Class: Tremendous::OrderWithLink
- Inherits:
-
Object
- Object
- Tremendous::OrderWithLink
- Defined in:
- lib/tremendous/models/order_with_link.rb
Overview
An order wraps around the fulfilment of one or more rewards.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#campaign_id ⇒ Object
ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
-
#created_at ⇒ Object
Date the order has been created.
-
#external_id ⇒ Object
Reference for this order, supplied by the customer.
-
#id ⇒ Object
Tremendous ID of the order.
-
#invoice_id ⇒ Object
The ID for the invoice associated with this order.
-
#payment ⇒ Object
Returns the value of attribute payment.
-
#rewards ⇒ Object
Returns the value of attribute rewards.
-
#status ⇒ Object
Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td>
CANCELED
</td> <td> The order and all of its rewards were canceled.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.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.
-
.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.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ OrderWithLink
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 = {}) ⇒ OrderWithLink
Initializes the object
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/tremendous/models/order_with_link.rb', line 106 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::OrderWithLink` 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 `Tremendous::OrderWithLink`. 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'] else self.id = nil end if attributes.key?(:'external_id') self.external_id = attributes[:'external_id'] end if attributes.key?(:'campaign_id') self.campaign_id = attributes[:'campaign_id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] else self.created_at = nil end if attributes.key?(:'status') self.status = attributes[:'status'] else self.status = nil end if attributes.key?(:'payment') self.payment = attributes[:'payment'] end if attributes.key?(:'invoice_id') self.invoice_id = attributes[:'invoice_id'] end if attributes.key?(:'rewards') if (value = attributes[:'rewards']).is_a?(Array) self.rewards = value end end end |
Instance Attribute Details
#campaign_id ⇒ Object
ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
26 27 28 |
# File 'lib/tremendous/models/order_with_link.rb', line 26 def campaign_id @campaign_id end |
#created_at ⇒ Object
Date the order has been created
29 30 31 |
# File 'lib/tremendous/models/order_with_link.rb', line 29 def created_at @created_at end |
#external_id ⇒ Object
Reference for this order, supplied by the customer. When set, ‘external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses fail to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
23 24 25 |
# File 'lib/tremendous/models/order_with_link.rb', line 23 def external_id @external_id end |
#id ⇒ Object
Tremendous ID of the order
20 21 22 |
# File 'lib/tremendous/models/order_with_link.rb', line 20 def id @id end |
#invoice_id ⇒ Object
The ID for the invoice associated with this order
37 38 39 |
# File 'lib/tremendous/models/order_with_link.rb', line 37 def invoice_id @invoice_id end |
#payment ⇒ Object
Returns the value of attribute payment.
34 35 36 |
# File 'lib/tremendous/models/order_with_link.rb', line 34 def payment @payment end |
#rewards ⇒ Object
Returns the value of attribute rewards.
39 40 41 |
# File 'lib/tremendous/models/order_with_link.rb', line 39 def rewards @rewards end |
#status ⇒ Object
Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> CANCELED
</td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> CART
</td> <td> The order has been created, but hasn’t yet been processed. </td> </tr> <tr> <td> EXECUTED
</td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> FAILED
</td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> PENDING APPROVAL
</td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> PENDING INTERNAL PAYMENT APPROVAL
</td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
32 33 34 |
# File 'lib/tremendous/models/order_with_link.rb', line 32 def status @status end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/tremendous/models/order_with_link.rb', line 313 def self._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 = Tremendous.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
78 79 80 |
# File 'lib/tremendous/models/order_with_link.rb', line 78 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/tremendous/models/order_with_link.rb', line 64 def self.attribute_map { :'id' => :'id', :'external_id' => :'external_id', :'campaign_id' => :'campaign_id', :'created_at' => :'created_at', :'status' => :'status', :'payment' => :'payment', :'invoice_id' => :'invoice_id', :'rewards' => :'rewards' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/tremendous/models/order_with_link.rb', line 289 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{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[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
97 98 99 100 101 102 |
# File 'lib/tremendous/models/order_with_link.rb', line 97 def self.openapi_nullable Set.new([ :'external_id', :'campaign_id', ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/tremendous/models/order_with_link.rb', line 83 def self.openapi_types { :'id' => :'String', :'external_id' => :'String', :'campaign_id' => :'String', :'created_at' => :'Time', :'status' => :'String', :'payment' => :'OrderBasePayment', :'invoice_id' => :'String', :'rewards' => :'Array<OrderWithLinkRewardsInner>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/tremendous/models/order_with_link.rb', line 261 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && external_id == o.external_id && campaign_id == o.campaign_id && created_at == o.created_at && status == o.status && payment == o.payment && invoice_id == o.invoice_id && rewards == o.rewards end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/tremendous/models/order_with_link.rb', line 384 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 |
#eql?(o) ⇒ Boolean
276 277 278 |
# File 'lib/tremendous/models/order_with_link.rb', line 276 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
282 283 284 |
# File 'lib/tremendous/models/order_with_link.rb', line 282 def hash [id, external_id, campaign_id, created_at, status, payment, invoice_id, rewards].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/tremendous/models/order_with_link.rb', line 162 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end pattern = Regexp.new(/[A-Z0-9]{4,20}/) if @id !~ pattern invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.") end pattern = Regexp.new(/[A-Z0-9]{4,20}/) if !@campaign_id.nil? && @campaign_id !~ pattern invalid_properties.push("invalid value for \"campaign_id\", must conform to the pattern #{pattern}.") end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if !@rewards.nil? && @rewards.length < 1 invalid_properties.push('invalid value for "rewards", number of items must be greater than or equal to 1.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
360 361 362 |
# File 'lib/tremendous/models/order_with_link.rb', line 360 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
366 367 368 369 370 371 372 373 374 375 376 377 378 |
# File 'lib/tremendous/models/order_with_link.rb', line 366 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
354 355 356 |
# File 'lib/tremendous/models/order_with_link.rb', line 354 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/tremendous/models/order_with_link.rb', line 196 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @id.nil? return false if @id !~ Regexp.new(/[A-Z0-9]{4,20}/) return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/[A-Z0-9]{4,20}/) return false if @created_at.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ["CANCELED", "CART", "EXECUTED", "FAILED", "PENDING APPROVAL", "PENDING INTERNAL PAYMENT APPROVAL"]) return false unless status_validator.valid?(@status) return false if !@rewards.nil? && @rewards.length < 1 true end |