rcs 2.0.2 → 2.0.3

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

@@ -5,11 +5,12 @@ require_relative "../../types/autofill_campaign_params"
 require_relative "types/rcs_autofill_response"
 require_relative "../../types/extended_rcs_campaign"
 require_relative "../../types/campaign_submission_result"
-require_relative "types/upsert_rcs_agent"
-require_relative "types/upsert_rcs_links"
-require_relative "types/upsert_rcs_opt_in"
-require_relative "types/upsert_rcs_opt_out"
-require_relative "types/upsert_rcs_use_case"
+require_relative "types/rcs_agent"
+require_relative "types/rcs_links"
+require_relative "types/rcs_use_case"
+require_relative "../../types/rcs_messaging_type_enum"
+require_relative "types/rcs_campaign_keywords"
+require_relative "types/rcs_campaign_traffic"
 require_relative "../../types/validate_campaign_params"
 require_relative "../../types/campaign_validation_result"
 require "async"
@@ -127,7 +128,7 @@ module Pinnacle
       # Create a new RCS campaign or updates an existing one. <br>
       #  Omit campaignId to create a campaign.
       #
-      # @param agent [Hash] Create an agent for the campaign.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsAgent, as a Hash
+      # @param agent [Hash] Create an agent for the campaign.Request of type Pinnacle::Campaigns::Rcs::Types::RcsAgent, as a Hash
       #   * :color (String)
       #   * :description (String)
       #   * :emails (Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>)
@@ -136,24 +137,49 @@ 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 [String] Unique identifier for the brand.
       # @param campaign_id [String] Unique identifier for the campaign.
       # @param expected_agent_responses [Array<String>] List of what the agent might say to users (1-5 required).
-      # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsLinks, as a Hash
+      # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Rcs::Types::RcsLinks, as a Hash
       #   * :privacy_policy (String)
       #   * :terms_of_service (String)
-      # @param opt_in [Hash] Opt-in configuration.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsOptIn, as a Hash
-      #   * :method_ (Pinnacle::Types::RcsCampaignOptInMethodEnum)
-      #   * :terms_and_conditions (String)
-      # @param opt_out [Hash] Opt-out configuration.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsOptOut, as a Hash
-      #   * :description (String)
-      #   * :keywords (Array<String>)
-      # @param use_case [Hash] Use case classification for the campaign.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsUseCase, as a Hash
+      # @param use_case [Hash] Use case classification for the campaign.Request of type Pinnacle::Campaigns::Rcs::Types::RcsUseCase, as a Hash
       #   * :behavior (String)
       #   * :value (Pinnacle::Types::RcsCampaignUseCaseEnum)
+      # @param opt_in_terms_and_conditions [String] Details on how opt-in is acquired. If it is done through a website or app,
+      #  provide the link.
+      # @param messaging_type [Pinnacle::Types::RcsMessagingTypeEnum]
+      # @param carrier_description [String] Description of the agent's purpose, shown to carriers for approval.
+      # @param keywords [Hash] Request of type Pinnacle::Campaigns::Rcs::Types::RcsCampaignKeywords, as a Hash
+      #   * :help (Hash)
+      #     * :message (String)
+      #     * :keywords (Array<String>)
+      #   * :opt_in (Hash)
+      #     * :message (String)
+      #     * :keywords (Array<String>)
+      #   * :opt_out (Hash)
+      #     * :message (String)
+      #     * :keywords (Array<String>)
+      # @param traffic [Hash] Request of type Pinnacle::Campaigns::Rcs::Types::RcsCampaignTraffic, as a Hash
+      #   * :monthly_website (Integer)
+      #   * :monthly_rcs_estimate (Integer)
+      # @param agent_triggers [String] Explanation of how the agent is triggered. This includes how the first message
+      #  is delivered, whether messages follow a schedule or triggered by user actions,
+      #  and any external triggers.
+      # @param interaction_description [String] Description of all agent interactions.
+      # @param is_conversational [Boolean] Whether the agent supports conversational flows or respond to P2A messages from
+      #  the users. Set to false for one-way messages from agent to user.
+      # @param cta_language [String] Required text that appears next to the opt-in checkbox for your opt-in form.
+      #  This checkbox has to be unchecked by default. The text should meet the US CTIA
+      #  requirements and is usually in the following format: <br>
+      #  [Program description of the company sending the messages and what type of
+      #  messages are being sent]. Msg&data rates may apply. [Message frequency: How
+      #  frequently messages are sent]. [Privacy statement or link to privacy policy].
+      #  [Link to full mobile
+      #  T&Cs page].
+      # @param demo_trigger [String] Instructions on how an external reviewer can trigger messages and an example
+      #  flow from the agent. This is usually an inbound text message to the agent that
+      #  will start a flow of messages between the agent and the user.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::ExtendedRcsCampaign]
       # @example
@@ -163,18 +189,32 @@ module Pinnacle
       #    api_key: "YOUR_API_KEY"
       #  )
       #  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",
+      #    agent: { color: "#000000", description: "Experience the power of RCS messaging with interactive demos. Test rich features like carousels, suggested replies, and media sharing. Get started with our developer-friendly APIs.", emails: [{ email: "founders@trypinnacle.app", label: "Email Us" }], hero_url: "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4", icon_url: "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP", name: "Pinnacle - RCS Demo", phones: [{ label: "Contact us directly", phone: "+14154467821" }], websites: [{ label: "Get started with Pinnacle", url: "https://www.trypinnacle.app/" }] },
       #    brand: "b_1234567890",
       #    campaign_id: "rcs_1234567890",
       #    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" },
-      #    opt_in: { method_: WEBSITE, terms_and_conditions: "Would you like to subscribe to 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 }
+      #    use_case: { behavior: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an “onboarding guide” for new customers and a “best-practices coach” for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>
+      #  The agent delivers a mix of operational updates and educational content (2–6 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.
+      #  ", value: OTHER },
+      #    opt_in_terms_and_conditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>
+      #  Users agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.
+      #  ",
+      #    messaging_type: MULTI_USE,
+      #    carrier_description: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
+      #    keywords: { help: { message: "Email founders@trypinnacle.app for support.", keywords: ["HELP", "SUPPORT"] }, opt_in: { message: "Welcome back to Pinnacle!<br>
+      #  🔔 You're now subscribed to Pinnacle - RCS Demo and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>
+      #  Reply STOP to opt out and HELP for support. Message & rates may apply.
+      #  ", keywords: ["START", "SUBSCRIBE"] }, opt_out: { message: "You've been unsubscribed from Pinnacle - RCS Demo and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.", keywords: ["STOP", "UNSUBSCRIBE", "END"] } },
+      #    traffic: { monthly_website: 10000, monthly_rcs_estimate: 10000 },
+      #    agent_triggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
+      #    interaction_description: "The agent's primary interaction will be customer service — helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
+      #    is_conversational: true,
+      #    cta_language: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
+      #    demo_trigger: "Text "START" to trigger the flow."
       #  )
-      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)
+      def upsert(agent: nil, brand: nil, campaign_id: nil, expected_agent_responses: nil, links: nil, use_case: nil,
+                 opt_in_terms_and_conditions: nil, messaging_type: nil, carrier_description: nil, keywords: nil, traffic: nil, agent_triggers: nil, interaction_description: nil, is_conversational: nil, cta_language: nil, demo_trigger: 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?
@@ -189,14 +229,21 @@ module Pinnacle
           req.body = {
             **(request_options&.additional_body_parameters || {}),
             agent: agent,
-            brandVerificationUrl: brand_verification_url,
             brand: brand,
             campaignId: campaign_id,
             expectedAgentResponses: expected_agent_responses,
             links: links,
-            optIn: opt_in,
-            optOut: opt_out,
-            useCase: use_case
+            useCase: use_case,
+            optInTermsAndConditions: opt_in_terms_and_conditions,
+            messagingType: messaging_type,
+            carrierDescription: carrier_description,
+            keywords: keywords,
+            traffic: traffic,
+            agentTriggers: agent_triggers,
+            interactionDescription: interaction_description,
+            isConversational: is_conversational,
+            ctaLanguage: cta_language,
+            demoTrigger: demo_trigger
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/rcs"
         end
@@ -354,7 +401,7 @@ module Pinnacle
       # Create a new RCS campaign or updates an existing one. <br>
       #  Omit campaignId to create a campaign.
       #
-      # @param agent [Hash] Create an agent for the campaign.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsAgent, as a Hash
+      # @param agent [Hash] Create an agent for the campaign.Request of type Pinnacle::Campaigns::Rcs::Types::RcsAgent, as a Hash
       #   * :color (String)
       #   * :description (String)
       #   * :emails (Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>)
@@ -363,24 +410,49 @@ 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 [String] Unique identifier for the brand.
       # @param campaign_id [String] Unique identifier for the campaign.
       # @param expected_agent_responses [Array<String>] List of what the agent might say to users (1-5 required).
-      # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsLinks, as a Hash
+      # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Rcs::Types::RcsLinks, as a Hash
       #   * :privacy_policy (String)
       #   * :terms_of_service (String)
-      # @param opt_in [Hash] Opt-in configuration.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsOptIn, as a Hash
-      #   * :method_ (Pinnacle::Types::RcsCampaignOptInMethodEnum)
-      #   * :terms_and_conditions (String)
-      # @param opt_out [Hash] Opt-out configuration.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsOptOut, as a Hash
-      #   * :description (String)
-      #   * :keywords (Array<String>)
-      # @param use_case [Hash] Use case classification for the campaign.Request of type Pinnacle::Campaigns::Rcs::Types::UpsertRcsUseCase, as a Hash
+      # @param use_case [Hash] Use case classification for the campaign.Request of type Pinnacle::Campaigns::Rcs::Types::RcsUseCase, as a Hash
       #   * :behavior (String)
       #   * :value (Pinnacle::Types::RcsCampaignUseCaseEnum)
+      # @param opt_in_terms_and_conditions [String] Details on how opt-in is acquired. If it is done through a website or app,
+      #  provide the link.
+      # @param messaging_type [Pinnacle::Types::RcsMessagingTypeEnum]
+      # @param carrier_description [String] Description of the agent's purpose, shown to carriers for approval.
+      # @param keywords [Hash] Request of type Pinnacle::Campaigns::Rcs::Types::RcsCampaignKeywords, as a Hash
+      #   * :help (Hash)
+      #     * :message (String)
+      #     * :keywords (Array<String>)
+      #   * :opt_in (Hash)
+      #     * :message (String)
+      #     * :keywords (Array<String>)
+      #   * :opt_out (Hash)
+      #     * :message (String)
+      #     * :keywords (Array<String>)
+      # @param traffic [Hash] Request of type Pinnacle::Campaigns::Rcs::Types::RcsCampaignTraffic, as a Hash
+      #   * :monthly_website (Integer)
+      #   * :monthly_rcs_estimate (Integer)
+      # @param agent_triggers [String] Explanation of how the agent is triggered. This includes how the first message
+      #  is delivered, whether messages follow a schedule or triggered by user actions,
+      #  and any external triggers.
+      # @param interaction_description [String] Description of all agent interactions.
+      # @param is_conversational [Boolean] Whether the agent supports conversational flows or respond to P2A messages from
+      #  the users. Set to false for one-way messages from agent to user.
+      # @param cta_language [String] Required text that appears next to the opt-in checkbox for your opt-in form.
+      #  This checkbox has to be unchecked by default. The text should meet the US CTIA
+      #  requirements and is usually in the following format: <br>
+      #  [Program description of the company sending the messages and what type of
+      #  messages are being sent]. Msg&data rates may apply. [Message frequency: How
+      #  frequently messages are sent]. [Privacy statement or link to privacy policy].
+      #  [Link to full mobile
+      #  T&Cs page].
+      # @param demo_trigger [String] Instructions on how an external reviewer can trigger messages and an example
+      #  flow from the agent. This is usually an inbound text message to the agent that
+      #  will start a flow of messages between the agent and the user.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::ExtendedRcsCampaign]
       # @example
@@ -390,18 +462,32 @@ module Pinnacle
       #    api_key: "YOUR_API_KEY"
       #  )
       #  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",
+      #    agent: { color: "#000000", description: "Experience the power of RCS messaging with interactive demos. Test rich features like carousels, suggested replies, and media sharing. Get started with our developer-friendly APIs.", emails: [{ email: "founders@trypinnacle.app", label: "Email Us" }], hero_url: "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4", icon_url: "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP", name: "Pinnacle - RCS Demo", phones: [{ label: "Contact us directly", phone: "+14154467821" }], websites: [{ label: "Get started with Pinnacle", url: "https://www.trypinnacle.app/" }] },
       #    brand: "b_1234567890",
       #    campaign_id: "rcs_1234567890",
       #    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" },
-      #    opt_in: { method_: WEBSITE, terms_and_conditions: "Would you like to subscribe to 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 }
+      #    use_case: { behavior: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an “onboarding guide” for new customers and a “best-practices coach” for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>
+      #  The agent delivers a mix of operational updates and educational content (2–6 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.
+      #  ", value: OTHER },
+      #    opt_in_terms_and_conditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>
+      #  Users agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.
+      #  ",
+      #    messaging_type: MULTI_USE,
+      #    carrier_description: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
+      #    keywords: { help: { message: "Email founders@trypinnacle.app for support.", keywords: ["HELP", "SUPPORT"] }, opt_in: { message: "Welcome back to Pinnacle!<br>
+      #  🔔 You're now subscribed to Pinnacle - RCS Demo and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>
+      #  Reply STOP to opt out and HELP for support. Message & rates may apply.
+      #  ", keywords: ["START", "SUBSCRIBE"] }, opt_out: { message: "You've been unsubscribed from Pinnacle - RCS Demo and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.", keywords: ["STOP", "UNSUBSCRIBE", "END"] } },
+      #    traffic: { monthly_website: 10000, monthly_rcs_estimate: 10000 },
+      #    agent_triggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
+      #    interaction_description: "The agent's primary interaction will be customer service — helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
+      #    is_conversational: true,
+      #    cta_language: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
+      #    demo_trigger: "Text "START" to trigger the flow."
       #  )
-      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)
+      def upsert(agent: nil, brand: nil, campaign_id: nil, expected_agent_responses: nil, links: nil, use_case: nil,
+                 opt_in_terms_and_conditions: nil, messaging_type: nil, carrier_description: nil, keywords: nil, traffic: nil, agent_triggers: nil, interaction_description: nil, is_conversational: nil, cta_language: nil, demo_trigger: 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?
@@ -417,14 +503,21 @@ module Pinnacle
             req.body = {
               **(request_options&.additional_body_parameters || {}),
               agent: agent,
-              brandVerificationUrl: brand_verification_url,
               brand: brand,
               campaignId: campaign_id,
               expectedAgentResponses: expected_agent_responses,
               links: links,
-              optIn: opt_in,
-              optOut: opt_out,
-              useCase: use_case
+              useCase: use_case,
+              optInTermsAndConditions: opt_in_terms_and_conditions,
+              messagingType: messaging_type,
+              carrierDescription: carrier_description,
+              keywords: keywords,
+              traffic: traffic,
+              agentTriggers: agent_triggers,
+              interactionDescription: interaction_description,
+              isConversational: is_conversational,
+              ctaLanguage: cta_language,
+              demoTrigger: demo_trigger
             }.compact
             req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/rcs"
           end

data/lib/rcs/campaigns/rcs/types/{upsert_rcs_agent.rb → rcs_agent.rb}

@@ -11,11 +11,13 @@ module Pinnacle
     module Rcs
       module Types
         # Create an agent for the campaign.
-        class UpsertRcsAgent
+        class RcsAgent
           # @return [String] Color of the agent's buttons. <br>
           #  Must have sufficient contrast with white.
           attr_reader :color
-          # @return [String] Description of the agent.
+          # @return [String] Description of the agent. <br>
+          #  Be clear, concise, user-focused, and highlight what the agent does and the
+          #  benefits it provides for the user.
           attr_reader :description
           # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails (1-3 required).
           attr_reader :emails
@@ -23,7 +25,8 @@ module Pinnacle
           attr_reader :hero_url
           # @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.
+          # @return [String] Name of the agent. <br>
+          #  Recommended format: [Brand Name] - [1-2 word description of purpose]
           attr_reader :name
           # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>] List of phone numbers (1-3 required).
           attr_reader :phones
@@ -39,15 +42,18 @@ module Pinnacle
 
           # @param color [String] Color of the agent's buttons. <br>
           #  Must have sufficient contrast with white.
-          # @param description [String] Description of the agent.
+          # @param description [String] Description of the agent. <br>
+          #  Be clear, concise, user-focused, and highlight what the agent does and the
+          #  benefits it provides for the user.
           # @param emails [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails (1-3 required).
           # @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 name [String] Name of the agent. <br>
+          #  Recommended format: [Brand Name] - [1-2 word description of purpose]
           # @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).
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-          # @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsAgent]
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsAgent]
           def initialize(color: OMIT, description: OMIT, emails: OMIT, hero_url: OMIT, icon_url: OMIT, name: OMIT,
                          phones: OMIT, websites: OMIT, additional_properties: nil)
             @color = color if color != OMIT
@@ -73,10 +79,10 @@ module Pinnacle
             end
           end
 
-          # Deserialize a JSON object to an instance of UpsertRcsAgent
+          # Deserialize a JSON object to an instance of RcsAgent
           #
           # @param json_object [String]
-          # @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsAgent]
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsAgent]
           def self.from_json(json_object:)
             struct = JSON.parse(json_object, object_class: OpenStruct)
             parsed_json = JSON.parse(json_object)
@@ -110,7 +116,7 @@ module Pinnacle
             )
           end
 
-          # Serialize an instance of UpsertRcsAgent to a JSON object
+          # Serialize an instance of RcsAgent to a JSON object
           #
           # @return [String]
           def to_json(*_args)

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

@@ -2,9 +2,10 @@
 
 require_relative "../../../types/rcs_campaign_schema_agent"
 require_relative "../../../types/rcs_campaign_schema_links"
-require_relative "../../../types/rcs_campaign_schema_opt_in"
-require_relative "../../../types/rcs_campaign_schema_opt_out"
 require_relative "../../../types/rcs_campaign_schema_use_case"
+require_relative "../../../types/rcs_messaging_type_enum"
+require_relative "../../../types/rcs_campaign_schema_keywords"
+require_relative "../../../types/rcs_campaign_schema_traffic"
 require "ostruct"
 require "json"
 
@@ -19,20 +20,45 @@ module Pinnacle
           attr_reader :agent
           # @return [String] 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.
           attr_reader :links
-          # @return [Pinnacle::Types::RcsCampaignSchemaOptIn] Opt-in configuration.
-          attr_reader :opt_in
-          # @return [Pinnacle::Types::RcsCampaignSchemaOptOut] Opt-out configuration.
-          attr_reader :opt_out
           # @return [Pinnacle::Types::RcsCampaignSchemaUseCase] Use case classification for the campaign.
           attr_reader :use_case
+          # @return [String] Details on how opt-in is acquired. If it is done through a website or app,
+          #  provide the link.
+          attr_reader :opt_in_terms_and_conditions
+          # @return [Pinnacle::Types::RcsMessagingTypeEnum]
+          attr_reader :messaging_type
+          # @return [String] Description of the agent's purpose, shown to carriers for approval.
+          attr_reader :carrier_description
+          # @return [Pinnacle::Types::RcsCampaignSchemaKeywords]
+          attr_reader :keywords
+          # @return [Pinnacle::Types::RcsCampaignSchemaTraffic]
+          attr_reader :traffic
+          # @return [String] Explanation of how the agent is triggered. This includes how the first message
+          #  is delivered, whether messages follow a schedule or triggered by user actions,
+          #  and any external triggers.
+          attr_reader :agent_triggers
+          # @return [String] Description of all agent interactions.
+          attr_reader :interaction_description
+          # @return [Boolean] Whether the agent supports conversational flows or respond to P2A messages from
+          #  the users. Set to false for one-way messages from agent to user.
+          attr_reader :is_conversational
+          # @return [String] Required text that appears next to the opt-in checkbox for your opt-in form.
+          #  This checkbox has to be unchecked by default. The text should meet the US CTIA
+          #  requirements and is usually in the following format: <br>
+          #  [Program description of the company sending the messages and what type of
+          #  messages are being sent]. Msg&data rates may apply. [Message frequency: How
+          #  frequently messages are sent]. [Privacy statement or link to privacy policy].
+          #  [Link to full mobile
+          #  T&Cs page].
+          attr_reader :cta_language
+          # @return [String] Instructions on how an external reviewer can trigger messages and an example
+          #  flow from the agent. This is usually an inbound text message to the agent that
+          #  will start a flow of messages between the agent and the user.
+          attr_reader :demo_trigger
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -44,38 +70,70 @@ module Pinnacle
           # @param brand [String]
           # @param agent [Pinnacle::Types::RcsCampaignSchemaAgent] Agent configured to the campaign.
           # @param campaign_id [String] 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.
-          # @param opt_out [Pinnacle::Types::RcsCampaignSchemaOptOut] Opt-out configuration.
           # @param use_case [Pinnacle::Types::RcsCampaignSchemaUseCase] Use case classification for the campaign.
+          # @param opt_in_terms_and_conditions [String] Details on how opt-in is acquired. If it is done through a website or app,
+          #  provide the link.
+          # @param messaging_type [Pinnacle::Types::RcsMessagingTypeEnum]
+          # @param carrier_description [String] Description of the agent's purpose, shown to carriers for approval.
+          # @param keywords [Pinnacle::Types::RcsCampaignSchemaKeywords]
+          # @param traffic [Pinnacle::Types::RcsCampaignSchemaTraffic]
+          # @param agent_triggers [String] Explanation of how the agent is triggered. This includes how the first message
+          #  is delivered, whether messages follow a schedule or triggered by user actions,
+          #  and any external triggers.
+          # @param interaction_description [String] Description of all agent interactions.
+          # @param is_conversational [Boolean] Whether the agent supports conversational flows or respond to P2A messages from
+          #  the users. Set to false for one-way messages from agent to user.
+          # @param cta_language [String] Required text that appears next to the opt-in checkbox for your opt-in form.
+          #  This checkbox has to be unchecked by default. The text should meet the US CTIA
+          #  requirements and is usually in the following format: <br>
+          #  [Program description of the company sending the messages and what type of
+          #  messages are being sent]. Msg&data rates may apply. [Message frequency: How
+          #  frequently messages are sent]. [Privacy statement or link to privacy policy].
+          #  [Link to full mobile
+          #  T&Cs page].
+          # @param demo_trigger [String] Instructions on how an external reviewer can trigger messages and an example
+          #  flow from the agent. This is usually an inbound text message to the agent that
+          #  will start a flow of messages between the agent and the user.
           # @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, brand_verification_url: 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, expected_agent_responses: OMIT, links: OMIT,
+                         use_case: OMIT, opt_in_terms_and_conditions: OMIT, messaging_type: OMIT, carrier_description: OMIT, keywords: OMIT, traffic: OMIT, agent_triggers: OMIT, interaction_description: OMIT, is_conversational: OMIT, cta_language: OMIT, demo_trigger: 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
-            @opt_out = opt_out if opt_out != OMIT
             @use_case = use_case if use_case != OMIT
+            @opt_in_terms_and_conditions = opt_in_terms_and_conditions if opt_in_terms_and_conditions != OMIT
+            @messaging_type = messaging_type if messaging_type != OMIT
+            @carrier_description = carrier_description if carrier_description != OMIT
+            @keywords = keywords if keywords != OMIT
+            @traffic = traffic if traffic != OMIT
+            @agent_triggers = agent_triggers if agent_triggers != OMIT
+            @interaction_description = interaction_description if interaction_description != OMIT
+            @is_conversational = is_conversational if is_conversational != OMIT
+            @cta_language = cta_language if cta_language != OMIT
+            @demo_trigger = demo_trigger if demo_trigger != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "brand": brand,
               "agent": agent,
               "campaignId": campaign_id,
-              "brandVerificationUrl": brand_verification_url,
               "expectedAgentResponses": expected_agent_responses,
               "links": links,
-              "optIn": opt_in,
-              "optOut": opt_out,
-              "useCase": use_case
+              "useCase": use_case,
+              "optInTermsAndConditions": opt_in_terms_and_conditions,
+              "messagingType": messaging_type,
+              "carrierDescription": carrier_description,
+              "keywords": keywords,
+              "traffic": traffic,
+              "agentTriggers": agent_triggers,
+              "interactionDescription": interaction_description,
+              "isConversational": is_conversational,
+              "ctaLanguage": cta_language,
+              "demoTrigger": demo_trigger
             }.reject do |_k, v|
               v == OMIT
             end
@@ -96,7 +154,6 @@ 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
@@ -104,34 +161,49 @@ module Pinnacle
               links = parsed_json["links"].to_json
               links = Pinnacle::Types::RcsCampaignSchemaLinks.from_json(json_object: links)
             end
-            if parsed_json["optIn"].nil?
-              opt_in = nil
-            else
-              opt_in = parsed_json["optIn"].to_json
-              opt_in = Pinnacle::Types::RcsCampaignSchemaOptIn.from_json(json_object: opt_in)
-            end
-            if parsed_json["optOut"].nil?
-              opt_out = nil
-            else
-              opt_out = parsed_json["optOut"].to_json
-              opt_out = Pinnacle::Types::RcsCampaignSchemaOptOut.from_json(json_object: opt_out)
-            end
             if parsed_json["useCase"].nil?
               use_case = nil
             else
               use_case = parsed_json["useCase"].to_json
               use_case = Pinnacle::Types::RcsCampaignSchemaUseCase.from_json(json_object: use_case)
             end
+            opt_in_terms_and_conditions = parsed_json["optInTermsAndConditions"]
+            messaging_type = parsed_json["messagingType"]
+            carrier_description = parsed_json["carrierDescription"]
+            if parsed_json["keywords"].nil?
+              keywords = nil
+            else
+              keywords = parsed_json["keywords"].to_json
+              keywords = Pinnacle::Types::RcsCampaignSchemaKeywords.from_json(json_object: keywords)
+            end
+            if parsed_json["traffic"].nil?
+              traffic = nil
+            else
+              traffic = parsed_json["traffic"].to_json
+              traffic = Pinnacle::Types::RcsCampaignSchemaTraffic.from_json(json_object: traffic)
+            end
+            agent_triggers = parsed_json["agentTriggers"]
+            interaction_description = parsed_json["interactionDescription"]
+            is_conversational = parsed_json["isConversational"]
+            cta_language = parsed_json["ctaLanguage"]
+            demo_trigger = parsed_json["demoTrigger"]
             new(
               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,
-              opt_out: opt_out,
               use_case: use_case,
+              opt_in_terms_and_conditions: opt_in_terms_and_conditions,
+              messaging_type: messaging_type,
+              carrier_description: carrier_description,
+              keywords: keywords,
+              traffic: traffic,
+              agent_triggers: agent_triggers,
+              interaction_description: interaction_description,
+              is_conversational: is_conversational,
+              cta_language: cta_language,
+              demo_trigger: demo_trigger,
               additional_properties: struct
             )
           end
@@ -153,12 +225,19 @@ module Pinnacle
             obj.brand&.is_a?(String) != 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?(String) != 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)
-            obj.opt_out.nil? || Pinnacle::Types::RcsCampaignSchemaOptOut.validate_raw(obj: obj.opt_out)
             obj.use_case.nil? || Pinnacle::Types::RcsCampaignSchemaUseCase.validate_raw(obj: obj.use_case)
+            obj.opt_in_terms_and_conditions&.is_a?(String) != false || raise("Passed value for field obj.opt_in_terms_and_conditions is not the expected type, validation failed.")
+            obj.messaging_type&.is_a?(Pinnacle::Types::RcsMessagingTypeEnum) != false || raise("Passed value for field obj.messaging_type is not the expected type, validation failed.")
+            obj.carrier_description&.is_a?(String) != false || raise("Passed value for field obj.carrier_description is not the expected type, validation failed.")
+            obj.keywords.nil? || Pinnacle::Types::RcsCampaignSchemaKeywords.validate_raw(obj: obj.keywords)
+            obj.traffic.nil? || Pinnacle::Types::RcsCampaignSchemaTraffic.validate_raw(obj: obj.traffic)
+            obj.agent_triggers&.is_a?(String) != false || raise("Passed value for field obj.agent_triggers is not the expected type, validation failed.")
+            obj.interaction_description&.is_a?(String) != false || raise("Passed value for field obj.interaction_description is not the expected type, validation failed.")
+            obj.is_conversational&.is_a?(Boolean) != false || raise("Passed value for field obj.is_conversational is not the expected type, validation failed.")
+            obj.cta_language&.is_a?(String) != false || raise("Passed value for field obj.cta_language is not the expected type, validation failed.")
+            obj.demo_trigger&.is_a?(String) != false || raise("Passed value for field obj.demo_trigger is not the expected type, validation failed.")
           end
         end
       end