Class: TalonOne::InventoryReferral

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/inventory_referral.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InventoryReferral

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
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
 
# File 'lib/talon_one/models/inventory_referral.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#advocate_profile_integration_id ⇒ Object

The Integration ID of the Advocate’s Profile.



37
38
39
 
# File 'lib/talon_one/models/inventory_referral.rb', line 37

def advocate_profile_integration_id
  @advocate_profile_integration_id
end

#attributes ⇒ Object

Arbitrary properties associated with this item.



43
44
45
 
# File 'lib/talon_one/models/inventory_referral.rb', line 43

def attributes
  @attributes
end

#batch_id ⇒ Object

The ID of the batch the referrals belong to.



55
56
57
 
# File 'lib/talon_one/models/inventory_referral.rb', line 55

def batch_id
  @batch_id
end

#campaign_id ⇒ Object

ID of the campaign from which the referral received the referral code.



34
35
36
 
# File 'lib/talon_one/models/inventory_referral.rb', line 34

def campaign_id
  @campaign_id
end

#code ⇒ Object

The referral code.



49
50
51
 
# File 'lib/talon_one/models/inventory_referral.rb', line 49

def code
  @code
end

#created ⇒ Object

The time this entity was created.



22
23
24
 
# File 'lib/talon_one/models/inventory_referral.rb', line 22

def created
  @created
end

#expiry_date ⇒ Object

Expiration date of the referral code. Referral never expires if this is omitted.



28
29
30
 
# File 'lib/talon_one/models/inventory_referral.rb', line 28

def expiry_date
  @expiry_date
end

#friend_profile_integration_id ⇒ Object

An optional Integration ID of the Friend’s Profile.



40
41
42
 
# File 'lib/talon_one/models/inventory_referral.rb', line 40

def friend_profile_integration_id
  @friend_profile_integration_id
end

#id ⇒ Object

Internal ID of this entity.



19
20
21
 
# File 'lib/talon_one/models/inventory_referral.rb', line 19

def id
  @id
end

#import_id ⇒ Object

The ID of the Import which created this referral.



46
47
48
 
# File 'lib/talon_one/models/inventory_referral.rb', line 46

def import_id
  @import_id
end

#referred_customers ⇒ Object

An array of referred customers.



58
59
60
 
# File 'lib/talon_one/models/inventory_referral.rb', line 58

def referred_customers
  @referred_customers
end

#start_date ⇒ Object

Timestamp at which point the referral code becomes valid.



25
26
27
 
# File 'lib/talon_one/models/inventory_referral.rb', line 25

def start_date
  @start_date
end

#usage_counter ⇒ Object

The number of times this referral code has been successfully used.



52
53
54
 
# File 'lib/talon_one/models/inventory_referral.rb', line 52

def usage_counter
  @usage_counter
end

#usage_limit ⇒ Object

The number of times a referral code can be used. ‘0` means no limit but any campaign usage limits will still apply.



31
32
33
 
# File 'lib/talon_one/models/inventory_referral.rb', line 31

def usage_limit
  @usage_limit
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/talon_one/models/inventory_referral.rb', line 61

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'start_date' => :'startDate',
    :'expiry_date' => :'expiryDate',
    :'usage_limit' => :'usageLimit',
    :'campaign_id' => :'campaignId',
    :'advocate_profile_integration_id' => :'advocateProfileIntegrationId',
    :'friend_profile_integration_id' => :'friendProfileIntegrationId',
    :'attributes' => :'attributes',
    :'import_id' => :'importId',
    :'code' => :'code',
    :'usage_counter' => :'usageCounter',
    :'batch_id' => :'batchId',
    :'referred_customers' => :'referredCustomers'
  }
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



335
336
337
 
# File 'lib/talon_one/models/inventory_referral.rb', line 335

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
 
# File 'lib/talon_one/models/inventory_referral.rb', line 101

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/talon_one/models/inventory_referral.rb', line 81

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'start_date' => :'DateTime',
    :'expiry_date' => :'DateTime',
    :'usage_limit' => :'Integer',
    :'campaign_id' => :'Integer',
    :'advocate_profile_integration_id' => :'String',
    :'friend_profile_integration_id' => :'String',
    :'attributes' => :'Object',
    :'import_id' => :'Integer',
    :'code' => :'String',
    :'usage_counter' => :'Integer',
    :'batch_id' => :'String',
    :'referred_customers' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/talon_one/models/inventory_referral.rb', line 301

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      start_date == o.start_date &&
      expiry_date == o.expiry_date &&
      usage_limit == o.usage_limit &&
      campaign_id == o.campaign_id &&
      advocate_profile_integration_id == o.advocate_profile_integration_id &&
      friend_profile_integration_id == o.friend_profile_integration_id &&
      attributes == o.attributes &&
      import_id == o.import_id &&
      code == o.code &&
      usage_counter == o.usage_counter &&
      batch_id == o.batch_id &&
      referred_customers == o.referred_customers
end

#_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



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
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/talon_one/models/inventory_referral.rb', line 363

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    TalonOne.const_get(type).build_from_hash(value)
  end
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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/talon_one/models/inventory_referral.rb', line 432

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

#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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/talon_one/models/inventory_referral.rb', line 342

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


322
323
324
 
# File 'lib/talon_one/models/inventory_referral.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



328
329
330
 
# File 'lib/talon_one/models/inventory_referral.rb', line 328

def hash
  [id, created, start_date, expiry_date, usage_limit, campaign_id, advocate_profile_integration_id, friend_profile_integration_id, attributes, import_id, code, usage_counter, batch_id, referred_customers].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



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
 
# File 'lib/talon_one/models/inventory_referral.rb', line 182

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

  if @usage_limit > 999999
    invalid_properties.push('invalid value for "usage_limit", must be smaller than or equal to 999999.')
  end

  if @usage_limit < 0
    invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
  end

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

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

  if @advocate_profile_integration_id.to_s.length > 1000
    invalid_properties.push('invalid value for "advocate_profile_integration_id", the character length must be smaller than or equal to 1000.')
  end

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

  if @code.to_s.length < 4
    invalid_properties.push('invalid value for "code", the character length must be great than or equal to 4.')
  end

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

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



408
409
410
 
# File 'lib/talon_one/models/inventory_referral.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/talon_one/models/inventory_referral.rb', line 414

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



402
403
404
 
# File 'lib/talon_one/models/inventory_referral.rb', line 402

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/talon_one/models/inventory_referral.rb', line 237

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @usage_limit.nil?
  return false if @usage_limit > 999999
  return false if @usage_limit < 0
  return false if @campaign_id.nil?
  return false if @advocate_profile_integration_id.nil?
  return false if @advocate_profile_integration_id.to_s.length > 1000
  return false if @code.nil?
  return false if @code.to_s.length < 4
  return false if @usage_counter.nil?
  return false if @referred_customers.nil?
  true
end