apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/assets_product_ready_webhook.rb

@@ -0,0 +1,97 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when the Asset Report has been generated and `/asset_report/get` is
+  # ready to be called.  If you attempt to retrieve an Asset Report before this
+  # webhook has fired, you’ll receive a response with the HTTP status code 400
+  # and a Plaid error code of `PRODUCT_NOT_READY`.
+  class AssetsProductReadyWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `ASSETS`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `PRODUCT_READY`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `asset_report_id` that can be provided to `/asset_report/get` to
+    # retrieve the Asset Report.
+    # @return [String]
+    attr_accessor :asset_report_id
+
+    # 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['asset_report_id'] = 'asset_report_id'
+      @_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:, asset_report_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @asset_report_id = asset_report_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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      asset_report_id =
+        hash.key?('asset_report_id') ? hash['asset_report_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.
+      AssetsProductReadyWebhook.new(webhook_type: webhook_type,
+                                    webhook_code: webhook_code,
+                                    asset_report_id: asset_report_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} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code},"\
+      " asset_report_id: #{@asset_report_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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, asset_report_id: #{@asset_report_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/auth_get_numbers.rb

@@ -0,0 +1,141 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object containing identifying numbers used for making electronic
+  # transfers to and from the `accounts`. The identifying number type (ACH, EFT,
+  # IBAN, or BACS) used will depend on the country of the account. An account
+  # may have more than one number type. If a particular identifying number type
+  # is not used by any `accounts` for which data has been requested, the array
+  # for that type will be empty.
+  class AuthGetNumbers < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of ACH numbers identifying accounts.
+    # @return [Array[NumbersAch]]
+    attr_accessor :ach
+
+    # An array of EFT numbers identifying accounts.
+    # @return [Array[NumbersEft]]
+    attr_accessor :eft
+
+    # An array of IBAN numbers identifying accounts.
+    # @return [Array[NumbersInternational]]
+    attr_accessor :international
+
+    # An array of BACS numbers identifying accounts.
+    # @return [Array[NumbersBacs]]
+    attr_accessor :bacs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ach'] = 'ach'
+      @_hash['eft'] = 'eft'
+      @_hash['international'] = 'international'
+      @_hash['bacs'] = 'bacs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ach:, eft:, international:, bacs:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ach = ach
+      @eft = eft
+      @international = international
+      @bacs = bacs
+      @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
+      ach = nil
+      unless hash['ach'].nil?
+        ach = []
+        hash['ach'].each do |structure|
+          ach << (NumbersAch.from_hash(structure) if structure)
+        end
+      end
+
+      ach = nil unless hash.key?('ach')
+      # Parameter is an array, so we need to iterate through it
+      eft = nil
+      unless hash['eft'].nil?
+        eft = []
+        hash['eft'].each do |structure|
+          eft << (NumbersEft.from_hash(structure) if structure)
+        end
+      end
+
+      eft = nil unless hash.key?('eft')
+      # Parameter is an array, so we need to iterate through it
+      international = nil
+      unless hash['international'].nil?
+        international = []
+        hash['international'].each do |structure|
+          international << (NumbersInternational.from_hash(structure) if structure)
+        end
+      end
+
+      international = nil unless hash.key?('international')
+      # Parameter is an array, so we need to iterate through it
+      bacs = nil
+      unless hash['bacs'].nil?
+        bacs = []
+        hash['bacs'].each do |structure|
+          bacs << (NumbersBacs.from_hash(structure) if structure)
+        end
+      end
+
+      bacs = nil unless hash.key?('bacs')
+
+      # 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.
+      AuthGetNumbers.new(ach: ach,
+                         eft: eft,
+                         international: international,
+                         bacs: bacs,
+                         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} ach: #{@ach}, eft: #{@eft}, international: #{@international}, bacs:"\
+      " #{@bacs}, 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} ach: #{@ach.inspect}, eft: #{@eft.inspect}, international:"\
+      " #{@international.inspect}, bacs: #{@bacs.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/auth_get_request.rb

@@ -0,0 +1,107 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AuthGetRequest defines the request schema for `/auth/get`
+  class AuthGetRequest < 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 `/auth/get` results.
+    # @return [AuthGetRequestOptions]
+    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 = AuthGetRequestOptions.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.
+      AuthGetRequest.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/auth_get_request_options.rb

@@ -0,0 +1,78 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to filter `/auth/get` results.
+  class AuthGetRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of `account_ids` to retrieve for the Item.
+    # Note: 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.
+      AuthGetRequestOptions.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/auth_get_response.rb

@@ -0,0 +1,116 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AuthGetResponse defines the response schema for `/auth/get`
+  class AuthGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The `accounts` for which numbers are being retrieved.
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # An object containing identifying numbers used for making electronic
+    # transfers to and from the `accounts`. The identifying number type (ACH,
+    # EFT, IBAN, or BACS) used will depend on the country of the account. An
+    # account may have more than one number type. If a particular identifying
+    # number type is not used by any `accounts` for which data has been
+    # requested, the array for that type will be empty.
+    # @return [AuthGetNumbers]
+    attr_accessor :numbers
+
+    # Metadata about the Item.
+    # @return [Item]
+    attr_accessor :item
+
+    # 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['numbers'] = 'numbers'
+      @_hash['item'] = 'item'
+      @_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:, numbers:, item:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @accounts = accounts
+      @numbers = numbers
+      @item = item
+      @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')
+      numbers = AuthGetNumbers.from_hash(hash['numbers']) if hash['numbers']
+      item = Item.from_hash(hash['item']) if hash['item']
+      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.
+      AuthGetResponse.new(accounts: accounts,
+                          numbers: numbers,
+                          item: item,
+                          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}, numbers: #{@numbers}, item: #{@item}, 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}, numbers: #{@numbers.inspect}, item:"\
+      " #{@item.inspect}, request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/auth_metadata.rb

@@ -0,0 +1,77 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Metadata that captures information about the Auth features of an
+  # institution.
+  class AuthMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Metadata specifically related to which auth methods an institution
+    # supports.
+    # @return [AuthSupportedMethods]
+    attr_accessor :supported_methods
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['supported_methods'] = 'supported_methods'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(supported_methods:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @supported_methods = supported_methods
+      @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.
+      supported_methods = AuthSupportedMethods.from_hash(hash['supported_methods']) if
+        hash['supported_methods']
+
+      # 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.
+      AuthMetadata.new(supported_methods: supported_methods,
+                       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} supported_methods: #{@supported_methods}, 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} supported_methods: #{@supported_methods.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end