Twilio.Keys (twilio v0.2.0)

Copy Markdown

API calls: create, delete, list, retrieve, update.

Summary

Functions

POST /2010-04-01/Accounts/{AccountSid}/Keys.json

Like create/2, but returns the result or raises Infusion.Runtime.Error.

DELETE /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Like delete/2, but returns the result or raises Infusion.Runtime.Error.

GET /2010-04-01/Accounts/{AccountSid}/Keys.json

Like list/2, but returns the result or raises Infusion.Runtime.Error.

Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.Key.t() that fetches pages as it is read.

GET /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.

POST /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Functions

create(params \\ %{}, opts \\ [])

@spec create(map() | keyword(), keyword()) ::
  {:ok, Twilio.Schemas.NewKey.t()} | {:error, Infusion.Runtime.Error.t()}

POST /2010-04-01/Accounts/{AccountSid}/Keys.json

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • friendly_name - A descriptive string that you create to describe the resource. It can be up to 64 characters long.

create!(params \\ %{}, opts \\ [])

@spec create!(map() | keyword(), keyword()) :: Twilio.Schemas.NewKey.t()

Like create/2, but returns the result or raises Infusion.Runtime.Error.

delete(sid, opts \\ [])

@spec delete(String.t(), keyword()) ::
  {:ok, nil} | {:error, Infusion.Runtime.Error.t()}

DELETE /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Path parameters

  • sid (required) - The Twilio-provided string that uniquely identifies the Key resource to delete.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

delete!(sid, opts \\ [])

@spec delete!(String.t(), keyword()) :: nil

Like delete/2, but returns the result or raises Infusion.Runtime.Error.

list(params \\ %{}, opts \\ [])

@spec list(map() | keyword(), keyword()) ::
  {:ok, Twilio.Schemas.KeysListResponse.t()}
  | {:error, Infusion.Runtime.Error.t()}

GET /2010-04-01/Accounts/{AccountSid}/Keys.json

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • page_size - How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • page - The page index. This value is simply for client state.
  • page_token - The page token. This is provided by the API.

To read every item across all pages, use list_all.

list!(params \\ %{}, opts \\ [])

Like list/2, but returns the result or raises Infusion.Runtime.Error.

list_all(params \\ %{}, opts \\ [])

@spec list_all(map() | keyword(), keyword()) ::
  {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}

Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.Key.t() that fetches pages as it is read.

The first page is fetched right away, so its errors are returned; a later page that fails raises Infusion.Runtime.Error. Stopping early (Enum.take/2) fetches no more pages.

list_all!(params \\ %{}, opts \\ [])

@spec list_all!(map() | keyword(), keyword()) :: Enumerable.t()

Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.

retrieve(sid, opts \\ [])

@spec retrieve(String.t(), keyword()) ::
  {:ok, Twilio.Schemas.Key.t()} | {:error, Infusion.Runtime.Error.t()}

GET /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Path parameters

  • sid (required) - The Twilio-provided string that uniquely identifies the Key resource to fetch.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

retrieve!(sid, opts \\ [])

@spec retrieve!(String.t(), keyword()) :: Twilio.Schemas.Key.t()

Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.

update(sid, params \\ %{}, opts \\ [])

@spec update(String.t(), map() | keyword(), keyword()) ::
  {:ok, Twilio.Schemas.Key.t()} | {:error, Infusion.Runtime.Error.t()}

POST /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Path parameters

  • sid (required) - The Twilio-provided string that uniquely identifies the Key resource to update.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • friendly_name - A descriptive string that you create to describe the resource. It can be up to 64 characters long.

update!(sid, params \\ %{}, opts \\ [])

@spec update!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.Key.t()

Like update/3, but returns the result or raises Infusion.Runtime.Error.