rcs 2.0.0.pre.rc.4 → 2.0.0.pre.rc.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5359c70f9a7ce7a7288024ad6d7aefaef2cef5d9a03beb3e3afd62671c7db723
-  data.tar.gz: be2848caca8ff4126d3f9ec0c84e30902721a85b7a81b37bc0dbf4c81f436bfe
+  metadata.gz: 262806a75a52a70e37dd92a0036ba70af3a59aa98ea132dd60f2dad6cbe2c95a
+  data.tar.gz: 5dcd700d3f9a65f9dfa3bd4551773fb8fa6789f39e998b053eef877fc95daf70
 SHA512:
-  metadata.gz: 59f56e2b8c19d78d55c9065e958184f2046d3ea5bfa3486d3fce065e330835c4dad35c4fbefc82fb97b6e7c456eb6aecad8fb851a20c890b8ef7292bff05e4b4
-  data.tar.gz: b1c510a805a9614cffbefd1f44a0e1dc22008a9435252e5f70b792fb8dd003b6e000f92f150035860b1430df88d21b5de9111e490addcb87f654bfc1cdfa21a9
+  metadata.gz: af03848b61375c06cd367fa1b2609616568daba7e7858e377e7f03cfb68f34f9d26b9681bbd9eb94164e48a35219db9932a260feebe59d4f0317243e4ee42e38
+  data.tar.gz: 82b3b96ff4b841b1cd3078487f938d01105639414d0bb0950728081aec53b0cd93ea570f8596445c7886d0fee6e38a492bfd6df60040bb82a1b87233ee588d96

data/lib/rcs/campaigns/dlc/client.rb

@@ -58,9 +58,9 @@ module Pinnacle
         Pinnacle::Types::AutofillDlcCampaignResponse.from_json(json_object: response.body)
       end
 
-      # Retrieve DLC campaign.
+      # Retrieve 10DLC campaign.
       #
-      # @param campaign_id [Integer] Unique identifier of the DLC campaign.
+      # @param campaign_id [Integer] Unique identifier of the 10DLC campaign.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
       # @example
@@ -90,9 +90,9 @@ module Pinnacle
         Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
       end
 
-      # Submit your DLC campaign for approval and activation with carriers.
+      # Submit your 10DLC campaign for approval and activation with carriers.
       #
-      # @param campaign_id [Integer] Unique identifier of the DLC campaign to submit.
+      # @param campaign_id [Integer] Unique identifier of the 10DLC campaign to submit.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignSubmissionResult]
       # @example
@@ -122,7 +122,7 @@ module Pinnacle
         Pinnacle::Types::CampaignSubmissionResult.from_json(json_object: response.body)
       end
 
-      # Create a new DLC campaign or updates an existing one. <br>
+      # Create a new 10DLC campaign or updates an existing one. <br>
       #  Omit campaignId to create a campaign.
       #
       # @param auto_renew [Boolean] Whether the campaign renews automatically.
@@ -207,7 +207,7 @@ module Pinnacle
         Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
       end
 
-      # Validate your DLC campaign configuration against carrier requirements and
+      # Validate your 10DLC campaign configuration against carrier requirements and
       #  compliance rules.
       #
       # @param request [Hash] Request of type Pinnacle::Types::ValidateCampaignParams, as a Hash
@@ -286,9 +286,9 @@ module Pinnacle
         end
       end
 
-      # Retrieve DLC campaign.
+      # Retrieve 10DLC campaign.
       #
-      # @param campaign_id [Integer] Unique identifier of the DLC campaign.
+      # @param campaign_id [Integer] Unique identifier of the 10DLC campaign.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
       # @example
@@ -320,9 +320,9 @@ module Pinnacle
         end
       end
 
-      # Submit your DLC campaign for approval and activation with carriers.
+      # Submit your 10DLC campaign for approval and activation with carriers.
       #
-      # @param campaign_id [Integer] Unique identifier of the DLC campaign to submit.
+      # @param campaign_id [Integer] Unique identifier of the 10DLC campaign to submit.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::CampaignSubmissionResult]
       # @example
@@ -354,7 +354,7 @@ module Pinnacle
         end
       end
 
-      # Create a new DLC campaign or updates an existing one. <br>
+      # Create a new 10DLC campaign or updates an existing one. <br>
       #  Omit campaignId to create a campaign.
       #
       # @param auto_renew [Boolean] Whether the campaign renews automatically.
@@ -441,7 +441,7 @@ module Pinnacle
         end
       end
 
-      # Validate your DLC campaign configuration against carrier requirements and
+      # Validate your 10DLC campaign configuration against carrier requirements and
       #  compliance rules.
       #
       # @param request [Hash] Request of type Pinnacle::Types::ValidateCampaignParams, as a Hash

data/lib/rcs/campaigns/rcs/types/upsert_rcs_agent.rb

@@ -19,9 +19,9 @@ module Pinnacle
           attr_reader :description
           # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails (1-3 required).
           attr_reader :emails
-          # @return [String] Link to the agent's hero.
+          # @return [String] Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
           attr_reader :hero_url
-          # @return [String] Link to the agent's icon.
+          # @return [String] Link to the agent's icon. Icon must be an image file with dimensions 224x224px.
           attr_reader :icon_url
           # @return [String] Name of the agent.
           attr_reader :name
@@ -41,8 +41,8 @@ module Pinnacle
           #  Must have sufficient contrast with white.
           # @param description [String] Description of the agent.
           # @param emails [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails (1-3 required).
-          # @param hero_url [String] Link to the agent's hero.
-          # @param icon_url [String] Link to the agent's icon.
+          # @param hero_url [String] Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
+          # @param icon_url [String] Link to the agent's icon. Icon must be an image file with dimensions 224x224px.
           # @param name [String] Name of the agent.
           # @param phones [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>] List of phone numbers (1-3 required).
           # @param websites [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>] List of urls (1-3 required).

data/lib/rcs/conversations/client.rb

@@ -61,7 +61,7 @@ module Pinnacle
     # @param receiver [String] Receiver's phone number in E.164 format.
     # @param sender [String]
     # @param request_options [Pinnacle::RequestOptions]
-    # @return [Pinnacle::Types::ConversationList]
+    # @return [Pinnacle::Types::ErrorResponse, Pinnacle::Types::RetrievedConversations]
     # @example
     #  api = Pinnacle::Client.new(
     #    base_url: "https://api.example.com",
@@ -191,7 +191,7 @@ module Pinnacle
     # @param receiver [String] Receiver's phone number in E.164 format.
     # @param sender [String]
     # @param request_options [Pinnacle::RequestOptions]
-    # @return [Pinnacle::Types::ConversationList]
+    # @return [Pinnacle::Types::ErrorResponse, Pinnacle::Types::RetrievedConversations]
     # @example
     #  api = Pinnacle::Client.new(
     #    base_url: "https://api.example.com",

data/lib/rcs/messages/mms/client.rb

@@ -28,7 +28,7 @@ module Pinnacle
       # @param options [Hash] Control how your MMS is processed and delivered.Request of type Pinnacle::Messages::Mms::Types::SendMmsOptions, as a Hash
       #   * :multiple_messages (Boolean)
       #   * :schedule (Hash)
-      #     * :end_date (DateTime)
+      #     * :end_date (String)
       #     * :recurrence (String)
       #     * :send_at (String)
       #     * :timezone (String)
@@ -128,7 +128,7 @@ module Pinnacle
       # @param options [Hash] Control how your MMS is processed and delivered.Request of type Pinnacle::Messages::Mms::Types::SendMmsOptions, as a Hash
       #   * :multiple_messages (Boolean)
       #   * :schedule (Hash)
-      #     * :end_date (DateTime)
+      #     * :end_date (String)
       #     * :recurrence (String)
       #     * :send_at (String)
       #     * :timezone (String)

data/lib/rcs/messages/sms/client.rb

@@ -24,7 +24,7 @@ module Pinnacle
       # @param from [String] Phone number that sends the message in E.164 format.
       # @param options [Hash] Additional settings to customize SMS delivery.Request of type Pinnacle::Messages::Sms::Types::SendSmsOptions, as a Hash
       #   * :schedule (Hash)
-      #     * :end_date (DateTime)
+      #     * :end_date (String)
       #     * :recurrence (String)
       #     * :send_at (String)
       #     * :timezone (String)
@@ -115,7 +115,7 @@ module Pinnacle
       # @param from [String] Phone number that sends the message in E.164 format.
       # @param options [Hash] Additional settings to customize SMS delivery.Request of type Pinnacle::Messages::Sms::Types::SendSmsOptions, as a Hash
       #   * :schedule (Hash)
-      #     * :end_date (DateTime)
+      #     * :end_date (String)
       #     * :recurrence (String)
       #     * :send_at (String)
       #     * :timezone (String)

data/lib/rcs/rcs/client.rb

@@ -0,0 +1,316 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/rcs_capabilities_result"
+require "json"
+require_relative "../types/rcs_whitelist_response"
+require_relative "../types/rcs_link_result"
+require "async"
+
+module Pinnacle
+  class RcsClient
+    # @return [Pinnacle::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Pinnacle::RequestClient]
+    # @return [Pinnacle::RcsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Check RCS capabilities for one or more phone numbers.
+    #  This endpoint allows you to verify which RCS features (cards, buttons, etc.) are
+    #  supported
+    #  on specific phone numbers before sending RCS messages to them.
+    #
+    # @param phone_numbers [Array<String>] List of phone numbers to check RCS capabilities for (E.164 format)
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::RCS_CAPABILITIES_RESULT]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.rcs.get_capabilities(phone_numbers: ["+12345678901", "+19876543210"])
+    def get_capabilities(phone_numbers:, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = { **(request_options&.additional_body_parameters || {}), phoneNumbers: phone_numbers }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/rcs/capabilities"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.transform_values do |value|
+        value = value.to_json
+        Pinnacle::Types::RcsCapability.from_json(json_object: value)
+      end
+    end
+
+    # Whitelist a phone number for testing with your test RCS agent.
+    #  ## Overview
+    #  During development and testing, RCS agents can only send messages to whitelisted
+    #  phone numbers.
+    #  Use this endpoint to add test devices to your agent's whitelist before sending
+    #  test messages.
+    #  ## Verification Process
+    #  After whitelisting a number, you'll need to complete verification:
+    #  1. Check the test device for an "RBM Tester Management" request
+    #  2. Accept the request on the device
+    #  3. Enter the 4-digit verification code in the Pinnacle dashboard at:
+    #  ```
+    #  .pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
+    #  ```
+    #  > **Important Notes**
+    #  >
+    #  > - **Testing only:** This is only required for test agents. Production agents
+    #  can message any RCS-enabled number
+    #  > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
+    #  > - **Verification required:** The whitelist request isn't complete until you
+    #  verify the device.
+    #
+    # @param agent_id [String] The RCS agent ID (must be prefixed with 'agent_')
+    # @param phone_number [String] Phone number to whitelist for testing (E.164 format)
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::RcsWhitelistResponse]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.rcs.whitelist(agent_id: "agent_XXXXXXXXXXXX", phone_number: "+12345678901")
+    def whitelist(agent_id:, phone_number:, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          agentId: agent_id,
+          phoneNumber: phone_number
+        }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/rcs/whitelist"
+      end
+      Pinnacle::Types::RcsWhitelistResponse.from_json(json_object: response.body)
+    end
+
+    # Generate a link for initiating an RCS conversation with your agent.
+    #  Users can click these links to start conversations with your RCS agent directly
+    #  from websites, emails, or other applications.
+    #
+    # @param agent_id [String] The RCS agent ID (must be prefixed with 'agent_')
+    # @param test_mode [Boolean] Link to the test agent or the production agent if false
+    # @param phone_number [String] Fallback phone number (E.164 format) to use if the phone number does not support
+    #  RCS. If not provided, no url will be generated.
+    # @param body [String] Optional message body to pre-fill after the user clicks the link
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::RcsLinkResult]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.rcs.get_link(
+    #    agent_id: "agent_XXXXXXXXXXXX",
+    #    test_mode: false,
+    #    phone_number: "+12345678901",
+    #    body: "Hello, I need help with my order"
+    #  )
+    def get_link(agent_id:, test_mode: nil, phone_number: nil, body: nil, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          agentId: agent_id,
+          testMode: test_mode,
+          phoneNumber: phone_number,
+          body: body
+        }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/rcs/link"
+      end
+      Pinnacle::Types::RcsLinkResult.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncRcsClient
+    # @return [Pinnacle::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Pinnacle::AsyncRequestClient]
+    # @return [Pinnacle::AsyncRcsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Check RCS capabilities for one or more phone numbers.
+    #  This endpoint allows you to verify which RCS features (cards, buttons, etc.) are
+    #  supported
+    #  on specific phone numbers before sending RCS messages to them.
+    #
+    # @param phone_numbers [Array<String>] List of phone numbers to check RCS capabilities for (E.164 format)
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::RCS_CAPABILITIES_RESULT]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.rcs.get_capabilities(phone_numbers: ["+12345678901", "+19876543210"])
+    def get_capabilities(phone_numbers:, request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request_options&.additional_body_parameters || {}), phoneNumbers: phone_numbers }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/rcs/capabilities"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.transform_values do |value|
+          value = value.to_json
+          Pinnacle::Types::RcsCapability.from_json(json_object: value)
+        end
+      end
+    end
+
+    # Whitelist a phone number for testing with your test RCS agent.
+    #  ## Overview
+    #  During development and testing, RCS agents can only send messages to whitelisted
+    #  phone numbers.
+    #  Use this endpoint to add test devices to your agent's whitelist before sending
+    #  test messages.
+    #  ## Verification Process
+    #  After whitelisting a number, you'll need to complete verification:
+    #  1. Check the test device for an "RBM Tester Management" request
+    #  2. Accept the request on the device
+    #  3. Enter the 4-digit verification code in the Pinnacle dashboard at:
+    #  ```
+    #  .pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
+    #  ```
+    #  > **Important Notes**
+    #  >
+    #  > - **Testing only:** This is only required for test agents. Production agents
+    #  can message any RCS-enabled number
+    #  > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
+    #  > - **Verification required:** The whitelist request isn't complete until you
+    #  verify the device.
+    #
+    # @param agent_id [String] The RCS agent ID (must be prefixed with 'agent_')
+    # @param phone_number [String] Phone number to whitelist for testing (E.164 format)
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::RcsWhitelistResponse]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.rcs.whitelist(agent_id: "agent_XXXXXXXXXXXX", phone_number: "+12345678901")
+    def whitelist(agent_id:, phone_number:, request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            agentId: agent_id,
+            phoneNumber: phone_number
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/rcs/whitelist"
+        end
+        Pinnacle::Types::RcsWhitelistResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Generate a link for initiating an RCS conversation with your agent.
+    #  Users can click these links to start conversations with your RCS agent directly
+    #  from websites, emails, or other applications.
+    #
+    # @param agent_id [String] The RCS agent ID (must be prefixed with 'agent_')
+    # @param test_mode [Boolean] Link to the test agent or the production agent if false
+    # @param phone_number [String] Fallback phone number (E.164 format) to use if the phone number does not support
+    #  RCS. If not provided, no url will be generated.
+    # @param body [String] Optional message body to pre-fill after the user clicks the link
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::RcsLinkResult]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.rcs.get_link(
+    #    agent_id: "agent_XXXXXXXXXXXX",
+    #    test_mode: false,
+    #    phone_number: "+12345678901",
+    #    body: "Hello, I need help with my order"
+    #  )
+    def get_link(agent_id:, test_mode: nil, phone_number: nil, body: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            agentId: agent_id,
+            testMode: test_mode,
+            phoneNumber: phone_number,
+            body: body
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/rcs/link"
+        end
+        Pinnacle::Types::RcsLinkResult.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/rcs/status/get/client.rb

@@ -84,9 +84,9 @@ module Pinnacle
         Pinnacle::Types::TollFreeCampaignStatus.from_json(json_object: response.body)
       end
 
-      # Retrieve a DLC campaign's status.
+      # Retrieve a 10DLC campaign's status.
       #
-      # @param campaign_id [Integer] ID of the DLC campaign.
+      # @param campaign_id [Integer] ID of the 10DLC campaign.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DlcCampaignStatus]
       # @example
@@ -260,9 +260,9 @@ module Pinnacle
         end
       end
 
-      # Retrieve a DLC campaign's status.
+      # Retrieve a 10DLC campaign's status.
       #
-      # @param campaign_id [Integer] ID of the DLC campaign.
+      # @param campaign_id [Integer] ID of the 10DLC campaign.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DlcCampaignStatus]
       # @example

data/lib/rcs/types/conversation_list.rb

@@ -1,66 +1,36 @@
 # frozen_string_literal: true
 
-require_relative "conversation"
-require "ostruct"
 require "json"
+require_relative "error_response"
+require_relative "retrieved_conversations"
 
 module Pinnacle
   module Types
     # Response for list conversation.
     class ConversationList
-      # @return [Integer] Total number of conversations matching the filter.
-      attr_reader :count
-      # @return [Array<Pinnacle::Types::Conversation>]
-      attr_reader :conversations
-      # @return [Boolean] Indicates if more conversations are available beyond the current page.
-      attr_reader :has_more
-      # @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 count [Integer] Total number of conversations matching the filter.
-      # @param conversations [Array<Pinnacle::Types::Conversation>]
-      # @param has_more [Boolean] Indicates if more conversations are available beyond the current page.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::ConversationList]
-      def initialize(count:, conversations:, has_more:, additional_properties: nil)
-        @count = count
-        @conversations = conversations
-        @has_more = has_more
-        @additional_properties = additional_properties
-        @_field_set = { "count": count, "conversations": conversations, "hasMore": has_more }
-      end
-
       # Deserialize a JSON object to an instance of ConversationList
       #
       # @param json_object [String]
       # @return [Pinnacle::Types::ConversationList]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        count = parsed_json["count"]
-        conversations = parsed_json["conversations"]&.map do |item|
-          item = item.to_json
-          Pinnacle::Types::Conversation.from_json(json_object: item)
+        begin
+          Pinnacle::Types::ErrorResponse.validate_raw(obj: struct)
+          return Pinnacle::Types::ErrorResponse.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
         end
-        has_more = parsed_json["hasMore"]
-        new(
-          count: count,
-          conversations: conversations,
-          has_more: has_more,
-          additional_properties: struct
-        )
-      end
+        begin
+          Pinnacle::Types::RetrievedConversations.validate_raw(obj: struct)
+          return Pinnacle::Types::RetrievedConversations.from_json(json_object: struct) unless struct.nil?
 
-      # Serialize an instance of ConversationList to a JSON object
-      #
-      # @return [String]
-      def to_json(*_args)
-        @_field_set&.to_json
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
       end
 
       # Leveraged for Union-type generation, validate_raw attempts to parse the given
@@ -70,9 +40,17 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.count.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
-        obj.conversations.is_a?(Array) != false || raise("Passed value for field obj.conversations is not the expected type, validation failed.")
-        obj.has_more.is_a?(Boolean) != false || raise("Passed value for field obj.has_more is not the expected type, validation failed.")
+        begin
+          return Pinnacle::Types::ErrorResponse.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::RetrievedConversations.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
       end
     end
   end

data/lib/rcs/types/dlc_campaign_status.rb

@@ -22,7 +22,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
@@ -44,7 +44,7 @@ module Pinnacle
       #  `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