Class: Brevo::MainGetContactRewardsPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/models/main_get_contact_rewards_payload.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MainGetContactRewardsPayload

Initializes the object



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
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 88

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'contactId')
    self.contact_id = attributes[:'contactId']
  end

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

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

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

  if attributes.has_key?(:'rewardId')
    self.reward_id = attributes[:'rewardId']
  end

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

  if attributes.has_key?(:'sortField')
    self.sort_field = attributes[:'sortField']
  end
end

Instance Attribute Details

#contact_id ⇒ Object

Contact to attribute the reward



18
19
20
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 18

def contact_id
  @contact_id
end

#limit ⇒ Object

Number of documents per page



21
22
23
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 21

def limit
  @limit
end

#metadata ⇒ Object

Data to define the reward for that particular contact



24
25
26
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 24

def metadata
  @metadata
end

#offset ⇒ Object

Index of the first document in the page



27
28
29
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 27

def offset
  @offset
end

#reward_id ⇒ Object

Unique identifier of the associated reward



30
31
32
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 30

def reward_id
  @reward_id
end

#sort ⇒ Object

Sort the documents in the ascending or descending order



33
34
35
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 33

def sort
  @sort
end

#sort_field ⇒ Object

Sort documents by field



36
37
38
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 36

def sort_field
  @sort_field
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
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 61

def self.attribute_map
  {
    :'contact_id' => :'contactId',
    :'limit' => :'limit',
    :'metadata' => :'metadata',
    :'offset' => :'offset',
    :'reward_id' => :'rewardId',
    :'sort' => :'sort',
    :'sort_field' => :'sortField'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 74

def self.swagger_types
  {
    :'contact_id' => :'Integer',
    :'limit' => :'Integer',
    :'metadata' => :'Array<MainFilter>',
    :'offset' => :'Integer',
    :'reward_id' => :'String',
    :'sort' => :'String',
    :'sort_field' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contact_id == o.contact_id &&
      limit == o.limit &&
      metadata == o.metadata &&
      offset == o.offset &&
      reward_id == o.reward_id &&
      sort == o.sort &&
      sort_field == o.sort_field
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 275

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
    temp_model = Brevo.const_get(type).new
    temp_model.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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 341

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 254

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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

See Also:

  • `==` method


241
242
243
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



247
248
249
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 247

def hash
  [contact_id, limit, metadata, offset, reward_id, sort, sort_field].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 127

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

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

  if !@limit.nil? && @limit > 500
    invalid_properties.push('invalid value for "limit", must be smaller than or equal to 500.')
  end

  if !@limit.nil? && @limit < 1
    invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.')
  end

  if !@offset.nil? && @offset < 0
    invalid_properties.push('invalid value for "offset", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



321
322
323
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 321

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



327
328
329
330
331
332
333
334
335
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 327

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



315
316
317
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 315

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/brevo/models/main_get_contact_rewards_payload.rb', line 154

def valid?
  return false if @contact_id.nil?
  return false if @contact_id < 1
  return false if !@limit.nil? && @limit > 500
  return false if !@limit.nil? && @limit < 1
  return false if !@offset.nil? && @offset < 0
  sort_validator = EnumAttributeValidator.new('String', ['asc', 'desc'])
  return false unless sort_validator.valid?(@sort)
  sort_field_validator = EnumAttributeValidator.new('String', ['updatedAt', 'createdAt'])
  return false unless sort_field_validator.valid?(@sort_field)
  true
end