Class: Svix::EventTypeImportOpenApiIn

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

Overview

Import a list of event types from webhooks defined in an OpenAPI spec. The OpenAPI spec can be specified as either ‘spec` given the spec as a JSON object, or as `specRaw` (a `string`) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a `400` **Bad Request**.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EventTypeImportOpenApiIn

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 61

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

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

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

Instance Attribute Details

#dry_run ⇒ Object

If ‘true`, return the event types that would be modified without actually modifying them.



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

def dry_run
  @dry_run
end

#spec ⇒ Object

A pre-parsed JSON spec.



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

def spec
  @spec
end

#spec_raw ⇒ Object

A string, parsed by the server as YAML or JSON.



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

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 29

def self.attribute_map
  {
    :'dry_run' => :'dry_run',
    :'spec' => :'spec',
    :'spec_raw' => :'specRaw'
  }
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 131

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



52
53
54
55
56
57
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 52

def self.openapi_nullable
  Set.new([
    :'spec',
    :'spec_raw'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 43

def self.openapi_types
  {
    :'dry_run' => :'Boolean',
    :'spec' => :'Hash<String, Object>',
    :'spec_raw' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



108
109
110
111
112
113
114
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 108

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      dry_run == o.dry_run &&
      spec == o.spec &&
      spec_raw == o.spec_raw
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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 226

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


118
119
120
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 118

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



124
125
126
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 124

def hash
  [dry_run, spec, spec_raw].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



93
94
95
96
97
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 93

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



202
203
204
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 202

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



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 208

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



196
197
198
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 196

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



101
102
103
104
 
# File 'lib/svix/models/event_type_import_open_api_in.rb', line 101

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end