sentdm 0.4.0 → 0.5.0

data/rbi/sentdm/models/template_definition.rbi

@@ -10,44 +10,28 @@ module Sentdm
 
       # Required template body with content for different channels (multi-channel,
       # SMS-specific, or WhatsApp-specific)
-      sig { returns(Sentdm::SentDmServicesCommonContractsPocOsTemplateBody) }
+      sig { returns(Sentdm::TemplateDefinition::Body) }
       attr_reader :body
 
-      sig do
-        params(
-          body: Sentdm::SentDmServicesCommonContractsPocOsTemplateBody::OrHash
-        ).void
-      end
+      sig { params(body: Sentdm::TemplateDefinition::Body::OrHash).void }
       attr_writer :body
 
       # Configuration specific to AUTHENTICATION category templates (optional)
       sig do
-        returns(
-          T.nilable(
-            Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig
-          )
-        )
+        returns(T.nilable(Sentdm::TemplateDefinition::AuthenticationConfig))
       end
       attr_reader :authentication_config
 
       sig do
         params(
           authentication_config:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig::OrHash
-            )
+            T.nilable(Sentdm::TemplateDefinition::AuthenticationConfig::OrHash)
         ).void
       end
       attr_writer :authentication_config
 
       # Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
-      sig do
-        returns(
-          T.nilable(
-            T::Array[Sentdm::SentDmServicesCommonContractsPocOsTemplateButton]
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Array[Sentdm::TemplateDefinition::Button])) }
       attr_accessor :buttons
 
       # The version of the template definition format
@@ -55,37 +39,23 @@ module Sentdm
       attr_accessor :definition_version
 
       # Optional template footer with optional variables
-      sig do
-        returns(
-          T.nilable(Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter)
-        )
-      end
+      sig { returns(T.nilable(Sentdm::TemplateDefinition::Footer)) }
       attr_reader :footer
 
       sig do
         params(
-          footer:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter::OrHash
-            )
+          footer: T.nilable(Sentdm::TemplateDefinition::Footer::OrHash)
         ).void
       end
       attr_writer :footer
 
       # Optional template header with optional variables
-      sig do
-        returns(
-          T.nilable(Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader)
-        )
-      end
+      sig { returns(T.nilable(Sentdm::TemplateDefinition::Header)) }
       attr_reader :header
 
       sig do
         params(
-          header:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader::OrHash
-            )
+          header: T.nilable(Sentdm::TemplateDefinition::Header::OrHash)
         ).void
       end
       attr_writer :header
@@ -94,26 +64,14 @@ module Sentdm
       # buttons
       sig do
         params(
-          body: Sentdm::SentDmServicesCommonContractsPocOsTemplateBody::OrHash,
+          body: Sentdm::TemplateDefinition::Body::OrHash,
           authentication_config:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig::OrHash
-            ),
+            T.nilable(Sentdm::TemplateDefinition::AuthenticationConfig::OrHash),
           buttons:
-            T.nilable(
-              T::Array[
-                Sentdm::SentDmServicesCommonContractsPocOsTemplateButton::OrHash
-              ]
-            ),
+            T.nilable(T::Array[Sentdm::TemplateDefinition::Button::OrHash]),
           definition_version: T.nilable(String),
-          footer:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter::OrHash
-            ),
-          header:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader::OrHash
-            )
+          footer: T.nilable(Sentdm::TemplateDefinition::Footer::OrHash),
+          header: T.nilable(Sentdm::TemplateDefinition::Header::OrHash)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -136,31 +94,404 @@ module Sentdm
       sig do
         override.returns(
           {
-            body: Sentdm::SentDmServicesCommonContractsPocOsTemplateBody,
+            body: Sentdm::TemplateDefinition::Body,
             authentication_config:
-              T.nilable(
-                Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig
-              ),
-            buttons:
-              T.nilable(
-                T::Array[
-                  Sentdm::SentDmServicesCommonContractsPocOsTemplateButton
-                ]
-              ),
+              T.nilable(Sentdm::TemplateDefinition::AuthenticationConfig),
+            buttons: T.nilable(T::Array[Sentdm::TemplateDefinition::Button]),
             definition_version: T.nilable(String),
-            footer:
-              T.nilable(
-                Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter
-              ),
-            header:
-              T.nilable(
-                Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader
-              )
+            footer: T.nilable(Sentdm::TemplateDefinition::Footer),
+            header: T.nilable(Sentdm::TemplateDefinition::Header)
           }
         )
       end
       def to_hash
       end
+
+      class Body < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::TemplateDefinition::Body, Sentdm::Internal::AnyHash)
+          end
+
+        # Content that will be used for all channels (SMS and WhatsApp) unless
+        # channel-specific content is provided
+        sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
+        attr_reader :multi_channel
+
+        sig do
+          params(
+            multi_channel: T.nilable(Sentdm::TemplateBodyContent::OrHash)
+          ).void
+        end
+        attr_writer :multi_channel
+
+        # SMS-specific content that overrides multi-channel content for SMS messages
+        sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
+        attr_reader :sms
+
+        sig { params(sms: T.nilable(Sentdm::TemplateBodyContent::OrHash)).void }
+        attr_writer :sms
+
+        # WhatsApp-specific content that overrides multi-channel content for WhatsApp
+        # messages
+        sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
+        attr_reader :whatsapp
+
+        sig do
+          params(whatsapp: T.nilable(Sentdm::TemplateBodyContent::OrHash)).void
+        end
+        attr_writer :whatsapp
+
+        # Required template body with content for different channels (multi-channel,
+        # SMS-specific, or WhatsApp-specific)
+        sig do
+          params(
+            multi_channel: T.nilable(Sentdm::TemplateBodyContent::OrHash),
+            sms: T.nilable(Sentdm::TemplateBodyContent::OrHash),
+            whatsapp: T.nilable(Sentdm::TemplateBodyContent::OrHash)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Content that will be used for all channels (SMS and WhatsApp) unless
+          # channel-specific content is provided
+          multi_channel: nil,
+          # SMS-specific content that overrides multi-channel content for SMS messages
+          sms: nil,
+          # WhatsApp-specific content that overrides multi-channel content for WhatsApp
+          # messages
+          whatsapp: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              multi_channel: T.nilable(Sentdm::TemplateBodyContent),
+              sms: T.nilable(Sentdm::TemplateBodyContent),
+              whatsapp: T.nilable(Sentdm::TemplateBodyContent)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class AuthenticationConfig < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::TemplateDefinition::AuthenticationConfig,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Whether to add the security recommendation text: "For your security, do not
+        # share this code."
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :add_security_recommendation
+
+        sig { params(add_security_recommendation: T::Boolean).void }
+        attr_writer :add_security_recommendation
+
+        # Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+        # in X minutes."
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :code_expiration_minutes
+
+        # Configuration specific to AUTHENTICATION category templates (optional)
+        sig do
+          params(
+            add_security_recommendation: T::Boolean,
+            code_expiration_minutes: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether to add the security recommendation text: "For your security, do not
+          # share this code."
+          add_security_recommendation: nil,
+          # Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+          # in X minutes."
+          code_expiration_minutes: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              add_security_recommendation: T::Boolean,
+              code_expiration_minutes: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Button < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::TemplateDefinition::Button, Sentdm::Internal::AnyHash)
+          end
+
+        # The unique identifier of the button (1-based index)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :id
+
+        sig { params(id: Integer).void }
+        attr_writer :id
+
+        # Properties specific to the button type
+        sig { returns(T.nilable(Sentdm::TemplateDefinition::Button::Props)) }
+        attr_reader :props
+
+        sig do
+          params(props: Sentdm::TemplateDefinition::Button::Props::OrHash).void
+        end
+        attr_writer :props
+
+        # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        # Interactive button in a message template
+        sig do
+          params(
+            id: Integer,
+            props: Sentdm::TemplateDefinition::Button::Props::OrHash,
+            type: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier of the button (1-based index)
+          id: nil,
+          # Properties specific to the button type
+          props: nil,
+          # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+          type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: Integer,
+              props: Sentdm::TemplateDefinition::Button::Props,
+              type: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Props < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::TemplateDefinition::Button::Props,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :active_for
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :autofill_text
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :country_code
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :offer_code
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :otp_type
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :package_name
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :phone_number
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :quick_reply_type
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :signature_hash
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :text
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :url
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :url_type
+
+          # Properties specific to the button type
+          sig do
+            params(
+              active_for: T.nilable(Integer),
+              autofill_text: T.nilable(String),
+              country_code: T.nilable(String),
+              offer_code: T.nilable(String),
+              otp_type: T.nilable(String),
+              package_name: T.nilable(String),
+              phone_number: T.nilable(String),
+              quick_reply_type: T.nilable(String),
+              signature_hash: T.nilable(String),
+              text: T.nilable(String),
+              url: T.nilable(String),
+              url_type: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            active_for: nil,
+            autofill_text: nil,
+            country_code: nil,
+            offer_code: nil,
+            otp_type: nil,
+            package_name: nil,
+            phone_number: nil,
+            quick_reply_type: nil,
+            signature_hash: nil,
+            text: nil,
+            url: nil,
+            url_type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                active_for: T.nilable(Integer),
+                autofill_text: T.nilable(String),
+                country_code: T.nilable(String),
+                offer_code: T.nilable(String),
+                otp_type: T.nilable(String),
+                package_name: T.nilable(String),
+                phone_number: T.nilable(String),
+                quick_reply_type: T.nilable(String),
+                signature_hash: T.nilable(String),
+                text: T.nilable(String),
+                url: T.nilable(String),
+                url_type: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Footer < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::TemplateDefinition::Footer, Sentdm::Internal::AnyHash)
+          end
+
+        # The footer template text with optional variable placeholders
+        sig { returns(T.nilable(String)) }
+        attr_reader :template
+
+        sig { params(template: String).void }
+        attr_writer :template
+
+        # The type of footer (typically "text")
+        sig { returns(T.nilable(String)) }
+        attr_accessor :type
+
+        # List of variables used in the footer template
+        sig { returns(T.nilable(T::Array[Sentdm::TemplateVariable])) }
+        attr_accessor :variables
+
+        # Optional template footer with optional variables
+        sig do
+          params(
+            template: String,
+            type: T.nilable(String),
+            variables: T.nilable(T::Array[Sentdm::TemplateVariable::OrHash])
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The footer template text with optional variable placeholders
+          template: nil,
+          # The type of footer (typically "text")
+          type: nil,
+          # List of variables used in the footer template
+          variables: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              template: String,
+              type: T.nilable(String),
+              variables: T.nilable(T::Array[Sentdm::TemplateVariable])
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Header < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::TemplateDefinition::Header, Sentdm::Internal::AnyHash)
+          end
+
+        # The header template text with optional variable placeholders (e.g., "Welcome to
+        # {{0:variable}}")
+        sig { returns(T.nilable(String)) }
+        attr_reader :template
+
+        sig { params(template: String).void }
+        attr_writer :template
+
+        # The type of header (e.g., "text", "image", "video", "document")
+        sig { returns(T.nilable(String)) }
+        attr_accessor :type
+
+        # List of variables used in the header template
+        sig { returns(T.nilable(T::Array[Sentdm::TemplateVariable])) }
+        attr_accessor :variables
+
+        # Optional template header with optional variables
+        sig do
+          params(
+            template: String,
+            type: T.nilable(String),
+            variables: T.nilable(T::Array[Sentdm::TemplateVariable::OrHash])
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The header template text with optional variable placeholders (e.g., "Welcome to
+          # {{0:variable}}")
+          template: nil,
+          # The type of header (e.g., "text", "image", "video", "document")
+          type: nil,
+          # List of variables used in the header template
+          variables: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              template: String,
+              type: T.nilable(String),
+              variables: T.nilable(T::Array[Sentdm::TemplateVariable])
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/sentdm/models/user_remove_params.rbi

@@ -57,7 +57,7 @@ module Sentdm
       def to_hash
       end
 
-      class Body < Sentdm::Models::MutationRequest
+      class Body < Sentdm::Models::MutationRequestBase
         OrHash =
           T.type_alias do
             T.any(Sentdm::UserRemoveParams::Body, Sentdm::Internal::AnyHash)

data/rbi/sentdm/models/webhook_rotate_secret_params.rbi

@@ -64,7 +64,7 @@ module Sentdm
       def to_hash
       end
 
-      class Body < Sentdm::Models::MutationRequest
+      class Body < Sentdm::Models::MutationRequestBase
         OrHash =
           T.type_alias do
             T.any(

data/rbi/sentdm/models.rbi

@@ -5,7 +5,7 @@ module Sentdm
 
   APIMeta = Sentdm::Models::APIMeta
 
-  APIResponseContact = Sentdm::Models::APIResponseContact
+  APIResponseOfContact = Sentdm::Models::APIResponseOfContact
 
   APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
 
@@ -15,13 +15,11 @@ module Sentdm
 
   APIResponseWebhook = Sentdm::Models::APIResponseWebhook
 
-  BrandData = Sentdm::Models::BrandData
+  BaseDto = Sentdm::Models::BaseDto
 
-  Brands = Sentdm::Models::Brands
+  BillingContactInfo = Sentdm::Models::BillingContactInfo
 
-  BrandWithKYC = Sentdm::Models::BrandWithKYC
-
-  Contact = Sentdm::Models::Contact
+  BrandsBrandData = Sentdm::Models::BrandsBrandData
 
   ContactCreateParams = Sentdm::Models::ContactCreateParams
 
@@ -29,6 +27,8 @@ module Sentdm
 
   ContactListParams = Sentdm::Models::ContactListParams
 
+  ContactResponse = Sentdm::Models::ContactResponse
+
   ContactRetrieveParams = Sentdm::Models::ContactRetrieveParams
 
   ContactUpdateParams = Sentdm::Models::ContactUpdateParams
@@ -44,11 +44,15 @@ module Sentdm
 
   MessageSendParams = Sentdm::Models::MessageSendParams
 
-  MutationRequest = Sentdm::Models::MutationRequest
+  MutationRequestBase = Sentdm::Models::MutationRequestBase
+
+  NumberLookupParams = Sentdm::Models::NumberLookupParams
 
   PaginationMeta = Sentdm::Models::PaginationMeta
 
-  ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
+  PaymentDetails = Sentdm::Models::PaymentDetails
+
+  ProfileCompleteSetupParams = Sentdm::Models::ProfileCompleteSetupParams
 
   ProfileCreateParams = Sentdm::Models::ProfileCreateParams
 
@@ -60,28 +64,12 @@ module Sentdm
 
   ProfileRetrieveParams = Sentdm::Models::ProfileRetrieveParams
 
+  Profiles = Sentdm::Models::Profiles
+
   ProfileSettings = Sentdm::Models::ProfileSettings
 
   ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
 
-  SentDmServicesCommonContractsPocOsAuthenticationConfig =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig
-
-  SentDmServicesCommonContractsPocOsTemplateBody =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody
-
-  SentDmServicesCommonContractsPocOsTemplateButton =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton
-
-  SentDmServicesCommonContractsPocOsTemplateButtonProps =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps
-
-  SentDmServicesCommonContractsPocOsTemplateFooter =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter
-
-  SentDmServicesCommonContractsPocOsTemplateHeader =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader
-
   TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
 
   TcrVertical = Sentdm::Models::TcrVertical

data/rbi/sentdm/resources/contacts.rbi

@@ -13,7 +13,7 @@ module Sentdm
           idempotency_key: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseContact)
+        ).returns(Sentdm::APIResponseOfContact)
       end
       def create(
         # Body param: Phone number of the contact to create
@@ -41,7 +41,7 @@ module Sentdm
           id: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseContact)
+        ).returns(Sentdm::APIResponseOfContact)
       end
       def retrieve(
         # Contact ID from route parameter
@@ -64,7 +64,7 @@ module Sentdm
           idempotency_key: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseContact)
+        ).returns(Sentdm::APIResponseOfContact)
       end
       def update(
         # Path param: Contact ID from route parameter

data/rbi/sentdm/resources/numbers.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    # Manage and lookup phone numbers
+    class Numbers
+      # Retrieves detailed information about a phone number including carrier, line
+      # type, porting status, and VoIP detection. Uses the customer's messaging provider
+      # for rich data, with fallback to the internal index.
+      sig do
+        params(
+          phone_number: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::NumberLookupResponse)
+      end
+      def lookup(
+        phone_number,
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end