sentdm 0.38.1 → 0.40.0

data/rbi/sentdm/resources/voice/calls.rbi

@@ -0,0 +1,244 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Voice
+      # Phone calls from the numbers you hold, driven by your own callback URL.
+      #
+      # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+      # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+      # short-lived token that lets a user of your app place and receive calls as that
+      # number. When a call arrives or a caller presses a key, a signed question is
+      # POSTed to the callback URL and the answer decides the call;
+      # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+      # before a real call reaches it, and
+      # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+      # The call events themselves (`call.completed` and the rest) arrive through your
+      # webhooks.
+      #
+      # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+      # once one is ready, hang it up, start or stop recording, and add, mute or remove
+      # conference participants while it is live. A leg to a phone number runs for at
+      # most what your balance affords at the destination's rate.
+      #
+      # **Voice agents.** `POST /v3/voice/agents` creates an agent that answers calls
+      # through the Sent Voice Gateway: `session_type` says whether Sent carries the
+      # call as text (speech recognised and spoken for the agent) or as audio,
+      # `websocket_url` is where the gateway dials the agent for each call (leave it out
+      # and the agent dials in with your API key), and `tools`, `transfer_targets`,
+      # `fallback` and `limits` say what it may do on a call. The agent's
+      # `signing_secret` is shown on create and on
+      # `POST /v3/voice/agents/{id}/rotate-secret` only. Voices and languages for text
+      # sessions come from `GET /v3/voice/voices`. A number takes calls to an agent once
+      # it is bound to it on `/v3/channels/voice`.
+      class Calls
+        # Phone calls from the numbers you hold, driven by your own callback URL.
+        #
+        # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+        # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+        # short-lived token that lets a user of your app place and receive calls as that
+        # number. When a call arrives or a caller presses a key, a signed question is
+        # POSTed to the callback URL and the answer decides the call;
+        # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+        # before a real call reaches it, and
+        # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+        # The call events themselves (`call.completed` and the rest) arrive through your
+        # webhooks.
+        #
+        # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+        # once one is ready, hang it up, start or stop recording, and add, mute or remove
+        # conference participants while it is live. A leg to a phone number runs for at
+        # most what your balance affords at the destination's rate.
+        #
+        # **Voice agents.** `POST /v3/voice/agents` creates an agent that answers calls
+        # through the Sent Voice Gateway: `session_type` says whether Sent carries the
+        # call as text (speech recognised and spoken for the agent) or as audio,
+        # `websocket_url` is where the gateway dials the agent for each call (leave it out
+        # and the agent dials in with your API key), and `tools`, `transfer_targets`,
+        # `fallback` and `limits` say what it may do on a call. The agent's
+        # `signing_secret` is shown on create and on
+        # `POST /v3/voice/agents/{id}/rotate-secret` only. Voices and languages for text
+        # sessions come from `GET /v3/voice/voices`. A number takes calls to an agent once
+        # it is bound to it on `/v3/channels/voice`.
+        sig { returns(Sentdm::Resources::Voice::Calls::Participants) }
+        attr_reader :participants
+
+        # Retrieves one of your calls by id: the parties, the owning number, the phone
+        # number the call was connected to and the caller id it showed, the current status
+        # with its failure reason, duration, price with the billed legs and what each
+        # cost, recording availability, and a timeline of when the call entered each
+        # status.
+        sig do
+          params(
+            id: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Voice::APIResponseOfCall)
+        end
+        def retrieve(
+          # The call id from the route, as carried by call webhooks and the calls list, for
+          # example call_9f2ab000-0000-4000-8000-000000000001
+          id,
+          # Profile UUID to scope the request to a child profile. Only organization API keys
+          # can use this header. The profile must belong to the calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a paginated list of your calls, most recent first. Filter by
+        # direction, status, the owning number, the mode (inapp, or agent for calls your
+        # voice agents answered), the agent that answered, and the time the call started
+        # (from and to are inclusive). Each call carries the phone number it was connected
+        # to, the caller id it showed, and the billed legs with what each cost. Use the
+        # call webhooks for real-time updates; this list is for looking calls up
+        # afterwards.
+        sig do
+          params(
+            agent_id: T.nilable(String),
+            direction: T.nilable(String),
+            from: T.nilable(Time),
+            mode: T.nilable(String),
+            number: T.nilable(String),
+            page: Integer,
+            page_size: Integer,
+            status: T.nilable(String),
+            to: T.nilable(Time),
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Internal::CallsPage[Sentdm::Voice::Call])
+        end
+        def list(
+          # Query param: Optional filter on the voice agent that answered the call, such as
+          # agent_9f2ab000-0000-4000-8000-000000000001
+          agent_id: nil,
+          # Query param: Optional direction filter: outbound for calls placed from your app,
+          # inbound for calls to one of your numbers
+          direction: nil,
+          # Query param: Only calls started at or after this time (ISO 8601)
+          from: nil,
+          # Query param: Optional mode filter: inapp for calls routed by your number's
+          # callback URL, agent for calls one of your voice agents answered
+          mode: nil,
+          # Query param: Optional filter on the number that owns the call, one of your
+          # voice-enabled numbers in E.164 format
+          number: nil,
+          # Query param: Page number (1-indexed)
+          page: nil,
+          # Query param: Number of items per page
+          page_size: nil,
+          # Query param: Optional status filter: initiated, ringing, answered, completed,
+          # failed, no_answer or rejected
+          status: nil,
+          # Query param: Only calls started at or before this time (ISO 8601)
+          to: nil,
+          # Header param: Profile UUID to scope the request to a child profile. Only
+          # organization API keys can use this header. The profile must belong to the
+          # calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Ends one of your live calls. The call then ends the way any other call does once
+        # the disconnect is reported: an answered call as COMPLETED with call.completed, a
+        # call still ringing as NO_ANSWER, REJECTED or FAILED with call.failed. A call
+        # that has already ended answers 409, as do a call with no phone leg, such as one
+        # between two app users, and a call one of your voice agents answers.
+        sig do
+          params(
+            id: String,
+            sandbox: T::Boolean,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).void
+        end
+        def hangup(
+          # Path param: The call id from the route, as carried by call webhooks and the
+          # calls list, for example call_9f2ab000-0000-4000-8000-000000000001
+          id,
+          # Body param: Sandbox flag - when true, the operation is simulated without side
+          # effects Useful for testing integrations without actual execution
+          sandbox: nil,
+          # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+          # hours per key per customer.
+          idempotency_key: nil,
+          # Header param: Profile UUID to scope the request to a child profile. Only
+          # organization API keys can use this header. The profile must belong to the
+          # calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns pre-signed links to the recordings of one of your calls, each valid
+        # until its url_expires_at. A recording appears once the call was recorded, by a
+        # connect answer with record set, a startRecording instruction or the recordings
+        # command, and the call.recording_ready webhook has been sent; until then, and for
+        # a call that was never recorded, the list is empty. A call recorded more than
+        # once lists every recording, oldest first, each under the recording_id its
+        # call.recording_ready webhook carried.
+        sig do
+          params(
+            id: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Voice::APIResponseOfCallRecordings)
+        end
+        def list_recordings(
+          # The call id from the route, as carried by call webhooks and the calls list, for
+          # example call_9f2ab000-0000-4000-8000-000000000001
+          id,
+          # Profile UUID to scope the request to a child profile. Only organization API keys
+          # can use this header. The profile must belong to the calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Starts or stops recording one of your live calls. Use start to begin recording
+        # mid-call, or stop to end a recording, whether it was started here or by a
+        # connect answer with record set. A call that has already ended answers 409, as do
+        # a call with no phone leg, such as one between two app users, and a call one of
+        # your voice agents answers, neither of which can be recorded this way.
+        sig do
+          params(
+            id: String,
+            action: String,
+            sandbox: T::Boolean,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).void
+        end
+        def record(
+          # Path param: The call id from the route, as carried by call webhooks and the
+          # calls list, for example call_9f2ab000-0000-4000-8000-000000000001
+          id,
+          # Body param: start to begin recording, stop to end it
+          action: nil,
+          # Body param: Sandbox flag - when true, the operation is simulated without side
+          # effects Useful for testing integrations without actual execution
+          sandbox: nil,
+          # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+          # hours per key per customer.
+          idempotency_key: nil,
+          # Header param: Profile UUID to scope the request to a child profile. Only
+          # organization API keys can use this header. The profile must belong to the
+          # calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Sentdm::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/voice/catalogue.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Voice
+      # Phone calls from the numbers you hold, driven by your own callback URL.
+      #
+      # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+      # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+      # short-lived token that lets a user of your app place and receive calls as that
+      # number. When a call arrives or a caller presses a key, a signed question is
+      # POSTed to the callback URL and the answer decides the call;
+      # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+      # before a real call reaches it, and
+      # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+      # The call events themselves (`call.completed` and the rest) arrive through your
+      # webhooks.
+      #
+      # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+      # once one is ready, hang it up, start or stop recording, and add, mute or remove
+      # conference participants while it is live. A leg to a phone number runs for at
+      # most what your balance affords at the destination's rate.
+      #
+      # **Voice agents.** `POST /v3/voice/agents` creates an agent that answers calls
+      # through the Sent Voice Gateway: `session_type` says whether Sent carries the
+      # call as text (speech recognised and spoken for the agent) or as audio,
+      # `websocket_url` is where the gateway dials the agent for each call (leave it out
+      # and the agent dials in with your API key), and `tools`, `transfer_targets`,
+      # `fallback` and `limits` say what it may do on a call. The agent's
+      # `signing_secret` is shown on create and on
+      # `POST /v3/voice/agents/{id}/rotate-secret` only. Voices and languages for text
+      # sessions come from `GET /v3/voice/voices`. A number takes calls to an agent once
+      # it is bound to it on `/v3/channels/voice`.
+      class Catalogue
+        # The names a voice agent's `speech.voice` and `speech.language` accept, with the
+        # default marked. The list grows as voices are added; a name is never removed
+        # without notice.
+        sig do
+          params(
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Voice::APIResponseOfVoiceCatalogue)
+        end
+        def list(
+          # Profile UUID to scope the request to a child profile. Only organization API keys
+          # can use this header. The profile must belong to the calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Sentdm::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/voice/tokens.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Voice
+      # Phone calls from the numbers you hold, driven by your own callback URL.
+      #
+      # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+      # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+      # short-lived token that lets a user of your app place and receive calls as that
+      # number. When a call arrives or a caller presses a key, a signed question is
+      # POSTed to the callback URL and the answer decides the call;
+      # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+      # before a real call reaches it, and
+      # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+      # The call events themselves (`call.completed` and the rest) arrive through your
+      # webhooks.
+      #
+      # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+      # once one is ready, hang it up, start or stop recording, and add, mute or remove
+      # conference participants while it is live. A leg to a phone number runs for at
+      # most what your balance affords at the destination's rate.
+      #
+      # **Voice agents.** `POST /v3/voice/agents` creates an agent that answers calls
+      # through the Sent Voice Gateway: `session_type` says whether Sent carries the
+      # call as text (speech recognised and spoken for the agent) or as audio,
+      # `websocket_url` is where the gateway dials the agent for each call (leave it out
+      # and the agent dials in with your API key), and `tools`, `transfer_targets`,
+      # `fallback` and `limits` say what it may do on a call. The agent's
+      # `signing_secret` is shown on create and on
+      # `POST /v3/voice/agents/{id}/rotate-secret` only. Voices and languages for text
+      # sessions come from `GET /v3/voice/voices`. A number takes calls to an agent once
+      # it is bound to it on `/v3/channels/voice`.
+      class Tokens
+        # Mints a short-lived token for one of your app users. Call this from your backend
+        # and return the token to your app, which passes it to the voice client SDK to
+        # register. The identity is bound to the given number, or to your default app-call
+        # number when omitted, and calls placed by that identity are routed through the
+        # bound number. Minting again re-binds the identity, so an identity can move
+        # between numbers.
+        sig do
+          params(
+            identity: String,
+            number: T.nilable(String),
+            sandbox: T::Boolean,
+            ttl: T.nilable(Integer),
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Voice::APIResponseOfVoiceToken)
+        end
+        def create(
+          # Body param: Your identifier for the app user, such as an agent or account id.
+          # Letters, digits, hyphens and underscores only, up to 200 characters.
+          identity: nil,
+          # Body param: One of your voice-enabled phone numbers in E.164 format. Calls
+          # placed by this identity are routed through that number. Omit to use your default
+          # app-call number.
+          number: nil,
+          # Body param: Sandbox flag - when true, the operation is simulated without side
+          # effects Useful for testing integrations without actual execution
+          sandbox: nil,
+          # Body param: Token lifetime in seconds. Defaults to 600 and cannot exceed 3600.
+          ttl: nil,
+          # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+          # hours per key per customer.
+          idempotency_key: nil,
+          # Header param: Profile UUID to scope the request to a child profile. Only
+          # organization API keys can use this header. The profile must belong to the
+          # calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Sentdm::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/voice.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Voice
+      # Phone calls from the numbers you hold, driven by your own callback URL.
+      #
+      # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+      # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+      # short-lived token that lets a user of your app place and receive calls as that
+      # number. When a call arrives or a caller presses a key, a signed question is
+      # POSTed to the callback URL and the answer decides the call;
+      # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+      # before a real call reaches it, and
+      # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+      # The call events themselves (`call.completed` and the rest) arrive through your
+      # webhooks.
+      #
+      # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+      # once one is ready, hang it up, start or stop recording, and add, mute or remove
+      # conference participants while it is live. A leg to a phone number runs for at
+      # most what your balance affords at the destination's rate.
+      #
+      # **Voice agents.** `POST /v3/voice/agents` creates an agent that answers calls
+      # through the Sent Voice Gateway: `session_type` says whether Sent carries the
+      # call as text (speech recognised and spoken for the agent) or as audio,
+      # `websocket_url` is where the gateway dials the agent for each call (leave it out
+      # and the agent dials in with your API key), and `tools`, `transfer_targets`,
+      # `fallback` and `limits` say what it may do on a call. The agent's
+      # `signing_secret` is shown on create and on
+      # `POST /v3/voice/agents/{id}/rotate-secret` only. Voices and languages for text
+      # sessions come from `GET /v3/voice/voices`. A number takes calls to an agent once
+      # it is bound to it on `/v3/channels/voice`.
+      sig { returns(Sentdm::Resources::Voice::Calls) }
+      attr_reader :calls
+
+      # Phone calls from the numbers you hold, driven by your own callback URL.
+      #
+      # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+      # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+      # short-lived token that lets a user of your app place and receive calls as that
+      # number. When a call arrives or a caller presses a key, a signed question is
+      # POSTed to the callback URL and the answer decides the call;
+      # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+      # before a real call reaches it, and
+      # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+      # The call events themselves (`call.completed` and the rest) arrive through your
+      # webhooks.
+      #
+      # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+      # once one is ready, hang it up, start or stop recording, and add, mute or remove
+      # conference participants while it is live. A leg to a phone number runs for at
+      # most what your balance affords at the destination's rate.
+      #
+      # **Voice agents.** `POST /v3/voice/agents` creates an agent that answers calls
+      # through the Sent Voice Gateway: `session_type` says whether Sent carries the
+      # call as text (speech recognised and spoken for the agent) or as audio,
+      # `websocket_url` is where the gateway dials the agent for each call (leave it out
+      # and the agent dials in with your API key), and `tools`, `transfer_targets`,
+      # `fallback` and `limits` say what it may do on a call. The agent's
+      # `signing_secret` is shown on create and on
+      # `POST /v3/voice/agents/{id}/rotate-secret` only. Voices and languages for text
+      # sessions come from `GET /v3/voice/voices`. A number takes calls to an agent once
+      # it is bound to it on `/v3/channels/voice`.
+      sig { returns(Sentdm::Resources::Voice::Tokens) }
+      attr_reader :tokens
+
+      # Phone calls from the numbers you hold, driven by your own callback URL.
+      #
+      # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+      # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+      # short-lived token that lets a user of your app place and receive calls as that
+      # number. When a call arrives or a caller presses a key, a signed question is
+      # POSTed to the callback URL and the answer decides the call;
+      # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+      # before a real call reaches it, and
+      # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+      # The call events themselves (`call.completed` and the rest) arrive through your
+      # webhooks.
+      #
+      # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+      # once one is ready, hang it up, start or stop recording, and add, mute or remove
+      # conference participants while it is live. A leg to a phone number runs for at
+      # most what your balance affords at the destination's rate.
+      #
+      # **Voice agents.** `POST /v3/voice/agents` creates an agent that answers calls
+      # through the Sent Voice Gateway: `session_type` says whether Sent carries the
+      # call as text (speech recognised and spoken for the agent) or as audio,
+      # `websocket_url` is where the gateway dials the agent for each call (leave it out
+      # and the agent dials in with your API key), and `tools`, `transfer_targets`,
+      # `fallback` and `limits` say what it may do on a call. The agent's
+      # `signing_secret` is shown on create and on
+      # `POST /v3/voice/agents/{id}/rotate-secret` only. Voices and languages for text
+      # sessions come from `GET /v3/voice/voices`. A number takes calls to an agent once
+      # it is bound to it on `/v3/channels/voice`.
+      sig { returns(Sentdm::Resources::Voice::Agents) }
+      attr_reader :agents
+
+      # Phone calls from the numbers you hold, driven by your own callback URL.
+      #
+      # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+      # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+      # short-lived token that lets a user of your app place and receive calls as that
+      # number. When a call arrives or a caller presses a key, a signed question is
+      # POSTed to the callback URL and the answer decides the call;
+      # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+      # before a real call reaches it, and
+      # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+      # The call events themselves (`call.completed` and the rest) arrive through your
+      # webhooks.
+      #
+      # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+      # once one is ready, hang it up, start or stop recording, and add, mute or remove
+      # conference participants while it is live. A leg to a phone number runs for at
+      # most what your balance affords at the destination's rate.
+      #
+      # **Voice agents.** `POST /v3/voice/agents` creates an agent that answers calls
+      # through the Sent Voice Gateway: `session_type` says whether Sent carries the
+      # call as text (speech recognised and spoken for the agent) or as audio,
+      # `websocket_url` is where the gateway dials the agent for each call (leave it out
+      # and the agent dials in with your API key), and `tools`, `transfer_targets`,
+      # `fallback` and `limits` say what it may do on a call. The agent's
+      # `signing_secret` is shown on create and on
+      # `POST /v3/voice/agents/{id}/rotate-secret` only. Voices and languages for text
+      # sessions come from `GET /v3/voice/voices`. A number takes calls to an agent once
+      # it is bound to it on `/v3/channels/voice`.
+      sig { returns(Sentdm::Resources::Voice::Catalogue) }
+      attr_reader :catalogue
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end