Function APIKeysApiFp

Returns {
    createAPIKey(tilled_account, ApiKeyCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<ApiKey>)>;
    deleteAPIKey(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<object>)>;
    listAPIKeys(tilled_account, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListAPIKeys200Response>)>;
    updateAPIKey(tilled_account, id, ApiKeyUpdateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<ApiKey>)>;
}

• createAPIKey:function

  • createAPIKey(tilled_account, ApiKeyCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<ApiKey>)>

  • 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<((axios?, basePath?) => AxiosPromise<ApiKey>)>

• deleteAPIKey:function

  • deleteAPIKey(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<object>)>

  • 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<((axios?, basePath?) => AxiosPromise<object>)>

• listAPIKeys:function

  • listAPIKeys(tilled_account, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListAPIKeys200Response>)>

  • 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<((axios?, basePath?) => AxiosPromise<ListAPIKeys200Response>)>

• updateAPIKey:function

  • updateAPIKey(tilled_account, id, ApiKeyUpdateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<ApiKey>)>

  • 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<((axios?, basePath?) => AxiosPromise<ApiKey>)>