Struct Client 

pub struct Client { /* private fields */ }

The Linear API client.

Implementations

impl Client

pub fn from_token(token: impl Into<String>) -> Result<Self, LinearError>

Create a client with an explicit API token.

pub fn from_env() -> Result<Self, LinearError>

Create a client from the LINEAR_API_TOKEN environment variable.

pub fn from_file() -> Result<Self, LinearError>

Create a client from the ~/.linear_api_token file.

pub fn auto() -> Result<Self, LinearError>

Create a client by auto-detecting the token (env -> file).

pub async fn execute<T: DeserializeOwned>( &self, query: &str, variables: Value, data_path: &str, ) -> Result<T, LinearError>

Execute a GraphQL query and extract a single object from the response.

pub async fn execute_connection<T: DeserializeOwned>( &self, query: &str, variables: Value, data_path: &str, ) -> Result<Connection<T>, LinearError>

Execute a GraphQL query and extract a Connection from the response.

impl Client

pub fn workflow_states(&self) -> WorkflowStatesQueryBuilder<'_>

All issue workflow states.

pub fn users(&self) -> UsersQueryBuilder<'_>

All users for the organization.

pub async fn whoami(&self) -> Result<User, LinearError>

The currently authenticated user.

pub fn projects(&self) -> ProjectsQueryBuilder<'_>

All projects.

pub async fn project(&self, id: String) -> Result<Project, LinearError>

One specific project.

pub fn teams(&self) -> TeamsQueryBuilder<'_>

All teams whose issues can be accessed by the user. This might be different from administrableTeams, which also includes teams whose settings can be changed by the user.

pub async fn team(&self, id: String) -> Result<Team, LinearError>

One specific team.

pub fn search_issues( &self, term: impl Into<String>, ) -> SearchIssuesQueryBuilder<'_>

Search issues.

pub fn issues(&self) -> IssuesQueryBuilder<'_>

All issues.

pub async fn issue(&self, id: String) -> Result<Issue, LinearError>

One specific issue.

pub fn issue_relations(&self) -> IssueRelationsQueryBuilder<'_>

All issue relationships.

pub async fn issue_relation( &self, id: String, ) -> Result<IssueRelation, LinearError>

One specific issue relation.

pub fn issue_labels(&self) -> IssueLabelsQueryBuilder<'_>

All issue labels.

pub fn documents(&self) -> DocumentsQueryBuilder<'_>

All documents in the workspace.

pub async fn document(&self, id: String) -> Result<Document, LinearError>

One specific document.

pub fn cycles(&self) -> CyclesQueryBuilder<'_>

All cycles.

pub async fn cycle(&self, id: String) -> Result<Cycle, LinearError>

One specific cycle.

pub async fn file_upload( &self, meta_data: Option<Value>, make_public: Option<bool>, size: i64, content_type: String, filename: String, ) -> Result<Value, LinearError>

XHR request payload to upload an images, video and other attachments directly to Linear’s cloud storage.

pub async fn image_upload_from_url( &self, url: String, ) -> Result<Value, LinearError>

Upload an image from an URL to Linear.

pub async fn issue_create( &self, input: IssueCreateInput, ) -> Result<Value, LinearError>

Creates a new issue.

pub async fn issue_update( &self, input: IssueUpdateInput, id: String, ) -> Result<Value, LinearError>

Updates an issue.

pub async fn issue_archive( &self, trash: Option<bool>, id: String, ) -> Result<Value, LinearError>

Archives an issue.

pub async fn issue_unarchive(&self, id: String) -> Result<Value, LinearError>

Unarchives an issue.

pub async fn issue_delete( &self, permanently_delete: Option<bool>, id: String, ) -> Result<Value, LinearError>

Deletes (trashes) an issue.

pub async fn issue_relation_create( &self, override_created_at: Option<Value>, input: IssueRelationCreateInput, ) -> Result<Value, LinearError>

Creates a new issue relation.

pub async fn document_create( &self, input: DocumentCreateInput, ) -> Result<Value, LinearError>

Creates a new document.

pub async fn document_update( &self, input: DocumentUpdateInput, id: String, ) -> Result<Value, LinearError>

Updates a document.

pub async fn document_delete(&self, id: String) -> Result<Value, LinearError>

Deletes (trashes) a document.

pub async fn comment_create( &self, input: CommentCreateInput, ) -> Result<Value, LinearError>

Creates a new comment.

impl Client

pub async fn download_url( &self, url: &str, ) -> Result<DownloadResult, LinearError>

Download a file from a URL.

Handles Linear’s signed/expiring CDN URLs (e.g. https://uploads.linear.app/...) as well as any other publicly accessible URL. Returns the raw bytes and content type so the caller can write them to disk or process them further.

Errors

Returns LinearError::HttpError if the server responds with a non-2xx status, or LinearError::Network if the request fails at the transport level.

Example

let client = lineark_sdk::Client::auto()?;
let result = client.download_url("https://uploads.linear.app/...").await?;
std::fs::write("output.png", &result.bytes).unwrap();

pub async fn upload_file( &self, filename: &str, content_type: &str, bytes: Vec<u8>, make_public: bool, ) -> Result<UploadResult, LinearError>

Upload a file to Linear’s cloud storage.

This is a two-step process:

1. Call the fileUpload GraphQL mutation to obtain a signed upload URL and required headers from Linear.
2. PUT the raw file bytes to that signed URL (a Google Cloud Storage endpoint).

On success, returns an UploadResult containing the permanent asset_url that can be referenced in issue descriptions, comments, or attachments.

Arguments

• filename — The original filename (e.g. "screenshot.png"). Linear uses this for display and content-type inference on its side.
• content_type — MIME type of the file (e.g. "image/png").
• bytes — The raw file content.
• make_public — If true, the uploaded file will be publicly accessible without authentication.

Errors

Returns an error if the fileUpload mutation fails, if the signed URL upload fails, or if the response is missing expected fields.

Example

let client = lineark_sdk::Client::auto()?;
let bytes = std::fs::read("screenshot.png").unwrap();
let result = client
    .upload_file("screenshot.png", "image/png", bytes, false)
    .await?;
println!("Uploaded to: {}", result.asset_url);

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.