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.

pub async fn query<T: DeserializeOwned + GraphQLFields>( &self, field: &str, ) -> Result<T, LinearError>

Execute a typed query using the type’s GraphQLFields implementation.

Builds the query from T::selection() — define a struct with only the fields you need for zero-overfetch queries.

#[derive(Deserialize)]
struct MyViewer { name: Option<String>, email: Option<String> }

impl GraphQLFields for MyViewer {
    fn selection() -> String { "name email".into() }
}

let me: MyViewer = client.query::<MyViewer>("viewer").await?;

pub async fn query_connection<T: DeserializeOwned + GraphQLFields>( &self, field: &str, ) -> Result<Connection<T>, LinearError>

Execute a typed connection query using the node type’s GraphQLFields implementation.

Builds { field { nodes { <T::selection()> } pageInfo { ... } } }.

impl Client

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

All issue workflow states.

Full type: WorkflowState

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

All users for the organization.

Full type: User

pub async fn whoami<T: DeserializeOwned + GraphQLFields<FullType = User>>( &self, ) -> Result<T, LinearError>

The currently authenticated user.

Full type: User

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

All projects.

Full type: Project

pub async fn project<T: DeserializeOwned + GraphQLFields<FullType = Project>>( &self, id: String, ) -> Result<T, LinearError>

One specific project.

Full type: Project

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

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.

Full type: Team

pub async fn team<T: DeserializeOwned + GraphQLFields<FullType = Team>>( &self, id: String, ) -> Result<T, LinearError>

One specific team.

Full type: Team

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

Search issues.

Full type: IssueSearchResult

pub fn project_milestones<T>(&self) -> ProjectMilestonesQueryBuilder<'_, T>

All milestones for the project.

Full type: ProjectMilestone

pub async fn project_milestone<T: DeserializeOwned + GraphQLFields<FullType = ProjectMilestone>>( &self, id: String, ) -> Result<T, LinearError>

One specific project milestone.

Full type: ProjectMilestone

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

All issues.

Full type: Issue

pub async fn issue<T: DeserializeOwned + GraphQLFields<FullType = Issue>>( &self, id: String, ) -> Result<T, LinearError>

One specific issue.

Full type: Issue

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

All issue relationships.

Full type: IssueRelation

pub async fn issue_relation<T: DeserializeOwned + GraphQLFields<FullType = IssueRelation>>( &self, id: String, ) -> Result<T, LinearError>

One specific issue relation.

Full type: IssueRelation

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

All issue labels.

Full type: IssueLabel

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

All documents in the workspace.

Full type: Document

pub async fn document<T: DeserializeOwned + GraphQLFields<FullType = Document>>( &self, id: String, ) -> Result<T, LinearError>

One specific document.

Full type: Document

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

All cycles.

Full type: Cycle

pub async fn cycle<T: DeserializeOwned + GraphQLFields<FullType = Cycle>>( &self, id: String, ) -> Result<T, LinearError>

One specific cycle.

Full type: 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 project_create<T: DeserializeOwned + GraphQLFields<FullType = Project>>( &self, slack_channel_name: Option<String>, input: ProjectCreateInput, ) -> Result<T, LinearError>

Creates a new project.

Full type: Project

pub async fn project_update<T: DeserializeOwned + GraphQLFields<FullType = Project>>( &self, input: ProjectUpdateInput, id: String, ) -> Result<T, LinearError>

Updates a project.

Full type: Project

pub async fn project_delete<T: DeserializeOwned + GraphQLFields<FullType = Project>>( &self, id: String, ) -> Result<T, LinearError>

Deletes (trashes) a project.

Full type: Project

pub async fn project_milestone_create<T: DeserializeOwned + GraphQLFields<FullType = ProjectMilestone>>( &self, input: ProjectMilestoneCreateInput, ) -> Result<T, LinearError>

Creates a new project milestone.

Full type: ProjectMilestone

pub async fn project_milestone_update<T: DeserializeOwned + GraphQLFields<FullType = ProjectMilestone>>( &self, input: ProjectMilestoneUpdateInput, id: String, ) -> Result<T, LinearError>

Updates a project milestone.

Full type: ProjectMilestone

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

Deletes a project milestone.

pub async fn issue_create<T: DeserializeOwned + GraphQLFields<FullType = Issue>>( &self, input: IssueCreateInput, ) -> Result<T, LinearError>

Creates a new issue.

Full type: Issue

pub async fn issue_update<T: DeserializeOwned + GraphQLFields<FullType = Issue>>( &self, input: IssueUpdateInput, id: String, ) -> Result<T, LinearError>

Updates an issue.

Full type: Issue

pub async fn issue_archive<T: DeserializeOwned + GraphQLFields<FullType = Issue>>( &self, trash: Option<bool>, id: String, ) -> Result<T, LinearError>

Archives an issue.

Full type: Issue

pub async fn issue_unarchive<T: DeserializeOwned + GraphQLFields<FullType = Issue>>( &self, id: String, ) -> Result<T, LinearError>

Unarchives an issue.

Full type: Issue

pub async fn issue_delete<T: DeserializeOwned + GraphQLFields<FullType = Issue>>( &self, permanently_delete: Option<bool>, id: String, ) -> Result<T, LinearError>

Deletes (trashes) an issue.

Full type: Issue

pub async fn issue_relation_create<T: DeserializeOwned + GraphQLFields<FullType = IssueRelation>>( &self, override_created_at: Option<Value>, input: IssueRelationCreateInput, ) -> Result<T, LinearError>

Creates a new issue relation.

Full type: IssueRelation

pub async fn document_create<T: DeserializeOwned + GraphQLFields<FullType = Document>>( &self, input: DocumentCreateInput, ) -> Result<T, LinearError>

Creates a new document.

Full type: Document

pub async fn document_update<T: DeserializeOwned + GraphQLFields<FullType = Document>>( &self, input: DocumentUpdateInput, id: String, ) -> Result<T, LinearError>

Updates a document.

Full type: Document

pub async fn document_delete<T: DeserializeOwned + GraphQLFields<FullType = Document>>( &self, id: String, ) -> Result<T, LinearError>

Deletes (trashes) a document.

Full type: Document

pub async fn comment_create<T: DeserializeOwned + GraphQLFields<FullType = Comment>>( &self, input: CommentCreateInput, ) -> Result<T, LinearError>

Creates a new comment.

Full type: 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.