sentdm 0.3.1 → 0.4.0

data/lib/sentdm/models/contact_update_params.rb

@@ -24,19 +24,24 @@ module Sentdm
       #   @return [Boolean, nil]
       optional :opt_out, Sentdm::Internal::Type::Boolean, nil?: true
 
-      # @!attribute test_mode
-      #   Test mode flag - when true, the operation is simulated without side effects
-      #   Useful for testing integrations without actual execution
+      # @!attribute sandbox
+      #   Sandbox flag - when true, the operation is simulated without side effects Useful
+      #   for testing integrations without actual execution
       #
       #   @return [Boolean, nil]
-      optional :test_mode, Sentdm::Internal::Type::Boolean
+      optional :sandbox, Sentdm::Internal::Type::Boolean
 
       # @!attribute idempotency_key
       #
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!method initialize(id:, default_channel: nil, opt_out: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(id:, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::ContactUpdateParams} for more details.
       #
@@ -46,10 +51,12 @@ module Sentdm
       #
       #   @param opt_out [Boolean, nil] Whether the contact has opted out of messaging
       #
-      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
       #   @param idempotency_key [String]
       #
+      #   @param x_profile_id [String]
+      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/sentdm/models/me_retrieve_params.rb

@@ -7,7 +7,13 @@ module Sentdm
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(x_profile_id: nil, request_options: {})
+      #   @param x_profile_id [String]
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/sentdm/models/me_retrieve_response.rb

@@ -42,11 +42,17 @@ module Sentdm
       # @see Sentdm::Models::MeRetrieveResponse#data
       class Data < Sentdm::Internal::Type::BaseModel
         # @!attribute id
-        #   Customer ID (organization or profile)
+        #   Customer ID (organization, account, or profile)
         #
         #   @return [String, nil]
         optional :id, String
 
+        # @!attribute channels
+        #   Messaging channel configuration
+        #
+        #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels, nil]
+        optional :channels, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels }
+
         # @!attribute created_at
         #   When the account was created
         #
@@ -59,6 +65,12 @@ module Sentdm
         #   @return [String, nil]
         optional :description, String, nil?: true
 
+        # @!attribute email
+        #   Contact email address
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
         # @!attribute icon
         #   Account icon URL
         #
@@ -71,13 +83,19 @@ module Sentdm
         #   @return [String, nil]
         optional :name, String
 
+        # @!attribute organization_id
+        #   Organization ID (only for profile type — the parent organization)
+        #
+        #   @return [String, nil]
+        optional :organization_id, String, nil?: true
+
         # @!attribute profiles
-        #   List of profiles (only for organization type)
+        #   List of profiles (populated for organization type, empty for user and profile
+        #   types)
         #
         #   @return [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>, nil]
         optional :profiles,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] },
-                 nil?: true
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] }
 
         # @!attribute settings
         #   Profile settings (only for profile type)
@@ -85,6 +103,12 @@ module Sentdm
         #   @return [Sentdm::Models::ProfileSettings, nil]
         optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
 
+        # @!attribute short_name
+        #   Short name / abbreviation (only for profile type)
+        #
+        #   @return [String, nil]
+        optional :short_name, String, nil?: true
+
         # @!attribute status
         #   Profile status (only for profile type): incomplete, pending_review, approved,
         #   etc.
@@ -92,27 +116,148 @@ module Sentdm
         #   @return [String, nil]
         optional :status, String, nil?: true
 
-        # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, profiles: nil, settings: nil, status: nil)
+        # @!attribute type
+        #   Account type: "organization" (has profiles), "user" (no profiles), or "profile"
+        #   (child of an organization)
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!method initialize(id: nil, channels: nil, created_at: nil, description: nil, email: nil, icon: nil, name: nil, organization_id: nil, profiles: nil, settings: nil, short_name: nil, status: nil, type: nil)
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::MeRetrieveResponse::Data} for more details.
         #
         #   The response data (null if error)
         #
-        #   @param id [String] Customer ID (organization or profile)
+        #   @param id [String] Customer ID (organization, account, or profile)
+        #
+        #   @param channels [Sentdm::Models::MeRetrieveResponse::Data::Channels] Messaging channel configuration
         #
         #   @param created_at [Time] When the account was created
         #
         #   @param description [String, nil] Account description
         #
+        #   @param email [String, nil] Contact email address
+        #
         #   @param icon [String, nil] Account icon URL
         #
         #   @param name [String] Account name
         #
-        #   @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>, nil] List of profiles (only for organization type)
+        #   @param organization_id [String, nil] Organization ID (only for profile type — the parent organization)
+        #
+        #   @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>] List of profiles (populated for organization type, empty for user and profile ty
         #
         #   @param settings [Sentdm::Models::ProfileSettings, nil] Profile settings (only for profile type)
         #
+        #   @param short_name [String, nil] Short name / abbreviation (only for profile type)
+        #
         #   @param status [String, nil] Profile status (only for profile type): incomplete, pending_review, approved, et
+        #
+        #   @param type [String] Account type: "organization" (has profiles), "user" (no profiles), or "profile"
+
+        # @see Sentdm::Models::MeRetrieveResponse::Data#channels
+        class Channels < Sentdm::Internal::Type::BaseModel
+          # @!attribute rcs
+          #   RCS channel (provider: vibes)
+          #
+          #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs, nil]
+          optional :rcs, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs }
+
+          # @!attribute sms
+          #   SMS channel (providers: telnyx, sinch)
+          #
+          #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS, nil]
+          optional :sms, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS }
+
+          # @!attribute whatsapp
+          #   WhatsApp Business channel (provider: meta)
+          #
+          #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp, nil]
+          optional :whatsapp, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp }
+
+          # @!method initialize(rcs: nil, sms: nil, whatsapp: nil)
+          #   Messaging channel configuration
+          #
+          #   @param rcs [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs] RCS channel (provider: vibes)
+          #
+          #   @param sms [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS] SMS channel (providers: telnyx, sinch)
+          #
+          #   @param whatsapp [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp] WhatsApp Business channel (provider: meta)
+
+          # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#rcs
+          class Rcs < Sentdm::Internal::Type::BaseModel
+            # @!attribute configured
+            #   Whether RCS is configured for this account
+            #
+            #   @return [Boolean, nil]
+            optional :configured, Sentdm::Internal::Type::Boolean
+
+            # @!attribute phone_number
+            #   RCS-enabled phone number in E.164 format
+            #
+            #   @return [String, nil]
+            optional :phone_number, String, nil?: true
+
+            # @!method initialize(configured: nil, phone_number: nil)
+            #   RCS channel (provider: vibes)
+            #
+            #   @param configured [Boolean] Whether RCS is configured for this account
+            #
+            #   @param phone_number [String, nil] RCS-enabled phone number in E.164 format
+          end
+
+          # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#sms
+          class SMS < Sentdm::Internal::Type::BaseModel
+            # @!attribute configured
+            #   Whether SMS is configured for this account
+            #
+            #   @return [Boolean, nil]
+            optional :configured, Sentdm::Internal::Type::Boolean
+
+            # @!attribute phone_number
+            #   Sending phone number in E.164 format
+            #
+            #   @return [String, nil]
+            optional :phone_number, String, nil?: true
+
+            # @!method initialize(configured: nil, phone_number: nil)
+            #   SMS channel (providers: telnyx, sinch)
+            #
+            #   @param configured [Boolean] Whether SMS is configured for this account
+            #
+            #   @param phone_number [String, nil] Sending phone number in E.164 format
+          end
+
+          # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#whatsapp
+          class Whatsapp < Sentdm::Internal::Type::BaseModel
+            # @!attribute business_name
+            #   WhatsApp Business display name
+            #
+            #   @return [String, nil]
+            optional :business_name, String, nil?: true
+
+            # @!attribute configured
+            #   Whether WhatsApp is configured for this account
+            #
+            #   @return [Boolean, nil]
+            optional :configured, Sentdm::Internal::Type::Boolean
+
+            # @!attribute phone_number
+            #   WhatsApp phone number in E.164 format
+            #
+            #   @return [String, nil]
+            optional :phone_number, String, nil?: true
+
+            # @!method initialize(business_name: nil, configured: nil, phone_number: nil)
+            #   WhatsApp Business channel (provider: meta)
+            #
+            #   @param business_name [String, nil] WhatsApp Business display name
+            #
+            #   @param configured [Boolean] Whether WhatsApp is configured for this account
+            #
+            #   @param phone_number [String, nil] WhatsApp phone number in E.164 format
+          end
+        end
 
         class Profile < Sentdm::Internal::Type::BaseModel
           # @!attribute id

data/lib/sentdm/models/message_retrieve_activities_params.rb

@@ -12,8 +12,14 @@ module Sentdm
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(id:, x_profile_id: nil, request_options: {})
       #   @param id [String]
+      #   @param x_profile_id [String]
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/sentdm/models/message_retrieve_activities_response.rb

@@ -62,11 +62,12 @@ module Sentdm
         #   @param message_id [String] The message ID these activities belong to
 
         class Activity < Sentdm::Internal::Type::BaseModel
-          # @!attribute content
-          #   Additional content or payload for the activity (e.g., channel response)
+          # @!attribute active_contact_price
+          #   Active contact markup applied on top of the channel cost, formatted to 4 decimal
+          #   places.
           #
           #   @return [String, nil]
-          optional :content, String, nil?: true
+          optional :active_contact_price, String, nil?: true
 
           # @!attribute description
           #   Human-readable description of the activity
@@ -74,6 +75,13 @@ module Sentdm
           #   @return [String, nil]
           optional :description, String
 
+          # @!attribute price
+          #   Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
+          #   4 decimal places.
+          #
+          #   @return [String, nil]
+          optional :price, String, nil?: true
+
           # @!attribute status
           #   Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
           #
@@ -86,13 +94,19 @@ module Sentdm
           #   @return [Time, nil]
           optional :timestamp, Time
 
-          # @!method initialize(content: nil, description: nil, status: nil, timestamp: nil)
+          # @!method initialize(active_contact_price: nil, description: nil, price: nil, status: nil, timestamp: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity} for more
+          #   details.
+          #
           #   A single message activity event for v3 API
           #
-          #   @param content [String, nil] Additional content or payload for the activity (e.g., channel response)
+          #   @param active_contact_price [String, nil] Active contact markup applied on top of the channel cost, formatted to 4 decimal
           #
           #   @param description [String] Human-readable description of the activity
           #
+          #   @param price [String, nil] Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
+          #
           #   @param status [String] Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
           #
           #   @param timestamp [Time] When this activity occurred

data/lib/sentdm/models/message_retrieve_status_params.rb

@@ -12,8 +12,14 @@ module Sentdm
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(id:, x_profile_id: nil, request_options: {})
       #   @param id [String]
+      #   @param x_profile_id [String]
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/sentdm/models/message_retrieve_status_response.rb

@@ -46,6 +46,11 @@ module Sentdm
         #   @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]
@@ -122,7 +127,7 @@ module Sentdm
         #   @return [String, nil]
         optional :template_name, String
 
-        # @!method initialize(id: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: 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)
+        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: 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::MessageRetrieveStatusResponse::Data} for more details.
         #
@@ -130,6 +135,8 @@ module Sentdm
         #
         #   @param id [String]
         #
+        #   @param active_contact_price [Float, nil]
+        #
         #   @param channel [String]
         #
         #   @param contact_id [String]

data/lib/sentdm/models/message_send_params.rb

@@ -15,19 +15,19 @@ module Sentdm
       #   @return [Array<String>, nil]
       optional :channel, Sentdm::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!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 template
       #   Template reference (by id or name, with optional parameters)
       #
       #   @return [Sentdm::Models::MessageSendParams::Template, nil]
       optional :template, -> { Sentdm::MessageSendParams::Template }
 
-      # @!attribute test_mode
-      #   Test mode flag - when true, the operation is simulated without side effects
-      #   Useful for testing integrations without actual execution
-      #
-      #   @return [Boolean, nil]
-      optional :test_mode, Sentdm::Internal::Type::Boolean
-
       # @!attribute to
       #   List of recipient phone numbers in E.164 format (multi-recipient fan-out)
       #
@@ -39,20 +39,27 @@ module Sentdm
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!method initialize(channel: nil, template: nil, test_mode: nil, to: nil, idempotency_key: nil, request_options: {})
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(channel: nil, sandbox: nil, template: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::MessageSendParams} for more details.
       #
       #   @param channel [Array<String>, nil] Channels to broadcast on, e.g. ["whatsapp", "sms"].
       #
-      #   @param template [Sentdm::Models::MessageSendParams::Template] Template reference (by id or name, with optional parameters)
+      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
-      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #   @param template [Sentdm::Models::MessageSendParams::Template] Template reference (by id or name, with optional parameters)
       #
       #   @param to [Array<String>] List of recipient phone numbers in E.164 format (multi-recipient fan-out)
       #
       #   @param idempotency_key [String]
       #
+      #   @param x_profile_id [String]
+      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
 
       class Template < Sentdm::Internal::Type::BaseModel

data/lib/sentdm/models/mutation_request.rb

@@ -3,18 +3,18 @@
 module Sentdm
   module Models
     class MutationRequest < Sentdm::Internal::Type::BaseModel
-      # @!attribute test_mode
-      #   Test mode flag - when true, the operation is simulated without side effects
-      #   Useful for testing integrations without actual execution
+      # @!attribute sandbox
+      #   Sandbox flag - when true, the operation is simulated without side effects Useful
+      #   for testing integrations without actual execution
       #
       #   @return [Boolean, nil]
-      optional :test_mode, Sentdm::Internal::Type::Boolean
+      optional :sandbox, Sentdm::Internal::Type::Boolean
 
-      # @!method initialize(test_mode: nil)
+      # @!method initialize(sandbox: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::MutationRequest} for more details.
       #
-      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
     end
   end
 end

data/lib/sentdm/models/profile_complete_params.rb

@@ -18,19 +18,24 @@ module Sentdm
       #   @return [String]
       required :web_hook_url, String, api_name: :webHookUrl
 
-      # @!attribute test_mode
-      #   Test mode flag - when true, the operation is simulated without side effects
-      #   Useful for testing integrations without actual execution
+      # @!attribute sandbox
+      #   Sandbox flag - when true, the operation is simulated without side effects Useful
+      #   for testing integrations without actual execution
       #
       #   @return [Boolean, nil]
-      optional :test_mode, Sentdm::Internal::Type::Boolean
+      optional :sandbox, Sentdm::Internal::Type::Boolean
 
       # @!attribute idempotency_key
       #
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!method initialize(profile_id:, web_hook_url:, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(profile_id:, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::ProfileCompleteParams} for more details.
       #
@@ -38,10 +43,12 @@ module Sentdm
       #
       #   @param web_hook_url [String] Webhook URL to call when profile completion finishes (success or failure)
       #
-      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
       #   @param idempotency_key [String]
       #
+      #   @param x_profile_id [String]
+      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end