Class: CloudsmithApi::RepositoryWebhook

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/models/repository_webhook.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RepositoryWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
203
204
205
206
207
208
209
210
211
212
213
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
251
252
253
254
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
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 170

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



17
18
19
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 17

def created_at
  @created_at
end

#created_by ⇒ Object

Returns the value of attribute created_by.



19
20
21
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 19

def created_by
  @created_by
end

#created_by_url ⇒ Object

Returns the value of attribute created_by_url.



21
22
23
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 21

def created_by_url
  @created_by_url
end

#disable_reason ⇒ Object

Returns the value of attribute disable_reason.



23
24
25
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 23

def disable_reason
  @disable_reason
end

#disable_reason_str ⇒ Object

Returns the value of attribute disable_reason_str.



25
26
27
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 25

def disable_reason_str
  @disable_reason_str
end

#events ⇒ Object

Returns the value of attribute events.



27
28
29
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 27

def events
  @events
end

#identifier ⇒ Object

Deprecated (23-05-15): Please use ‘slug_perm’ instead. Previously: A monotonically increasing number that identified a webhook request within a repository.



30
31
32
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 30

def identifier
  @identifier
end

#is_active ⇒ Object

If enabled, the webhook will trigger on subscribed events and send payloads to the configured target URL.



33
34
35
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 33

def is_active
  @is_active
end

#is_last_response_bad ⇒ Object

Returns the value of attribute is_last_response_bad.



35
36
37
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 35

def is_last_response_bad
  @is_last_response_bad
end

#last_response_status ⇒ Object

Returns the value of attribute last_response_status.



37
38
39
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 37

def last_response_status
  @last_response_status
end

#last_response_status_str ⇒ Object

Returns the value of attribute last_response_status_str.



39
40
41
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 39

def last_response_status_str
  @last_response_status_str
end

#num_sent ⇒ Object

Returns the value of attribute num_sent.



41
42
43
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 41

def num_sent
  @num_sent
end

#package_query ⇒ Object

The package-based search query for webhooks to fire. This uses the same syntax as the standard search used for repositories, and also supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. If a package does not match, the webhook will not fire.



44
45
46
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 44

def package_query
  @package_query
end

#request_body_format ⇒ Object

The format of the payloads for webhook requests. Valid options are: (0) JSON, (1) JSON array, (2) form encoded JSON and (3) Handlebars template.



47
48
49
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 47

def request_body_format
  @request_body_format
end

#request_body_format_str ⇒ Object

Returns the value of attribute request_body_format_str.



49
50
51
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 49

def request_body_format_str
  @request_body_format_str
end

#request_body_template_format ⇒ Object

The format of the payloads for webhook requests. Valid options are: (0) Generic/user defined, (1) JSON and (2) XML.



52
53
54
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 52

def request_body_template_format
  @request_body_template_format
end

#request_body_template_format_str ⇒ Object

Returns the value of attribute request_body_template_format_str.



54
55
56
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 54

def request_body_template_format_str
  @request_body_template_format_str
end

#request_content_type ⇒ Object

The value that will be sent for the ‘Content Type’ header.



57
58
59
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 57

def request_content_type
  @request_content_type
end

#secret_header ⇒ Object

The header to send the predefined secret in. This must be unique from existing headers or it won’t be sent. You can use this as a form of authentication on the endpoint side.



60
61
62
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 60

def secret_header
  @secret_header
end

#self_url ⇒ Object

Returns the value of attribute self_url.



62
63
64
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 62

def self_url
  @self_url
end

#slug_perm ⇒ Object

Returns the value of attribute slug_perm.



64
65
66
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 64

def slug_perm
  @slug_perm
end

#target_url ⇒ Object

The destination URL that webhook payloads will be POST’ed to.



67
68
69
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 67

def target_url
  @target_url
end

#templates ⇒ Object

Returns the value of attribute templates.



69
70
71
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 69

def templates
  @templates
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



71
72
73
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 71

def updated_at
  @updated_at
end

#updated_by ⇒ Object

Returns the value of attribute updated_by.



73
74
75
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 73

def updated_by
  @updated_by
end

#updated_by_url ⇒ Object

Returns the value of attribute updated_by_url.



75
76
77
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 75

def updated_by_url
  @updated_by_url
end

#verify_ssl ⇒ Object

If enabled, SSL certificates is verified when webhooks are sent. It’s recommended to leave this enabled as not verifying the integrity of SSL certificates leaves you susceptible to Man-in-the-Middle (MITM) attacks.



78
79
80
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 78

def verify_ssl
  @verify_ssl
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 103

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'created_by' => :'created_by',
    :'created_by_url' => :'created_by_url',
    :'disable_reason' => :'disable_reason',
    :'disable_reason_str' => :'disable_reason_str',
    :'events' => :'events',
    :'identifier' => :'identifier',
    :'is_active' => :'is_active',
    :'is_last_response_bad' => :'is_last_response_bad',
    :'last_response_status' => :'last_response_status',
    :'last_response_status_str' => :'last_response_status_str',
    :'num_sent' => :'num_sent',
    :'package_query' => :'package_query',
    :'request_body_format' => :'request_body_format',
    :'request_body_format_str' => :'request_body_format_str',
    :'request_body_template_format' => :'request_body_template_format',
    :'request_body_template_format_str' => :'request_body_template_format_str',
    :'request_content_type' => :'request_content_type',
    :'secret_header' => :'secret_header',
    :'self_url' => :'self_url',
    :'slug_perm' => :'slug_perm',
    :'target_url' => :'target_url',
    :'templates' => :'templates',
    :'updated_at' => :'updated_at',
    :'updated_by' => :'updated_by',
    :'updated_by_url' => :'updated_by_url',
    :'verify_ssl' => :'verify_ssl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 136

def self.swagger_types
  {
    :'created_at' => :'DateTime',
    :'created_by' => :'String',
    :'created_by_url' => :'String',
    :'disable_reason' => :'Integer',
    :'disable_reason_str' => :'String',
    :'events' => :'Array<String>',
    :'identifier' => :'Integer',
    :'is_active' => :'BOOLEAN',
    :'is_last_response_bad' => :'BOOLEAN',
    :'last_response_status' => :'Integer',
    :'last_response_status_str' => :'String',
    :'num_sent' => :'Integer',
    :'package_query' => :'String',
    :'request_body_format' => :'Integer',
    :'request_body_format_str' => :'String',
    :'request_body_template_format' => :'Integer',
    :'request_body_template_format_str' => :'String',
    :'request_content_type' => :'String',
    :'secret_header' => :'String',
    :'self_url' => :'String',
    :'slug_perm' => :'String',
    :'target_url' => :'String',
    :'templates' => :'Array<WebhookTemplate>',
    :'updated_at' => :'DateTime',
    :'updated_by' => :'String',
    :'updated_by_url' => :'String',
    :'verify_ssl' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 319

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      created_by == o.created_by &&
      created_by_url == o.created_by_url &&
      disable_reason == o.disable_reason &&
      disable_reason_str == o.disable_reason_str &&
      events == o.events &&
      identifier == o.identifier &&
      is_active == o.is_active &&
      is_last_response_bad == o.is_last_response_bad &&
      last_response_status == o.last_response_status &&
      last_response_status_str == o.last_response_status_str &&
      num_sent == o.num_sent &&
      package_query == o.package_query &&
      request_body_format == o.request_body_format &&
      request_body_format_str == o.request_body_format_str &&
      request_body_template_format == o.request_body_template_format &&
      request_body_template_format_str == o.request_body_template_format_str &&
      request_content_type == o.request_content_type &&
      secret_header == o.secret_header &&
      self_url == o.self_url &&
      slug_perm == o.slug_perm &&
      target_url == o.target_url &&
      templates == o.templates &&
      updated_at == o.updated_at &&
      updated_by == o.updated_by &&
      updated_by_url == o.updated_by_url &&
      verify_ssl == o.verify_ssl
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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 387

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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 453

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 366

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


353
354
355
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 353

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



359
360
361
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 359

def hash
  [created_at, created_by, created_by_url, disable_reason, disable_reason_str, events, identifier, is_active, is_last_response_bad, last_response_status, last_response_status_str, num_sent, package_query, request_body_format, request_body_format_str, request_body_template_format, request_body_template_format_str, request_content_type, secret_header, self_url, slug_perm, target_url, templates, updated_at, updated_by, updated_by_url, verify_ssl].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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 291

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

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

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



433
434
435
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 433

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



439
440
441
442
443
444
445
446
447
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 439

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



427
428
429
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 427

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



310
311
312
313
314
315
 
# File 'lib/cloudsmith-api/models/repository_webhook.rb', line 310

def valid?
  return false if @events.nil?
  return false if @target_url.nil?
  return false if @templates.nil?
  true
end