Function WebhookEndpointsApiAxiosParamCreator

Returns {
    createWebhookEndpoint: ((tilled_account, WebhookEndpointCreateParams, options?) => Promise<RequestArgs>);
    deleteWebhookEndpoint: ((tilled_account, id, options?) => Promise<RequestArgs>);
    getWebhookEndpoint: ((tilled_account, id, options?) => Promise<RequestArgs>);
    listWebhookEndpoints: ((tilled_account, offset?, limit?, options?) => Promise<RequestArgs>);
    updateWebhookEndpoint: ((tilled_account, id, WebhookEndpointUpdateParams, options?) => Promise<RequestArgs>);
}

• createWebhookEndpoint: ((tilled_account, WebhookEndpointCreateParams, options?) => Promise<RequestArgs>)

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

    • Creates a Webhook Endpoint.

      Summary

      Create a Webhook Endpoint

      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.

      • WebhookEndpointCreateParams: WebhookEndpointCreateParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

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

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

    • Deletes a Webhook Endpoint. This cannot be undone.

      Summary

      Delete a Webhook Endpoint

      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>

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

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

    • Retrieves the details of an existing Webhook Endpoint.

      Summary

      Get a Webhook Endpoint

      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>

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

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

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

      Summary

      List all Webhook Endpoints

      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>

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

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

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

      Summary

      Update a Webhook Endpoint

      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

      • WebhookEndpointUpdateParams: WebhookEndpointUpdateParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>