Class: Svix::EndpointIn

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/models/endpoint_in.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndpointIn

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
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
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
 
# File 'lib/svix/models/endpoint_in.rb', line 92

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

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

  if attributes.key?(:'disabled')
    self.disabled = attributes[:'disabled']
  else
    self.disabled = false
  end

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

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

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

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

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

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

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  else
    self.version = 1
  end
end

Instance Attribute Details

#channels ⇒ Object

List of message channels this endpoint listens to (omit for all)



19
20
21
 
# File 'lib/svix/models/endpoint_in.rb', line 19

def channels
  @channels
end

#description ⇒ Object

Returns the value of attribute description.



21
22
23
 
# File 'lib/svix/models/endpoint_in.rb', line 21

def description
  @description
end

#disabled ⇒ Object

Returns the value of attribute disabled.



23
24
25
 
# File 'lib/svix/models/endpoint_in.rb', line 23

def disabled
  @disabled
end

#filter_types ⇒ Object

Returns the value of attribute filter_types.



25
26
27
 
# File 'lib/svix/models/endpoint_in.rb', line 25

def filter_types
  @filter_types
end

#metadata ⇒ Object

Returns the value of attribute metadata.



27
28
29
 
# File 'lib/svix/models/endpoint_in.rb', line 27

def metadata
  @metadata
end

#rate_limit ⇒ Object

Returns the value of attribute rate_limit.



29
30
31
 
# File 'lib/svix/models/endpoint_in.rb', line 29

def rate_limit
  @rate_limit
end

#secret ⇒ Object

The endpoint’s verification secret. If ‘null` is passed, a secret is automatically generated. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. Recommended size: 24.



32
33
34
 
# File 'lib/svix/models/endpoint_in.rb', line 32

def secret
  @secret
end

#uid ⇒ Object

Optional unique identifier for the endpoint



35
36
37
 
# File 'lib/svix/models/endpoint_in.rb', line 35

def uid
  @uid
end

#url ⇒ Object

Returns the value of attribute url.



37
38
39
 
# File 'lib/svix/models/endpoint_in.rb', line 37

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



39
40
41
 
# File 'lib/svix/models/endpoint_in.rb', line 39

def version
  @version
end

Class Method Details

._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



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
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/svix/models/endpoint_in.rb', line 385

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Svix.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/svix/models/endpoint_in.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/svix/models/endpoint_in.rb', line 42

def self.attribute_map
  {
    :'channels' => :'channels',
    :'description' => :'description',
    :'disabled' => :'disabled',
    :'filter_types' => :'filterTypes',
    :'metadata' => :'metadata',
    :'rate_limit' => :'rateLimit',
    :'secret' => :'secret',
    :'uid' => :'uid',
    :'url' => :'url',
    :'version' => :'version'
  }
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/svix/models/endpoint_in.rb', line 361

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/svix/models/endpoint_in.rb', line 79

def self.openapi_nullable
  Set.new([
    :'channels',
    :'filter_types',
    :'rate_limit',
    :'secret',
    :'uid',
    :'version'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/svix/models/endpoint_in.rb', line 63

def self.openapi_types
  {
    :'channels' => :'Array<String>',
    :'description' => :'String',
    :'disabled' => :'Boolean',
    :'filter_types' => :'Array<String>',
    :'metadata' => :'Hash<String, String>',
    :'rate_limit' => :'Integer',
    :'secret' => :'String',
    :'uid' => :'String',
    :'url' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/svix/models/endpoint_in.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channels == o.channels &&
      description == o.description &&
      disabled == o.disabled &&
      filter_types == o.filter_types &&
      metadata == o.metadata &&
      rate_limit == o.rate_limit &&
      secret == o.secret &&
      uid == o.uid &&
      url == o.url &&
      version == o.version
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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/svix/models/endpoint_in.rb', line 456

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


348
349
350
 
# File 'lib/svix/models/endpoint_in.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



354
355
356
 
# File 'lib/svix/models/endpoint_in.rb', line 354

def hash
  [channels, description, disabled, filter_types, metadata, rate_limit, secret, uid, url, version].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



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
215
216
 
# File 'lib/svix/models/endpoint_in.rb', line 162

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@channels.nil? && @channels.length > 10
    invalid_properties.push('invalid value for "channels", number of items must be less than or equal to 10.')
  end

  if !@channels.nil? && @channels.length < 1
    invalid_properties.push('invalid value for "channels", number of items must be greater than or equal to 1.')
  end

  if !@filter_types.nil? && @filter_types.length < 1
    invalid_properties.push('invalid value for "filter_types", number of items must be greater than or equal to 1.')
  end

  if !@rate_limit.nil? && @rate_limit < 1
    invalid_properties.push('invalid value for "rate_limit", must be greater than or equal to 1.')
  end

  pattern = Regexp.new(/^(whsec_)?[a-zA-Z0-9+\/=]{32,100}$/)
  if !@secret.nil? && @secret !~ pattern
    invalid_properties.push("invalid value for \"secret\", must conform to the pattern #{pattern}.")
  end

  if !@uid.nil? && @uid.to_s.length > 256
    invalid_properties.push('invalid value for "uid", the character length must be smaller than or equal to 256.')
  end

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

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if !@uid.nil? && @uid !~ pattern
    invalid_properties.push("invalid value for \"uid\", must conform to the pattern #{pattern}.")
  end

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

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

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

  if !@version.nil? && @version < 1
    invalid_properties.push('invalid value for "version", must be greater than or equal to 1.')
  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



432
433
434
 
# File 'lib/svix/models/endpoint_in.rb', line 432

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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/svix/models/endpoint_in.rb', line 438

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



426
427
428
 
# File 'lib/svix/models/endpoint_in.rb', line 426

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@channels.nil? && @channels.length > 10
  return false if !@channels.nil? && @channels.length < 1
  return false if !@filter_types.nil? && @filter_types.length < 1
  return false if !@rate_limit.nil? && @rate_limit < 1
  return false if !@secret.nil? && @secret !~ Regexp.new(/^(whsec_)?[a-zA-Z0-9+\/=]{32,100}$/)
  return false if !@uid.nil? && @uid.to_s.length > 256
  return false if !@uid.nil? && @uid.to_s.length < 1
  return false if !@uid.nil? && @uid !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  return false if @url.nil?
  return false if @url.to_s.length > 65536
  return false if @url.to_s.length < 1
  return false if !@version.nil? && @version < 1
  true
end