sentdm 0.2.0 → 0.3.0

data/lib/sentdm/models/message_retrieve_status_response.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#retrieve_status
+    class MessageRetrieveStatusResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::MessageRetrieveStatusResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::MessageRetrieveStatusResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::MessageRetrieveStatusResponse::Data, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::MessageRetrieveStatusResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!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 events
+        #
+        #   @return [Array<Sentdm::Models::MessageRetrieveStatusResponse::Data::Event>, nil]
+        optional :events,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageRetrieveStatusResponse::Data::Event] },
+                 nil?: true
+
+        # @!attribute message_body
+        #   Structured message body format for database storage. Preserves channel-specific
+        #   components (header, body, footer, buttons).
+        #
+        #   @return [Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody, nil]
+        optional :message_body,
+                 -> { Sentdm::Models::MessageRetrieveStatusResponse::Data::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
+
+        # @!attribute template_id
+        #
+        #   @return [String, nil]
+        optional :template_id, String, nil?: true
+
+        # @!attribute template_name
+        #
+        #   @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)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::MessageRetrieveStatusResponse::Data} for more details.
+        #
+        #   The response data (null if error)
+        #
+        #   @param id [String]
+        #
+        #   @param channel [String]
+        #
+        #   @param contact_id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param events [Array<Sentdm::Models::MessageRetrieveStatusResponse::Data::Event>, nil]
+        #
+        #   @param message_body [Sentdm::Models::MessageRetrieveStatusResponse::Data::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]
+        #
+        #   @param template_id [String, nil]
+        #
+        #   @param template_name [String]
+
+        class Event < Sentdm::Internal::Type::BaseModel
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute status
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!attribute timestamp
+          #
+          #   @return [Time, nil]
+          optional :timestamp, Time
+
+          # @!method initialize(description: nil, status: nil, timestamp: nil)
+          #   Represents a status change event in a message's lifecycle (v3)
+          #
+          #   @param description [String, nil]
+          #   @param status [String]
+          #   @param timestamp [Time]
+        end
+
+        # @see Sentdm::Models::MessageRetrieveStatusResponse::Data#message_body
+        class MessageBody < Sentdm::Internal::Type::BaseModel
+          # @!attribute buttons
+          #
+          #   @return [Array<Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::Button>, nil]
+          optional :buttons,
+                   -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageRetrieveStatusResponse::Data::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::MessageRetrieveStatusResponse::Data::MessageBody::Button>, nil]
+          #   @param content [String]
+          #   @param footer [String, nil]
+          #   @param header [String, nil]
+
+          class Button < Sentdm::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [String, nil]
+            optional :type, String
+
+            # @!attribute value
+            #
+            #   @return [String, nil]
+            optional :value, String
+
+            # @!method initialize(type: nil, value: nil)
+            #   @param type [String]
+            #   @param value [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/message_send_params.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#send_
+    class MessageSendParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute channel
+      #   Channels to broadcast on, e.g. ["whatsapp", "sms"]. Each channel produces a
+      #   separate message per recipient. "sent" = auto-detect, "rcs" = reserved
+      #   (skipped). Defaults to ["sent"] (auto-detect) if omitted.
+      #
+      #   @return [Array<String>, nil]
+      optional :channel, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!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)
+      #
+      #   @return [Array<String>, nil]
+      optional :to, Sentdm::Internal::Type::ArrayOf[String]
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(channel: nil, template: nil, test_mode: nil, to: nil, idempotency_key: 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 test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #
+      #   @param to [Array<String>] List of recipient phone numbers in E.164 format (multi-recipient fan-out)
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+      class Template < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #   Template ID (mutually exclusive with name)
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute name
+        #   Template name (mutually exclusive with id)
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute parameters
+        #   Template variable parameters for personalization
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :parameters, Sentdm::Internal::Type::HashOf[String], nil?: true
+
+        # @!method initialize(id: nil, name: nil, parameters: nil)
+        #   Template reference (by id or name, with optional parameters)
+        #
+        #   @param id [String, nil] Template ID (mutually exclusive with name)
+        #
+        #   @param name [String, nil] Template name (mutually exclusive with id)
+        #
+        #   @param parameters [Hash{Symbol=>String}, nil] Template variable parameters for personalization
+      end
+    end
+  end
+end

data/lib/sentdm/models/message_send_response.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#send_
+    class MessageSendResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::MessageSendResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::MessageSendResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::MessageSendResponse::Data, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::MessageSendResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute body
+        #   Resolved template body text
+        #
+        #   @return [String, nil]
+        optional :body, String, nil?: true
+
+        # @!attribute recipients
+        #   Per-recipient message results
+        #
+        #   @return [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>, nil]
+        optional :recipients,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageSendResponse::Data::Recipient] }
+
+        # @!attribute status
+        #   Overall request status (e.g. "accepted")
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute template_id
+        #   Template ID that was used
+        #
+        #   @return [String, nil]
+        optional :template_id, String
+
+        # @!attribute template_name
+        #   Template display name
+        #
+        #   @return [String, nil]
+        optional :template_name, String
+
+        # @!method initialize(body: nil, recipients: nil, status: nil, template_id: nil, template_name: nil)
+        #   The response data (null if error)
+        #
+        #   @param body [String, nil] Resolved template body text
+        #
+        #   @param recipients [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>] Per-recipient message results
+        #
+        #   @param status [String] Overall request status (e.g. "accepted")
+        #
+        #   @param template_id [String] Template ID that was used
+        #
+        #   @param template_name [String] Template display name
+
+        class Recipient < Sentdm::Internal::Type::BaseModel
+          # @!attribute channel
+          #   Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for
+          #   auto-detect
+          #
+          #   @return [String, nil]
+          optional :channel, String, nil?: true
+
+          # @!attribute message_id
+          #   Unique message identifier for tracking this recipient's message
+          #
+          #   @return [String, nil]
+          optional :message_id, String
+
+          # @!attribute to
+          #   Phone number in E.164 format
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!method initialize(channel: nil, message_id: nil, to: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::MessageSendResponse::Data::Recipient} for more details.
+          #
+          #   Per-recipient result in the send message response
+          #
+          #   @param channel [String, nil] Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for auto-
+          #
+          #   @param message_id [String] Unique message identifier for tracking this recipient's message
+          #
+          #   @param to [String] Phone number in E.164 format
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/mutation_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(test_mode: 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
+    end
+  end
+end

data/lib/sentdm/models/pagination_meta.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class PaginationMeta < Sentdm::Internal::Type::BaseModel
+      # @!attribute cursors
+      #   Cursor-based pagination (optional)
+      #
+      #   @return [Sentdm::Models::PaginationMeta::Cursors, nil]
+      optional :cursors, -> { Sentdm::PaginationMeta::Cursors }, nil?: true
+
+      # @!attribute has_more
+      #   Whether there are more pages after this one
+      #
+      #   @return [Boolean, nil]
+      optional :has_more, Sentdm::Internal::Type::Boolean
+
+      # @!attribute page
+      #   Current page number (1-indexed)
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute page_size
+      #   Number of items per page
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute total_count
+      #   Total number of items across all pages
+      #
+      #   @return [Integer, nil]
+      optional :total_count, Integer
+
+      # @!attribute total_pages
+      #   Total number of pages
+      #
+      #   @return [Integer, nil]
+      optional :total_pages, Integer
+
+      # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
+      #   Pagination metadata for list responses
+      #
+      #   @param cursors [Sentdm::Models::PaginationMeta::Cursors, nil] Cursor-based pagination (optional)
+      #
+      #   @param has_more [Boolean] Whether there are more pages after this one
+      #
+      #   @param page [Integer] Current page number (1-indexed)
+      #
+      #   @param page_size [Integer] Number of items per page
+      #
+      #   @param total_count [Integer] Total number of items across all pages
+      #
+      #   @param total_pages [Integer] Total number of pages
+
+      # @see Sentdm::Models::PaginationMeta#cursors
+      class Cursors < Sentdm::Internal::Type::BaseModel
+        # @!attribute after
+        #   Cursor to fetch the next page
+        #
+        #   @return [String, nil]
+        optional :after, String, nil?: true
+
+        # @!attribute before
+        #   Cursor to fetch the previous page
+        #
+        #   @return [String, nil]
+        optional :before, String, nil?: true
+
+        # @!method initialize(after: nil, before: nil)
+        #   Cursor-based pagination (optional)
+        #
+        #   @param after [String, nil] Cursor to fetch the next page
+        #
+        #   @param before [String, nil] Cursor to fetch the previous page
+      end
+    end
+  end
+end

data/lib/sentdm/models/profile_complete_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Profiles#complete
+    class ProfileCompleteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute web_hook_url
+      #   Webhook URL to call when profile completion finishes (success or failure)
+      #
+      #   @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
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(web_hook_url:, test_mode: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ProfileCompleteParams} for more details.
+      #
+      #   @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 idempotency_key [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/profile_complete_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @type [Sentdm::Internal::Type::Converter]
+    ProfileCompleteResponse = Sentdm::Internal::Type::Unknown
+  end
+end