DodoPayments.WebhookEndpoints (dodo_payments v0.1.0)

Webhook endpoint management. For signature verification use DodoPayments.Webhooks.

Summary

Types

Parameters for webhook_endpoints_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/webhooks/webhooks.ts declaration WebhookCreateParams.

list_params()

Parameters for webhook_endpoints_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/webhooks/webhooks.ts declaration WebhookListParams.

update_params()

Parameters for webhook_endpoints_update. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/webhooks/webhooks.ts declaration WebhookUpdateParams.

Functions

create(client, params)

Calls Dodo operation webhook_endpoints_create (POST /webhooks). Required parameters: :url.

create(client, params, opts)

Calls Dodo operation webhook_endpoints_create (POST /webhooks). Required parameters: :url.

delete(client, webhook_id, opts \\ [])

Calls Dodo operation webhook_endpoints_delete (DELETE /webhooks/{webhook_id}). Required parameters: none.

list(client)

Calls Dodo operation webhook_endpoints_list (GET /webhooks). Required parameters: none. Pagination uses Dodo iterators.

list(client, opts)

Calls Dodo operation webhook_endpoints_list (GET /webhooks). Required parameters: none. Pagination uses Dodo iterators.

list(client, params, opts)

Calls Dodo operation webhook_endpoints_list (GET /webhooks). Required parameters: none. Pagination uses Dodo iterators.

retrieve(client, webhook_id, opts \\ [])

Calls Dodo operation webhook_endpoints_retrieve (GET /webhooks/{webhook_id}). Required parameters: none.

retrieve_secret(client, webhook_id, opts \\ [])

Calls Dodo operation webhook_endpoints_retrieve_secret (GET /webhooks/{webhook_id}/secret). Required parameters: none.

update(client, webhook_id)

Calls Dodo operation webhook_endpoints_update (PATCH /webhooks/{webhook_id}). Required parameters: none.

update(client, webhook_id, opts)

Calls Dodo operation webhook_endpoints_update (PATCH /webhooks/{webhook_id}). Required parameters: none.

update(client, webhook_id, params, opts)

Calls Dodo operation webhook_endpoints_update (PATCH /webhooks/{webhook_id}). Required parameters: none.

Types

create_params()

@type create_params() ::
  %{
    :url => String.t(),
    optional(:description) => String.t(),
    optional(:disabled) => boolean(),
    optional(:filter_types) => [DodoPayments.Enums.webhook_event_type()],
    optional(:headers) => DodoPayments.RequestTypes.string_map(),
    optional(:idempotency_key) => String.t(),
    optional(:metadata) => DodoPayments.RequestTypes.string_map(),
    optional(:rate_limit) => number(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

list_params()

@type list_params() ::
  %{
    optional(:iterator) => String.t(),
    optional(:limit) => number(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

update_params()

@type update_params() ::
  %{
    optional(:description) => String.t(),
    optional(:disabled) => boolean(),
    optional(:filter_types) => [DodoPayments.Enums.webhook_event_type()],
    optional(:metadata) => DodoPayments.RequestTypes.string_map(),
    optional(:rate_limit) => number(),
    optional(:url) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Functions

create(client, params)

@spec create(DodoPayments.Client.t(), create_params()) ::
  {:ok, DodoPayments.WebhookEndpoint.t()} | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_create (POST /webhooks). Required parameters: :url.

API parameters must be supplied as a map.

create(client, params, opts)

@spec create(DodoPayments.Client.t(), create_params(), keyword()) ::
  {:ok,
   DodoPayments.WebhookEndpoint.t()
   | DodoPayments.Response.t(DodoPayments.WebhookEndpoint.t())}
  | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_create (POST /webhooks). Required parameters: :url.

The final argument contains request-local options.

delete(client, webhook_id, opts \\ [])

@spec delete(DodoPayments.Client.t(), String.t() | integer(), keyword()) ::
  {:ok, nil | DodoPayments.Response.t(nil)} | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_delete (DELETE /webhooks/{webhook_id}). Required parameters: none.

Options are request-local.

list(client)

@spec list(DodoPayments.Client.t()) ::
  {:ok, DodoPayments.Page.Cursor.t(DodoPayments.WebhookEndpoint.t())}
  | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_list (GET /webhooks). Required parameters: none. Pagination uses Dodo iterators.

Calls the operation with an empty parameter map.

list(client, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil | keyword()) ::
  {:ok,
   DodoPayments.Page.Cursor.t(DodoPayments.WebhookEndpoint.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Cursor.t(DodoPayments.WebhookEndpoint.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_list (GET /webhooks). Required parameters: none. Pagination uses Dodo iterators.

Pass a map for Dodo parameters or a keyword list for request-local options.

list(client, params, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil, keyword()) ::
  {:ok,
   DodoPayments.Page.Cursor.t(DodoPayments.WebhookEndpoint.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Cursor.t(DodoPayments.WebhookEndpoint.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_list (GET /webhooks). Required parameters: none. Pagination uses Dodo iterators.

Accepts both a Dodo parameter map and request-local options.

retrieve(client, webhook_id, opts \\ [])

@spec retrieve(DodoPayments.Client.t(), String.t() | integer(), keyword()) ::
  {:ok,
   DodoPayments.WebhookEndpoint.t()
   | DodoPayments.Response.t(DodoPayments.WebhookEndpoint.t())}
  | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_retrieve (GET /webhooks/{webhook_id}). Required parameters: none.

Options are request-local.

retrieve_secret(client, webhook_id, opts \\ [])

@spec retrieve_secret(DodoPayments.Client.t(), String.t() | integer(), keyword()) ::
  {:ok,
   DodoPayments.WebhookSecret.t()
   | DodoPayments.Response.t(DodoPayments.WebhookSecret.t())}
  | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_retrieve_secret (GET /webhooks/{webhook_id}/secret). Required parameters: none.

Options are request-local.

update(client, webhook_id)

@spec update(DodoPayments.Client.t(), String.t() | integer()) ::
  {:ok, DodoPayments.WebhookEndpoint.t()} | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_update (PATCH /webhooks/{webhook_id}). Required parameters: none.

Calls the operation with an empty parameter map.

update(client, webhook_id, opts)

@spec update(
  DodoPayments.Client.t(),
  String.t() | integer(),
  update_params() | nil | keyword()
) ::
  {:ok,
   DodoPayments.WebhookEndpoint.t()
   | DodoPayments.Response.t(DodoPayments.WebhookEndpoint.t())}
  | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_update (PATCH /webhooks/{webhook_id}). Required parameters: none.

Pass a map for Dodo parameters or a keyword list for request-local options.

update(client, webhook_id, params, opts)

@spec update(
  DodoPayments.Client.t(),
  String.t() | integer(),
  update_params() | nil,
  keyword()
) ::
  {:ok,
   DodoPayments.WebhookEndpoint.t()
   | DodoPayments.Response.t(DodoPayments.WebhookEndpoint.t())}
  | {:error, Exception.t()}

Calls Dodo operation webhook_endpoints_update (PATCH /webhooks/{webhook_id}). Required parameters: none.

Accepts both a Dodo parameter map and request-local options.