rcs 2.0.5.pre.rc.1 → 2.0.5

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignHelpKeywords
+          # @return [String] Message sent when a user sends HELP. Must include at least one support contact
+          #  method (phone, email, or website).<br>
+          #  Recommended format: [Verb] [Contact Information] for support.
+          attr_reader :message
+          # @return [Array<String>] Keywords that trigger help response (HELP, SUPPORT, INFO, etc).
+          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 sends HELP. Must include at least one support contact
+          #  method (phone, email, or website).<br>
+          #  Recommended format: [Verb] [Contact Information] for support.
+          # @param keywords [Array<String>] Keywords that trigger help response (HELP, SUPPORT, INFO, etc).
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignHelpKeywords]
+          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 RcsCampaignHelpKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignHelpKeywords]
+          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 RcsCampaignHelpKeywords 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/rcs/types/rcs_campaign_keywords.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative "rcs_campaign_help_keywords"
+require_relative "rcs_campaign_opt_in_keywords"
+require_relative "rcs_campaign_opt_out_keywords"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignKeywords
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignHelpKeywords]
+          attr_reader :help
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptInKeywords]
+          attr_reader :opt_in
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptOutKeywords]
+          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::Rcs::Types::RcsCampaignHelpKeywords]
+          # @param opt_in [Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptInKeywords]
+          # @param opt_out [Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptOutKeywords]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignKeywords]
+          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 RcsCampaignKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignKeywords]
+          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::Rcs::Types::RcsCampaignHelpKeywords.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::Rcs::Types::RcsCampaignOptInKeywords.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::Rcs::Types::RcsCampaignOptOutKeywords.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 RcsCampaignKeywords 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::Rcs::Types::RcsCampaignHelpKeywords.validate_raw(obj: obj.help)
+            obj.opt_in.nil? || Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptInKeywords.validate_raw(obj: obj.opt_in)
+            obj.opt_out.nil? || Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptOutKeywords.validate_raw(obj: obj.opt_out)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignOptInKeywords
+          # @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).<br>
+          #  Recommended Format:<br>
+          #  [Greetings]<br>
+          #  You are now subscribed to [Agent Name] and will receive [type of messages that
+          #  the agent will send]. Feel free to contact us any time for help. <br>
+          #  Reply STOP to opt out and HELP for support. Message & rates may apply.
+          attr_reader :message
+          # @return [Array<String>] Keywords that trigger opt-in response (START, SUBSCRIBE, JOIN, etc).
+          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).<br>
+          #  Recommended Format:<br>
+          #  [Greetings]<br>
+          #  You are now subscribed to [Agent Name] and will receive [type of messages that
+          #  the agent will send]. Feel free to contact us any time for help. <br>
+          #  Reply STOP to opt out and HELP for support. Message & rates may apply.
+          # @param keywords [Array<String>] Keywords that trigger opt-in response (START, SUBSCRIBE, JOIN, etc).
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptInKeywords]
+          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 RcsCampaignOptInKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptInKeywords]
+          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 RcsCampaignOptInKeywords 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/rcs/types/rcs_campaign_opt_out_keywords.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignOptOutKeywords
+          # @return [String] Message sent when a user opt-out. Must include brand name, acknowledge opt-out
+          #  request and state user will not receive further messages. No marketing or
+          #  re-engagement attempts.<br>
+          #  Recommended format: "You've been unsubscribed from [Agent Name] and will no
+          #  longer receive messages. If you ever change your mind, reply START or SUBSCRIBE
+          #  to rejoin anytime."
+          attr_reader :message
+          # @return [Array<String>] Keywords that trigger opt-out response (END, UNSUBSCRIBE, STOP, etc).
+          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-out. Must include brand name, acknowledge opt-out
+          #  request and state user will not receive further messages. No marketing or
+          #  re-engagement attempts.<br>
+          #  Recommended format: "You've been unsubscribed from [Agent Name] and will no
+          #  longer receive messages. If you ever change your mind, reply START or SUBSCRIBE
+          #  to rejoin anytime."
+          # @param keywords [Array<String>] Keywords that trigger opt-out response (END, UNSUBSCRIBE, STOP, etc).
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptOutKeywords]
+          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 RcsCampaignOptOutKeywords
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptOutKeywords]
+          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 RcsCampaignOptOutKeywords 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/rcs/types/rcs_campaign_traffic.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignTraffic
+          # @return [Integer] Estimated monthly website visitors.
+          attr_reader :monthly_website
+          # @return [Integer] Estimated monthly RCS messages sent.
+          attr_reader :monthly_rcs_estimate
+          # @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 monthly_website [Integer] Estimated monthly website visitors.
+          # @param monthly_rcs_estimate [Integer] Estimated monthly RCS messages sent.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignTraffic]
+          def initialize(monthly_website: OMIT, monthly_rcs_estimate: OMIT, additional_properties: nil)
+            @monthly_website = monthly_website if monthly_website != OMIT
+            @monthly_rcs_estimate = monthly_rcs_estimate if monthly_rcs_estimate != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "monthlyWebsite": monthly_website,
+              "monthlyRcsEstimate": monthly_rcs_estimate
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of RcsCampaignTraffic
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Campaigns::Rcs::Types::RcsCampaignTraffic]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            monthly_website = parsed_json["monthlyWebsite"]
+            monthly_rcs_estimate = parsed_json["monthlyRcsEstimate"]
+            new(
+              monthly_website: monthly_website,
+              monthly_rcs_estimate: monthly_rcs_estimate,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of RcsCampaignTraffic 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.monthly_website&.is_a?(Integer) != false || raise("Passed value for field obj.monthly_website is not the expected type, validation failed.")
+            obj.monthly_rcs_estimate&.is_a?(Integer) != false || raise("Passed value for field obj.monthly_rcs_estimate is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

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

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

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