Twilio.ConnectApps (twilio v0.2.0)

Copy Markdown

API calls: delete, list, retrieve, update.

Summary

Functions

Delete an instance of a connect-app

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

Retrieve a list of connect-apps belonging to the account used to make the request

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.ConnectApp.t() that fetches pages as it is read.

Fetch an instance of a connect-app

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

Update a connect-app with the specified parameters

Functions

delete(sid, opts \\ [])

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

Delete an instance of a connect-app

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

Path parameters

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

{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 \\ [])

Retrieve a list of connect-apps belonging to the account used to make the request

GET /2010-04-01/Accounts/{AccountSid}/ConnectApps.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.ConnectApp.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.ConnectApp.t()} | {:error, Infusion.Runtime.Error.t()}

Fetch an instance of a connect-app

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

Path parameters

  • sid (required) - The Twilio-provided string that uniquely identifies the ConnectApp 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.ConnectApp.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.ConnectApp.t()} | {:error, Infusion.Runtime.Error.t()}

Update a connect-app with the specified parameters

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

Path parameters

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

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

Parameters

  • authorize_redirect_url - The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.
  • company_name - The company name to set for the Connect App.
  • deauthorize_callback_method - The HTTP method to use when calling deauthorize_callback_url.
  • deauthorize_callback_url - The URL to call using the deauthorize_callback_method to de-authorize the Connect App.
  • description - A description of the Connect App.
  • friendly_name - A descriptive string that you create to describe the resource. It can be up to 64 characters long.
  • homepage_url - A public URL where users can obtain more information about this Connect App.
  • permissions - A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: get-all and post-all.

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

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

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