Function WebhookEndpointsApiFactory

Returns {
    createWebhookEndpoint(requestParameters, options?) => AxiosPromise<WebhookEndpoint>;
    deleteWebhookEndpoint(requestParameters, options?) => AxiosPromise<object>;
    getWebhookEndpoint(requestParameters, options?) => AxiosPromise<WebhookEndpoint>;
    listWebhookEndpoints(requestParameters, options?) => AxiosPromise<ListWebhookEndpoints200Response>;
    updateWebhookEndpoint(requestParameters, options?) => AxiosPromise<WebhookEndpoint>;
}

• createWebhookEndpoint:function

  • createWebhookEndpoint(requestParameters, options?): AxiosPromise<WebhookEndpoint>

  • Creates a Webhook Endpoint.

    Summary

    Create a Webhook Endpoint

    Throws

    Parameters

    • requestParameters: WebhookEndpointsApiCreateWebhookEndpointRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookEndpoint>

• deleteWebhookEndpoint:function

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

  • Deletes a Webhook Endpoint. This cannot be undone.

    Summary

    Delete a Webhook Endpoint

    Throws

    Parameters

    • requestParameters: WebhookEndpointsApiDeleteWebhookEndpointRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<object>

• getWebhookEndpoint:function

  • getWebhookEndpoint(requestParameters, options?): AxiosPromise<WebhookEndpoint>

  • Retrieves the details of an existing Webhook Endpoint.

    Summary

    Get a Webhook Endpoint

    Throws

    Parameters

    • requestParameters: WebhookEndpointsApiGetWebhookEndpointRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookEndpoint>

• listWebhookEndpoints:function

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

    • requestParameters: WebhookEndpointsApiListWebhookEndpointsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListWebhookEndpoints200Response>

• updateWebhookEndpoint:function

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

    • requestParameters: WebhookEndpointsApiUpdateWebhookEndpointRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookEndpoint>