Twilio.IpMessaging.V2.CredentialService (twilio_elixir v0.1.1)

Service for Credential API operations.

Operations: list, create, fetch, update, delete

Summary

Functions

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

Operation: CreateCredential | Tags: IpMessagingV2Credential

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

Operation: DeleteCredential | Tags: IpMessagingV2Credential

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

Operation: FetchCredential | Tags: IpMessagingV2Credential

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

Operation: ListCredential | Tags: IpMessagingV2Credential

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

Stream: (lazy auto-pagination).

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

Operation: UpdateCredential | Tags: IpMessagingV2Credential

Functions

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

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

Operation: CreateCredential | Tags: IpMessagingV2Credential

Required Parameters

Parameter	Type	Description
`Type`	string	Values: `gcm`, `apn`, `fcm`

Optional Parameters

Parameter	Type	Description
`ApiKey`	string
`Certificate`	string
`FriendlyName`	string
`PrivateKey`	string
`Sandbox`	boolean
`Secret`	string

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

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

Operation: DeleteCredential | Tags: IpMessagingV2Credential

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

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

Operation: FetchCredential | Tags: IpMessagingV2Credential

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

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

Operation: ListCredential | Tags: IpMessagingV2Credential

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

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

Stream: (lazy auto-pagination).

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

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

Operation: UpdateCredential | Tags: IpMessagingV2Credential

Optional Parameters

Parameter	Type	Description
`ApiKey`	string
`Certificate`	string
`FriendlyName`	string
`PrivateKey`	string
`Sandbox`	boolean
`Secret`	string