sentdm 0.29.0 → 0.31.0

data/lib/sentdm/models/brand_contact_info.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandContactInfo < Sentdm::Internal::Type::BaseModel
+      # @!attribute name
+      #   Primary contact name (required)
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute business_name
+      #   Business/brand name
+      #
+      #   @return [String, nil]
+      optional :business_name, String, api_name: :businessName, nil?: true
+
+      # @!attribute email
+      #   Contact email address
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute phone
+      #   Contact phone number in E.164 format
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!attribute phone_country_code
+      #   Contact phone country code (e.g., "1" for US)
+      #
+      #   @return [String, nil]
+      optional :phone_country_code, String, api_name: :phoneCountryCode, nil?: true
+
+      # @!attribute role
+      #   Contact's role in the business
+      #
+      #   @return [String, nil]
+      optional :role, String, nil?: true
+
+      # @!method initialize(name:, business_name: nil, email: nil, phone: nil, phone_country_code: nil, role: nil)
+      #   Contact information for brand KYC
+      #
+      #   @param name [String] Primary contact name (required)
+      #
+      #   @param business_name [String, nil] Business/brand name
+      #
+      #   @param email [String, nil] Contact email address
+      #
+      #   @param phone [String, nil] Contact phone number in E.164 format
+      #
+      #   @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
+      #
+      #   @param role [String, nil] Contact's role in the business
+    end
+  end
+end

data/lib/sentdm/models/brands_brand_data.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandsBrandData < Sentdm::Internal::Type::BaseModel
+      # @!attribute compliance
+      #   Compliance and TCR information for brand registration
+      #
+      #   @return [Sentdm::Models::BrandComplianceInfo]
+      required :compliance, -> { Sentdm::BrandComplianceInfo }
+
+      # @!attribute contact
+      #   Contact information for brand KYC
+      #
+      #   @return [Sentdm::Models::BrandContactInfo]
+      required :contact, -> { Sentdm::BrandContactInfo }
+
+      # @!attribute business
+      #   Business details and address for brand KYC
+      #
+      #   @return [Sentdm::Models::BrandBusinessInfo, nil]
+      optional :business, -> { Sentdm::BrandBusinessInfo }, nil?: true
+
+      # @!method initialize(compliance:, contact:, business: nil)
+      #   Brand and KYC data grouped into contact, business, and compliance sections
+      #
+      #   @param compliance [Sentdm::Models::BrandComplianceInfo] Compliance and TCR information for brand registration
+      #
+      #   @param contact [Sentdm::Models::BrandContactInfo] Contact information for brand KYC
+      #
+      #   @param business [Sentdm::Models::BrandBusinessInfo, nil] Business details and address for brand KYC
+    end
+  end
+end

data/lib/sentdm/models/contact_delete_params.rb

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Contacts#delete
-    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
+    class ContactDeleteParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -12,28 +12,14 @@ module Sentdm
       #   @return [String]
       required :id, String
 
-      # @!attribute sandbox
-      #   Sandbox flag - when true, the operation is simulated without side effects Useful
-      #   for testing integrations without actual execution
-      #
-      #   @return [Boolean, nil]
-      optional :sandbox, Sentdm::Internal::Type::Boolean
-
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, sandbox: nil, x_profile_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::ContactDeleteParams} for more details.
-      #
+      # @!method initialize(id:, x_profile_id: nil, request_options: {})
       #   @param id [String]
-      #
-      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
-      #
       #   @param x_profile_id [String]
-      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/sentdm/models/contact_list_params.rb

@@ -7,23 +7,23 @@ module Sentdm
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
+      # @!attribute channel
+      #   Optional channel filter (sms, whatsapp)
+      #
+      #   @return [String, nil]
+      optional :channel, String, nil?: true
+
       # @!attribute page
       #   Page number (1-indexed)
       #
-      #   @return [Integer]
-      required :page, Integer
+      #   @return [Integer, nil]
+      optional :page, Integer
 
       # @!attribute page_size
       #   Number of items per page
       #
-      #   @return [Integer]
-      required :page_size, Integer
-
-      # @!attribute channel
-      #   Optional channel filter (sms, whatsapp)
-      #
-      #   @return [String, nil]
-      optional :channel, String, nil?: true
+      #   @return [Integer, nil]
+      optional :page_size, Integer
 
       # @!attribute phone
       #   Optional phone number filter (alternative to list view)
@@ -42,13 +42,13 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(page:, page_size:, channel: nil, phone: nil, search: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(channel: nil, page: nil, page_size: nil, phone: nil, search: nil, x_profile_id: nil, request_options: {})
+      #   @param channel [String, nil] Optional channel filter (sms, whatsapp)
+      #
       #   @param page [Integer] Page number (1-indexed)
       #
       #   @param page_size [Integer] Number of items per page
       #
-      #   @param channel [String, nil] Optional channel filter (sms, whatsapp)
-      #
       #   @param phone [String, nil] Optional phone number filter (alternative to list view)
       #
       #   @param search [String, nil] Optional search term for filtering contacts

data/lib/sentdm/models/contact_message_summary.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ContactMessageSummary < Sentdm::Internal::Type::BaseModel
+      # @!attribute channel_scores
+      #
+      #   @return [Array<Sentdm::Models::ContactMessageSummary::ChannelScore>, nil]
+      optional :channel_scores,
+               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactMessageSummary::ChannelScore] }
+
+      # @!attribute channels_used
+      #
+      #   @return [Array<String>, nil]
+      optional :channels_used, Sentdm::Internal::Type::ArrayOf[String]
+
+      # @!attribute contact_id
+      #
+      #   @return [String, nil]
+      optional :contact_id, String
+
+      # @!attribute first_message_at
+      #
+      #   @return [Time, nil]
+      optional :first_message_at, Time, nil?: true
+
+      # @!attribute last_message_at
+      #
+      #   @return [Time, nil]
+      optional :last_message_at, Time, nil?: true
+
+      # @!attribute message_count
+      #
+      #   @return [Integer, nil]
+      optional :message_count, Integer
+
+      # @!method initialize(channel_scores: nil, channels_used: nil, contact_id: nil, first_message_at: nil, last_message_at: nil, message_count: nil)
+      #   @param channel_scores [Array<Sentdm::Models::ContactMessageSummary::ChannelScore>]
+      #   @param channels_used [Array<String>]
+      #   @param contact_id [String]
+      #   @param first_message_at [Time, nil]
+      #   @param last_message_at [Time, nil]
+      #   @param message_count [Integer]
+
+      class ChannelScore < Sentdm::Internal::Type::BaseModel
+        # @!attribute channel
+        #
+        #   @return [String, nil]
+        optional :channel, String
+
+        # @!attribute fail_score
+        #   Percentage (0-100) of messages on this channel that ended in FAILED.
+        #
+        #   @return [Integer, nil]
+        optional :fail_score, Integer
+
+        # @!attribute success_score
+        #   Percentage (0-100) of messages on this channel that reached a successful
+        #   terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
+        #
+        #   @return [Integer, nil]
+        optional :success_score, Integer
+
+        # @!method initialize(channel: nil, fail_score: nil, success_score: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ContactMessageSummary::ChannelScore} for more details.
+        #
+        #   @param channel [String]
+        #
+        #   @param fail_score [Integer] Percentage (0-100) of messages on this channel that ended in FAILED.
+        #
+        #   @param success_score [Integer] Percentage (0-100) of messages on this channel that reached a successful termina
+      end
+    end
+  end
+end

data/lib/sentdm/models/contact_response.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#list
+    class ContactResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the contact
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute available_channels
+      #   Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+      #
+      #   @return [String, nil]
+      optional :available_channels, String
+
+      # @!attribute country_code
+      #   Country calling code (e.g., 1 for US/Canada)
+      #
+      #   @return [String, nil]
+      optional :country_code, String
+
+      # @!attribute created_at
+      #   When the contact was created
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute customer_id
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String
+
+      # @!attribute default_channel
+      #   Default messaging channel to use (e.g., "sms" or "whatsapp")
+      #
+      #   @return [String, nil]
+      optional :default_channel, String
+
+      # @!attribute format_e164
+      #   Phone number in E.164 format (e.g., +1234567890)
+      #
+      #   @return [String, nil]
+      optional :format_e164, String
+
+      # @!attribute format_international
+      #   Phone number in international format (e.g., +1 234-567-890)
+      #
+      #   @return [String, nil]
+      optional :format_international, String
+
+      # @!attribute format_national
+      #   Phone number in national format (e.g., (234) 567-890)
+      #
+      #   @return [String, nil]
+      optional :format_national, String
+
+      # @!attribute format_rfc
+      #   Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+      #
+      #   @return [String, nil]
+      optional :format_rfc, String
+
+      # @!attribute is_inherited
+      #   @deprecated
+      #
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :is_inherited, Sentdm::Internal::Type::Boolean
+
+      # @!attribute opt_out
+      #   Whether the contact has opted out of messaging. Single source of truth — opt-out
+      #   is per-contact, not per-channel.
+      #
+      #   @return [Boolean, nil]
+      optional :opt_out, Sentdm::Internal::Type::Boolean
+
+      # @!attribute phone_number
+      #   Phone number in original format
+      #
+      #   @return [String, nil]
+      optional :phone_number, String
+
+      # @!attribute region_code
+      #   ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+      #
+      #   @return [String, nil]
+      optional :region_code, String
+
+      # @!attribute updated_at
+      #   When the contact was last updated
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!method initialize(id: nil, available_channels: nil, country_code: nil, created_at: nil, customer_id: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ContactResponse} for more details.
+      #
+      #   Contact response for v3 API Uses snake_case for JSON property names
+      #
+      #   @param id [String] Unique identifier for the contact
+      #
+      #   @param available_channels [String] Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+      #
+      #   @param country_code [String] Country calling code (e.g., 1 for US/Canada)
+      #
+      #   @param created_at [Time] When the contact was created
+      #
+      #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
+      #
+      #   @param default_channel [String] Default messaging channel to use (e.g., "sms" or "whatsapp")
+      #
+      #   @param format_e164 [String] Phone number in E.164 format (e.g., +1234567890)
+      #
+      #   @param format_international [String] Phone number in international format (e.g., +1 234-567-890)
+      #
+      #   @param format_national [String] Phone number in national format (e.g., (234) 567-890)
+      #
+      #   @param format_rfc [String] Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+      #
+      #   @param is_inherited [Boolean] Always false. Contacts are no longer shared or inherited between sender profiles
+      #
+      #   @param opt_out [Boolean] Whether the contact has opted out of messaging. Single source of truth — opt-out
+      #
+      #   @param phone_number [String] Phone number in original format
+      #
+      #   @param region_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+      #
+      #   @param updated_at [Time, nil] When the contact was last updated
+    end
+  end
+end

data/lib/sentdm/models/conversation_list_messages_params.rb

@@ -14,20 +14,20 @@ module Sentdm
 
       # @!attribute page
       #
-      #   @return [Integer]
-      required :page, Integer
+      #   @return [Integer, nil]
+      optional :page, Integer
 
       # @!attribute page_size
       #
-      #   @return [Integer]
-      required :page_size, Integer
+      #   @return [Integer, nil]
+      optional :page_size, Integer
 
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, page:, page_size:, x_profile_id: nil, request_options: {})
+      # @!method initialize(id:, page: nil, page_size: nil, x_profile_id: nil, request_options: {})
       #   @param id [String]
       #   @param page [Integer]
       #   @param page_size [Integer]

data/lib/sentdm/models/conversation_list_params.rb

@@ -9,20 +9,20 @@ module Sentdm
 
       # @!attribute page
       #
-      #   @return [Integer]
-      required :page, Integer
+      #   @return [Integer, nil]
+      optional :page, Integer
 
       # @!attribute page_size
       #
-      #   @return [Integer]
-      required :page_size, Integer
+      #   @return [Integer, nil]
+      optional :page_size, Integer
 
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(page:, page_size:, x_profile_id: nil, request_options: {})
+      # @!method initialize(page: nil, page_size: nil, x_profile_id: nil, request_options: {})
       #   @param page [Integer]
       #   @param page_size [Integer]
       #   @param x_profile_id [String]

data/lib/sentdm/models/conversation_messages_list.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ConversationMessagesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute messages
+      #   The messages on this page.
+      #
+      #   @return [Array<Sentdm::Models::ConversationMessagesList::Message>, nil]
+      optional :messages, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message] }
+
+      # @!attribute pagination
+      #   Pagination metadata for list responses
+      #
+      #   @return [Sentdm::Models::PaginationMeta, nil]
+      optional :pagination, -> { Sentdm::PaginationMeta }
+
+      # @!method initialize(messages: nil, pagination: nil)
+      #   A paginated list of messages — used by both conversation read endpoints.
+      #
+      #   @param messages [Array<Sentdm::Models::ConversationMessagesList::Message>] The messages on this page.
+      #
+      #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+
+      class Message < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute active_contact_price
+        #
+        #   @return [Float, nil]
+        optional :active_contact_price, Float, nil?: true
+
+        # @!attribute channel
+        #
+        #   @return [String, nil]
+        optional :channel, String
+
+        # @!attribute contact_id
+        #
+        #   @return [String, nil]
+        optional :contact_id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String
+
+        # @!attribute direction
+        #
+        #   @return [String, nil]
+        optional :direction, String
+
+        # @!attribute events
+        #
+        #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
+        optional :events,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::Event] },
+                 nil?: true
+
+        # @!attribute message_body
+        #   Structured message body format for database storage. Preserves channel-specific
+        #   components (header, body, footer, buttons).
+        #
+        #   @return [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil]
+        optional :message_body, -> { Sentdm::ConversationMessagesList::Message::MessageBody }, nil?: true
+
+        # @!attribute phone
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!attribute phone_international
+        #
+        #   @return [String, nil]
+        optional :phone_international, String
+
+        # @!attribute price
+        #
+        #   @return [Float, nil]
+        optional :price, Float, nil?: true
+
+        # @!attribute region_code
+        #
+        #   @return [String, nil]
+        optional :region_code, String
+
+        # @!attribute status
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute template_category
+        #
+        #   @return [String, nil]
+        optional :template_category, String, nil?: true
+
+        # @!attribute template_id
+        #
+        #   @return [String, nil]
+        optional :template_id, String, nil?: true
+
+        # @!attribute template_name
+        #
+        #   @return [String, nil]
+        optional :template_name, String, nil?: true
+
+        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ConversationMessagesList::Message} for more details.
+        #
+        #   Message response for v3 API — same shape as v2 with snake_case JSON conventions
+        #
+        #   @param id [String]
+        #
+        #   @param active_contact_price [Float, nil]
+        #
+        #   @param channel [String]
+        #
+        #   @param contact_id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param direction [String]
+        #
+        #   @param events [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
+        #
+        #   @param message_body [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil] Structured message body format for database storage.
+        #
+        #   @param phone [String]
+        #
+        #   @param phone_international [String]
+        #
+        #   @param price [Float, nil]
+        #
+        #   @param region_code [String]
+        #
+        #   @param status [String]
+        #
+        #   @param template_category [String, nil]
+        #
+        #   @param template_id [String, nil]
+        #
+        #   @param template_name [String, nil]
+
+        class Event < Sentdm::Internal::Type::BaseModel
+          # @!attribute status
+          #
+          #   @return [String]
+          required :status, String
+
+          # @!attribute timestamp
+          #
+          #   @return [Time]
+          required :timestamp, Time
+
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!method initialize(status:, timestamp:, description: nil)
+          #   Represents a status change event in a message's lifecycle (v3)
+          #
+          #   @param status [String]
+          #   @param timestamp [Time]
+          #   @param description [String, nil]
+        end
+
+        # @see Sentdm::Models::ConversationMessagesList::Message#message_body
+        class MessageBody < Sentdm::Internal::Type::BaseModel
+          # @!attribute buttons
+          #
+          #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
+          optional :buttons,
+                   -> {
+                     Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::MessageBody::Button]
+                   },
+                   nil?: true
+
+          # @!attribute content
+          #
+          #   @return [String, nil]
+          optional :content, String
+
+          # @!attribute footer
+          #
+          #   @return [String, nil]
+          optional :footer, String, nil?: true
+
+          # @!attribute header
+          #
+          #   @return [String, nil]
+          optional :header, String, nil?: true
+
+          # @!method initialize(buttons: nil, content: nil, footer: nil, header: nil)
+          #   Structured message body format for database storage. Preserves channel-specific
+          #   components (header, body, footer, buttons).
+          #
+          #   @param buttons [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
+          #   @param content [String]
+          #   @param footer [String, nil]
+          #   @param header [String, nil]
+
+          class Button < Sentdm::Internal::Type::BaseModel
+            # @!attribute postback_data
+            #
+            #   @return [String, nil]
+            optional :postback_data, String, api_name: :postbackData, nil?: true
+
+            # @!attribute text
+            #
+            #   @return [String, nil]
+            optional :text, String, nil?: true
+
+            # @!attribute type
+            #
+            #   @return [String, nil]
+            optional :type, String
+
+            # @!attribute value
+            #
+            #   @return [String, nil]
+            optional :value, String
+
+            # @!method initialize(postback_data: nil, text: nil, type: nil, value: nil)
+            #   @param postback_data [String, nil]
+            #   @param text [String, nil]
+            #   @param type [String]
+            #   @param value [String]
+          end
+        end
+      end
+    end
+  end
+end