Twilio.Numbers.V2.RegulatoryCompliance.BundleService (twilio_elixir v0.1.1)

Service for Bundle API operations.

Operations: list, create, fetch, update, delete

Summary

Functions

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

Create a new Bundle.

delete(client, sid, opts \\ [])

Delete a specific Bundle.

fetch(client, sid, opts \\ [])

Fetch a specific Bundle instance.

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

Retrieve a list of all Bundles for an account.

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

Stream: Retrieve a list of all Bundles for an account. (lazy auto-pagination).

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

Updates a Bundle in an account.

Functions

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

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Numbers.V2.RegulatoryCompliance.Bundle.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create a new Bundle.

Operation: CreateBundle | Tags: NumbersV2Bundle

Required Parameters

Parameter	Type	Description
`Email`	string	The email address that will receive updates when the Bundle resource changes status.
`FriendlyName`	string	The string that you assigned to describe the resource.

Optional Parameters

Parameter	Type	Description
`EndUserType`	string	Values: `individual`, `business`
`IsTest`	boolean	Indicates that Bundle is a Test Bundle and will be Auto-Rejected

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

| IsoCountry | string | The ISO country code of the Bundle's phone number country ownership request. |

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

`NumberType`	string	The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
`RegulationSid`	string	The unique string of a regulation that is associated to the Bundle resource.
`StatusCallback`	string (uri)	The URL we call to inform your application of status changes.

delete(client, sid, opts \\ [])

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

Delete a specific Bundle.

Operation: DeleteBundle | Tags: NumbersV2Bundle

fetch(client, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Numbers.V2.RegulatoryCompliance.Bundle.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Fetch a specific Bundle instance.

Operation: FetchBundle | Tags: NumbersV2Bundle

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

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

Retrieve a list of all Bundles for an account.

Operation: ListBundle | Tags: NumbersV2Bundle

Query Parameters

Parameter	Type	Description

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

| Status | string | The verification status of the Bundle resource. Please refer to Bundle Statuses for more details. |

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

| BundleSids | string | A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match ^BU[0-9a-fA-F]{32}$. |

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

| FriendlyName | string | The string that you assigned to describe the resource. The column can contain 255 variable characters. |

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

| RegulationSid | string | The unique string of a Regulation resource that is associated to the Bundle resource. |

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

| IsoCountry | string | The 2-digit ISO country code of the Bundle's phone number country ownership request. |

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

`NumberType`	string	The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
`EndUserType`	string	The end user type of the regulation of the Bundle. Can be `business` or `individual`.
`HasValidUntilDate`	boolean	Indicates that the Bundle is a valid Bundle until a specified expiration date.
`SortBy`	string	Can be `valid-until` or `date-updated`. Defaults to `date-created`.
`SortDirection`	string	Default is `DESC`. Can be `ASC` or `DESC`.

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

| ValidUntilDate | string (date-time) | Date to filter Bundles having their valid_until_date before or after the specified date. Can be ValidUntilDate>= or ValidUntilDate<=. Both can be used in conjunction as well. ISO 8601 is the acceptable date format. |

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

| ValidUntilDate< | string (date-time) | Date to filter Bundles having their valid_until_date before or after the specified date. Can be ValidUntilDate>= or ValidUntilDate<=. Both can be used in conjunction as well. ISO 8601 is the acceptable date format. |

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

| ValidUntilDate> | string (date-time) | Date to filter Bundles having their valid_until_date before or after the specified date. Can be ValidUntilDate>= or ValidUntilDate<=. Both can be used in conjunction as well. ISO 8601 is the acceptable date format. |

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

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

Stream: Retrieve a list of all Bundles for an account. (lazy auto-pagination).

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

@spec update(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Numbers.V2.RegulatoryCompliance.Bundle.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Updates a Bundle in an account.

Operation: UpdateBundle | Tags: NumbersV2Bundle

Optional Parameters

Parameter	Type	Description
`Email`	string	The email address that will receive updates when the Bundle resource changes status.
`FriendlyName`	string	The string that you assigned to describe the resource.

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

`Status`	string	Values: `draft`, `pending-review`, `in-review`, `twilio-rejected`, `twilio-approved`, `provisionally-approved`
`StatusCallback`	string (uri)	The URL we call to inform your application of status changes.