Class: SquareConnect::CreateOrderRequest
- Inherits:
-
Object
- Object
- SquareConnect::CreateOrderRequest
- Defined in:
- lib/square_connect/models/create_order_request.rb
Instance Attribute Summary collapse
-
#discounts ⇒ Object
__Deprecated__: Please set the discounts on the nested [order](#type-order) field instead.
-
#idempotency_key ⇒ Object
A value you specify that uniquely identifies this order among orders you’ve created.
-
#line_items ⇒ Object
__Deprecated__: Please set the line_items on the nested [order](#type-order) field instead.
-
#order ⇒ Object
The order to create.
-
#reference_id ⇒ Object
__Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead.
-
#taxes ⇒ Object
__Deprecated__: Please set the taxes on the nested [order](#type-order) field instead.
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 = {}) ⇒ CreateOrderRequest
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 = {}) ⇒ CreateOrderRequest
Initializes the object
60 61 62 63 64 65 66 67 68 69 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 |
# File 'lib/square_connect/models/create_order_request.rb', line 60 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?(:'order') self.order = attributes[:'order'] end if attributes.has_key?(:'idempotency_key') self.idempotency_key = attributes[:'idempotency_key'] end if attributes.has_key?(:'reference_id') self.reference_id = attributes[:'reference_id'] end if attributes.has_key?(:'line_items') if (value = attributes[:'line_items']).is_a?(Array) self.line_items = value end end if attributes.has_key?(:'taxes') if (value = attributes[:'taxes']).is_a?(Array) self.taxes = value end end if attributes.has_key?(:'discounts') if (value = attributes[:'discounts']).is_a?(Array) self.discounts = value end end end |
Instance Attribute Details
#discounts ⇒ Object
__Deprecated__: Please set the discounts on the nested [order](#type-order) field instead. The discounts to include on the order.
31 32 33 |
# File 'lib/square_connect/models/create_order_request.rb', line 31 def discounts @discounts end |
#idempotency_key ⇒ Object
A value you specify that uniquely identifies this order among orders you’ve created. If you’re unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](/basics/api101/idempotency) for more information.
19 20 21 |
# File 'lib/square_connect/models/create_order_request.rb', line 19 def idempotency_key @idempotency_key end |
#line_items ⇒ Object
__Deprecated__: Please set the line_items on the nested [order](#type-order) field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase.
25 26 27 |
# File 'lib/square_connect/models/create_order_request.rb', line 25 def line_items @line_items end |
#order ⇒ Object
The order to create. If this field is set, then the only other top-level field that can be set is the idempotency_key.
16 17 18 |
# File 'lib/square_connect/models/create_order_request.rb', line 16 def order @order end |
#reference_id ⇒ Object
__Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters.
22 23 24 |
# File 'lib/square_connect/models/create_order_request.rb', line 22 def reference_id @reference_id end |
#taxes ⇒ Object
__Deprecated__: Please set the taxes on the nested [order](#type-order) field instead. The taxes to include on the order.
28 29 30 |
# File 'lib/square_connect/models/create_order_request.rb', line 28 def taxes @taxes end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
35 36 37 38 39 40 41 42 43 44 |
# File 'lib/square_connect/models/create_order_request.rb', line 35 def self.attribute_map { :'order' => :'order', :'idempotency_key' => :'idempotency_key', :'reference_id' => :'reference_id', :'line_items' => :'line_items', :'taxes' => :'taxes', :'discounts' => :'discounts' } end |
.swagger_types ⇒ Object
Attribute type mapping.
47 48 49 50 51 52 53 54 55 56 |
# File 'lib/square_connect/models/create_order_request.rb', line 47 def self.swagger_types { :'order' => :'Order', :'idempotency_key' => :'String', :'reference_id' => :'String', :'line_items' => :'Array<CreateOrderRequestLineItem>', :'taxes' => :'Array<CreateOrderRequestTax>', :'discounts' => :'Array<CreateOrderRequestDiscount>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
145 146 147 148 149 150 151 152 153 154 |
# File 'lib/square_connect/models/create_order_request.rb', line 145 def ==(o) return true if self.equal?(o) self.class == o.class && order == o.order && idempotency_key == o.idempotency_key && reference_id == o.reference_id && line_items == o.line_items && taxes == o.taxes && discounts == o.discounts end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/square_connect/models/create_order_request.rb', line 192 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
258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/square_connect/models/create_order_request.rb', line 258 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
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/square_connect/models/create_order_request.rb', line 171 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
158 159 160 |
# File 'lib/square_connect/models/create_order_request.rb', line 158 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
164 165 166 |
# File 'lib/square_connect/models/create_order_request.rb', line 164 def hash [order, idempotency_key, reference_id, line_items, taxes, discounts].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/square_connect/models/create_order_request.rb', line 100 def list_invalid_properties invalid_properties = Array.new if !@idempotency_key.nil? && @idempotency_key.to_s.length > 192 invalid_properties.push("invalid value for 'idempotency_key', the character length must be smaller than or equal to 192.") end if !@reference_id.nil? && @reference_id.to_s.length > 40 invalid_properties.push("invalid value for 'reference_id', the character length must be smaller than or equal to 40.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
238 239 240 |
# File 'lib/square_connect/models/create_order_request.rb', line 238 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
244 245 246 247 248 249 250 251 252 |
# File 'lib/square_connect/models/create_order_request.rb', line 244 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
232 233 234 |
# File 'lib/square_connect/models/create_order_request.rb', line 232 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
115 116 117 118 119 |
# File 'lib/square_connect/models/create_order_request.rb', line 115 def valid? return false if !@idempotency_key.nil? && @idempotency_key.to_s.length > 192 return false if !@reference_id.nil? && @reference_id.to_s.length > 40 return true end |