AgentPushKit.Api.CustomerAccounts (agent_push_kit v0.1.0)

API calls for all endpoints tagged CustomerAccounts.

Summary

Functions

add_organization_member(connection, organization_id, add_member_input, opts \\ [])

Add an already-registered user to a customer account

create_organization(connection, create_organization_input, opts \\ [])

Create another Agent Push Kit customer account

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

List members of a customer account

list_organizations(connection, opts \\ [])

List customer accounts available to the current user

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

Rotate the application event-ingestion key The previous apk_ key stops working immediately. The replacement is returned only in this response.

Functions

add_organization_member(connection, organization_id, add_member_input, opts \\ [])

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

Add an already-registered user to a customer account

Parameters

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

Returns

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

create_organization(connection, create_organization_input, opts \\ [])

@spec create_organization(
  Tesla.Env.client(),
  AgentPushKit.Model.CreateOrganizationInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.OrganizationCreated.t()}
  | {:error, Tesla.Env.t()}

Create another Agent Push Kit customer account

Parameters

connection (AgentPushKit.Connection): Connection to server
create_organization_input (CreateOrganizationInput):
opts (keyword): Optional parameters

Returns

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

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

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

List members of a customer account

Parameters

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

Returns

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

list_organizations(connection, opts \\ [])

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

List customer accounts available to the current user

Parameters

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

Returns

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

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

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

Rotate the application event-ingestion key The previous apk_ key stops working immediately. The replacement is returned only in this response.

Parameters

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

Returns

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