Class: SquareConnect::CreateOrderRequestTax
- Inherits:
-
Object
- Object
- SquareConnect::CreateOrderRequestTax
- Defined in:
- lib/square_connect/models/create_order_request_tax.rb
Overview
Represents a tax that can apply to either a single line item or an entire order.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#catalog_object_id ⇒ Object
Only used for catalog taxes.
-
#name ⇒ Object
Only used for ad hoc taxes.
-
#percentage ⇒ Object
Only used for ad hoc taxes.
-
#type ⇒ Object
Only used for ad hoc taxes.
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 = {}) ⇒ CreateOrderRequestTax
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 = {}) ⇒ CreateOrderRequestTax
Initializes the object
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 71 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?(:'catalog_object_id') self.catalog_object_id = attributes[:'catalog_object_id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'percentage') self.percentage = attributes[:'percentage'] end end |
Instance Attribute Details
#catalog_object_id ⇒ Object
Only used for catalog taxes. The catalog object ID of an existing [CatalogTax](#type-catalogtax). Do not provide a value for this field if you provide values in other fields for an ad hoc tax.
16 17 18 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 16 def catalog_object_id @catalog_object_id end |
#name ⇒ Object
Only used for ad hoc taxes. The tax’s name. Do not provide a value for this field if you set catalog_object_id.
19 20 21 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 19 def name @name end |
#percentage ⇒ Object
Only used for ad hoc taxes. The percentage of the tax, as a string representation of a decimal number. A value of ‘7.25` corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0
25 26 27 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 25 def percentage @percentage end |
#type ⇒ Object
Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: ‘ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values.
22 23 24 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 22 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
50 51 52 53 54 55 56 57 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 50 def self.attribute_map { :'catalog_object_id' => :'catalog_object_id', :'name' => :'name', :'type' => :'type', :'percentage' => :'percentage' } end |
.swagger_types ⇒ Object
Attribute type mapping.
60 61 62 63 64 65 66 67 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 60 def self.swagger_types { :'catalog_object_id' => :'String', :'name' => :'String', :'type' => :'String', :'percentage' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
170 171 172 173 174 175 176 177 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 170 def ==(o) return true if self.equal?(o) self.class == o.class && catalog_object_id == o.catalog_object_id && name == o.name && type == o.type && percentage == o.percentage end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 215 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
281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 281 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
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 194 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
181 182 183 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 181 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
187 188 189 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 187 def hash [catalog_object_id, name, type, percentage].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 97 def list_invalid_properties invalid_properties = Array.new 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 !@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 !@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)
261 262 263 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 261 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
267 268 269 270 271 272 273 274 275 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 267 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
255 256 257 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 255 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
116 117 118 119 120 121 122 123 |
# File 'lib/square_connect/models/create_order_request_tax.rb', line 116 def valid? return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192 return false if !@name.nil? && @name.to_s.length > 255 type_validator = EnumAttributeValidator.new('String', ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"]) return false unless type_validator.valid?(@type) return false if !@percentage.nil? && @percentage.to_s.length > 10 return true end |