Twilio.Numbers.V1.SigningRequest.ConfigurationService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Configuration API operations.

Operations: list, create

Summary

Functions

Synchronous operation to insert or update a configuration for the customer.

Synchronous operation to retrieve configurations for the customer.

Stream: Synchronous operation to retrieve configurations for the customer. (lazy auto-pagination).

Functions

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

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Numbers.V1.SigningRequest.Configuration.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Synchronous operation to insert or update a configuration for the customer.

Operation: CreateSigningRequestConfiguration | Tags: NumbersV1SigningRequestConfiguration

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

@spec list(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Synchronous operation to retrieve configurations for the customer.

Operation: ListSigningRequestConfiguration | Tags: NumbersV1SigningRequestConfiguration

Query Parameters

ParameterTypeDescription
CountrystringThe country ISO code to apply this configuration, this is an optional field, Example: US, MX

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| Product | string | The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting |

stream(client, params \\ %{}, opts \\ [])

@spec stream(Twilio.Client.t(), map(), keyword()) :: Enumerable.t()

Stream: Synchronous operation to retrieve configurations for the customer. (lazy auto-pagination).