sentdm 0.45.0 → 0.46.0

data/lib/sentdm/models/message_channel_options.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageChannelOptions < Sentdm::Internal::Type::BaseModel
+      # @!attribute country
+      #   Recipient country this entry is meant for (ISO 3166-1 alpha-2, e.g. US).
+      #   Optional. Accepted and stored, not acted on yet.
+      #
+      #   @return [String, nil]
+      optional :country, String, nil?: true
+
+      # @!attribute from
+      #   Sender numbers in E.164. Each must be an active sender on your account for this
+      #   channel. That is account state rather than request shape, so it is decided per
+      #   message: the request is accepted with 202 and a message naming an unusable
+      #   number is recorded BLOCKED with error code BUSINESS_029.
+      #
+      #   @return [Array<String>, nil]
+      optional :from, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute strategy
+      #   How to pick a number from From, e.g. sticky or geo. Optional. Accepted and
+      #   stored, not acted on yet.
+      #
+      #   @return [String, nil]
+      optional :strategy, String, nil?: true
+
+      # @!method initialize(country: nil, from: nil, strategy: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageChannelOptions} for more details.
+      #
+      #   One entry of a channel's list in Channels, e.g. {"country": "US", "from":
+      #   ["+15559990002", "+15559990003"], "strategy": "sticky"}.
+      #
+      #   @param country [String, nil] Recipient country this entry is meant for (ISO 3166-1 alpha-2, e.g. US). Optiona
+      #
+      #   @param from [Array<String>, nil] Sender numbers in E.164. Each must be an active sender on your account for this
+      #
+      #   @param strategy [String, nil] How to pick a number from From, e.g. sticky or geo. Optional. Accepted
+    end
+  end
+end

data/lib/sentdm/models/message_header_media.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageHeaderMedia < Sentdm::Internal::Type::BaseModel
+      # @!attribute type
+      #   "image", "video" or "document" — taken from the header's media variable.
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!attribute url
+      #   The https URL the caller supplied for this send. Never the template's stored
+      #   props.sample, which is Meta's expiring header_handle rather than what was
+      #   delivered.
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!method initialize(type: nil, url: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageHeaderMedia} for more details.
+      #
+      #   The media asset that rode a message's header, recorded as sent.
+      #
+      #   @param type [String] "image", "video" or "document" — taken from the header's media variable.
+      #
+      #   @param url [String] The https URL the caller supplied for this send. Never the template's stored
+    end
+  end
+end

data/lib/sentdm/models/message_media.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageMedia < Sentdm::Internal::Type::BaseModel
+      # @!attribute media_type
+      #   One of MmsMediaTypes when the content type is known. Advisory — a reader should
+      #   trust the fetched object's own Content-Type.
+      #
+      #   @return [String, nil]
+      optional :media_type, String, api_name: :mediaType, nil?: true
+
+      # @!attribute mime_type
+      #   Content type as the provider declared it. Null when it declared none.
+      #
+      #   @return [String, nil]
+      optional :mime_type, String, api_name: :mimeType, nil?: true
+
+      # @!attribute size_bytes
+      #   Size as the provider declared it. Never measured here — nothing downloads the
+      #   file.
+      #
+      #   @return [Integer, nil]
+      optional :size_bytes, Integer, api_name: :sizeBytes, nil?: true
+
+      # @!attribute source_hash_sha256
+      #   Inbound only: the SHA-256 the provider declared alongside the attachment, when
+      #   it declared one. Relayed to the customer so they can verify what they fetch
+      #   matches what the carrier said it sent. It is the only integrity signal available
+      #   on an attachment nobody here has read.
+      #
+      #   @return [String, nil]
+      optional :source_hash_sha256, String, api_name: :sourceHashSha256, nil?: true
+
+      # @!attribute url
+      #   Where the file lives. Outbound: the URL the customer gave us and the carrier
+      #   fetched. Inbound: the URL the carrier hosts it at, relayed unchanged.
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!method initialize(media_type: nil, mime_type: nil, size_bytes: nil, source_hash_sha256: nil, url: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageMedia} for more details.
+      #
+      #   One attachment on a message, in either direction — and in both, a URL somebody
+      #   else hosts.
+      #
+      #   Outbound: the customer supplied a public URL and we handed it to the carrier.
+      #   Inbound: the carrier hosts the file and we record where. sent.dm never holds the
+      #   bytes, so there is no key, no expiry bookkeeping and nothing minted per read —
+      #   what is stored is what is served.
+      #
+      #   An inbound link expires on the carrier's own schedule and is unauthenticated.
+      #   That is the customer's to manage, and it is documented where they will see it
+      #   rather than only here — a recipient who needs an attachment to outlive that
+      #   window copies it on receipt.
+      #
+      #   Storing a presigned URL is the specific mistake this shape still avoids:
+      #   M260826130000 and M260826140000 exist because RCS assets were stored as signed
+      #   URLs and went stale. Nothing here is signed.
+      #
+      #   @param media_type [String, nil] One of MmsMediaTypes when the content type is known. Advisory — a reader should
+      #
+      #   @param mime_type [String, nil] Content type as the provider declared it. Null when it declared none.
+      #
+      #   @param size_bytes [Integer, nil] Size as the provider declared it. Never measured here — nothing downloads the fi
+      #
+      #   @param source_hash_sha256 [String, nil] Inbound only: the SHA-256 the provider declared alongside the attachment, when i
+      #
+      #   @param url [String, nil] Where the file lives. Outbound: the URL the customer gave us and the carrier fet
+    end
+  end
+end

data/lib/sentdm/models/message_recipient.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageRecipient < Sentdm::Internal::Type::BaseModel
+      # @!attribute body
+      #   Resolved template body for this recipient's channel, or null when the channel is
+      #   auto-detected.
+      #
+      #   @return [String, nil]
+      optional :body, String, nil?: true
+
+      # @!attribute channel
+      #   Channel this message will be sent on — sms, whatsapp — or null to auto-detect.
+      #
+      #   @return [String, nil]
+      optional :channel, String, nil?: true
+
+      # @!attribute message_id
+      #   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(body: nil, channel: nil, message_id: nil, to: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageRecipient} for more details.
+      #
+      #   What one recipient of a send got, as the API reports it.
+      #
+      #   @param body [String, nil] Resolved template body for this recipient's channel, or null when the channel is
+      #
+      #   @param channel [String, nil] Channel this message will be sent on — sms, whatsapp — or null to auto-detect.
+      #
+      #   @param message_id [String] Identifier for tracking this recipient's message.
+      #
+      #   @param to [String] Phone number in E.164 format.
+    end
+  end
+end

data/lib/sentdm/models/message_send_params.rb

@@ -40,10 +40,10 @@ module Sentdm
       #   decided per message, so each affected message is recorded BLOCKED with error
       #   code BUSINESS_029 and reported on GET /v3/messages and the status webhook.
       #
-      #   @return [Hash{Symbol=>Array<Sentdm::Models::MessageSendParams::Channel>}, nil]
+      #   @return [Hash{Symbol=>Array<Sentdm::Models::MessageChannelOptions>}, nil]
       optional :channels,
                -> {
-                 Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[Sentdm::MessageSendParams::Channel]]
+                 Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[Sentdm::MessageChannelOptions]]
                },
                nil?: true
 
@@ -102,8 +102,8 @@ module Sentdm
       #   SDK-style template reference: resolve by ID or by name, with optional
       #   parameters.
       #
-      #   @return [Sentdm::Models::MessageSendParams::Template, nil]
-      optional :template, -> { Sentdm::MessageSendParams::Template }, nil?: true
+      #   @return [Sentdm::Models::TemplateRef, nil]
+      optional :template, -> { Sentdm::TemplateRef }, nil?: true
 
       # @!attribute text
       #   Plain-text (free-form) message body. Provide either Template or this.
@@ -133,7 +133,7 @@ module Sentdm
       #
       #   @param channel [Array<String>, nil] Channels to broadcast on, e.g. ["whatsapp", "sms"].
       #
-      #   @param channels [Hash{Symbol=>Array<Sentdm::Models::MessageSendParams::Channel>}, nil] Which of your own numbers to send from, keyed by channel, each channel holding a
+      #   @param channels [Hash{Symbol=>Array<Sentdm::Models::MessageChannelOptions>}, nil] Which of your own numbers to send from, keyed by channel, each channel holding a
       #
       #   @param media_urls [Array<String>, nil] Attachments for this send, as publicly fetchable https URLs. Used by the MMS cha
       #
@@ -143,7 +143,7 @@ module Sentdm
       #
       #   @param subject [String, nil] Subject line for this send, overriding the template's. MMS only; ignored on ever
       #
-      #   @param template [Sentdm::Models::MessageSendParams::Template, nil] SDK-style template reference: resolve by ID or by name, with optional parameters
+      #   @param template [Sentdm::Models::TemplateRef, nil] SDK-style template reference: resolve by ID or by name, with optional parameters
       #
       #   @param text [String, nil] Plain-text (free-form) message body. Provide either Template or this.
       #
@@ -154,90 +154,6 @@ module Sentdm
       #   @param x_profile_id [String]
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-
-      class Channel < Sentdm::Internal::Type::BaseModel
-        # @!attribute country
-        #   Recipient country this entry is meant for (ISO 3166-1 alpha-2, e.g. US).
-        #   Optional. Accepted and stored, not acted on yet.
-        #
-        #   @return [String, nil]
-        optional :country, String, nil?: true
-
-        # @!attribute from
-        #   Sender numbers in E.164. Each must be an active sender on your account for this
-        #   channel. That is account state rather than request shape, so it is decided per
-        #   message: the request is accepted with 202 and a message naming an unusable
-        #   number is recorded BLOCKED with error code BUSINESS_029.
-        #
-        #   @return [Array<String>, nil]
-        optional :from, Sentdm::Internal::Type::ArrayOf[String], nil?: true
-
-        # @!attribute strategy
-        #   How to pick a number from From, e.g. sticky or geo. Optional. Accepted and
-        #   stored, not acted on yet.
-        #
-        #   @return [String, nil]
-        optional :strategy, String, nil?: true
-
-        # @!method initialize(country: nil, from: nil, strategy: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::MessageSendParams::Channel} for more details.
-        #
-        #   One entry of a channel's list in Channels, e.g. {"country": "US", "from":
-        #   ["+15559990002", "+15559990003"], "strategy": "sticky"}.
-        #
-        #   @param country [String, nil] Recipient country this entry is meant for (ISO 3166-1 alpha-2, e.g. US). Optiona
-        #
-        #   @param from [Array<String>, nil] Sender numbers in E.164. Each must be an active sender on your account for this
-        #
-        #   @param strategy [String, nil] How to pick a number from From, e.g. sticky or geo. Optional. Accepted
-      end
-
-      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, keyed by variable name.
-        #
-        #   Every variable the template declares is required; GET /v3/templates/{id} lists
-        #   them. Supplying a key the template does not declare is ignored.
-        #
-        #   Media headers. A template whose header is an image (designed in WhatsApp Manager
-        #   and imported into Sent) declares a reserved header_image key. Its value is a
-        #   publicly reachable https URL that Meta fetches at send time — Sent does not host
-        #   the asset, and the sample approved with the template is not reused. The key is
-        #   derived from the header's media type, so header_video and header_document follow
-        #   the same shape when those formats ship.
-        #
-        #   "parameters": { "header_image": "https://cdn.example.com/banner.jpg", "name":
-        #   "John Doe" }
-        #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :parameters, Sentdm::Internal::Type::HashOf[String], nil?: true
-
-        # @!method initialize(id: nil, name: nil, parameters: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::MessageSendParams::Template} for more details.
-        #
-        #   SDK-style template reference: resolve by ID or by 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, keyed by variable name.
-      end
     end
   end
 end

data/lib/sentdm/models/message_send_response.rb

@@ -18,8 +18,8 @@ module Sentdm
       #   carried scheduled_at is a ScheduledSendMessageResponse, and the endpoint decides
       #   which of the two to answer with. From always returns this type.
       #
-      #   @return [Sentdm::Models::MessageSendResponse::Data, nil]
-      optional :data, -> { Sentdm::MessageSendResponse::Data }, nil?: true
+      #   @return [Sentdm::Models::MessageSendResult, nil]
+      optional :data, -> { Sentdm::MessageSendResult }, nil?: true
 
       # @!attribute error
       #   Error information
@@ -45,105 +45,13 @@ module Sentdm
       #
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::MessageSendResponse::Data, nil] The result of a multi-recipient send.
+      #   @param data [Sentdm::Models::MessageSendResult, nil] The result of a multi-recipient send.
       #
       #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
       #
       #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
-
-      # @see Sentdm::Models::MessageSendResponse#data
-      class Data < Sentdm::Internal::Type::BaseModel
-        # @!attribute recipients
-        #
-        #   @return [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>, nil]
-        optional :recipients, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::MessageSendResponse::Data::Recipient] }
-
-        # @!attribute status
-        #   QUEUED: the batch is accepted. A request that carried scheduled_at is QUEUED
-        #   here too; each message moves to SCHEDULED once it is held, as GET
-        #   /v3/messages/{id} and the message.scheduled webhook report.
-        #
-        #   @return [String, nil]
-        optional :status, String
-
-        # @!attribute template_id
-        #
-        #   @return [String, nil]
-        optional :template_id, String
-
-        # @!attribute template_name
-        #
-        #   @return [String, nil]
-        optional :template_name, String
-
-        # @!method initialize(recipients: nil, status: nil, template_id: nil, template_name: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::MessageSendResponse::Data} for more details.
-        #
-        #   The result of a multi-recipient send.
-        #
-        #   Declared here rather than in the service layer. POST /v3/messages used to
-        #   publish MessageSendResult — a type in Common.Services.Messaging.Contracts — so
-        #   the public contract was whatever the send service happened to return, and
-        #   changing that service for an internal reason changed the API. The service keeps
-        #   its result; this is what a caller sees, and the mapping between them is a
-        #   decision the endpoint makes.
-        #
-        #   The shape of an immediate send: it never has a scheduled_at key. A send that
-        #   carried scheduled_at is a ScheduledSendMessageResponse, and the endpoint decides
-        #   which of the two to answer with. From always returns this type.
-        #
-        #   @param recipients [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>]
-        #
-        #   @param status [String] QUEUED: the batch is accepted. A request that carried scheduled_at is QUEUED
-        #
-        #   @param template_id [String]
-        #
-        #   @param template_name [String]
-
-        class Recipient < Sentdm::Internal::Type::BaseModel
-          # @!attribute body
-          #   Resolved template body for this recipient's channel, or null when the channel is
-          #   auto-detected.
-          #
-          #   @return [String, nil]
-          optional :body, String, nil?: true
-
-          # @!attribute channel
-          #   Channel this message will be sent on — sms, whatsapp — or null to auto-detect.
-          #
-          #   @return [String, nil]
-          optional :channel, String, nil?: true
-
-          # @!attribute message_id
-          #   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(body: nil, channel: nil, message_id: nil, to: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::MessageSendResponse::Data::Recipient} for more details.
-          #
-          #   What one recipient of a send got, as the API reports it.
-          #
-          #   @param body [String, nil] Resolved template body for this recipient's channel, or null when the channel is
-          #
-          #   @param channel [String, nil] Channel this message will be sent on — sms, whatsapp — or null to auto-detect.
-          #
-          #   @param message_id [String] 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/message_send_result.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageSendResult < Sentdm::Internal::Type::BaseModel
+      # @!attribute recipients
+      #
+      #   @return [Array<Sentdm::Models::MessageRecipient>, nil]
+      optional :recipients, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::MessageRecipient] }
+
+      # @!attribute status
+      #   QUEUED: the batch is accepted. A request that carried scheduled_at is QUEUED
+      #   here too; each message moves to SCHEDULED once it is held, as GET
+      #   /v3/messages/{id} and the message.scheduled webhook report.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute template_id
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!attribute template_name
+      #
+      #   @return [String, nil]
+      optional :template_name, String
+
+      # @!method initialize(recipients: nil, status: nil, template_id: nil, template_name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageSendResult} for more details.
+      #
+      #   The result of a multi-recipient send.
+      #
+      #   Declared here rather than in the service layer. POST /v3/messages used to
+      #   publish MessageSendResult — a type in Common.Services.Messaging.Contracts — so
+      #   the public contract was whatever the send service happened to return, and
+      #   changing that service for an internal reason changed the API. The service keeps
+      #   its result; this is what a caller sees, and the mapping between them is a
+      #   decision the endpoint makes.
+      #
+      #   The shape of an immediate send: it never has a scheduled_at key. A send that
+      #   carried scheduled_at is a ScheduledSendMessageResponse, and the endpoint decides
+      #   which of the two to answer with. From always returns this type.
+      #
+      #   @param recipients [Array<Sentdm::Models::MessageRecipient>]
+      #
+      #   @param status [String] QUEUED: the batch is accepted. A request that carried scheduled_at is QUEUED
+      #
+      #   @param template_id [String]
+      #
+      #   @param template_name [String]
+    end
+  end
+end

data/lib/sentdm/models/message_status_event.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageStatusEvent < 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
+
+      # @!attribute reason
+      #   A human-readable sentence for reason_code. Omitted whenever reason_code is.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute reason_code
+      #   Why the message reached this status, as a stable platform code such as
+      #   DELIVERY_007. Present on FAILED, FILTERED and BLOCKED events; omitted on every
+      #   status that needs no explanation. Same wire name and vocabulary as on the
+      #   activities list and the webhook.
+      #
+      #   @return [String, nil]
+      optional :reason_code, String, nil?: true
+
+      # @!method initialize(status:, timestamp:, description: nil, reason: nil, reason_code: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageStatusEvent} for more details.
+      #
+      #   Represents a status change event in a message's lifecycle (v3)
+      #
+      #   @param status [String]
+      #
+      #   @param timestamp [Time]
+      #
+      #   @param description [String, nil]
+      #
+      #   @param reason [String, nil] A human-readable sentence for reason_code. Omitted whenever reason_code is.
+      #
+      #   @param reason_code [String, nil] Why the message reached this status, as a stable platform code such as
+      #   DELIVERY\_
+    end
+  end
+end

data/lib/sentdm/models/mms_market.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MmsMarket < Sentdm::Internal::Type::BaseModel
+      # @!attribute country
+      #   ISO-3166 alpha-2 of the market.
+      #
+      #   @return [String, nil]
+      optional :country, String, nil?: true
+
+      # @!attribute number_type
+      #   The sender type the market sends from, mirroring the SMS sender.
+      #
+      #   @return [String, nil]
+      optional :number_type, String, nil?: true
+
+      # @!attribute sender_value
+      #   The sending number. Null while the market is still being provisioned.
+      #
+      #   @return [String, nil]
+      optional :sender_value, String, nil?: true
+
+      # @!attribute status
+      #   Where this market's MMS sender stands. Read-only.
+      #
+      #   @return [String, nil]
+      optional :status, String, nil?: true
+
+      # @!method initialize(country: nil, number_type: nil, sender_value: nil, status: nil)
+      #   One market the profile can send MMS in.
+      #
+      #   Deliberately not SmsMarketState: an MMS market carries no compliance of its own.
+      #   It is the same number, carrier and registration as the SMS market on it in that
+      #   country — MMS files nothing separately — so a compliance block here would always
+      #   be null and would invite the question of what an MMS market owes. It owes what
+      #   the SMS market owes, reported there.
+      #
+      #   @param country [String, nil] ISO-3166 alpha-2 of the market.
+      #
+      #   @param number_type [String, nil] The sender type the market sends from, mirroring the SMS sender.
+      #
+      #   @param sender_value [String, nil] The sending number. Null while the market is still being provisioned.
+      #
+      #   @param status [String, nil] Where this market's MMS sender stands. Read-only.
+    end
+  end
+end

data/lib/sentdm/models/number_lookup_result.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class NumberLookupResult < Sentdm::Internal::Type::BaseModel
+      # @!attribute carrier_name
+      #
+      #   @return [String, nil]
+      optional :carrier_name, String, nil?: true
+
+      # @!attribute country_code
+      #
+      #   @return [String, nil]
+      optional :country_code, String, nil?: true
+
+      # @!attribute is_ported
+      #
+      #   @return [Boolean, nil]
+      optional :is_ported, Sentdm::Internal::Type::Boolean, nil?: true
+
+      # @!attribute is_valid
+      #
+      #   @return [Boolean, nil]
+      optional :is_valid, Sentdm::Internal::Type::Boolean
+
+      # @!attribute is_voip
+      #
+      #   @return [Boolean, nil]
+      optional :is_voip, Sentdm::Internal::Type::Boolean, nil?: true
+
+      # @!attribute line_type
+      #
+      #   @return [String, nil]
+      optional :line_type, String, nil?: true
+
+      # @!attribute mobile_country_code
+      #
+      #   @return [String, nil]
+      optional :mobile_country_code, String, nil?: true
+
+      # @!attribute mobile_network_code
+      #
+      #   @return [String, nil]
+      optional :mobile_network_code, String, nil?: true
+
+      # @!attribute phone_number
+      #
+      #   @return [String, nil]
+      optional :phone_number, String
+
+      # @!method initialize(carrier_name: nil, country_code: nil, is_ported: nil, is_valid: nil, is_voip: nil, line_type: nil, mobile_country_code: nil, mobile_network_code: nil, phone_number: nil)
+      #   @param carrier_name [String, nil]
+      #   @param country_code [String, nil]
+      #   @param is_ported [Boolean, nil]
+      #   @param is_valid [Boolean]
+      #   @param is_voip [Boolean, nil]
+      #   @param line_type [String, nil]
+      #   @param mobile_country_code [String, nil]
+      #   @param mobile_network_code [String, nil]
+      #   @param phone_number [String]
+    end
+  end
+end