Class: VoucherifySdk::CustomerWithSummaryLoyaltyReferrals

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerWithSummaryLoyaltyReferrals

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
220
221
222
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
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 161

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#assets ⇒ Object

Returns the value of attribute assets.



62
63
64
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 62

def assets
  @assets
end

#birthdate ⇒ Object

Customer’s birthdate; format YYYY-MM-DD.



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

def birthdate
  @birthdate
end

#birthday ⇒ Object

Deprecated Customer’s birthdate; format YYYY-MM-DD.



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

def birthday
  @birthday
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#description ⇒ Object

An arbitrary string that you can attach to a customer object.



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

def description
  @description
end

#email ⇒ Object

Customer’s email address.



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

def email
  @email
end

#id ⇒ Object

The ID of an existing customer that will be linked to redemption in this request.



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

def id
  @id
end

#loyalty ⇒ Object

Returns the value of attribute loyalty.



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

def loyalty
  @loyalty
end

#metadata ⇒ Object

A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.



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

def metadata
  @metadata
end

#name ⇒ Object

Customer’s first and last name.



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

def name
  @name
end

#object ⇒ Object

The type of object represented by JSON.



65
66
67
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 65

def object
  @object
end

#phone ⇒ Object

Customer’s phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.



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

def phone
  @phone
end

#referrals ⇒ Object

Returns the value of attribute referrals.



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

def referrals
  @referrals
end

#source_id ⇒ Object

A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.



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

def source_id
  @source_id
end

#summary ⇒ Object

Returns the value of attribute summary.



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

def summary
  @summary
end

#system_metadata ⇒ Object

Object used to store system metadata information.



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

def system_metadata
  @system_metadata
end

#updated_at ⇒ Object

Timestamp representing the date and time when the customer was updated in ISO 8601 format.



60
61
62
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 60

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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 351

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



114
115
116
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 114

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 90

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'email' => :'email',
    :'phone' => :'phone',
    :'birthday' => :'birthday',
    :'birthdate' => :'birthdate',
    :'address' => :'address',
    :'metadata' => :'metadata',
    :'id' => :'id',
    :'source_id' => :'source_id',
    :'summary' => :'summary',
    :'loyalty' => :'loyalty',
    :'referrals' => :'referrals',
    :'system_metadata' => :'system_metadata',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'assets' => :'assets',
    :'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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 327

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)



153
154
155
156
157
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 153

def self.openapi_all_of
  [
  :'CustomerBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
147
148
149
150
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 143

def self.openapi_nullable
  Set.new([
    :'address',
    :'summary',
    :'loyalty',
    :'referrals',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 119

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'email' => :'String',
    :'phone' => :'String',
    :'birthday' => :'Date',
    :'birthdate' => :'Date',
    :'address' => :'CustomerBaseAddress',
    :'metadata' => :'Object',
    :'id' => :'String',
    :'source_id' => :'String',
    :'summary' => :'CustomerSummary',
    :'loyalty' => :'CustomerLoyalty',
    :'referrals' => :'CustomerReferrals',
    :'system_metadata' => :'Object',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'assets' => :'CustomerResponseDataAssets',
    :'object' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 289

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      email == o.email &&
      phone == o.phone &&
      birthday == o.birthday &&
      birthdate == o.birthdate &&
      address == o.address &&
      metadata == o.metadata &&
      id == o.id &&
      source_id == o.source_id &&
      summary == o.summary &&
      loyalty == o.loyalty &&
      referrals == o.referrals &&
      system_metadata == o.system_metadata &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      assets == o.assets &&
      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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 422

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


314
315
316
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 314

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



320
321
322
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 320

def hash
  [name, description, email, phone, birthday, birthdate, address, metadata, id, source_id, summary, loyalty, referrals, system_metadata, created_at, updated_at, assets, 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



257
258
259
260
261
262
263
264
265
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 257

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



398
399
400
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 398

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



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 404

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



392
393
394
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 392

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



269
270
271
272
273
274
275
 
# File 'lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb', line 269

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