Class: VoucherifySdk::RewardsCreateResponseBody

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/rewards_create_response_body.rb

Overview

Response body schema for POST ‘v1/rewards`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RewardsCreateResponseBody

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 128

def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'stock')
    self.stock = attributes[:'stock']
  end

  if attributes.key?(:'redeemed')
    self.redeemed = attributes[:'redeemed']
  end

  if attributes.key?(:'attributes')
    self.attributes = attributes[:'attributes']
  end

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'parameters')
    self.parameters = attributes[:'parameters']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'reward'
  end
end

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



31
32
33
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 31

def attributes
  @attributes
end

#created_at ⇒ Object

Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format.



42
43
44
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 42

def created_at
  @created_at
end

#id ⇒ Object

Unique reward ID, assigned by Voucherify.



20
21
22
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 20

def id
  @id
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format.



34
35
36
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 34

def metadata
  @metadata
end

#name ⇒ Object

Reward name.



23
24
25
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 23

def name
  @name
end

#object ⇒ Object

The type of the object represented by the JSON. This object stores information about the reward.



48
49
50
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 48

def object
  @object
end

#parameters ⇒ Object

Returns the value of attribute parameters.



39
40
41
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 39

def parameters
  @parameters
end

#redeemed ⇒ Object

Defines the number of already invoked (successful) reward redemptions.



29
30
31
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 29

def redeemed
  @redeemed
end

#stock ⇒ Object

Configurable for **material rewards**. The number of units of the product that you want to share as reward.



26
27
28
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 26

def stock
  @stock
end

#type ⇒ Object

Reward type.



37
38
39
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 37

def type
  @type
end

#updated_at ⇒ Object

Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.



45
46
47
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 45

def updated_at
  @updated_at
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 262

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 = VoucherifySdk.const_get(type)
    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



90
91
92
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 73

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'stock' => :'stock',
    :'redeemed' => :'redeemed',
    :'attributes' => :'attributes',
    :'metadata' => :'metadata',
    :'type' => :'type',
    :'parameters' => :'parameters',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'object' => :'object'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 238

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



112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 112

def self.openapi_nullable
  Set.new([
    :'id',
    :'name',
    :'stock',
    :'redeemed',
    :'attributes',
    :'metadata',
    :'type',
    :'created_at',
    :'updated_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 95

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'stock' => :'Integer',
    :'redeemed' => :'Integer',
    :'attributes' => :'RewardsCreateResponseBodyAttributes',
    :'metadata' => :'Object',
    :'type' => :'String',
    :'parameters' => :'RewardType',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'object' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      stock == o.stock &&
      redeemed == o.redeemed &&
      attributes == o.attributes &&
      metadata == o.metadata &&
      type == o.type &&
      parameters == o.parameters &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      object == o.object
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 333

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


225
226
227
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 231

def hash
  [id, name, stock, redeemed, attributes, metadata, type, parameters, created_at, updated_at, object].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



183
184
185
186
187
188
189
190
191
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 183

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @object.nil?
    invalid_properties.push('invalid value for "object", object cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



309
310
311
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 309

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 315

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

Returns:

  • (String) —

    String presentation of the object



303
304
305
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 303

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



195
196
197
198
199
200
201
202
203
 
# File 'lib/VoucherifySdk/models/rewards_create_response_body.rb', line 195

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["CAMPAIGN", "COIN", "MATERIAL"])
  return false unless type_validator.valid?(@type)
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["reward"])
  return false unless object_validator.valid?(@object)
  true
end