HookSniffAPI.Api.CustomerPortal (HookSniff v0.3.0)

API calls for all endpoints tagged CustomerPortal.

Summary

Functions

portal_api_keys_get(connection, opts \\ [])

List API keys (portal)

portal_api_keys_key_id_delete(connection, key_id, opts \\ [])

Revoke API key (portal)

portal_api_keys_post(connection, opts \\ [])

Create API key (portal)

portal_config_get(connection, opts \\ [])

Get portal configuration

portal_config_post(connection, opts \\ [])

Update portal configuration

portal_embed_code_get(connection, opts \\ [])

Get portal embed code

portal_me_get(connection, opts \\ [])

Get portal profile

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

Update portal profile

portal_notifications_get(connection, opts \\ [])

Get notification preferences (portal)

portal_notifications_put(connection, update_notification_preferences, opts \\ [])

Update notification preferences (portal)

portal_plan_get(connection, opts \\ [])

Get plan info (portal)

portal_usage_get(connection, opts \\ [])

Get usage (portal)

Functions

portal_api_keys_get(connection, opts \\ [])

@spec portal_api_keys_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [HookSniffAPI.Model.ApiKeyInfo.t()]} | {:error, Tesla.Env.t()}

List API keys (portal)

Parameters

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

Returns

{:ok, [%ApiKeyInfo{}, ...]} on success
{:error, Tesla.Env.t} on failure

portal_api_keys_key_id_delete(connection, key_id, opts \\ [])

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

Revoke API key (portal)

Parameters

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

Returns

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

portal_api_keys_post(connection, opts \\ [])

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

Create API key (portal)

Parameters

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

Returns

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

portal_config_get(connection, opts \\ [])

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

Get portal configuration

Parameters

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

Returns

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

portal_config_post(connection, opts \\ [])

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

Update portal configuration

Parameters

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

Returns

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

portal_embed_code_get(connection, opts \\ [])

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

Get portal embed code

Parameters

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

Returns

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

portal_me_get(connection, opts \\ [])

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

Get portal profile

Parameters

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

Returns

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

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

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

Update portal profile

Parameters

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

Returns

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

portal_notifications_get(connection, opts \\ [])

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

Get notification preferences (portal)

Parameters

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

Returns

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

portal_notifications_put(connection, update_notification_preferences, opts \\ [])

@spec portal_notifications_put(
  Tesla.Env.client(),
  HookSniffAPI.Model.UpdateNotificationPreferences.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.PortalNotificationsPut200Response.t()}
  | {:error, Tesla.Env.t()}

Update notification preferences (portal)

Parameters

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

Returns

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

portal_plan_get(connection, opts \\ [])

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

Get plan info (portal)

Parameters

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

Returns

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

portal_usage_get(connection, opts \\ [])

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

Get usage (portal)

Parameters

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

Returns

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