Class: Tremendous::ListProducts200ResponseProductsInner
- Inherits:
-
Object
- Object
- Tremendous::ListProducts200ResponseProductsInner
- Defined in:
- lib/tremendous/models/list_products200_response_products_inner.rb
Overview
A product represents one way to payout a reward to it’s recipient. Think: * Amazon.com gift card (ID: ‘OKMHM2X2OHYV`) * Donations to Save the Children (ID: `ESRNAD533W5A`) * Virtual Visa debit card (ID: `Q24BD9EZ332JT`) each of which is one specific product on Tremendous. > 📘 All available products > > See this [list](www.tremendous.com/catalog) Products can be limited in their availability to recipients by * geography (field `countries`) * currency (field `currencies`) * amount of the reward (field `skus`) * e.g. adidas gift cards accept any amount between 5 and 200 USD. See the description of each respective parameter for further details.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#category ⇒ Object
The category of this product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>
ach
</td> <td>Bank transfer to the recipient</td> </tr> <tr> <td>charity
</td> <td>Donations to a charity</td> </tr> <tr> <td>merchant_card
</td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td>paypal
</td> <td>Payout via PayPal</td> </tr> <tr> <td>venmo
</td> <td>Payout via Venmo</td> </tr> <tr> <td>visa_card
</td> <td>Payout in form of a Visa debit card</td> </tr> </tbody> </table>. -
#countries ⇒ Object
List of countries in which this product is available to recipients.
-
#currency_codes ⇒ Object
Available currencies for this product.
-
#description ⇒ Object
Detailed description of the product.
-
#disclosure ⇒ Object
Legal disclosures for this product.
-
#id ⇒ Object
Returns the value of attribute id.
-
#images ⇒ Object
List of product images associated with this product (e.g. logos or images of the gift cards).
-
#name ⇒ Object
Name of the product.
-
#skus ⇒ Object
Products may are restricted in their usage based on the amount of the reward.
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 = {}) ⇒ ListProducts200ResponseProductsInner
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 = {}) ⇒ ListProducts200ResponseProductsInner
Initializes the object
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 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 110 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::ListProducts200ResponseProductsInner` 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::ListProducts200ResponseProductsInner`. 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?(:'name') self.name = attributes[:'name'] else self.name = nil end if attributes.key?(:'description') self.description = attributes[:'description'] else self.description = nil end if attributes.key?(:'category') self.category = attributes[:'category'] else self.category = nil end if attributes.key?(:'disclosure') self.disclosure = attributes[:'disclosure'] else self.disclosure = nil end if attributes.key?(:'skus') if (value = attributes[:'skus']).is_a?(Array) self.skus = value end end if attributes.key?(:'currency_codes') if (value = attributes[:'currency_codes']).is_a?(Array) self.currency_codes = value end else self.currency_codes = nil end if attributes.key?(:'countries') if (value = attributes[:'countries']).is_a?(Array) self.countries = value end else self.countries = nil end if attributes.key?(:'images') if (value = attributes[:'images']).is_a?(Array) self.images = value end else self.images = nil end end |
Instance Attribute Details
#category ⇒ Object
The category of this product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>ach
</td> <td>Bank transfer to the recipient</td> </tr> <tr> <td>charity
</td> <td>Donations to a charity</td> </tr> <tr> <td>merchant_card
</td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td>paypal
</td> <td>Payout via PayPal</td> </tr> <tr> <td>venmo
</td> <td>Payout via Venmo</td> </tr> <tr> <td>visa_card
</td> <td>Payout in form of a Visa debit card</td> </tr> </tbody> </table>
28 29 30 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 28 def category @category end |
#countries ⇒ Object
List of countries in which this product is available to recipients.
40 41 42 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 40 def countries @countries end |
#currency_codes ⇒ Object
Available currencies for this product
37 38 39 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 37 def currency_codes @currency_codes end |
#description ⇒ Object
Detailed description of the product. Mostly used for products with a ‘category` of `charities`.
25 26 27 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 25 def description @description end |
#disclosure ⇒ Object
Legal disclosures for this product. Can be in HTML format.
31 32 33 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 31 def disclosure @disclosure end |
#id ⇒ Object
Returns the value of attribute id.
19 20 21 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 19 def id @id end |
#images ⇒ Object
List of product images associated with this product (e.g. logos or images of the gift cards)
43 44 45 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 43 def images @images end |
#name ⇒ Object
Name of the product
22 23 24 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 22 def name @name end |
#skus ⇒ Object
Products may are restricted in their usage based on the amount of the reward. The ‘skus` array defines bands of denominations in which this product may be used for payouts.
34 35 36 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 34 def skus @skus end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
370 371 372 373 374 375 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 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 370 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
83 84 85 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 83 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 68 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'description' => :'description', :'category' => :'category', :'disclosure' => :'disclosure', :'skus' => :'skus', :'currency_codes' => :'currency_codes', :'countries' => :'countries', :'images' => :'images' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 346 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
103 104 105 106 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 103 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 88 def self.openapi_types { :'id' => :'String', :'name' => :'String', :'description' => :'String', :'category' => :'String', :'disclosure' => :'String', :'skus' => :'Array<ListProducts200ResponseProductsInnerSkusInner>', :'currency_codes' => :'Array<String>', :'countries' => :'Array<ListProducts200ResponseProductsInnerCountriesInner>', :'images' => :'Array<ListProducts200ResponseProductsInnerImagesInner>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 317 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && description == o.description && category == o.category && disclosure == o.disclosure && skus == o.skus && currency_codes == o.currency_codes && countries == o.countries && images == o.images end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
441 442 443 444 445 446 447 448 449 450 451 452 453 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 441 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
333 334 335 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 333 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
339 340 341 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 339 def hash [id, name, description, category, disclosure, skus, currency_codes, countries, images].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 186 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 if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @description.nil? invalid_properties.push('invalid value for "description", description cannot be nil.') end if @category.nil? invalid_properties.push('invalid value for "category", category cannot be nil.') end if @disclosure.nil? invalid_properties.push('invalid value for "disclosure", disclosure cannot be nil.') end if @currency_codes.nil? invalid_properties.push('invalid value for "currency_codes", currency_codes cannot be nil.') end if @currency_codes.length < 1 invalid_properties.push('invalid value for "currency_codes", number of items must be greater than or equal to 1.') end if @countries.nil? invalid_properties.push('invalid value for "countries", countries cannot be nil.') end if @countries.length < 1 invalid_properties.push('invalid value for "countries", number of items must be greater than or equal to 1.') end if @images.nil? invalid_properties.push('invalid value for "images", images cannot be nil.') end if @images.length < 0 invalid_properties.push('invalid value for "images", number of items must be greater than or equal to 0.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
417 418 419 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 417 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
423 424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 423 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
411 412 413 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 411 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/tremendous/models/list_products200_response_products_inner.rb', line 243 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 @name.nil? return false if @description.nil? return false if @category.nil? category_validator = EnumAttributeValidator.new('String', ["ach", "charity", "merchant_card", "paypal", "venmo", "visa_card"]) return false unless category_validator.valid?(@category) return false if @disclosure.nil? return false if @currency_codes.nil? return false if @currency_codes.length < 1 return false if @countries.nil? return false if @countries.length < 1 return false if @images.nil? return false if @images.length < 0 true end |