apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/income_verification_documents_download_request.rb

@@ -0,0 +1,114 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationDocumentsDownloadRequest defines the request schema for
+  # `/income/verification/documents/download`.
+  class IncomeVerificationDocumentsDownloadRequest < 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.
+      IncomeVerificationDocumentsDownloadRequest.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_documents_download_response.rb

@@ -0,0 +1,73 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationDocumentsDownloadResponse defines the response schema for
+  # `/income/verification/documents/download`.
+  class IncomeVerificationDocumentsDownloadResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = 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.
+      id = hash.key?('id') ? hash['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.
+      IncomeVerificationDocumentsDownloadResponse.new(id: 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} id: #{@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} id: #{@id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_paystub_get_request.rb

@@ -0,0 +1,114 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationPaystubGetRequest defines the request schema for
+  # `/income/verification/paystub/get`.
+  class IncomeVerificationPaystubGetRequest < 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 for which to get paystub information.
+    # @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.
+      IncomeVerificationPaystubGetRequest.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_paystub_get_response.rb

@@ -0,0 +1,100 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationPaystubGetResponse defines the response schema for
+  # `/income/verification/paystub/get`.
+  class IncomeVerificationPaystubGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object representing data extracted from the end user's paystub.
+    # @return [Paystub]
+    attr_accessor :paystub
+
+    # 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['paystub'] = 'paystub'
+      @_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(paystub:, request_id:, error: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @paystub = paystub
+      @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.
+      paystub = Paystub.from_hash(hash['paystub']) if hash['paystub']
+      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.
+      IncomeVerificationPaystubGetResponse.new(paystub: paystub,
+                                               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} paystub: #{@paystub}, 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} paystub: #{@paystub.inspect}, error: #{@error.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_paystubs_get_request.rb

@@ -0,0 +1,114 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationPaystubsGetRequest defines the request schema for
+  # `/income/verification/paystubs/get`.
+  class IncomeVerificationPaystubsGetRequest < 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 for which to get paystub information.
+    # @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.
+      IncomeVerificationPaystubsGetRequest.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_paystubs_get_response.rb

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