Class: TalonOne::AwardGiveawayEffectProps

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

Overview

The properties specific to the "awardGiveaway" effect. This effect contains information on the giveaway item, and which profile it was awarded to.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AwardGiveawayEffectProps

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 63

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

The giveaway code that was awarded.



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

def code
  @code
end

#giveaway_id ⇒ Object

The internal ID for the giveaway that was awarded.



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

def giveaway_id
  @giveaway_id
end

#pool_id ⇒ Object

The ID of the giveaways pool the code was taken from.



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

def pool_id
  @pool_id
end

#pool_name ⇒ Object

The name of the giveaways pool the code was taken from.



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

def pool_name
  @pool_name
end

#recipient_integration_id ⇒ Object

The integration ID of the profile that was awarded the giveaway.



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

def recipient_integration_id
  @recipient_integration_id
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 34

def self.attribute_map
  {
    :'pool_id' => :'poolId',
    :'pool_name' => :'poolName',
    :'recipient_integration_id' => :'recipientIntegrationId',
    :'giveaway_id' => :'giveawayId',
    :'code' => :'code'
  }
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



181
182
183
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 181

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
59
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'pool_id' => :'Integer',
    :'pool_name' => :'String',
    :'recipient_integration_id' => :'String',
    :'giveaway_id' => :'Integer',
    :'code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 156

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pool_id == o.pool_id &&
      pool_name == o.pool_name &&
      recipient_integration_id == o.recipient_integration_id &&
      giveaway_id == o.giveaway_id &&
      code == o.code
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



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

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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 278

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 188

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


168
169
170
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 174

def hash
  [pool_id, pool_name, recipient_integration_id, giveaway_id, code].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



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

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

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

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

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

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

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



254
255
256
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 254

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 260

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



248
249
250
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 248

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



130
131
132
133
134
135
136
137
138
 
# File 'lib/talon_one/models/award_giveaway_effect_props.rb', line 130

def valid?
  return false if @pool_id.nil?
  return false if @pool_name.nil?
  return false if @recipient_integration_id.nil?
  return false if @recipient_integration_id.to_s.length > 1000
  return false if @giveaway_id.nil?
  return false if @code.nil?
  true
end