• WebhooksApi - axios parameter creator

    Parameters

    Returns {
        createWalletWebhook: ((walletId, createWalletWebhookRequest?, options?) => Promise<RequestArgs>);
        createWebhook: ((createWebhookRequest?, options?) => Promise<RequestArgs>);
        deleteWebhook: ((webhookId, options?) => Promise<RequestArgs>);
        listWebhooks: ((limit?, page?, options?) => Promise<RequestArgs>);
        updateWebhook: ((webhookId, updateWebhookRequest?, options?) => Promise<RequestArgs>);
    }

    • createWalletWebhook: ((walletId, createWalletWebhookRequest?, options?) => Promise<RequestArgs>)

      Create a new webhook scoped to a wallet

      Summary

      Create a new webhook scoped to a wallet

      Throws

        • (walletId, createWalletWebhookRequest?, options?): Promise<RequestArgs>
        • Parameters

          • walletId: string

            The ID of the wallet to create the webhook for.

          • Optional createWalletWebhookRequest: CreateWalletWebhookRequest
          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • createWebhook: ((createWebhookRequest?, options?) => Promise<RequestArgs>)

      Create a new webhook

      Summary

      Create a new webhook

      Throws

        • (createWebhookRequest?, options?): Promise<RequestArgs>
        • Parameters

          • Optional createWebhookRequest: CreateWebhookRequest
          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • deleteWebhook: ((webhookId, options?) => Promise<RequestArgs>)

      Delete a webhook

      Summary

      Delete a webhook

      Throws

        • (webhookId, options?): Promise<RequestArgs>
        • Parameters

          • webhookId: string

            The Webhook uuid that needs to be deleted

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • listWebhooks: ((limit?, page?, options?) => Promise<RequestArgs>)

      List webhooks, optionally filtered by event type.

      Summary

      List webhooks

      Throws

        • (limit?, page?, options?): Promise<RequestArgs>
        • Parameters

          • Optional limit: number

            A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

          • Optional page: string

            A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updateWebhook: ((webhookId, updateWebhookRequest?, options?) => Promise<RequestArgs>)

      Update a webhook

      Summary

      Update a webhook

      Throws

        • (webhookId, updateWebhookRequest?, options?): Promise<RequestArgs>
        • Parameters

          • webhookId: string

            The Webhook id that needs to be updated

          • Optional updateWebhookRequest: UpdateWebhookRequest
          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    Export