DodoPayments.WebhookEndpoints.Headers (dodo_payments v0.1.0)

Copy Markdown View Source

Custom headers configured for a webhook endpoint.

Summary

Types

update_params()

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

Functions

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

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

update(client, webhook_id, params)

Calls Dodo operation webhook_headers_update (PATCH /webhooks/{webhook_id}/headers). Required parameters: :headers.

update(client, webhook_id, params, opts)

Calls Dodo operation webhook_headers_update (PATCH /webhooks/{webhook_id}/headers). Required parameters: :headers.

Types

update_params()

@type update_params() ::
  %{
    :headers => DodoPayments.RequestTypes.string_map(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

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

Functions

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

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

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

Options are request-local.

update(client, webhook_id, params)

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

Calls Dodo operation webhook_headers_update (PATCH /webhooks/{webhook_id}/headers). Required parameters: :headers.

API parameters must be supplied as a map.

update(client, webhook_id, params, opts)

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

Calls Dodo operation webhook_headers_update (PATCH /webhooks/{webhook_id}/headers). Required parameters: :headers.

The final argument contains request-local options.