Class: SquareConnect::V1ModifierOption
- Inherits:
-
Object
- Object
- SquareConnect::V1ModifierOption
- Defined in:
- lib/square_connect/models/v1_modifier_option.rb
Overview
V1ModifierOption
Instance Attribute Summary collapse
-
#id ⇒ Object
The modifier option’s unique ID.
-
#modifier_list_id ⇒ Object
The ID of the modifier list the option belongs to.
-
#name ⇒ Object
The modifier option’s name.
-
#on_by_default ⇒ Object
If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.
-
#ordinal ⇒ Object
Indicates the modifier option’s list position when displayed in Square Register and the merchant dashboard.
-
#price_money ⇒ Object
The modifier option’s price.
-
#v2_id ⇒ Object
The ID of the CatalogObject in the Connect v2 API.
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 = {}) ⇒ V1ModifierOption
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 = {}) ⇒ V1ModifierOption
Initializes the object
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 65 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'price_money') self.price_money = attributes[:'price_money'] end if attributes.has_key?(:'on_by_default') self.on_by_default = attributes[:'on_by_default'] end if attributes.has_key?(:'ordinal') self.ordinal = attributes[:'ordinal'] end if attributes.has_key?(:'modifier_list_id') self.modifier_list_id = attributes[:'modifier_list_id'] end if attributes.has_key?(:'v2_id') self.v2_id = attributes[:'v2_id'] end end |
Instance Attribute Details
#id ⇒ Object
The modifier option’s unique ID.
16 17 18 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 16 def id @id end |
#modifier_list_id ⇒ Object
The ID of the modifier list the option belongs to.
31 32 33 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 31 def modifier_list_id @modifier_list_id end |
#name ⇒ Object
The modifier option’s name.
19 20 21 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 19 def name @name end |
#on_by_default ⇒ Object
If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.
25 26 27 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 25 def on_by_default @on_by_default end |
#ordinal ⇒ Object
Indicates the modifier option’s list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.
28 29 30 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 28 def ordinal @ordinal end |
#price_money ⇒ Object
The modifier option’s price.
22 23 24 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 22 def price_money @price_money end |
#v2_id ⇒ Object
The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
34 35 36 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 34 def v2_id @v2_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 38 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'price_money' => :'price_money', :'on_by_default' => :'on_by_default', :'ordinal' => :'ordinal', :'modifier_list_id' => :'modifier_list_id', :'v2_id' => :'v2_id' } end |
.swagger_types ⇒ Object
Attribute type mapping.
51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 51 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'price_money' => :'V1Money', :'on_by_default' => :'BOOLEAN', :'ordinal' => :'Integer', :'modifier_list_id' => :'String', :'v2_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 116 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && price_money == o.price_money && on_by_default == o.on_by_default && ordinal == o.ordinal && modifier_list_id == o.modifier_list_id && v2_id == o.v2_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
164 165 166 167 168 169 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 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 164 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
230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 230 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
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 143 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
130 131 132 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 130 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
136 137 138 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 136 def hash [id, name, price_money, on_by_default, ordinal, modifier_list_id, v2_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
103 104 105 106 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 103 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
210 211 212 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 210 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
216 217 218 219 220 221 222 223 224 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 216 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
204 205 206 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 204 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
110 111 112 |
# File 'lib/square_connect/models/v1_modifier_option.rb', line 110 def valid? return true end |