rcs 2.0.0.pre.rc.3 → 2.0.0.pre.rc.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1427bbd6a4b71cea24dabba775a6738497b9ac5a511ca5ab39731186c6d0535f
-  data.tar.gz: f9dd560ed6a0343af0e3f308a2ba4ed8dc6310c31134fa56ac9d322074df14b4
+  metadata.gz: 262806a75a52a70e37dd92a0036ba70af3a59aa98ea132dd60f2dad6cbe2c95a
+  data.tar.gz: 5dcd700d3f9a65f9dfa3bd4551773fb8fa6789f39e998b053eef877fc95daf70
 SHA512:
-  metadata.gz: 0a77a84261329cfa6214225a7eb0d5a48c36eae332672081e9b89cb8b2cf687193f1ba3c791871e478d21738abb024ac12693df14c81e12ea886aa0f48b43f9d
-  data.tar.gz: e5fd2ee9fe78581876d46a8c6dc0406f85b9501b0df5c8a0f82b700b0eea1ba017f9f1fcca8ff87b2f1fc39614c9657f5c0fe4aecd94adcf3fa7c8b3ce16042f
+  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/client.rb

@@ -135,6 +135,9 @@ module Pinnacle
       #   * :name (String)
       #   * :phones (Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>)
       #   * :websites (Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>)
+      # @param brand_verification_url [String] Link to document verifying the brand's name. This may be the certificate of
+      #  incorporation, business license, or other relevant document. You can typically
+      #  find this on the Secretary of State website.
       # @param brand [Integer] Unique identifier for the brand.
       # @param campaign_id [Integer] Unique identifier for the campaign.
       # @param expected_agent_responses [Array<String>] List of what the agent might say to users (1-5 required).
@@ -160,6 +163,7 @@ module Pinnacle
       #  )
       #  api.campaigns.rcs.upsert(
       #    agent: { color: "#000000", description: "Engaging campaigns with RBM – next-gen SMS marketing with rich content and better analytics.", emails: [{ email: "founders@trypinnacle.app", label: "Email Us" }], hero_url: "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6", icon_url: "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3", name: "Pinnacle Software Development", phones: [{ label: "Contact us directly", phone: "+14154467821" }], websites: [{ label: "Get started with Pinnacle", url: "https://www.trypinnacle.app/" }] },
+      #    brand_verification_url: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
       #    brand: 2,
       #    expected_agent_responses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
       #    links: { privacy_policy: "https://www.trypinnacle.app/privacy", terms_of_service: "https://www.trypinnacle.app/terms" },
@@ -167,8 +171,8 @@ module Pinnacle
       #    opt_out: { description: "Reply STOP to opt-out anytime.", keywords: ["STOP", "UNSUBSCRIBE", "END"] },
       #    use_case: { behavior: "Acts as a customer service representative.", value: OTHER }
       #  )
-      def upsert(agent: nil, brand: nil, campaign_id: nil, expected_agent_responses: nil, links: nil, opt_in: nil,
-                 opt_out: nil, use_case: nil, request_options: nil)
+      def upsert(agent: nil, brand_verification_url: nil, brand: nil, campaign_id: nil, expected_agent_responses: nil,
+                 links: nil, opt_in: nil, opt_out: nil, use_case: 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?
@@ -183,6 +187,7 @@ module Pinnacle
           req.body = {
             **(request_options&.additional_body_parameters || {}),
             agent: agent,
+            brandVerificationUrl: brand_verification_url,
             brand: brand,
             campaignId: campaign_id,
             expectedAgentResponses: expected_agent_responses,
@@ -355,6 +360,9 @@ module Pinnacle
       #   * :name (String)
       #   * :phones (Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>)
       #   * :websites (Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>)
+      # @param brand_verification_url [String] Link to document verifying the brand's name. This may be the certificate of
+      #  incorporation, business license, or other relevant document. You can typically
+      #  find this on the Secretary of State website.
       # @param brand [Integer] Unique identifier for the brand.
       # @param campaign_id [Integer] Unique identifier for the campaign.
       # @param expected_agent_responses [Array<String>] List of what the agent might say to users (1-5 required).
@@ -380,6 +388,7 @@ module Pinnacle
       #  )
       #  api.campaigns.rcs.upsert(
       #    agent: { color: "#000000", description: "Engaging campaigns with RBM – next-gen SMS marketing with rich content and better analytics.", emails: [{ email: "founders@trypinnacle.app", label: "Email Us" }], hero_url: "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6", icon_url: "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3", name: "Pinnacle Software Development", phones: [{ label: "Contact us directly", phone: "+14154467821" }], websites: [{ label: "Get started with Pinnacle", url: "https://www.trypinnacle.app/" }] },
+      #    brand_verification_url: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
       #    brand: 2,
       #    expected_agent_responses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
       #    links: { privacy_policy: "https://www.trypinnacle.app/privacy", terms_of_service: "https://www.trypinnacle.app/terms" },
@@ -387,8 +396,8 @@ module Pinnacle
       #    opt_out: { description: "Reply STOP to opt-out anytime.", keywords: ["STOP", "UNSUBSCRIBE", "END"] },
       #    use_case: { behavior: "Acts as a customer service representative.", value: OTHER }
       #  )
-      def upsert(agent: nil, brand: nil, campaign_id: nil, expected_agent_responses: nil, links: nil, opt_in: nil,
-                 opt_out: nil, use_case: nil, request_options: nil)
+      def upsert(agent: nil, brand_verification_url: nil, brand: nil, campaign_id: nil, expected_agent_responses: nil,
+                 links: nil, opt_in: nil, opt_out: nil, use_case: 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?
@@ -404,6 +413,7 @@ module Pinnacle
             req.body = {
               **(request_options&.additional_body_parameters || {}),
               agent: agent,
+              brandVerificationUrl: brand_verification_url,
               brand: brand,
               campaignId: campaign_id,
               expectedAgentResponses: expected_agent_responses,

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

@@ -19,6 +19,10 @@ module Pinnacle
           attr_reader :agent
           # @return [Integer] Unique identifier for the campaign.
           attr_reader :campaign_id
+          # @return [String] Link to document verifying the brand's name. This may be the certificate of
+          #  incorporation, business license, or other relevant document. You can typically
+          #  find this on the Secretary of State website.
+          attr_reader :brand_verification_url
           # @return [Array<String>] List of what the agent might say to users.
           attr_reader :expected_agent_responses
           # @return [Pinnacle::Types::RcsCampaignSchemaLinks] Legal documentation links.
@@ -40,6 +44,9 @@ module Pinnacle
           # @param brand [Integer]
           # @param agent [Pinnacle::Types::RcsCampaignSchemaAgent] Agent configured to the campaign.
           # @param campaign_id [Integer] Unique identifier for the campaign.
+          # @param brand_verification_url [String] Link to document verifying the brand's name. This may be the certificate of
+          #  incorporation, business license, or other relevant document. You can typically
+          #  find this on the Secretary of State website.
           # @param expected_agent_responses [Array<String>] List of what the agent might say to users.
           # @param links [Pinnacle::Types::RcsCampaignSchemaLinks] Legal documentation links.
           # @param opt_in [Pinnacle::Types::RcsCampaignSchemaOptIn] Opt-in configuration.
@@ -47,11 +54,12 @@ module Pinnacle
           # @param use_case [Pinnacle::Types::RcsCampaignSchemaUseCase] Use case classification for the campaign.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [Pinnacle::Campaigns::Rcs::Types::RcsAutofillResponse]
-          def initialize(brand: OMIT, agent: OMIT, campaign_id: OMIT, expected_agent_responses: OMIT, links: OMIT,
-                         opt_in: OMIT, opt_out: OMIT, use_case: OMIT, additional_properties: nil)
+          def initialize(brand: OMIT, agent: OMIT, campaign_id: OMIT, brand_verification_url: OMIT,
+                         expected_agent_responses: OMIT, links: OMIT, opt_in: OMIT, opt_out: OMIT, use_case: OMIT, additional_properties: nil)
             @brand = brand if brand != OMIT
             @agent = agent if agent != OMIT
             @campaign_id = campaign_id if campaign_id != OMIT
+            @brand_verification_url = brand_verification_url if brand_verification_url != OMIT
             @expected_agent_responses = expected_agent_responses if expected_agent_responses != OMIT
             @links = links if links != OMIT
             @opt_in = opt_in if opt_in != OMIT
@@ -62,6 +70,7 @@ module Pinnacle
               "brand": brand,
               "agent": agent,
               "campaignId": campaign_id,
+              "brandVerificationUrl": brand_verification_url,
               "expectedAgentResponses": expected_agent_responses,
               "links": links,
               "optIn": opt_in,
@@ -87,6 +96,7 @@ module Pinnacle
               agent = Pinnacle::Types::RcsCampaignSchemaAgent.from_json(json_object: agent)
             end
             campaign_id = parsed_json["campaignId"]
+            brand_verification_url = parsed_json["brandVerificationUrl"]
             expected_agent_responses = parsed_json["expectedAgentResponses"]
             if parsed_json["links"].nil?
               links = nil
@@ -116,6 +126,7 @@ module Pinnacle
               brand: brand,
               agent: agent,
               campaign_id: campaign_id,
+              brand_verification_url: brand_verification_url,
               expected_agent_responses: expected_agent_responses,
               links: links,
               opt_in: opt_in,
@@ -142,6 +153,7 @@ module Pinnacle
             obj.brand&.is_a?(Integer) != false || raise("Passed value for field obj.brand is not the expected type, validation failed.")
             obj.agent.nil? || Pinnacle::Types::RcsCampaignSchemaAgent.validate_raw(obj: obj.agent)
             obj.campaign_id&.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
+            obj.brand_verification_url&.is_a?(String) != false || raise("Passed value for field obj.brand_verification_url is not the expected type, validation failed.")
             obj.expected_agent_responses&.is_a?(Array) != false || raise("Passed value for field obj.expected_agent_responses is not the expected type, validation failed.")
             obj.links.nil? || Pinnacle::Types::RcsCampaignSchemaLinks.validate_raw(obj: obj.links)
             obj.opt_in.nil? || Pinnacle::Types::RcsCampaignSchemaOptIn.validate_raw(obj: obj.opt_in)

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