Skip to main content

InstallationClient

Struct InstallationClient 

Source
pub struct InstallationClient { /* private fields */ }
Expand description

Installation-scoped GitHub API client.

Holds a reference to the parent GitHubClient for shared HTTP client, auth provider, and rate limiter. All operations use installation tokens.

Implementations§

Source§

impl InstallationClient

Source

pub fn new(client: Arc<GitHubClient>, installation_id: InstallationId) -> Self

Create a new installation client.

§Arguments
  • client - Parent GitHubClient
  • installation_id - Installation ID to bind to
Source

pub fn installation_id(&self) -> InstallationId

Get the installation ID this client is bound to.

Source

pub async fn get(&self, path: &str) -> Result<Response, ApiError>

Make an authenticated GET request to the GitHub API.

Uses installation token for authentication and includes automatic retry logic for transient errors (5xx, 429, network failures).

§Arguments
  • path - API path (e.g., “/repos/owner/repo” or “repos/owner/repo”)
§Returns

Returns the raw reqwest::Response for flexible handling.

§Errors

Returns ApiError for HTTP errors, authentication failures, or network issues.

Source

pub async fn post<T: Serialize>( &self, path: &str, body: &T, ) -> Result<Response, ApiError>

Make an authenticated POST request to the GitHub API.

Includes automatic retry logic for transient errors.

§Arguments
  • path - API path
  • body - Request body (will be serialized to JSON)
§Errors

Returns ApiError for HTTP errors, serialization failures, or network issues.

Source

pub async fn put<T: Serialize>( &self, path: &str, body: &T, ) -> Result<Response, ApiError>

Make an authenticated PUT request to the GitHub API.

Includes automatic retry logic for transient errors.

Source

pub async fn delete(&self, path: &str) -> Result<Response, ApiError>

Make an authenticated DELETE request to the GitHub API.

Includes automatic retry logic for transient errors.

Source

pub async fn post_graphql<V: Serialize>( &self, query: &str, variables: V, ) -> Result<Value, ApiError>

Make an authenticated POST request to the GitHub GraphQL API.

GitHub’s GraphQL endpoint always returns HTTP 200 even for errors. Application-level errors are detected by checking the .errors array in the response body; the first error message is surfaced as ApiError::GraphQlError. On success, the .data value is returned.

Retry logic (backoff, 5xx, rate-limit handling) is identical to the REST helpers because the transport layer is the same.

§Arguments
  • query - GraphQL query or mutation string
  • variables - Variables object (serialised to JSON)
§Returns

Returns the data field from the GraphQL response as a serde_json::Value.

§Errors
  • ApiError::GraphQlError — GitHub returned .errors in the body
  • ApiError::GraphQlError — response body contains neither .errors nor a non-null .data field (malformed or unexpected response shape)
  • ApiError::AuthenticationFailed — HTTP 401
  • ApiError::JsonError — response body could not be parsed
  • Any other ApiError variant for HTTP-level failures
Source

pub async fn patch<T: Serialize>( &self, path: &str, body: &T, ) -> Result<Response, ApiError>

Make an authenticated PATCH request to the GitHub API.

Includes automatic retry logic for transient errors.

Source

pub async fn delete_with_body<T: Serialize>( &self, path: &str, body: &T, ) -> Result<Response, ApiError>

Make an authenticated DELETE request with a JSON body to the GitHub API.

Used for endpoints that require a body on DELETE (e.g. remove assignees).

Source§

impl InstallationClient

Source

pub fn issues(&self) -> IssuesClient

Access issue-domain operations.

See docs/specs/interfaces/issue-operations.md; ADR-003.

Source

pub fn pull_requests(&self) -> PullRequestsClient

Access pull request operations, reviews, and inline comments.

See docs/specs/interfaces/pull-request-operations.md; ADR-003.

Source

pub fn labels(&self) -> LabelsClient

Access repository-level label catalogue operations.

See docs/specs/interfaces/labels-client.md; ADR-003.

Source

pub fn milestones(&self) -> MilestonesClient

Access milestone CRUD operations.

See docs/specs/interfaces/milestones-client.md; ADR-003.

Source

pub fn repositories(&self) -> RepositoriesClient

Access repository, branch, tag, git-ref, and commit operations.

See docs/specs/interfaces/repository-operations.md; ADR-003.

Source

pub fn workflows(&self) -> WorkflowsClient

Access GitHub Actions workflow and run operations.

See docs/specs/interfaces/additional-operations.md; ADR-003.

Source

pub fn releases(&self) -> ReleasesClient

Access release CRUD operations.

See docs/specs/interfaces/additional-operations.md; ADR-003.

Source

pub fn projects(&self) -> ProjectsClient

Access GitHub Projects V2 operations.

See docs/specs/interfaces/project-operations.md; ADR-003.

Trait Implementations§

Source§

impl Clone for InstallationClient

Source§

fn clone(&self) -> InstallationClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InstallationClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more