class SquareConnect::OrderReturnServiceCharge
The service charge applied to the original order.
Attributes
The amount of a non-percentage based service charge. Exactly one of percentage or amount_money
should be set.
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.
The calculation phase after which to apply the service charge. This field is read-only. See [OrderServiceChargeCalculationPhase](type-orderservicechargecalculationphase) for possible values
The ID referencing the service charge [CatalogObject](type-catalogobject)
The name of the service charge.
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.
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.
`uid` of the Service Charge from the Order
which contains the original charge of this service charge, null for unlinked returns.
Indicates whether the surcharge can be taxed. Service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.
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.
The total amount of tax money to collect for the service charge. This field is read-only.
Unique ID that identifies the return service charge only within this order. This field is read-only.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
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/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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
Custom attribute writer method with validation @param [Object] catalog_object_id
Value to be assigned
# File lib/square_connect/models/order_return_service_charge.rb, line 221 def catalog_object_id=(catalog_object_id) if !catalog_object_id.nil? && catalog_object_id.to_s.length > 192 fail ArgumentError, "invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192." end @catalog_object_id = catalog_object_id end
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/order_return_service_charge.rb, line 262 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# 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
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/square_connect/models/order_return_service_charge.rb, line 210 def name=(name) if !name.nil? && name.to_s.length > 255 fail ArgumentError, "invalid value for 'name', the character length must be smaller than or equal to 255." end @name = name end
Custom attribute writer method with validation @param [Object] percentage Value to be assigned
# File lib/square_connect/models/order_return_service_charge.rb, line 232 def percentage=(percentage) if !percentage.nil? && percentage.to_s.length > 10 fail ArgumentError, "invalid value for 'percentage', the character length must be smaller than or equal to 10." end @percentage = percentage end
Custom attribute writer method with validation @param [Object] source_service_charge_uid
Value to be assigned
# File lib/square_connect/models/order_return_service_charge.rb, line 199 def source_service_charge_uid=(source_service_charge_uid) if !source_service_charge_uid.nil? && source_service_charge_uid.to_s.length > 60 fail ArgumentError, "invalid value for 'source_service_charge_uid', the character length must be smaller than or equal to 60." end @source_service_charge_uid = source_service_charge_uid end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/order_return_service_charge.rb, line 336 def to_s to_hash.to_s end
Custom attribute writer method with validation @param [Object] uid Value to be assigned
# File lib/square_connect/models/order_return_service_charge.rb, line 188 def uid=(uid) if !uid.nil? && uid.to_s.length > 60 fail ArgumentError, "invalid value for 'uid', the character length must be smaller than or equal to 60." end @uid = uid end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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