apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/asset_report_item.rb

@@ -0,0 +1,130 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # A representation of an Item within an Asset Report.
+  class AssetReportItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # The full financial institution name associated with the Item.
+    # @return [String]
+    attr_accessor :institution_name
+
+    # The id of the financial institution associated with the Item.
+    # @return [String]
+    attr_accessor :institution_id
+
+    # The date and time when this Item’s data was last retrieved from the
+    # financial institution, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601)
+    # format.
+    # @return [DateTime]
+    attr_accessor :date_last_updated
+
+    # Data about each of the accounts open on the Item.
+    # @return [Array[AccountAssets]]
+    attr_accessor :accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_id'] = 'item_id'
+      @_hash['institution_name'] = 'institution_name'
+      @_hash['institution_id'] = 'institution_id'
+      @_hash['date_last_updated'] = 'date_last_updated'
+      @_hash['accounts'] = 'accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_id:, institution_name:, institution_id:,
+                   date_last_updated:, accounts:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @item_id = item_id
+      @institution_name = institution_name
+      @institution_id = institution_id
+      @date_last_updated = date_last_updated
+      @accounts = accounts
+      @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.
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      institution_name =
+        hash.key?('institution_name') ? hash['institution_name'] : nil
+      institution_id =
+        hash.key?('institution_id') ? hash['institution_id'] : nil
+      date_last_updated = if hash.key?('date_last_updated')
+                            (DateTimeHelper.from_rfc3339(hash['date_last_updated']) if hash['date_last_updated'])
+                          end
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (AccountAssets.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = nil unless hash.key?('accounts')
+
+      # 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.
+      AssetReportItem.new(item_id: item_id,
+                          institution_name: institution_name,
+                          institution_id: institution_id,
+                          date_last_updated: date_last_updated,
+                          accounts: accounts,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_date_last_updated
+      DateTimeHelper.to_rfc3339(date_last_updated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_id: #{@item_id}, institution_name: #{@institution_name},"\
+      " institution_id: #{@institution_id}, date_last_updated: #{@date_last_updated}, accounts:"\
+      " #{@accounts}, 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} item_id: #{@item_id.inspect}, institution_name:"\
+      " #{@institution_name.inspect}, institution_id: #{@institution_id.inspect},"\
+      " date_last_updated: #{@date_last_updated.inspect}, accounts: #{@accounts.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_pdf_get_request.rb

@@ -0,0 +1,101 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportPDFGetRequest defines the request schema for
+  # `/asset_report/pdf/get`
+  class AssetReportPdfGetRequest < 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
+
+    # A token that can be provided to endpoints such as `/asset_report/get` or
+    # `/asset_report/pdf/get` to fetch or update an Asset Report.
+    # @return [String]
+    attr_accessor :asset_report_token
+
+    # 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['asset_report_token'] = 'asset_report_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_report_token:, client_id: SKIP, secret: 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
+      @asset_report_token = asset_report_token
+      @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.
+      asset_report_token =
+        hash.key?('asset_report_token') ? hash['asset_report_token'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : 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.
+      AssetReportPdfGetRequest.new(asset_report_token: asset_report_token,
+                                   client_id: client_id,
+                                   secret: secret,
+                                   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}, asset_report_token:"\
+      " #{@asset_report_token}, 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},"\
+      " asset_report_token: #{@asset_report_token.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_refresh_request.rb

@@ -0,0 +1,127 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportRefreshRequest defines the request schema for
+  # `/asset_report/refresh`
+  class AssetReportRefreshRequest < 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 `asset_report_token` returned by the original call to
+    # `/asset_report/create`
+    # @return [String]
+    attr_accessor :asset_report_token
+
+    # The maximum number of days of history to include in the Asset Report. Must
+    # be an integer. If not specified, the value from the original call to
+    # `/asset_report/create` will be used.
+    # @return [Integer]
+    attr_accessor :days_requested
+
+    # An optional object to filter `/asset_report/refresh` results. If provided,
+    # cannot be `null`. If not specified, the `options` from the original call
+    # to `/asset_report/create` will be used.
+    # @return [AssetReportRefreshRequestOptions]
+    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['asset_report_token'] = 'asset_report_token'
+      @_hash['days_requested'] = 'days_requested'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        days_requested
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_report_token:, client_id: SKIP, secret: SKIP,
+                   days_requested: 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
+      @asset_report_token = asset_report_token
+      @days_requested = days_requested unless days_requested == SKIP
+      @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.
+      asset_report_token =
+        hash.key?('asset_report_token') ? hash['asset_report_token'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      days_requested =
+        hash.key?('days_requested') ? hash['days_requested'] : SKIP
+      options = AssetReportRefreshRequestOptions.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.
+      AssetReportRefreshRequest.new(asset_report_token: asset_report_token,
+                                    client_id: client_id,
+                                    secret: secret,
+                                    days_requested: days_requested,
+                                    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}, asset_report_token:"\
+      " #{@asset_report_token}, days_requested: #{@days_requested}, 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},"\
+      " asset_report_token: #{@asset_report_token.inspect}, days_requested:"\
+      " #{@days_requested.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_refresh_request_options.rb

@@ -0,0 +1,104 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to filter `/asset_report/refresh` results. If provided,
+  # cannot be `null`. If not specified, the `options` from the original call to
+  # `/asset_report/create` will be used.
+  class AssetReportRefreshRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Client-generated identifier, which can be used by lenders to track loan
+    # applications.
+    # @return [String]
+    attr_accessor :client_report_id
+
+    # URL to which Plaid will send Assets webhooks, for example when the
+    # requested Asset Report is ready.
+    # @return [String]
+    attr_accessor :webhook
+
+    # The user object allows you to provide additional information about the
+    # user to be appended to the Asset Report. All fields are optional. The
+    # `first_name`, `last_name`, and `ssn` fields are required if you would like
+    # the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
+    # @return [AssetReportUser]
+    attr_accessor :user
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_report_id'] = 'client_report_id'
+      @_hash['webhook'] = 'webhook'
+      @_hash['user'] = 'user'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_report_id
+        webhook
+        user
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_report_id: SKIP, webhook: SKIP, user: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_report_id = client_report_id unless client_report_id == SKIP
+      @webhook = webhook unless webhook == SKIP
+      @user = user unless user == 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.
+      client_report_id =
+        hash.key?('client_report_id') ? hash['client_report_id'] : SKIP
+      webhook = hash.key?('webhook') ? hash['webhook'] : SKIP
+      user = AssetReportUser.from_hash(hash['user']) if hash['user']
+
+      # 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.
+      AssetReportRefreshRequestOptions.new(client_report_id: client_report_id,
+                                           webhook: webhook,
+                                           user: user,
+                                           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_report_id: #{@client_report_id}, webhook: #{@webhook}, user:"\
+      " #{@user}, 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_report_id: #{@client_report_id.inspect}, webhook:"\
+      " #{@webhook.inspect}, user: #{@user.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_refresh_response.rb

@@ -0,0 +1,100 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportRefreshResponse defines the response schema for
+  # `/asset_report/refresh`
+  class AssetReportRefreshResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique ID identifying an Asset Report. Like all Plaid identifiers, this
+    # ID is case sensitive.
+    # @return [String]
+    attr_accessor :asset_report_id
+
+    # A token that can be provided to endpoints such as `/asset_report/get` or
+    # `/asset_report/pdf/get` to fetch or update an Asset Report.
+    # @return [String]
+    attr_accessor :asset_report_token
+
+    # 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['asset_report_id'] = 'asset_report_id'
+      @_hash['asset_report_token'] = 'asset_report_token'
+      @_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(asset_report_id:, asset_report_token:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_report_id = asset_report_id
+      @asset_report_token = asset_report_token
+      @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.
+      asset_report_id =
+        hash.key?('asset_report_id') ? hash['asset_report_id'] : nil
+      asset_report_token =
+        hash.key?('asset_report_token') ? hash['asset_report_token'] : nil
+      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.
+      AssetReportRefreshResponse.new(asset_report_id: asset_report_id,
+                                     asset_report_token: asset_report_token,
+                                     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} asset_report_id: #{@asset_report_id}, asset_report_token:"\
+      " #{@asset_report_token}, 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} asset_report_id: #{@asset_report_id.inspect}, asset_report_token:"\
+      " #{@asset_report_token.inspect}, request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_remove_request.rb

@@ -0,0 +1,101 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportRemoveRequest defines the request schema for
+  # `/asset_report/remove`
+  class AssetReportRemoveRequest < 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
+
+    # A token that can be provided to endpoints such as `/asset_report/get` or
+    # `/asset_report/pdf/get` to fetch or update an Asset Report.
+    # @return [String]
+    attr_accessor :asset_report_token
+
+    # 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['asset_report_token'] = 'asset_report_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_report_token:, client_id: SKIP, secret: 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
+      @asset_report_token = asset_report_token
+      @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.
+      asset_report_token =
+        hash.key?('asset_report_token') ? hash['asset_report_token'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : 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.
+      AssetReportRemoveRequest.new(asset_report_token: asset_report_token,
+                                   client_id: client_id,
+                                   secret: secret,
+                                   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}, asset_report_token:"\
+      " #{@asset_report_token}, 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},"\
+      " asset_report_token: #{@asset_report_token.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end