Function APIKeysApiAxiosParamCreator

Returns {
    createAPIKey: ((tilled_account, ApiKeyCreateParams, options?) => Promise<RequestArgs>);
    deleteAPIKey: ((tilled_account, id, options?) => Promise<RequestArgs>);
    listAPIKeys: ((tilled_account, offset?, limit?, options?) => Promise<RequestArgs>);
    updateAPIKey: ((tilled_account, id, ApiKeyUpdateParams, options?) => Promise<RequestArgs>);
}

• createAPIKey: ((tilled_account, ApiKeyCreateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, ApiKeyCreateParams, options?): Promise<RequestArgs>

    • Creates a new API Key. For security reasons, secret keys are only fully displayed upon creation. Store this key securely to authenticate your application to the API.

      Summary

      Create an API key

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • ApiKeyCreateParams: ApiKeyCreateParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteAPIKey: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • Deletes an API Key. This cannot be undone.

      Summary

      Delete an API Key

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • id: string

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listAPIKeys: ((tilled_account, offset?, limit?, options?) => Promise<RequestArgs>)

  • • (tilled_account, offset?, limit?, options?): Promise<RequestArgs>

    • Returns a list of API Keys. The API Keys are sorted with the most recently created appearing first.

      Summary

      List all API Keys

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • Optional offset: number

        The (zero-based) offset of the first item in the collection to return.

      • Optional limit: number

        The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateAPIKey: ((tilled_account, id, ApiKeyUpdateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, ApiKeyUpdateParams, options?): Promise<RequestArgs>

    • Updates the API Keys by setting the values of the provided parameters. Any parameters not provided will be left unchanged.

      Summary

      Update an API key

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • id: string

      • ApiKeyUpdateParams: ApiKeyUpdateParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>