Class: TalonOne::Giveaway

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Giveaway

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/talon_one/models/giveaway.rb', line 93

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attributes ⇒ Object

Arbitrary properties associated with this giveaway.



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

def attributes
  @attributes
end

#code ⇒ Object

The code value of this giveaway.



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

def code
  @code
end

#created ⇒ Object

The time this entity was created.



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

def created
  @created
end

#end_date ⇒ Object

Timestamp at which point the giveaway becomes invalid.



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

def end_date
  @end_date
end

#id ⇒ Object

Internal ID of this entity.



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

def id
  @id
end

#import_id ⇒ Object

The ID of the Import which created this giveaway.



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

def import_id
  @import_id
end

#pool_id ⇒ Object

The ID of the pool to return giveaway codes from.



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

def pool_id
  @pool_id
end

#profile_id ⇒ Object

The internal ID of the customer profile that was awarded the giveaway, if the giveaway was awarded and an internal ID exists.



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

def profile_id
  @profile_id
end

#profile_integration_id ⇒ Object

The third-party integration ID of the customer profile that was awarded the giveaway, if the giveaway was awarded.



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

def profile_integration_id
  @profile_integration_id
end

#start_date ⇒ Object

Timestamp at which point the giveaway becomes valid.



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

def start_date
  @start_date
end

#used ⇒ Object

Indicates whether this giveaway code was given before.



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

def used
  @used
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/talon_one/models/giveaway.rb', line 52

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'code' => :'code',
    :'pool_id' => :'poolId',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'attributes' => :'attributes',
    :'used' => :'used',
    :'import_id' => :'importId',
    :'profile_integration_id' => :'profileIntegrationId',
    :'profile_id' => :'profileId'
  }
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



217
218
219
 
# File 'lib/talon_one/models/giveaway.rb', line 217

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/talon_one/models/giveaway.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/talon_one/models/giveaway.rb', line 69

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'code' => :'String',
    :'pool_id' => :'Integer',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'attributes' => :'Object',
    :'used' => :'Boolean',
    :'import_id' => :'Integer',
    :'profile_integration_id' => :'String',
    :'profile_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/talon_one/models/giveaway.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      code == o.code &&
      pool_id == o.pool_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      attributes == o.attributes &&
      used == o.used &&
      import_id == o.import_id &&
      profile_integration_id == o.profile_integration_id &&
      profile_id == o.profile_id
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/talon_one/models/giveaway.rb', line 245

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/talon_one/models/giveaway.rb', line 314

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/talon_one/models/giveaway.rb', line 224

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


204
205
206
 
# File 'lib/talon_one/models/giveaway.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/talon_one/models/giveaway.rb', line 210

def hash
  [id, created, code, pool_id, start_date, end_date, attributes, used, import_id, profile_integration_id, profile_id].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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/talon_one/models/giveaway.rb', line 153

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 @code.nil?
    invalid_properties.push('invalid value for "code", code cannot be nil.')
  end

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



290
291
292
 
# File 'lib/talon_one/models/giveaway.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/talon_one/models/giveaway.rb', line 296

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



284
285
286
 
# File 'lib/talon_one/models/giveaway.rb', line 284

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



176
177
178
179
180
181
182
 
# File 'lib/talon_one/models/giveaway.rb', line 176

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @code.nil?
  return false if @pool_id.nil?
  true
end