apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/income_override.rb

@@ -0,0 +1,84 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specify payroll data on the account.
+  class IncomeOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of paystubs associated with the account.
+    # @return [Array[PaystubOverride]]
+    attr_accessor :paystubs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['paystubs'] = 'paystubs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        paystubs
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(paystubs: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @paystubs = paystubs unless paystubs == 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
+      paystubs = nil
+      unless hash['paystubs'].nil?
+        paystubs = []
+        hash['paystubs'].each do |structure|
+          paystubs << (PaystubOverride.from_hash(structure) if structure)
+        end
+      end
+
+      paystubs = SKIP unless hash.key?('paystubs')
+
+      # 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.
+      IncomeOverride.new(paystubs: paystubs,
+                         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}, 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}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_summary.rb

@@ -0,0 +1,137 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The verified fields from a paystub verification. All fields are provided as
+  # reported on the paystub.
+  class IncomeSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EmployerIncomeSummaryFieldString]
+    attr_accessor :employer_name
+
+    # TODO: Write general description for this method
+    # @return [EmployeeIncomeSummaryFieldString]
+    attr_accessor :employee_name
+
+    # TODO: Write general description for this method
+    # @return [YtdGrossIncomeSummaryFieldNumber]
+    attr_accessor :ytd_gross_income
+
+    # TODO: Write general description for this method
+    # @return [YtdNetIncomeSummaryFieldNumber]
+    attr_accessor :ytd_net_income
+
+    # TODO: Write general description for this method
+    # @return [PayFrequency]
+    attr_accessor :pay_frequency
+
+    # TODO: Write general description for this method
+    # @return [ProjectedIncomeSummaryFieldNumber]
+    attr_accessor :projected_wage
+
+    # Information about the matched direct deposit transaction used to verify a
+    # user's payroll information.
+    # @return [TransactionData]
+    attr_accessor :verified_transaction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['employer_name'] = 'employer_name'
+      @_hash['employee_name'] = 'employee_name'
+      @_hash['ytd_gross_income'] = 'ytd_gross_income'
+      @_hash['ytd_net_income'] = 'ytd_net_income'
+      @_hash['pay_frequency'] = 'pay_frequency'
+      @_hash['projected_wage'] = 'projected_wage'
+      @_hash['verified_transaction'] = 'verified_transaction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(employer_name:, employee_name:, ytd_gross_income:,
+                   ytd_net_income:, pay_frequency:, projected_wage:,
+                   verified_transaction:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @employer_name = employer_name
+      @employee_name = employee_name
+      @ytd_gross_income = ytd_gross_income
+      @ytd_net_income = ytd_net_income
+      @pay_frequency = pay_frequency
+      @projected_wage = projected_wage
+      @verified_transaction = verified_transaction
+      @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.
+      employer_name = EmployerIncomeSummaryFieldString.from_hash(hash['employer_name']) if
+        hash['employer_name']
+      employee_name = EmployeeIncomeSummaryFieldString.from_hash(hash['employee_name']) if
+        hash['employee_name']
+      ytd_gross_income = YtdGrossIncomeSummaryFieldNumber.from_hash(hash['ytd_gross_income']) if
+        hash['ytd_gross_income']
+      ytd_net_income = YtdNetIncomeSummaryFieldNumber.from_hash(hash['ytd_net_income']) if
+        hash['ytd_net_income']
+      pay_frequency = PayFrequency.from_hash(hash['pay_frequency']) if hash['pay_frequency']
+      projected_wage = ProjectedIncomeSummaryFieldNumber.from_hash(hash['projected_wage']) if
+        hash['projected_wage']
+      verified_transaction = TransactionData.from_hash(hash['verified_transaction']) if
+        hash['verified_transaction']
+
+      # 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.
+      IncomeSummary.new(employer_name: employer_name,
+                        employee_name: employee_name,
+                        ytd_gross_income: ytd_gross_income,
+                        ytd_net_income: ytd_net_income,
+                        pay_frequency: pay_frequency,
+                        projected_wage: projected_wage,
+                        verified_transaction: verified_transaction,
+                        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} employer_name: #{@employer_name}, employee_name: #{@employee_name},"\
+      " ytd_gross_income: #{@ytd_gross_income}, ytd_net_income: #{@ytd_net_income}, pay_frequency:"\
+      " #{@pay_frequency}, projected_wage: #{@projected_wage}, verified_transaction:"\
+      " #{@verified_transaction}, 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} employer_name: #{@employer_name.inspect}, employee_name:"\
+      " #{@employee_name.inspect}, ytd_gross_income: #{@ytd_gross_income.inspect}, ytd_net_income:"\
+      " #{@ytd_net_income.inspect}, pay_frequency: #{@pay_frequency.inspect}, projected_wage:"\
+      " #{@projected_wage.inspect}, verified_transaction: #{@verified_transaction.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_summary_field_number.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeSummaryFieldNumber Model.
+  class IncomeSummaryFieldNumber < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value of the field.
+    # @return [Float]
+    attr_accessor :value
+
+    # The verification status. One of the following:
+    # `"VERIFIED"`: The information was successfully verified.
+    # `"UNVERIFIED"`: The verification has not yet been performed.
+    # `"NEEDS_INFO"`: The verification was attempted but could not be completed
+    # due to missing information.
+    # "`UNABLE_TO_VERIFY`": The verification was performed and the information
+    # could not be verified.
+    # `"UNKNOWN"`: The verification status is unknown.
+    # @return [VerificationStatus]
+    attr_accessor :verification_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_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(value:, verification_status:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @value = value
+      @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.
+      value = hash.key?('value') ? hash['value'] : 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.
+      IncomeSummaryFieldNumber.new(value: value,
+                                   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} value: #{@value}, 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} value: #{@value.inspect}, verification_status:"\
+      " #{@verification_status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_summary_field_string.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeSummaryFieldString Model.
+  class IncomeSummaryFieldString < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value of the field.
+    # @return [String]
+    attr_accessor :value
+
+    # The verification status. One of the following:
+    # `"VERIFIED"`: The information was successfully verified.
+    # `"UNVERIFIED"`: The verification has not yet been performed.
+    # `"NEEDS_INFO"`: The verification was attempted but could not be completed
+    # due to missing information.
+    # "`UNABLE_TO_VERIFY`": The verification was performed and the information
+    # could not be verified.
+    # `"UNKNOWN"`: The verification status is unknown.
+    # @return [VerificationStatus]
+    attr_accessor :verification_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_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(value:, verification_status:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @value = value
+      @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.
+      value = hash.key?('value') ? hash['value'] : 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.
+      IncomeSummaryFieldString.new(value: value,
+                                   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} value: #{@value}, 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} value: #{@value.inspect}, verification_status:"\
+      " #{@verification_status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_create_request.rb

@@ -0,0 +1,99 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationCreateRequest defines the request schema for
+  # `/income/verification/create`
+  class IncomeVerificationCreateRequest < 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 URL endpoint to which Plaid should send webhooks related to the
+    # progress of the income verification process.
+    # @return [String]
+    attr_accessor :webhook
+
+    # 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['webhook'] = 'webhook'
+      @_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(webhook:, 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
+      @webhook = webhook
+      @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 = hash.key?('webhook') ? hash['webhook'] : 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.
+      IncomeVerificationCreateRequest.new(webhook: webhook,
+                                          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}, webhook: #{@webhook},"\
+      " 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}, webhook:"\
+      " #{@webhook.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_verification_create_response.rb

@@ -0,0 +1,88 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IncomeVerificationCreateResponse defines the response schema for
+  # `/income/verification/create`.
+  class IncomeVerificationCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the verification. This ID is persisted throughout the lifetime of
+    # the verification.
+    # @return [String]
+    attr_accessor :income_verification_id
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['income_verification_id'] = 'income_verification_id'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(income_verification_id:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @income_verification_id = income_verification_id
+      @request_id = request_id
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      income_verification_id =
+        hash.key?('income_verification_id') ? hash['income_verification_id'] : nil
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      IncomeVerificationCreateResponse.new(income_verification_id: income_verification_id,
+                                           request_id: request_id,
+                                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} income_verification_id: #{@income_verification_id}, request_id:"\
+      " #{@request_id}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} income_verification_id: #{@income_verification_id.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end