sentdm 0.27.0 → 0.29.0

data/rbi/sentdm/models/inbound_message_event_payload.rbi

@@ -8,6 +8,14 @@ module Sentdm
           T.any(Sentdm::InboundMessageEventPayload, Sentdm::Internal::AnyHash)
         end
 
+      # The contact's number in E.164 format, meaning the number the message came from.
+      sig { returns(String) }
+      attr_accessor :inbound_number
+
+      # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      sig { returns(String) }
+      attr_accessor :received_at
+
       # The account the message belongs to.
       sig { returns(T.nilable(String)) }
       attr_reader :account_id
@@ -22,13 +30,6 @@ module Sentdm
       sig { params(channel: String).void }
       attr_writer :channel
 
-      # The contact's number in E.164 format, meaning the number the message came from.
-      sig { returns(T.nilable(String)) }
-      attr_reader :inbound_number
-
-      sig { params(inbound_number: String).void }
-      attr_writer :inbound_number
-
       # The inbound message.
       sig { returns(T.nilable(String)) }
       attr_reader :message_id
@@ -43,13 +44,6 @@ module Sentdm
       sig { params(outbound_number: String).void }
       attr_writer :outbound_number
 
-      # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
-      sig { returns(T.nilable(String)) }
-      attr_reader :received_at
-
-      sig { params(received_at: String).void }
-      attr_writer :received_at
-
       # The message body. Sent as null when the inbound message carried no text, for
       # example a media-only message. The field is always present, so read it and check
       # for null rather than checking whether the key exists.
@@ -68,29 +62,29 @@ module Sentdm
       # numbers.
       sig do
         params(
+          inbound_number: String,
+          received_at: String,
           account_id: String,
           channel: String,
-          inbound_number: String,
           message_id: String,
           outbound_number: String,
-          received_at: String,
           text: T.nilable(String),
           updated_at: String
         ).returns(T.attached_class)
       end
       def self.new(
+        # The contact's number in E.164 format, meaning the number the message came from.
+        inbound_number:,
+        # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+        received_at:,
         # The account the message belongs to.
         account_id: nil,
         # The channel the message arrived on, for example sms or whatsapp.
         channel: nil,
-        # The contact's number in E.164 format, meaning the number the message came from.
-        inbound_number: nil,
         # The inbound message.
         message_id: nil,
         # Your number in E.164 format, meaning the number the message was addressed to.
         outbound_number: nil,
-        # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
-        received_at: nil,
         # The message body. Sent as null when the inbound message carried no text, for
         # example a media-only message. The field is always present, so read it and check
         # for null rather than checking whether the key exists.
@@ -104,12 +98,12 @@ module Sentdm
       sig do
         override.returns(
           {
+            inbound_number: String,
+            received_at: String,
             account_id: String,
             channel: String,
-            inbound_number: String,
             message_id: String,
             outbound_number: String,
-            received_at: String,
             text: T.nilable(String),
             updated_at: String
           }

data/rbi/sentdm/models/me_retrieve_response.rbi

@@ -22,17 +22,23 @@ module Sentdm
       attr_writer :data
 
       # Error information
-      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+      sig { returns(T.nilable(Sentdm::Models::MeRetrieveResponse::Error)) }
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+      sig do
+        params(
+          error: T.nilable(Sentdm::Models::MeRetrieveResponse::Error::OrHash)
+        ).void
+      end
       attr_writer :error
 
       # Request and response metadata
-      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      sig { returns(T.nilable(Sentdm::Models::MeRetrieveResponse::Meta)) }
       attr_reader :meta
 
-      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      sig do
+        params(meta: Sentdm::Models::MeRetrieveResponse::Meta::OrHash).void
+      end
       attr_writer :meta
 
       # Indicates whether the request was successful
@@ -46,8 +52,8 @@ module Sentdm
       sig do
         params(
           data: T.nilable(Sentdm::Models::MeRetrieveResponse::Data::OrHash),
-          error: T.nilable(Sentdm::ErrorDetail::OrHash),
-          meta: Sentdm::APIMeta::OrHash,
+          error: T.nilable(Sentdm::Models::MeRetrieveResponse::Error::OrHash),
+          meta: Sentdm::Models::MeRetrieveResponse::Meta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
       end
@@ -69,8 +75,8 @@ module Sentdm
         override.returns(
           {
             data: T.nilable(Sentdm::Models::MeRetrieveResponse::Data),
-            error: T.nilable(Sentdm::ErrorDetail),
-            meta: Sentdm::APIMeta,
+            error: T.nilable(Sentdm::Models::MeRetrieveResponse::Error),
+            meta: Sentdm::Models::MeRetrieveResponse::Meta,
             success: T::Boolean
           }
         )
@@ -159,12 +165,41 @@ module Sentdm
         end
         attr_writer :profiles
 
+        # The SMS sender this account sends from in the United States, in E.164 form. Null
+        # when the account has no US SMS sender.
+        #
+        # The same value as channels.sms.phone_number, published under both names on
+        # purpose: sending_phone_number is what this value is already called on GET
+        # /v3/profiles, so the same key answers the same question whichever of the two
+        # endpoints you ask. Neither name is preferred over the other and neither is
+        # deprecated.
+        #
+        # The same value, not the same presence: this key is always written, including as
+        # null, whereas channels.sms.phone_number is left out entirely when there is no
+        # sender.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sending_phone_number
+
+        # The account that holds sending_phone_number in number inventory: normally this
+        # account itself, and a different account when the number is held elsewhere. Null
+        # when there is no US sender, or when the sender is not a number drawn from
+        # inventory — an alphanumeric sender ID or a short code.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sending_phone_number_profile_id
+
         # Profile configuration settings
-        sig { returns(T.nilable(Sentdm::ProfileSettings)) }
+        sig do
+          returns(T.nilable(Sentdm::Models::MeRetrieveResponse::Data::Settings))
+        end
         attr_reader :settings
 
         sig do
-          params(settings: T.nilable(Sentdm::ProfileSettings::OrHash)).void
+          params(
+            settings:
+              T.nilable(
+                Sentdm::Models::MeRetrieveResponse::Data::Settings::OrHash
+              )
+          ).void
         end
         attr_writer :settings
 
@@ -203,7 +238,12 @@ module Sentdm
               T::Array[
                 Sentdm::Models::MeRetrieveResponse::Data::Profile::OrHash
               ],
-            settings: T.nilable(Sentdm::ProfileSettings::OrHash),
+            sending_phone_number: T.nilable(String),
+            sending_phone_number_profile_id: T.nilable(String),
+            settings:
+              T.nilable(
+                Sentdm::Models::MeRetrieveResponse::Data::Settings::OrHash
+              ),
             short_name: T.nilable(String),
             status: T.nilable(String),
             type: String
@@ -230,6 +270,24 @@ module Sentdm
           # List of profiles (populated for organization type, empty for user and profile
           # types)
           profiles: nil,
+          # The SMS sender this account sends from in the United States, in E.164 form. Null
+          # when the account has no US SMS sender.
+          #
+          # The same value as channels.sms.phone_number, published under both names on
+          # purpose: sending_phone_number is what this value is already called on GET
+          # /v3/profiles, so the same key answers the same question whichever of the two
+          # endpoints you ask. Neither name is preferred over the other and neither is
+          # deprecated.
+          #
+          # The same value, not the same presence: this key is always written, including as
+          # null, whereas channels.sms.phone_number is left out entirely when there is no
+          # sender.
+          sending_phone_number: nil,
+          # The account that holds sending_phone_number in number inventory: normally this
+          # account itself, and a different account when the number is held elsewhere. Null
+          # when there is no US sender, or when the sender is not a number drawn from
+          # inventory — an alphanumeric sender ID or a short code.
+          sending_phone_number_profile_id: nil,
           # Profile configuration settings
           settings: nil,
           # Short name / abbreviation (only for profile type)
@@ -256,7 +314,10 @@ module Sentdm
               organization_id: T.nilable(String),
               profiles:
                 T::Array[Sentdm::Models::MeRetrieveResponse::Data::Profile],
-              settings: T.nilable(Sentdm::ProfileSettings),
+              sending_phone_number: T.nilable(String),
+              sending_phone_number_profile_id: T.nilable(String),
+              settings:
+                T.nilable(Sentdm::Models::MeRetrieveResponse::Data::Settings),
               short_name: T.nilable(String),
               status: T.nilable(String),
               type: String
@@ -551,10 +612,21 @@ module Sentdm
           attr_accessor :role
 
           # Profile configuration settings
-          sig { returns(T.nilable(Sentdm::ProfileSettings)) }
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings
+              )
+            )
+          end
           attr_reader :settings
 
-          sig { params(settings: Sentdm::ProfileSettings::OrHash).void }
+          sig do
+            params(
+              settings:
+                Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings::OrHash
+            ).void
+          end
           attr_writer :settings
 
           # Profile short name (abbreviation)
@@ -574,7 +646,8 @@ module Sentdm
               icon: T.nilable(String),
               name: String,
               role: T.nilable(String),
-              settings: Sentdm::ProfileSettings::OrHash,
+              settings:
+                Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings::OrHash,
               short_name: T.nilable(String),
               status: T.nilable(String)
             ).returns(T.attached_class)
@@ -611,7 +684,8 @@ module Sentdm
                 icon: T.nilable(String),
                 name: String,
                 role: T.nilable(String),
-                settings: Sentdm::ProfileSettings,
+                settings:
+                  Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings,
                 short_name: T.nilable(String),
                 status: T.nilable(String)
               }
@@ -619,6 +693,327 @@ module Sentdm
           end
           def to_hash
           end
+
+          class Settings < Sentdm::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings,
+                  Sentdm::Internal::AnyHash
+                )
+              end
+
+            # Always false. A profile no longer shares contacts with sibling profiles — it
+            # sees only what it owns. Retained so existing v3 clients reading
+            # allow_contact_sharing keep deserializing; it carries no information.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :allow_contact_sharing
+
+            # Always false. A profile no longer shares templates with sibling profiles.
+            # Retained so existing v3 clients reading allow_template_sharing keep
+            # deserializing; it carries no information.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :allow_template_sharing
+
+            # Billing model: profile, organization, or profile_and_organization
+            sig { returns(T.nilable(String)) }
+            attr_accessor :billing_model
+
+            # Always false. A profile no longer inherits its organization's contacts. Retained
+            # so existing v3 clients reading inherit_contacts keep deserializing; it carries
+            # no information.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :inherit_contacts
+
+            # Whether this profile inherits TCR brand from the organization
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :inherit_tcr_brand
+
+            # Whether this profile inherits TCR campaign from the organization
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :inherit_tcr_campaign
+
+            # Always false. A profile no longer inherits its organization's templates.
+            # Retained so existing v3 clients reading inherit_templates keep deserializing; it
+            # carries no information.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :inherit_templates
+
+            # Profile configuration settings
+            sig do
+              params(
+                allow_contact_sharing: T.nilable(T::Boolean),
+                allow_template_sharing: T.nilable(T::Boolean),
+                billing_model: T.nilable(String),
+                inherit_contacts: T.nilable(T::Boolean),
+                inherit_tcr_brand: T.nilable(T::Boolean),
+                inherit_tcr_campaign: T.nilable(T::Boolean),
+                inherit_templates: T.nilable(T::Boolean)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Always false. A profile no longer shares contacts with sibling profiles — it
+              # sees only what it owns. Retained so existing v3 clients reading
+              # allow_contact_sharing keep deserializing; it carries no information.
+              allow_contact_sharing: nil,
+              # Always false. A profile no longer shares templates with sibling profiles.
+              # Retained so existing v3 clients reading allow_template_sharing keep
+              # deserializing; it carries no information.
+              allow_template_sharing: nil,
+              # Billing model: profile, organization, or profile_and_organization
+              billing_model: nil,
+              # Always false. A profile no longer inherits its organization's contacts. Retained
+              # so existing v3 clients reading inherit_contacts keep deserializing; it carries
+              # no information.
+              inherit_contacts: nil,
+              # Whether this profile inherits TCR brand from the organization
+              inherit_tcr_brand: nil,
+              # Whether this profile inherits TCR campaign from the organization
+              inherit_tcr_campaign: nil,
+              # Always false. A profile no longer inherits its organization's templates.
+              # Retained so existing v3 clients reading inherit_templates keep deserializing; it
+              # carries no information.
+              inherit_templates: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  allow_contact_sharing: T.nilable(T::Boolean),
+                  allow_template_sharing: T.nilable(T::Boolean),
+                  billing_model: T.nilable(String),
+                  inherit_contacts: T.nilable(T::Boolean),
+                  inherit_tcr_brand: T.nilable(T::Boolean),
+                  inherit_tcr_campaign: T.nilable(T::Boolean),
+                  inherit_templates: T.nilable(T::Boolean)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
+        class Settings < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Models::MeRetrieveResponse::Data::Settings,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Always false. A profile no longer shares contacts with sibling profiles — it
+          # sees only what it owns. Retained so existing v3 clients reading
+          # allow_contact_sharing keep deserializing; it carries no information.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :allow_contact_sharing
+
+          # Always false. A profile no longer shares templates with sibling profiles.
+          # Retained so existing v3 clients reading allow_template_sharing keep
+          # deserializing; it carries no information.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :allow_template_sharing
+
+          # Billing model: profile, organization, or profile_and_organization
+          sig { returns(T.nilable(String)) }
+          attr_accessor :billing_model
+
+          # Always false. A profile no longer inherits its organization's contacts. Retained
+          # so existing v3 clients reading inherit_contacts keep deserializing; it carries
+          # no information.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :inherit_contacts
+
+          # Whether this profile inherits TCR brand from the organization
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :inherit_tcr_brand
+
+          # Whether this profile inherits TCR campaign from the organization
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :inherit_tcr_campaign
+
+          # Always false. A profile no longer inherits its organization's templates.
+          # Retained so existing v3 clients reading inherit_templates keep deserializing; it
+          # carries no information.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :inherit_templates
+
+          # Profile configuration settings
+          sig do
+            params(
+              allow_contact_sharing: T.nilable(T::Boolean),
+              allow_template_sharing: T.nilable(T::Boolean),
+              billing_model: T.nilable(String),
+              inherit_contacts: T.nilable(T::Boolean),
+              inherit_tcr_brand: T.nilable(T::Boolean),
+              inherit_tcr_campaign: T.nilable(T::Boolean),
+              inherit_templates: T.nilable(T::Boolean)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Always false. A profile no longer shares contacts with sibling profiles — it
+            # sees only what it owns. Retained so existing v3 clients reading
+            # allow_contact_sharing keep deserializing; it carries no information.
+            allow_contact_sharing: nil,
+            # Always false. A profile no longer shares templates with sibling profiles.
+            # Retained so existing v3 clients reading allow_template_sharing keep
+            # deserializing; it carries no information.
+            allow_template_sharing: nil,
+            # Billing model: profile, organization, or profile_and_organization
+            billing_model: nil,
+            # Always false. A profile no longer inherits its organization's contacts. Retained
+            # so existing v3 clients reading inherit_contacts keep deserializing; it carries
+            # no information.
+            inherit_contacts: nil,
+            # Whether this profile inherits TCR brand from the organization
+            inherit_tcr_brand: nil,
+            # Whether this profile inherits TCR campaign from the organization
+            inherit_tcr_campaign: nil,
+            # Always false. A profile no longer inherits its organization's templates.
+            # Retained so existing v3 clients reading inherit_templates keep deserializing; it
+            # carries no information.
+            inherit_templates: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                allow_contact_sharing: T.nilable(T::Boolean),
+                allow_template_sharing: T.nilable(T::Boolean),
+                billing_model: T.nilable(String),
+                inherit_contacts: T.nilable(T::Boolean),
+                inherit_tcr_brand: T.nilable(T::Boolean),
+                inherit_tcr_campaign: T.nilable(T::Boolean),
+                inherit_templates: T.nilable(T::Boolean)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Error < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::MeRetrieveResponse::Error,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Machine-readable error code (e.g., "RESOURCE_001")
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # Additional validation error details (field-level errors)
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :details
+
+        # URL to documentation about this error
+        sig { returns(T.nilable(String)) }
+        attr_accessor :doc_url
+
+        # Human-readable error message
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Error information
+        sig do
+          params(
+            code: String,
+            details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            doc_url: T.nilable(String),
+            message: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Machine-readable error code (e.g., "RESOURCE_001")
+          code: nil,
+          # Additional validation error details (field-level errors)
+          details: nil,
+          # URL to documentation about this error
+          doc_url: nil,
+          # Human-readable error message
+          message: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              doc_url: T.nilable(String),
+              message: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Meta < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::MeRetrieveResponse::Meta,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for this request (for tracing and support)
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # Server timestamp when the response was generated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :timestamp
+
+        sig { params(timestamp: Time).void }
+        attr_writer :timestamp
+
+        # API version used for this request
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # Request and response metadata
+        sig do
+          params(request_id: String, timestamp: Time, version: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for this request (for tracing and support)
+          request_id: nil,
+          # Server timestamp when the response was generated
+          timestamp: nil,
+          # API version used for this request
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { request_id: String, timestamp: Time, version: String }
+          )
+        end
+        def to_hash
         end
       end
     end

data/rbi/sentdm/models/message_event_payload.rbi

@@ -8,6 +8,12 @@ module Sentdm
           T.any(Sentdm::MessageEventPayload, Sentdm::Internal::AnyHash)
         end
 
+      # The status the message just reached, for example SENT, DELIVERED, or FAILED.
+      # Sent means dispatched and delivered means confirmed, so treat them as distinct
+      # outcomes.
+      sig { returns(String) }
+      attr_accessor :message_status
+
       # The account the message belongs to.
       sig { returns(T.nilable(String)) }
       attr_reader :account_id
@@ -35,15 +41,6 @@ module Sentdm
       sig { params(message_id: String).void }
       attr_writer :message_id
 
-      # The status the message just reached, for example SENT, DELIVERED, or FAILED.
-      # Sent means dispatched and delivered means confirmed, so treat them as distinct
-      # outcomes.
-      sig { returns(T.nilable(String)) }
-      attr_reader :message_status
-
-      sig { params(message_status: String).void }
-      attr_writer :message_status
-
       # The recipient's number in E.164 format.
       sig { returns(T.nilable(String)) }
       attr_reader :outbound_number
@@ -72,11 +69,11 @@ module Sentdm
       # status.
       sig do
         params(
+          message_status: String,
           account_id: String,
           agent_id: T.nilable(String),
           channel: String,
           message_id: String,
-          message_status: String,
           outbound_number: String,
           template_id: T.nilable(String),
           template_name: T.nilable(String),
@@ -84,6 +81,10 @@ module Sentdm
         ).returns(T.attached_class)
       end
       def self.new(
+        # The status the message just reached, for example SENT, DELIVERED, or FAILED.
+        # Sent means dispatched and delivered means confirmed, so treat them as distinct
+        # outcomes.
+        message_status:,
         # The account the message belongs to.
         account_id: nil,
         # The agent attributed to the send, when the send was attributed to one.
@@ -94,10 +95,6 @@ module Sentdm
         # The message this event describes. Stable across every event in the message's
         # lifecycle, so use it to correlate them.
         message_id: nil,
-        # The status the message just reached, for example SENT, DELIVERED, or FAILED.
-        # Sent means dispatched and delivered means confirmed, so treat them as distinct
-        # outcomes.
-        message_status: nil,
         # The recipient's number in E.164 format.
         outbound_number: nil,
         # The template the message was sent from, when it was sent from one.
@@ -113,11 +110,11 @@ module Sentdm
       sig do
         override.returns(
           {
+            message_status: String,
             account_id: String,
             agent_id: T.nilable(String),
             channel: String,
             message_id: String,
-            message_status: String,
             outbound_number: String,
             template_id: T.nilable(String),
             template_name: T.nilable(String),