Class: TalonOne::NewReferralsForMultipleAdvocates

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewReferralsForMultipleAdvocates

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 77

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

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

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

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

Instance Attribute Details

#advocate_profile_integration_ids ⇒ Object

An array containing all the respective advocate profiles.



30
31
32
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 30

def advocate_profile_integration_ids
  @advocate_profile_integration_ids
end

#attributes ⇒ Object

Arbitrary properties associated with this referral code.



33
34
35
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 33

def attributes
  @attributes
end

#campaign_id ⇒ Object

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



27
28
29
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 27

def campaign_id
  @campaign_id
end

#expiry_date ⇒ Object

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



21
22
23
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 21

def expiry_date
  @expiry_date
end

#referral_pattern ⇒ Object

The pattern used to generate referrals. The character ‘#` is a placeholder and is replaced by a random character from the `validCharacters` set.



39
40
41
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 39

def referral_pattern
  @referral_pattern
end

#start_date ⇒ Object

Timestamp at which point the referral code becomes valid.



18
19
20
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 18

def start_date
  @start_date
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.



24
25
26
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 24

def usage_limit
  @usage_limit
end

#valid_characters ⇒ Object

List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the ‘[A-Z, 0-9]` regular expression.



36
37
38
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 36

def valid_characters
  @valid_characters
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 42

def self.attribute_map
  {
    :'start_date' => :'startDate',
    :'expiry_date' => :'expiryDate',
    :'usage_limit' => :'usageLimit',
    :'campaign_id' => :'campaignId',
    :'advocate_profile_integration_ids' => :'advocateProfileIntegrationIds',
    :'attributes' => :'attributes',
    :'valid_characters' => :'validCharacters',
    :'referral_pattern' => :'referralPattern'
  }
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



237
238
239
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 237

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 56

def self.openapi_types
  {
    :'start_date' => :'DateTime',
    :'expiry_date' => :'DateTime',
    :'usage_limit' => :'Integer',
    :'campaign_id' => :'Integer',
    :'advocate_profile_integration_ids' => :'Array<String>',
    :'attributes' => :'Object',
    :'valid_characters' => :'Array<String>',
    :'referral_pattern' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_date == o.start_date &&
      expiry_date == o.expiry_date &&
      usage_limit == o.usage_limit &&
      campaign_id == o.campaign_id &&
      advocate_profile_integration_ids == o.advocate_profile_integration_ids &&
      attributes == o.attributes &&
      valid_characters == o.valid_characters &&
      referral_pattern == o.referral_pattern
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



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
300
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 265

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 334

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 244

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


224
225
226
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



230
231
232
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 230

def hash
  [start_date, expiry_date, usage_limit, campaign_id, advocate_profile_integration_ids, attributes, valid_characters, referral_pattern].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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_ids.nil?
    invalid_properties.push('invalid value for "advocate_profile_integration_ids", advocate_profile_integration_ids cannot be nil.')
  end

  if !@referral_pattern.nil? && @referral_pattern.to_s.length > 100
    invalid_properties.push('invalid value for "referral_pattern", the character length must be smaller than or equal to 100.')
  end

  if !@referral_pattern.nil? && @referral_pattern.to_s.length < 3
    invalid_properties.push('invalid value for "referral_pattern", the character length must be great than or equal to 3.')
  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



310
311
312
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 310

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 316

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



304
305
306
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 304

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



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/talon_one/models/new_referrals_for_multiple_advocates.rb', line 164

def valid?
  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_ids.nil?
  return false if !@referral_pattern.nil? && @referral_pattern.to_s.length > 100
  return false if !@referral_pattern.nil? && @referral_pattern.to_s.length < 3
  true
end