Class: TalonOne::NewWebhook

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/new_webhook.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewWebhook

Initializes the object



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
169
170
171
172
173
174
175
176
 
# File 'lib/talon_one/models/new_webhook.rb', line 114

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#application_ids ⇒ Object

The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in ‘All Applications`.



18
19
20
 
# File 'lib/talon_one/models/new_webhook.rb', line 18

def application_ids
  @application_ids
end

#authentication_id ⇒ Object

The ID of the credential that this webhook is using.



48
49
50
 
# File 'lib/talon_one/models/new_webhook.rb', line 48

def authentication_id
  @authentication_id
end

#description ⇒ Object

A description of the webhook.



24
25
26
 
# File 'lib/talon_one/models/new_webhook.rb', line 24

def description
  @description
end

#draft ⇒ Object

Indicates if the webhook is a draft.



27
28
29
 
# File 'lib/talon_one/models/new_webhook.rb', line 27

def draft
  @draft
end

#enabled ⇒ Object

Enables or disables webhook from showing in the Rule Builder.



45
46
47
 
# File 'lib/talon_one/models/new_webhook.rb', line 45

def enabled
  @enabled
end

#headers ⇒ Object

List of API HTTP headers for this webhook.



36
37
38
 
# File 'lib/talon_one/models/new_webhook.rb', line 36

def headers
  @headers
end

#params ⇒ Object

Array of template argument definitions.



42
43
44
 
# File 'lib/talon_one/models/new_webhook.rb', line 42

def params
  @params
end

#payload ⇒ Object

API payload (supports templating using parameters) for this webhook.



39
40
41
 
# File 'lib/talon_one/models/new_webhook.rb', line 39

def payload
  @payload
end

#title ⇒ Object

Name or title for this webhook.



21
22
23
 
# File 'lib/talon_one/models/new_webhook.rb', line 21

def title
  @title
end

#url ⇒ Object

API URL (supports templating using parameters) for this webhook.



33
34
35
 
# File 'lib/talon_one/models/new_webhook.rb', line 33

def url
  @url
end

#verb ⇒ Object

API method for this webhook.



30
31
32
 
# File 'lib/talon_one/models/new_webhook.rb', line 30

def verb
  @verb
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/talon_one/models/new_webhook.rb', line 73

def self.attribute_map
  {
    :'application_ids' => :'applicationIds',
    :'title' => :'title',
    :'description' => :'description',
    :'draft' => :'draft',
    :'verb' => :'verb',
    :'url' => :'url',
    :'headers' => :'headers',
    :'payload' => :'payload',
    :'params' => :'params',
    :'enabled' => :'enabled',
    :'authentication_id' => :'authenticationId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



297
298
299
 
# File 'lib/talon_one/models/new_webhook.rb', line 297

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/talon_one/models/new_webhook.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/talon_one/models/new_webhook.rb', line 90

def self.openapi_types
  {
    :'application_ids' => :'Array<Integer>',
    :'title' => :'String',
    :'description' => :'String',
    :'draft' => :'Boolean',
    :'verb' => :'String',
    :'url' => :'String',
    :'headers' => :'Array<String>',
    :'payload' => :'String',
    :'params' => :'Array<TemplateArgDef>',
    :'enabled' => :'Boolean',
    :'authentication_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/talon_one/models/new_webhook.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      application_ids == o.application_ids &&
      title == o.title &&
      description == o.description &&
      draft == o.draft &&
      verb == o.verb &&
      url == o.url &&
      headers == o.headers &&
      payload == o.payload &&
      params == o.params &&
      enabled == o.enabled &&
      authentication_id == o.authentication_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/talon_one/models/new_webhook.rb', line 325

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
    TalonOne.const_get(type).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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/talon_one/models/new_webhook.rb', line 394

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/talon_one/models/new_webhook.rb', line 304

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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

See Also:

  • `==` method


284
285
286
 
# File 'lib/talon_one/models/new_webhook.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



290
291
292
 
# File 'lib/talon_one/models/new_webhook.rb', line 290

def hash
  [application_ids, title, description, draft, verb, url, headers, payload, params, enabled, authentication_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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
 
# File 'lib/talon_one/models/new_webhook.rb', line 180

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

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

  pattern = Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/)
  if @title !~ pattern
    invalid_properties.push("invalid value for \"title\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



370
371
372
 
# File 'lib/talon_one/models/new_webhook.rb', line 370

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/talon_one/models/new_webhook.rb', line 376

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

#to_s ⇒ String

Returns the string representation of the object



364
365
366
 
# File 'lib/talon_one/models/new_webhook.rb', line 364

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/talon_one/models/new_webhook.rb', line 224

def valid?
  return false if @application_ids.nil?
  return false if @title.nil?
  return false if @title !~ Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/)
  return false if @draft.nil?
  return false if @verb.nil?
  verb_validator = EnumAttributeValidator.new('String', ["POST", "PUT", "GET", "DELETE", "PATCH"])
  return false unless verb_validator.valid?(@verb)
  return false if @url.nil?
  return false if @headers.nil?
  return false if @params.nil?
  return false if @enabled.nil?
  true
end