placetel_api v2.0.1

View Source PlacetelAPI.Api.SipUsers (placetel_api v2.0.1)

API calls for all endpoints tagged SipUsers.

Link to this section Summary

Functions

delete_sip_users_id(connection, id, opts \\ [])

Delete a sip user Delete a sip user by its ID

delete_sip_users_id_short_codes_code_id(connection, id, code_id, opts \\ [])

Delete short code Delete sip user short code

get_sip_users(connection, opts \\ [])

Fetch all sip users Fetch a list of all sip users

get_sip_users_id(connection, id, opts \\ [])

Fetch a sip user Fetch a sip users by its ID

get_sip_users_id_short_codes(connection, id, opts \\ [])

Short codes List sip user short codes

post_sip_users(connection, sip_users, opts \\ [])

Create a sip user Create a new sip user

post_sip_users_id_short_codes(connection, id, sip_users_id_short_codes, opts \\ [])

Create short code Create sip user short code

put_sip_users_id(connection, id, sip_users, opts \\ [])

Update a sip user Update a sip user by its ID

Link to this section Functions

Link to this function

delete_sip_users_id(connection, id, opts \\ [])

View Source 
@spec delete_sip_users_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, PlacetelAPI.Model.SipUser.t()} | {:error, Tesla.Env.t()}

Delete a sip user Delete a sip user by its ID

parameters

 Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (integer()): Sip user ID
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, PlacetelAPI.Model.SipUser.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_sip_users_id_short_codes_code_id(connection, id, code_id, opts \\ [])

View Source 
@spec delete_sip_users_id_short_codes_code_id(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) :: {:ok, PlacetelAPI.Model.ShortCode.t()} | {:error, Tesla.Env.t()}

Delete short code Delete sip user short code

parameters

 Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (integer()): Sip user ID
  • code_id (integer()): Short code ID
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, PlacetelAPI.Model.ShortCode.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_sip_users(connection, opts \\ [])

View Source 
@spec get_sip_users(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [PlacetelAPI.Model.SipUser.t()]} | {:error, Tesla.Env.t()}

Fetch all sip users Fetch a list of all sip users

parameters

 Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :"filter[did]" (integer()):
    • :"filter[username]" (String.t):
    • :"filter[name]" (String.t):
    • :"filter[description]" (String.t):
    • :page (integer()): Page of results to fetch.
    • :per_page (integer()): Number of results to return per page.

returns

 Returns

  • {:ok, [%SipUser{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_sip_users_id(connection, id, opts \\ [])

View Source 
@spec get_sip_users_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, PlacetelAPI.Model.SipUser.t()} | {:error, Tesla.Env.t()}

Fetch a sip user Fetch a sip users by its ID

parameters

 Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (integer()): Sip user ID
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, PlacetelAPI.Model.SipUser.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_sip_users_id_short_codes(connection, id, opts \\ [])

View Source 
@spec get_sip_users_id_short_codes(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, PlacetelAPI.Model.ShortCode.t()} | {:error, Tesla.Env.t()}

Short codes List sip user short codes

parameters

 Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (integer()): Sip user ID
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, PlacetelAPI.Model.ShortCode.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_sip_users(connection, sip_users, opts \\ [])

View Source 
@spec post_sip_users(
  Tesla.Env.client(),
  PlacetelAPI.Model.PostSipUsers.t(),
  keyword()
) ::
  {:ok, PlacetelAPI.Model.SipUser.t()} | {:error, Tesla.Env.t()}

Create a sip user Create a new sip user

parameters

 Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • sip_users (PostSipUsers):
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, PlacetelAPI.Model.SipUser.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_sip_users_id_short_codes(connection, id, sip_users_id_short_codes, opts \\ [])

View Source 
@spec post_sip_users_id_short_codes(
  Tesla.Env.client(),
  integer(),
  PlacetelAPI.Model.PostSipUsersIdShortCodes.t(),
  keyword()
) :: {:ok, PlacetelAPI.Model.ShortCode.t()} | {:error, Tesla.Env.t()}

Create short code Create sip user short code

parameters

 Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (integer()): Sip user ID
  • sip_users_id_short_codes (PostSipUsersIdShortCodes):
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, PlacetelAPI.Model.ShortCode.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

put_sip_users_id(connection, id, sip_users, opts \\ [])

View Source 
@spec put_sip_users_id(
  Tesla.Env.client(),
  integer(),
  PlacetelAPI.Model.PutSipUsers.t(),
  keyword()
) :: {:ok, PlacetelAPI.Model.SipUser.t()} | {:error, Tesla.Env.t()}

Update a sip user Update a sip user by its ID

parameters

 Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (integer()): Sip user ID
  • sip_users (PutSipUsers):
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, PlacetelAPI.Model.SipUser.t} on success
  • {:error, Tesla.Env.t} on failure