DodoPayments.Customers.PortalSessions (dodo_payments v0.1.0)

Copy Markdown View Source

Customer self-service portal sessions.

Summary

Types

create_params()

Parameters for customer_portal_sessions_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/customers/customer-portal.ts declaration CustomerPortalCreateParams.

Functions

create(client, customer_id)

Calls Dodo operation customer_portal_sessions_create (POST /customers/{customer_id}/customer-portal/session). Required parameters: none.

create(client, customer_id, opts)

Calls Dodo operation customer_portal_sessions_create (POST /customers/{customer_id}/customer-portal/session). Required parameters: none.

create(client, customer_id, params, opts)

Calls Dodo operation customer_portal_sessions_create (POST /customers/{customer_id}/customer-portal/session). Required parameters: none.

Types

create_params()

@type create_params() ::
  %{
    optional(:return_url) => String.t(),
    optional(:send_email) => boolean(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for customer_portal_sessions_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/customers/customer-portal.ts declaration CustomerPortalCreateParams.

Functions

create(client, customer_id)

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

Calls Dodo operation customer_portal_sessions_create (POST /customers/{customer_id}/customer-portal/session). Required parameters: none.

Calls the operation with an empty parameter map.

create(client, customer_id, opts)

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

Calls Dodo operation customer_portal_sessions_create (POST /customers/{customer_id}/customer-portal/session). Required parameters: none.

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

create(client, customer_id, params, opts)

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

Calls Dodo operation customer_portal_sessions_create (POST /customers/{customer_id}/customer-portal/session). Required parameters: none.

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