Class: Svix::EndpointOauthConfigIn

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndpointOauthConfigIn

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 111

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_method ⇒ Object

Returns the value of attribute auth_method.



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

def auth_method
  @auth_method
end

#client_id ⇒ Object

The client ID. Required for all authentication types.



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

def client_id
  @client_id
end

#client_secret ⇒ Object

Optional client secret. This is only used for ‘clientSecretBasic` and `clientSecretPost`. For `clientSecretBasic`, the secret will be appended to the `Authorization` header. For `clientSecretPost`, this will be added to the body in a `client_secret` parameter.



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

def client_secret
  @client_secret
end

#extra_params ⇒ Object

Extra parameters added to the request body as key-value pairs.



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

def extra_params
  @extra_params
end

#grant_type ⇒ Object

Returns the value of attribute grant_type.



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

def grant_type
  @grant_type
end

#jwt_params ⇒ Object

Returns the value of attribute jwt_params.



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

def jwt_params
  @jwt_params
end

#refresh_token ⇒ Object

For ‘refreshToken` grant type



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

def refresh_token
  @refresh_token
end

#scopes ⇒ Object

Optional OAuth scopes added to the request body.



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

def scopes
  @scopes
end

#token_url ⇒ Object

The URL of the authorization server.



40
41
42
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 40

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 263

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



80
81
82
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'auth_method' => :'authMethod',
    :'client_id' => :'clientId',
    :'client_secret' => :'clientSecret',
    :'extra_params' => :'extraParams',
    :'grant_type' => :'grantType',
    :'jwt_params' => :'jwtParams',
    :'refresh_token' => :'refreshToken',
    :'scopes' => :'scopes',
    :'token_url' => :'tokenUrl'
  }
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 239

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



100
101
102
103
104
105
106
107
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 100

def self.openapi_nullable
  Set.new([
    :'client_secret',
    :'extra_params',
    :'refresh_token',
    :'scopes',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 85

def self.openapi_types
  {
    :'auth_method' => :'Oauth2AuthMethodIn',
    :'client_id' => :'String',
    :'client_secret' => :'String',
    :'extra_params' => :'Hash<String, String>',
    :'grant_type' => :'Oauth2GrantTypeIn',
    :'jwt_params' => :'ClientSecretJwtParamsIn',
    :'refresh_token' => :'String',
    :'scopes' => :'Array<String>',
    :'token_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_method == o.auth_method &&
      client_id == o.client_id &&
      client_secret == o.client_secret &&
      extra_params == o.extra_params &&
      grant_type == o.grant_type &&
      jwt_params == o.jwt_params &&
      refresh_token == o.refresh_token &&
      scopes == o.scopes &&
      token_url == o.token_url
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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 334

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


226
227
228
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 232

def hash
  [auth_method, client_id, client_secret, extra_params, grant_type, jwt_params, refresh_token, scopes, token_url].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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 175

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

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

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

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



310
311
312
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 310

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



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

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



304
305
306
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 304

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



199
200
201
202
203
204
205
206
 
# File 'lib/svix/models/endpoint_oauth_config_in.rb', line 199

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @auth_method.nil?
  return false if @client_id.nil?
  return false if @grant_type.nil?
  return false if @token_url.nil?
  true
end