Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserApi

UserApi - object-oriented interface

export

Hierarchy

  • BaseAPI
    • UserApi

Index

Constructors

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns UserApi

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: Configuration

Methods

  • summary

    Create a repository

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Repository>>

  • getUserSettings(options?: AxiosRequestConfig): Promise<AxiosResponse<UserSettings[]>>
  • summary

    Get user settings

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<UserSettings[]>>

  • getVerificationToken(options?: AxiosRequestConfig): Promise<AxiosResponse<string>>
  • summary

    Get a Token to verify

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<string>>

  • summary

    Update user settings

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<UserSettings[]>>

  • summary

    Add email addresses

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Email[]>>

  • summary

    Check if one user is following another user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Create an access token

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<AccessToken>>

  • summary

    Check whether a user is followed by the authenticated user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Whether the authenticated is starring the repo

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Unfollow a user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Remove a GPG key

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Delete a public key

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Unstar the given repo

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Get a GPG key

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<GPGKey>>

  • summary

    Get a public key

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<PublicKey>>

  • summary

    List the authenticated user's followers

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<User[]>>

  • summary

    List the users that the authenticated user is following

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<User[]>>

  • summary

    List the authenticated user's GPG keys

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<GPGKey[]>>

  • summary

    List the authenticated user's public keys

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<PublicKey[]>>

  • summary

    List the repos that the authenticated user owns

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Repository[]>>

  • summary

    The repos that the authenticated user has starred

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Repository[]>>

  • summary

    List repositories watched by the authenticated user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Repository[]>>

  • summary

    Create a GPG key

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<GPGKey>>

  • summary

    Create a public key

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<PublicKey>>

  • summary

    Follow a user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Star the given repo

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    List the current user's tracked times

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<TrackedTime[]>>

  • summary

    delete an access token

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Delete email addresses

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    delete an OAuth2 Application

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<void>>

  • summary

    Get a user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<User>>

  • userGetCurrent(options?: AxiosRequestConfig): Promise<AxiosResponse<User>>
  • summary

    Get the authenticated user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<User>>

  • summary

    Get a user's heatmap

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<UserHeatmapData[]>>

  • summary

    get an OAuth2 Application

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<OAuth2Application>>

  • summary

    List the authenticated user's oauth2 applications

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<OAuth2Application[]>>

  • summary

    Get list of all existing stopwatches

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<StopWatch[]>>

  • summary

    List the authenticated user's access tokens

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<AccessToken[]>>

  • userListEmails(options?: AxiosRequestConfig): Promise<AxiosResponse<Email[]>>
  • summary

    List the authenticated user's email addresses

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<Email[]>>

  • summary

    List the given user's followers

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<User[]>>

  • summary

    List the users that the given user is following

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<User[]>>

  • summary

    List the given user's GPG keys

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<GPGKey[]>>

  • summary

    List the given user's public keys

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<PublicKey[]>>

  • summary

    List the repos owned by the given user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Repository[]>>

  • summary

    The repos that the given user has starred

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Repository[]>>

  • summary

    List the repositories watched by a user

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Repository[]>>

  • summary

    List all the teams a user belongs to

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<Team[]>>

  • summary

    Search for users

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<UserSearch200Response>>

  • summary

    update an OAuth2 Application, this includes regenerating the client secret

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    Returns Promise<AxiosResponse<OAuth2Application>>

  • userVerifyGPGKey(options?: AxiosRequestConfig): Promise<AxiosResponse<GPGKey>>
  • summary

    Verify a GPG key

    throws

    {RequiredError}

    memberof

    UserApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<GPGKey>>

Generated using TypeDoc