Polarex.CustomerSession (Polarex v0.3.0)

View Source

Provides API endpoints related to customer session

Summary

Types

t()

Functions

customer_portal_customer_session_get_authenticated_user(opts \\ [])

Get Authenticated Portal User

customer_portal_customer_session_introspect(opts \\ [])

Introspect Customer Session

Types

t()

@type t() :: %Polarex.CustomerSession{
  created_at: DateTime.t(),
  customer: Polarex.CustomerIndividual.t() | Polarex.CustomerTeam.t(),
  customer_id: String.t(),
  customer_portal_url: String.t(),
  expires_at: DateTime.t(),
  id: String.t(),
  modified_at: DateTime.t() | nil,
  return_url: String.t() | nil,
  token: String.t()
}

Functions

customer_portal_customer_session_get_authenticated_user(opts \\ [])

@spec customer_portal_customer_session_get_authenticated_user(opts :: keyword()) ::
  {:ok, Polarex.PortalAuthenticatedUser.t()} | :error

Get Authenticated Portal User

Get information about the currently authenticated portal user.

Scopes: customer_portal:read customer_portal:write

customer_portal_customer_session_introspect(opts \\ [])

@spec customer_portal_customer_session_introspect(opts :: keyword()) ::
  {:ok, Polarex.CustomerCustomerSession.t()} | :error

Introspect Customer Session

Introspect the current session and return its information.

Scopes: customer_portal:read customer_portal:write