AgentPushKit.Api.Preferences (agent_push_kit v0.1.0)

API calls for all endpoints tagged Preferences.

Summary

Functions

list_preferences(connection, organization_id, opts \\ [])

List service defaults and exact-type overrides

remove_type_preference(connection, service_id, type, opts \\ [])

Remove an exact-type override so it inherits the service default

set_service_preference(connection, service_id, set_enabled_input, opts \\ [])

Enable or disable pushes for a service by default

set_type_preference(connection, service_id, type, set_enabled_input, opts \\ [])

Override push delivery for one exact notification type

Functions

list_preferences(connection, organization_id, opts \\ [])

@spec list_preferences(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, [AgentPushKit.Model.ServicePreference.t()]}
  | {:error, Tesla.Env.t()}

List service defaults and exact-type overrides

Parameters

connection (AgentPushKit.Connection): Connection to server
organization_id (String.t):
opts (keyword): Optional parameters

Returns

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

remove_type_preference(connection, service_id, type, opts \\ [])

@spec remove_type_preference(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, AgentPushKit.Model.InheritedResponse.t()}
  | {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Remove an exact-type override so it inherits the service default

Parameters

connection (AgentPushKit.Connection): Connection to server
service_id (String.t):
type (String.t):
opts (keyword): Optional parameters

Returns

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

set_service_preference(connection, service_id, set_enabled_input, opts \\ [])

@spec set_service_preference(
  Tesla.Env.client(),
  String.t(),
  AgentPushKit.Model.SetEnabledInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.PreferenceRecord.t()}
  | {:error, Tesla.Env.t()}

Enable or disable pushes for a service by default

Parameters

connection (AgentPushKit.Connection): Connection to server
service_id (String.t):
set_enabled_input (SetEnabledInput):
opts (keyword): Optional parameters

Returns

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

set_type_preference(connection, service_id, type, set_enabled_input, opts \\ [])

@spec set_type_preference(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  AgentPushKit.Model.SetEnabledInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.PreferenceRecord.t()}
  | {:error, Tesla.Env.t()}

Override push delivery for one exact notification type

Parameters

connection (AgentPushKit.Connection): Connection to server
service_id (String.t):
type (String.t):
set_enabled_input (SetEnabledInput):
opts (keyword): Optional parameters

Returns

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