Class: Brevo::ExportWebhooksHistory

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportWebhooksHistory

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#days ⇒ Object

Number of days in the past including today (positive integer). _Not compatible with ‘startDate’ and ‘endDate’_



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

def days
  @days
end

#email ⇒ Object

Filter the history for a specific email



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

def email
  @email
end

#end_date ⇒ Object

Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate



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

def end_date
  @end_date
end

#event ⇒ Object

Filter the history for a specific event type



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

def event
  @event
end

#message_id ⇒ Object

Filter the history for a specific message id. Applicable only for transactional webhooks.



45
46
47
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 45

def message_id
  @message_id
end

#notify_url ⇒ Object

Webhook URL to receive CSV file link



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

def notify_url
  @notify_url
end

#sort ⇒ Object

Sorting order of records (asc or desc)



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

def sort
  @sort
end

#start_date ⇒ Object

Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate



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

def start_date
  @start_date
end

#type ⇒ Object

Filter the history based on webhook type



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

def type
  @type
end

#webhook_id ⇒ Object

Filter the history for a specific webhook id



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

def webhook_id
  @webhook_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'days' => :'days',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'sort' => :'sort',
    :'type' => :'type',
    :'event' => :'event',
    :'notify_url' => :'notifyURL',
    :'webhook_id' => :'webhookId',
    :'email' => :'email',
    :'message_id' => :'messageId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 86

def self.swagger_types
  {
    :'days' => :'Integer',
    :'start_date' => :'String',
    :'end_date' => :'String',
    :'sort' => :'String',
    :'type' => :'String',
    :'event' => :'String',
    :'notify_url' => :'String',
    :'webhook_id' => :'Integer',
    :'email' => :'String',
    :'message_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      days == o.days &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      sort == o.sort &&
      type == o.type &&
      event == o.event &&
      notify_url == o.notify_url &&
      webhook_id == o.webhook_id &&
      email == o.email &&
      message_id == o.message_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



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
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 255

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 321

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 234

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


221
222
223
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



227
228
229
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 227

def hash
  [days, start_date, end_date, sort, type, event, notify_url, webhook_id, email, message_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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 152

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

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

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



301
302
303
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 301

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



307
308
309
310
311
312
313
314
315
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 307

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



295
296
297
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 295

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



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/brevo/models/export_webhooks_history.rb', line 171

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['transactional', 'marketing'])
  return false unless type_validator.valid?(@type)
  return false if @event.nil?
  event_validator = EnumAttributeValidator.new('String', ['invalid_parameter', 'missing_parameter', 'hardBounce', 'softBounce', 'delivered', 'spam', 'request', 'opened', 'click', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error', 'uniqueOpened', 'loadedByProxy', 'allEvents'])
  return false unless event_validator.valid?(@event)
  return false if @notify_url.nil?
  true
end