rcs 1.0.17 → 2.0.0.pre.rc.1

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

@@ -0,0 +1,429 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/autofill_campaign_params"
+require_relative "types/toll_free_autofill_response"
+require_relative "../../types/toll_free_campaign_with_extended_brand_and_status"
+require_relative "../../types/campaign_submission_result"
+require_relative "../../types/message_volume_enum"
+require_relative "types/upsert_toll_free_schema_opt_in"
+require_relative "types/upsert_toll_free_schema_use_case"
+require_relative "../../types/validate_campaign_params"
+require_relative "../../types/campaign_validation_result"
+require "async"
+
+module Pinnacle
+  module Campaigns
+    class TollFreeClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Campaigns::TollFreeClient]
+      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 (Integer)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeAutofillResponse]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.toll_free.autofill(request: { additional_info: "Please autofill missing DLC campaign fields using my brand profile", campaign_id: 161 })
+      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/toll-free/autofill"
+        end
+        Pinnacle::Campaigns::TollFree::Types::TollFreeAutofillResponse.from_json(json_object: response.body)
+      end
+
+      # Retrieve Toll-Free campaign.
+      #
+      # @param campaign_id [Integer] Unique identifier of toll-free campaign.
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.toll_free.get(campaign_id: 161)
+      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/toll-free/#{campaign_id}"
+        end
+        Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
+      end
+
+      # Submit your toll-free campaign for approval and activation with carriers.
+      #
+      # @param campaign_id [Integer] Unique identifier of the toll-free campaign to submit.
+      # @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.toll_free.submit(campaign_id: 161)
+      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/toll-free/submit/#{campaign_id}"
+        end
+        Pinnacle::Types::CampaignSubmissionResult.from_json(json_object: response.body)
+      end
+
+      # Create a new toll-free campaign or updates an existing one.<br>
+      #  Omit campaignId to create a campaign.
+      #
+      # @param brand [Integer] Brand id.
+      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
+      # @param name [String] Display name of the campaign.
+      # @param opt_in [Hash] Opt-in keyword settings.Request of type Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaOptIn, as a Hash
+      #   * :method (Pinnacle::Types::OptInMethodEnum)
+      #   * :url (String)
+      #   * :workflow_description (String)
+      # @param production_message_content [String] Explain message that would be sent.
+      # @param use_case [Hash] Use case classification for the campaign.Request of type Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaUseCase, as a Hash
+      #   * :summary (String)
+      #   * :value (Pinnacle::Types::TollFreeCampaignUseCaseEnum)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.toll_free.upsert(
+      #    brand: 2,
+      #    campaign_id: 161,
+      #    monthly_volume: ONE_000,
+      #    name: "Pinnacle",
+      #    opt_in: { method: DIGITAL, url: "https://www.pinnacle.sh/", workflow_description: "Visit https://www.pinnacle.sh/" },
+      #    production_message_content: "Join Pinnacle's workshop tomorrow and send your first RCS!",
+      #    use_case: { summary: "Alerts clients about any Pinnacle hosted workshops.", value: WORKSHOP_ALERTS }
+      #  )
+      def upsert(brand: nil, campaign_id: nil, monthly_volume: nil, name: nil, opt_in: nil,
+                 production_message_content: 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 || {}),
+            brand: brand,
+            campaignId: campaign_id,
+            monthlyVolume: monthly_volume,
+            name: name,
+            optIn: opt_in,
+            productionMessageContent: production_message_content,
+            useCase: use_case
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/toll-free"
+        end
+        Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
+      end
+
+      # Validate your toll-free 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 (Integer)
+      # @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.toll_free.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: 161 })
+      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/toll-free/validate"
+        end
+        Pinnacle::Types::CampaignValidationResult.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncTollFreeClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Campaigns::AsyncTollFreeClient]
+      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 (Integer)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeAutofillResponse]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.toll_free.autofill(request: { additional_info: "Please autofill missing DLC campaign fields using my brand profile", campaign_id: 161 })
+      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/toll-free/autofill"
+          end
+          Pinnacle::Campaigns::TollFree::Types::TollFreeAutofillResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Retrieve Toll-Free campaign.
+      #
+      # @param campaign_id [Integer] Unique identifier of toll-free campaign.
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.toll_free.get(campaign_id: 161)
+      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/toll-free/#{campaign_id}"
+          end
+          Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
+        end
+      end
+
+      # Submit your toll-free campaign for approval and activation with carriers.
+      #
+      # @param campaign_id [Integer] Unique identifier of the toll-free campaign to submit.
+      # @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.toll_free.submit(campaign_id: 161)
+      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/toll-free/submit/#{campaign_id}"
+          end
+          Pinnacle::Types::CampaignSubmissionResult.from_json(json_object: response.body)
+        end
+      end
+
+      # Create a new toll-free campaign or updates an existing one.<br>
+      #  Omit campaignId to create a campaign.
+      #
+      # @param brand [Integer] Brand id.
+      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
+      # @param name [String] Display name of the campaign.
+      # @param opt_in [Hash] Opt-in keyword settings.Request of type Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaOptIn, as a Hash
+      #   * :method (Pinnacle::Types::OptInMethodEnum)
+      #   * :url (String)
+      #   * :workflow_description (String)
+      # @param production_message_content [String] Explain message that would be sent.
+      # @param use_case [Hash] Use case classification for the campaign.Request of type Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaUseCase, as a Hash
+      #   * :summary (String)
+      #   * :value (Pinnacle::Types::TollFreeCampaignUseCaseEnum)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.campaigns.toll_free.upsert(
+      #    brand: 2,
+      #    campaign_id: 161,
+      #    monthly_volume: ONE_000,
+      #    name: "Pinnacle",
+      #    opt_in: { method: DIGITAL, url: "https://www.pinnacle.sh/", workflow_description: "Visit https://www.pinnacle.sh/" },
+      #    production_message_content: "Join Pinnacle's workshop tomorrow and send your first RCS!",
+      #    use_case: { summary: "Alerts clients about any Pinnacle hosted workshops.", value: WORKSHOP_ALERTS }
+      #  )
+      def upsert(brand: nil, campaign_id: nil, monthly_volume: nil, name: nil, opt_in: nil,
+                 production_message_content: 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 || {}),
+              brand: brand,
+              campaignId: campaign_id,
+              monthlyVolume: monthly_volume,
+              name: name,
+              optIn: opt_in,
+              productionMessageContent: production_message_content,
+              useCase: use_case
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/campaigns/toll-free"
+          end
+          Pinnacle::Types::TollFreeCampaignWithExtendedBrandAndStatus.from_json(json_object: response.body)
+        end
+      end
+
+      # Validate your toll-free 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 (Integer)
+      # @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.toll_free.validate(request: { additional_info: "Please validate this DLC campaign for 10DLC compliance", campaign_id: 161 })
+      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/toll-free/validate"
+          end
+          Pinnacle::Types::CampaignValidationResult.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/rcs/campaigns/toll_free/types/toll_free_autofill_response.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative "../../../types/message_volume_enum"
+require_relative "../../../types/toll_free_campaign_schema_opt_in"
+require_relative "../../../types/toll_free_campaign_schema_use_case"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        class TollFreeAutofillResponse
+          # @return [Integer]
+          attr_reader :brand
+          # @return [Integer] Unique identifier for the campaign.
+          attr_reader :campaign_id
+          # @return [Pinnacle::Types::MessageVolumeEnum]
+          attr_reader :monthly_volume
+          # @return [String] Display name of the campaign.
+          attr_reader :name
+          # @return [Pinnacle::Types::TollFreeCampaignSchemaOptIn] Opt-in keyword settings.
+          attr_reader :opt_in
+          # @return [String] Explain message that would be sent.
+          attr_reader :production_message_content
+          # @return [Pinnacle::Types::TollFreeCampaignSchemaUseCase] Use case classification for the campaign.
+          attr_reader :use_case
+          # @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 brand [Integer]
+          # @param campaign_id [Integer] Unique identifier for the campaign.
+          # @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
+          # @param name [String] Display name of the campaign.
+          # @param opt_in [Pinnacle::Types::TollFreeCampaignSchemaOptIn] Opt-in keyword settings.
+          # @param production_message_content [String] Explain message that would be sent.
+          # @param use_case [Pinnacle::Types::TollFreeCampaignSchemaUseCase] Use case classification for the campaign.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeAutofillResponse]
+          def initialize(brand: OMIT, campaign_id: OMIT, monthly_volume: OMIT, name: OMIT, opt_in: OMIT,
+                         production_message_content: OMIT, use_case: OMIT, additional_properties: nil)
+            @brand = brand if brand != OMIT
+            @campaign_id = campaign_id if campaign_id != OMIT
+            @monthly_volume = monthly_volume if monthly_volume != OMIT
+            @name = name if name != OMIT
+            @opt_in = opt_in if opt_in != OMIT
+            @production_message_content = production_message_content if production_message_content != OMIT
+            @use_case = use_case if use_case != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "brand": brand,
+              "campaignId": campaign_id,
+              "monthlyVolume": monthly_volume,
+              "name": name,
+              "optIn": opt_in,
+              "productionMessageContent": production_message_content,
+              "useCase": use_case
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of TollFreeAutofillResponse
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeAutofillResponse]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            brand = parsed_json["brand"]
+            campaign_id = parsed_json["campaignId"]
+            monthly_volume = parsed_json["monthlyVolume"]
+            name = parsed_json["name"]
+            if parsed_json["optIn"].nil?
+              opt_in = nil
+            else
+              opt_in = parsed_json["optIn"].to_json
+              opt_in = Pinnacle::Types::TollFreeCampaignSchemaOptIn.from_json(json_object: opt_in)
+            end
+            production_message_content = parsed_json["productionMessageContent"]
+            if parsed_json["useCase"].nil?
+              use_case = nil
+            else
+              use_case = parsed_json["useCase"].to_json
+              use_case = Pinnacle::Types::TollFreeCampaignSchemaUseCase.from_json(json_object: use_case)
+            end
+            new(
+              brand: brand,
+              campaign_id: campaign_id,
+              monthly_volume: monthly_volume,
+              name: name,
+              opt_in: opt_in,
+              production_message_content: production_message_content,
+              use_case: use_case,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of TollFreeAutofillResponse 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.brand&.is_a?(Integer) != false || raise("Passed value for field obj.brand 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.monthly_volume&.is_a?(Pinnacle::Types::MessageVolumeEnum) != false || raise("Passed value for field obj.monthly_volume is not the expected type, validation failed.")
+            obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+            obj.opt_in.nil? || Pinnacle::Types::TollFreeCampaignSchemaOptIn.validate_raw(obj: obj.opt_in)
+            obj.production_message_content&.is_a?(String) != false || raise("Passed value for field obj.production_message_content is not the expected type, validation failed.")
+            obj.use_case.nil? || Pinnacle::Types::TollFreeCampaignSchemaUseCase.validate_raw(obj: obj.use_case)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rcs/campaigns/toll_free/types/upsert_toll_free_schema_opt_in.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "../../../types/opt_in_method_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Opt-in keyword settings.
+        class UpsertTollFreeSchemaOptIn
+          # @return [Pinnacle::Types::OptInMethodEnum]
+          attr_reader :method
+          # @return [String] Url to opt in.
+          attr_reader :url
+          # @return [String] Explain how users find the opt-in.
+          attr_reader :workflow_description
+          # @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 method [Pinnacle::Types::OptInMethodEnum]
+          # @param url [String] Url to opt in.
+          # @param workflow_description [String] Explain how users find the opt-in.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaOptIn]
+          def initialize(method: OMIT, url: OMIT, workflow_description: OMIT, additional_properties: nil)
+            @method = method if method != OMIT
+            @url = url if url != OMIT
+            @workflow_description = workflow_description if workflow_description != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "method": method,
+              "url": url,
+              "workflowDescription": workflow_description
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of UpsertTollFreeSchemaOptIn
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaOptIn]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            method = parsed_json["method"]
+            url = parsed_json["url"]
+            workflow_description = parsed_json["workflowDescription"]
+            new(
+              method: method,
+              url: url,
+              workflow_description: workflow_description,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of UpsertTollFreeSchemaOptIn 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.method&.is_a?(Pinnacle::Types::OptInMethodEnum) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
+            obj.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+            obj.workflow_description&.is_a?(String) != false || raise("Passed value for field obj.workflow_description is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end