sentdm 0.29.0 → 0.30.0

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

data/lib/sentdm/models/error_detail.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ErrorDetail < Sentdm::Internal::Type::BaseModel
+      # @!attribute code
+      #   Machine-readable error code (e.g., "RESOURCE_001")
+      #
+      #   @return [String, nil]
+      optional :code, String
+
+      # @!attribute details
+      #   Additional validation error details (field-level errors)
+      #
+      #   @return [Hash{Symbol=>Array<String>}, nil]
+      optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
+
+      # @!attribute doc_url
+      #   URL to documentation about this error
+      #
+      #   @return [String, nil]
+      optional :doc_url, String, nil?: true
+
+      # @!attribute message
+      #   Human-readable error message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
+      #   Error information
+      #
+      #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
+      #
+      #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
+      #
+      #   @param doc_url [String, nil] URL to documentation about this error
+      #
+      #   @param message [String] Human-readable error message
+    end
+  end
+end

data/lib/sentdm/models/me_retrieve_response.rb

@@ -15,14 +15,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::MeRetrieveResponse::Error, nil]
-      optional :error, -> { Sentdm::Models::MeRetrieveResponse::Error }, nil?: true
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::MeRetrieveResponse::Meta, nil]
-      optional :meta, -> { Sentdm::Models::MeRetrieveResponse::Meta }
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -38,9 +38,9 @@ module Sentdm
       #
       #   @param data [Sentdm::Models::MeRetrieveResponse::Data, nil] Account response for GET /v3/me endpoint.
       #
-      #   @param error [Sentdm::Models::MeRetrieveResponse::Error, nil] Error information
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
       #
-      #   @param meta [Sentdm::Models::MeRetrieveResponse::Meta] Request and response metadata
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -132,8 +132,8 @@ module Sentdm
         # @!attribute settings
         #   Profile configuration settings
         #
-        #   @return [Sentdm::Models::MeRetrieveResponse::Data::Settings, nil]
-        optional :settings, -> { Sentdm::Models::MeRetrieveResponse::Data::Settings }, nil?: true
+        #   @return [Sentdm::Models::ProfileSettings, nil]
+        optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
 
         # @!attribute short_name
         #   Short name / abbreviation (only for profile type)
@@ -185,7 +185,7 @@ module Sentdm
         #
         #   @param sending_phone_number_profile_id [String, nil] The account that holds sending_phone_number in number inventory: normally this a
         #
-        #   @param settings [Sentdm::Models::MeRetrieveResponse::Data::Settings, nil] Profile configuration settings
+        #   @param settings [Sentdm::Models::ProfileSettings, nil] Profile configuration settings
         #
         #   @param short_name [String, nil] Short name / abbreviation (only for profile type)
         #
@@ -344,8 +344,8 @@ module Sentdm
           # @!attribute settings
           #   Profile configuration settings
           #
-          #   @return [Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings, nil]
-          optional :settings, -> { Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings }
+          #   @return [Sentdm::Models::ProfileSettings, nil]
+          optional :settings, -> { Sentdm::ProfileSettings }
 
           # @!attribute short_name
           #   Profile short name (abbreviation)
@@ -377,242 +377,12 @@ module Sentdm
           #
           #   @param role [String, nil] User's role in this profile: admin, billing, developer (inherited from organizat
           #
-          #   @param settings [Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings] Profile configuration settings
+          #   @param settings [Sentdm::Models::ProfileSettings] Profile configuration settings
           #
           #   @param short_name [String, nil] Profile short name (abbreviation)
           #
           #   @param status [String, nil] Profile setup status: incomplete, pending_review, approved, rejected
-
-          # @see Sentdm::Models::MeRetrieveResponse::Data::Profile#settings
-          class Settings < Sentdm::Internal::Type::BaseModel
-            # @!attribute allow_contact_sharing
-            #   @deprecated
-            #
-            #   Always false. A profile no longer shares contacts with sibling profiles — it
-            #   sees only what it owns. Retained so existing v3 clients reading
-            #   allow_contact_sharing keep deserializing; it carries no information.
-            #
-            #   @return [Boolean, nil]
-            optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean, nil?: true
-
-            # @!attribute allow_template_sharing
-            #   @deprecated
-            #
-            #   Always false. A profile no longer shares templates with sibling profiles.
-            #   Retained so existing v3 clients reading allow_template_sharing keep
-            #   deserializing; it carries no information.
-            #
-            #   @return [Boolean, nil]
-            optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
-
-            # @!attribute billing_model
-            #   Billing model: profile, organization, or profile_and_organization
-            #
-            #   @return [String, nil]
-            optional :billing_model, String, nil?: true
-
-            # @!attribute inherit_contacts
-            #   @deprecated
-            #
-            #   Always false. A profile no longer inherits its organization's contacts. Retained
-            #   so existing v3 clients reading inherit_contacts keep deserializing; it carries
-            #   no information.
-            #
-            #   @return [Boolean, nil]
-            optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
-
-            # @!attribute inherit_tcr_brand
-            #   Whether this profile inherits TCR brand from the organization
-            #
-            #   @return [Boolean, nil]
-            optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
-
-            # @!attribute inherit_tcr_campaign
-            #   Whether this profile inherits TCR campaign from the organization
-            #
-            #   @return [Boolean, nil]
-            optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
-
-            # @!attribute inherit_templates
-            #   @deprecated
-            #
-            #   Always false. A profile no longer inherits its organization's templates.
-            #   Retained so existing v3 clients reading inherit_templates keep deserializing; it
-            #   carries no information.
-            #
-            #   @return [Boolean, nil]
-            optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
-
-            # @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings} for more details.
-            #
-            #   Profile configuration settings
-            #
-            #   @param allow_contact_sharing [Boolean, nil] Always false. A profile no longer shares contacts with sibling profiles — it see
-            #
-            #   @param allow_template_sharing [Boolean, nil] Always false. A profile no longer shares templates with sibling profiles. Retain
-            #
-            #   @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization
-            #
-            #   @param inherit_contacts [Boolean, nil] Always false. A profile no longer inherits its organization's contacts. Retained
-            #
-            #   @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from the organization
-            #
-            #   @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from the organization
-            #
-            #   @param inherit_templates [Boolean, nil] Always false. A profile no longer inherits its organization's templates. Retaine
-          end
         end
-
-        # @see Sentdm::Models::MeRetrieveResponse::Data#settings
-        class Settings < Sentdm::Internal::Type::BaseModel
-          # @!attribute allow_contact_sharing
-          #   @deprecated
-          #
-          #   Always false. A profile no longer shares contacts with sibling profiles — it
-          #   sees only what it owns. Retained so existing v3 clients reading
-          #   allow_contact_sharing keep deserializing; it carries no information.
-          #
-          #   @return [Boolean, nil]
-          optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean, nil?: true
-
-          # @!attribute allow_template_sharing
-          #   @deprecated
-          #
-          #   Always false. A profile no longer shares templates with sibling profiles.
-          #   Retained so existing v3 clients reading allow_template_sharing keep
-          #   deserializing; it carries no information.
-          #
-          #   @return [Boolean, nil]
-          optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
-
-          # @!attribute billing_model
-          #   Billing model: profile, organization, or profile_and_organization
-          #
-          #   @return [String, nil]
-          optional :billing_model, String, nil?: true
-
-          # @!attribute inherit_contacts
-          #   @deprecated
-          #
-          #   Always false. A profile no longer inherits its organization's contacts. Retained
-          #   so existing v3 clients reading inherit_contacts keep deserializing; it carries
-          #   no information.
-          #
-          #   @return [Boolean, nil]
-          optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
-
-          # @!attribute inherit_tcr_brand
-          #   Whether this profile inherits TCR brand from the organization
-          #
-          #   @return [Boolean, nil]
-          optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
-
-          # @!attribute inherit_tcr_campaign
-          #   Whether this profile inherits TCR campaign from the organization
-          #
-          #   @return [Boolean, nil]
-          optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
-
-          # @!attribute inherit_templates
-          #   @deprecated
-          #
-          #   Always false. A profile no longer inherits its organization's templates.
-          #   Retained so existing v3 clients reading inherit_templates keep deserializing; it
-          #   carries no information.
-          #
-          #   @return [Boolean, nil]
-          optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
-
-          # @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::MeRetrieveResponse::Data::Settings} for more details.
-          #
-          #   Profile configuration settings
-          #
-          #   @param allow_contact_sharing [Boolean, nil] Always false. A profile no longer shares contacts with sibling profiles — it see
-          #
-          #   @param allow_template_sharing [Boolean, nil] Always false. A profile no longer shares templates with sibling profiles. Retain
-          #
-          #   @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization
-          #
-          #   @param inherit_contacts [Boolean, nil] Always false. A profile no longer inherits its organization's contacts. Retained
-          #
-          #   @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from the organization
-          #
-          #   @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from the organization
-          #
-          #   @param inherit_templates [Boolean, nil] Always false. A profile no longer inherits its organization's templates. Retaine
-        end
-      end
-
-      # @see Sentdm::Models::MeRetrieveResponse#error
-      class Error < Sentdm::Internal::Type::BaseModel
-        # @!attribute code
-        #   Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @return [String, nil]
-        optional :code, String
-
-        # @!attribute details
-        #   Additional validation error details (field-level errors)
-        #
-        #   @return [Hash{Symbol=>Array<String>}, nil]
-        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
-
-        # @!attribute doc_url
-        #   URL to documentation about this error
-        #
-        #   @return [String, nil]
-        optional :doc_url, String, nil?: true
-
-        # @!attribute message
-        #   Human-readable error message
-        #
-        #   @return [String, nil]
-        optional :message, String
-
-        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
-        #   Error information
-        #
-        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
-        #
-        #   @param doc_url [String, nil] URL to documentation about this error
-        #
-        #   @param message [String] Human-readable error message
-      end
-
-      # @see Sentdm::Models::MeRetrieveResponse#meta
-      class Meta < Sentdm::Internal::Type::BaseModel
-        # @!attribute request_id
-        #   Unique identifier for this request (for tracing and support)
-        #
-        #   @return [String, nil]
-        optional :request_id, String
-
-        # @!attribute timestamp
-        #   Server timestamp when the response was generated
-        #
-        #   @return [Time, nil]
-        optional :timestamp, Time
-
-        # @!attribute version
-        #   API version used for this request
-        #
-        #   @return [String, nil]
-        optional :version, String
-
-        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
-        #   Request and response metadata
-        #
-        #   @param request_id [String] Unique identifier for this request (for tracing and support)
-        #
-        #   @param timestamp [Time] Server timestamp when the response was generated
-        #
-        #   @param version [String] API version used for this request
       end
     end
   end