Class: Svix::EndpointCreatedEventData

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

Overview

Sent when an endpoint is created, updated, or deleted

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndpointCreatedEventData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 66

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

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

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

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

Instance Attribute Details

#app_id ⇒ Object

The app’s ID



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

def app_id
  @app_id
end

#app_uid ⇒ Object

The app’s UID



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

def app_uid
  @app_uid
end

#endpoint_id ⇒ Object

The ep’s ID



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

def endpoint_id
  @endpoint_id
end

#endpoint_uid ⇒ Object

The ep’s UID



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

def endpoint_uid
  @endpoint_uid
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 245

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



42
43
44
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 32

def self.attribute_map
  {
    :'app_id' => :'appId',
    :'app_uid' => :'appUid',
    :'endpoint_id' => :'endpointId',
    :'endpoint_uid' => :'endpointUid'
  }
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 221

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



57
58
59
60
61
62
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 57

def self.openapi_nullable
  Set.new([
    :'app_uid',
    :'endpoint_uid'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 47

def self.openapi_types
  {
    :'app_id' => :'String',
    :'app_uid' => :'String',
    :'endpoint_id' => :'String',
    :'endpoint_uid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 197

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_id == o.app_id &&
      app_uid == o.app_uid &&
      endpoint_id == o.endpoint_id &&
      endpoint_uid == o.endpoint_uid
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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 316

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


208
209
210
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 214

def hash
  [app_id, app_uid, endpoint_id, endpoint_uid].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @app_id.nil?
    invalid_properties.push('invalid value for "app_id", app_id cannot be nil.')
  end

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

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

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

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

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

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

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



292
293
294
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 292

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 298

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



286
287
288
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 286

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



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/svix/models/endpoint_created_event_data.rb', line 144

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @app_id.nil?
  return false if !@app_uid.nil? && @app_uid.to_s.length > 256
  return false if !@app_uid.nil? && @app_uid.to_s.length < 1
  return false if !@app_uid.nil? && @app_uid !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  return false if @endpoint_id.nil?
  return false if !@endpoint_uid.nil? && @endpoint_uid.to_s.length > 256
  return false if !@endpoint_uid.nil? && @endpoint_uid.to_s.length < 1
  return false if !@endpoint_uid.nil? && @endpoint_uid !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  true
end