finch-api 0.1.0.pre.alpha.1

data/lib/finch-api/models/hris/w42020.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class W42020 < FinchAPI::BaseModel
+        # @!attribute [r] data
+        #   Detailed information specific to the 2020 W4 form.
+        #
+        #   @return [FinchAPI::Models::HRIS::W42020::Data, nil]
+        optional :data, -> { FinchAPI::Models::HRIS::W42020::Data }
+
+        # @!parse
+        #   # @return [FinchAPI::Models::HRIS::W42020::Data]
+        #   attr_writer :data
+
+        # @!attribute [r] type
+        #   Specifies the form type, indicating that this document is a 2020 W4 form.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::W42020::Type, nil]
+        optional :type, enum: -> { FinchAPI::Models::HRIS::W42020::Type }
+
+        # @!parse
+        #   # @return [Symbol, FinchAPI::Models::HRIS::W42020::Type]
+        #   attr_writer :type
+
+        # @!attribute year
+        #   The tax year this W4 document applies to.
+        #
+        #   @return [Float, nil]
+        optional :year, Float, nil?: true
+
+        # @!parse
+        #   # A 2020 version of the W-4 tax form containing information on an individual's
+        #   #   filing status, dependents, and withholding details.
+        #   #
+        #   # @param data [FinchAPI::Models::HRIS::W42020::Data]
+        #   # @param type [Symbol, FinchAPI::Models::HRIS::W42020::Type]
+        #   # @param year [Float, nil]
+        #   #
+        #   def initialize(data: nil, type: nil, year: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class Data < FinchAPI::BaseModel
+          # @!attribute amount_for_other_dependents
+          #   Amount claimed for dependents other than qualifying children under 17 (in
+          #     cents).
+          #
+          #   @return [Integer, nil]
+          optional :amount_for_other_dependents, Integer, nil?: true
+
+          # @!attribute amount_for_qualifying_children_under_17
+          #   Amount claimed for dependents under 17 years old (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :amount_for_qualifying_children_under_17, Integer, nil?: true
+
+          # @!attribute deductions
+          #   Deductible expenses (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :deductions, Integer, nil?: true
+
+          # @!attribute extra_withholding
+          #   Additional withholding amount (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :extra_withholding, Integer, nil?: true
+
+          # @!attribute filing_status
+          #   The individual's filing status for tax purposes.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus, nil]
+          optional :filing_status, enum: -> { FinchAPI::Models::HRIS::W42020::Data::FilingStatus }, nil?: true
+
+          # @!attribute [r] individual_id
+          #   The unique identifier for the individual associated with this document.
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :individual_id
+
+          # @!attribute other_income
+          #   Additional income from sources outside of primary employment (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :other_income, Integer, nil?: true
+
+          # @!attribute total_claim_dependent_and_other_credits
+          #   Total amount claimed for dependents and other credits (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :total_claim_dependent_and_other_credits, Integer, nil?: true
+
+          # @!parse
+          #   # Detailed information specific to the 2020 W4 form.
+          #   #
+          #   # @param amount_for_other_dependents [Integer, nil]
+          #   # @param amount_for_qualifying_children_under_17 [Integer, nil]
+          #   # @param deductions [Integer, nil]
+          #   # @param extra_withholding [Integer, nil]
+          #   # @param filing_status [Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus, nil]
+          #   # @param individual_id [String]
+          #   # @param other_income [Integer, nil]
+          #   # @param total_claim_dependent_and_other_credits [Integer, nil]
+          #   #
+          #   def initialize(
+          #     amount_for_other_dependents: nil,
+          #     amount_for_qualifying_children_under_17: nil,
+          #     deductions: nil,
+          #     extra_withholding: nil,
+          #     filing_status: nil,
+          #     individual_id: nil,
+          #     other_income: nil,
+          #     total_claim_dependent_and_other_credits: nil,
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # The individual's filing status for tax purposes.
+          #
+          # @example
+          # ```ruby
+          # case filing_status
+          # in :head_of_household
+          #   # ...
+          # in :married_filing_jointly_or_qualifying_surviving_spouse
+          #   # ...
+          # in :single_or_married_filing_separately
+          #   # ...
+          # end
+          # ```
+          class FilingStatus < FinchAPI::Enum
+            HEAD_OF_HOUSEHOLD = :head_of_household
+            MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = :married_filing_jointly_or_qualifying_surviving_spouse
+            SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+
+        # @abstract
+        #
+        # Specifies the form type, indicating that this document is a 2020 W4 form.
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :w4_2020
+        #   # ...
+        # end
+        # ```
+        class Type < FinchAPI::Enum
+          W4_2020 = :w4_2020
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/income.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Income < FinchAPI::BaseModel
+      # @!attribute amount
+      #   The income amount in cents.
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer, nil?: true
+
+      # @!attribute currency
+      #   The currency code.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute effective_date
+      #   The date the income amount went into effect.
+      #
+      #   @return [String, nil]
+      optional :effective_date, String, nil?: true
+
+      # @!attribute unit
+      #   The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
+      #     `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
+      #
+      #   @return [Symbol, FinchAPI::Models::Income::Unit, nil]
+      optional :unit, enum: -> { FinchAPI::Models::Income::Unit }, nil?: true
+
+      # @!parse
+      #   # The employee's income as reported by the provider. This may not always be
+      #   #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
+      #   #   depending on what information the provider returns.
+      #   #
+      #   # @param amount [Integer, nil]
+      #   # @param currency [String, nil]
+      #   # @param effective_date [String, nil]
+      #   # @param unit [Symbol, FinchAPI::Models::Income::Unit, nil]
+      #   #
+      #   def initialize(amount: nil, currency: nil, effective_date: nil, unit: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+      # @abstract
+      #
+      # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
+      #   `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
+      #
+      # @example
+      # ```ruby
+      # case unit
+      # in :yearly
+      #   # ...
+      # in :quarterly
+      #   # ...
+      # in :monthly
+      #   # ...
+      # in :semi_monthly
+      #   # ...
+      # in :bi_weekly
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class Unit < FinchAPI::Enum
+        YEARLY = :yearly
+        QUARTERLY = :quarterly
+        MONTHLY = :monthly
+        SEMI_MONTHLY = :semi_monthly
+        BI_WEEKLY = :bi_weekly
+        WEEKLY = :weekly
+        DAILY = :daily
+        HOURLY = :hourly
+        FIXED = :fixed
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/finch-api/models/individual_event.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class IndividualEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute [r] data
+      #
+      #   @return [FinchAPI::Models::IndividualEvent::Data, nil]
+      optional :data, -> { FinchAPI::Models::IndividualEvent::Data }
+
+      # @!parse
+      #   # @return [FinchAPI::Models::IndividualEvent::Data]
+      #   attr_writer :data
+
+      # @!attribute [r] event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::IndividualEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::IndividualEvent::EventType }
+
+      # @!parse
+      #   # @return [Symbol, FinchAPI::Models::IndividualEvent::EventType]
+      #   attr_writer :event_type
+
+      # @!parse
+      #   # @param data [FinchAPI::Models::IndividualEvent::Data]
+      #   # @param event_type [Symbol, FinchAPI::Models::IndividualEvent::EventType]
+      #   #
+      #   def initialize(data: nil, event_type: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+      class Data < FinchAPI::BaseModel
+        # @!attribute [r] individual_id
+        #   The ID of the individual related to the event.
+        #
+        #   @return [String, nil]
+        optional :individual_id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :individual_id
+
+        # @!parse
+        #   # @param individual_id [String]
+        #   #
+        #   def initialize(individual_id: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+
+      # @abstract
+      #
+      # @example
+      # ```ruby
+      # case event_type
+      # in :"individual.created"
+      #   # ...
+      # in :"individual.updated"
+      #   # ...
+      # in :"individual.deleted"
+      #   # ...
+      # end
+      # ```
+      class EventType < FinchAPI::Enum
+        INDIVIDUAL_CREATED = :"individual.created"
+        INDIVIDUAL_UPDATED = :"individual.updated"
+        INDIVIDUAL_DELETED = :"individual.deleted"
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/finch-api/models/introspection.rb

@@ -0,0 +1,342 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Introspection < FinchAPI::BaseModel
+      # @!attribute account_id
+      #   [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
+      #     instead of this account ID.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute authentication_methods
+      #
+      #   @return [Array<FinchAPI::Models::Introspection::AuthenticationMethod>]
+      required :authentication_methods,
+               -> { FinchAPI::ArrayOf[FinchAPI::Models::Introspection::AuthenticationMethod] }
+
+      # @!attribute client_id
+      #   The client ID of the application associated with the `access_token`.
+      #
+      #   @return [String]
+      required :client_id, String
+
+      # @!attribute client_type
+      #   The type of application associated with a token.
+      #
+      #   @return [Symbol, FinchAPI::Models::Introspection::ClientType]
+      required :client_type, enum: -> { FinchAPI::Models::Introspection::ClientType }
+
+      # @!attribute company_id
+      #   [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
+      #     instead of this company ID.
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute connection_id
+      #   The Finch UUID of the connection associated with the `access_token`.
+      #
+      #   @return [String]
+      required :connection_id, String
+
+      # @!attribute connection_status
+      #
+      #   @return [FinchAPI::Models::Introspection::ConnectionStatus]
+      required :connection_status, -> { FinchAPI::Models::Introspection::ConnectionStatus }
+
+      # @!attribute connection_type
+      #   The type of the connection associated with the token.
+      #
+      #     - `provider` - connection to an external provider
+      #     - `finch` - finch-generated data.
+      #
+      #   @return [Symbol, FinchAPI::Models::Introspection::ConnectionType]
+      required :connection_type, enum: -> { FinchAPI::Models::Introspection::ConnectionType }
+
+      # @!attribute customer_email
+      #   The email of your customer you provided to Finch when a connect session was
+      #     created for this connection.
+      #
+      #   @return [String, nil]
+      required :customer_email, String, nil?: true
+
+      # @!attribute customer_id
+      #   The ID of your customer you provided to Finch when a connect session was created
+      #     for this connection.
+      #
+      #   @return [String, nil]
+      required :customer_id, String, nil?: true
+
+      # @!attribute customer_name
+      #   The name of your customer you provided to Finch when a connect session was
+      #     created for this connection.
+      #
+      #   @return [String, nil]
+      required :customer_name, String, nil?: true
+
+      # @!attribute manual
+      #   Whether the connection associated with the `access_token` uses the Assisted
+      #     Connect Flow. (`true` if using Assisted Connect, `false` if connection is
+      #     automated)
+      #
+      #   @return [Boolean]
+      required :manual, FinchAPI::BooleanModel
+
+      # @!attribute payroll_provider_id
+      #   [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll
+      #     provider ID.
+      #
+      #   @return [String]
+      required :payroll_provider_id, String
+
+      # @!attribute products
+      #   An array of the authorized products associated with the `access_token`.
+      #
+      #   @return [Array<String>]
+      required :products, FinchAPI::ArrayOf[String]
+
+      # @!attribute provider_id
+      #   The ID of the provider associated with the `access_token`.
+      #
+      #   @return [String]
+      required :provider_id, String
+
+      # @!attribute username
+      #   The account username used for login associated with the `access_token`.
+      #
+      #   @return [String]
+      required :username, String
+
+      # @!parse
+      #   # @param account_id [String]
+      #   # @param authentication_methods [Array<FinchAPI::Models::Introspection::AuthenticationMethod>]
+      #   # @param client_id [String]
+      #   # @param client_type [Symbol, FinchAPI::Models::Introspection::ClientType]
+      #   # @param company_id [String]
+      #   # @param connection_id [String]
+      #   # @param connection_status [FinchAPI::Models::Introspection::ConnectionStatus]
+      #   # @param connection_type [Symbol, FinchAPI::Models::Introspection::ConnectionType]
+      #   # @param customer_email [String, nil]
+      #   # @param customer_id [String, nil]
+      #   # @param customer_name [String, nil]
+      #   # @param manual [Boolean]
+      #   # @param payroll_provider_id [String]
+      #   # @param products [Array<String>]
+      #   # @param provider_id [String]
+      #   # @param username [String]
+      #   #
+      #   def initialize(
+      #     account_id:,
+      #     authentication_methods:,
+      #     client_id:,
+      #     client_type:,
+      #     company_id:,
+      #     connection_id:,
+      #     connection_status:,
+      #     connection_type:,
+      #     customer_email:,
+      #     customer_id:,
+      #     customer_name:,
+      #     manual:,
+      #     payroll_provider_id:,
+      #     products:,
+      #     provider_id:,
+      #     username:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+      class AuthenticationMethod < FinchAPI::BaseModel
+        # @!attribute [r] connection_status
+        #
+        #   @return [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, nil]
+        optional :connection_status,
+                 -> { FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus }
+
+        # @!parse
+        #   # @return [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus]
+        #   attr_writer :connection_status
+
+        # @!attribute [r] products
+        #   An array of the authorized products associated with the `access_token`.
+        #
+        #   @return [Array<String>, nil]
+        optional :products, FinchAPI::ArrayOf[String]
+
+        # @!parse
+        #   # @return [Array<String>]
+        #   attr_writer :products
+
+        # @!attribute [r] type
+        #   The type of authentication method.
+        #
+        #   @return [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type, nil]
+        optional :type, enum: -> { FinchAPI::Models::Introspection::AuthenticationMethod::Type }
+
+        # @!parse
+        #   # @return [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type]
+        #   attr_writer :type
+
+        # @!parse
+        #   # @param connection_status [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus]
+        #   # @param products [Array<String>]
+        #   # @param type [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type]
+        #   #
+        #   def initialize(connection_status: nil, products: nil, type: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class ConnectionStatus < FinchAPI::BaseModel
+          # @!attribute [r] message
+          #
+          #   @return [String, nil]
+          optional :message, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :message
+
+          # @!attribute [r] status
+          #
+          #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
+          optional :status, enum: -> { FinchAPI::Models::ConnectionStatusType }
+
+          # @!parse
+          #   # @return [Symbol, FinchAPI::Models::ConnectionStatusType]
+          #   attr_writer :status
+
+          # @!parse
+          #   # @param message [String]
+          #   # @param status [Symbol, FinchAPI::Models::ConnectionStatusType]
+          #   #
+          #   def initialize(message: nil, status: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+
+        # @abstract
+        #
+        # The type of authentication method.
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :assisted
+        #   # ...
+        # in :credential
+        #   # ...
+        # in :api_token
+        #   # ...
+        # in :api_credential
+        #   # ...
+        # in :oauth
+        #   # ...
+        # end
+        # ```
+        class Type < FinchAPI::Enum
+          ASSISTED = :assisted
+          CREDENTIAL = :credential
+          API_TOKEN = :api_token
+          API_CREDENTIAL = :api_credential
+          OAUTH = :oauth
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+
+      # @abstract
+      #
+      # The type of application associated with a token.
+      #
+      # @example
+      # ```ruby
+      # case client_type
+      # in :production
+      #   # ...
+      # in :development
+      #   # ...
+      # in :sandbox
+      #   # ...
+      # end
+      # ```
+      class ClientType < FinchAPI::Enum
+        PRODUCTION = :production
+        DEVELOPMENT = :development
+        SANDBOX = :sandbox
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      class ConnectionStatus < FinchAPI::BaseModel
+        # @!attribute [r] message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :message
+
+        # @!attribute [r] status
+        #
+        #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
+        optional :status, enum: -> { FinchAPI::Models::ConnectionStatusType }
+
+        # @!parse
+        #   # @return [Symbol, FinchAPI::Models::ConnectionStatusType]
+        #   attr_writer :status
+
+        # @!parse
+        #   # @param message [String]
+        #   # @param status [Symbol, FinchAPI::Models::ConnectionStatusType]
+        #   #
+        #   def initialize(message: nil, status: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+
+      # @abstract
+      #
+      # The type of the connection associated with the token.
+      #
+      #   - `provider` - connection to an external provider
+      #   - `finch` - finch-generated data.
+      #
+      # @example
+      # ```ruby
+      # case connection_type
+      # in :provider
+      #   # ...
+      # in :finch
+      #   # ...
+      # end
+      # ```
+      class ConnectionType < FinchAPI::Enum
+        PROVIDER = :provider
+        FINCH = :finch
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end