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

API calls for all endpoints tagged Faxes.

Link to this section Summary

Functions

Delete a fax Delete a fax by its ID

Fetch in- and outbound faxes Provides a list of all faxes

Fetch specific fax Fetch in- or outbound fax

Create outbound fax Sends faxes via API call

Link to this section Functions

Link to this function

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

View Source
@spec delete_faxes_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete a fax Delete a fax by its ID

parameters

Parameters

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

returns

Returns

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

get_faxes(connection, opts \\ [])

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

Fetch in- and outbound faxes Provides a list of all faxes

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :"filter[type]" (String.t):
    • :"filter[from_number]" (String.t):
    • :"filter[to_number]" (String.t):
    • :order (String.t):
    • :page (integer()): Page of results to fetch.
    • :per_page (integer()): Number of results to return per page.

returns

Returns

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

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

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

Fetch specific fax Fetch in- or outbound fax

parameters

Parameters

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

returns

Returns

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

post_faxes(connection, faxes, opts \\ [])

View Source
@spec post_faxes(Tesla.Env.client(), PlacetelAPI.Model.PostFaxes.t(), keyword()) ::
  {:ok, PlacetelAPI.Model.Fax.t()} | {:error, Tesla.Env.t()}

Create outbound fax Sends faxes via API call

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • faxes (PostFaxes):
  • opts (keyword): Optional parameters

returns

Returns

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