Current section
Files
Jump to
Current section
Files
lib/twilio/ipmessaging/v2/service/binding_service.ex
# File generated from Twilio's OpenAPI spec — do not edit manually
defmodule Twilio.IpMessaging.V2.Service.BindingService do
@moduledoc """
Service for Binding API operations.
Operations: `list`, `fetch`, `delete`
"""
alias Twilio.Client
alias Twilio.Deserializer
@doc """
Operation: `ListBinding` | Tags: IpMessagingV2Binding
## Query Parameters
| Parameter | Type | Description |
|-----------|------|-------------|
| `BindingType` | array | |
| `Identity` | array | |
"""
@spec list(Client.t(), String.t(), map(), keyword()) ::
{:ok, Twilio.Page.t()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()}
def list(client, service_sid, params \\ %{}, opts \\ []) do
case Client.request(client, :get, "/v2/Services/#{service_sid}/Bindings",
params: params,
opts: opts,
base_url: "https://ip-messaging.twilio.com"
) do
{:ok, data} ->
page = Twilio.Page.from_response(data, "bindings")
{:ok,
%{
page
| items:
Deserializer.deserialize_list(
page.items,
Twilio.Resources.IpMessaging.V2.Service.Binding
)
}}
error ->
error
end
end
@doc "Stream: (lazy auto-pagination)."
@spec stream(Client.t(), String.t(), map(), keyword()) :: Enumerable.t()
def stream(client, service_sid, params \\ %{}, opts \\ []) do
Twilio.Page.stream(
fn page_opts ->
list(client, service_sid, Map.merge(params, page_opts), opts)
end,
"bindings"
)
end
@doc """
Operation: `FetchBinding` | Tags: IpMessagingV2Binding
"""
@spec fetch(Client.t(), String.t(), String.t(), keyword()) ::
{:ok, Twilio.Resources.IpMessaging.V2.Service.Binding.t()}
| {:ok, map(), map()}
| :ok
| {:error, Twilio.Error.t()}
def fetch(client, service_sid, sid, opts \\ []) do
with {:ok, data} <-
Client.request(client, :get, "/v2/Services/#{service_sid}/Bindings/#{sid}",
opts: opts,
base_url: "https://ip-messaging.twilio.com"
) do
{:ok, Deserializer.deserialize(data, Twilio.Resources.IpMessaging.V2.Service.Binding)}
end
end
@doc """
Operation: `DeleteBinding` | Tags: IpMessagingV2Binding
"""
@spec delete(Client.t(), String.t(), String.t(), keyword()) ::
{:ok, map()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()}
def delete(client, service_sid, sid, opts \\ []) do
Client.request(client, :delete, "/v2/Services/#{service_sid}/Bindings/#{sid}",
opts: opts,
base_url: "https://ip-messaging.twilio.com"
)
end
end