Class: Brevo::GetCouponCollection

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCouponCollection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Datetime on which the collection was created.



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

def created_at
  @created_at
end

#default_coupon ⇒ Object

The default coupon of the collection.



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

def default_coupon
  @default_coupon
end

#expiration_date ⇒ Object

Expiration date for the coupon collection in RFC3339 format.



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

def expiration_date
  @expiration_date
end

#id ⇒ Object

The id of the collection.



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

def id
  @id
end

#name ⇒ Object

The name of the collection.



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

def name
  @name
end

#remaining_coupons ⇒ Object

Number of coupons that have not been sent yet.



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

def remaining_coupons
  @remaining_coupons
end

#remaining_coupons_alert ⇒ Object

If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.



42
43
44
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 42

def remaining_coupons_alert
  @remaining_coupons_alert
end

#remaining_days_alert ⇒ Object

If present, an email notification is going to be sent the defined amount of days before the expiration date.



39
40
41
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 39

def remaining_days_alert
  @remaining_days_alert
end

#total_coupons ⇒ Object

Total number of coupons in the collection.



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

def total_coupons
  @total_coupons
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 45

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'default_coupon' => :'defaultCoupon',
    :'created_at' => :'createdAt',
    :'total_coupons' => :'totalCoupons',
    :'remaining_coupons' => :'remainingCoupons',
    :'expiration_date' => :'expirationDate',
    :'remaining_days_alert' => :'remainingDaysAlert',
    :'remaining_coupons_alert' => :'remainingCouponsAlert'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 60

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'default_coupon' => :'String',
    :'created_at' => :'DateTime',
    :'total_coupons' => :'Integer',
    :'remaining_coupons' => :'Integer',
    :'expiration_date' => :'DateTime',
    :'remaining_days_alert' => :'Integer',
    :'remaining_coupons_alert' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      default_coupon == o.default_coupon &&
      created_at == o.created_at &&
      total_coupons == o.total_coupons &&
      remaining_coupons == o.remaining_coupons &&
      expiration_date == o.expiration_date &&
      remaining_days_alert == o.remaining_days_alert &&
      remaining_coupons_alert == o.remaining_coupons_alert
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



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
245
246
247
248
249
250
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 214

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 280

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 193

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


180
181
182
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



186
187
188
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 186

def hash
  [id, name, default_coupon, created_at, total_coupons, remaining_coupons, expiration_date, remaining_days_alert, remaining_coupons_alert].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



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

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

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

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

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

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

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



260
261
262
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 260

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



266
267
268
269
270
271
272
273
274
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 266

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

Returns:

  • (String) —

    String presentation of the object



254
255
256
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 254

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



152
153
154
155
156
157
158
159
160
 
# File 'lib/brevo/models/get_coupon_collection.rb', line 152

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @default_coupon.nil?
  return false if @created_at.nil?
  return false if @total_coupons.nil?
  return false if @remaining_coupons.nil?
  true
end