sentdm 0.2.0 → 0.3.0

data/rbi/sentdm/models/message_send_response.rbi

@@ -0,0 +1,231 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageSendResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::Models::MessageSendResponse, Sentdm::Internal::AnyHash)
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::Models::MessageSendResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::MessageSendResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error details (null if successful)
+      sig { returns(T.nilable(Sentdm::APIError)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      attr_writer :error
+
+      # Metadata about the request and response
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::MessageSendResponse::Data::OrHash),
+          error: T.nilable(Sentdm::APIError::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The response data (null if error)
+        data: nil,
+        # Error details (null if successful)
+        error: nil,
+        # Metadata about the request and response
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Models::MessageSendResponse::Data),
+            error: T.nilable(Sentdm::APIError),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::MessageSendResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Resolved template body text
+        sig { returns(T.nilable(String)) }
+        attr_accessor :body
+
+        # Per-recipient message results
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Sentdm::Models::MessageSendResponse::Data::Recipient]
+            )
+          )
+        end
+        attr_reader :recipients
+
+        sig do
+          params(
+            recipients:
+              T::Array[
+                Sentdm::Models::MessageSendResponse::Data::Recipient::OrHash
+              ]
+          ).void
+        end
+        attr_writer :recipients
+
+        # Overall request status (e.g. "accepted")
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        # Template ID that was used
+        sig { returns(T.nilable(String)) }
+        attr_reader :template_id
+
+        sig { params(template_id: String).void }
+        attr_writer :template_id
+
+        # Template display name
+        sig { returns(T.nilable(String)) }
+        attr_reader :template_name
+
+        sig { params(template_name: String).void }
+        attr_writer :template_name
+
+        # The response data (null if error)
+        sig do
+          params(
+            body: T.nilable(String),
+            recipients:
+              T::Array[
+                Sentdm::Models::MessageSendResponse::Data::Recipient::OrHash
+              ],
+            status: String,
+            template_id: String,
+            template_name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Resolved template body text
+          body: nil,
+          # Per-recipient message results
+          recipients: nil,
+          # Overall request status (e.g. "accepted")
+          status: nil,
+          # Template ID that was used
+          template_id: nil,
+          # Template display name
+          template_name: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              body: T.nilable(String),
+              recipients:
+                T::Array[Sentdm::Models::MessageSendResponse::Data::Recipient],
+              status: String,
+              template_id: String,
+              template_name: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Recipient < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Models::MessageSendResponse::Data::Recipient,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for
+          # auto-detect
+          sig { returns(T.nilable(String)) }
+          attr_accessor :channel
+
+          # Unique message identifier for tracking this recipient's message
+          sig { returns(T.nilable(String)) }
+          attr_reader :message_id
+
+          sig { params(message_id: String).void }
+          attr_writer :message_id
+
+          # Phone number in E.164 format
+          sig { returns(T.nilable(String)) }
+          attr_reader :to
+
+          sig { params(to: String).void }
+          attr_writer :to
+
+          # Per-recipient result in the send message response
+          sig do
+            params(
+              channel: T.nilable(String),
+              message_id: String,
+              to: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for
+            # auto-detect
+            channel: nil,
+            # Unique message identifier for tracking this recipient's message
+            message_id: nil,
+            # Phone number in E.164 format
+            to: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { channel: T.nilable(String), message_id: String, to: String }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/mutation_request.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MutationRequest < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MutationRequest, Sentdm::Internal::AnyHash)
+        end
+
+      # 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 { params(test_mode: T::Boolean).returns(T.attached_class) }
+      def self.new(
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil
+      )
+      end
+
+      sig { override.returns({ test_mode: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/pagination_meta.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class PaginationMeta < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::PaginationMeta, Sentdm::Internal::AnyHash)
+        end
+
+      # Cursor-based pagination (optional)
+      sig { returns(T.nilable(Sentdm::PaginationMeta::Cursors)) }
+      attr_reader :cursors
+
+      sig do
+        params(cursors: T.nilable(Sentdm::PaginationMeta::Cursors::OrHash)).void
+      end
+      attr_writer :cursors
+
+      # Whether there are more pages after this one
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_more
+
+      sig { params(has_more: T::Boolean).void }
+      attr_writer :has_more
+
+      # Current page number (1-indexed)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # Number of items per page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Total number of items across all pages
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :total_count
+
+      sig { params(total_count: Integer).void }
+      attr_writer :total_count
+
+      # Total number of pages
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :total_pages
+
+      sig { params(total_pages: Integer).void }
+      attr_writer :total_pages
+
+      # Pagination metadata for list responses
+      sig do
+        params(
+          cursors: T.nilable(Sentdm::PaginationMeta::Cursors::OrHash),
+          has_more: T::Boolean,
+          page: Integer,
+          page_size: Integer,
+          total_count: Integer,
+          total_pages: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor-based pagination (optional)
+        cursors: nil,
+        # Whether there are more pages after this one
+        has_more: nil,
+        # Current page number (1-indexed)
+        page: nil,
+        # Number of items per page
+        page_size: nil,
+        # Total number of items across all pages
+        total_count: nil,
+        # Total number of pages
+        total_pages: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursors: T.nilable(Sentdm::PaginationMeta::Cursors),
+            has_more: T::Boolean,
+            page: Integer,
+            page_size: Integer,
+            total_count: Integer,
+            total_pages: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Cursors < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::PaginationMeta::Cursors, Sentdm::Internal::AnyHash)
+          end
+
+        # Cursor to fetch the next page
+        sig { returns(T.nilable(String)) }
+        attr_accessor :after
+
+        # Cursor to fetch the previous page
+        sig { returns(T.nilable(String)) }
+        attr_accessor :before
+
+        # Cursor-based pagination (optional)
+        sig do
+          params(after: T.nilable(String), before: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Cursor to fetch the next page
+          after: nil,
+          # Cursor to fetch the previous page
+          before: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { after: T.nilable(String), before: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profile_complete_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileCompleteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ProfileCompleteParams, Sentdm::Internal::AnyHash)
+        end
+
+      # Webhook URL to call when profile completion finishes (success or failure)
+      sig { returns(String) }
+      attr_accessor :web_hook_url
+
+      # 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(
+          web_hook_url: String,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Webhook URL to call when profile completion finishes (success or failure)
+        web_hook_url:,
+        # 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(
+          {
+            web_hook_url: String,
+            test_mode: T::Boolean,
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profile_complete_response.rbi

@@ -0,0 +1,8 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    ProfileCompleteResponse =
+      T.let(T.anything, Sentdm::Internal::Type::Converter)
+  end
+end

data/rbi/sentdm/models/profile_create_params.rbi

@@ -0,0 +1,156 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileCreateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ProfileCreateParams, Sentdm::Internal::AnyHash)
+        end
+
+      # Whether contacts are shared across profiles (default: false)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :allow_contact_sharing
+
+      sig { params(allow_contact_sharing: T::Boolean).void }
+      attr_writer :allow_contact_sharing
+
+      # Whether templates are shared across profiles (default: false)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :allow_template_sharing
+
+      sig { params(allow_template_sharing: T::Boolean).void }
+      attr_writer :allow_template_sharing
+
+      # Billing model: profile, organization, or profile_and_organization (default:
+      # profile)
+      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 (default: true)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_contacts
+
+      # Whether this profile inherits TCR brand from organization (default: true)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_tcr_brand
+
+      # Whether this profile inherits TCR campaign from organization (default: true)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_tcr_campaign
+
+      # Whether this profile inherits templates from organization (default: true)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_templates
+
+      # Profile name (required)
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # 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
+
+      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::Boolean,
+          allow_template_sharing: 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: String,
+          short_name: T.nilable(String),
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether contacts are shared across profiles (default: false)
+        allow_contact_sharing: nil,
+        # Whether templates are shared across profiles (default: false)
+        allow_template_sharing: nil,
+        # Billing model: profile, organization, or profile_and_organization (default:
+        # profile)
+        billing_model: nil,
+        # Profile description (optional)
+        description: nil,
+        # Profile icon URL (optional)
+        icon: nil,
+        # Whether this profile inherits contacts from organization (default: true)
+        inherit_contacts: nil,
+        # Whether this profile inherits TCR brand from organization (default: true)
+        inherit_tcr_brand: nil,
+        # Whether this profile inherits TCR campaign from organization (default: true)
+        inherit_tcr_campaign: nil,
+        # Whether this profile inherits templates from organization (default: true)
+        inherit_templates: nil,
+        # Profile name (required)
+        name: 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,
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            allow_contact_sharing: T::Boolean,
+            allow_template_sharing: 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: String,
+            short_name: T.nilable(String),
+            test_mode: T::Boolean,
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profile_delete_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileDeleteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ProfileDeleteParams, Sentdm::Internal::AnyHash)
+        end
+
+      # 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
+
+      # 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 do
+        params(
+          body_profile_id: String,
+          test_mode: T::Boolean,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Profile ID from route parameter
+        body_profile_id: nil,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            body_profile_id: String,
+            test_mode: T::Boolean,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end