apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/income_verification_refresh_response.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationRequestResponse defines the response schema for
+  # `/income/verification/refresh`
+  class IncomeVerificationRefreshResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # The verification refresh status. One of the following:
+    # `"VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED"` User presence is
+    # required to refresh an income verification.
+    # @return [String]
+    attr_accessor :verification_refresh_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'request_id'
+      @_hash['verification_refresh_status'] = 'verification_refresh_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id:, verification_refresh_status:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @request_id = request_id
+      @verification_refresh_status = verification_refresh_status
+      @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.
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+      verification_refresh_status =
+        hash.key?('verification_refresh_status') ? hash['verification_refresh_status'] : 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.
+      IncomeVerificationRefreshResponse.new(request_id: request_id,
+                                            verification_refresh_status: verification_refresh_status,
+                                            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} request_id: #{@request_id}, verification_refresh_status:"\
+      " #{@verification_refresh_status}, 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} request_id: #{@request_id.inspect}, verification_refresh_status:"\
+      " #{@verification_refresh_status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_status_webhook.rb

@@ -0,0 +1,117 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when the status of an income verification instance has changed. It
+  # will typically take several minutes for this webhook to fire after the end
+  # user has uploaded their documents in the Document Income flow.
+  class IncomeVerificationStatusWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `"INCOME"`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `income_verification`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `income_verification_id` of the verification instance whose status is
+    # being reported.
+    # @return [String]
+    attr_accessor :income_verification_id
+
+    # `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status
+    # processing has completed.
+    # `VERIFICATION_STATUS_UPLOAD_ERROR`: An upload error occurred when the end
+    # user attempted to upload their verification documentation.
+    # `VERIFICATION_STATUS_INVALID_TYPE`: The end user attempted to upload
+    # verification documentation in an unsupported file format.
+    # `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The documentation uploaded by the
+    # end user was recognized as a supported file format, but not recognized as
+    # a valid paystub.
+    # `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when
+    # attempting to process the verification documentation.
+    # @return [String]
+    attr_accessor :verification_status
+
+    # 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['income_verification_id'] = 'income_verification_id'
+      @_hash['verification_status'] = 'verification_status'
+      @_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:, income_verification_id:,
+                   verification_status:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @income_verification_id = income_verification_id
+      @verification_status = verification_status
+      @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
+      income_verification_id =
+        hash.key?('income_verification_id') ? hash['income_verification_id'] : nil
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : 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.
+      IncomeVerificationStatusWebhook.new(webhook_type: webhook_type,
+                                          webhook_code: webhook_code,
+                                          income_verification_id: income_verification_id,
+                                          verification_status: verification_status,
+                                          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},"\
+      " income_verification_id: #{@income_verification_id}, verification_status:"\
+      " #{@verification_status}, 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}, income_verification_id: #{@income_verification_id.inspect},"\
+      " verification_status: #{@verification_status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_summary_get_request.rb

@@ -0,0 +1,114 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationSummaryGetRequest defines the request schema for
+  # `/income/verification/summary/get`.
+  class IncomeVerificationSummaryGetRequest < 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 ID of the verification.
+    # @return [String]
+    attr_accessor :income_verification_id
+
+    # The access token associated with the Item data is being requested for.
+    # @return [String]
+    attr_accessor :access_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['income_verification_id'] = 'income_verification_id'
+      @_hash['access_token'] = 'access_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        income_verification_id
+        access_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        income_verification_id
+        access_token
+      ]
+    end
+
+    def initialize(client_id: SKIP, secret: SKIP, income_verification_id: SKIP,
+                   access_token: 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
+      @income_verification_id = income_verification_id unless income_verification_id == SKIP
+      @access_token = access_token unless access_token == 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_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      income_verification_id =
+        hash.key?('income_verification_id') ? hash['income_verification_id'] : SKIP
+      access_token = hash.key?('access_token') ? hash['access_token'] : 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.
+      IncomeVerificationSummaryGetRequest.new(client_id: client_id,
+                                              secret: secret,
+                                              income_verification_id: income_verification_id,
+                                              access_token: access_token,
+                                              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}, income_verification_id:"\
+      " #{@income_verification_id}, access_token: #{@access_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},"\
+      " income_verification_id: #{@income_verification_id.inspect}, access_token:"\
+      " #{@access_token.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_summary_get_response.rb

@@ -0,0 +1,109 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationSummaryGetResponse defines the response schema for
+  # `/income/verification/summary/get`.
+  class IncomeVerificationSummaryGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of income summaries.
+    # @return [Array[IncomeSummary]]
+    attr_accessor :income_summaries
+
+    # 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
+
+    # 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['income_summaries'] = 'income_summaries'
+      @_hash['error'] = 'error'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(income_summaries:, request_id:, error: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @income_summaries = income_summaries
+      @error = error unless error == SKIP
+      @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
+      income_summaries = nil
+      unless hash['income_summaries'].nil?
+        income_summaries = []
+        hash['income_summaries'].each do |structure|
+          income_summaries << (IncomeSummary.from_hash(structure) if structure)
+        end
+      end
+
+      income_summaries = nil unless hash.key?('income_summaries')
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+      error = Error.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      IncomeVerificationSummaryGetResponse.new(income_summaries: income_summaries,
+                                               request_id: request_id,
+                                               error: error,
+                                               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} income_summaries: #{@income_summaries}, error: #{@error}, 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} income_summaries: #{@income_summaries.inspect}, error: #{@error.inspect},"\
+      " request_id: #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_taxforms_get_request.rb

@@ -0,0 +1,114 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationTaxformsGetRequest defines the request schema for
+  # `/income/verification/taxforms/get`
+  class IncomeVerificationTaxformsGetRequest < 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 ID of the verification.
+    # @return [String]
+    attr_accessor :income_verification_id
+
+    # The access token associated with the Item data is being requested for.
+    # @return [String]
+    attr_accessor :access_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['income_verification_id'] = 'income_verification_id'
+      @_hash['access_token'] = 'access_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        income_verification_id
+        access_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        income_verification_id
+        access_token
+      ]
+    end
+
+    def initialize(client_id: SKIP, secret: SKIP, income_verification_id: SKIP,
+                   access_token: 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
+      @income_verification_id = income_verification_id unless income_verification_id == SKIP
+      @access_token = access_token unless access_token == 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_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      income_verification_id =
+        hash.key?('income_verification_id') ? hash['income_verification_id'] : SKIP
+      access_token = hash.key?('access_token') ? hash['access_token'] : 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.
+      IncomeVerificationTaxformsGetRequest.new(client_id: client_id,
+                                               secret: secret,
+                                               income_verification_id: income_verification_id,
+                                               access_token: access_token,
+                                               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}, income_verification_id:"\
+      " #{@income_verification_id}, access_token: #{@access_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},"\
+      " income_verification_id: #{@income_verification_id.inspect}, access_token:"\
+      " #{@access_token.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_taxforms_get_response.rb

@@ -0,0 +1,129 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationTaxformsGetResponse defines the response schema for
+  # `/income/verification/taxforms/get`
+  class IncomeVerificationTaxformsGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 list of taxforms.
+    # @return [Array[Taxform]]
+    attr_accessor :taxforms
+
+    # A list of taxforms.
+    # @return [Array[DocumentMetadata]]
+    attr_accessor :document_metadata
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'request_id'
+      @_hash['taxforms'] = 'taxforms'
+      @_hash['document_metadata'] = 'document_metadata'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(taxforms:, document_metadata:, request_id: SKIP, error: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @request_id = request_id unless request_id == SKIP
+      @taxforms = taxforms
+      @document_metadata = document_metadata
+      @error = error unless error == 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.
+      # Parameter is an array, so we need to iterate through it
+      taxforms = nil
+      unless hash['taxforms'].nil?
+        taxforms = []
+        hash['taxforms'].each do |structure|
+          taxforms << (Taxform.from_hash(structure) if structure)
+        end
+      end
+
+      taxforms = nil unless hash.key?('taxforms')
+      # Parameter is an array, so we need to iterate through it
+      document_metadata = nil
+      unless hash['document_metadata'].nil?
+        document_metadata = []
+        hash['document_metadata'].each do |structure|
+          document_metadata << (DocumentMetadata.from_hash(structure) if structure)
+        end
+      end
+
+      document_metadata = nil unless hash.key?('document_metadata')
+      request_id = hash.key?('request_id') ? hash['request_id'] : SKIP
+      error = Error.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      IncomeVerificationTaxformsGetResponse.new(taxforms: taxforms,
+                                                document_metadata: document_metadata,
+                                                request_id: request_id,
+                                                error: error,
+                                                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} request_id: #{@request_id}, taxforms: #{@taxforms}, document_metadata:"\
+      " #{@document_metadata}, error: #{@error}, 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} request_id: #{@request_id.inspect}, taxforms: #{@taxforms.inspect},"\
+      " document_metadata: #{@document_metadata.inspect}, error: #{@error.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end