Skip to main content

GitHubApiClient

github_bot_sdk::auth

Trait GitHubApiClient 

Source 
pub trait GitHubApiClient: Send + Sync {
    // Required methods
    fn create_installation_access_token<'life0, 'life1, 'async_trait>(
        &'life0 self,
        installation_id: InstallationId,
        jwt: &'life1 JsonWebToken,
    ) -> Pin<Box<dyn Future<Output = Result<InstallationToken, ApiError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn list_app_installations<'life0, 'life1, 'async_trait>(
        &'life0 self,
        jwt: &'life1 JsonWebToken,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Installation>, ApiError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn list_installation_repositories<'life0, 'life1, 'async_trait>(
        &'life0 self,
        installation_id: InstallationId,
        token: &'life1 InstallationToken,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Repository>, ApiError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn get_repository<'life0, 'life1, 'async_trait>(
        &'life0 self,
        repo_id: RepositoryId,
        token: &'life1 InstallationToken,
    ) -> Pin<Box<dyn Future<Output = Result<Repository, ApiError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn get_rate_limit<'life0, 'life1, 'async_trait>(
        &'life0 self,
        token: &'life1 InstallationToken,
    ) -> Pin<Box<dyn Future<Output = Result<RateLimitInfo, ApiError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
}
Expand description

Interface for GitHub API client operations.

Required Methods§

Source

fn create_installation_access_token<'life0, 'life1, 'async_trait>( &'life0 self, installation_id: InstallationId, jwt: &'life1 JsonWebToken, ) -> Pin<Box<dyn Future<Output = Result<InstallationToken, ApiError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create installation access token via GitHub API.

Source

fn list_app_installations<'life0, 'life1, 'async_trait>( &'life0 self, jwt: &'life1 JsonWebToken, ) -> Pin<Box<dyn Future<Output = Result<Vec<Installation>, ApiError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List installations for the GitHub App.

Source

fn list_installation_repositories<'life0, 'life1, 'async_trait>( &'life0 self, installation_id: InstallationId, token: &'life1 InstallationToken, ) -> Pin<Box<dyn Future<Output = Result<Vec<Repository>, ApiError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get repositories for installation.

Source

fn get_repository<'life0, 'life1, 'async_trait>( &'life0 self, repo_id: RepositoryId, token: &'life1 InstallationToken, ) -> Pin<Box<dyn Future<Output = Result<Repository, ApiError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get repository information.

Source

fn get_rate_limit<'life0, 'life1, 'async_trait>( &'life0 self, token: &'life1 InstallationToken, ) -> Pin<Box<dyn Future<Output = Result<RateLimitInfo, ApiError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check API rate limits.

Implementors§