sentdm 0.1.0 → 0.3.0

data/rbi/sentdm/models/profile_update_params.rbi

@@ -0,0 +1,196 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileUpdateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ProfileUpdateParams, Sentdm::Internal::AnyHash)
+        end
+
+      # Whether contacts are shared across profiles (optional)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :allow_contact_sharing
+
+      # Whether number changes are allowed during onboarding (optional)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :allow_number_change_during_onboarding
+
+      # Whether templates are shared across profiles (optional)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :allow_template_sharing
+
+      # Billing model: profile, organization, or profile_and_organization (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :billing_model
+
+      # Profile description (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Profile icon URL (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :icon
+
+      # Whether this profile inherits contacts from organization (optional)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_contacts
+
+      # Whether this profile inherits TCR brand from organization (optional)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_tcr_brand
+
+      # Whether this profile inherits TCR campaign from organization (optional)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_tcr_campaign
+
+      # Whether this profile inherits templates from organization (optional)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_templates
+
+      # Profile name (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # Profile ID from route parameter
+      sig { returns(T.nilable(String)) }
+      attr_reader :body_profile_id
+
+      sig { params(body_profile_id: String).void }
+      attr_writer :body_profile_id
+
+      # Direct phone number for SMS sending (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :sending_phone_number
+
+      # Reference to another profile to use for SMS/Telnyx configuration (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :sending_phone_number_profile_id
+
+      # Reference to another profile to use for WhatsApp configuration (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :sending_whatsapp_number_profile_id
+
+      # Profile short name/abbreviation (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :short_name
+
+      # Test mode 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 :test_mode
+
+      sig { params(test_mode: T::Boolean).void }
+      attr_writer :test_mode
+
+      # Direct phone number for WhatsApp sending (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :whatsapp_phone_number
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig do
+        params(
+          allow_contact_sharing: T.nilable(T::Boolean),
+          allow_number_change_during_onboarding: T.nilable(T::Boolean),
+          allow_template_sharing: T.nilable(T::Boolean),
+          billing_model: T.nilable(String),
+          description: T.nilable(String),
+          icon: 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),
+          name: T.nilable(String),
+          body_profile_id: String,
+          sending_phone_number: T.nilable(String),
+          sending_phone_number_profile_id: T.nilable(String),
+          sending_whatsapp_number_profile_id: T.nilable(String),
+          short_name: T.nilable(String),
+          test_mode: T::Boolean,
+          whatsapp_phone_number: T.nilable(String),
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether contacts are shared across profiles (optional)
+        allow_contact_sharing: nil,
+        # Whether number changes are allowed during onboarding (optional)
+        allow_number_change_during_onboarding: nil,
+        # Whether templates are shared across profiles (optional)
+        allow_template_sharing: nil,
+        # Billing model: profile, organization, or profile_and_organization (optional)
+        billing_model: nil,
+        # Profile description (optional)
+        description: nil,
+        # Profile icon URL (optional)
+        icon: nil,
+        # Whether this profile inherits contacts from organization (optional)
+        inherit_contacts: nil,
+        # Whether this profile inherits TCR brand from organization (optional)
+        inherit_tcr_brand: nil,
+        # Whether this profile inherits TCR campaign from organization (optional)
+        inherit_tcr_campaign: nil,
+        # Whether this profile inherits templates from organization (optional)
+        inherit_templates: nil,
+        # Profile name (optional)
+        name: nil,
+        # Profile ID from route parameter
+        body_profile_id: nil,
+        # Direct phone number for SMS sending (optional)
+        sending_phone_number: nil,
+        # Reference to another profile to use for SMS/Telnyx configuration (optional)
+        sending_phone_number_profile_id: nil,
+        # Reference to another profile to use for WhatsApp configuration (optional)
+        sending_whatsapp_number_profile_id: nil,
+        # Profile short name/abbreviation (optional)
+        short_name: nil,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        # Direct phone number for WhatsApp sending (optional)
+        whatsapp_phone_number: nil,
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            allow_contact_sharing: T.nilable(T::Boolean),
+            allow_number_change_during_onboarding: T.nilable(T::Boolean),
+            allow_template_sharing: T.nilable(T::Boolean),
+            billing_model: T.nilable(String),
+            description: T.nilable(String),
+            icon: 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),
+            name: T.nilable(String),
+            body_profile_id: String,
+            sending_phone_number: T.nilable(String),
+            sending_phone_number_profile_id: T.nilable(String),
+            sending_whatsapp_number_profile_id: T.nilable(String),
+            short_name: T.nilable(String),
+            test_mode: T::Boolean,
+            whatsapp_phone_number: T.nilable(String),
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsAuthenticationConfig < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig,
+            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 for AUTHENTICATION category templates
+      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
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateBody < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateBody,
+            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
+
+      # Body section of a message template with channel-specific content
+      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
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateButton < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButton,
+            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 do
+        returns(
+          T.nilable(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps
+          )
+        )
+      end
+      attr_reader :props
+
+      sig do
+        params(
+          props:
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::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::SentDmServicesCommonContractsPocOsTemplateButtonProps::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::SentDmServicesCommonContractsPocOsTemplateButtonProps,
+            type: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateButtonProps < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
+            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
+
+      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
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateFooter < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter,
+            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
+
+      # Footer section of a message template
+      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
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateHeader < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader,
+            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
+
+      # Header section of a message template
+      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

data/rbi/sentdm/models/tcr_brand_relationship.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module TcrBrandRelationship
+      extend Sentdm::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Sentdm::TcrBrandRelationship) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      BASIC_ACCOUNT =
+        T.let(:BASIC_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+      MEDIUM_ACCOUNT =
+        T.let(:MEDIUM_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+      LARGE_ACCOUNT =
+        T.let(:LARGE_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+      SMALL_ACCOUNT =
+        T.let(:SMALL_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+      KEY_ACCOUNT =
+        T.let(:KEY_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Sentdm::TcrBrandRelationship::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end