sentdm 0.38.1 → 0.39.0

data/lib/sentdm/models/{calls/participant_update_params.rb → voice/call_record_params.rb}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    module Calls
-      # @see Sentdm::Resources::Calls::Participants#update
-      class ParticipantUpdateParams < Sentdm::Internal::Type::BaseModel
+    module Voice
+      # @see Sentdm::Resources::Voice::Calls#record
+      class CallRecordParams < Sentdm::Internal::Type::BaseModel
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
@@ -13,16 +13,11 @@ module Sentdm
         #   @return [String]
         required :id, String
 
-        # @!attribute participant_id
+        # @!attribute action
+        #   start to begin recording, stop to end it
         #
-        #   @return [String]
-        required :participant_id, String
-
-        # @!attribute muted
-        #   true to mute the participant, false to unmute them
-        #
-        #   @return [Boolean, nil]
-        optional :muted, Sentdm::Internal::Type::Boolean
+        #   @return [String, nil]
+        optional :action, String
 
         # @!attribute sandbox
         #   Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -41,15 +36,13 @@ module Sentdm
         #   @return [String, nil]
         optional :x_profile_id, String
 
-        # @!method initialize(id:, participant_id:, muted: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        # @!method initialize(id:, action: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::Calls::ParticipantUpdateParams} for more details.
+        #   {Sentdm::Models::Voice::CallRecordParams} for more details.
         #
         #   @param id [String]
         #
-        #   @param participant_id [String]
-        #
-        #   @param muted [Boolean] true to mute the participant, false to unmute them
+        #   @param action [String] start to begin recording, stop to end it
         #
         #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
         #

data/lib/sentdm/models/voice/call_recording.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallRecording < Sentdm::Internal::Type::BaseModel
+        # @!attribute download_url
+        #   A pre-signed link that downloads the recording as an MP3 file. Anyone holding it
+        #   can download the recording until it expires
+        #
+        #   @return [String, nil]
+        optional :download_url, String
+
+        # @!attribute recording_id
+        #   The recording's id, the one the call.recording_ready webhook announced it under
+        #
+        #   @return [String, nil]
+        optional :recording_id, String
+
+        # @!attribute url_expires_at
+        #   When the link stops working (UTC). Request the recordings again for a fresh link
+        #
+        #   @return [Time, nil]
+        optional :url_expires_at, Time
+
+        # @!method initialize(download_url: nil, recording_id: nil, url_expires_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::CallRecording} for more details.
+        #
+        #   A short-lived link to a call recording
+        #
+        #   @param download_url [String] A pre-signed link that downloads the recording as an MP3 file. Anyone holding it
+        #
+        #   @param recording_id [String] The recording's id, the one the call.recording_ready webhook announced it under
+        #
+        #   @param url_expires_at [Time] When the link stops working (UTC). Request the recordings again for a fresh link
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/call_recordings.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallRecordings < Sentdm::Internal::Type::BaseModel
+        # @!attribute recordings
+        #   Every recording of the call, oldest first. Empty until the first
+        #   call.recording_ready webhook has been sent, and for a call that was never
+        #   recorded
+        #
+        #   @return [Array<Sentdm::Models::Voice::CallRecording>, nil]
+        optional :recordings, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::CallRecording] }
+
+        # @!method initialize(recordings: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::CallRecordings} for more details.
+        #
+        #   The recordings of a call, each as a short-lived download link
+        #
+        #   @param recordings [Array<Sentdm::Models::Voice::CallRecording>] Every recording of the call, oldest first. Empty until the first
+        #   call.recording\_
+      end
+    end
+  end
+end

data/lib/sentdm/models/{calls/participant_list_params.rb → voice/call_retrieve_params.rb}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    module Calls
-      # @see Sentdm::Resources::Calls::Participants#list
-      class ParticipantListParams < Sentdm::Internal::Type::BaseModel
+    module Voice
+      # @see Sentdm::Resources::Voice::Calls#retrieve
+      class CallRetrieveParams < Sentdm::Internal::Type::BaseModel
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 

data/lib/sentdm/models/voice/call_timeline_entry.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallTimelineEntry < Sentdm::Internal::Type::BaseModel
+        # @!attribute status
+        #   INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute timestamp
+        #   When the call entered this status (UTC)
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!method initialize(status: nil, timestamp: nil)
+        #   When a call entered a status
+        #
+        #   @param status [String] INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
+        #
+        #   @param timestamp [Time] When the call entered this status (UTC)
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/api_response_of_list_of_call_participant.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#list
+        class APIResponseOfListOfCallParticipant < Sentdm::Internal::Type::BaseModel
+          # @!attribute data
+          #   The response data (null if error)
+          #
+          #   @return [Array<Sentdm::Models::Voice::Calls::CallParticipant>, nil]
+          optional :data,
+                   -> {
+                     Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::Calls::CallParticipant]
+                   },
+                   nil?: true
+
+          # @!attribute error
+          #   Error information
+          #
+          #   @return [Sentdm::Models::ErrorDetail, nil]
+          optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+          # @!attribute meta
+          #   Request and response metadata
+          #
+          #   @return [Sentdm::Models::APIMeta, nil]
+          optional :meta, -> { Sentdm::APIMeta }
+
+          # @!attribute success
+          #   Indicates whether the request was successful
+          #
+          #   @return [Boolean, nil]
+          optional :success, Sentdm::Internal::Type::Boolean
+
+          # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+          #   Standard API response envelope for all v3 endpoints
+          #
+          #   @param data [Array<Sentdm::Models::Voice::Calls::CallParticipant>, nil] The response data (null if error)
+          #
+          #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+          #
+          #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+          #
+          #   @param success [Boolean] Indicates whether the request was successful
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/call_participant.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        class CallParticipant < Sentdm::Internal::Type::BaseModel
+          # @!attribute id
+          #   The participant's own call id: what the mute and remove endpoints take, and what
+          #   GET /v3/voice/calls/{id} accepts
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute duration_seconds
+          #   How long the participant has been connected to the room, in seconds
+          #
+          #   @return [Integer, nil]
+          optional :duration_seconds, Integer
+
+          # @!attribute kind
+          #   user for one of your app users, number for a phone number, anonymous for a
+          #   caller who withheld their number
+          #
+          #   @return [String, nil]
+          optional :kind, String
+
+          # @!attribute muted
+          #   True while the room mutes this participant
+          #
+          #   @return [Boolean, nil]
+          optional :muted, Sentdm::Internal::Type::Boolean
+
+          # @!attribute value
+          #   The app user's identity or the phone number in E.164 format. Null when the kind
+          #   is anonymous
+          #
+          #   @return [String, nil]
+          optional :value, String, nil?: true
+
+          # @!method initialize(id: nil, duration_seconds: nil, kind: nil, muted: nil, value: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Voice::Calls::CallParticipant} for more details.
+          #
+          #   A participant of a conference call
+          #
+          #   @param id [String] The participant's own call id: what the mute and remove endpoints take, and what
+          #
+          #   @param duration_seconds [Integer] How long the participant has been connected to the room, in seconds
+          #
+          #   @param kind [String] user for one of your app users, number for a phone number, anonymous for a calle
+          #
+          #   @param muted [Boolean] True while the room mutes this participant
+          #
+          #   @param value [String, nil] The app user's identity or the phone number in E.164 format. Null when the kind
+        end
+      end
+
+      CallParticipant = Calls::CallParticipant
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/call_participant_target.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        class CallParticipantTarget < Sentdm::Internal::Type::BaseModel
+          # @!attribute kind
+          #   user for one of your app users, number for a phone number
+          #
+          #   @return [String, nil]
+          optional :kind, String
+
+          # @!attribute value
+          #   The app user's identity, or the phone number in E.164 format
+          #
+          #   @return [String, nil]
+          optional :value, String
+
+          # @!method initialize(kind: nil, value: nil)
+          #   A participant to add to a call
+          #
+          #   @param kind [String] user for one of your app users, number for a phone number
+          #
+          #   @param value [String] The app user's identity, or the phone number in E.164 format
+        end
+      end
+
+      CallParticipantTarget = Calls::CallParticipantTarget
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_add_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#add
+        class ParticipantAddParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute caller_id
+          #   The number shown to a phone participant as the caller, in E.164 format. Must be
+          #   one of your numbers. The call's owning number when omitted
+          #
+          #   @return [String, nil]
+          optional :caller_id, String, nil?: true
+
+          # @!attribute sandbox
+          #   Sandbox flag - when true, the operation is simulated without side effects Useful
+          #   for testing integrations without actual execution
+          #
+          #   @return [Boolean, nil]
+          optional :sandbox, Sentdm::Internal::Type::Boolean
+
+          # @!attribute to
+          #   A participant to add to a call
+          #
+          #   @return [Sentdm::Models::Voice::Calls::CallParticipantTarget, nil]
+          optional :to, -> { Sentdm::Voice::Calls::CallParticipantTarget }
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, caller_id: nil, sandbox: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Voice::Calls::ParticipantAddParams} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param caller_id [String, nil] The number shown to a phone participant as the caller, in E.164 format. Must be
+          #
+          #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+          #
+          #   @param to [Sentdm::Models::Voice::Calls::CallParticipantTarget] A participant to add to a call
+          #
+          #   @param idempotency_key [String]
+          #
+          #   @param x_profile_id [String]
+          #
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#list
+        class ParticipantListParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, x_profile_id: nil, request_options: {})
+          #   @param id [String]
+          #   @param x_profile_id [String]
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_remove_all_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#remove_all
+        class ParticipantRemoveAllParams < Sentdm::Models::MutationRequest
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, x_profile_id: nil, request_options: {})
+          #   @param id [String]
+          #   @param x_profile_id [String]
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_remove_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#remove
+        class ParticipantRemoveParams < Sentdm::Models::MutationRequest
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute participant_id
+          #
+          #   @return [String]
+          required :participant_id, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, participant_id:, x_profile_id: nil, request_options: {})
+          #   @param id [String]
+          #   @param participant_id [String]
+          #   @param x_profile_id [String]
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_update_params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#update
+        class ParticipantUpdateParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute participant_id
+          #
+          #   @return [String]
+          required :participant_id, String
+
+          # @!attribute muted
+          #   true to mute the participant, false to unmute them
+          #
+          #   @return [Boolean, nil]
+          optional :muted, Sentdm::Internal::Type::Boolean
+
+          # @!attribute sandbox
+          #   Sandbox flag - when true, the operation is simulated without side effects Useful
+          #   for testing integrations without actual execution
+          #
+          #   @return [Boolean, nil]
+          optional :sandbox, Sentdm::Internal::Type::Boolean
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, participant_id:, muted: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Voice::Calls::ParticipantUpdateParams} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param participant_id [String]
+          #
+          #   @param muted [Boolean] true to mute the participant, false to unmute them
+          #
+          #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+          #
+          #   @param idempotency_key [String]
+          #
+          #   @param x_profile_id [String]
+          #
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls_list.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallsList < Sentdm::Internal::Type::BaseModel
+        # @!attribute calls
+        #   The calls on this page, most recent first
+        #
+        #   @return [Array<Sentdm::Models::Voice::Call>, nil]
+        optional :calls, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::Call] }
+
+        # @!attribute pagination
+        #   Pagination metadata for list responses
+        #
+        #   @return [Sentdm::Models::PaginationMeta, nil]
+        optional :pagination, -> { Sentdm::PaginationMeta }
+
+        # @!method initialize(calls: nil, pagination: nil)
+        #   Paginated list of calls
+        #
+        #   @param calls [Array<Sentdm::Models::Voice::Call>] The calls on this page, most recent first
+        #
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+      end
+    end
+  end
+end

data/lib/sentdm/models/{channels/voice_create_token_params.rb → voice/token_create_params.rb}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    module Channels
-      # @see Sentdm::Resources::Channels::Voice#create_token
-      class VoiceCreateTokenParams < Sentdm::Internal::Type::BaseModel
+    module Voice
+      # @see Sentdm::Resources::Voice::Tokens#create
+      class TokenCreateParams < Sentdm::Internal::Type::BaseModel
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
@@ -48,7 +48,7 @@ module Sentdm
 
         # @!method initialize(identity: nil, number: nil, sandbox: nil, ttl: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::Channels::VoiceCreateTokenParams} for more details.
+        #   {Sentdm::Models::Voice::TokenCreateParams} for more details.
         #
         #   @param identity [String] Your identifier for the app user, such as an agent or account id. Letters, digit
         #

data/lib/sentdm/models/{channels → voice}/voice_token.rb

@@ -2,10 +2,11 @@
 
 module Sentdm
   module Models
-    module Channels
+    module Voice
       class VoiceToken < Sentdm::Internal::Type::BaseModel
         # @!attribute token
-        #   The signed token. Hand it to the client SDK unchanged.
+        #   The signed token. Hand it to the client SDK unchanged. Treat it as opaque: read
+        #   the identity, number, and expiry from this response, not from the token.
         #
         #   @return [String, nil]
         optional :token, String
@@ -29,9 +30,12 @@ module Sentdm
         optional :number, String
 
         # @!method initialize(token: nil, expires_at: nil, identity: nil, number: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::VoiceToken} for more details.
+        #
         #   A short-lived token your app passes to the voice client SDK to register
         #
-        #   @param token [String] The signed token. Hand it to the client SDK unchanged.
+        #   @param token [String] The signed token. Hand it to the client SDK unchanged. Treat it as opaque: read
         #
         #   @param expires_at [Time] When the token expires (UTC)
         #
@@ -40,5 +44,7 @@ module Sentdm
         #   @param number [String] The phone number this identity is now bound to, in E.164 format
       end
     end
+
+    VoiceToken = Voice::VoiceToken
   end
 end