# File generated from Twilio's OpenAPI spec — do not edit manually defmodule Twilio.Messaging.V1.Service.ShortCodeService do @moduledoc """ A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service. Operations: `list`, `create`, `fetch`, `delete` """ alias Twilio.Client alias Twilio.Deserializer @doc """ Operation: `ListShortCode` | Tags: MessagingV1ShortCode """ @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, "/v1/Services/#{service_sid}/ShortCodes", params: params, opts: opts, base_url: "https://messaging.twilio.com" ) do {:ok, data} -> page = Twilio.Page.from_response(data, "short_codes") {:ok, %{ page | items: Deserializer.deserialize_list( page.items, Twilio.Resources.Messaging.V1.Service.ShortCode ) }} 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, "short_codes" ) end @doc """ Operation: `CreateShortCode` | Tags: MessagingV1ShortCode ## Required Parameters | Parameter | Type | Description | |-----------|------|-------------| | `ShortCodeSid` | string | The SID of the ShortCode resource being added to the Service. | """ @spec create(Client.t(), String.t(), map(), keyword()) :: {:ok, Twilio.Resources.Messaging.V1.Service.ShortCode.t()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()} def create(client, service_sid, params \\ %{}, opts \\ []) do with {:ok, data} <- Client.request(client, :post, "/v1/Services/#{service_sid}/ShortCodes", params: params, opts: opts, base_url: "https://messaging.twilio.com", content_type: :form ) do {:ok, Deserializer.deserialize(data, Twilio.Resources.Messaging.V1.Service.ShortCode)} end end @doc """ Operation: `FetchShortCode` | Tags: MessagingV1ShortCode """ @spec fetch(Client.t(), String.t(), String.t(), keyword()) :: {:ok, Twilio.Resources.Messaging.V1.Service.ShortCode.t()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()} def fetch(client, service_sid, sid, opts \\ []) do with {:ok, data} <- Client.request(client, :get, "/v1/Services/#{service_sid}/ShortCodes/#{sid}", opts: opts, base_url: "https://messaging.twilio.com" ) do {:ok, Deserializer.deserialize(data, Twilio.Resources.Messaging.V1.Service.ShortCode)} end end @doc """ Operation: `DeleteShortCode` | Tags: MessagingV1ShortCode """ @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, "/v1/Services/#{service_sid}/ShortCodes/#{sid}", opts: opts, base_url: "https://messaging.twilio.com" ) end end