rcs 2.0.5.pre.rc.1 → 2.0.5

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

@@ -0,0 +1,492 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/autofill_campaign_params"
+require_relative "../../types/autofill_dlc_campaign_response"
+require_relative "../../types/dlc_campaign_with_extended_brand_and_status"
+require_relative "../../types/campaign_submission_result"
+require_relative "types/dlc_campaign_keywords"
+require_relative "types/dlc_campaign_links"
+require_relative "types/dlc_campaign_options"
+require_relative "types/dlc_campaign_use_case"
+require_relative "../../types/validate_campaign_params"
+require_relative "../../types/campaign_validation_result"
+require "async"
+
+module Pinnacle
+  module Campaigns
+    class DlcClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Campaigns::DlcClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Generate campaign details based off existing campaign and the brand it's
+      #  connected to.
+      #
+      # @param request [Hash] Request of type Pinnacle::Types::AutofillCampaignParams, as a Hash
+      #   * :additional_info (String)
+      #   * :campaign_id (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::AutofillDlcCampaignResponse]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.autofill(request: { additional_info: "Please autofill missing campaign fields using my brand profile", campaign_id: "dlc_1234567890" })
+      def autofill(request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc/autofill"
+        end
+        Pinnacle::Types::AutofillDlcCampaignResponse.from_json(json_object: response.body)
+      end
+
+      # Retrieve 10DLC campaign.
+      #
+      # @param campaign_id [String] Unique identifier of the 10DLC campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.get(campaign_id: "dlc_1234567890")
+      def get(campaign_id:, request_options: nil)
+        response = @request_client.conn.get 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
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc/#{campaign_id}"
+        end
+        Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
+      end
+
+      # Submit your 10DLC campaign for approval and activation with carriers.
+      #
+      # @param campaign_id [String] Unique identifier of the 10DLC campaign to submit.
+      #  <br><br> This identifier is a string that always begins with the prefix `dlc_`,
+      #  for example: `dlc_1234567890`.
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::CampaignSubmissionResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.submit(campaign_id: "dlc_1234567890")
+      def submit(campaign_id:, 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
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc/submit/#{campaign_id}"
+        end
+        Pinnacle::Types::CampaignSubmissionResult.from_json(json_object: response.body)
+      end
+
+      # 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.
+      # @param brand [String] Brand id. This identifier is a string that always begins with the prefix `b_`,
+      #  for example: `b_1234567890`.
+      # @param campaign_id [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
+      # @param description [String] Description of the campaign.
+      # @param keywords [Hash] Keyword response configuration.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords, as a Hash
+      #   * :help (Hash)
+      #     * :message (String)
+      #     * :values (Array<String>)
+      #   * :opt_in (Hash)
+      #     * :message (String)
+      #     * :values (Array<String>)
+      #   * :opt_out (Hash)
+      #     * :message (String)
+      #     * :values (Array<String>)
+      # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignLinks, as a Hash
+      #   * :privacy_policy (String)
+      #   * :terms_of_service (String)
+      # @param message_flow [String] Describe the flow of how users will opt in to this campaign.
+      # @param name [String] Display name of the campaign.
+      # @param options [Hash] Campaign configuration options.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptions, as a Hash
+      #   * :affiliate_marketing (Boolean)
+      #   * :age_gated (Boolean)
+      #   * :direct_lending (Boolean)
+      #   * :embedded_link (String)
+      #   * :embedded_phone (Boolean)
+      #   * :number_pooling (Boolean)
+      # @param sample_messages [Array<String>] Example messages for the campaign. <br><br>
+      #  **Limit:** 1 to 5
+      # @param use_case [Hash] Use case for the campaign.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase, as a Hash
+      #   * :sub (Array<Pinnacle::Types::SubUseCaseEnum>)
+      #   * :value (Pinnacle::Types::DlcCampaignUseCaseEnum)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.upsert(
+      #    auto_renew: true,
+      #    brand: "b_1234567890",
+      #    campaign_id: "dlc_1234567890",
+      #    keywords: { help: { message: "Reply HELP for assistance, STOP to opt-out", values: ["HELP", "INFO", "SUPPORT"] }, opt_in: { message: "Welcome. You are now subscribed to Pinnacle.", values: ["JOIN", "START", "SUBSCRIBE"] }, opt_out: { message: "You have been unsubscribed. Reply START to rejoin.", values: ["STOP", "QUIT", "UNSUBSCRIBE"] } },
+      #    links: { privacy_policy: "https://www.pinnacle.sh/privacy", terms_of_service: "https://www.pinnacle.sh/terms" },
+      #    message_flow: "Customer initiates -> Automated response -> Agent follow-up if needed",
+      #    name: "Account Notifications",
+      #    options: { affiliate_marketing: false, age_gated: false, direct_lending: false, embedded_link: "https://www.pinnacle.sh/example", embedded_phone: false, number_pooling: false },
+      #    sample_messages: ["Security alert: Unusual login detected from new device."],
+      #    use_case: { sub: [FRAUD_ALERT], value: ACCOUNT_NOTIFICATION }
+      #  )
+      def upsert(auto_renew: nil, brand: nil, campaign_id: nil, description: nil, keywords: nil, links: nil,
+                 message_flow: nil, name: nil, options: nil, sample_messages: 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?
+          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 || {}),
+            autoRenew: auto_renew,
+            brand: brand,
+            campaignId: campaign_id,
+            description: description,
+            keywords: keywords,
+            links: links,
+            messageFlow: message_flow,
+            name: name,
+            options: options,
+            sampleMessages: sample_messages,
+            useCase: use_case
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc"
+        end
+        Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
+      end
+
+      # Validate your 10DLC campaign configuration against carrier requirements and
+      #  compliance rules.
+      #
+      # @param request [Hash] Request of type Pinnacle::Types::ValidateCampaignParams, as a Hash
+      #   * :additional_info (String)
+      #   * :campaign_id (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::CampaignValidationResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: "dlc_1234567890" })
+      def validate(request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc/validate"
+        end
+        Pinnacle::Types::CampaignValidationResult.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncDlcClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Campaigns::AsyncDlcClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Generate campaign details based off existing campaign and the brand it's
+      #  connected to.
+      #
+      # @param request [Hash] Request of type Pinnacle::Types::AutofillCampaignParams, as a Hash
+      #   * :additional_info (String)
+      #   * :campaign_id (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::AutofillDlcCampaignResponse]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.autofill(request: { additional_info: "Please autofill missing campaign fields using my brand profile", campaign_id: "dlc_1234567890" })
+      def autofill(request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc/autofill"
+          end
+          Pinnacle::Types::AutofillDlcCampaignResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Retrieve 10DLC campaign.
+      #
+      # @param campaign_id [String] Unique identifier of the 10DLC campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.get(campaign_id: "dlc_1234567890")
+      def get(campaign_id:, request_options: nil)
+        Async do
+          response = @request_client.conn.get 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
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc/#{campaign_id}"
+          end
+          Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
+        end
+      end
+
+      # Submit your 10DLC campaign for approval and activation with carriers.
+      #
+      # @param campaign_id [String] Unique identifier of the 10DLC campaign to submit.
+      #  <br><br> This identifier is a string that always begins with the prefix `dlc_`,
+      #  for example: `dlc_1234567890`.
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::CampaignSubmissionResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.submit(campaign_id: "dlc_1234567890")
+      def submit(campaign_id:, 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
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc/submit/#{campaign_id}"
+          end
+          Pinnacle::Types::CampaignSubmissionResult.from_json(json_object: response.body)
+        end
+      end
+
+      # 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.
+      # @param brand [String] Brand id. This identifier is a string that always begins with the prefix `b_`,
+      #  for example: `b_1234567890`.
+      # @param campaign_id [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
+      # @param description [String] Description of the campaign.
+      # @param keywords [Hash] Keyword response configuration.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords, as a Hash
+      #   * :help (Hash)
+      #     * :message (String)
+      #     * :values (Array<String>)
+      #   * :opt_in (Hash)
+      #     * :message (String)
+      #     * :values (Array<String>)
+      #   * :opt_out (Hash)
+      #     * :message (String)
+      #     * :values (Array<String>)
+      # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignLinks, as a Hash
+      #   * :privacy_policy (String)
+      #   * :terms_of_service (String)
+      # @param message_flow [String] Describe the flow of how users will opt in to this campaign.
+      # @param name [String] Display name of the campaign.
+      # @param options [Hash] Campaign configuration options.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptions, as a Hash
+      #   * :affiliate_marketing (Boolean)
+      #   * :age_gated (Boolean)
+      #   * :direct_lending (Boolean)
+      #   * :embedded_link (String)
+      #   * :embedded_phone (Boolean)
+      #   * :number_pooling (Boolean)
+      # @param sample_messages [Array<String>] Example messages for the campaign. <br><br>
+      #  **Limit:** 1 to 5
+      # @param use_case [Hash] Use case for the campaign.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase, as a Hash
+      #   * :sub (Array<Pinnacle::Types::SubUseCaseEnum>)
+      #   * :value (Pinnacle::Types::DlcCampaignUseCaseEnum)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.upsert(
+      #    auto_renew: true,
+      #    brand: "b_1234567890",
+      #    campaign_id: "dlc_1234567890",
+      #    keywords: { help: { message: "Reply HELP for assistance, STOP to opt-out", values: ["HELP", "INFO", "SUPPORT"] }, opt_in: { message: "Welcome. You are now subscribed to Pinnacle.", values: ["JOIN", "START", "SUBSCRIBE"] }, opt_out: { message: "You have been unsubscribed. Reply START to rejoin.", values: ["STOP", "QUIT", "UNSUBSCRIBE"] } },
+      #    links: { privacy_policy: "https://www.pinnacle.sh/privacy", terms_of_service: "https://www.pinnacle.sh/terms" },
+      #    message_flow: "Customer initiates -> Automated response -> Agent follow-up if needed",
+      #    name: "Account Notifications",
+      #    options: { affiliate_marketing: false, age_gated: false, direct_lending: false, embedded_link: "https://www.pinnacle.sh/example", embedded_phone: false, number_pooling: false },
+      #    sample_messages: ["Security alert: Unusual login detected from new device."],
+      #    use_case: { sub: [FRAUD_ALERT], value: ACCOUNT_NOTIFICATION }
+      #  )
+      def upsert(auto_renew: nil, brand: nil, campaign_id: nil, description: nil, keywords: nil, links: nil,
+                 message_flow: nil, name: nil, options: nil, sample_messages: 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?
+            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 || {}),
+              autoRenew: auto_renew,
+              brand: brand,
+              campaignId: campaign_id,
+              description: description,
+              keywords: keywords,
+              links: links,
+              messageFlow: message_flow,
+              name: name,
+              options: options,
+              sampleMessages: sample_messages,
+              useCase: use_case
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc"
+          end
+          Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
+        end
+      end
+
+      # Validate your 10DLC campaign configuration against carrier requirements and
+      #  compliance rules.
+      #
+      # @param request [Hash] Request of type Pinnacle::Types::ValidateCampaignParams, as a Hash
+      #   * :additional_info (String)
+      #   * :campaign_id (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::CampaignValidationResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.dlc.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: "dlc_1234567890" })
+      def validate(request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/dlc/validate"
+          end
+          Pinnacle::Types::CampaignValidationResult.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/rcs/campaigns/dlc/types/dlc_campaign_help_keywords.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Help keyword settings.
+        class DlcCampaignHelpKeywords
+          # @return [String] Response message for help keywords.
+          attr_reader :message
+          # @return [Array<String>] Keywords that trigger help response.
+          attr_reader :values
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param message [String] Response message for help keywords.
+          # @param values [Array<String>] Keywords that trigger help response.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords]
+          def initialize(message: OMIT, values: OMIT, additional_properties: nil)
+            @message = message if message != OMIT
+            @values = values if values != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "message": message, "values": values }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of DlcCampaignHelpKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            message = parsed_json["message"]
+            values = parsed_json["values"]
+            new(
+              message: message,
+              values: values,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of DlcCampaignHelpKeywords to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+            obj.values&.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rcs/campaigns/dlc/types/dlc_campaign_keywords.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative "dlc_campaign_help_keywords"
+require_relative "dlc_campaign_opt_in_keywords"
+require_relative "dlc_campaign_opt_out_keywords"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Keyword response configuration.
+        class DlcCampaignKeywords
+          # @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords] Help keyword settings.
+          attr_reader :help
+          # @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords] Opt-in keyword settings.
+          attr_reader :opt_in
+          # @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords] Opt-out keyword settings.
+          attr_reader :opt_out
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param help [Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords] Help keyword settings.
+          # @param opt_in [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords] Opt-in keyword settings.
+          # @param opt_out [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords] Opt-out keyword settings.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords]
+          def initialize(help: OMIT, opt_in: OMIT, opt_out: OMIT, additional_properties: nil)
+            @help = help if help != OMIT
+            @opt_in = opt_in if opt_in != OMIT
+            @opt_out = opt_out if opt_out != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "HELP": help, "OPT_IN": opt_in, "OPT_OUT": opt_out }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of DlcCampaignKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            if parsed_json["HELP"].nil?
+              help = nil
+            else
+              help = parsed_json["HELP"].to_json
+              help = Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords.from_json(json_object: help)
+            end
+            if parsed_json["OPT_IN"].nil?
+              opt_in = nil
+            else
+              opt_in = parsed_json["OPT_IN"].to_json
+              opt_in = Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords.from_json(json_object: opt_in)
+            end
+            if parsed_json["OPT_OUT"].nil?
+              opt_out = nil
+            else
+              opt_out = parsed_json["OPT_OUT"].to_json
+              opt_out = Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords.from_json(json_object: opt_out)
+            end
+            new(
+              help: help,
+              opt_in: opt_in,
+              opt_out: opt_out,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of DlcCampaignKeywords to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.help.nil? || Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords.validate_raw(obj: obj.help)
+            obj.opt_in.nil? || Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords.validate_raw(obj: obj.opt_in)
+            obj.opt_out.nil? || Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords.validate_raw(obj: obj.opt_out)
+          end
+        end
+      end
+    end
+  end
+end