Class: Svix::ClientSecretJwtParamsIn

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClientSecretJwtParamsIn

Initializes the object

Parameters:

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

    Model attributes in the form of hash



86
87
88
89
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
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 86

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

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

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

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

Instance Attribute Details

#secret_base64 ⇒ Object

The base64-encoded secret used for signing the JWT.



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

def secret_base64
  @secret_base64
end

#secret_id ⇒ Object

Optional secret identifier. If supplied, this will be populated in the JWT header in the ‘kid` field.



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

def secret_id
  @secret_id
end

#signing_algorithm ⇒ Object

Returns the value of attribute signing_algorithm.



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

def signing_algorithm
  @signing_algorithm
end

#token_expiry_secs ⇒ Object

Optional number of seconds after which the JWT should expire. Defaults to 300 seconds.



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

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 210

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



62
63
64
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'secret_base64' => :'secretBase64',
    :'secret_id' => :'secretId',
    :'signing_algorithm' => :'signingAlgorithm',
    :'token_expiry_secs' => :'tokenExpirySecs'
  }
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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 186

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



77
78
79
80
81
82
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 77

def self.openapi_nullable
  Set.new([
    :'secret_id',
    :'token_expiry_secs'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 67

def self.openapi_types
  {
    :'secret_base64' => :'String',
    :'secret_id' => :'String',
    :'signing_algorithm' => :'OauthJwsSigningAlgorithm',
    :'token_expiry_secs' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      secret_base64 == o.secret_base64 &&
      secret_id == o.secret_id &&
      signing_algorithm == o.signing_algorithm &&
      token_expiry_secs == o.token_expiry_secs
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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 281

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


173
174
175
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 179

def hash
  [secret_base64, secret_id, signing_algorithm, token_expiry_secs].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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 122

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

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

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



257
258
259
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 257

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 263

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



251
252
253
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 251

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



142
143
144
145
146
147
148
 
# File 'lib/svix/models/client_secret_jwt_params_in.rb', line 142

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @secret_base64.nil?
  return false if @signing_algorithm.nil?
  return false if !@token_expiry_secs.nil? && @token_expiry_secs < 0
  true
end