Class: VoucherifySdk::PublicationsListResponseBodyPublicationsItem

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicationsListResponseBodyPublicationsItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'publication'
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'failure_message')
    self.failure_message = attributes[:'failure_message']
  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.



36
37
38
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 36

def channel
  @channel
end

#created_at ⇒ Object

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



25
26
27
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 25

def created_at
  @created_at
end

#customer ⇒ Object

Returns the value of attribute customer.



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

def customer
  @customer
end

#customer_id ⇒ Object

Unique customer ID of the customer receiving the publication.



28
29
30
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 28

def customer_id
  @customer_id
end

#failure_code ⇒ Object

Generic reason as to why the create publication operation failed.



54
55
56
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 54

def failure_code
  @failure_code
end

#failure_message ⇒ Object

This parameter will provide more expanded reason as to why the create publication operation failed.



57
58
59
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 57

def failure_message
  @failure_message
end

#id ⇒ Object

Unique publication ID, assigned by Voucherify.



19
20
21
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 19

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



33
34
35
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 33

def metadata
  @metadata
end

#object ⇒ Object

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



22
23
24
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 22

def object
  @object
end

#result ⇒ Object

Returns the value of attribute result.



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

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.



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

def source_id
  @source_id
end

#tracking_id ⇒ Object

Customer’s ‘source_id`.



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

def tracking_id
  @tracking_id
end

#voucher ⇒ Object

Returns the value of attribute voucher.



51
52
53
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 51

def voucher
  @voucher
end

#vouchers ⇒ Object

Contains the voucher IDs that was assigned by Voucherify. and Contains the unique voucher codes that was assigned by Voucherify.



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

def vouchers
  @vouchers
end

#vouchers_id ⇒ Object

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



47
48
49
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 47

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 299

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



103
104
105
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 82

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',
    :'customer' => :'customer',
    :'vouchers' => :'vouchers',
    :'vouchers_id' => :'vouchers_id',
    :'result' => :'result',
    :'voucher' => :'voucher',
    :'failure_code' => :'failure_code',
    :'failure_message' => :'failure_message'
  }
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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 275

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 129

def self.openapi_nullable
  Set.new([
    :'id',
    :'object',
    :'created_at',
    :'customer_id',
    :'tracking_id',
    :'channel',
    :'source_id',
    :'vouchers_id',
    :'failure_code',
    :'failure_message'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 108

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      customer == o.customer &&
      vouchers == o.vouchers &&
      vouchers_id == o.vouchers_id &&
      result == o.result &&
      voucher == o.voucher &&
      failure_code == o.failure_code &&
      failure_message == o.failure_message
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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 370

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


262
263
264
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



268
269
270
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 268

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



221
222
223
224
225
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 221

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



346
347
348
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 346

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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 352

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



340
341
342
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 340

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



229
230
231
232
233
234
235
236
 
# File 'lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb', line 229

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["publication"])
  return false unless object_validator.valid?(@object)
  result_validator = EnumAttributeValidator.new('String', ["SUCCESS", "FAILURE"])
  return false unless result_validator.valid?(@result)
  true
end