Class: Zernio::Webhook

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/webhook.rb

Overview

Individual webhook configuration for receiving real-time notifications

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Webhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/zernio-sdk/models/webhook.rb', line 131

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::Webhook` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::Webhook`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'_id')
    self._id = attributes[:'_id']
  end

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

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.key?(:'secret')
    self.secret = attributes[:'secret']
  end

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

  if attributes.key?(:'is_active')
    self.is_active = attributes[:'is_active']
  end

  if attributes.key?(:'last_fired_at')
    self.last_fired_at = attributes[:'last_fired_at']
  end

  if attributes.key?(:'failure_count')
    self.failure_count = attributes[:'failure_count']
  end

  if attributes.key?(:'custom_headers')
    if (value = attributes[:'custom_headers']).is_a?(Hash)
      self.custom_headers = value
    end
  end

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

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

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

Instance Attribute Details

#_id ⇒ Object

Unique webhook identifier



20
21
22
 
# File 'lib/zernio-sdk/models/webhook.rb', line 20

def _id
  @_id
end

#account_ids ⇒ Object

Connected accounts this subscription receives events for (allowlist). Absent or empty means every account. Same semantics as profileIds, keyed on the account: an aggregate post.* event is attributed to every account the post targets. Events that name no connected account (verification.*, phone_number.*, and whatsapp.number.*, which carry the phone number) are not delivered to an account-scoped subscription. A subscription with both lists must be satisfied on both. Applied when the event is emitted; a redelivery replays a delivery already made to this endpoint and a test fire ignores the list.



53
54
55
 
# File 'lib/zernio-sdk/models/webhook.rb', line 53

def 
  @account_ids
end

#custom_headers ⇒ Object

Custom headers included in webhook requests



44
45
46
 
# File 'lib/zernio-sdk/models/webhook.rb', line 44

def custom_headers
  @custom_headers
end

#disabled_resource_groups ⇒ Object

Resource groups this subscription does not receive (opt-out denylist, same vocabulary and same semantics as the field on API keys). Absent or empty means the subscription receives every event listed in events, which is how every subscription created before this field existed behaves. An event whose group is listed here is dropped before delivery even when it is still present in events, and the same check runs on every replay path (test fire, redelivery, dead-letter requeue). Editing the denylist applies to every event emitted afterwards; events already queued when the edit landed can still be delivered for up to five minutes after they were enqueued.



47
48
49
 
# File 'lib/zernio-sdk/models/webhook.rb', line 47

def disabled_resource_groups
  @disabled_resource_groups
end

#events ⇒ Object

Events subscribed to



32
33
34
 
# File 'lib/zernio-sdk/models/webhook.rb', line 32

def events
  @events
end

#failure_count ⇒ Object

Consecutive terminal delivery failures (resets to 0 on any successful delivery). Auto-disable only triggers when the endpoint has had no successful delivery within a 3-day window AND either reaches 20 consecutive terminal failures or has been failing continuously for 3 days; any success within that window keeps the endpoint enabled regardless of the count.



41
42
43
 
# File 'lib/zernio-sdk/models/webhook.rb', line 41

def failure_count
  @failure_count
end

#is_active ⇒ Object

Whether webhook delivery is enabled



35
36
37
 
# File 'lib/zernio-sdk/models/webhook.rb', line 35

def is_active
  @is_active
end

#last_fired_at ⇒ Object

Timestamp of last successful webhook delivery



38
39
40
 
# File 'lib/zernio-sdk/models/webhook.rb', line 38

def last_fired_at
  @last_fired_at
end

#name ⇒ Object

Webhook name (for identification)



23
24
25
 
# File 'lib/zernio-sdk/models/webhook.rb', line 23

def name
  @name
end

#profile_ids ⇒ Object

Profiles this subscription receives events for (allowlist). Absent or empty means every profile, which is how every subscription created before this field existed behaves. A scoped subscription is only sent events attributable to a listed profile. An aggregate post.* event is attributed to the profile of every account the post targets, so a post spanning two scoped endpoints' profiles reaches both. Events with no profile behind them (verification.*, phone_number.*, a legacy post whose accounts were deleted) are not delivered to it. Applied when the event is emitted: a redelivery replays a delivery already made to this endpoint, and a test fire ignores the list.



50
51
52
 
# File 'lib/zernio-sdk/models/webhook.rb', line 50

def profile_ids
  @profile_ids
end

#secret ⇒ Object

Secret key for HMAC-SHA256 signature verification.



29
30
31
 
# File 'lib/zernio-sdk/models/webhook.rb', line 29

def secret
  @secret
end

#url ⇒ Object

Webhook endpoint URL



26
27
28
 
# File 'lib/zernio-sdk/models/webhook.rb', line 26

def url
  @url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



96
97
98
 
# File 'lib/zernio-sdk/models/webhook.rb', line 96

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



101
102
103
 
# File 'lib/zernio-sdk/models/webhook.rb', line 101

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/zernio-sdk/models/webhook.rb', line 78

def self.attribute_map
  {
    :'_id' => :'_id',
    :'name' => :'name',
    :'url' => :'url',
    :'secret' => :'secret',
    :'events' => :'events',
    :'is_active' => :'isActive',
    :'last_fired_at' => :'lastFiredAt',
    :'failure_count' => :'failureCount',
    :'custom_headers' => :'customHeaders',
    :'disabled_resource_groups' => :'disabledResourceGroups',
    :'profile_ids' => :'profileIds',
    :'account_ids' => :'accountIds'
  }
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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/zernio-sdk/models/webhook.rb', line 272

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



124
125
126
127
 
# File 'lib/zernio-sdk/models/webhook.rb', line 124

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/zernio-sdk/models/webhook.rb', line 106

def self.openapi_types
  {
    :'_id' => :'String',
    :'name' => :'String',
    :'url' => :'String',
    :'secret' => :'String',
    :'events' => :'Array<String>',
    :'is_active' => :'Boolean',
    :'last_fired_at' => :'Time',
    :'failure_count' => :'Integer',
    :'custom_headers' => :'Hash<String, String>',
    :'disabled_resource_groups' => :'Array<String>',
    :'profile_ids' => :'Array<String>',
    :'account_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/zernio-sdk/models/webhook.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _id == o._id &&
      name == o.name &&
      url == o.url &&
      secret == o.secret &&
      events == o.events &&
      is_active == o.is_active &&
      last_fired_at == o.last_fired_at &&
      failure_count == o.failure_count &&
      custom_headers == o.custom_headers &&
      disabled_resource_groups == o.disabled_resource_groups &&
      profile_ids == o.profile_ids &&
       == o.
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


259
260
261
 
# File 'lib/zernio-sdk/models/webhook.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/zernio-sdk/models/webhook.rb', line 265

def hash
  [_id, name, url, secret, events, is_active, last_fired_at, failure_count, custom_headers, disabled_resource_groups, profile_ids, ].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



206
207
208
209
210
211
212
213
214
 
# File 'lib/zernio-sdk/models/webhook.rb', line 206

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 50
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/zernio-sdk/models/webhook.rb', line 294

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



218
219
220
221
222
 
# File 'lib/zernio-sdk/models/webhook.rb', line 218

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@name.nil? && @name.to_s.length > 50
  true
end