rcs 2.0.0.pre.rc.3 → 2.0.0.pre.rc.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1427bbd6a4b71cea24dabba775a6738497b9ac5a511ca5ab39731186c6d0535f
-  data.tar.gz: f9dd560ed6a0343af0e3f308a2ba4ed8dc6310c31134fa56ac9d322074df14b4
+  metadata.gz: 5359c70f9a7ce7a7288024ad6d7aefaef2cef5d9a03beb3e3afd62671c7db723
+  data.tar.gz: be2848caca8ff4126d3f9ec0c84e30902721a85b7a81b37bc0dbf4c81f436bfe
 SHA512:
-  metadata.gz: 0a77a84261329cfa6214225a7eb0d5a48c36eae332672081e9b89cb8b2cf687193f1ba3c791871e478d21738abb024ac12693df14c81e12ea886aa0f48b43f9d
-  data.tar.gz: e5fd2ee9fe78581876d46a8c6dc0406f85b9501b0df5c8a0f82b700b0eea1ba017f9f1fcca8ff87b2f1fc39614c9657f5c0fe4aecd94adcf3fa7c8b3ce16042f
+  metadata.gz: 59f56e2b8c19d78d55c9065e958184f2046d3ea5bfa3486d3fce065e330835c4dad35c4fbefc82fb97b6e7c456eb6aecad8fb851a20c890b8ef7292bff05e4b4
+  data.tar.gz: b1c510a805a9614cffbefd1f44a0e1dc22008a9435252e5f70b792fb8dd003b6e000f92f150035860b1430df88d21b5de9111e490addcb87f654bfc1cdfa21a9

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/types/extended_rcs_campaign.rb

@@ -18,6 +18,10 @@ module Pinnacle
       attr_reader :agent_id
       # @return [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
       attr_reader :brand
+      # @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 [Boolean] Indicates whether the brand has provided an attestation.
       attr_reader :brand_attestation
       # @return [Integer] Unique identifier for the campaign.
@@ -43,6 +47,9 @@ module Pinnacle
       # @param agent [Pinnacle::Types::RcsCampaignSchemaExtraAgent] Agent configured to the campaign.
       # @param agent_id [String] Agent's unique identifier.
       # @param brand [Pinnacle::Types::ExtendedBrand] Brand associated with this 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 brand_attestation [Boolean] Indicates whether the brand has provided an attestation.
       # @param campaign_id [Integer] Unique identifier for the campaign.
       # @param expected_agent_responses [Array<String>] List of what the agent might say to users.
@@ -52,11 +59,12 @@ module Pinnacle
       # @param use_case [Pinnacle::Types::RcsCampaignSchemaExtraUseCase] Use case classification for the campaign.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ExtendedRcsCampaign]
-      def initialize(agent:, agent_id:, brand:, brand_attestation:, campaign_id:, links:, opt_in:, opt_out:, use_case:,
+      def initialize(agent:, agent_id:, brand:, brand_attestation:, campaign_id:, links:, opt_in:, opt_out:, use_case:, brand_verification_url: OMIT,
                      expected_agent_responses: OMIT, additional_properties: nil)
         @agent = agent
         @agent_id = agent_id
         @brand = brand
+        @brand_verification_url = brand_verification_url if brand_verification_url != OMIT
         @brand_attestation = brand_attestation
         @campaign_id = campaign_id
         @expected_agent_responses = expected_agent_responses if expected_agent_responses != OMIT
@@ -69,6 +77,7 @@ module Pinnacle
           "agent": agent,
           "agentId": agent_id,
           "brand": brand,
+          "brandVerificationUrl": brand_verification_url,
           "brandAttestation": brand_attestation,
           "campaignId": campaign_id,
           "expectedAgentResponses": expected_agent_responses,
@@ -101,6 +110,7 @@ module Pinnacle
           brand = parsed_json["brand"].to_json
           brand = Pinnacle::Types::ExtendedBrand.from_json(json_object: brand)
         end
+        brand_verification_url = parsed_json["brandVerificationUrl"]
         brand_attestation = parsed_json["brandAttestation"]
         campaign_id = parsed_json["campaignId"]
         expected_agent_responses = parsed_json["expectedAgentResponses"]
@@ -132,6 +142,7 @@ module Pinnacle
           agent: agent,
           agent_id: agent_id,
           brand: brand,
+          brand_verification_url: brand_verification_url,
           brand_attestation: brand_attestation,
           campaign_id: campaign_id,
           expected_agent_responses: expected_agent_responses,
@@ -160,6 +171,7 @@ module Pinnacle
         Pinnacle::Types::RcsCampaignSchemaExtraAgent.validate_raw(obj: obj.agent)
         obj.agent_id.is_a?(String) != false || raise("Passed value for field obj.agent_id is not the expected type, validation failed.")
         Pinnacle::Types::ExtendedBrand.validate_raw(obj: obj.brand)
+        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.brand_attestation.is_a?(Boolean) != false || raise("Passed value for field obj.brand_attestation is not the expected type, validation failed.")
         obj.campaign_id.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id 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.")

data/lib/rcs/types/rcs_campaign.rb

@@ -15,6 +15,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.
@@ -35,6 +39,9 @@ module Pinnacle
 
       # @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.
@@ -42,10 +49,11 @@ 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::Types::RcsCampaign]
-      def initialize(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(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)
         @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
@@ -55,6 +63,7 @@ module Pinnacle
         @_field_set = {
           "agent": agent,
           "campaignId": campaign_id,
+          "brandVerificationUrl": brand_verification_url,
           "expectedAgentResponses": expected_agent_responses,
           "links": links,
           "optIn": opt_in,
@@ -79,6 +88,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
@@ -107,6 +117,7 @@ module Pinnacle
         new(
           agent: agent,
           campaign_id: campaign_id,
+          brand_verification_url: brand_verification_url,
           expected_agent_responses: expected_agent_responses,
           links: links,
           opt_in: opt_in,
@@ -132,6 +143,7 @@ module Pinnacle
       def self.validate_raw(obj:)
         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/requests.rb

@@ -43,7 +43,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.0-rc.3" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.0-rc.4" }
       headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
@@ -87,7 +87,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.0-rc.3" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.0-rc.4" }
       headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcs
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.rc.3
+  version: 2.0.0.pre.rc.4
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-13 00:00:00.000000000 Z
+date: 2025-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday