sentdm 0.2.0 → 0.3.1

data/rbi/sentdm/models/brands/tcr_campaign_with_use_cases.rbi

@@ -0,0 +1,404 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Brands
+      class TcrCampaignWithUseCases < Sentdm::Models::Brands::BaseDto
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Brands::TcrCampaignWithUseCases,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :billed_date
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :brand_id
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :cost
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :csp_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :help_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :help_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :kyc_submission_form_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :message_flow
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optin_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optin_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optout_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optout_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :privacy_policy_link
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reseller_id
+
+        sig do
+          returns(
+            T.nilable(
+              Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :sharing_status
+
+        sig do
+          returns(
+            T.nilable(
+              Sentdm::Brands::TcrCampaignWithUseCases::Status::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :submitted_at
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :submitted_to_tcr
+
+        sig { params(submitted_to_tcr: T::Boolean).void }
+        attr_writer :submitted_to_tcr
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tcr_campaign_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tcr_sync_error
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :telnyx_campaign_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :terms_and_conditions_link
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :upstream_cnp_id
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase]
+            )
+          )
+        end
+        attr_reader :use_cases
+
+        sig do
+          params(
+            use_cases:
+              T::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase::OrHash]
+          ).void
+        end
+        attr_writer :use_cases
+
+        sig do
+          params(
+            billed_date: T.nilable(Time),
+            brand_id: T.nilable(String),
+            cost: T.nilable(Float),
+            csp_id: T.nilable(String),
+            customer_id: String,
+            description: String,
+            help_keywords: T.nilable(String),
+            help_message: T.nilable(String),
+            kyc_submission_form_id: T.nilable(String),
+            message_flow: T.nilable(String),
+            name: String,
+            optin_keywords: T.nilable(String),
+            optin_message: T.nilable(String),
+            optout_keywords: T.nilable(String),
+            optout_message: T.nilable(String),
+            privacy_policy_link: T.nilable(String),
+            reseller_id: T.nilable(String),
+            sharing_status:
+              T.nilable(
+                Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus::OrSymbol
+              ),
+            status:
+              T.nilable(
+                Sentdm::Brands::TcrCampaignWithUseCases::Status::OrSymbol
+              ),
+            submitted_at: T.nilable(Time),
+            submitted_to_tcr: T::Boolean,
+            tcr_campaign_id: T.nilable(String),
+            tcr_sync_error: T.nilable(String),
+            telnyx_campaign_id: T.nilable(String),
+            terms_and_conditions_link: T.nilable(String),
+            type: String,
+            upstream_cnp_id: T.nilable(String),
+            use_cases:
+              T::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          billed_date: nil,
+          brand_id: nil,
+          cost: nil,
+          csp_id: nil,
+          customer_id: nil,
+          description: nil,
+          help_keywords: nil,
+          help_message: nil,
+          kyc_submission_form_id: nil,
+          message_flow: nil,
+          name: nil,
+          optin_keywords: nil,
+          optin_message: nil,
+          optout_keywords: nil,
+          optout_message: nil,
+          privacy_policy_link: nil,
+          reseller_id: nil,
+          sharing_status: nil,
+          status: nil,
+          submitted_at: nil,
+          submitted_to_tcr: nil,
+          tcr_campaign_id: nil,
+          tcr_sync_error: nil,
+          telnyx_campaign_id: nil,
+          terms_and_conditions_link: nil,
+          type: nil,
+          upstream_cnp_id: nil,
+          use_cases: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              billed_date: T.nilable(Time),
+              brand_id: T.nilable(String),
+              cost: T.nilable(Float),
+              csp_id: T.nilable(String),
+              customer_id: String,
+              description: String,
+              help_keywords: T.nilable(String),
+              help_message: T.nilable(String),
+              kyc_submission_form_id: T.nilable(String),
+              message_flow: T.nilable(String),
+              name: String,
+              optin_keywords: T.nilable(String),
+              optin_message: T.nilable(String),
+              optout_keywords: T.nilable(String),
+              optout_message: T.nilable(String),
+              privacy_policy_link: T.nilable(String),
+              reseller_id: T.nilable(String),
+              sharing_status:
+                T.nilable(
+                  Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+                ),
+              status:
+                T.nilable(
+                  Sentdm::Brands::TcrCampaignWithUseCases::Status::TaggedSymbol
+                ),
+              submitted_at: T.nilable(Time),
+              submitted_to_tcr: T::Boolean,
+              tcr_campaign_id: T.nilable(String),
+              tcr_sync_error: T.nilable(String),
+              telnyx_campaign_id: T.nilable(String),
+              terms_and_conditions_link: T.nilable(String),
+              type: String,
+              upstream_cnp_id: T.nilable(String),
+              use_cases:
+                T::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module SharingStatus
+          extend Sentdm::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :PENDING,
+              Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+            )
+          ACCEPTED =
+            T.let(
+              :ACCEPTED,
+              Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+            )
+          DECLINED =
+            T.let(
+              :DECLINED,
+              Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Sentdm::Brands::TcrCampaignWithUseCases::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SENT_CREATED =
+            T.let(
+              :SENT_CREATED,
+              Sentdm::Brands::TcrCampaignWithUseCases::Status::TaggedSymbol
+            )
+          ACTIVE =
+            T.let(
+              :ACTIVE,
+              Sentdm::Brands::TcrCampaignWithUseCases::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :EXPIRED,
+              Sentdm::Brands::TcrCampaignWithUseCases::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Sentdm::Brands::TcrCampaignWithUseCases::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class UseCase < Sentdm::Models::Brands::BaseDto
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Brands::TcrCampaignWithUseCases::UseCase,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :campaign_id
+
+          sig { params(campaign_id: String).void }
+          attr_writer :campaign_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :customer_id
+
+          sig { params(customer_id: String).void }
+          attr_writer :customer_id
+
+          sig do
+            returns(T.nilable(Sentdm::Brands::MessagingUseCaseUs::TaggedSymbol))
+          end
+          attr_reader :messaging_use_case_us
+
+          sig do
+            params(
+              messaging_use_case_us:
+                Sentdm::Brands::MessagingUseCaseUs::OrSymbol
+            ).void
+          end
+          attr_writer :messaging_use_case_us
+
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :sample_messages
+
+          sig { params(sample_messages: T::Array[String]).void }
+          attr_writer :sample_messages
+
+          sig do
+            params(
+              campaign_id: String,
+              customer_id: String,
+              messaging_use_case_us:
+                Sentdm::Brands::MessagingUseCaseUs::OrSymbol,
+              sample_messages: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            campaign_id: nil,
+            customer_id: nil,
+            messaging_use_case_us: nil,
+            sample_messages: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                campaign_id: String,
+                customer_id: String,
+                messaging_use_case_us:
+                  Sentdm::Brands::MessagingUseCaseUs::TaggedSymbol,
+                sample_messages: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/contact.rbi

@@ -0,0 +1,179 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class Contact < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::Contact, Sentdm::Internal::AnyHash) }
+
+      # 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
+
+      # 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
+
+      # Whether this is an inherited contact (read-only)
+      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
+      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,
+          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,
+        # 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,
+        # Whether this is an inherited contact (read-only)
+        is_inherited: nil,
+        # Whether the contact has opted out of messaging
+        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,
+            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

data/rbi/sentdm/models/contact_create_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ContactCreateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ContactCreateParams, Sentdm::Internal::AnyHash)
+        end
+
+      # Phone number of the contact to create
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone_number
+
+      sig { params(phone_number: String).void }
+      attr_writer :phone_number
+
+      # 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
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig do
+        params(
+          phone_number: String,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Phone number of the contact to create
+        phone_number: nil,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            phone_number: String,
+            test_mode: T::Boolean,
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/contact_delete_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ContactDeleteParams, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Request to delete/dissociate a contact
+      sig { returns(Sentdm::ContactDeleteParams::Body) }
+      attr_reader :body
+
+      sig { params(body: Sentdm::ContactDeleteParams::Body::OrHash).void }
+      attr_writer :body
+
+      sig do
+        params(
+          id: String,
+          body: Sentdm::ContactDeleteParams::Body::OrHash,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Request to delete/dissociate a contact
+        body:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            body: Sentdm::ContactDeleteParams::Body,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Body < Sentdm::Models::MutationRequest
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::ContactDeleteParams::Body, Sentdm::Internal::AnyHash)
+          end
+
+        # Request to delete/dissociate a contact
+        sig { returns(T.attached_class) }
+        def self.new
+        end
+
+        sig { override.returns({}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end