apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/income_verification_precheck_employer.rb

@@ -0,0 +1,88 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationPrecheckEmployer Model.
+  class IncomeVerificationPrecheckEmployer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The employer's name
+    # @return [String]
+    attr_accessor :name
+
+    # The employer's tax id
+    # @return [String]
+    attr_accessor :tax_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['tax_id'] = 'tax_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        tax_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        name
+        tax_id
+      ]
+    end
+
+    def initialize(name: SKIP, tax_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @tax_id = tax_id unless tax_id == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      tax_id = hash.key?('tax_id') ? hash['tax_id'] : 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.
+      IncomeVerificationPrecheckEmployer.new(name: name,
+                                             tax_id: tax_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} name: #{@name}, tax_id: #{@tax_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} name: #{@name.inspect}, tax_id: #{@tax_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_precheck_military_info.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationPrecheckMilitaryInfo Model.
+  class IncomeVerificationPrecheckMilitaryInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Is the user currently active duty in the US military
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_active_duty
+
+    # If the user is currently serving in the US military, the branch of the
+    # military they are serving in
+    # @return [Branch]
+    attr_accessor :branch
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_active_duty'] = 'is_active_duty'
+      @_hash['branch'] = 'branch'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        is_active_duty
+        branch
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        is_active_duty
+      ]
+    end
+
+    def initialize(is_active_duty: SKIP, branch: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @is_active_duty = is_active_duty unless is_active_duty == SKIP
+      @branch = branch unless branch == 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.
+      is_active_duty =
+        hash.key?('is_active_duty') ? hash['is_active_duty'] : SKIP
+      branch = hash.key?('branch') ? hash['branch'] : 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.
+      IncomeVerificationPrecheckMilitaryInfo.new(is_active_duty: is_active_duty,
+                                                 branch: branch,
+                                                 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} is_active_duty: #{@is_active_duty}, branch: #{@branch},"\
+      " 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} is_active_duty: #{@is_active_duty.inspect}, branch: #{@branch.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_precheck_request.rb

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

data/lib/plaid/models/income_verification_precheck_response.rb

@@ -0,0 +1,101 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationPrecheckResponse defines the response schema for
+  # `/income/verification/precheck`.
+  class IncomeVerificationPrecheckResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the precheck.
+    # @return [String]
+    attr_accessor :precheck_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
+
+    # The confidence that Plaid can support the user in the income verification
+    # flow. One of the following:
+    # `"HIGH"`: This precheck information submitted is definitively tied to a
+    # Plaid-supported integration.
+    # "`LOW`": This precheck information submitted is known not to be supported
+    # by Plaid.
+    # `"UNKNOWN"`: It was not possible to determine if the user is supportable
+    # with the information passed.
+    # @return [Confidence]
+    attr_accessor :confidence
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['precheck_id'] = 'precheck_id'
+      @_hash['request_id'] = 'request_id'
+      @_hash['confidence'] = 'confidence'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(precheck_id:, request_id:, confidence:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @precheck_id = precheck_id
+      @request_id = request_id
+      @confidence = confidence
+      @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.
+      precheck_id = hash.key?('precheck_id') ? hash['precheck_id'] : nil
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+      confidence = hash.key?('confidence') ? hash['confidence'] : 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.
+      IncomeVerificationPrecheckResponse.new(precheck_id: precheck_id,
+                                             request_id: request_id,
+                                             confidence: confidence,
+                                             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} precheck_id: #{@precheck_id}, request_id: #{@request_id}, confidence:"\
+      " #{@confidence}, 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} precheck_id: #{@precheck_id.inspect}, request_id: #{@request_id.inspect},"\
+      " confidence: #{@confidence.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_precheck_user.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationPrecheckUser Model.
+  class IncomeVerificationPrecheckUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The user's first name
+    # @return [String]
+    attr_accessor :first_name
+
+    # The user's last name
+    # @return [String]
+    attr_accessor :last_name
+
+    # The user's email address
+    # @return [String]
+    attr_accessor :email_address
+
+    # Data about the components comprising an address.
+    # @return [AddressData1]
+    attr_accessor :home_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['email_address'] = 'email_address'
+      @_hash['home_address'] = 'home_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        email_address
+        home_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        first_name
+        last_name
+        email_address
+      ]
+    end
+
+    def initialize(first_name: SKIP, last_name: SKIP, email_address: SKIP,
+                   home_address: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @home_address = home_address unless home_address == 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.
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      home_address = AddressData1.from_hash(hash['home_address']) if hash['home_address']
+
+      # 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.
+      IncomeVerificationPrecheckUser.new(first_name: first_name,
+                                         last_name: last_name,
+                                         email_address: email_address,
+                                         home_address: home_address,
+                                         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} first_name: #{@first_name}, last_name: #{@last_name}, email_address:"\
+      " #{@email_address}, home_address: #{@home_address}, 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} first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
+      " email_address: #{@email_address.inspect}, home_address: #{@home_address.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_refresh_request.rb

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