Class: Brevo::GetWebhook

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
150
 
# File 'lib/brevo/models/get_webhook.rb', line 101

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth ⇒ Object

Returns the value of attribute auth.



40
41
42
 
# File 'lib/brevo/models/get_webhook.rb', line 40

def auth
  @auth
end

#batched ⇒ Object

To send batched webhooks



38
39
40
 
# File 'lib/brevo/models/get_webhook.rb', line 38

def batched
  @batched
end

#created_at ⇒ Object

Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)



32
33
34
 
# File 'lib/brevo/models/get_webhook.rb', line 32

def created_at
  @created_at
end

#description ⇒ Object

Description of the webhook



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

def description
  @description
end

#events ⇒ Object

Returns the value of attribute events.



26
27
28
 
# File 'lib/brevo/models/get_webhook.rb', line 26

def events
  @events
end

#headers ⇒ Object

Custom headers to be send with webhooks



43
44
45
 
# File 'lib/brevo/models/get_webhook.rb', line 43

def headers
  @headers
end

#id ⇒ Object

ID of the webhook



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

def id
  @id
end

#modified_at ⇒ Object

Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)



35
36
37
 
# File 'lib/brevo/models/get_webhook.rb', line 35

def modified_at
  @modified_at
end

#type ⇒ Object

Type of webhook (marketing or transactional)



29
30
31
 
# File 'lib/brevo/models/get_webhook.rb', line 29

def type
  @type
end

#url ⇒ Object

URL of the webhook



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

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/brevo/models/get_webhook.rb', line 68

def self.attribute_map
  {
    :'url' => :'url',
    :'id' => :'id',
    :'description' => :'description',
    :'events' => :'events',
    :'type' => :'type',
    :'created_at' => :'createdAt',
    :'modified_at' => :'modifiedAt',
    :'batched' => :'batched',
    :'auth' => :'auth',
    :'headers' => :'headers'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/brevo/models/get_webhook.rb', line 84

def self.swagger_types
  {
    :'url' => :'String',
    :'id' => :'Integer',
    :'description' => :'String',
    :'events' => :'Array<String>',
    :'type' => :'String',
    :'created_at' => :'String',
    :'modified_at' => :'String',
    :'batched' => :'BOOLEAN',
    :'auth' => :'GetWebhookAuth',
    :'headers' => :'Array<GetWebhookHeaders>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/brevo/models/get_webhook.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      id == o.id &&
      description == o.description &&
      events == o.events &&
      type == o.type &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
      batched == o.batched &&
      auth == o.auth &&
      headers == o.headers
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



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
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/brevo/models/get_webhook.rb', line 265

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/brevo/models/get_webhook.rb', line 331

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/brevo/models/get_webhook.rb', line 244

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


231
232
233
 
# File 'lib/brevo/models/get_webhook.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



237
238
239
 
# File 'lib/brevo/models/get_webhook.rb', line 237

def hash
  [url, id, description, events, type, created_at, modified_at, batched, auth, headers].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/brevo/models/get_webhook.rb', line 154

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

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

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

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

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

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

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



311
312
313
 
# File 'lib/brevo/models/get_webhook.rb', line 311

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



317
318
319
320
321
322
323
324
325
 
# File 'lib/brevo/models/get_webhook.rb', line 317

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



305
306
307
 
# File 'lib/brevo/models/get_webhook.rb', line 305

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



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/brevo/models/get_webhook.rb', line 189

def valid?
  return false if @url.nil?
  return false if @id.nil?
  return false if @description.nil?
  return false if @events.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['marketing', 'transactional'])
  return false unless type_validator.valid?(@type)
  return false if @created_at.nil?
  return false if @modified_at.nil?
  true
end