Class: Svix::EndpointPatch

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndpointPatch

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
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
# File 'lib/svix/models/endpoint_patch.rb', line 90

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

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

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

Instance Attribute Details

#channelsObject

Returns the value of attribute channels.



18
19
20
# File 'lib/svix/models/endpoint_patch.rb', line 18

def channels
  @channels
end

#descriptionObject

Returns the value of attribute description.



20
21
22
# File 'lib/svix/models/endpoint_patch.rb', line 20

def description
  @description
end

#disabledObject

Returns the value of attribute disabled.



22
23
24
# File 'lib/svix/models/endpoint_patch.rb', line 22

def disabled
  @disabled
end

#filter_typesObject

Returns the value of attribute filter_types.



24
25
26
# File 'lib/svix/models/endpoint_patch.rb', line 24

def filter_types
  @filter_types
end

#metadataObject

Returns the value of attribute metadata.



26
27
28
# File 'lib/svix/models/endpoint_patch.rb', line 26

def 
  @metadata
end

#rate_limitObject

Returns the value of attribute rate_limit.



28
29
30
# File 'lib/svix/models/endpoint_patch.rb', line 28

def rate_limit
  @rate_limit
end

#secretObject

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.



31
32
33
# File 'lib/svix/models/endpoint_patch.rb', line 31

def secret
  @secret
end

#uidObject

The ep’s UID



34
35
36
# File 'lib/svix/models/endpoint_patch.rb', line 34

def uid
  @uid
end

#urlObject

Returns the value of attribute url.



36
37
38
# File 'lib/svix/models/endpoint_patch.rb', line 36

def url
  @url
end

#versionObject

Returns the value of attribute version.



38
39
40
# File 'lib/svix/models/endpoint_patch.rb', line 38

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



319
320
321
322
323
324
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
# File 'lib/svix/models/endpoint_patch.rb', line 319

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_attributesObject

Returns all the JSON keys this model knows about



57
58
59
# File 'lib/svix/models/endpoint_patch.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/svix/models/endpoint_patch.rb', line 295

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_nullableObject

List of attributes with nullable: true



78
79
80
81
82
83
84
85
86
# File 'lib/svix/models/endpoint_patch.rb', line 78

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

.openapi_typesObject

Attribute type mapping.



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

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/svix/models/endpoint_patch.rb', line 265

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 &&
       == o. &&
      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



390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/svix/models/endpoint_patch.rb', line 390

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


282
283
284
# File 'lib/svix/models/endpoint_patch.rb', line 282

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



288
289
290
# File 'lib/svix/models/endpoint_patch.rb', line 288

def hash
  [channels, description, disabled, filter_types, , rate_limit, secret, uid, url, version].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/svix/models/endpoint_patch.rb', line 152

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@rate_limit.nil? && @rate_limit < 0
    invalid_properties.push('invalid value for "rate_limit", must be greater than or equal to 0.')
  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 !@version.nil? && @version < 1
    invalid_properties.push('invalid value for "version", must be greater than or equal to 1.')
  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



366
367
368
# File 'lib/svix/models/endpoint_patch.rb', line 366

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



372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/svix/models/endpoint_patch.rb', line 372

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



360
361
362
# File 'lib/svix/models/endpoint_patch.rb', line 360

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



186
187
188
189
190
191
192
193
194
195
# File 'lib/svix/models/endpoint_patch.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@rate_limit.nil? && @rate_limit < 0
  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 !@version.nil? && @version < 1
  true
end