Class: VoucherifySdk::PublicationsCreateVouchersResponseBody

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

Overview

Response body schema for POST ‘/publication` and GET `/publications/create`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicationsCreateVouchersResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
212
213
214
215
216
217
218
219
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 133

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::PublicationsCreateVouchersResponseBody` 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 `VoucherifySdk::PublicationsCreateVouchersResponseBody`. 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?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'publication'
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'vouchers_id')
    if (value = attributes[:'vouchers_id']).is_a?(Array)
      self.vouchers_id = value
    end
  else
    self.vouchers_id = nil
  end

  if attributes.key?(:'vouchers')
    if (value = attributes[:'vouchers']).is_a?(Array)
      self.vouchers = value
    end
  else
    self.vouchers = nil
  end
end

Instance Attribute Details

#channel ⇒ Object

How the publication was originated. It can be your own custom channel or an example value provided here.



38
39
40
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 38

def channel
  @channel
end

#created_at ⇒ Object

Timestamp representing the date and time when the publication was created in ISO 8601 format.



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

def created_at
  @created_at
end

#customer ⇒ Object

Returns the value of attribute customer.



46
47
48
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 46

def customer
  @customer
end

#customer_id ⇒ Object

Unique customer ID of the customer receiving the publication.



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

def customer_id
  @customer_id
end

#id ⇒ Object

Unique publication ID, assigned by Voucherify.



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

def id
  @id
end

#metadata ⇒ Object

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



35
36
37
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 35

def metadata
  @metadata
end

#object ⇒ Object

The type of object represented by the JSON. This object stores information about the ‘publication`.



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

def object
  @object
end

#result ⇒ Object

Status of the publication attempt.



44
45
46
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 44

def result
  @result
end

#source_id ⇒ Object

The merchant’s publication ID if it is different from the Voucherify publication ID. It’s an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service.



41
42
43
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 41

def source_id
  @source_id
end

#tracking_id ⇒ Object

Customer’s ‘source_id`.



32
33
34
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 32

def tracking_id
  @tracking_id
end

#vouchers ⇒ Object

Contains the unique voucher codes that was assigned by Voucherify.



52
53
54
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 52

def vouchers
  @vouchers
end

#vouchers_id ⇒ Object

Contains the unique internal voucher ID that was assigned by Voucherify.



49
50
51
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 49

def vouchers_id
  @vouchers_id
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



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
414
415
416
417
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 380

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



95
96
97
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 77

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'created_at' => :'created_at',
    :'customer_id' => :'customer_id',
    :'tracking_id' => :'tracking_id',
    :'metadata' => :'metadata',
    :'channel' => :'channel',
    :'source_id' => :'source_id',
    :'result' => :'result',
    :'customer' => :'customer',
    :'vouchers_id' => :'vouchers_id',
    :'vouchers' => :'vouchers'
  }
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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 356

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



125
126
127
128
129
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 125

def self.openapi_all_of
  [
  :'PublicationsCreateBaseResponseBody'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
122
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 118

def self.openapi_nullable
  Set.new([
    :'source_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 100

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'created_at' => :'Time',
    :'customer_id' => :'String',
    :'tracking_id' => :'String',
    :'metadata' => :'Object',
    :'channel' => :'String',
    :'source_id' => :'String',
    :'result' => :'String',
    :'customer' => :'CustomerWithSummaryLoyaltyReferrals',
    :'vouchers_id' => :'Array<String>',
    :'vouchers' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 324

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      created_at == o.created_at &&
      customer_id == o.customer_id &&
      tracking_id == o.tracking_id &&
      metadata == o.metadata &&
      channel == o.channel &&
      source_id == o.source_id &&
      result == o.result &&
      customer == o.customer &&
      vouchers_id == o.vouchers_id &&
      vouchers == o.vouchers
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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 451

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


343
344
345
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 343

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



349
350
351
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 349

def hash
  [id, object, created_at, customer_id, tracking_id, metadata, channel, source_id, result, customer, vouchers_id, vouchers].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



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
263
264
265
266
267
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 223

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

  if @object.nil?
    invalid_properties.push('invalid value for "object", object cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @customer_id.nil?
    invalid_properties.push('invalid value for "customer_id", customer_id cannot be nil.')
  end

  if @metadata.nil?
    invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
  end

  if @channel.nil?
    invalid_properties.push('invalid value for "channel", channel cannot be nil.')
  end

  if @result.nil?
    invalid_properties.push('invalid value for "result", result cannot be nil.')
  end

  if @customer.nil?
    invalid_properties.push('invalid value for "customer", customer cannot be nil.')
  end

  if @vouchers_id.nil?
    invalid_properties.push('invalid value for "vouchers_id", vouchers_id cannot be nil.')
  end

  if @vouchers.nil?
    invalid_properties.push('invalid value for "vouchers", vouchers 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



427
428
429
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 427

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



433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 433

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



421
422
423
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 421

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb', line 271

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["publication"])
  return false unless object_validator.valid?(@object)
  return false if @created_at.nil?
  return false if @customer_id.nil?
  return false if @metadata.nil?
  return false if @channel.nil?
  channel_validator = EnumAttributeValidator.new('String', ["API"])
  return false unless channel_validator.valid?(@channel)
  return false if @result.nil?
  result_validator = EnumAttributeValidator.new('String', ["SUCCESS"])
  return false unless result_validator.valid?(@result)
  return false if @customer.nil?
  return false if @vouchers_id.nil?
  return false if @vouchers.nil?
  true
end