Function WebhookEndpointsApiFp

  • WebhookEndpointsApi - functional programming interface

    Export

    Parameters

    Returns {
        createWebhookEndpoint(tilled_account, WebhookEndpointCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<WebhookEndpoint>)>;
        deleteWebhookEndpoint(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<object>)>;
        getWebhookEndpoint(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<WebhookEndpoint>)>;
        listWebhookEndpoints(tilled_account, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListWebhookEndpoints200Response>)>;
        updateWebhookEndpoint(tilled_account, id, WebhookEndpointUpdateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<WebhookEndpoint>)>;
    }

    • createWebhookEndpoint:function
      • createWebhookEndpoint(tilled_account, WebhookEndpointCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<WebhookEndpoint>)>

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

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

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

    • getWebhookEndpoint:function
      • getWebhookEndpoint(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<WebhookEndpoint>)>

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

    • listWebhookEndpoints:function
      • listWebhookEndpoints(tilled_account, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListWebhookEndpoints200Response>)>

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

    • updateWebhookEndpoint:function
      • updateWebhookEndpoint(tilled_account, id, WebhookEndpointUpdateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<WebhookEndpoint>)>

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

Settings

Member Visibility

Theme

Generated using TypeDoc