Class: SquareConnect::CreateOrderRequestDiscount
- Inherits:
-
Object
- Object
- SquareConnect::CreateOrderRequestDiscount
- Defined in:
- lib/square_connect/models/create_order_request_discount.rb
Overview
Represents a discount that can apply to either a single line item or an entire order.
Instance Attribute Summary collapse
-
#amount_money ⇒ Object
Only used for ad hoc discounts.
-
#catalog_object_id ⇒ Object
Only used for catalog discounts.
-
#name ⇒ Object
Only used for ad hoc discounts.
-
#percentage ⇒ Object
Only used for ad hoc discounts.
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 = {}) ⇒ CreateOrderRequestDiscount
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 = {}) ⇒ CreateOrderRequestDiscount
Initializes the object
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 50 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?(:'percentage') self.percentage = attributes[:'percentage'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end end |
Instance Attribute Details
#amount_money ⇒ Object
Only used for ad hoc discounts. The monetary amount of the discount.
25 26 27 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 25 def amount_money @amount_money end |
#catalog_object_id ⇒ Object
Only used for catalog discounts. The catalog object ID for an existing [CatalogDiscount](#type-catalogdiscount). Do not provide a value for this field if you provide values in other fields for an ad hoc discount.
16 17 18 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 16 def catalog_object_id @catalog_object_id end |
#name ⇒ Object
Only used for ad hoc discounts. The discount’s name.
19 20 21 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 19 def name @name end |
#percentage ⇒ Object
Only used for ad hoc discounts. The percentage of the discount, 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
22 23 24 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 22 def percentage @percentage end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
29 30 31 32 33 34 35 36 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 29 def self.attribute_map { :'catalog_object_id' => :'catalog_object_id', :'name' => :'name', :'percentage' => :'percentage', :'amount_money' => :'amount_money' } end |
.swagger_types ⇒ Object
Attribute type mapping.
39 40 41 42 43 44 45 46 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 39 def self.swagger_types { :'catalog_object_id' => :'String', :'name' => :'String', :'percentage' => :'String', :'amount_money' => :'Money' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
137 138 139 140 141 142 143 144 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 137 def ==(o) return true if self.equal?(o) self.class == o.class && catalog_object_id == o.catalog_object_id && name == o.name && percentage == o.percentage && amount_money == o.amount_money end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 213 214 215 216 217 218 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 182 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
248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 248 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
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 161 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
148 149 150 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 148 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
154 155 156 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 154 def hash [catalog_object_id, name, percentage, amount_money].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 76 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)
228 229 230 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 228 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
234 235 236 237 238 239 240 241 242 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 234 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
222 223 224 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 222 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
95 96 97 98 99 100 |
# File 'lib/square_connect/models/create_order_request_discount.rb', line 95 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 return false if !@percentage.nil? && @percentage.to_s.length > 10 return true end |