rcs 2.0.5.pre.rc.1 → 2.0.5

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Help keyword settings.
+        class TollFreeCampaignHelpKeywords
+          # @return [String] Message sent when a user sends HELP. Must include at least one support contact
+          #  method (phone, email, or website).
+          attr_reader :message
+          # @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] Message sent when a user sends HELP. Must include at least one support contact
+          #  method (phone, email, or website).
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignHelpKeywords]
+          def initialize(message: OMIT, additional_properties: nil)
+            @message = message if message != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "message": message }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of TollFreeCampaignHelpKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignHelpKeywords]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            message = parsed_json["message"]
+            new(message: message, additional_properties: struct)
+          end
+
+          # Serialize an instance of TollFreeCampaignHelpKeywords 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.")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "toll_free_campaign_help_keywords"
+require_relative "toll_free_campaign_opt_in_keywords"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Keyword response configuration.
+        class TollFreeCampaignKeywords
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignHelpKeywords] Help keyword settings.
+          attr_reader :help
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptInKeywords] Opt-in keyword settings.
+          attr_reader :opt_in
+          # @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::TollFree::Types::TollFreeCampaignHelpKeywords] Help keyword settings.
+          # @param opt_in [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptInKeywords] Opt-in keyword settings.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignKeywords]
+          def initialize(help: OMIT, opt_in: OMIT, additional_properties: nil)
+            @help = help if help != OMIT
+            @opt_in = opt_in if opt_in != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "HELP": help, "OPT_IN": opt_in }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of TollFreeCampaignKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignKeywords]
+          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::TollFree::Types::TollFreeCampaignHelpKeywords.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::TollFree::Types::TollFreeCampaignOptInKeywords.from_json(json_object: opt_in)
+            end
+            new(
+              help: help,
+              opt_in: opt_in,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of TollFreeCampaignKeywords 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::TollFree::Types::TollFreeCampaignHelpKeywords.validate_raw(obj: obj.help)
+            obj.opt_in.nil? || Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptInKeywords.validate_raw(obj: obj.opt_in)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Legal documentation links.
+        class TollFreeCampaignLinks
+          # @return [String] Privacy policy URL.
+          attr_reader :privacy_policy
+          # @return [String] Terms of service URL.
+          attr_reader :terms_of_service
+          # @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 privacy_policy [String] Privacy policy URL.
+          # @param terms_of_service [String] Terms of service URL.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignLinks]
+          def initialize(privacy_policy: OMIT, terms_of_service: OMIT, additional_properties: nil)
+            @privacy_policy = privacy_policy if privacy_policy != OMIT
+            @terms_of_service = terms_of_service if terms_of_service != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "privacyPolicy": privacy_policy, "termsOfService": terms_of_service }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of TollFreeCampaignLinks
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignLinks]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            privacy_policy = parsed_json["privacyPolicy"]
+            terms_of_service = parsed_json["termsOfService"]
+            new(
+              privacy_policy: privacy_policy,
+              terms_of_service: terms_of_service,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of TollFreeCampaignLinks 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.privacy_policy&.is_a?(String) != false || raise("Passed value for field obj.privacy_policy is not the expected type, validation failed.")
+            obj.terms_of_service&.is_a?(String) != false || raise("Passed value for field obj.terms_of_service is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_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 TollFreeCampaignOptIn
+          # @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::TollFreeCampaignOptIn]
+          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 TollFreeCampaignOptIn
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptIn]
+          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 TollFreeCampaignOptIn 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

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Opt-in keyword settings.
+        class TollFreeCampaignOptInKeywords
+          # @return [String] Message sent when a user opt-in. Must include brand name, confirmation of
+          #  subscription, and disclosures (STOP and HELP instructions, message and data
+          #  rates).
+          attr_reader :message
+          # @return [Array<String>] Keywords that trigger opt-in response.
+          attr_reader :keywords
+          # @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] Message sent when a user opt-in. Must include brand name, confirmation of
+          #  subscription, and disclosures (STOP and HELP instructions, message and data
+          #  rates).
+          # @param keywords [Array<String>] Keywords that trigger opt-in response.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptInKeywords]
+          def initialize(message: OMIT, keywords: OMIT, additional_properties: nil)
+            @message = message if message != OMIT
+            @keywords = keywords if keywords != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "message": message, "keywords": keywords }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of TollFreeCampaignOptInKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptInKeywords]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            message = parsed_json["message"]
+            keywords = parsed_json["keywords"]
+            new(
+              message: message,
+              keywords: keywords,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of TollFreeCampaignOptInKeywords 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.keywords&.is_a?(Array) != false || raise("Passed value for field obj.keywords is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Campaign configuration options.
+        class TollFreeCampaignOptions
+          # @return [Boolean] Whether the campaign is age-gated.
+          attr_reader :age_gated
+          # @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 age_gated [Boolean] Whether the campaign is age-gated.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptions]
+          def initialize(age_gated: OMIT, additional_properties: nil)
+            @age_gated = age_gated if age_gated != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "ageGated": age_gated }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of TollFreeCampaignOptions
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptions]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            age_gated = parsed_json["ageGated"]
+            new(age_gated: age_gated, additional_properties: struct)
+          end
+
+          # Serialize an instance of TollFreeCampaignOptions 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.age_gated&.is_a?(Boolean) != false || raise("Passed value for field obj.age_gated is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "../../../types/toll_free_campaign_use_case_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Use case classification for the campaign.
+        class TollFreeCampaignUseCase
+          # @return [String] Summary of the use case.
+          attr_reader :summary
+          # @return [Pinnacle::Types::TollFreeCampaignUseCaseEnum]
+          attr_reader :value
+          # @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 summary [String] Summary of the use case.
+          # @param value [Pinnacle::Types::TollFreeCampaignUseCaseEnum]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignUseCase]
+          def initialize(summary: OMIT, value: OMIT, additional_properties: nil)
+            @summary = summary if summary != OMIT
+            @value = value if value != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "summary": summary, "value": value }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of TollFreeCampaignUseCase
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignUseCase]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            summary = parsed_json["summary"]
+            value = parsed_json["value"]
+            new(
+              summary: summary,
+              value: value,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of TollFreeCampaignUseCase 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.summary&.is_a?(String) != false || raise("Passed value for field obj.summary is not the expected type, validation failed.")
+            obj.value&.is_a?(Pinnacle::Types::TollFreeCampaignUseCaseEnum) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end