Class: BrevoRuby::GetWebhook

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/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



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
118
119
120
121
122
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 87

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
end

Instance Attribute Details

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#description ⇒ Object

Description of the webhook



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

def description
  @description
end

#events ⇒ Object

Returns the value of attribute events.



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

def events
  @events
end

#id ⇒ Object

ID of the webhook



21
22
23
 
# File 'lib/brevo-ruby/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-ruby/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-ruby/models/get_webhook.rb', line 29

def type
  @type
end

#url ⇒ Object

URL of the webhook



18
19
20
 
# File 'lib/brevo-ruby/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.



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 60

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

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 73

def self.swagger_types
  {
    :'url' => :'String',
    :'id' => :'Integer',
    :'description' => :'String',
    :'events' => :'Array<String>',
    :'type' => :'String',
    :'created_at' => :'String',
    :'modified_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 186

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
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 234

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 = BrevoRuby.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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 300

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



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

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


200
201
202
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



206
207
208
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 206

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



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
151
152
153
154
155
156
157
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 126

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



280
281
282
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 280

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



286
287
288
289
290
291
292
293
294
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 286

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



274
275
276
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 274

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



161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/brevo-ruby/models/get_webhook.rb', line 161

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