class TalonOne::UpdateApplication
Attributes
Arbitrary properties associated with this campaign
Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to "universal"
A string indicating how should campaigns in this application deal with case sensitivity on coupon codes.
A string describing a default currency for new customer sessions.
The default scope to apply "setDiscount" effects on if no scope was provided with the effect.
A longer description of the application.
Flag indicating if discounts should cascade for this application
Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one
The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to "listOrder"
Default limits for campaigns created in this application
The name of this application.
Flag indicating if this is a live or sandbox application
A string containing an IANA timezone descriptor.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/talon_one/models/update_application.rb, line 81 def self.attribute_map { :'name' => :'name', :'description' => :'description', :'timezone' => :'timezone', :'currency' => :'currency', :'case_sensitivity' => :'caseSensitivity', :'attributes' => :'attributes', :'limits' => :'limits', :'campaign_priority' => :'campaignPriority', :'exclusive_campaigns_strategy' => :'exclusiveCampaignsStrategy', :'default_discount_scope' => :'defaultDiscountScope', :'enable_cascading_discounts' => :'enableCascadingDiscounts', :'enable_flattened_cart_items' => :'enableFlattenedCartItems', :'attributes_settings' => :'attributesSettings', :'sandbox' => :'sandbox' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/talon_one/models/update_application.rb, line 369 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/talon_one/models/update_application.rb, line 128 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::UpdateApplication` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::UpdateApplication`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'timezone') self.timezone = attributes[:'timezone'] end if attributes.key?(:'currency') self.currency = attributes[:'currency'] end if attributes.key?(:'case_sensitivity') self.case_sensitivity = attributes[:'case_sensitivity'] end if attributes.key?(:'attributes') self.attributes = attributes[:'attributes'] end if attributes.key?(:'limits') if (value = attributes[:'limits']).is_a?(Array) self.limits = value end end if attributes.key?(:'campaign_priority') self.campaign_priority = attributes[:'campaign_priority'] end if attributes.key?(:'exclusive_campaigns_strategy') self.exclusive_campaigns_strategy = attributes[:'exclusive_campaigns_strategy'] end if attributes.key?(:'default_discount_scope') self.default_discount_scope = attributes[:'default_discount_scope'] end if attributes.key?(:'enable_cascading_discounts') self.enable_cascading_discounts = attributes[:'enable_cascading_discounts'] end if attributes.key?(:'enable_flattened_cart_items') self.enable_flattened_cart_items = attributes[:'enable_flattened_cart_items'] end if attributes.key?(:'attributes_settings') self.attributes_settings = attributes[:'attributes_settings'] end if attributes.key?(:'sandbox') self.sandbox = attributes[:'sandbox'] end end
List of attributes with nullable: true
# File lib/talon_one/models/update_application.rb, line 121 def self.openapi_nullable Set.new([ ]) end
Attribute
type mapping.
# File lib/talon_one/models/update_application.rb, line 101 def self.openapi_types { :'name' => :'String', :'description' => :'String', :'timezone' => :'String', :'currency' => :'String', :'case_sensitivity' => :'String', :'attributes' => :'Object', :'limits' => :'Array<LimitConfig>', :'campaign_priority' => :'String', :'exclusive_campaigns_strategy' => :'String', :'default_discount_scope' => :'String', :'enable_cascading_discounts' => :'Boolean', :'enable_flattened_cart_items' => :'Boolean', :'attributes_settings' => :'AttributesSettings', :'sandbox' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/talon_one/models/update_application.rb, line 335 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && description == o.description && timezone == o.timezone && currency == o.currency && case_sensitivity == o.case_sensitivity && attributes == o.attributes && limits == o.limits && campaign_priority == o.campaign_priority && exclusive_campaigns_strategy == o.exclusive_campaigns_strategy && default_discount_scope == o.default_discount_scope && enable_cascading_discounts == o.enable_cascading_discounts && enable_flattened_cart_items == o.enable_flattened_cart_items && attributes_settings == o.attributes_settings && sandbox == o.sandbox end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/talon_one/models/update_application.rb, line 397 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model TalonOne.const_get(type).build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/talon_one/models/update_application.rb, line 466 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/talon_one/models/update_application.rb, line 376 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method checking allowed values (enum). @param [Object] campaign_priority
Object to be assigned
# File lib/talon_one/models/update_application.rb, line 305 def campaign_priority=(campaign_priority) validator = EnumAttributeValidator.new('String', ["universal", "stackable", "exclusive"]) unless validator.valid?(campaign_priority) fail ArgumentError, "invalid value for \"campaign_priority\", must be one of #{validator.allowable_values}." end @campaign_priority = campaign_priority end
Custom attribute writer method checking allowed values (enum). @param [Object] case_sensitivity
Object to be assigned
# File lib/talon_one/models/update_application.rb, line 295 def case_sensitivity=(case_sensitivity) validator = EnumAttributeValidator.new('String', ["sensitive", "insensitive-uppercase", "insensitive-lowercase"]) unless validator.valid?(case_sensitivity) fail ArgumentError, "invalid value for \"case_sensitivity\", must be one of #{validator.allowable_values}." end @case_sensitivity = case_sensitivity end
Custom attribute writer method with validation @param [Object] currency Value to be assigned
# File lib/talon_one/models/update_application.rb, line 281 def currency=(currency) if currency.nil? fail ArgumentError, 'currency cannot be nil' end if currency.to_s.length < 1 fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 1.' end @currency = currency end
Custom attribute writer method checking allowed values (enum). @param [Object] default_discount_scope
Object to be assigned
# File lib/talon_one/models/update_application.rb, line 325 def default_discount_scope=(default_discount_scope) validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"]) unless validator.valid?(default_discount_scope) fail ArgumentError, "invalid value for \"default_discount_scope\", must be one of #{validator.allowable_values}." end @default_discount_scope = default_discount_scope end
@see the `==` method @param [Object] Object to be compared
# File lib/talon_one/models/update_application.rb, line 356 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] exclusive_campaigns_strategy
Object to be assigned
# File lib/talon_one/models/update_application.rb, line 315 def exclusive_campaigns_strategy=(exclusive_campaigns_strategy) validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"]) unless validator.valid?(exclusive_campaigns_strategy) fail ArgumentError, "invalid value for \"exclusive_campaigns_strategy\", must be one of #{validator.allowable_values}." end @exclusive_campaigns_strategy = exclusive_campaigns_strategy end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/talon_one/models/update_application.rb, line 362 def hash [name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/talon_one/models/update_application.rb, line 202 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @name.to_s.length < 1 invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.') end if @timezone.nil? invalid_properties.push('invalid value for "timezone", timezone cannot be nil.') end if @timezone.to_s.length < 1 invalid_properties.push('invalid value for "timezone", the character length must be great than or equal to 1.') end if @currency.nil? invalid_properties.push('invalid value for "currency", currency cannot be nil.') end if @currency.to_s.length < 1 invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 1.') end invalid_properties end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/talon_one/models/update_application.rb, line 253 def name=(name) if name.nil? fail ArgumentError, 'name cannot be nil' end if name.to_s.length < 1 fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.' end @name = name end
Custom attribute writer method with validation @param [Object] timezone Value to be assigned
# File lib/talon_one/models/update_application.rb, line 267 def timezone=(timezone) if timezone.nil? fail ArgumentError, 'timezone cannot be nil' end if timezone.to_s.length < 1 fail ArgumentError, 'invalid value for "timezone", the character length must be great than or equal to 1.' end @timezone = timezone end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/talon_one/models/update_application.rb, line 448 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/talon_one/models/update_application.rb, line 436 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/talon_one/models/update_application.rb, line 233 def valid? return false if @name.nil? return false if @name.to_s.length < 1 return false if @timezone.nil? return false if @timezone.to_s.length < 1 return false if @currency.nil? return false if @currency.to_s.length < 1 case_sensitivity_validator = EnumAttributeValidator.new('String', ["sensitive", "insensitive-uppercase", "insensitive-lowercase"]) return false unless case_sensitivity_validator.valid?(@case_sensitivity) campaign_priority_validator = EnumAttributeValidator.new('String', ["universal", "stackable", "exclusive"]) return false unless campaign_priority_validator.valid?(@campaign_priority) exclusive_campaigns_strategy_validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"]) return false unless exclusive_campaigns_strategy_validator.valid?(@exclusive_campaigns_strategy) default_discount_scope_validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"]) return false unless default_discount_scope_validator.valid?(@default_discount_scope) true end