HookSniffAPI.Api.Auth (HookSniff v0.3.0)

API calls for all endpoints tagged Auth.

Summary

Functions

auth2fa_confirm_post(connection, confirm2fa_request, opts \\ [])

Confirm 2FA setup with a code

auth2fa_disable_post(connection, disable2fa_request, opts \\ [])

Disable 2FA

auth2fa_enable_post(connection, enable2fa_request, opts \\ [])

Enable 2FA (returns TOTP secret and QR URL)

auth2fa_verify_post(connection, verify2fa_request, opts \\ [])

Verify 2FA code during login

auth_account_delete(connection, opts \\ [])

Delete account (GDPR)

auth_export_get(connection, opts \\ [])

Export user data (GDPR)

auth_forgot_password_post(connection, forgot_password_request, opts \\ [])

Request password reset email

auth_login_post(connection, login_request, opts \\ [])

auth_logout_post(connection, opts \\ [])

Logout (invalidate refresh token)

auth_me_get(connection, opts \\ [])

Get current user profile

auth_password_put(connection, change_password_request, opts \\ [])

Change password

auth_profile_put(connection, update_profile_request, opts \\ [])

Update profile

auth_refresh_post(connection, refresh_token_request, opts \\ [])

Refresh access token

auth_register_post(connection, register_request, opts \\ [])

auth_resend_verification_post(connection, resend_verification_request, opts \\ [])

Resend verification email

auth_reset_password_post(connection, reset_password_request, opts \\ [])

Reset password with token

auth_verify_email_post(connection, verify_email_request, opts \\ [])

Verify email address

Functions

auth2fa_confirm_post(connection, confirm2fa_request, opts \\ [])

@spec auth2fa_confirm_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.Confirm2faRequest.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Confirm 2FA setup with a code

Parameters

connection (HookSniffAPI.Connection): Connection to server
confirm2fa_request (Confirm2faRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth2fa_disable_post(connection, disable2fa_request, opts \\ [])

@spec auth2fa_disable_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.Disable2faRequest.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Disable 2FA

Parameters

connection (HookSniffAPI.Connection): Connection to server
disable2fa_request (Disable2faRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth2fa_enable_post(connection, enable2fa_request, opts \\ [])

@spec auth2fa_enable_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.Enable2faRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.Auth2faEnablePost200Response.t()}
  | {:error, Tesla.Env.t()}

Enable 2FA (returns TOTP secret and QR URL)

Parameters

connection (HookSniffAPI.Connection): Connection to server
enable2fa_request (Enable2faRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.Auth2faEnablePost200Response.t} on success
{:error, Tesla.Env.t} on failure

auth2fa_verify_post(connection, verify2fa_request, opts \\ [])

@spec auth2fa_verify_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.Verify2faRequest.t(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, HookSniffAPI.Model.AuthResponse.t()}
  | {:error, Tesla.Env.t()}

Verify 2FA code during login

Parameters

connection (HookSniffAPI.Connection): Connection to server
verify2fa_request (Verify2faRequest):
opts (keyword): Optional parameters

Returns

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

auth_account_delete(connection, opts \\ [])

@spec auth_account_delete(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Delete account (GDPR)

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth_export_get(connection, opts \\ [])

@spec auth_export_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Export user data (GDPR)

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth_forgot_password_post(connection, forgot_password_request, opts \\ [])

@spec auth_forgot_password_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.ForgotPasswordRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Request password reset email

Parameters

connection (HookSniffAPI.Connection): Connection to server
forgot_password_request (ForgotPasswordRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth_login_post(connection, login_request, opts \\ [])

@spec auth_login_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.LoginRequest.t(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, HookSniffAPI.Model.AuthLoginPost200Response.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (HookSniffAPI.Connection): Connection to server
login_request (LoginRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.AuthLoginPost200Response.t} on success
{:error, Tesla.Env.t} on failure

auth_logout_post(connection, opts \\ [])

@spec auth_logout_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Logout (invalidate refresh token)

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth_me_get(connection, opts \\ [])

@spec auth_me_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, HookSniffAPI.Model.CustomerResponse.t()} | {:error, Tesla.Env.t()}

Get current user profile

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.CustomerResponse.t} on success
{:error, Tesla.Env.t} on failure

auth_password_put(connection, change_password_request, opts \\ [])

@spec auth_password_put(
  Tesla.Env.client(),
  HookSniffAPI.Model.ChangePasswordRequest.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Change password

Parameters

connection (HookSniffAPI.Connection): Connection to server
change_password_request (ChangePasswordRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth_profile_put(connection, update_profile_request, opts \\ [])

@spec auth_profile_put(
  Tesla.Env.client(),
  HookSniffAPI.Model.UpdateProfileRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.CustomerResponse.t()} | {:error, Tesla.Env.t()}

Update profile

Parameters

connection (HookSniffAPI.Connection): Connection to server
update_profile_request (UpdateProfileRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.CustomerResponse.t} on success
{:error, Tesla.Env.t} on failure

auth_refresh_post(connection, refresh_token_request, opts \\ [])

@spec auth_refresh_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.RefreshTokenRequest.t(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, HookSniffAPI.Model.AuthResponse.t()}
  | {:error, Tesla.Env.t()}

Refresh access token

Parameters

connection (HookSniffAPI.Connection): Connection to server
refresh_token_request (RefreshTokenRequest):
opts (keyword): Optional parameters

Returns

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

auth_register_post(connection, register_request, opts \\ [])

@spec auth_register_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.RegisterRequest.t(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, HookSniffAPI.Model.Error.t()}
  | {:ok, HookSniffAPI.Model.CustomerResponse.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (HookSniffAPI.Connection): Connection to server
register_request (RegisterRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.CustomerResponse.t} on success
{:error, Tesla.Env.t} on failure

auth_resend_verification_post(connection, resend_verification_request, opts \\ [])

@spec auth_resend_verification_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.ResendVerificationRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Resend verification email

Parameters

connection (HookSniffAPI.Connection): Connection to server
resend_verification_request (ResendVerificationRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth_reset_password_post(connection, reset_password_request, opts \\ [])

@spec auth_reset_password_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.ResetPasswordRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Reset password with token

Parameters

connection (HookSniffAPI.Connection): Connection to server
reset_password_request (ResetPasswordRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

auth_verify_email_post(connection, verify_email_request, opts \\ [])

@spec auth_verify_email_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.VerifyEmailRequest.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Verify email address

Parameters

connection (HookSniffAPI.Connection): Connection to server
verify_email_request (VerifyEmailRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure