rcs 2.0.0.pre.rc.4 → 2.0.0

data/lib/rcs/types/button_clicked_data.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "button_clicked_data_button"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Unified data structure for button click events.
+    class ButtonClickedData
+      # @return [Pinnacle::Types::ButtonClickedDataButton] Information about the button that was clicked.
+      attr_reader :button
+      # @return [String] ID of the message this button was sent in, or null if not available. To get the
+      #  message details, use the [GET /messages/{id}](/api-reference/messages/get)
+      #  endpoint.
+      attr_reader :message_id
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param button [Pinnacle::Types::ButtonClickedDataButton] Information about the button that was clicked.
+      # @param message_id [String] ID of the message this button was sent in, or null if not available. To get the
+      #  message details, use the [GET /messages/{id}](/api-reference/messages/get)
+      #  endpoint.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ButtonClickedData]
+      def initialize(button:, message_id: OMIT, additional_properties: nil)
+        @button = button
+        @message_id = message_id if message_id != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "button": button, "messageId": message_id }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of ButtonClickedData
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ButtonClickedData]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["button"].nil?
+          button = nil
+        else
+          button = parsed_json["button"].to_json
+          button = Pinnacle::Types::ButtonClickedDataButton.from_json(json_object: button)
+        end
+        message_id = parsed_json["messageId"]
+        new(
+          button: button,
+          message_id: message_id,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ButtonClickedData to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        Pinnacle::Types::ButtonClickedDataButton.validate_raw(obj: obj.button)
+        obj.message_id&.is_a?(String) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/button_clicked_data_button.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative "button_clicked_data_button_type"
+require_relative "button_clicked_data_button_raw"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Information about the button that was clicked.
+    class ButtonClickedDataButton
+      # @return [Pinnacle::Types::ButtonClickedDataButtonType] Type of button clicked.
+      #  - `CARD` for card buttons,
+      #  - `QUICK_REPLY` for quick replies.
+      #  - `null` if we cannot determine the button type. This is a rare edge case and is
+      #  mainly here for backward compatibility.
+      attr_reader :type
+      # @return [Pinnacle::Types::ButtonClickedDataButtonRaw] Raw button data. Contains the entire button that was clicked by the user. In
+      #  rare cases where we cannot determine the exact button, this will return only the
+      #  button title.
+      attr_reader :raw
+      # @return [String] Extracted payload from the button's `payload` field, if provided. Provides quick
+      #  access to any payload that was attached to the button.
+      attr_reader :payload
+      # @return [String] Additional metadata attached to the button's `metadata` field, if provided.
+      attr_reader :metadata
+      # @return [Integer] Number of times the button has been clicked.
+      attr_reader :clicks
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param type [Pinnacle::Types::ButtonClickedDataButtonType] Type of button clicked.
+      #  - `CARD` for card buttons,
+      #  - `QUICK_REPLY` for quick replies.
+      #  - `null` if we cannot determine the button type. This is a rare edge case and is
+      #  mainly here for backward compatibility.
+      # @param raw [Pinnacle::Types::ButtonClickedDataButtonRaw] Raw button data. Contains the entire button that was clicked by the user. In
+      #  rare cases where we cannot determine the exact button, this will return only the
+      #  button title.
+      # @param payload [String] Extracted payload from the button's `payload` field, if provided. Provides quick
+      #  access to any payload that was attached to the button.
+      # @param metadata [String] Additional metadata attached to the button's `metadata` field, if provided.
+      # @param clicks [Integer] Number of times the button has been clicked.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ButtonClickedDataButton]
+      def initialize(raw:, clicks:, type: OMIT, payload: OMIT, metadata: OMIT, additional_properties: nil)
+        @type = type if type != OMIT
+        @raw = raw
+        @payload = payload if payload != OMIT
+        @metadata = metadata if metadata != OMIT
+        @clicks = clicks
+        @additional_properties = additional_properties
+        @_field_set = {
+          "type": type,
+          "raw": raw,
+          "payload": payload,
+          "metadata": metadata,
+          "clicks": clicks
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of ButtonClickedDataButton
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ButtonClickedDataButton]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        type = parsed_json["type"]
+        if parsed_json["raw"].nil?
+          raw = nil
+        else
+          raw = parsed_json["raw"].to_json
+          raw = Pinnacle::Types::ButtonClickedDataButtonRaw.from_json(json_object: raw)
+        end
+        payload = parsed_json["payload"]
+        metadata = parsed_json["metadata"]
+        clicks = parsed_json["clicks"]
+        new(
+          type: type,
+          raw: raw,
+          payload: payload,
+          metadata: metadata,
+          clicks: clicks,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ButtonClickedDataButton to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.type&.is_a?(Pinnacle::Types::ButtonClickedDataButtonType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        Pinnacle::Types::ButtonClickedDataButtonRaw.validate_raw(obj: obj.raw)
+        obj.payload&.is_a?(String) != false || raise("Passed value for field obj.payload is not the expected type, validation failed.")
+        obj.metadata&.is_a?(String) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+        obj.clicks.is_a?(Integer) != false || raise("Passed value for field obj.clicks is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/{click_action_data.rb → button_clicked_data_button_raw.rb}

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "click_action_data_metadata"
+require_relative "rich_button"
 
 module Pinnacle
   module Types
-    # Payload received from the button interaction.
-    class ClickActionData
-      # Deserialize a JSON object to an instance of ClickActionData
+    # Raw button data. Contains the entire button that was clicked by the user. In
+    #  rare cases where we cannot determine the exact button, this will return only the
+    #  button title.
+    class ButtonClickedDataButtonRaw
+      # Deserialize a JSON object to an instance of ButtonClickedDataButtonRaw
       #
       # @param json_object [String]
-      # @return [Pinnacle::Types::ClickActionData]
+      # @return [Pinnacle::Types::ButtonClickedDataButtonRaw]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         begin
-          Pinnacle::Types::ClickActionDataMetadata.validate_raw(obj: struct)
-          return Pinnacle::Types::ClickActionDataMetadata.from_json(json_object: struct) unless struct.nil?
+          Pinnacle::Types::RichButton.validate_raw(obj: struct)
+          return Pinnacle::Types::RichButton.from_json(json_object: struct) unless struct.nil?
 
           return nil
         rescue StandardError
@@ -40,7 +42,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         begin
-          return Pinnacle::Types::ClickActionDataMetadata.validate_raw(obj: obj)
+          return Pinnacle::Types::RichButton.validate_raw(obj: obj)
         rescue StandardError
           # noop
         end

data/lib/rcs/types/button_clicked_data_button_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Type of button clicked.
+    #  - `CARD` for card buttons,
+    #  - `QUICK_REPLY` for quick replies.
+    #  - `null` if we cannot determine the button type. This is a rare edge case and is
+    #  mainly here for backward compatibility.
+    class ButtonClickedDataButtonType
+      CARD = "CARD"
+      QUICK_REPLY = "QUICK_REPLY"
+    end
+  end
+end

data/lib/rcs/types/campaign_query.rb

@@ -8,7 +8,11 @@ module Pinnacle
   module Types
     # Information about the campaign associated with a conversation
     class CampaignQuery
-      # @return [String] Unique identifier for the campaign
+      # @return [String] Unique identifier for the campaign. This identifier is a string that begins with
+      #  the prefix:
+      #  - TOLL_FREE: `tf_` (e.g., `tf_1234567890`)
+      #  - 10DLC: `dlc_` (e.g., `dlc_1234567890`)
+      #  - RCS: `rcs_` (e.g., `rcs_1234567890`)
       attr_reader :id
       # @return [Pinnacle::Types::CampaignEnum]
       attr_reader :type
@@ -20,7 +24,11 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [String] Unique identifier for the campaign
+      # @param id [String] Unique identifier for the campaign. This identifier is a string that begins with
+      #  the prefix:
+      #  - TOLL_FREE: `tf_` (e.g., `tf_1234567890`)
+      #  - 10DLC: `dlc_` (e.g., `dlc_1234567890`)
+      #  - RCS: `rcs_` (e.g., `rcs_1234567890`)
       # @param type [Pinnacle::Types::CampaignEnum]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::CampaignQuery]

data/lib/rcs/types/contact.rb

@@ -10,7 +10,8 @@ module Pinnacle
       attr_reader :description
       # @return [String] Contact's email address, if available.
       attr_reader :email
-      # @return [Integer] Unique ID of the contact.
+      # @return [String] Unique ID of the contact. This identifier is a string that always begins with
+      #  the prefix `co_`, for example: `co_1234567890`.
       attr_reader :id
       # @return [String] Full name of the contact, if available.
       attr_reader :name
@@ -28,7 +29,8 @@ module Pinnacle
 
       # @param description [String] Additional information about the contact.
       # @param email [String] Contact's email address, if available.
-      # @param id [Integer] Unique ID of the contact.
+      # @param id [String] Unique ID of the contact. This identifier is a string that always begins with
+      #  the prefix `co_`, for example: `co_1234567890`.
       # @param name [String] Full name of the contact, if available.
       # @param phone_number [String] Contact's phone number in E.164 format.
       # @param tags [Array<String>] List of tags associated with the contact.
@@ -95,7 +97,7 @@ module Pinnacle
       def self.validate_raw(obj:)
         obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
         obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
         obj.tags&.is_a?(Array) != false || raise("Passed value for field obj.tags is not the expected type, validation failed.")

data/lib/rcs/types/contact_id.rb

@@ -6,7 +6,8 @@ require "json"
 module Pinnacle
   module Types
     class ContactId
-      # @return [Integer] Unique ID of the created contact.
+      # @return [String] Unique ID of the created contact. This identifier is a string that always begins
+      #  with the prefix `co_`, for example: `co_1234567890`.
       attr_reader :id
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -16,7 +17,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Unique ID of the created contact.
+      # @param id [String] Unique ID of the created contact. This identifier is a string that always begins
+      #  with the prefix `co_`, for example: `co_1234567890`.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ContactId]
       def initialize(id:, additional_properties: nil)
@@ -50,7 +52,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/conversation.rb

@@ -10,15 +10,19 @@ module Pinnacle
   module Types
     # Conversation that was found.
     class Conversation
-      # @return [Integer] Identifier for the brand associated with this conversation.
+      # @return [String] The unique identifier of the brand associated with this conversation. This
+      #  identifier is a string that always begins with the prefix `b_`, for example:
+      #  `b_1234567890`.
       attr_reader :brand_id
-      # @return [Pinnacle::Types::CampaignQuery] Campaign information if this conversation is part of a marketing campaign.
+      # @return [Pinnacle::Types::CampaignQuery] Campaign information if this conversation is part of a marketing campaign. This
+      #  is an object that contains the campaign ID and type.
       attr_reader :campaign
       # @return [Pinnacle::Types::ConversationContact] Contact information for the recipient in a conversation.
       attr_reader :contact
       # @return [String] ISO 8601 timestamp when the conversation was created.
       attr_reader :created_at
-      # @return [Integer] Unique identifier for the conversation.
+      # @return [String] Unique identifier for the conversation. This identifier is a string that always
+      #  begins with the prefix `conv_`, for example: `conv_1234567890`.
       attr_reader :id
       # @return [String] Free-form notes or comments about the conversation.
       attr_reader :notes
@@ -37,11 +41,15 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param brand_id [Integer] Identifier for the brand associated with this conversation.
-      # @param campaign [Pinnacle::Types::CampaignQuery] Campaign information if this conversation is part of a marketing campaign.
+      # @param brand_id [String] The unique identifier of the brand associated with this conversation. This
+      #  identifier is a string that always begins with the prefix `b_`, for example:
+      #  `b_1234567890`.
+      # @param campaign [Pinnacle::Types::CampaignQuery] Campaign information if this conversation is part of a marketing campaign. This
+      #  is an object that contains the campaign ID and type.
       # @param contact [Pinnacle::Types::ConversationContact] Contact information for the recipient in a conversation.
       # @param created_at [String] ISO 8601 timestamp when the conversation was created.
-      # @param id [Integer] Unique identifier for the conversation.
+      # @param id [String] Unique identifier for the conversation. This identifier is a string that always
+      #  begins with the prefix `conv_`, for example: `conv_1234567890`.
       # @param notes [String] Free-form notes or comments about the conversation.
       # @param sender [Pinnacle::Types::ConversationSender] The sender of messages in this conversation. Can be:
       #  - A phone number with its capabilities and metadata
@@ -132,11 +140,11 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.brand_id&.is_a?(Integer) != false || raise("Passed value for field obj.brand_id is not the expected type, validation failed.")
+        obj.brand_id&.is_a?(String) != false || raise("Passed value for field obj.brand_id is not the expected type, validation failed.")
         obj.campaign.nil? || Pinnacle::Types::CampaignQuery.validate_raw(obj: obj.campaign)
         Pinnacle::Types::ConversationContact.validate_raw(obj: obj.contact)
         obj.created_at.is_a?(String) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.notes.is_a?(String) != false || raise("Passed value for field obj.notes is not the expected type, validation failed.")
         obj.sender.nil? || Pinnacle::Types::ConversationSender.validate_raw(obj: obj.sender)
         obj.updated_at.is_a?(String) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")

data/lib/rcs/types/conversation_by_id_params.rb

@@ -7,7 +7,9 @@ module Pinnacle
   module Types
     # Retrieve conversation information by ID.
     class ConversationByIdParams
-      # @return [Integer] Unique identifier of the conversation you want to retrieve.
+      # @return [String] Unique identifier of the conversation you want to retrieve. This identifier is a
+      #  string that always begins with the prefix `conv_`, for example:
+      #  `conv_1234567890`.
       attr_reader :id
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -17,7 +19,9 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Unique identifier of the conversation you want to retrieve.
+      # @param id [String] Unique identifier of the conversation you want to retrieve. This identifier is a
+      #  string that always begins with the prefix `conv_`, for example:
+      #  `conv_1234567890`.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ConversationByIdParams]
       def initialize(id:, additional_properties: nil)
@@ -51,7 +55,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/conversation_contact.rb

@@ -7,7 +7,8 @@ module Pinnacle
   module Types
     # Contact information for the recipient in a conversation.
     class ConversationContact
-      # @return [Integer] Unique identifier for the contact.
+      # @return [String] Unique ID of the contact. This identifier is a string that always begins with
+      #  the prefix `co_`, for example: `co_1234567890`.
       attr_reader :id
       # @return [String] The contact's phone number in E.164 format.
       attr_reader :phone_number
@@ -19,7 +20,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Unique identifier for the contact.
+      # @param id [String] Unique ID of the contact. This identifier is a string that always begins with
+      #  the prefix `co_`, for example: `co_1234567890`.
       # @param phone_number [String] The contact's phone number in E.164 format.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ConversationContact]
@@ -60,7 +62,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/create_url_options.rb

@@ -7,7 +7,8 @@ module Pinnacle
   module Types
     class CreateUrlOptions
       # @return [String] Expiration date in ISO 8601 format for the shortened URL. <br>
-      #  If omitted, then a permalink is generated instead.
+      #  If omitted, then a permalink is generated instead. Short permalinks contain a
+      #  30-digit link id. Short links with an expiration date contain a 8-digit link id.
       attr_reader :expires_at
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -18,7 +19,8 @@ module Pinnacle
       OMIT = Object.new
 
       # @param expires_at [String] Expiration date in ISO 8601 format for the shortened URL. <br>
-      #  If omitted, then a permalink is generated instead.
+      #  If omitted, then a permalink is generated instead. Short permalinks contain a
+      #  30-digit link id. Short links with an expiration date contain a 8-digit link id.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::CreateUrlOptions]
       def initialize(expires_at: OMIT, additional_properties: nil)

data/lib/rcs/types/detached_webhook_info.rb

@@ -8,7 +8,8 @@ module Pinnacle
     class DetachedWebhookInfo
       # @return [String] Confirmation message.
       attr_reader :message
-      # @return [Integer] ID of the detached webhook.
+      # @return [String] Unique identifier of the webhook within the account. This identifier is a string
+      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
       attr_reader :webhook_id
       # @return [String] Phone number the webhook was detached from in E.164 format.
       attr_reader :phone_number
@@ -21,7 +22,8 @@ module Pinnacle
       OMIT = Object.new
 
       # @param message [String] Confirmation message.
-      # @param webhook_id [Integer] ID of the detached webhook.
+      # @param webhook_id [String] Unique identifier of the webhook within the account. This identifier is a string
+      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
       # @param phone_number [String] Phone number the webhook was detached from in E.164 format.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::DetachedWebhookInfo]
@@ -66,7 +68,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
-        obj.webhook_id.is_a?(Integer) != false || raise("Passed value for field obj.webhook_id is not the expected type, validation failed.")
+        obj.webhook_id.is_a?(String) != false || raise("Passed value for field obj.webhook_id is not the expected type, validation failed.")
         obj.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/dlc_campaign_status.rb

@@ -13,7 +13,8 @@ module Pinnacle
       #  These errors may request additional information or point out erroneous and/or
       #  missing fields.
       attr_reader :error
-      # @return [Integer] Id of the DLC campaign.
+      # @return [String] The unique identifier of the 10DLC campaign. This identifier is a string that
+      #  always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       attr_reader :id
       # @return [Pinnacle::Types::ProfileStatusEnum] Current review status of the DLC campaign. <br>
       #  `INCOMPLETE`: Not submitted.<br>
@@ -22,7 +23,7 @@ module Pinnacle
       #  `FAILED`: Issues and errors related to the campaign's details. See
       #  [error](dlc-campaign#response.body.error) for these potential issues.
       attr_reader :status
-      # @return [Pinnacle::Types::GetDlcCampaignStatusResponseUpdates] Status of toll free numbers that are being attached to this campaign. <br>
+      # @return [Pinnacle::Types::GetDlcCampaignStatusResponseUpdates] Status of local long code numbers that are being attached to this campaign. <br>
       #  Note that phone numbers can only be attached to `VERIFIED` campaigns via the
       #  [attach campaign endpoint](../phone-numbers/attach-campaign).
       attr_reader :updates
@@ -37,14 +38,15 @@ module Pinnacle
       # @param error [String] Summary of errors related to the verification process. <br>
       #  These errors may request additional information or point out erroneous and/or
       #  missing fields.
-      # @param id [Integer] Id of the DLC campaign.
+      # @param id [String] The unique identifier of the 10DLC campaign. This identifier is a string that
+      #  always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param status [Pinnacle::Types::ProfileStatusEnum] Current review status of the DLC campaign. <br>
       #  `INCOMPLETE`: Not submitted.<br>
       #  `IN REVIEW`: Being reviewed by carriers.<br>
       #  `VERIFIED`: Approved and ready to send messages.<br>
       #  `FAILED`: Issues and errors related to the campaign's details. See
       #  [error](dlc-campaign#response.body.error) for these potential issues.
-      # @param updates [Pinnacle::Types::GetDlcCampaignStatusResponseUpdates] Status of toll free numbers that are being attached to this campaign. <br>
+      # @param updates [Pinnacle::Types::GetDlcCampaignStatusResponseUpdates] Status of local long code numbers that are being attached to this campaign. <br>
       #  Note that phone numbers can only be attached to `VERIFIED` campaigns via the
       #  [attach campaign endpoint](../phone-numbers/attach-campaign).
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
@@ -98,7 +100,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.error.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         Pinnacle::Types::GetDlcCampaignStatusResponseUpdates.validate_raw(obj: obj.updates)
       end

data/lib/rcs/types/dlc_campaign_with_extended_brand_and_status.rb

@@ -17,7 +17,8 @@ module Pinnacle
       attr_reader :auto_renew
       # @return [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
       attr_reader :brand
-      # @return [Integer] Unique identifier for the campaign.
+      # @return [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       attr_reader :campaign_id
       # @return [String] Description of the campaign.
       attr_reader :description
@@ -33,11 +34,11 @@ module Pinnacle
       attr_reader :options
       # @return [Array<String>] Example messages for the campaign.
       attr_reader :sample_messages
-      # @return [Pinnacle::Types::ProfileStatusEnum] Current review status of the campaign.<br>
-      #  `INCOMPLETE`: Not submitted.<br>
-      #  `IN REVIEW`: Being reviewed by carriers.<br>
-      #  `VERIFIED`: Approved and ready to send messages.<br>
-      #  `FAILED`: Issues and errors related to the campaign's details.<br>
+      # @return [Pinnacle::Types::ProfileStatusEnum] Current review status of the campaign. <br>
+      #  `INCOMPLETE`: Not submitted. <br>
+      #  `IN REVIEW`: Being reviewed by carriers. <br>
+      #  `VERIFIED`: Approved and ready to send messages. <br>
+      #  `FAILED`: Issues and errors related to the campaign's details.
       attr_reader :status
       # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase] Use case for the campaign.
       attr_reader :use_case
@@ -51,7 +52,8 @@ module Pinnacle
 
       # @param auto_renew [Boolean] Whether the campaign renews automatically.
       # @param brand [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
-      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param campaign_id [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param description [String] Description of the campaign.
       # @param keywords [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords] Keyword response configuration.
       # @param links [Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks] Legal documentation links.
@@ -59,25 +61,25 @@ module Pinnacle
       # @param name [String] Display name of the campaign.
       # @param options [Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions] Campaign configuration options.
       # @param sample_messages [Array<String>] Example messages for the campaign.
-      # @param status [Pinnacle::Types::ProfileStatusEnum] Current review status of the campaign.<br>
-      #  `INCOMPLETE`: Not submitted.<br>
-      #  `IN REVIEW`: Being reviewed by carriers.<br>
-      #  `VERIFIED`: Approved and ready to send messages.<br>
-      #  `FAILED`: Issues and errors related to the campaign's details.<br>
+      # @param status [Pinnacle::Types::ProfileStatusEnum] Current review status of the campaign. <br>
+      #  `INCOMPLETE`: Not submitted. <br>
+      #  `IN REVIEW`: Being reviewed by carriers. <br>
+      #  `VERIFIED`: Approved and ready to send messages. <br>
+      #  `FAILED`: Issues and errors related to the campaign's details.
       # @param use_case [Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase] Use case for the campaign.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
-      def initialize(auto_renew:, brand:, status:, campaign_id: OMIT, description: OMIT, keywords: OMIT, links: OMIT,
-                     message_flow: OMIT, name: OMIT, options: OMIT, sample_messages: OMIT, use_case: OMIT, additional_properties: nil)
+      def initialize(auto_renew:, brand:, keywords:, options:, status:, campaign_id: OMIT, description: OMIT, links: OMIT,
+                     message_flow: OMIT, name: OMIT, sample_messages: OMIT, use_case: OMIT, additional_properties: nil)
         @auto_renew = auto_renew
         @brand = brand
         @campaign_id = campaign_id if campaign_id != OMIT
         @description = description if description != OMIT
-        @keywords = keywords if keywords != OMIT
+        @keywords = keywords
         @links = links if links != OMIT
         @message_flow = message_flow if message_flow != OMIT
         @name = name if name != OMIT
-        @options = options if options != OMIT
+        @options = options
         @sample_messages = sample_messages if sample_messages != OMIT
         @status = status
         @use_case = use_case if use_case != OMIT
@@ -178,13 +180,13 @@ module Pinnacle
       def self.validate_raw(obj:)
         obj.auto_renew.is_a?(Boolean) != false || raise("Passed value for field obj.auto_renew is not the expected type, validation failed.")
         Pinnacle::Types::ExtendedBrand.validate_raw(obj: obj.brand)
-        obj.campaign_id&.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
+        obj.campaign_id&.is_a?(String) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
         obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-        obj.keywords.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords.validate_raw(obj: obj.keywords)
+        Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords.validate_raw(obj: obj.keywords)
         obj.links.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks.validate_raw(obj: obj.links)
         obj.message_flow&.is_a?(String) != false || raise("Passed value for field obj.message_flow is not the expected type, validation failed.")
         obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-        obj.options.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions.validate_raw(obj: obj.options)
+        Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions.validate_raw(obj: obj.options)
         obj.sample_messages&.is_a?(Array) != false || raise("Passed value for field obj.sample_messages is not the expected type, validation failed.")
         obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.use_case.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase.validate_raw(obj: obj.use_case)