Class: SquareConnect::OrderReturnServiceCharge
- Inherits:
-
Object
- Object
- SquareConnect::OrderReturnServiceCharge
- Defined in:
- lib/square_connect/models/order_return_service_charge.rb
Overview
The service charge applied to the original order.
Instance Attribute Summary collapse
-
#amount_money ⇒ Object
The amount of a non-percentage based service charge.
-
#applied_money ⇒ Object
The amount of money applied to the order by the service charge, as calculated by the server.
-
#calculation_phase ⇒ Object
The calculation phase after which to apply the service charge.
-
#catalog_object_id ⇒ Object
The ID referencing the service charge [CatalogObject](#type-catalogobject).
-
#name ⇒ Object
The name of the service charge.
-
#percentage ⇒ Object
The percentage of the service charge, as a string representation of a decimal number.
-
#return_taxes ⇒ Object
The taxes which apply to the service charge.
-
#source_service_charge_uid ⇒ Object
‘uid` of the Service Charge from the Order which contains the original charge of this service charge, null for unlinked returns.
-
#taxable ⇒ Object
Indicates whether the surcharge can be taxed.
-
#total_money ⇒ Object
The total amount of money to collect for the service charge.
-
#total_tax_money ⇒ Object
The total amount of tax money to collect for the service charge.
-
#uid ⇒ Object
Unique ID that identifies the return service charge only within this order.
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 = {}) ⇒ OrderReturnServiceCharge
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 = {}) ⇒ OrderReturnServiceCharge
Initializes the object
90 91 92 93 94 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 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 90 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?(:'uid') self.uid = attributes[:'uid'] end if attributes.has_key?(:'source_service_charge_uid') self.source_service_charge_uid = attributes[:'source_service_charge_uid'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'catalog_object_id') self.catalog_object_id = attributes[:'catalog_object_id'] end if attributes.has_key?(:'percentage') self.percentage = attributes[:'percentage'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end if attributes.has_key?(:'applied_money') self.applied_money = attributes[:'applied_money'] end if attributes.has_key?(:'total_money') self.total_money = attributes[:'total_money'] end if attributes.has_key?(:'total_tax_money') self.total_tax_money = attributes[:'total_tax_money'] end if attributes.has_key?(:'calculation_phase') self.calculation_phase = attributes[:'calculation_phase'] end if attributes.has_key?(:'taxable') self.taxable = attributes[:'taxable'] end if attributes.has_key?(:'return_taxes') if (value = attributes[:'return_taxes']).is_a?(Array) self.return_taxes = value end end end |
Instance Attribute Details
#amount_money ⇒ Object
The amount of a non-percentage based service charge. Exactly one of percentage or amount_money should be set.
31 32 33 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 31 def amount_money @amount_money end |
#applied_money ⇒ Object
The amount of money applied to the order by the service charge, as calculated by the server. For fixed-amount service charges, ‘applied_money` is equal to `amount_money`. For percentage-based service charges, `applied_money` is the money calculated using the percentage. The `applied_money` field will include any inclusive tax amounts as well. This field is read-only.
34 35 36 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 34 def applied_money @applied_money end |
#calculation_phase ⇒ Object
The calculation phase after which to apply the service charge. This field is read-only. See [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values
43 44 45 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 43 def calculation_phase @calculation_phase end |
#catalog_object_id ⇒ Object
The ID referencing the service charge [CatalogObject](#type-catalogobject)
25 26 27 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 25 def catalog_object_id @catalog_object_id end |
#name ⇒ Object
The name of the service charge.
22 23 24 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 22 def name @name end |
#percentage ⇒ Object
The percentage of the service charge, as a string representation of a decimal number. A value of ‘7.25` corresponds to a percentage of 7.25%. Exactly one of percentage or amount_money should be set.
28 29 30 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 28 def percentage @percentage end |
#return_taxes ⇒ Object
The taxes which apply to the service charge. Return-level taxes apply by default to service charge calculated in the ‘SUBTOTAL_PHASE` if the service charge is marked as taxable.
49 50 51 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 49 def return_taxes @return_taxes end |
#source_service_charge_uid ⇒ Object
‘uid` of the Service Charge from the Order which contains the original charge of this service charge, null for unlinked returns.
19 20 21 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 19 def source_service_charge_uid @source_service_charge_uid end |
#taxable ⇒ Object
Indicates whether the surcharge can be taxed. Service charges calculated in the ‘TOTAL_PHASE` cannot be marked as taxable.
46 47 48 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 46 def taxable @taxable end |
#total_money ⇒ Object
The total amount of money to collect for the service charge. Note that ‘total_money` does not equal `applied_money` plus `total_tax_money` if an inclusive tax is applied to the service charge since the inclusive tax amount will be included in both `applied_money` and `total_tax_money`. This field is read-only.
37 38 39 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 37 def total_money @total_money end |
#total_tax_money ⇒ Object
The total amount of tax money to collect for the service charge. This field is read-only.
40 41 42 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 40 def total_tax_money @total_tax_money end |
#uid ⇒ Object
Unique ID that identifies the return service charge only within this order. This field is read-only.
16 17 18 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 16 def uid @uid end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 53 def self.attribute_map { :'uid' => :'uid', :'source_service_charge_uid' => :'source_service_charge_uid', :'name' => :'name', :'catalog_object_id' => :'catalog_object_id', :'percentage' => :'percentage', :'amount_money' => :'amount_money', :'applied_money' => :'applied_money', :'total_money' => :'total_money', :'total_tax_money' => :'total_tax_money', :'calculation_phase' => :'calculation_phase', :'taxable' => :'taxable', :'return_taxes' => :'return_taxes' } end |
.swagger_types ⇒ Object
Attribute type mapping.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 71 def self.swagger_types { :'uid' => :'String', :'source_service_charge_uid' => :'String', :'name' => :'String', :'catalog_object_id' => :'String', :'percentage' => :'String', :'amount_money' => :'Money', :'applied_money' => :'Money', :'total_money' => :'Money', :'total_tax_money' => :'Money', :'calculation_phase' => :'String', :'taxable' => :'BOOLEAN', :'return_taxes' => :'Array<OrderReturnTax>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 243 def ==(o) return true if self.equal?(o) self.class == o.class && uid == o.uid && source_service_charge_uid == o.source_service_charge_uid && name == o.name && catalog_object_id == o.catalog_object_id && percentage == o.percentage && amount_money == o.amount_money && applied_money == o.applied_money && total_money == o.total_money && total_tax_money == o.total_tax_money && calculation_phase == o.calculation_phase && taxable == o.taxable && return_taxes == o.return_taxes end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 296 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
362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 362 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
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 275 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
262 263 264 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 262 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
268 269 270 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 268 def hash [uid, source_service_charge_uid, name, catalog_object_id, percentage, amount_money, applied_money, total_money, total_tax_money, calculation_phase, taxable, return_taxes].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 150 def list_invalid_properties invalid_properties = Array.new if !@uid.nil? && @uid.to_s.length > 60 invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.") end if !@source_service_charge_uid.nil? && @source_service_charge_uid.to_s.length > 60 invalid_properties.push("invalid value for 'source_service_charge_uid', the character length must be smaller than or equal to 60.") end if !@name.nil? && @name.to_s.length > 255 invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.") end if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192 invalid_properties.push("invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192.") end if !@percentage.nil? && @percentage.to_s.length > 10 invalid_properties.push("invalid value for 'percentage', the character length must be smaller than or equal to 10.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
342 343 344 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 342 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
348 349 350 351 352 353 354 355 356 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 348 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
336 337 338 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 336 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
177 178 179 180 181 182 183 184 |
# File 'lib/square_connect/models/order_return_service_charge.rb', line 177 def valid? return false if !@uid.nil? && @uid.to_s.length > 60 return false if !@source_service_charge_uid.nil? && @source_service_charge_uid.to_s.length > 60 return false if !@name.nil? && @name.to_s.length > 255 return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192 return false if !@percentage.nil? && @percentage.to_s.length > 10 return true end |