Function APIKeysApiFactory

Returns {
    createAPIKey(requestParameters, options?) => AxiosPromise<ApiKey>;
    deleteAPIKey(requestParameters, options?) => AxiosPromise<object>;
    listAPIKeys(requestParameters, options?) => AxiosPromise<ListAPIKeys200Response>;
    updateAPIKey(requestParameters, options?) => AxiosPromise<ApiKey>;
}

• createAPIKey:function

  • createAPIKey(requestParameters, options?): 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

    • requestParameters: APIKeysApiCreateAPIKeyRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ApiKey>

• deleteAPIKey:function

  • deleteAPIKey(requestParameters, options?): AxiosPromise<object>

  • Deletes an API Key. This cannot be undone.

    Summary

    Delete an API Key

    Throws

    Parameters

    • requestParameters: APIKeysApiDeleteAPIKeyRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<object>

• listAPIKeys:function

  • listAPIKeys(requestParameters, options?): 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

    • requestParameters: APIKeysApiListAPIKeysRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListAPIKeys200Response>

• updateAPIKey:function

  • updateAPIKey(requestParameters, options?): 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

    • requestParameters: APIKeysApiUpdateAPIKeyRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ApiKey>