Class: SquareConnect::OrderLineItem
- Inherits:
-
Object
- Object
- SquareConnect::OrderLineItem
- Defined in:
- lib/square_connect/models/order_line_item.rb
Overview
Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.
Instance Attribute Summary collapse
-
#base_price_money ⇒ Object
The base price for a single unit of the line item.
-
#catalog_object_id ⇒ Object
The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item.
-
#discounts ⇒ Object
The discounts applied to this line item.
-
#gross_sales_money ⇒ Object
The gross sales amount of money calculated as (item base price + modifiers price) * quantity.
-
#modifiers ⇒ Object
The [CatalogModifier](#type-catalogmodifier)s applied to this line item.
-
#name ⇒ Object
The name of the line item.
-
#note ⇒ Object
The note of the line item.
-
#quantity ⇒ Object
The quantity purchased, as a string representation of a number.
-
#taxes ⇒ Object
The taxes applied to this line item.
-
#total_discount_money ⇒ Object
The total discount amount of money to collect for the line item.
-
#total_money ⇒ Object
The total amount of money to collect for this line item.
-
#total_tax_money ⇒ Object
The total tax amount of money to collect for the line item.
-
#variation_name ⇒ Object
The name of the variation applied to this line item.
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 = {}) ⇒ OrderLineItem
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 = {}) ⇒ OrderLineItem
Initializes the object
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/square_connect/models/order_line_item.rb', line 95 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'quantity') self.quantity = attributes[:'quantity'] end if attributes.has_key?(:'note') self.note = attributes[:'note'] end if attributes.has_key?(:'catalog_object_id') self.catalog_object_id = attributes[:'catalog_object_id'] end if attributes.has_key?(:'variation_name') self.variation_name = attributes[:'variation_name'] end if attributes.has_key?(:'modifiers') if (value = attributes[:'modifiers']).is_a?(Array) self.modifiers = value end end if attributes.has_key?(:'taxes') if (value = attributes[:'taxes']).is_a?(Array) self.taxes = value end end if attributes.has_key?(:'discounts') if (value = attributes[:'discounts']).is_a?(Array) self.discounts = value end end if attributes.has_key?(:'base_price_money') self.base_price_money = attributes[:'base_price_money'] end if attributes.has_key?(:'gross_sales_money') self.gross_sales_money = attributes[:'gross_sales_money'] end if attributes.has_key?(:'total_tax_money') self.total_tax_money = attributes[:'total_tax_money'] end if attributes.has_key?(:'total_discount_money') self.total_discount_money = attributes[:'total_discount_money'] end if attributes.has_key?(:'total_money') self.total_money = attributes[:'total_money'] end end |
Instance Attribute Details
#base_price_money ⇒ Object
The base price for a single unit of the line item.
40 41 42 |
# File 'lib/square_connect/models/order_line_item.rb', line 40 def base_price_money @base_price_money end |
#catalog_object_id ⇒ Object
The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item.
25 26 27 |
# File 'lib/square_connect/models/order_line_item.rb', line 25 def catalog_object_id @catalog_object_id end |
#discounts ⇒ Object
The discounts applied to this line item.
37 38 39 |
# File 'lib/square_connect/models/order_line_item.rb', line 37 def discounts @discounts end |
#gross_sales_money ⇒ Object
The gross sales amount of money calculated as (item base price + modifiers price) * quantity.
43 44 45 |
# File 'lib/square_connect/models/order_line_item.rb', line 43 def gross_sales_money @gross_sales_money end |
#modifiers ⇒ Object
The [CatalogModifier](#type-catalogmodifier)s applied to this line item.
31 32 33 |
# File 'lib/square_connect/models/order_line_item.rb', line 31 def modifiers @modifiers end |
#name ⇒ Object
The name of the line item.
16 17 18 |
# File 'lib/square_connect/models/order_line_item.rb', line 16 def name @name end |
#note ⇒ Object
The note of the line item.
22 23 24 |
# File 'lib/square_connect/models/order_line_item.rb', line 22 def note @note end |
#quantity ⇒ Object
The quantity purchased, as a string representation of a number.
19 20 21 |
# File 'lib/square_connect/models/order_line_item.rb', line 19 def quantity @quantity end |
#taxes ⇒ Object
The taxes applied to this line item.
34 35 36 |
# File 'lib/square_connect/models/order_line_item.rb', line 34 def taxes @taxes end |
#total_discount_money ⇒ Object
The total discount amount of money to collect for the line item.
49 50 51 |
# File 'lib/square_connect/models/order_line_item.rb', line 49 def total_discount_money @total_discount_money end |
#total_money ⇒ Object
The total amount of money to collect for this line item.
52 53 54 |
# File 'lib/square_connect/models/order_line_item.rb', line 52 def total_money @total_money end |
#total_tax_money ⇒ Object
The total tax amount of money to collect for the line item.
46 47 48 |
# File 'lib/square_connect/models/order_line_item.rb', line 46 def total_tax_money @total_tax_money end |
#variation_name ⇒ Object
The name of the variation applied to this line item.
28 29 30 |
# File 'lib/square_connect/models/order_line_item.rb', line 28 def variation_name @variation_name end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/square_connect/models/order_line_item.rb', line 56 def self.attribute_map { :'name' => :'name', :'quantity' => :'quantity', :'note' => :'note', :'catalog_object_id' => :'catalog_object_id', :'variation_name' => :'variation_name', :'modifiers' => :'modifiers', :'taxes' => :'taxes', :'discounts' => :'discounts', :'base_price_money' => :'base_price_money', :'gross_sales_money' => :'gross_sales_money', :'total_tax_money' => :'total_tax_money', :'total_discount_money' => :'total_discount_money', :'total_money' => :'total_money' } end |
.swagger_types ⇒ Object
Attribute type mapping.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/square_connect/models/order_line_item.rb', line 75 def self.swagger_types { :'name' => :'String', :'quantity' => :'String', :'note' => :'String', :'catalog_object_id' => :'String', :'variation_name' => :'String', :'modifiers' => :'Array<OrderLineItemModifier>', :'taxes' => :'Array<OrderLineItemTax>', :'discounts' => :'Array<OrderLineItemDiscount>', :'base_price_money' => :'Money', :'gross_sales_money' => :'Money', :'total_tax_money' => :'Money', :'total_discount_money' => :'Money', :'total_money' => :'Money' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/square_connect/models/order_line_item.rb', line 176 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && quantity == o.quantity && note == o.note && catalog_object_id == o.catalog_object_id && variation_name == o.variation_name && modifiers == o.modifiers && taxes == o.taxes && discounts == o.discounts && base_price_money == o.base_price_money && gross_sales_money == o.gross_sales_money && total_tax_money == o.total_tax_money && total_discount_money == o.total_discount_money && total_money == o.total_money end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/square_connect/models/order_line_item.rb', line 230 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
296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/square_connect/models/order_line_item.rb', line 296 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
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/square_connect/models/order_line_item.rb', line 209 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
196 197 198 |
# File 'lib/square_connect/models/order_line_item.rb', line 196 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
202 203 204 |
# File 'lib/square_connect/models/order_line_item.rb', line 202 def hash [name, quantity, note, catalog_object_id, variation_name, modifiers, taxes, discounts, base_price_money, gross_sales_money, total_tax_money, total_discount_money, total_money].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
163 164 165 166 |
# File 'lib/square_connect/models/order_line_item.rb', line 163 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)
276 277 278 |
# File 'lib/square_connect/models/order_line_item.rb', line 276 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
282 283 284 285 286 287 288 289 290 |
# File 'lib/square_connect/models/order_line_item.rb', line 282 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
270 271 272 |
# File 'lib/square_connect/models/order_line_item.rb', line 270 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
170 171 172 |
# File 'lib/square_connect/models/order_line_item.rb', line 170 def valid? return true end |