Class: SquareConnect::V1PaymentSurcharge
- Inherits:
-
Object
- Object
- SquareConnect::V1PaymentSurcharge
- Defined in:
- lib/square_connect/models/v1_payment_surcharge.rb
Overview
V1PaymentSurcharge
Instance Attribute Summary collapse
-
#amount_money ⇒ Object
The amount of the surcharge as a Money object.
-
#applied_money ⇒ Object
The amount of money applied to the order as a result of the surcharge.
-
#name ⇒ Object
The name of the surcharge.
-
#rate ⇒ Object
The amount of the surcharge as a percentage.
-
#surcharge_id ⇒ Object
A Square-issued unique identifier associated with the surcharge.
-
#taxable ⇒ Object
Indicates whether the surcharge is taxable.
-
#taxes ⇒ Object
The list of taxes that should be applied to the surcharge.
-
#type ⇒ Object
Indicates the source of the surcharge.
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 = {}) ⇒ V1PaymentSurcharge
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 = {}) ⇒ V1PaymentSurcharge
Initializes the object
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 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 70 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?(:'applied_money') self.applied_money = attributes[:'applied_money'] end if attributes.has_key?(:'rate') self.rate = attributes[:'rate'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'taxable') self.taxable = attributes[:'taxable'] end if attributes.has_key?(:'taxes') if (value = attributes[:'taxes']).is_a?(Array) self.taxes = value end end if attributes.has_key?(:'surcharge_id') self.surcharge_id = attributes[:'surcharge_id'] end end |
Instance Attribute Details
#amount_money ⇒ Object
The amount of the surcharge as a Money object. Exactly one of rate or amount_money should be set.
25 26 27 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 25 def amount_money @amount_money end |
#applied_money ⇒ Object
The amount of money applied to the order as a result of the surcharge.
19 20 21 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 19 def applied_money @applied_money end |
#name ⇒ Object
The name of the surcharge.
16 17 18 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 16 def name @name end |
#rate ⇒ Object
The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set.
22 23 24 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 22 def rate @rate end |
#surcharge_id ⇒ Object
A Square-issued unique identifier associated with the surcharge.
37 38 39 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 37 def surcharge_id @surcharge_id end |
#taxable ⇒ Object
Indicates whether the surcharge is taxable.
31 32 33 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 31 def taxable @taxable end |
#taxes ⇒ Object
The list of taxes that should be applied to the surcharge.
34 35 36 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 34 def taxes @taxes end |
#type ⇒ Object
Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. See [V1PaymentSurchargeType](#type-v1paymentsurchargetype) for possible values
28 29 30 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 28 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 41 def self.attribute_map { :'name' => :'name', :'applied_money' => :'applied_money', :'rate' => :'rate', :'amount_money' => :'amount_money', :'type' => :'type', :'taxable' => :'taxable', :'taxes' => :'taxes', :'surcharge_id' => :'surcharge_id' } end |
.swagger_types ⇒ Object
Attribute type mapping.
55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 55 def self.swagger_types { :'name' => :'String', :'applied_money' => :'V1Money', :'rate' => :'String', :'amount_money' => :'V1Money', :'type' => :'String', :'taxable' => :'BOOLEAN', :'taxes' => :'Array<V1PaymentTax>', :'surcharge_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 127 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && applied_money == o.applied_money && rate == o.rate && amount_money == o.amount_money && type == o.type && taxable == o.taxable && taxes == o.taxes && surcharge_id == o.surcharge_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 207 208 209 210 211 212 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 176 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
242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 242 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
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 155 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
142 143 144 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 142 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
148 149 150 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 148 def hash [name, applied_money, rate, amount_money, type, taxable, taxes, surcharge_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
114 115 116 117 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 114 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)
222 223 224 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 222 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
228 229 230 231 232 233 234 235 236 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 228 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
216 217 218 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 216 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
121 122 123 |
# File 'lib/square_connect/models/v1_payment_surcharge.rb', line 121 def valid? return true end |