sentdm 0.0.2

data/lib/sentdm/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Internal
+    extend Sentdm::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Sentdm::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Sentdm::FilePart) }
+    end
+  end
+end

data/lib/sentdm/models/contact_list_item.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#retrieve_by_phone
+    class ContactListItem < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier of the contact
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute available_channels
+      #   Comma-separated list of available messaging channels for this contact (e.g.,
+      #   "sms,whatsapp")
+      #
+      #   @return [String, nil]
+      optional :available_channels, String, api_name: :availableChannels
+
+      # @!attribute country_code
+      #   The country calling code (e.g., 1 for US/Canada)
+      #
+      #   @return [String, nil]
+      optional :country_code, String, api_name: :countryCode
+
+      # @!attribute default_channel
+      #   The default messaging channel to use for this contact (e.g., "sms" or
+      #   "whatsapp")
+      #
+      #   @return [String, nil]
+      optional :default_channel, String, api_name: :defaultChannel
+
+      # @!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 phone_number
+      #   The phone number in its original format
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, api_name: :phoneNumber
+
+      # @!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(id: nil, available_channels: nil, country_code: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, phone_number: nil, region_code: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ContactListItem} for more details.
+      #
+      #   Represents a contact in the customer's contact list
+      #
+      #   @param id [String] The unique identifier of the contact
+      #
+      #   @param available_channels [String] Comma-separated list of available messaging channels for this contact (e.g., "sm
+      #
+      #   @param country_code [String] The country calling code (e.g., 1 for US/Canada)
+      #
+      #   @param default_channel [String] The default messaging channel to use for this contact (e.g., "sms" or "whatsapp"
+      #
+      #   @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 phone_number [String] The phone number in its original format
+      #
+      #   @param region_code [String] The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+    end
+  end
+end

data/lib/sentdm/models/contact_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#list
+    class ContactListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute page
+      #   The page number (zero-indexed). Default is 0.
+      #
+      #   @return [Integer]
+      required :page, Integer
+
+      # @!attribute page_size
+      #   The number of items per page. Default is 20.
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!method initialize(page:, page_size:, request_options: {})
+      #   @param page [Integer] The page number (zero-indexed). Default is 0.
+      #
+      #   @param page_size [Integer] The number of items per page. Default is 20.
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/contact_list_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#list
+    class ContactListResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute items
+      #
+      #   @return [Array<Sentdm::Models::ContactListItem>, nil]
+      optional :items, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactListItem] }
+
+      # @!attribute page
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer, api_name: :pageSize
+
+      # @!attribute total_count
+      #
+      #   @return [Integer, nil]
+      optional :total_count, Integer, api_name: :totalCount
+
+      # @!attribute total_pages
+      #
+      #   @return [Integer, nil]
+      optional :total_pages, Integer, api_name: :totalPages
+
+      # @!method initialize(items: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
+      #   @param items [Array<Sentdm::Models::ContactListItem>]
+      #   @param page [Integer]
+      #   @param page_size [Integer]
+      #   @param total_count [Integer]
+      #   @param total_pages [Integer]
+    end
+  end
+end

data/lib/sentdm/models/contact_retrieve_by_phone_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#retrieve_by_phone
+    class ContactRetrieveByPhoneParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #   The phone number in international format (e.g., +1234567890)
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!method initialize(phone_number:, request_options: {})
+      #   @param phone_number [String] The phone number in international format (e.g., +1234567890)
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/contact_retrieve_id_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#retrieve_id
+    class ContactRetrieveIDParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   The unique identifier (GUID) of the resource to retrieve
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The unique identifier (GUID) of the resource to retrieve
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/message_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#retrieve
+    class MessageRetrieveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/message_retrieve_response.rb

@@ -0,0 +1,227 @@
+# 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

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,46 @@
+# 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

@@ -0,0 +1,47 @@
+# 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_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::NumberLookup#retrieve
+    class NumberLookupRetrieveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!method initialize(phone_number:, request_options: {})
+      #   @param phone_number [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end