Class: CloudsmithApi::RepositoryWebhookRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RepositoryWebhookRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 111

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?(:'events')
    if (value = attributes[:'events']).is_a?(Array)
      self.events = value
    end
  end

  if attributes.has_key?(:'is_active')
    self.is_active = attributes[:'is_active']
  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_template_format')
    self.request_body_template_format = attributes[:'request_body_template_format']
  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?(:'secret_value')
    self.secret_value = attributes[:'secret_value']
  end

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

Instance Attribute Details

#events ⇒ Object

Returns the value of attribute events.



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

def events
  @events
end

#is_active ⇒ Object

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



20
21
22
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 20

def is_active
  @is_active
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.



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

def package_query
  @package_query
end

#request_body_format ⇒ Object

The format of the payloads for webhook requests.



26
27
28
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 26

def request_body_format
  @request_body_format
end

#request_body_template_format ⇒ Object

The format of the payloads for webhook requests.



29
30
31
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 29

def request_body_template_format
  @request_body_template_format
end

#request_content_type ⇒ Object

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



32
33
34
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 32

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.



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

def secret_header
  @secret_header
end

#secret_value ⇒ Object

The value for the predefined secret (note: this is treated as a passphrase and is encrypted when we store it). You can use this as a form of authentication on the endpoint side.



38
39
40
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 38

def secret_value
  @secret_value
end

#signature_key ⇒ Object

The value for the signature key - This is used to generate an HMAC-based hex digest of the request body, which we send as the X-Cloudsmith-Signature header so that you can ensure that the request wasn’t modified by a malicious party (note: this is treated as a passphrase and is encrypted when we store it).



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

def signature_key
  @signature_key
end

#target_url ⇒ Object

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



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

def target_url
  @target_url
end

#templates ⇒ Object

Returns the value of attribute templates.



46
47
48
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 46

def templates
  @templates
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.



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

def verify_ssl
  @verify_ssl
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 74

def self.attribute_map
  {
    :'events' => :'events',
    :'is_active' => :'is_active',
    :'package_query' => :'package_query',
    :'request_body_format' => :'request_body_format',
    :'request_body_template_format' => :'request_body_template_format',
    :'request_content_type' => :'request_content_type',
    :'secret_header' => :'secret_header',
    :'secret_value' => :'secret_value',
    :'signature_key' => :'signature_key',
    :'target_url' => :'target_url',
    :'templates' => :'templates',
    :'verify_ssl' => :'verify_ssl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 92

def self.swagger_types
  {
    :'events' => :'Array<String>',
    :'is_active' => :'BOOLEAN',
    :'package_query' => :'String',
    :'request_body_format' => :'Integer',
    :'request_body_template_format' => :'Integer',
    :'request_content_type' => :'String',
    :'secret_header' => :'String',
    :'secret_value' => :'String',
    :'signature_key' => :'String',
    :'target_url' => :'String',
    :'templates' => :'Array<WebhookTemplate>',
    :'verify_ssl' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      events == o.events &&
      is_active == o.is_active &&
      package_query == o.package_query &&
      request_body_format == o.request_body_format &&
      request_body_template_format == o.request_body_template_format &&
      request_content_type == o.request_content_type &&
      secret_header == o.secret_header &&
      secret_value == o.secret_value &&
      signature_key == o.signature_key &&
      target_url == o.target_url &&
      templates == o.templates &&
      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



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
288
289
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 253

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 319

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 232

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


219
220
221
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



225
226
227
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 225

def hash
  [events, is_active, package_query, request_body_format, request_body_template_format, request_content_type, secret_header, secret_value, signature_key, target_url, templates, 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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 172

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



299
300
301
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 299

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



305
306
307
308
309
310
311
312
313
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 305

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



293
294
295
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 293

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



191
192
193
194
195
196
 
# File 'lib/cloudsmith-api/models/repository_webhook_request.rb', line 191

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