Class: Patch::Order
- Inherits:
-
Object
- Object
- Patch::Order
- Defined in:
- lib/patch_ruby/models/order.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#amount ⇒ Object
The amount in ‘unit`s purchased through this order.
-
#created_at ⇒ Object
The timestamp at which the order was created.
-
#currency ⇒ Object
The currency code for the ‘price` and `patch_fee`.
-
#id ⇒ Object
A unique uid for the record.
-
#issued_to ⇒ Object
An object containing the name & email of the party the inventory will be issued to.
-
#line_items ⇒ Object
An array containing the line items allocated for this order.
-
#metadata ⇒ Object
An optional JSON object containing metadata for this order.
-
#patch_fee ⇒ Object
The Patch Fee for this order.
-
#price ⇒ Object
The total price for the ‘amount` ordered.
-
#production ⇒ Object
A boolean indicating if this order is a production or demo mode order.
-
#registry_url ⇒ Object
The URL of this order in the public registry.
-
#state ⇒ Object
The current state of the order.
-
#unit ⇒ Object
The unit of measurement (ie "g" or "Wh") for the ‘amount` ordered.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.method_missing(message, *args, &block) ⇒ Object
Allows models with corresponding API classes to delegate API operations to those API classes Exposes Model.operation_id which delegates to ModelsApi.new.operation_id Eg.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_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 ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Order
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 = {}) ⇒ Order
Initializes the object
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 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 |
# File 'lib/patch_ruby/models/order.rb', line 142 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Patch::Order` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Patch::Order`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'production') self.production = attributes[:'production'] end if attributes.key?(:'state') self.state = attributes[:'state'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'unit') self.unit = attributes[:'unit'] end if attributes.key?(:'price') self.price = attributes[:'price'] end if attributes.key?(:'patch_fee') self.patch_fee = attributes[:'patch_fee'] end if attributes.key?(:'currency') self.currency = attributes[:'currency'] end if attributes.key?(:'registry_url') self.registry_url = attributes[:'registry_url'] end if attributes.key?(:'metadata') self. = attributes[:'metadata'] end if attributes.key?(:'line_items') if (value = attributes[:'line_items']).is_a?(Array) self.line_items = value end end if attributes.key?(:'issued_to') if (value = attributes[:'issued_to']).is_a?(Hash) self.issued_to = value end self.issued_to = attributes[:'issued_to'] end end |
Instance Attribute Details
#amount ⇒ Object
The amount in ‘unit`s purchased through this order.
31 32 33 |
# File 'lib/patch_ruby/models/order.rb', line 31 def amount @amount end |
#created_at ⇒ Object
The timestamp at which the order was created
22 23 24 |
# File 'lib/patch_ruby/models/order.rb', line 22 def created_at @created_at end |
#currency ⇒ Object
The currency code for the ‘price` and `patch_fee`.
43 44 45 |
# File 'lib/patch_ruby/models/order.rb', line 43 def currency @currency end |
#id ⇒ Object
A unique uid for the record. UIDs will be prepended by ord_prod or ord_test depending on the mode it was created in.
19 20 21 |
# File 'lib/patch_ruby/models/order.rb', line 19 def id @id end |
#issued_to ⇒ Object
An object containing the name & email of the party the inventory will be issued to.
55 56 57 |
# File 'lib/patch_ruby/models/order.rb', line 55 def issued_to @issued_to end |
#line_items ⇒ Object
An array containing the line items allocated for this order. Line items are grouped by project, vintage year, and price.
52 53 54 |
# File 'lib/patch_ruby/models/order.rb', line 52 def line_items @line_items end |
#metadata ⇒ Object
An optional JSON object containing metadata for this order.
49 50 51 |
# File 'lib/patch_ruby/models/order.rb', line 49 def @metadata end |
#patch_fee ⇒ Object
The Patch Fee for this order. Patch Fee is always represented in the smallest currency unit (ie cents for USD).
40 41 42 |
# File 'lib/patch_ruby/models/order.rb', line 40 def patch_fee @patch_fee end |
#price ⇒ Object
The total price for the ‘amount` ordered. Prices are always represented in the smallest currency unit (ie cents for USD).
37 38 39 |
# File 'lib/patch_ruby/models/order.rb', line 37 def price @price end |
#production ⇒ Object
A boolean indicating if this order is a production or demo mode order.
25 26 27 |
# File 'lib/patch_ruby/models/order.rb', line 25 def production @production end |
#registry_url ⇒ Object
The URL of this order in the public registry. Use this URL to access the order’s accompanying certificate.
46 47 48 |
# File 'lib/patch_ruby/models/order.rb', line 46 def registry_url @registry_url end |
#state ⇒ Object
The current state of the order.
28 29 30 |
# File 'lib/patch_ruby/models/order.rb', line 28 def state @state end |
#unit ⇒ Object
The unit of measurement (ie "g" or "Wh") for the ‘amount` ordered.
34 35 36 |
# File 'lib/patch_ruby/models/order.rb', line 34 def unit @unit end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
99 100 101 |
# File 'lib/patch_ruby/models/order.rb', line 99 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/patch_ruby/models/order.rb', line 80 def self.attribute_map { :'id' => :'id', :'created_at' => :'created_at', :'production' => :'production', :'state' => :'state', :'amount' => :'amount', :'unit' => :'unit', :'price' => :'price', :'patch_fee' => :'patch_fee', :'currency' => :'currency', :'registry_url' => :'registry_url', :'metadata' => :'metadata', :'line_items' => :'line_items', :'issued_to' => :'issued_to' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
346 347 348 |
# File 'lib/patch_ruby/models/order.rb', line 346 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.method_missing(message, *args, &block) ⇒ Object
Allows models with corresponding API classes to delegate API operations to those API classes Exposes Model.operation_id which delegates to ModelsApi.new.operation_id Eg. Order.create_order delegates to OrdersApi.new.create_order
132 133 134 135 136 137 138 |
# File 'lib/patch_ruby/models/order.rb', line 132 def self.method_missing(, *args, &block) if Object.const_defined?('Patch::OrdersApi::OPERATIONS') && Patch::OrdersApi::OPERATIONS.include?() Patch::OrdersApi.new.send(, *args) else super end end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
123 124 125 126 |
# File 'lib/patch_ruby/models/order.rb', line 123 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/patch_ruby/models/order.rb', line 104 def self.openapi_types { :'id' => :'String', :'created_at' => :'Time', :'production' => :'Boolean', :'state' => :'String', :'amount' => :'Integer', :'unit' => :'String', :'price' => :'Integer', :'patch_fee' => :'Integer', :'currency' => :'String', :'registry_url' => :'String', :'metadata' => :'Object', :'line_items' => :'Array<OrderLineItem>', :'issued_to' => :'OrderIssuedTo' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/patch_ruby/models/order.rb', line 313 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && created_at == o.created_at && production == o.production && state == o.state && amount == o.amount && unit == o.unit && price == o.price && patch_fee == o.patch_fee && currency == o.currency && registry_url == o.registry_url && == o. && line_items == o.line_items && issued_to == o.issued_to end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/patch_ruby/models/order.rb', line 376 def _deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Patch.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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
447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/patch_ruby/models/order.rb', line 447 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
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/patch_ruby/models/order.rb', line 353 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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 end self end |
#eql?(o) ⇒ Boolean
333 334 335 |
# File 'lib/patch_ruby/models/order.rb', line 333 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
339 340 341 |
# File 'lib/patch_ruby/models/order.rb', line 339 def hash [id, created_at, production, state, amount, unit, price, patch_fee, currency, registry_url, , line_items, issued_to].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/patch_ruby/models/order.rb', line 215 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @production.nil? invalid_properties.push('invalid value for "production", production cannot be nil.') end if @state.nil? invalid_properties.push('invalid value for "state", state cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @amount > 100000000000000 invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000000.') end if @amount < 0 invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.') end if @unit.nil? invalid_properties.push('invalid value for "unit", unit cannot be nil.') end if @price.nil? invalid_properties.push('invalid value for "price", price cannot be nil.') end if @patch_fee.nil? invalid_properties.push('invalid value for "patch_fee", patch_fee cannot be nil.') end if @currency.nil? invalid_properties.push('invalid value for "currency", currency cannot be nil.') end if @metadata.nil? invalid_properties.push('invalid value for "metadata", metadata cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
423 424 425 |
# File 'lib/patch_ruby/models/order.rb', line 423 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
429 430 431 432 433 434 435 436 437 438 439 440 441 |
# File 'lib/patch_ruby/models/order.rb', line 429 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
417 418 419 |
# File 'lib/patch_ruby/models/order.rb', line 417 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/patch_ruby/models/order.rb', line 266 def valid? return false if @id.nil? return false if @production.nil? return false if @state.nil? state_validator = EnumAttributeValidator.new('String', ["draft", "reserved", "placed", "processing", "complete", "cancelled"]) return false unless state_validator.valid?(@state) return false if @amount.nil? return false if @amount > 100000000000000 return false if @amount < 0 return false if @unit.nil? return false if @price.nil? return false if @patch_fee.nil? return false if @currency.nil? return false if @metadata.nil? true end |