sentdm 0.29.0 → 0.31.0

data/rbi/sentdm/models/brand_compliance_info.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandComplianceInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BrandComplianceInfo, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(Sentdm::TcrBrandRelationship::OrSymbol) }
+      attr_accessor :brand_relationship
+
+      sig { returns(Sentdm::TcrVertical::OrSymbol) }
+      attr_accessor :vertical
+
+      # List of destination countries for messaging
+      sig { returns(T.nilable(T::Array[Sentdm::DestinationCountry])) }
+      attr_accessor :destination_countries
+
+      # Whether this is a TCR (Campaign Registry) application
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_tcr_application
+
+      # Additional notes about the business or use case
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      # Phone number prefix for messaging (e.g., "+1")
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number_prefix
+
+      # Compliance and TCR information for brand registration
+      sig do
+        params(
+          brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
+          vertical: Sentdm::TcrVertical::OrSymbol,
+          destination_countries:
+            T.nilable(T::Array[Sentdm::DestinationCountry::OrHash]),
+          is_tcr_application: T.nilable(T::Boolean),
+          notes: T.nilable(String),
+          phone_number_prefix: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        brand_relationship:,
+        vertical:,
+        # List of destination countries for messaging
+        destination_countries: nil,
+        # Whether this is a TCR (Campaign Registry) application
+        is_tcr_application: nil,
+        # Additional notes about the business or use case
+        notes: nil,
+        # Phone number prefix for messaging (e.g., "+1")
+        phone_number_prefix: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
+            vertical: Sentdm::TcrVertical::OrSymbol,
+            destination_countries:
+              T.nilable(T::Array[Sentdm::DestinationCountry]),
+            is_tcr_application: T.nilable(T::Boolean),
+            notes: T.nilable(String),
+            phone_number_prefix: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/brand_contact_info.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandContactInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BrandContactInfo, Sentdm::Internal::AnyHash)
+        end
+
+      # Primary contact name (required)
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Business/brand name
+      sig { returns(T.nilable(String)) }
+      attr_accessor :business_name
+
+      # Contact email address
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # Contact phone number in E.164 format
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # Contact phone country code (e.g., "1" for US)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_country_code
+
+      # Contact's role in the business
+      sig { returns(T.nilable(String)) }
+      attr_accessor :role
+
+      # Contact information for brand KYC
+      sig do
+        params(
+          name: String,
+          business_name: T.nilable(String),
+          email: T.nilable(String),
+          phone: T.nilable(String),
+          phone_country_code: T.nilable(String),
+          role: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Primary contact name (required)
+        name:,
+        # Business/brand name
+        business_name: nil,
+        # Contact email address
+        email: nil,
+        # Contact phone number in E.164 format
+        phone: nil,
+        # Contact phone country code (e.g., "1" for US)
+        phone_country_code: nil,
+        # Contact's role in the business
+        role: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            business_name: T.nilable(String),
+            email: T.nilable(String),
+            phone: T.nilable(String),
+            phone_country_code: T.nilable(String),
+            role: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/brands_brand_data.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandsBrandData < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BrandsBrandData, Sentdm::Internal::AnyHash)
+        end
+
+      # Compliance and TCR information for brand registration
+      sig { returns(Sentdm::BrandComplianceInfo) }
+      attr_reader :compliance
+
+      sig { params(compliance: Sentdm::BrandComplianceInfo::OrHash).void }
+      attr_writer :compliance
+
+      # Contact information for brand KYC
+      sig { returns(Sentdm::BrandContactInfo) }
+      attr_reader :contact
+
+      sig { params(contact: Sentdm::BrandContactInfo::OrHash).void }
+      attr_writer :contact
+
+      # Business details and address for brand KYC
+      sig { returns(T.nilable(Sentdm::BrandBusinessInfo)) }
+      attr_reader :business
+
+      sig do
+        params(business: T.nilable(Sentdm::BrandBusinessInfo::OrHash)).void
+      end
+      attr_writer :business
+
+      # Brand and KYC data grouped into contact, business, and compliance sections
+      sig do
+        params(
+          compliance: Sentdm::BrandComplianceInfo::OrHash,
+          contact: Sentdm::BrandContactInfo::OrHash,
+          business: T.nilable(Sentdm::BrandBusinessInfo::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Compliance and TCR information for brand registration
+        compliance:,
+        # Contact information for brand KYC
+        contact:,
+        # Business details and address for brand KYC
+        business: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            compliance: Sentdm::BrandComplianceInfo,
+            contact: Sentdm::BrandContactInfo,
+            business: T.nilable(Sentdm::BrandBusinessInfo)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/contact_delete_params.rbi

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
+    class ContactDeleteParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -14,14 +14,6 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :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
-
       sig { returns(T.nilable(String)) }
       attr_reader :x_profile_id
 
@@ -31,26 +23,17 @@ module Sentdm
       sig do
         params(
           id: String,
-          sandbox: T::Boolean,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        id:,
-        # Sandbox flag - when true, the operation is simulated without side effects Useful
-        # for testing integrations without actual execution
-        sandbox: nil,
-        x_profile_id: nil,
-        request_options: {}
-      )
+      def self.new(id:, x_profile_id: nil, request_options: {})
       end
 
       sig do
         override.returns(
           {
             id: String,
-            sandbox: T::Boolean,
             x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }

data/rbi/sentdm/models/contact_list_params.rbi

@@ -11,17 +11,23 @@ module Sentdm
           T.any(Sentdm::ContactListParams, Sentdm::Internal::AnyHash)
         end
 
+      # Optional channel filter (sms, whatsapp)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :channel
+
       # Page number (1-indexed)
-      sig { returns(Integer) }
-      attr_accessor :page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
 
       # Number of items per page
-      sig { returns(Integer) }
-      attr_accessor :page_size
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
 
-      # Optional channel filter (sms, whatsapp)
-      sig { returns(T.nilable(String)) }
-      attr_accessor :channel
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
 
       # Optional phone number filter (alternative to list view)
       sig { returns(T.nilable(String)) }
@@ -39,9 +45,9 @@ module Sentdm
 
       sig do
         params(
+          channel: T.nilable(String),
           page: Integer,
           page_size: Integer,
-          channel: T.nilable(String),
           phone: T.nilable(String),
           search: T.nilable(String),
           x_profile_id: String,
@@ -49,12 +55,12 @@ module Sentdm
         ).returns(T.attached_class)
       end
       def self.new(
-        # Page number (1-indexed)
-        page:,
-        # Number of items per page
-        page_size:,
         # Optional channel filter (sms, whatsapp)
         channel: nil,
+        # Page number (1-indexed)
+        page: nil,
+        # Number of items per page
+        page_size: nil,
         # Optional phone number filter (alternative to list view)
         phone: nil,
         # Optional search term for filtering contacts
@@ -67,9 +73,9 @@ module Sentdm
       sig do
         override.returns(
           {
+            channel: T.nilable(String),
             page: Integer,
             page_size: Integer,
-            channel: T.nilable(String),
             phone: T.nilable(String),
             search: T.nilable(String),
             x_profile_id: String,

data/rbi/sentdm/models/contact_message_summary.rbi

@@ -0,0 +1,144 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ContactMessageSummary < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ContactMessageSummary, Sentdm::Internal::AnyHash)
+        end
+
+      sig do
+        returns(
+          T.nilable(T::Array[Sentdm::ContactMessageSummary::ChannelScore])
+        )
+      end
+      attr_reader :channel_scores
+
+      sig do
+        params(
+          channel_scores:
+            T::Array[Sentdm::ContactMessageSummary::ChannelScore::OrHash]
+        ).void
+      end
+      attr_writer :channel_scores
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :channels_used
+
+      sig { params(channels_used: T::Array[String]).void }
+      attr_writer :channels_used
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :contact_id
+
+      sig { params(contact_id: String).void }
+      attr_writer :contact_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :first_message_at
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :last_message_at
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :message_count
+
+      sig { params(message_count: Integer).void }
+      attr_writer :message_count
+
+      sig do
+        params(
+          channel_scores:
+            T::Array[Sentdm::ContactMessageSummary::ChannelScore::OrHash],
+          channels_used: T::Array[String],
+          contact_id: String,
+          first_message_at: T.nilable(Time),
+          last_message_at: T.nilable(Time),
+          message_count: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        channel_scores: nil,
+        channels_used: nil,
+        contact_id: nil,
+        first_message_at: nil,
+        last_message_at: nil,
+        message_count: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            channel_scores:
+              T::Array[Sentdm::ContactMessageSummary::ChannelScore],
+            channels_used: T::Array[String],
+            contact_id: String,
+            first_message_at: T.nilable(Time),
+            last_message_at: T.nilable(Time),
+            message_count: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class ChannelScore < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::ContactMessageSummary::ChannelScore,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :channel
+
+        sig { params(channel: String).void }
+        attr_writer :channel
+
+        # Percentage (0-100) of messages on this channel that ended in FAILED.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :fail_score
+
+        sig { params(fail_score: Integer).void }
+        attr_writer :fail_score
+
+        # Percentage (0-100) of messages on this channel that reached a successful
+        # terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :success_score
+
+        sig { params(success_score: Integer).void }
+        attr_writer :success_score
+
+        sig do
+          params(
+            channel: String,
+            fail_score: Integer,
+            success_score: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          channel: nil,
+          # Percentage (0-100) of messages on this channel that ended in FAILED.
+          fail_score: nil,
+          # Percentage (0-100) of messages on this channel that reached a successful
+          # terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
+          success_score: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { channel: String, fail_score: Integer, success_score: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/contact_response.rbi

@@ -0,0 +1,200 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ContactResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ContactResponse, Sentdm::Internal::AnyHash)
+        end
+
+      # Unique identifier for the contact
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+      sig { returns(T.nilable(String)) }
+      attr_reader :available_channels
+
+      sig { params(available_channels: String).void }
+      attr_writer :available_channels
+
+      # Country calling code (e.g., 1 for US/Canada)
+      sig { returns(T.nilable(String)) }
+      attr_reader :country_code
+
+      sig { params(country_code: String).void }
+      attr_writer :country_code
+
+      # When the contact was created
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # Which customer owns this — the key's own, or the profile named in x-profile-id.
+      # Says whose resource this is, which the resource's own id does not.
+      sig { returns(T.nilable(String)) }
+      attr_reader :customer_id
+
+      sig { params(customer_id: String).void }
+      attr_writer :customer_id
+
+      # Default messaging channel to use (e.g., "sms" or "whatsapp")
+      sig { returns(T.nilable(String)) }
+      attr_reader :default_channel
+
+      sig { params(default_channel: String).void }
+      attr_writer :default_channel
+
+      # Phone number in E.164 format (e.g., +1234567890)
+      sig { returns(T.nilable(String)) }
+      attr_reader :format_e164
+
+      sig { params(format_e164: String).void }
+      attr_writer :format_e164
+
+      # Phone number in international format (e.g., +1 234-567-890)
+      sig { returns(T.nilable(String)) }
+      attr_reader :format_international
+
+      sig { params(format_international: String).void }
+      attr_writer :format_international
+
+      # Phone number in national format (e.g., (234) 567-890)
+      sig { returns(T.nilable(String)) }
+      attr_reader :format_national
+
+      sig { params(format_national: String).void }
+      attr_writer :format_national
+
+      # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+      sig { returns(T.nilable(String)) }
+      attr_reader :format_rfc
+
+      sig { params(format_rfc: String).void }
+      attr_writer :format_rfc
+
+      # Always false. Contacts are no longer shared or inherited between sender profiles
+      # — a profile sees only the contacts it owns. Retained so existing v3 clients
+      # reading is_inherited keep deserializing; it carries no information.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_inherited
+
+      sig { params(is_inherited: T::Boolean).void }
+      attr_writer :is_inherited
+
+      # Whether the contact has opted out of messaging. Single source of truth — opt-out
+      # is per-contact, not per-channel.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :opt_out
+
+      sig { params(opt_out: T::Boolean).void }
+      attr_writer :opt_out
+
+      # Phone number in original format
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone_number
+
+      sig { params(phone_number: String).void }
+      attr_writer :phone_number
+
+      # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+      sig { returns(T.nilable(String)) }
+      attr_reader :region_code
+
+      sig { params(region_code: String).void }
+      attr_writer :region_code
+
+      # When the contact was last updated
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      # Contact response for v3 API Uses snake_case for JSON property names
+      sig do
+        params(
+          id: String,
+          available_channels: String,
+          country_code: String,
+          created_at: Time,
+          customer_id: String,
+          default_channel: String,
+          format_e164: String,
+          format_international: String,
+          format_national: String,
+          format_rfc: String,
+          is_inherited: T::Boolean,
+          opt_out: T::Boolean,
+          phone_number: String,
+          region_code: String,
+          updated_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the contact
+        id: nil,
+        # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+        available_channels: nil,
+        # Country calling code (e.g., 1 for US/Canada)
+        country_code: nil,
+        # When the contact was created
+        created_at: nil,
+        # Which customer owns this — the key's own, or the profile named in x-profile-id.
+        # Says whose resource this is, which the resource's own id does not.
+        customer_id: nil,
+        # Default messaging channel to use (e.g., "sms" or "whatsapp")
+        default_channel: nil,
+        # Phone number in E.164 format (e.g., +1234567890)
+        format_e164: nil,
+        # Phone number in international format (e.g., +1 234-567-890)
+        format_international: nil,
+        # Phone number in national format (e.g., (234) 567-890)
+        format_national: nil,
+        # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+        format_rfc: nil,
+        # Always false. Contacts are no longer shared or inherited between sender profiles
+        # — a profile sees only the contacts it owns. Retained so existing v3 clients
+        # reading is_inherited keep deserializing; it carries no information.
+        is_inherited: nil,
+        # Whether the contact has opted out of messaging. Single source of truth — opt-out
+        # is per-contact, not per-channel.
+        opt_out: nil,
+        # Phone number in original format
+        phone_number: nil,
+        # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+        region_code: nil,
+        # When the contact was last updated
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            available_channels: String,
+            country_code: String,
+            created_at: Time,
+            customer_id: String,
+            default_channel: String,
+            format_e164: String,
+            format_international: String,
+            format_national: String,
+            format_rfc: String,
+            is_inherited: T::Boolean,
+            opt_out: T::Boolean,
+            phone_number: String,
+            region_code: String,
+            updated_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end