rcs 1.0.18 → 2.0.0.pre.rc.1

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative "upsert_dlc_schema_keywords_help"
+require_relative "upsert_dlc_schema_keywords_opt_in"
+require_relative "upsert_dlc_schema_keywords_opt_out"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Keyword response configuration.
+        class UpsertDlcSchemaKeywords
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsHelp] Help keyword settings.
+          attr_reader :help
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptIn] Opt-in keyword settings.
+          attr_reader :opt_in
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptOut] 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::UpsertDlcSchemaKeywordsHelp] Help keyword settings.
+          # @param opt_in [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptIn] Opt-in keyword settings.
+          # @param opt_out [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptOut] Opt-out keyword settings.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywords]
+          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 UpsertDlcSchemaKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywords]
+          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::UpsertDlcSchemaKeywordsHelp.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::UpsertDlcSchemaKeywordsOptIn.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::UpsertDlcSchemaKeywordsOptOut.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 UpsertDlcSchemaKeywords 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::UpsertDlcSchemaKeywordsHelp.validate_raw(obj: obj.help)
+            obj.opt_in.nil? || Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptIn.validate_raw(obj: obj.opt_in)
+            obj.opt_out.nil? || Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptOut.validate_raw(obj: obj.opt_out)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rcs/campaigns/dlc/types/upsert_dlc_schema_keywords_help.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 UpsertDlcSchemaKeywordsHelp
+          # @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::UpsertDlcSchemaKeywordsHelp]
+          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 UpsertDlcSchemaKeywordsHelp
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsHelp]
+          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 UpsertDlcSchemaKeywordsHelp 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/upsert_dlc_schema_keywords_opt_in.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Opt-in keyword settings.
+        class UpsertDlcSchemaKeywordsOptIn
+          # @return [String] Response message for opt-in keywords.
+          attr_reader :message
+          # @return [Array<String>] Keywords that trigger opt-in.
+          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 opt-in keywords.
+          # @param values [Array<String>] Keywords that trigger opt-in.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptIn]
+          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 UpsertDlcSchemaKeywordsOptIn
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptIn]
+          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 UpsertDlcSchemaKeywordsOptIn 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/upsert_dlc_schema_keywords_opt_out.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Opt-out keyword settings.
+        class UpsertDlcSchemaKeywordsOptOut
+          # @return [String] Response message for opt-out keywords.
+          attr_reader :message
+          # @return [Array<String>] Keywords that trigger opt-out.
+          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 opt-out keywords.
+          # @param values [Array<String>] Keywords that trigger opt-out.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptOut]
+          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 UpsertDlcSchemaKeywordsOptOut
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaKeywordsOptOut]
+          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 UpsertDlcSchemaKeywordsOptOut 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/upsert_dlc_schema_links.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Legal documentation links.
+        class UpsertDlcSchemaLinks
+          # @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::Dlc::Types::UpsertDlcSchemaLinks]
+          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 UpsertDlcSchemaLinks
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaLinks]
+          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 UpsertDlcSchemaLinks 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/dlc/types/upsert_dlc_schema_options.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Campaign configuration options.
+        class UpsertDlcSchemaOptions
+          # @return [Boolean] Whether the campaign uses affiliate marketing.
+          attr_reader :affiliate_marketing
+          # @return [Boolean] Whether the campaign is age-gated.
+          attr_reader :age_gated
+          # @return [Boolean] Whether the campaign involves direct lending.
+          attr_reader :direct_lending
+          # @return [String] Link embedded in campaign message.
+          attr_reader :embedded_link
+          # @return [Boolean] Whether messages include phone numbers.
+          attr_reader :embedded_phone
+          # @return [Boolean] Whether the campaign uses number pooling.
+          attr_reader :number_pooling
+          # @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 affiliate_marketing [Boolean] Whether the campaign uses affiliate marketing.
+          # @param age_gated [Boolean] Whether the campaign is age-gated.
+          # @param direct_lending [Boolean] Whether the campaign involves direct lending.
+          # @param embedded_link [String] Link embedded in campaign message.
+          # @param embedded_phone [Boolean] Whether messages include phone numbers.
+          # @param number_pooling [Boolean] Whether the campaign uses number pooling.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaOptions]
+          def initialize(affiliate_marketing: OMIT, age_gated: OMIT, direct_lending: OMIT, embedded_link: OMIT,
+                         embedded_phone: OMIT, number_pooling: OMIT, additional_properties: nil)
+            @affiliate_marketing = affiliate_marketing if affiliate_marketing != OMIT
+            @age_gated = age_gated if age_gated != OMIT
+            @direct_lending = direct_lending if direct_lending != OMIT
+            @embedded_link = embedded_link if embedded_link != OMIT
+            @embedded_phone = embedded_phone if embedded_phone != OMIT
+            @number_pooling = number_pooling if number_pooling != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "affiliateMarketing": affiliate_marketing,
+              "ageGated": age_gated,
+              "directLending": direct_lending,
+              "embeddedLink": embedded_link,
+              "embeddedPhone": embedded_phone,
+              "numberPooling": number_pooling
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of UpsertDlcSchemaOptions
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Dlc::Types::UpsertDlcSchemaOptions]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            affiliate_marketing = parsed_json["affiliateMarketing"]
+            age_gated = parsed_json["ageGated"]
+            direct_lending = parsed_json["directLending"]
+            embedded_link = parsed_json["embeddedLink"]
+            embedded_phone = parsed_json["embeddedPhone"]
+            number_pooling = parsed_json["numberPooling"]
+            new(
+              affiliate_marketing: affiliate_marketing,
+              age_gated: age_gated,
+              direct_lending: direct_lending,
+              embedded_link: embedded_link,
+              embedded_phone: embedded_phone,
+              number_pooling: number_pooling,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of UpsertDlcSchemaOptions 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.affiliate_marketing&.is_a?(Boolean) != false || raise("Passed value for field obj.affiliate_marketing is not the expected type, validation failed.")
+            obj.age_gated&.is_a?(Boolean) != false || raise("Passed value for field obj.age_gated is not the expected type, validation failed.")
+            obj.direct_lending&.is_a?(Boolean) != false || raise("Passed value for field obj.direct_lending is not the expected type, validation failed.")
+            obj.embedded_link&.is_a?(String) != false || raise("Passed value for field obj.embedded_link is not the expected type, validation failed.")
+            obj.embedded_phone&.is_a?(Boolean) != false || raise("Passed value for field obj.embedded_phone is not the expected type, validation failed.")
+            obj.number_pooling&.is_a?(Boolean) != false || raise("Passed value for field obj.number_pooling is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

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

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