apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/jwk_public_key.rb

@@ -0,0 +1,150 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A JSON Web Key (JWK) that can be used in conjunction with [JWT
+  # libraries](https://jwt.io/#libraries-io) to verify Plaid webhooks
+  class JwkPublicKey < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The alg member identifies the cryptographic algorithm family used with the
+    # key.
+    # @return [String]
+    attr_accessor :alg
+
+    # The crv member identifies the cryptographic curve used with the key.
+    # @return [String]
+    attr_accessor :crv
+
+    # 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.
+    # @return [String]
+    attr_accessor :kid
+
+    # The kty (key type) parameter identifies the cryptographic algorithm family
+    # used with the key, such as RSA or EC.
+    # @return [String]
+    attr_accessor :kty
+
+    # The use (public key use) parameter identifies the intended use of the
+    # public key.
+    # @return [String]
+    attr_accessor :use
+
+    # The x member contains the x coordinate for the elliptic curve point.
+    # @return [String]
+    attr_accessor :x
+
+    # The y member contains the y coordinate for the elliptic curve point.
+    # @return [String]
+    attr_accessor :y
+
+    # The timestamp when the key was created, in Unix time.
+    # @return [Integer]
+    attr_accessor :created_at
+
+    # The timestamp when the key expired, in Unix time.
+    # @return [Integer]
+    attr_accessor :expired_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['alg'] = 'alg'
+      @_hash['crv'] = 'crv'
+      @_hash['kid'] = 'kid'
+      @_hash['kty'] = 'kty'
+      @_hash['use'] = 'use'
+      @_hash['x'] = 'x'
+      @_hash['y'] = 'y'
+      @_hash['created_at'] = 'created_at'
+      @_hash['expired_at'] = 'expired_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        expired_at
+      ]
+    end
+
+    def initialize(alg:, crv:, kid:, kty:, use:, x:, y:, created_at:,
+                   expired_at:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @alg = alg
+      @crv = crv
+      @kid = kid
+      @kty = kty
+      @use = use
+      @x = x
+      @y = y
+      @created_at = created_at
+      @expired_at = expired_at
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      alg = hash.key?('alg') ? hash['alg'] : nil
+      crv = hash.key?('crv') ? hash['crv'] : nil
+      kid = hash.key?('kid') ? hash['kid'] : nil
+      kty = hash.key?('kty') ? hash['kty'] : nil
+      use = hash.key?('use') ? hash['use'] : nil
+      x = hash.key?('x') ? hash['x'] : nil
+      y = hash.key?('y') ? hash['y'] : nil
+      created_at = hash.key?('created_at') ? hash['created_at'] : nil
+      expired_at = hash.key?('expired_at') ? hash['expired_at'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      JwkPublicKey.new(alg: alg,
+                       crv: crv,
+                       kid: kid,
+                       kty: kty,
+                       use: use,
+                       x: x,
+                       y: y,
+                       created_at: created_at,
+                       expired_at: expired_at,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alg: #{@alg}, crv: #{@crv}, kid: #{@kid}, kty: #{@kty}, use: #{@use}, x:"\
+      " #{@x}, y: #{@y}, created_at: #{@created_at}, expired_at: #{@expired_at},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alg: #{@alg.inspect}, crv: #{@crv.inspect}, kid: #{@kid.inspect}, kty:"\
+      " #{@kty.inspect}, use: #{@use.inspect}, x: #{@x.inspect}, y: #{@y.inspect}, created_at:"\
+      " #{@created_at.inspect}, expired_at: #{@expired_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/jwt_header.rb

@@ -0,0 +1,72 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A JWT Header, used for webhook validation
+  class JwtHeader < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      JwtHeader.new(id: id,
+                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/liabilities_default_update_webhook.rb

@@ -0,0 +1,135 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The webhook of type `LIABILITIES` and code `DEFAULT_UPDATE` will be fired
+  # when new or updated liabilities have been detected on a liabilities item.
+  class LiabilitiesDefaultUpdateWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `LIABILITIES`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `DEFAULT_UPDATE`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # We use standard HTTP response codes for success and failure notifications,
+    # and our errors are further classified by `error_type`. In general, 200
+    # HTTP codes correspond to success, 40X codes are for developer- or
+    # user-related failures, and 50X codes are for Plaid-related issues.  Error
+    # fields will be `null` if no error has occurred.
+    # @return [Error]
+    attr_accessor :error
+
+    # An array of `account_id`'s for accounts that contain new liabilities.
+    # @return [Array[String]]
+    attr_accessor :account_ids_with_new_liabilities
+
+    # An object with keys of `account_id`'s that are mapped to their respective
+    # liabilities fields that changed.
+    # Example: `{ "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58": ["past_amount_due"]
+    # }`
+    # @return [Hash[String, Object]]
+    attr_accessor :account_ids_with_updated_liabilities
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_type'] = 'webhook_type'
+      @_hash['webhook_code'] = 'webhook_code'
+      @_hash['item_id'] = 'item_id'
+      @_hash['error'] = 'error'
+      @_hash['account_ids_with_new_liabilities'] =
+        'account_ids_with_new_liabilities'
+      @_hash['account_ids_with_updated_liabilities'] =
+        'account_ids_with_updated_liabilities'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, item_id:, error:,
+                   account_ids_with_new_liabilities:,
+                   account_ids_with_updated_liabilities:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @item_id = item_id
+      @error = error
+      @account_ids_with_new_liabilities = account_ids_with_new_liabilities
+      @account_ids_with_updated_liabilities = account_ids_with_updated_liabilities
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      error = Error.from_hash(hash['error']) if hash['error']
+      account_ids_with_new_liabilities =
+        hash.key?('account_ids_with_new_liabilities') ? hash['account_ids_with_new_liabilities'] : nil
+      account_ids_with_updated_liabilities =
+        hash.key?('account_ids_with_updated_liabilities') ? hash['account_ids_with_updated_liabilities'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LiabilitiesDefaultUpdateWebhook.new(webhook_type: webhook_type,
+                                          webhook_code: webhook_code,
+                                          item_id: item_id,
+                                          error: error,
+                                          account_ids_with_new_liabilities: account_ids_with_new_liabilities,
+                                          account_ids_with_updated_liabilities: account_ids_with_updated_liabilities,
+                                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, item_id:"\
+      " #{@item_id}, error: #{@error}, account_ids_with_new_liabilities:"\
+      " #{@account_ids_with_new_liabilities}, account_ids_with_updated_liabilities:"\
+      " #{@account_ids_with_updated_liabilities}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, item_id: #{@item_id.inspect}, error: #{@error.inspect},"\
+      " account_ids_with_new_liabilities: #{@account_ids_with_new_liabilities.inspect},"\
+      " account_ids_with_updated_liabilities: #{@account_ids_with_updated_liabilities.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/liabilities_get_request.rb

@@ -0,0 +1,108 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # LiabilitiesGetRequest defines the request schema for `/liabilities/get`
+  class LiabilitiesGetRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your Plaid API `client_id`. The `client_id` is required and may be
+    # provided either in the `PLAID-CLIENT-ID` header or as part of a request
+    # body.
+    # @return [String]
+    attr_accessor :client_id
+
+    # Your Plaid API `secret`. The `secret` is required and may be provided
+    # either in the `PLAID-SECRET` header or as part of a request body.
+    # @return [String]
+    attr_accessor :secret
+
+    # The access token associated with the Item data is being requested for.
+    # @return [String]
+    attr_accessor :access_token
+
+    # An optional object to filter `/liabilities/get` results. If provided,
+    # `options` cannot be null.
+    # @return [LiabilitiesGetRequestOptions]
+    attr_accessor :options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'client_id'
+      @_hash['secret'] = 'secret'
+      @_hash['access_token'] = 'access_token'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, client_id: SKIP, secret: SKIP, options: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_id = client_id unless client_id == SKIP
+      @secret = secret unless secret == SKIP
+      @access_token = access_token
+      @options = options unless options == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      options = LiabilitiesGetRequestOptions.from_hash(hash['options']) if hash['options']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LiabilitiesGetRequest.new(access_token: access_token,
+                                client_id: client_id,
+                                secret: secret,
+                                options: options,
+                                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id}, secret: #{@secret}, access_token:"\
+      " #{@access_token}, options: #{@options}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, access_token:"\
+      " #{@access_token.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/liabilities_get_request_options.rb

@@ -0,0 +1,79 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to filter `/liabilities/get` results. If provided,
+  # `options` cannot be null.
+  class LiabilitiesGetRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of accounts to retrieve for the Item.
+    # An error will be returned if a provided `account_id` is not associated
+    # with the Item
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_ids'] = 'account_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_ids: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_ids = account_ids unless account_ids == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_ids = hash.key?('account_ids') ? hash['account_ids'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LiabilitiesGetRequestOptions.new(account_ids: account_ids,
+                                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_ids: #{@account_ids}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_ids: #{@account_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/liabilities_get_response.rb

@@ -0,0 +1,111 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # LiabilitiesGetResponse defines the response schema for `/liabilities/get`
+  class LiabilitiesGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of accounts associated with the Item
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # Metadata about the Item.
+    # @return [Item]
+    attr_accessor :item
+
+    # An object containing liability accounts
+    # @return [LiabilitiesObject]
+    attr_accessor :liabilities
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accounts'] = 'accounts'
+      @_hash['item'] = 'item'
+      @_hash['liabilities'] = 'liabilities'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accounts:, item:, liabilities:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @accounts = accounts
+      @item = item
+      @liabilities = liabilities
+      @request_id = request_id
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (Account.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = nil unless hash.key?('accounts')
+      item = Item.from_hash(hash['item']) if hash['item']
+      liabilities = LiabilitiesObject.from_hash(hash['liabilities']) if hash['liabilities']
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LiabilitiesGetResponse.new(accounts: accounts,
+                                 item: item,
+                                 liabilities: liabilities,
+                                 request_id: request_id,
+                                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} accounts: #{@accounts}, item: #{@item}, liabilities: #{@liabilities},"\
+      " request_id: #{@request_id}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} accounts: #{@accounts.inspect}, item: #{@item.inspect}, liabilities:"\
+      " #{@liabilities.inspect}, request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end