Class: TalonOne::OutgoingIntegrationTemplateWithConfigurationDetails

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OutgoingIntegrationTemplateWithConfigurationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 105

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

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

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

The description of the specific outgoing integration template.



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

def description
  @description
end

#headers ⇒ Object

The list of HTTP headers for this integration template.



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

def headers
  @headers
end

#id ⇒ Object

Unique ID for this entity.



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

def id
  @id
end

#integration_type ⇒ Object

Unique ID of outgoing integration type.



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

def integration_type
  @integration_type
end

#method ⇒ Object

API method for this webhook.



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

def method
  @method
end

#payload ⇒ Object

The API payload (supports templating using parameters) for this integration template.



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

def payload
  @payload
end

#policy ⇒ Object

The outgoing integration policy specific to each integration type.



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

def policy
  @policy
end

#relative_url ⇒ Object

The relative URL corresponding to each integration template.



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

def relative_url
  @relative_url
end

#title ⇒ Object

The title of the integration template.



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

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 68

def self.attribute_map
  {
    :'id' => :'id',
    :'integration_type' => :'integrationType',
    :'title' => :'title',
    :'description' => :'description',
    :'payload' => :'payload',
    :'method' => :'method',
    :'relative_url' => :'relativeUrl',
    :'headers' => :'headers',
    :'policy' => :'policy'
  }
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



314
315
316
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 314

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 83

def self.openapi_types
  {
    :'id' => :'Integer',
    :'integration_type' => :'Integer',
    :'title' => :'String',
    :'description' => :'String',
    :'payload' => :'String',
    :'method' => :'String',
    :'relative_url' => :'String',
    :'headers' => :'Array<String>',
    :'policy' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 285

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      integration_type == o.integration_type &&
      title == o.title &&
      description == o.description &&
      payload == o.payload &&
      method == o.method &&
      relative_url == o.relative_url &&
      headers == o.headers &&
      policy == o.policy
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 342

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 411

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 321

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


301
302
303
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



307
308
309
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 307

def hash
  [id, integration_type, title, description, payload, method, relative_url, headers, policy].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



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
214
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 159

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

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

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

  if @title.to_s.length > 255
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
  end

  if @title.to_s.length < 1
    invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.')
  end

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

  if @description.to_s.length > 1000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 1000.')
  end

  if @description.to_s.length < 1
    invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
  end

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

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

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

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

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



387
388
389
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 387

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



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

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

Returns:

  • (String) —

    String presentation of the object



381
382
383
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 381

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb', line 218

def valid?
  return false if @id.nil?
  return false if @integration_type.nil?
  return false if @title.nil?
  return false if @title.to_s.length > 255
  return false if @title.to_s.length < 1
  return false if @description.nil?
  return false if @description.to_s.length > 1000
  return false if @description.to_s.length < 1
  return false if @payload.nil?
  return false if @method.nil?
  method_validator = EnumAttributeValidator.new('String', ["POST", "PUT", "GET", "DELETE", "PATCH"])
  return false unless method_validator.valid?(@method)
  return false if @relative_url.nil?
  return false if @headers.nil?
  return false if @policy.nil?
  true
end