Class: TalonOne::WebhookWithOutgoingIntegrationDetails

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookWithOutgoingIntegrationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 135

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::WebhookWithOutgoingIntegrationDetails` 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::WebhookWithOutgoingIntegrationDetails`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

Instance Attribute Details

#application_idsObject

The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity.



28
29
30
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 28

def application_ids
  @application_ids
end

#createdObject

The time this entity was created.



22
23
24
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 22

def created
  @created
end

#descriptionObject

A description of the webhook.



34
35
36
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 34

def description
  @description
end

#enabledObject

Enables or disables webhook from showing in the Rule Builder.



52
53
54
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 52

def enabled
  @enabled
end

#headersObject

List of API HTTP headers for this webhook.



43
44
45
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 43

def headers
  @headers
end

#idObject

Internal ID of this entity.



19
20
21
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 19

def id
  @id
end

#modifiedObject

The time this entity was last modified.



25
26
27
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 25

def modified
  @modified
end

#outgoing_integration_template_idObject

Identifier of the outgoing integration template.



55
56
57
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 55

def outgoing_integration_template_id
  @outgoing_integration_template_id
end

#outgoing_integration_type_idObject

Identifier of the outgoing integration type.



58
59
60
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 58

def outgoing_integration_type_id
  @outgoing_integration_type_id
end

#outgoing_integration_type_nameObject

Name of the outgoing integration.



61
62
63
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 61

def outgoing_integration_type_name
  @outgoing_integration_type_name
end

#paramsObject

Array of template argument definitions.



49
50
51
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 49

def params
  @params
end

#payloadObject

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



46
47
48
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 46

def payload
  @payload
end

#titleObject

Name or title for this webhook.



31
32
33
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 31

def title
  @title
end

#urlObject

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



40
41
42
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 40

def url
  @url
end

#verbObject

API method for this webhook.



37
38
39
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 37

def verb
  @verb
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'modified' => :'modified',
    :'application_ids' => :'applicationIds',
    :'title' => :'title',
    :'description' => :'description',
    :'verb' => :'verb',
    :'url' => :'url',
    :'headers' => :'headers',
    :'payload' => :'payload',
    :'params' => :'params',
    :'enabled' => :'enabled',
    :'outgoing_integration_template_id' => :'outgoingIntegrationTemplateId',
    :'outgoing_integration_type_id' => :'outgoingIntegrationTypeId',
    :'outgoing_integration_type_name' => :'outgoingIntegrationTypeName'
  }
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



348
349
350
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 348

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

.openapi_nullableObject

List of attributes with nullable: true



128
129
130
131
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 128

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

.openapi_typesObject

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 107

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'modified' => :'DateTime',
    :'application_ids' => :'Array<Integer>',
    :'title' => :'String',
    :'description' => :'String',
    :'verb' => :'String',
    :'url' => :'String',
    :'headers' => :'Array<String>',
    :'payload' => :'String',
    :'params' => :'Array<TemplateArgDef>',
    :'enabled' => :'Boolean',
    :'outgoing_integration_template_id' => :'Integer',
    :'outgoing_integration_type_id' => :'Integer',
    :'outgoing_integration_type_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      modified == o.modified &&
      application_ids == o.application_ids &&
      title == o.title &&
      description == o.description &&
      verb == o.verb &&
      url == o.url &&
      headers == o.headers &&
      payload == o.payload &&
      params == o.params &&
      enabled == o.enabled &&
      outgoing_integration_template_id == o.outgoing_integration_template_id &&
      outgoing_integration_type_id == o.outgoing_integration_type_id &&
      outgoing_integration_type_name == o.outgoing_integration_type_name
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



376
377
378
379
380
381
382
383
384
385
386
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
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 376

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



445
446
447
448
449
450
451
452
453
454
455
456
457
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 445

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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 355

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


335
336
337
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 335

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



341
342
343
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 341

def hash
  [id, created, modified, application_ids, title, description, verb, url, headers, payload, params, enabled, outgoing_integration_template_id, outgoing_integration_type_id, outgoing_integration_type_name].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



421
422
423
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 421

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



427
428
429
430
431
432
433
434
435
436
437
438
439
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 427

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



415
416
417
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 415

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'lib/talon_one/models/webhook_with_outgoing_integration_details.rb', line 269

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @modified.nil?
  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 @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