sentdm 0.2.0 → 0.3.1

data/lib/sentdm/models/message_retrieve_response.rb

@@ -1,227 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Messages#retrieve
-    class MessageRetrieveResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute id
-      #   The unique identifier of the message
-      #
-      #   @return [String, nil]
-      optional :id, String
-
-      # @!attribute channel
-      #   The messaging channel used (e.g., SMS, WhatsApp)
-      #
-      #   @return [String, nil]
-      optional :channel, String
-
-      # @!attribute contact_id
-      #   The unique identifier of the contact who received the message
-      #
-      #   @return [String, nil]
-      optional :contact_id, String, api_name: :contactId
-
-      # @!attribute corrected_price
-      #   The final price charged for sending this message
-      #
-      #   @return [Float, nil]
-      optional :corrected_price, Float, api_name: :correctedPrice, nil?: true
-
-      # @!attribute created_at
-      #   The date and time when the message was created
-      #
-      #   @return [Time, nil]
-      optional :created_at, Time, api_name: :createdAt
-
-      # @!attribute customer_id
-      #   The unique identifier of the customer who sent the message
-      #
-      #   @return [String, nil]
-      optional :customer_id, String, api_name: :customerId
-
-      # @!attribute events
-      #   A chronological list of status change events for this message. Each event
-      #   includes a status and timestamp, following industry standards (Twilio, SendGrid,
-      #   Mailgun). Events are ordered chronologically from oldest to newest.
-      #
-      #   @return [Array<Sentdm::Models::MessageRetrieveResponse::Event>, nil]
-      optional :events,
-               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageRetrieveResponse::Event] },
-               nil?: true
-
-      # @!attribute message_body
-      #   The message body content with variables substituted
-      #
-      #   @return [Sentdm::Models::MessageRetrieveResponse::MessageBody, nil]
-      optional :message_body,
-               -> { Sentdm::Models::MessageRetrieveResponse::MessageBody },
-               api_name: :messageBody,
-               nil?: true
-
-      # @!attribute phone_number
-      #   The phone number of the recipient (E.164 format)
-      #
-      #   @return [String, nil]
-      optional :phone_number, String, api_name: :phoneNumber
-
-      # @!attribute phone_number_international
-      #   The phone number in international format
-      #
-      #   @return [String, nil]
-      optional :phone_number_international, String, api_name: :phoneNumberInternational
-
-      # @!attribute region_code
-      #   The region code of the phone number (e.g., US, GB, DE)
-      #
-      #   @return [String, nil]
-      optional :region_code, String, api_name: :regionCode
-
-      # @!attribute status
-      #   The delivery status of the message (e.g., sent, delivered, failed, read)
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!attribute template_category
-      #   The category of the template (e.g., MARKETING, UTILITY, AUTHENTICATION)
-      #
-      #   @return [String, nil]
-      optional :template_category, String, api_name: :templateCategory
-
-      # @!attribute template_id
-      #   The unique identifier of the template used for this message (null if no template
-      #   was used)
-      #
-      #   @return [String, nil]
-      optional :template_id, String, api_name: :templateId, nil?: true
-
-      # @!attribute template_name
-      #   The display name of the template
-      #
-      #   @return [String, nil]
-      optional :template_name, String, api_name: :templateName
-
-      # @!method initialize(id: nil, channel: nil, contact_id: nil, corrected_price: nil, created_at: nil, customer_id: nil, events: nil, message_body: nil, phone_number: nil, phone_number_international: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::MessageRetrieveResponse} for more details.
-      #
-      #   Represents a sent message with comprehensive delivery and template information
-      #   (v2)
-      #
-      #   @param id [String] The unique identifier of the message
-      #
-      #   @param channel [String] The messaging channel used (e.g., SMS, WhatsApp)
-      #
-      #   @param contact_id [String] The unique identifier of the contact who received the message
-      #
-      #   @param corrected_price [Float, nil] The final price charged for sending this message
-      #
-      #   @param created_at [Time] The date and time when the message was created
-      #
-      #   @param customer_id [String] The unique identifier of the customer who sent the message
-      #
-      #   @param events [Array<Sentdm::Models::MessageRetrieveResponse::Event>, nil] A chronological list of status change events for this message.
-      #
-      #   @param message_body [Sentdm::Models::MessageRetrieveResponse::MessageBody, nil] The message body content with variables substituted
-      #
-      #   @param phone_number [String] The phone number of the recipient (E.164 format)
-      #
-      #   @param phone_number_international [String] The phone number in international format
-      #
-      #   @param region_code [String] The region code of the phone number (e.g., US, GB, DE)
-      #
-      #   @param status [String] The delivery status of the message (e.g., sent, delivered, failed, read)
-      #
-      #   @param template_category [String] The category of the template (e.g., MARKETING, UTILITY, AUTHENTICATION)
-      #
-      #   @param template_id [String, nil] The unique identifier of the template used for this message (null if no template
-      #
-      #   @param template_name [String] The display name of the template
-
-      class Event < Sentdm::Internal::Type::BaseModel
-        # @!attribute description
-        #   Optional human-readable description of the event Useful for error messages or
-        #   additional context
-        #
-        #   @return [String, nil]
-        optional :description, String, nil?: true
-
-        # @!attribute status
-        #   The status of the message at this point in time Examples: "queued", "sent",
-        #   "delivered", "read", "failed"
-        #
-        #   @return [String, nil]
-        optional :status, String
-
-        # @!attribute timestamp
-        #   When this status change occurred (ISO 8601 format)
-        #
-        #   @return [Time, nil]
-        optional :timestamp, Time
-
-        # @!method initialize(description: nil, status: nil, timestamp: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::MessageRetrieveResponse::Event} for more details.
-        #
-        #   Represents a status change event in a message's lifecycle Follows industry
-        #   standards (Twilio, SendGrid, Mailgun pattern)
-        #
-        #   @param description [String, nil] Optional human-readable description of the event
-        #
-        #   @param status [String] The status of the message at this point in time
-        #
-        #   @param timestamp [Time] When this status change occurred (ISO 8601 format)
-      end
-
-      # @see Sentdm::Models::MessageRetrieveResponse#message_body
-      class MessageBody < Sentdm::Internal::Type::BaseModel
-        # @!attribute buttons
-        #
-        #   @return [Array<Sentdm::Models::MessageRetrieveResponse::MessageBody::Button>, nil]
-        optional :buttons,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageRetrieveResponse::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)
-        #   The message body content with variables substituted
-        #
-        #   @param buttons [Array<Sentdm::Models::MessageRetrieveResponse::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

data/lib/sentdm/models/message_send_quick_message_params.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Messages#send_quick_message
-    class MessageSendQuickMessageParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      # @!attribute custom_message
-      #   The custom message content to include in the template
-      #
-      #   @return [String]
-      required :custom_message, String, api_name: :customMessage
-
-      # @!attribute phone_number
-      #   The phone number to send the message to, in international format (e.g.,
-      #   +1234567890)
-      #
-      #   @return [String]
-      required :phone_number, String, api_name: :phoneNumber
-
-      # @!method initialize(custom_message:, phone_number:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::MessageSendQuickMessageParams} for more details.
-      #
-      #   @param custom_message [String] The custom message content to include in the template
-      #
-      #   @param phone_number [String] The phone number to send the message to, in international format (e.g., +1234567
-      #
-      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/sentdm/models/message_send_to_contact_params.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Messages#send_to_contact
-    class MessageSendToContactParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      # @!attribute contact_id
-      #   The unique identifier of the contact to send the message to
-      #
-      #   @return [String]
-      required :contact_id, String, api_name: :contactId
-
-      # @!attribute template_id
-      #   The unique identifier of the template to use for the message
-      #
-      #   @return [String]
-      required :template_id, String, api_name: :templateId
-
-      # @!attribute template_variables
-      #   Optional key-value pairs of template variables to replace in the template body.
-      #   For example, if your template contains "Hello {{name}}", you would provide {
-      #   "name": "John Doe" }
-      #
-      #   @return [Hash{Symbol=>String}, nil]
-      optional :template_variables,
-               Sentdm::Internal::Type::HashOf[String],
-               api_name: :templateVariables,
-               nil?: true
-
-      # @!method initialize(contact_id:, template_id:, template_variables: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::MessageSendToContactParams} for more details.
-      #
-      #   @param contact_id [String] The unique identifier of the contact to send the message to
-      #
-      #   @param template_id [String] The unique identifier of the template to use for the message
-      #
-      #   @param template_variables [Hash{Symbol=>String}, nil] Optional key-value pairs of template variables to replace in the template body.
-      #
-      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/sentdm/models/message_send_to_phone_params.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Messages#send_to_phone
-    class MessageSendToPhoneParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      # @!attribute phone_number
-      #   The phone number to send the message to, in international format (e.g.,
-      #   +1234567890)
-      #
-      #   @return [String]
-      required :phone_number, String, api_name: :phoneNumber
-
-      # @!attribute template_id
-      #   The unique identifier of the template to use for the message
-      #
-      #   @return [String]
-      required :template_id, String, api_name: :templateId
-
-      # @!attribute template_variables
-      #   Optional key-value pairs of template variables to replace in the template body.
-      #   For example, if your template contains "Hello {{name}}", you would provide {
-      #   "name": "John Doe" }
-      #
-      #   @return [Hash{Symbol=>String}, nil]
-      optional :template_variables,
-               Sentdm::Internal::Type::HashOf[String],
-               api_name: :templateVariables,
-               nil?: true
-
-      # @!method initialize(phone_number:, template_id:, template_variables: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::MessageSendToPhoneParams} for more details.
-      #
-      #   @param phone_number [String] The phone number to send the message to, in international format (e.g., +1234567
-      #
-      #   @param template_id [String] The unique identifier of the template to use for the message
-      #
-      #   @param template_variables [Hash{Symbol=>String}, nil] Optional key-value pairs of template variables to replace in the template body.
-      #
-      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/sentdm/models/number_lookup_retrieve_response.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::NumberLookup#retrieve
-    class NumberLookupRetrieveResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute country_code
-      #   The country calling code (e.g., 1 for US/Canada)
-      #
-      #   @return [String, nil]
-      optional :country_code, String, api_name: :countryCode
-
-      # @!attribute format_e164
-      #   The phone number formatted in E.164 standard (e.g., +1234567890)
-      #
-      #   @return [String, nil]
-      optional :format_e164, String, api_name: :formatE164
-
-      # @!attribute format_international
-      #   The phone number formatted for international dialing (e.g., +1 234-567-890)
-      #
-      #   @return [String, nil]
-      optional :format_international, String, api_name: :formatInternational
-
-      # @!attribute format_national
-      #   The phone number formatted for national dialing (e.g., (234) 567-890)
-      #
-      #   @return [String, nil]
-      optional :format_national, String, api_name: :formatNational
-
-      # @!attribute format_rfc
-      #   The phone number formatted according to RFC 3966 (e.g., tel:+1-234-567-890)
-      #
-      #   @return [String, nil]
-      optional :format_rfc, String, api_name: :formatRfc
-
-      # @!attribute number_type
-      #   The type of phone number (e.g., mobile, fixed_line, voip)
-      #
-      #   @return [String, nil]
-      optional :number_type, String, api_name: :numberType
-
-      # @!attribute phone_number
-      #   The phone number in its original format
-      #
-      #   @return [String, nil]
-      optional :phone_number, String, api_name: :phoneNumber
-
-      # @!attribute phone_timezones
-      #   The timezones associated with the phone number
-      #
-      #   @return [String, nil]
-      optional :phone_timezones, String, api_name: :phoneTimezones
-
-      # @!attribute region_code
-      #   The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
-      #
-      #   @return [String, nil]
-      optional :region_code, String, api_name: :regionCode
-
-      # @!method initialize(country_code: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, number_type: nil, phone_number: nil, phone_timezones: nil, region_code: nil)
-      #   Response containing phone number lookup data
-      #
-      #   @param country_code [String] The country calling code (e.g., 1 for US/Canada)
-      #
-      #   @param format_e164 [String] The phone number formatted in E.164 standard (e.g., +1234567890)
-      #
-      #   @param format_international [String] The phone number formatted for international dialing (e.g., +1 234-567-890)
-      #
-      #   @param format_national [String] The phone number formatted for national dialing (e.g., (234) 567-890)
-      #
-      #   @param format_rfc [String] The phone number formatted according to RFC 3966 (e.g., tel:+1-234-567-890)
-      #
-      #   @param number_type [String] The type of phone number (e.g., mobile, fixed_line, voip)
-      #
-      #   @param phone_number [String] The phone number in its original format
-      #
-      #   @param phone_timezones [String] The timezones associated with the phone number
-      #
-      #   @param region_code [String] The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
-    end
-  end
-end

data/lib/sentdm/models/template_response_v2.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Templates#create
-    class TemplateResponseV2 < Sentdm::Internal::Type::BaseModel
-      # @!attribute id
-      #   The unique identifier of the template
-      #
-      #   @return [String, nil]
-      optional :id, String
-
-      # @!attribute category
-      #   The template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
-      #
-      #   @return [String, nil]
-      optional :category, String
-
-      # @!attribute created_at
-      #   The date and time when the template was created
-      #
-      #   @return [Time, nil]
-      optional :created_at, Time, api_name: :createdAt
-
-      # @!attribute definition
-      #   The complete template definition including header, body, footer, and buttons
-      #
-      #   @return [Sentdm::Models::TemplateDefinition, nil]
-      optional :definition, -> { Sentdm::TemplateDefinition }
-
-      # @!attribute display_name
-      #   The display name of the template (auto-generated if not provided)
-      #
-      #   @return [String, nil]
-      optional :display_name, String, api_name: :displayName
-
-      # @!attribute is_published
-      #   Indicates whether the template is published and available for use
-      #
-      #   @return [Boolean, nil]
-      optional :is_published, Sentdm::Internal::Type::Boolean, api_name: :isPublished
-
-      # @!attribute language
-      #   The template language code (e.g., en_US, es_ES)
-      #
-      #   @return [String, nil]
-      optional :language, String
-
-      # @!attribute status
-      #   The approval status of the template (e.g., APPROVED, PENDING, REJECTED, DRAFT)
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!attribute updated_at
-      #   The date and time when the template was last updated
-      #
-      #   @return [Time, nil]
-      optional :updated_at, Time, api_name: :updatedAt, nil?: true
-
-      # @!attribute whatsapp_template_id
-      #   The WhatsApp Business API template ID from Meta
-      #
-      #   @return [String, nil]
-      optional :whatsapp_template_id, String, api_name: :whatsappTemplateId
-
-      # @!attribute whatsapp_template_name
-      #   The WhatsApp template name as registered with Meta
-      #
-      #   @return [String, nil]
-      optional :whatsapp_template_name, String, api_name: :whatsappTemplateName
-
-      # @!method initialize(id: nil, category: nil, created_at: nil, definition: nil, display_name: nil, is_published: nil, language: nil, status: nil, updated_at: nil, whatsapp_template_id: nil, whatsapp_template_name: nil)
-      #   Represents a message template with comprehensive metadata including definition
-      #   structure
-      #
-      #   @param id [String] The unique identifier of the template
-      #
-      #   @param category [String] The template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
-      #
-      #   @param created_at [Time] The date and time when the template was created
-      #
-      #   @param definition [Sentdm::Models::TemplateDefinition] The complete template definition including header, body, footer, and buttons
-      #
-      #   @param display_name [String] The display name of the template (auto-generated if not provided)
-      #
-      #   @param is_published [Boolean] Indicates whether the template is published and available for use
-      #
-      #   @param language [String] The template language code (e.g., en_US, es_ES)
-      #
-      #   @param status [String] The approval status of the template (e.g., APPROVED, PENDING, REJECTED, DRAFT)
-      #
-      #   @param updated_at [Time, nil] The date and time when the template was last updated
-      #
-      #   @param whatsapp_template_id [String] The WhatsApp Business API template ID from Meta
-      #
-      #   @param whatsapp_template_name [String] The WhatsApp template name as registered with Meta
-    end
-  end
-end

data/lib/sentdm/resources/number_lookup.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Resources
-    class NumberLookup
-      # Retrieves detailed information about a phone number including validation,
-      # formatting, country information, and available messaging channels. The customer
-      # ID is extracted from the authentication token.
-      #
-      # @overload retrieve(phone_number:, request_options: {})
-      #
-      # @param phone_number [String]
-      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Sentdm::Models::NumberLookupRetrieveResponse]
-      #
-      # @see Sentdm::Models::NumberLookupRetrieveParams
-      def retrieve(params)
-        parsed, options = Sentdm::NumberLookupRetrieveParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "v2/number-lookup",
-          query: parsed.transform_keys(phone_number: "phoneNumber"),
-          model: Sentdm::Models::NumberLookupRetrieveResponse,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Sentdm::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end