sentdm 0.25.0 → 0.27.0

data/lib/sentdm/models/conversation_messages_list.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ConversationMessagesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute messages
+      #   The messages on this page, most recent first.
+      #
+      #   @return [Array<Sentdm::Models::ConversationMessagesList::Message>, nil]
+      optional :messages, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message] }
+
+      # @!attribute pagination
+      #   Pagination metadata for list responses
+      #
+      #   @return [Sentdm::Models::PaginationMeta, nil]
+      optional :pagination, -> { Sentdm::PaginationMeta }
+
+      # @!method initialize(messages: nil, pagination: nil)
+      #   A paginated list of messages — used by both conversation read endpoints.
+      #
+      #   @param messages [Array<Sentdm::Models::ConversationMessagesList::Message>] The messages on this page, most recent first.
+      #
+      #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+
+      class Message < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute active_contact_price
+        #
+        #   @return [Float, nil]
+        optional :active_contact_price, Float, nil?: true
+
+        # @!attribute channel
+        #
+        #   @return [String, nil]
+        optional :channel, String
+
+        # @!attribute contact_id
+        #
+        #   @return [String, nil]
+        optional :contact_id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String
+
+        # @!attribute direction
+        #
+        #   @return [String, nil]
+        optional :direction, String
+
+        # @!attribute events
+        #
+        #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
+        optional :events,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::Event] },
+                 nil?: true
+
+        # @!attribute message_body
+        #   Structured message body format for database storage. Preserves channel-specific
+        #   components (header, body, footer, buttons).
+        #
+        #   @return [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil]
+        optional :message_body, -> { Sentdm::ConversationMessagesList::Message::MessageBody }, nil?: true
+
+        # @!attribute phone
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!attribute phone_international
+        #
+        #   @return [String, nil]
+        optional :phone_international, String
+
+        # @!attribute price
+        #
+        #   @return [Float, nil]
+        optional :price, Float, nil?: true
+
+        # @!attribute region_code
+        #
+        #   @return [String, nil]
+        optional :region_code, String
+
+        # @!attribute status
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute template_category
+        #
+        #   @return [String, nil]
+        optional :template_category, String, nil?: true
+
+        # @!attribute template_id
+        #
+        #   @return [String, nil]
+        optional :template_id, String, nil?: true
+
+        # @!attribute template_name
+        #
+        #   @return [String, nil]
+        optional :template_name, String, nil?: true
+
+        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ConversationMessagesList::Message} for more details.
+        #
+        #   Message response for v3 API — same shape as v2 with snake_case JSON conventions
+        #
+        #   @param id [String]
+        #
+        #   @param active_contact_price [Float, nil]
+        #
+        #   @param channel [String]
+        #
+        #   @param contact_id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param direction [String]
+        #
+        #   @param events [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
+        #
+        #   @param message_body [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil] Structured message body format for database storage.
+        #
+        #   @param phone [String]
+        #
+        #   @param phone_international [String]
+        #
+        #   @param price [Float, nil]
+        #
+        #   @param region_code [String]
+        #
+        #   @param status [String]
+        #
+        #   @param template_category [String, nil]
+        #
+        #   @param template_id [String, nil]
+        #
+        #   @param template_name [String, nil]
+
+        class Event < Sentdm::Internal::Type::BaseModel
+          # @!attribute status
+          #
+          #   @return [String]
+          required :status, String
+
+          # @!attribute timestamp
+          #
+          #   @return [Time]
+          required :timestamp, Time
+
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!method initialize(status:, timestamp:, description: nil)
+          #   Represents a status change event in a message's lifecycle (v3)
+          #
+          #   @param status [String]
+          #   @param timestamp [Time]
+          #   @param description [String, nil]
+        end
+
+        # @see Sentdm::Models::ConversationMessagesList::Message#message_body
+        class MessageBody < Sentdm::Internal::Type::BaseModel
+          # @!attribute buttons
+          #
+          #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
+          optional :buttons,
+                   -> {
+                     Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::MessageBody::Button]
+                   },
+                   nil?: true
+
+          # @!attribute content
+          #
+          #   @return [String, nil]
+          optional :content, String
+
+          # @!attribute footer
+          #
+          #   @return [String, nil]
+          optional :footer, String, nil?: true
+
+          # @!attribute header
+          #
+          #   @return [String, nil]
+          optional :header, String, nil?: true
+
+          # @!method initialize(buttons: nil, content: nil, footer: nil, header: nil)
+          #   Structured message body format for database storage. Preserves channel-specific
+          #   components (header, body, footer, buttons).
+          #
+          #   @param buttons [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
+          #   @param content [String]
+          #   @param footer [String, nil]
+          #   @param header [String, nil]
+
+          class Button < Sentdm::Internal::Type::BaseModel
+            # @!attribute postback_data
+            #
+            #   @return [String, nil]
+            optional :postback_data, String, api_name: :postbackData, nil?: true
+
+            # @!attribute text
+            #
+            #   @return [String, nil]
+            optional :text, String, nil?: true
+
+            # @!attribute type
+            #
+            #   @return [String, nil]
+            optional :type, String
+
+            # @!attribute value
+            #
+            #   @return [String, nil]
+            optional :value, String
+
+            # @!method initialize(postback_data: nil, text: nil, type: nil, value: nil)
+            #   @param postback_data [String, nil]
+            #   @param text [String, nil]
+            #   @param type [String]
+            #   @param value [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/inbound_message_event.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class InboundMessageEvent < Sentdm::Internal::Type::BaseModel
+      # @!attribute event
+      #   The specific event within the family, for example message.delivered or
+      #   message.received. Absent on events that have no subtype, so treat it as
+      #   optional.
+      #
+      #   @return [String, nil]
+      optional :event, String, nil?: true
+
+      # @!attribute field
+      #   The event family, for example message or templates. Route on this first, then on
+      #   event for the specific change.
+      #
+      #   @return [String, nil]
+      optional :field, String
+
+      # @!attribute payload
+      #   Body of a message.received event. Delivered when a contact messages one of your
+      #   numbers.
+      #
+      #   @return [Sentdm::Models::InboundMessageEventPayload, nil]
+      optional :payload, -> { Sentdm::InboundMessageEventPayload }, nil?: true
+
+      # @!attribute timestamp
+      #   When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+      #   time, not the time the underlying change happened. Use the timestamp inside the
+      #   payload for the latter.
+      #
+      #   @return [String, nil]
+      optional :timestamp, String
+
+      # @!method initialize(event: nil, field: nil, payload: nil, timestamp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::InboundMessageEvent} for more details.
+      #
+      #   The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+      #   this shape and varies only in Payload.
+      #
+      #   @param event [String, nil] The specific event within the family, for example message.delivered or
+      #
+      #   @param field [String] The event family, for example message or templates. Route on this first, then
+      #
+      #   @param payload [Sentdm::Models::InboundMessageEventPayload, nil] Body of a message.received event. Delivered when a contact messages one of your
+      #
+      #   @param timestamp [String] When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+    end
+  end
+end

data/lib/sentdm/models/inbound_message_event_payload.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class InboundMessageEventPayload < Sentdm::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The account the message belongs to.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute channel
+      #   The channel the message arrived on, for example sms or whatsapp.
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute inbound_number
+      #   The contact's number in E.164 format, meaning the number the message came from.
+      #
+      #   @return [String, nil]
+      optional :inbound_number, String
+
+      # @!attribute message_id
+      #   The inbound message.
+      #
+      #   @return [String, nil]
+      optional :message_id, String
+
+      # @!attribute outbound_number
+      #   Your number in E.164 format, meaning the number the message was addressed to.
+      #
+      #   @return [String, nil]
+      optional :outbound_number, String
+
+      # @!attribute received_at
+      #   When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      #
+      #   @return [String, nil]
+      optional :received_at, String
+
+      # @!attribute text
+      #   The message body. Sent as null when the inbound message carried no text, for
+      #   example a media-only message. The field is always present, so read it and check
+      #   for null rather than checking whether the key exists.
+      #
+      #   @return [String, nil]
+      optional :text, String, nil?: true
+
+      # @!attribute updated_at
+      #   When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ). Same value as
+      #   ReceivedAt, kept for envelope consistency with outbound events.
+      #
+      #   @return [String, nil]
+      optional :updated_at, String
+
+      # @!method initialize(account_id: nil, channel: nil, inbound_number: nil, message_id: nil, outbound_number: nil, received_at: nil, text: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::InboundMessageEventPayload} for more details.
+      #
+      #   Body of a message.received event. Delivered when a contact messages one of your
+      #   numbers.
+      #
+      #   @param account_id [String] The account the message belongs to.
+      #
+      #   @param channel [String] The channel the message arrived on, for example sms or whatsapp.
+      #
+      #   @param inbound_number [String] The contact's number in E.164 format, meaning the number the message came from.
+      #
+      #   @param message_id [String] The inbound message.
+      #
+      #   @param outbound_number [String] Your number in E.164 format, meaning the number the message was addressed to.
+      #
+      #   @param received_at [String] When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      #
+      #   @param text [String, nil] The message body. Sent as null when the inbound message carried no text, for
+      #
+      #   @param updated_at [String] When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ). Same value as
+    end
+  end
+end

data/lib/sentdm/models/message_event.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageEvent < Sentdm::Internal::Type::BaseModel
+      # @!attribute event
+      #   The specific event within the family, for example message.delivered or
+      #   message.received. Absent on events that have no subtype, so treat it as
+      #   optional.
+      #
+      #   @return [String, nil]
+      optional :event, String, nil?: true
+
+      # @!attribute field
+      #   The event family, for example message or templates. Route on this first, then on
+      #   event for the specific change.
+      #
+      #   @return [String, nil]
+      optional :field, String
+
+      # @!attribute payload
+      #   Body of an outbound message lifecycle event. Delivered once per status change,
+      #   so a single message produces several of these as it moves toward a terminal
+      #   status.
+      #
+      #   @return [Sentdm::Models::MessageEventPayload, nil]
+      optional :payload, -> { Sentdm::MessageEventPayload }, nil?: true
+
+      # @!attribute timestamp
+      #   When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+      #   time, not the time the underlying change happened. Use the timestamp inside the
+      #   payload for the latter.
+      #
+      #   @return [String, nil]
+      optional :timestamp, String
+
+      # @!method initialize(event: nil, field: nil, payload: nil, timestamp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageEvent} for more details.
+      #
+      #   The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+      #   this shape and varies only in Payload.
+      #
+      #   @param event [String, nil] The specific event within the family, for example message.delivered or
+      #
+      #   @param field [String] The event family, for example message or templates. Route on this first, then
+      #
+      #   @param payload [Sentdm::Models::MessageEventPayload, nil] Body of an outbound message lifecycle event. Delivered once per status change, s
+      #
+      #   @param timestamp [String] When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+    end
+  end
+end

data/lib/sentdm/models/message_event_payload.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageEventPayload < Sentdm::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The account the message belongs to.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute agent_id
+      #   The agent attributed to the send, when the send was attributed to one.
+      #
+      #   @return [String, nil]
+      optional :agent_id, String, nil?: true
+
+      # @!attribute channel
+      #   The channel the message went out on, for example sms or whatsapp. A message that
+      #   falls back to another channel reports the channel actually used.
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute message_id
+      #   The message this event describes. Stable across every event in the message's
+      #   lifecycle, so use it to correlate them.
+      #
+      #   @return [String, nil]
+      optional :message_id, String
+
+      # @!attribute message_status
+      #   The status the message just reached, for example SENT, DELIVERED, or FAILED.
+      #   Sent means dispatched and delivered means confirmed, so treat them as distinct
+      #   outcomes.
+      #
+      #   @return [String, nil]
+      optional :message_status, String
+
+      # @!attribute outbound_number
+      #   The recipient's number in E.164 format.
+      #
+      #   @return [String, nil]
+      optional :outbound_number, String
+
+      # @!attribute template_id
+      #   The template the message was sent from, when it was sent from one.
+      #
+      #   @return [String, nil]
+      optional :template_id, String, nil?: true
+
+      # @!attribute template_name
+      #   Name of the template the message was sent from. Omitted when the message wasn't
+      #   template-based.
+      #
+      #   @return [String, nil]
+      optional :template_name, String, nil?: true
+
+      # @!attribute updated_at
+      #   When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      #
+      #   @return [String, nil]
+      optional :updated_at, String
+
+      # @!method initialize(account_id: nil, agent_id: nil, channel: nil, message_id: nil, message_status: nil, outbound_number: nil, template_id: nil, template_name: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageEventPayload} for more details.
+      #
+      #   Body of an outbound message lifecycle event. Delivered once per status change,
+      #   so a single message produces several of these as it moves toward a terminal
+      #   status.
+      #
+      #   @param account_id [String] The account the message belongs to.
+      #
+      #   @param agent_id [String, nil] The agent attributed to the send, when the send was attributed to one.
+      #
+      #   @param channel [String] The channel the message went out on, for example sms or whatsapp. A message
+      #
+      #   @param message_id [String] The message this event describes. Stable across every event in the message's lif
+      #
+      #   @param message_status [String] The status the message just reached, for example SENT, DELIVERED, or
+      #
+      #   @param outbound_number [String] The recipient's number in E.164 format.
+      #
+      #   @param template_id [String, nil] The template the message was sent from, when it was sent from one.
+      #
+      #   @param template_name [String, nil] Name of the template the message was sent from. Omitted when the message wasn't
+      #
+      #   @param updated_at [String] When the message reached MessageStatus, in UTC
+    end
+  end
+end

data/lib/sentdm/models/message_send_response.rb

@@ -49,8 +49,7 @@ module Sentdm
                  -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageSendResponse::Data::Recipient] }
 
         # @!attribute status
-        #   Overall request status: "QUEUED" when the batch has been accepted and published
-        #   to Kafka.
+        #   Overall request status: "QUEUED" when the batch has been accepted for delivery.
         #
         #   @return [String, nil]
         optional :status, String
@@ -68,14 +67,11 @@ module Sentdm
         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.
-        #
         #   Response for the multi-recipient send message endpoint
         #
         #   @param recipients [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>] Per-recipient message results
         #
-        #   @param status [String] Overall request status: "QUEUED" when the batch has been accepted and published
+        #   @param status [String] Overall request status: "QUEUED" when the batch has been accepted for delivery.
         #
         #   @param template_id [String] Template ID that was used
         #

data/lib/sentdm/models/profile_detail.rb

@@ -113,7 +113,7 @@ module Sentdm
       optional :sending_phone_number, String, nil?: true
 
       # @!attribute sending_phone_number_profile_id
-      #   Reference to another profile for SMS/Telnyx configuration
+      #   Reference to another profile whose SMS configuration this profile uses
       #
       #   @return [String, nil]
       optional :sending_phone_number_profile_id, String, nil?: true
@@ -198,7 +198,7 @@ module Sentdm
       #
       #   @param sending_phone_number [String, nil] Direct SMS phone number
       #
-      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile for SMS/Telnyx configuration
+      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile whose SMS configuration this profile uses
       #
       #   @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile for WhatsApp configuration
       #
@@ -276,7 +276,12 @@ module Sentdm
         optional :created_at, Time
 
         # @!attribute csp_id
-        #   CSP (Campaign Service Provider) ID
+        #   @deprecated
+        #
+        #   Deprecated and scheduled for removal. Identifies the Campaign Service Provider
+        #   that registered the brand, which is Sent, so the value is the same for every
+        #   brand and every account. Nothing on your side can act on it and there is no
+        #   replacement. Stop reading it.
         #
         #   @return [String, nil]
         optional :csp_id, String, nil?: true
@@ -328,6 +333,9 @@ module Sentdm
         optional :updated_at, Time, nil?: true
 
         # @!method initialize(id: nil, business: nil, compliance: nil, contact: nil, created_at: nil, csp_id: nil, identity_status: nil, is_inherited: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ProfileDetail::Brand} for more details.
+        #
         #   Brand response with nested contact, business, and compliance sections — mirrors
         #   the request structure.
         #
@@ -341,7 +349,7 @@ module Sentdm
         #
         #   @param created_at [Time] When the brand was created
         #
-        #   @param csp_id [String, nil] CSP (Campaign Service Provider) ID
+        #   @param csp_id [String, nil] Deprecated and scheduled for removal. Identifies the Campaign Service Provider t
         #
         #   @param identity_status [Symbol, Sentdm::Models::ProfileDetail::Brand::IdentityStatus, nil]
         #
@@ -466,12 +474,6 @@ module Sentdm
           #   @return [Array<Sentdm::Models::DestinationCountry>, nil]
           optional :destination_countries, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] }
 
-          # @!attribute expected_messaging_volume
-          #   Expected daily messaging volume
-          #
-          #   @return [String, nil]
-          optional :expected_messaging_volume, String, nil?: true
-
           # @!attribute is_tcr_application
           #   Whether this is a TCR (Campaign Registry) application
           #
@@ -501,15 +503,13 @@ module Sentdm
           #   @return [Symbol, Sentdm::Models::TcrVertical, nil]
           optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true
 
-          # @!method initialize(brand_relationship: nil, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
+          # @!method initialize(brand_relationship: nil, destination_countries: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
           #   Compliance and TCR-related information
           #
           #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
           #
           #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>] List of destination countries for messaging
           #
-          #   @param expected_messaging_volume [String, nil] Expected daily messaging volume
-          #
           #   @param is_tcr_application [Boolean] Whether this is a TCR (Campaign Registry) application
           #
           #   @param notes [String, nil] Additional notes about the business or use case

data/lib/sentdm/models/profile_update_params.rb

@@ -119,7 +119,7 @@ module Sentdm
       optional :sending_phone_number, String, nil?: true
 
       # @!attribute sending_phone_number_profile_id
-      #   Reference to another profile to use for SMS/Telnyx configuration (optional)
+      #   Reference to another profile to use for SMS configuration (optional)
       #
       #   @return [String, nil]
       optional :sending_phone_number_profile_id, String, nil?: true
@@ -192,7 +192,7 @@ module Sentdm
       #
       #   @param sending_phone_number [String, nil] Direct phone number for SMS sending (optional)
       #
-      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile to use for SMS/Telnyx configuration (optional)
+      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile to use for SMS configuration (optional)
       #
       #   @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile to use for WhatsApp configuration (optional)
       #

data/lib/sentdm/models/profiles/{api_response_of_tcr_campaign_with_use_cases.rb → api_response_of_brand_campaign.rb}

@@ -4,12 +4,12 @@ module Sentdm
   module Models
     module Profiles
       # @see Sentdm::Resources::Profiles::Campaigns#create
-      class APIResponseOfTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
+      class APIResponseOfBrandCampaign < Sentdm::Internal::Type::BaseModel
         # @!attribute data
-        #   The response data (null if error)
+        #   A 10DLC campaign registered for a brand.
         #
-        #   @return [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil]
-        optional :data, -> { Sentdm::Profiles::TcrCampaignWithUseCases }, nil?: true
+        #   @return [Sentdm::Models::Profiles::BrandCampaign, nil]
+        optional :data, -> { Sentdm::Profiles::BrandCampaign }, nil?: true
 
         # @!attribute error
         #   Error information
@@ -32,7 +32,7 @@ module Sentdm
         # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
         #   Standard API response envelope for all v3 endpoints
         #
-        #   @param data [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil] The response data (null if error)
+        #   @param data [Sentdm::Models::Profiles::BrandCampaign, nil] A 10DLC campaign registered for a brand.
         #
         #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
         #