apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/asset_report_audit_copy_create_request.rb

@@ -0,0 +1,111 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportAuditCopyCreateRequest defines the request schema for
+  # `/asset_report/audit_copy/get`
+  class AssetReportAuditCopyCreateRequest < 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 `auditor_id` of the third party with whom you would like to share the
+    # Asset Report.
+    # @return [String]
+    attr_accessor :auditor_id
+
+    # 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['auditor_id'] = 'auditor_id'
+      @_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:, auditor_id:, 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
+      @auditor_id = auditor_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
+      auditor_id = hash.key?('auditor_id') ? hash['auditor_id'] : 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.
+      AssetReportAuditCopyCreateRequest.new(asset_report_token: asset_report_token,
+                                            auditor_id: auditor_id,
+                                            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}, auditor_id: #{@auditor_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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect},"\
+      " asset_report_token: #{@asset_report_token.inspect}, auditor_id: #{@auditor_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_audit_copy_create_response.rb

@@ -0,0 +1,87 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportAuditCopyCreateResponse defines the response schema for
+  # `/asset_report/audit_copy/get`
+  class AssetReportAuditCopyCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A token that can be shared with a third party auditor to allow them to
+    # obtain access to the Asset Report. This token should be stored securely.
+    # @return [String]
+    attr_accessor :audit_copy_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['audit_copy_token'] = 'audit_copy_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(audit_copy_token:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @audit_copy_token = audit_copy_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.
+      audit_copy_token =
+        hash.key?('audit_copy_token') ? hash['audit_copy_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.
+      AssetReportAuditCopyCreateResponse.new(audit_copy_token: audit_copy_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} audit_copy_token: #{@audit_copy_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} audit_copy_token: #{@audit_copy_token.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_audit_copy_get_request.rb

@@ -0,0 +1,101 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportAuditCopyGetRequest defines the request schema for
+  # `/asset_report/audit_copy/get`
+  class AssetReportAuditCopyGetRequest < 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 `audit_copy_token` granting access to the Audit Copy you would like to
+    # get.
+    # @return [String]
+    attr_accessor :audit_copy_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['audit_copy_token'] = 'audit_copy_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(audit_copy_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
+      @audit_copy_token = audit_copy_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.
+      audit_copy_token =
+        hash.key?('audit_copy_token') ? hash['audit_copy_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.
+      AssetReportAuditCopyGetRequest.new(audit_copy_token: audit_copy_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}, audit_copy_token:"\
+      " #{@audit_copy_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},"\
+      " audit_copy_token: #{@audit_copy_token.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_audit_copy_remove_request.rb

@@ -0,0 +1,101 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportAuditCopyRemoveRequest defines the request schema for
+  # `/asset_report/audit_copy/remove`
+  class AssetReportAuditCopyRemoveRequest < 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 `audit_copy_token` granting access to the Audit Copy you would like to
+    # revoke.
+    # @return [String]
+    attr_accessor :audit_copy_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['audit_copy_token'] = 'audit_copy_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(audit_copy_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
+      @audit_copy_token = audit_copy_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.
+      audit_copy_token =
+        hash.key?('audit_copy_token') ? hash['audit_copy_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.
+      AssetReportAuditCopyRemoveRequest.new(audit_copy_token: audit_copy_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}, audit_copy_token:"\
+      " #{@audit_copy_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},"\
+      " audit_copy_token: #{@audit_copy_token.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_audit_copy_remove_response.rb

@@ -0,0 +1,85 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportAuditCopyRemoveResponse defines the response schema for
+  # `/asset_report/audit_copy/remove`
+  class AssetReportAuditCopyRemoveResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `true` if the Audit Copy was successfully removed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :removed
+
+    # 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['removed'] = 'removed'
+      @_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(removed:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @removed = removed
+      @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.
+      removed = hash.key?('removed') ? hash['removed'] : 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.
+      AssetReportAuditCopyRemoveResponse.new(removed: removed,
+                                             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} removed: #{@removed}, 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} removed: #{@removed.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_create_request.rb

@@ -0,0 +1,125 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportCreateRequest defines the request schema for
+  # `/asset_report/create`
+  class AssetReportCreateRequest < 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
+
+    # An array of access tokens corresponding to the Items that will be included
+    # in the report. The `assets` product must have been initialized for the
+    # Items during link; the Assets product cannot be added after
+    # initialization.
+    # @return [Array[String]]
+    attr_accessor :access_tokens
+
+    # The maximum integer number of days of history to include in the Asset
+    # Report. If using Fannie Mae Day 1 Certainty, `days_requested` must be at
+    # least 61 for new originations or at least 31 for refinancings.
+    # @return [Integer]
+    attr_accessor :days_requested
+
+    # 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.
+    # @return [AssetReportCreateRequestOptions]
+    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_tokens'] = 'access_tokens'
+      @_hash['days_requested'] = 'days_requested'
+      @_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_tokens:, days_requested:, 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_tokens = access_tokens
+      @days_requested = days_requested
+      @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_tokens = hash.key?('access_tokens') ? hash['access_tokens'] : nil
+      days_requested =
+        hash.key?('days_requested') ? hash['days_requested'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      options = AssetReportCreateRequestOptions.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.
+      AssetReportCreateRequest.new(access_tokens: access_tokens,
+                                   days_requested: days_requested,
+                                   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_tokens:"\
+      " #{@access_tokens}, 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},"\
+      " access_tokens: #{@access_tokens.inspect}, days_requested: #{@days_requested.inspect},"\
+      " options: #{@options.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end