apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/asset_report_create_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/create` results. If provided,
+  # must be non-`null`. The optional `user` object is required for the report to
+  # be eligible for Fannie Mae's Day 1 Certainty program.
+  class AssetReportCreateRequestOptions < 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.
+      AssetReportCreateRequestOptions.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_create_response.rb

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

data/lib/plaid/models/asset_report_filter_request.rb

@@ -0,0 +1,111 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportFilterRequest defines the request schema for
+  # `/asset_report/filter`
+  class AssetReportFilterRequest < 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
+
+    # The accounts to exclude from the Asset Report, identified by `account_id`.
+    # @return [Array[String]]
+    attr_accessor :account_ids_to_exclude
+
+    # 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['account_ids_to_exclude'] = 'account_ids_to_exclude'
+      @_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:, account_ids_to_exclude:,
+                   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
+      @account_ids_to_exclude = account_ids_to_exclude
+      @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
+      account_ids_to_exclude =
+        hash.key?('account_ids_to_exclude') ? hash['account_ids_to_exclude'] : 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.
+      AssetReportFilterRequest.new(asset_report_token: asset_report_token,
+                                   account_ids_to_exclude: account_ids_to_exclude,
+                                   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}, account_ids_to_exclude: #{@account_ids_to_exclude},"\
+      " 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}, account_ids_to_exclude:"\
+      " #{@account_ids_to_exclude.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_filter_response.rb

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

data/lib/plaid/models/asset_report_get_request.rb

@@ -0,0 +1,112 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportGetRequest defines the request schema for `/asset_report/get`
+  class AssetReportGetRequest < 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
+
+    # `true` if you would like to retrieve the Asset Report with Insights,
+    # `false` otherwise. This field defaults to `false` if omitted.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_insights
+
+    # 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['include_insights'] = 'include_insights'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        include_insights
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_report_token:, client_id: SKIP, secret: SKIP,
+                   include_insights: 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
+      @include_insights = include_insights unless include_insights == 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
+      include_insights =
+        hash.key?('include_insights') ? hash['include_insights'] : 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.
+      AssetReportGetRequest.new(asset_report_token: asset_report_token,
+                                client_id: client_id,
+                                secret: secret,
+                                include_insights: include_insights,
+                                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}, include_insights: #{@include_insights}, 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}, include_insights:"\
+      " #{@include_insights.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_get_response.rb

@@ -0,0 +1,103 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportGetResponse defines the response schema for `/asset_report/get`
+  class AssetReportGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object representing an Asset Report
+    # @return [AssetReport]
+    attr_accessor :report
+
+    # If the Asset Report generation was successful but identity information
+    # cannot be returned, this array will contain information about the errors
+    # causing identity information to be missing
+    # @return [Array[Warning]]
+    attr_accessor :warnings
+
+    # 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['report'] = 'report'
+      @_hash['warnings'] = 'warnings'
+      @_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(report:, warnings:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @report = report
+      @warnings = warnings
+      @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.
+      report = AssetReport.from_hash(hash['report']) if hash['report']
+      # Parameter is an array, so we need to iterate through it
+      warnings = nil
+      unless hash['warnings'].nil?
+        warnings = []
+        hash['warnings'].each do |structure|
+          warnings << (Warning.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = nil unless hash.key?('warnings')
+      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.
+      AssetReportGetResponse.new(report: report,
+                                 warnings: warnings,
+                                 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} report: #{@report}, warnings: #{@warnings}, 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} report: #{@report.inspect}, warnings: #{@warnings.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end