class Plaid::JWKPublicKey

A JSON Web Key (JWK) that can be used in conjunction with [JWT libraries](jwt.io/#libraries-io) to verify Plaid webhooks

Attributes

alg[RW]

The alg member identifies the cryptographic algorithm family used with the key.

created_at[RW]

The timestamp when the key was created, in Unix time.

crv[RW]

The crv member identifies the cryptographic curve used with the key.

expired_at[RW]

The timestamp when the key expired, in Unix time.

kid[RW]

The kid (Key ID) member can be used to match a specific key. This can be used, for instance, to choose among a set of keys within the JWK during key rollover.

kty[RW]

The kty (key type) parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC.

use[RW]

The use (public key use) parameter identifies the intended use of the public key.

x[RW]

The x member contains the x coordinate for the elliptic curve point, provided as a base64url-encoded string of the coordinate’s big endian representation.

y[RW]

The y member contains the y coordinate for the elliptic curve point, provided as a base64url-encoded string of the coordinate’s big endian representation.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/jwk_public_key.rb, line 62
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/plaid/models/jwk_public_key.rb, line 47
def self.attribute_map
  {
    :'alg' => :'alg',
    :'crv' => :'crv',
    :'kid' => :'kid',
    :'kty' => :'kty',
    :'use' => :'use',
    :'x' => :'x',
    :'y' => :'y',
    :'created_at' => :'created_at',
    :'expired_at' => :'expired_at'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/jwk_public_key.rb, line 224
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/plaid/models/jwk_public_key.rb, line 90
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::JWKPublicKey` 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 `Plaid::JWKPublicKey`. 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?(:'alg')
    self.alg = attributes[:'alg']
  end

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

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

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

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

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

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

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

  if attributes.key?(:'expired_at')
    self.expired_at = attributes[:'expired_at']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/jwk_public_key.rb, line 82
def self.openapi_nullable
  Set.new([
    :'expired_at'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/jwk_public_key.rb, line 67
def self.openapi_types
  {
    :'alg' => :'String',
    :'crv' => :'String',
    :'kid' => :'String',
    :'kty' => :'String',
    :'use' => :'String',
    :'x' => :'String',
    :'y' => :'String',
    :'created_at' => :'Integer',
    :'expired_at' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/plaid/models/jwk_public_key.rb, line 195
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alg == o.alg &&
      crv == o.crv &&
      kid == o.kid &&
      kty == o.kty &&
      use == o.use &&
      x == o.x &&
      y == o.y &&
      created_at == o.created_at &&
      expired_at == o.expired_at
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/plaid/models/jwk_public_key.rb, line 255
def _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 = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/plaid/models/jwk_public_key.rb, line 326
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/jwk_public_key.rb, line 231
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/plaid/models/jwk_public_key.rb, line 211
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/plaid/models/jwk_public_key.rb, line 217
def hash
  [alg, crv, kid, kty, use, x, y, created_at, expired_at].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/plaid/models/jwk_public_key.rb, line 142
def list_invalid_properties
  invalid_properties = Array.new
  if @alg.nil?
    invalid_properties.push('invalid value for "alg", alg cannot be nil.')
  end

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

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

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

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

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

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

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

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/jwk_public_key.rb, line 302
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/jwk_public_key.rb, line 308
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/plaid/models/jwk_public_key.rb, line 296
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/plaid/models/jwk_public_key.rb, line 181
def valid?
  return false if @alg.nil?
  return false if @crv.nil?
  return false if @kid.nil?
  return false if @kty.nil?
  return false if @use.nil?
  return false if @x.nil?
  return false if @y.nil?
  return false if @created_at.nil?
  true
end