Twilio.Supersim.V1.ESimProfileService (twilio_elixir v0.1.1)

eSIM Profiles that can be loaded onto consumer eUICC SIMs

Operations: list, create, fetch

Summary

Functions

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

Order an eSIM Profile.

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

Fetch an eSIM Profile.

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

Retrieve a list of eSIM Profiles.

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

Stream: Retrieve a list of eSIM Profiles. (lazy auto-pagination).

Functions

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

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

Order an eSIM Profile.

Operation: CreateEsimProfile | Tags: SupersimV1EsimProfile

Optional Parameters

Parameter	Type	Description

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

| CallbackMethod | string (http-method) | The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST. Values: GET, POST |

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

`CallbackUrl`	string	The URL we should call using the `callback_method` when the status of the eSIM Profile changes. At this stage of the eSIM Profile pilot, the a request to the URL will only be called when the ESimProfile resource changes from `reserving` to `available`.
`Eid`	string	Identifier of the eUICC that will claim the eSIM Profile.

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

| GenerateMatchingId | boolean | When set to true, a value for Eid does not need to be provided. Instead, when the eSIM profile is reserved, a matching ID will be generated and returned via the matching_id property. This identifies the specific eSIM profile that can be used by any capable device to claim and download the profile. |

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

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Supersim.V1.ESimProfile.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Fetch an eSIM Profile.

Operation: FetchEsimProfile | Tags: SupersimV1EsimProfile

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 eSIM Profiles.

Operation: ListEsimProfile | Tags: SupersimV1EsimProfile

Query Parameters

Parameter	Type	Description
`Eid`	string	List the eSIM Profiles that have been associated with an EId.

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

`SimSid`	string	Find the eSIM Profile resource related to a Sim resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
`Status`	string	List the eSIM Profiles that are in a given status.

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

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

Stream: Retrieve a list of eSIM Profiles. (lazy auto-pagination).