Class: SquareConnect::CatalogItemModifierListInfo
- Inherits:
-
Object
- Object
- SquareConnect::CatalogItemModifierListInfo
- Defined in:
- lib/square_connect/models/catalog_item_modifier_list_info.rb
Overview
Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as it applies to this [CatalogItem](#type-catalogitem).
Instance Attribute Summary collapse
-
#enabled ⇒ Object
If ‘true`, enable this [CatalogModifierList](#type-catalogmodifierlist).
-
#max_selected_modifiers ⇒ Object
If zero or larger, the largest number of [CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList](#type-catalogmodifierlist).
-
#min_selected_modifiers ⇒ Object
If zero or larger, the smallest number of [CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList](#type-catalogmodifierlist).
-
#modifier_list_id ⇒ Object
The ID of the [CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo](#type-catalogmodifierlistinfo).
-
#modifier_overrides ⇒ Object
A set of [CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier](#type-catalogmodifier) is enabled by default.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CatalogItemModifierListInfo
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ CatalogItemModifierListInfo
Initializes the object
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 55 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'modifier_list_id') self.modifier_list_id = attributes[:'modifier_list_id'] end if attributes.has_key?(:'modifier_overrides') if (value = attributes[:'modifier_overrides']).is_a?(Array) self.modifier_overrides = value end end if attributes.has_key?(:'min_selected_modifiers') self.min_selected_modifiers = attributes[:'min_selected_modifiers'] end if attributes.has_key?(:'max_selected_modifiers') self.max_selected_modifiers = attributes[:'max_selected_modifiers'] end if attributes.has_key?(:'enabled') self.enabled = attributes[:'enabled'] end end |
Instance Attribute Details
#enabled ⇒ Object
If ‘true`, enable this [CatalogModifierList](#type-catalogmodifierlist).
28 29 30 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 28 def enabled @enabled end |
#max_selected_modifiers ⇒ Object
If zero or larger, the largest number of [CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList](#type-catalogmodifierlist).
25 26 27 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 25 def max_selected_modifiers @max_selected_modifiers end |
#min_selected_modifiers ⇒ Object
If zero or larger, the smallest number of [CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList](#type-catalogmodifierlist).
22 23 24 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 22 def min_selected_modifiers @min_selected_modifiers end |
#modifier_list_id ⇒ Object
The ID of the [CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo](#type-catalogmodifierlistinfo).
16 17 18 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 16 def modifier_list_id @modifier_list_id end |
#modifier_overrides ⇒ Object
A set of [CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier](#type-catalogmodifier) is enabled by default.
19 20 21 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 19 def modifier_overrides @modifier_overrides end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
32 33 34 35 36 37 38 39 40 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 32 def self.attribute_map { :'modifier_list_id' => :'modifier_list_id', :'modifier_overrides' => :'modifier_overrides', :'min_selected_modifiers' => :'min_selected_modifiers', :'max_selected_modifiers' => :'max_selected_modifiers', :'enabled' => :'enabled' } end |
.swagger_types ⇒ Object
Attribute type mapping.
43 44 45 46 47 48 49 50 51 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 43 def self.swagger_types { :'modifier_list_id' => :'String', :'modifier_overrides' => :'Array<CatalogModifierOverride>', :'min_selected_modifiers' => :'Integer', :'max_selected_modifiers' => :'Integer', :'enabled' => :'BOOLEAN' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
124 125 126 127 128 129 130 131 132 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 124 def ==(o) return true if self.equal?(o) self.class == o.class && modifier_list_id == o.modifier_list_id && modifier_overrides == o.modifier_overrides && min_selected_modifiers == o.min_selected_modifiers && max_selected_modifiers == o.max_selected_modifiers && enabled == o.enabled end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 170 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 temp_model = SquareConnect.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 236 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 149 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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 |
#eql?(o) ⇒ Boolean
136 137 138 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 136 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
142 143 144 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 142 def hash [modifier_list_id, modifier_overrides, min_selected_modifiers, max_selected_modifiers, enabled].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 87 def list_invalid_properties invalid_properties = Array.new if @modifier_list_id.nil? invalid_properties.push("invalid value for 'modifier_list_id', modifier_list_id cannot be nil.") end if @modifier_list_id.to_s.length < 1 invalid_properties.push("invalid value for 'modifier_list_id', the character length must be great than or equal to 1.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
216 217 218 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 216 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
222 223 224 225 226 227 228 229 230 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 222 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
210 211 212 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 210 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
102 103 104 105 106 |
# File 'lib/square_connect/models/catalog_item_modifier_list_info.rb', line 102 def valid? return false if @modifier_list_id.nil? return false if @modifier_list_id.to_s.length < 1 return true end |