sentdm 0.33.0 → 0.35.0

data/rbi/sentdm/models/calls/api_response_of_list_of_call_participant.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Calls
+      class APIResponseOfListOfCallParticipant < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Calls::APIResponseOfListOfCallParticipant,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # The response data (null if error)
+        sig { returns(T.nilable(T::Array[Sentdm::Calls::CallParticipant])) }
+        attr_accessor :data
+
+        # Error information
+        sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+        attr_reader :error
+
+        sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+        attr_writer :error
+
+        # Request and response metadata
+        sig { returns(T.nilable(Sentdm::APIMeta)) }
+        attr_reader :meta
+
+        sig { params(meta: Sentdm::APIMeta::OrHash).void }
+        attr_writer :meta
+
+        # Indicates whether the request was successful
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :success
+
+        sig { params(success: T::Boolean).void }
+        attr_writer :success
+
+        # Standard API response envelope for all v3 endpoints
+        sig do
+          params(
+            data: T.nilable(T::Array[Sentdm::Calls::CallParticipant::OrHash]),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The response data (null if error)
+          data: nil,
+          # Error information
+          error: nil,
+          # Request and response metadata
+          meta: nil,
+          # Indicates whether the request was successful
+          success: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T.nilable(T::Array[Sentdm::Calls::CallParticipant]),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/calls/call_participant.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    CallParticipant = Calls::CallParticipant
+
+    module Calls
+      class CallParticipant < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Calls::CallParticipant, Sentdm::Internal::AnyHash)
+          end
+
+        # The participant's own call id: what the mute and remove endpoints take, and what
+        # GET /v3/calls/{id} accepts
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # How long the participant has been connected to the room, in seconds
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :duration_seconds
+
+        sig { params(duration_seconds: Integer).void }
+        attr_writer :duration_seconds
+
+        # user for one of your app users, number for a phone number, anonymous for a
+        # caller who withheld their number
+        sig { returns(T.nilable(String)) }
+        attr_reader :kind
+
+        sig { params(kind: String).void }
+        attr_writer :kind
+
+        # True while the room mutes this participant
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :muted
+
+        sig { params(muted: T::Boolean).void }
+        attr_writer :muted
+
+        # The app user's identity or the phone number in E.164 format. Null when the kind
+        # is anonymous
+        sig { returns(T.nilable(String)) }
+        attr_accessor :value
+
+        # A participant of a conference call
+        sig do
+          params(
+            id: String,
+            duration_seconds: Integer,
+            kind: String,
+            muted: T::Boolean,
+            value: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The participant's own call id: what the mute and remove endpoints take, and what
+          # GET /v3/calls/{id} accepts
+          id: nil,
+          # How long the participant has been connected to the room, in seconds
+          duration_seconds: nil,
+          # user for one of your app users, number for a phone number, anonymous for a
+          # caller who withheld their number
+          kind: nil,
+          # True while the room mutes this participant
+          muted: nil,
+          # The app user's identity or the phone number in E.164 format. Null when the kind
+          # is anonymous
+          value: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              duration_seconds: Integer,
+              kind: String,
+              muted: T::Boolean,
+              value: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/calls/call_participant_target.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    CallParticipantTarget = Calls::CallParticipantTarget
+
+    module Calls
+      class CallParticipantTarget < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Calls::CallParticipantTarget,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # user for one of your app users, number for a phone number
+        sig { returns(T.nilable(String)) }
+        attr_reader :kind
+
+        sig { params(kind: String).void }
+        attr_writer :kind
+
+        # The app user's identity, or the phone number in E.164 format
+        sig { returns(T.nilable(String)) }
+        attr_reader :value
+
+        sig { params(value: String).void }
+        attr_writer :value
+
+        # A participant to add to a call
+        sig { params(kind: String, value: String).returns(T.attached_class) }
+        def self.new(
+          # user for one of your app users, number for a phone number
+          kind: nil,
+          # The app user's identity, or the phone number in E.164 format
+          value: nil
+        )
+        end
+
+        sig { override.returns({ kind: String, value: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/calls/participant_add_params.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Calls
+      class ParticipantAddParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Calls::ParticipantAddParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :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
+        sig { returns(T.nilable(String)) }
+        attr_accessor :caller_id
+
+        # Sandbox flag - when true, the operation is simulated without side effects Useful
+        # for testing integrations without actual execution
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sandbox
+
+        sig { params(sandbox: T::Boolean).void }
+        attr_writer :sandbox
+
+        # A participant to add to a call
+        sig { returns(T.nilable(Sentdm::Calls::CallParticipantTarget)) }
+        attr_reader :to
+
+        sig { params(to: Sentdm::Calls::CallParticipantTarget::OrHash).void }
+        attr_writer :to
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            id: String,
+            caller_id: T.nilable(String),
+            sandbox: T::Boolean,
+            to: Sentdm::Calls::CallParticipantTarget::OrHash,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          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
+          caller_id: nil,
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sandbox: nil,
+          # A participant to add to a call
+          to: nil,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              caller_id: T.nilable(String),
+              sandbox: T::Boolean,
+              to: Sentdm::Calls::CallParticipantTarget,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/calls/participant_list_params.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Calls
+      class ParticipantListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Calls::ParticipantListParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            id: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, x_profile_id: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/calls/participant_remove_all_params.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Calls
+      class ParticipantRemoveAllParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Calls::ParticipantRemoveAllParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            id: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, x_profile_id: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/calls/participant_remove_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Calls
+      class ParticipantRemoveParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Calls::ParticipantRemoveParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            id: String,
+            participant_id: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          participant_id:,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/calls/participant_update_params.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Calls
+      class ParticipantUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Calls::ParticipantUpdateParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id
+
+        # true to mute the participant, false to unmute them
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :muted
+
+        sig { params(muted: T::Boolean).void }
+        attr_writer :muted
+
+        # Sandbox flag - when true, the operation is simulated without side effects Useful
+        # for testing integrations without actual execution
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sandbox
+
+        sig { params(sandbox: T::Boolean).void }
+        attr_writer :sandbox
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            id: String,
+            participant_id: String,
+            muted: T::Boolean,
+            sandbox: T::Boolean,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          participant_id:,
+          # true to mute the participant, false to unmute them
+          muted: nil,
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sandbox: nil,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id: String,
+              muted: T::Boolean,
+              sandbox: T::Boolean,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/calls_list.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class CallsList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::CallsList, Sentdm::Internal::AnyHash) }
+
+      # The calls on this page, most recent first
+      sig { returns(T.nilable(T::Array[Sentdm::Call])) }
+      attr_reader :calls
+
+      sig { params(calls: T::Array[Sentdm::Call::OrHash]).void }
+      attr_writer :calls
+
+      # Pagination metadata for list responses
+      sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+      attr_reader :pagination
+
+      sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+      attr_writer :pagination
+
+      # Paginated list of calls
+      sig do
+        params(
+          calls: T::Array[Sentdm::Call::OrHash],
+          pagination: Sentdm::PaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The calls on this page, most recent first
+        calls: nil,
+        # Pagination metadata for list responses
+        pagination: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { calls: T::Array[Sentdm::Call], pagination: Sentdm::PaginationMeta }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channel_event_payload.rbi

@@ -68,13 +68,19 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :number_type
 
-      # Why the market reached this state, when a reason was given — a correction
-      # explained, or a campaign lapse. Free text, passed through from the registry or
-      # carrier that wrote it, so treat it as a message to show a human rather than a
-      # value to branch on.
+      # Why the market reached this state, as a sentence to show a person: the specific
+      # explanation when one was given (a correction explained, a campaign lapse),
+      # otherwise what reason_code means for this market. Not a value to branch on.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # Why the market is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
+      # such as CHANNEL_001 (something you owe) or CHANNEL_002 (a correction was
+      # requested). The same code the channels resource reports for the market. Switch
+      # on this rather than on reason. Omitted while ACTIVE.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason_code
+
       # The sender itself — a number in E.164, or an alphanumeric sender ID.
       #
       # Always present, and null until a sender exists. The key is on every delivery so
@@ -142,6 +148,7 @@ module Sentdm
             T.nilable(Sentdm::ChannelEventPayload::Compliance::OrHash),
           number_type: T.nilable(String),
           reason: T.nilable(String),
+          reason_code: T.nilable(String),
           sender_value: T.nilable(String),
           status: String,
           updated_at: String
@@ -185,11 +192,15 @@ module Sentdm
         # The kind of sender the market uses, for example TEN_DLC, LOCAL, or ALPHANUMERIC.
         # Omitted when the subject has no sender type of its own.
         number_type: nil,
-        # Why the market reached this state, when a reason was given — a correction
-        # explained, or a campaign lapse. Free text, passed through from the registry or
-        # carrier that wrote it, so treat it as a message to show a human rather than a
-        # value to branch on.
+        # Why the market reached this state, as a sentence to show a person: the specific
+        # explanation when one was given (a correction explained, a campaign lapse),
+        # otherwise what reason_code means for this market. Not a value to branch on.
         reason: nil,
+        # Why the market is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
+        # such as CHANNEL_001 (something you owe) or CHANNEL_002 (a correction was
+        # requested). The same code the channels resource reports for the market. Switch
+        # on this rather than on reason. Omitted while ACTIVE.
+        reason_code: nil,
         # The sender itself — a number in E.164, or an alphanumeric sender ID.
         #
         # Always present, and null until a sender exists. The key is on every delivery so
@@ -228,6 +239,7 @@ module Sentdm
             compliance: T.nilable(Sentdm::ChannelEventPayload::Compliance),
             number_type: T.nilable(String),
             reason: T.nilable(String),
+            reason_code: T.nilable(String),
             sender_value: T.nilable(String),
             status: String,
             updated_at: String