AgentPushKit.Api.Authentication (agent_push_kit v0.1.0)

API calls for all endpoints tagged Authentication.

Summary

Functions

complete_password_reset(connection, password_reset_complete_input, opts \\ [])

Choose a new password and log in

login_with_apple(connection, provider_login_input, opts \\ [])

login_with_google(connection, provider_login_input, opts \\ [])

login_with_password(connection, password_login_input, opts \\ [])

Create a user and first customer account

request_password_reset(connection, password_reset_request_input, opts \\ [])

Email a single-use password reset token

Functions

complete_password_reset(connection, password_reset_complete_input, opts \\ [])

@spec complete_password_reset(
  Tesla.Env.client(),
  AgentPushKit.Model.PasswordResetCompleteInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.AuthResponse.t()}
  | {:error, Tesla.Env.t()}

Choose a new password and log in

Parameters

connection (AgentPushKit.Connection): Connection to server
password_reset_complete_input (PasswordResetCompleteInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.AuthResponse.t} on success
{:error, Tesla.Env.t} on failure

login_with_apple(connection, provider_login_input, opts \\ [])

@spec login_with_apple(
  Tesla.Env.client(),
  AgentPushKit.Model.ProviderLoginInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.AuthResponse.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (AgentPushKit.Connection): Connection to server
provider_login_input (ProviderLoginInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.AuthResponse.t} on success
{:error, Tesla.Env.t} on failure

login_with_google(connection, provider_login_input, opts \\ [])

@spec login_with_google(
  Tesla.Env.client(),
  AgentPushKit.Model.ProviderLoginInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.AuthResponse.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (AgentPushKit.Connection): Connection to server
provider_login_input (ProviderLoginInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.AuthResponse.t} on success
{:error, Tesla.Env.t} on failure

login_with_password(connection, password_login_input, opts \\ [])

@spec login_with_password(
  Tesla.Env.client(),
  AgentPushKit.Model.PasswordLoginInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.AuthResponse.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (AgentPushKit.Connection): Connection to server
password_login_input (PasswordLoginInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.AuthResponse.t} on success
{:error, Tesla.Env.t} on failure

register(connection, register_input, opts \\ [])

@spec register(Tesla.Env.client(), AgentPushKit.Model.RegisterInput.t(), keyword()) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.AuthResponse.t()}
  | {:error, Tesla.Env.t()}

Create a user and first customer account

Parameters

connection (AgentPushKit.Connection): Connection to server
register_input (RegisterInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.AuthResponse.t} on success
{:error, Tesla.Env.t} on failure

request_password_reset(connection, password_reset_request_input, opts \\ [])

@spec request_password_reset(
  Tesla.Env.client(),
  AgentPushKit.Model.PasswordResetRequestInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.AcceptedResponse.t()}
  | {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Email a single-use password reset token

Parameters

connection (AgentPushKit.Connection): Connection to server
password_reset_request_input (PasswordResetRequestInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.AcceptedResponse.t} on success
{:error, Tesla.Env.t} on failure