sentdm 0.38.0 → 0.39.0

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

@@ -0,0 +1,209 @@
+# 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.
+      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.
+        sig { returns(Sentdm::Resources::Voice::Calls::Participants) }
+        attr_reader :participants
+
+        # Retrieves one of your calls by id: the parties, the owning number, the current
+        # status with its failure reason, duration, price, 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, and the time the call started (from and to
+        # are inclusive). Use the call webhooks for real-time updates; this list is for
+        # looking calls up afterwards.
+        sig do
+          params(
+            direction: T.nilable(String),
+            from: T.nilable(Time),
+            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 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 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, and so does a call with no phone leg, such
+        # as one between two app users.
+        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, and
+        # so does a call with no phone leg, such as one between two app users, which can't
+        # be recorded.
+        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/tokens.rbi

@@ -0,0 +1,73 @@
+# 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.
+      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,52 @@
+# 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.
+      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.
+      sig { returns(Sentdm::Resources::Voice::Tokens) }
+      attr_reader :tokens
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/sentdm/client.rbs

@@ -26,7 +26,7 @@ module Sentdm
 
     attr_reader conversations: Sentdm::Resources::Conversations
 
-    attr_reader calls: Sentdm::Resources::Calls
+    attr_reader voice: Sentdm::Resources::Voice
 
     attr_reader channels: Sentdm::Resources::Channels
 

data/sig/sentdm/models/{calls/api_response_of_list_of_call_participant.rbs → voice/api_response_of_call.rbs}

@@ -1,16 +1,16 @@
 module Sentdm
   module Models
-    module Calls
-      type api_response_of_list_of_call_participant =
+    module Voice
+      type api_response_of_call =
         {
-          data: ::Array[Sentdm::Calls::CallParticipant]?,
+          data: Sentdm::Voice::Call?,
           error: Sentdm::ErrorDetail?,
           meta: Sentdm::APIMeta,
           success: bool
         }
 
-      class APIResponseOfListOfCallParticipant < Sentdm::Internal::Type::BaseModel
-        attr_accessor data: ::Array[Sentdm::Calls::CallParticipant]?
+      class APIResponseOfCall < Sentdm::Internal::Type::BaseModel
+        attr_accessor data: Sentdm::Voice::Call?
 
         attr_accessor error: Sentdm::ErrorDetail?
 
@@ -23,14 +23,14 @@ module Sentdm
         def success=: (bool) -> bool
 
         def initialize: (
-          ?data: ::Array[Sentdm::Calls::CallParticipant]?,
+          ?data: Sentdm::Voice::Call?,
           ?error: Sentdm::ErrorDetail?,
           ?meta: Sentdm::APIMeta,
           ?success: bool
         ) -> void
 
         def to_hash: -> {
-          data: ::Array[Sentdm::Calls::CallParticipant]?,
+          data: Sentdm::Voice::Call?,
           error: Sentdm::ErrorDetail?,
           meta: Sentdm::APIMeta,
           success: bool

data/sig/sentdm/models/voice/api_response_of_call_recordings.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Models
+    module Voice
+      type api_response_of_call_recordings =
+        {
+          data: Sentdm::Voice::CallRecordings?,
+          error: Sentdm::ErrorDetail?,
+          meta: Sentdm::APIMeta,
+          success: bool
+        }
+
+      class APIResponseOfCallRecordings < Sentdm::Internal::Type::BaseModel
+        attr_accessor data: Sentdm::Voice::CallRecordings?
+
+        attr_accessor error: Sentdm::ErrorDetail?
+
+        attr_reader meta: Sentdm::APIMeta?
+
+        def meta=: (Sentdm::APIMeta) -> Sentdm::APIMeta
+
+        attr_reader success: bool?
+
+        def success=: (bool) -> bool
+
+        def initialize: (
+          ?data: Sentdm::Voice::CallRecordings?,
+          ?error: Sentdm::ErrorDetail?,
+          ?meta: Sentdm::APIMeta,
+          ?success: bool
+        ) -> void
+
+        def to_hash: -> {
+          data: Sentdm::Voice::CallRecordings?,
+          error: Sentdm::ErrorDetail?,
+          meta: Sentdm::APIMeta,
+          success: bool
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/voice/api_response_of_calls_list.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Models
+    module Voice
+      type api_response_of_calls_list =
+        {
+          data: Sentdm::Voice::CallsList?,
+          error: Sentdm::ErrorDetail?,
+          meta: Sentdm::APIMeta,
+          success: bool
+        }
+
+      class APIResponseOfCallsList < Sentdm::Internal::Type::BaseModel
+        attr_accessor data: Sentdm::Voice::CallsList?
+
+        attr_accessor error: Sentdm::ErrorDetail?
+
+        attr_reader meta: Sentdm::APIMeta?
+
+        def meta=: (Sentdm::APIMeta) -> Sentdm::APIMeta
+
+        attr_reader success: bool?
+
+        def success=: (bool) -> bool
+
+        def initialize: (
+          ?data: Sentdm::Voice::CallsList?,
+          ?error: Sentdm::ErrorDetail?,
+          ?meta: Sentdm::APIMeta,
+          ?success: bool
+        ) -> void
+
+        def to_hash: -> {
+          data: Sentdm::Voice::CallsList?,
+          error: Sentdm::ErrorDetail?,
+          meta: Sentdm::APIMeta,
+          success: bool
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/{channels → voice}/api_response_of_voice_token.rbs

@@ -1,16 +1,16 @@
 module Sentdm
   module Models
-    module Channels
+    module Voice
       type api_response_of_voice_token =
         {
-          data: Sentdm::Channels::VoiceToken?,
+          data: Sentdm::Voice::VoiceToken?,
           error: Sentdm::ErrorDetail?,
           meta: Sentdm::APIMeta,
           success: bool
         }
 
       class APIResponseOfVoiceToken < Sentdm::Internal::Type::BaseModel
-        attr_accessor data: Sentdm::Channels::VoiceToken?
+        attr_accessor data: Sentdm::Voice::VoiceToken?
 
         attr_accessor error: Sentdm::ErrorDetail?
 
@@ -23,14 +23,14 @@ module Sentdm
         def success=: (bool) -> bool
 
         def initialize: (
-          ?data: Sentdm::Channels::VoiceToken?,
+          ?data: Sentdm::Voice::VoiceToken?,
           ?error: Sentdm::ErrorDetail?,
           ?meta: Sentdm::APIMeta,
           ?success: bool
         ) -> void
 
         def to_hash: -> {
-          data: Sentdm::Channels::VoiceToken?,
+          data: Sentdm::Voice::VoiceToken?,
           error: Sentdm::ErrorDetail?,
           meta: Sentdm::APIMeta,
           success: bool

data/sig/sentdm/models/voice/call.rbs

@@ -0,0 +1,110 @@
+module Sentdm
+  module Models
+    module Voice
+      type call =
+        {
+          id: String,
+          answered_at: Time?,
+          direction: String,
+          duration_seconds: Integer?,
+          ended_at: Time?,
+          failure_reason: String?,
+          from: Sentdm::Voice::CallParty,
+          mode: String,
+          number: String,
+          price: Float?,
+          recording_available: bool,
+          started_at: Time,
+          status: String,
+          timeline: ::Array[Sentdm::Voice::CallTimelineEntry]?,
+          to: Sentdm::Voice::CallParty
+        }
+
+      class Call < Sentdm::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_accessor answered_at: Time?
+
+        attr_reader direction: String?
+
+        def direction=: (String) -> String
+
+        attr_accessor duration_seconds: Integer?
+
+        attr_accessor ended_at: Time?
+
+        attr_accessor failure_reason: String?
+
+        attr_reader from: Sentdm::Voice::CallParty?
+
+        def from=: (Sentdm::Voice::CallParty) -> Sentdm::Voice::CallParty
+
+        attr_reader mode: String?
+
+        def mode=: (String) -> String
+
+        attr_reader number: String?
+
+        def number=: (String) -> String
+
+        attr_accessor price: Float?
+
+        attr_reader recording_available: bool?
+
+        def recording_available=: (bool) -> bool
+
+        attr_reader started_at: Time?
+
+        def started_at=: (Time) -> Time
+
+        attr_reader status: String?
+
+        def status=: (String) -> String
+
+        attr_accessor timeline: ::Array[Sentdm::Voice::CallTimelineEntry]?
+
+        attr_reader to: Sentdm::Voice::CallParty?
+
+        def to=: (Sentdm::Voice::CallParty) -> Sentdm::Voice::CallParty
+
+        def initialize: (
+          ?id: String,
+          ?answered_at: Time?,
+          ?direction: String,
+          ?duration_seconds: Integer?,
+          ?ended_at: Time?,
+          ?failure_reason: String?,
+          ?from: Sentdm::Voice::CallParty,
+          ?mode: String,
+          ?number: String,
+          ?price: Float?,
+          ?recording_available: bool,
+          ?started_at: Time,
+          ?status: String,
+          ?timeline: ::Array[Sentdm::Voice::CallTimelineEntry]?,
+          ?to: Sentdm::Voice::CallParty
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          answered_at: Time?,
+          direction: String,
+          duration_seconds: Integer?,
+          ended_at: Time?,
+          failure_reason: String?,
+          from: Sentdm::Voice::CallParty,
+          mode: String,
+          number: String,
+          price: Float?,
+          recording_available: bool,
+          started_at: Time,
+          status: String,
+          timeline: ::Array[Sentdm::Voice::CallTimelineEntry]?,
+          to: Sentdm::Voice::CallParty
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/{calls/participant_remove_params.rbs → voice/call_hangup_params.rbs}

@@ -1,11 +1,11 @@
 module Sentdm
   module Models
-    module Calls
-      type participant_remove_params =
-        { id: String, participant_id: String, x_profile_id: String }
+    module Voice
+      type call_hangup_params =
+        { id: String, idempotency_key: String, x_profile_id: String }
         & Sentdm::Internal::Type::request_parameters
 
-      class ParticipantRemoveParams < Sentdm::Models::MutationRequest
+      class CallHangupParams < Sentdm::Models::MutationRequest
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
@@ -13,9 +13,9 @@ module Sentdm
 
         def id=: (String _) -> String
 
-        def participant_id: -> String
+        def idempotency_key: -> String?
 
-        def participant_id=: (String _) -> String
+        def idempotency_key=: (String _) -> String
 
         def x_profile_id: -> String?
 
@@ -23,14 +23,14 @@ module Sentdm
 
         def initialize: (
           id: String,
-          participant_id: String,
+          ?idempotency_key: String,
           ?x_profile_id: String,
           ?request_options: Sentdm::request_opts
         ) -> void
 
         def to_hash: -> {
           id: String,
-          participant_id: String,
+          idempotency_key: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions
         }