finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.13

data/lib/finch_api/models/sandbox/payment_create_params.rb

@@ -0,0 +1,527 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      # @see FinchAPI::Resources::Sandbox::Payment#create
+      class PaymentCreateParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute end_date
+        #
+        #   @return [String, nil]
+        optional :end_date, String
+
+        # @!attribute pay_statements
+        #
+        #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>, nil]
+        optional :pay_statements,
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement] }
+
+        # @!attribute start_date
+        #
+        #   @return [String, nil]
+        optional :start_date, String
+
+        # @!method initialize(end_date: nil, pay_statements: nil, start_date: nil, request_options: {})
+        #   @param end_date [String]
+        #   @param pay_statements [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>]
+        #   @param start_date [String]
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        class PayStatement < FinchAPI::Internal::Type::BaseModel
+          # @!attribute earnings
+          #   The array of earnings objects associated with this pay statement
+          #
+          #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, nil>, nil]
+          optional :earnings,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, nil?: true] },
+                   nil?: true
+
+          # @!attribute employee_deductions
+          #   The array of deductions objects associated with this pay statement.
+          #
+          #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil>, nil]
+          optional :employee_deductions,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil?: true] },
+                   nil?: true
+
+          # @!attribute employer_contributions
+          #
+          #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil>, nil]
+          optional :employer_contributions,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil?: true] },
+                   nil?: true
+
+          # @!attribute gross_pay
+          #
+          #   @return [FinchAPI::Models::Money, nil]
+          optional :gross_pay, -> { FinchAPI::Models::Money }, nil?: true
+
+          # @!attribute individual_id
+          #   A stable Finch `id` (UUID v4) for an individual in the company
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!attribute net_pay
+          #
+          #   @return [FinchAPI::Models::Money, nil]
+          optional :net_pay, -> { FinchAPI::Models::Money }, nil?: true
+
+          # @!attribute payment_method
+          #   The payment method.
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil]
+          optional :payment_method,
+                   enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod },
+                   nil?: true
+
+          # @!attribute taxes
+          #   The array of taxes objects associated with this pay statement.
+          #
+          #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, nil>, nil]
+          optional :taxes,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, nil?: true] },
+                   nil?: true
+
+          # @!attribute total_hours
+          #   The number of hours worked for this pay period
+          #
+          #   @return [Float, nil]
+          optional :total_hours, Float, nil?: true
+
+          # @!attribute type
+          #   The type of the payment associated with the pay statement.
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil]
+          optional :type,
+                   enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type },
+                   nil?: true
+
+          # @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
+          #   @param earnings [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, nil>, nil] The array of earnings objects associated with this pay statement
+          #
+          #   @param employee_deductions [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil>, nil] The array of deductions objects associated with this pay statement.
+          #
+          #   @param employer_contributions [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil>, nil]
+          #
+          #   @param gross_pay [FinchAPI::Models::Money, nil]
+          #
+          #   @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company
+          #
+          #   @param net_pay [FinchAPI::Models::Money, nil]
+          #
+          #   @param payment_method [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil] The payment method.
+          #
+          #   @param taxes [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, nil>, nil] The array of taxes objects associated with this pay statement.
+          #
+          #   @param total_hours [Float, nil] The number of hours worked for this pay period
+          #
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil] The type of the payment associated with the pay statement.
+
+          class Earning < FinchAPI::Internal::Type::BaseModel
+            # @!attribute amount
+            #   The earnings amount in cents.
+            #
+            #   @return [Integer, nil]
+            optional :amount, Integer, nil?: true
+
+            # @!attribute attributes
+            #
+            #   @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil]
+            optional :attributes,
+                     -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes },
+                     nil?: true
+
+            # @!attribute currency
+            #   The earnings currency code.
+            #
+            #   @return [String, nil]
+            optional :currency, String, nil?: true
+
+            # @!attribute hours
+            #   The number of hours associated with this earning. (For salaried employees, this
+            #   could be hours per pay period, `0` or `null`, depending on the provider).
+            #
+            #   @return [Float, nil]
+            optional :hours, Float, nil?: true
+
+            # @!attribute name
+            #   The exact name of the deduction from the pay statement.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute type
+            #   The type of earning.
+            #
+            #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil]
+            optional :type,
+                     enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type },
+                     nil?: true
+
+            # @!method initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning} for more
+            #   details.
+            #
+            #   @param amount [Integer, nil] The earnings amount in cents.
+            #
+            #   @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil]
+            #
+            #   @param currency [String, nil] The earnings currency code.
+            #
+            #   @param hours [Float, nil] The number of hours associated with this earning. (For salaried employees, this
+            #   ...
+            #
+            #   @param name [String, nil] The exact name of the deduction from the pay statement.
+            #
+            #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil] The type of earning.
+
+            # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning#attributes
+            class Attributes < FinchAPI::Internal::Type::BaseModel
+              # @!attribute metadata
+              #
+              #   @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, nil]
+              optional :metadata,
+                       -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata }
+
+              # @!method initialize(metadata: nil)
+              #   @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata]
+
+              # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes#metadata
+              class Metadata < FinchAPI::Internal::Type::BaseModel
+                # @!attribute metadata
+                #   The metadata to be attached to the entity by existing rules. It is a key-value
+                #   pairs where the values can be of any type (string, number, boolean, object,
+                #   array, etc.).
+                #
+                #   @return [Hash{Symbol=>Object}, nil]
+                optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+                # @!method initialize(metadata: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata}
+                #   for more details.
+                #
+                #   @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p
+                #   ...
+              end
+            end
+
+            # The type of earning.
+            #
+            # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning#type
+            module Type
+              extend FinchAPI::Internal::Type::Enum
+
+              SALARY = :salary
+              WAGE = :wage
+              REIMBURSEMENT = :reimbursement
+              OVERTIME = :overtime
+              SEVERANCE = :severance
+              DOUBLE_OVERTIME = :double_overtime
+              PTO = :pto
+              SICK = :sick
+              BONUS = :bonus
+              COMMISSION = :commission
+              TIPS = :tips
+              TYPE_1099 = :"1099"
+              OTHER = :other
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
+            # @!attribute amount
+            #   The deduction amount in cents.
+            #
+            #   @return [Integer, nil]
+            optional :amount, Integer, nil?: true
+
+            # @!attribute attributes
+            #
+            #   @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil]
+            optional :attributes,
+                     -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes },
+                     nil?: true
+
+            # @!attribute currency
+            #   The deduction currency.
+            #
+            #   @return [String, nil]
+            optional :currency, String, nil?: true
+
+            # @!attribute name
+            #   The deduction name from the pay statement.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute pre_tax
+            #   Boolean indicating if the deduction is pre-tax.
+            #
+            #   @return [Boolean, nil]
+            optional :pre_tax, FinchAPI::Internal::Type::Boolean, nil?: true
+
+            # @!attribute type
+            #   Type of benefit.
+            #
+            #   @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
+            optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
+
+            # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
+            #   @param amount [Integer, nil] The deduction amount in cents.
+            #
+            #   @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil]
+            #
+            #   @param currency [String, nil] The deduction currency.
+            #
+            #   @param name [String, nil] The deduction name from the pay statement.
+            #
+            #   @param pre_tax [Boolean, nil] Boolean indicating if the deduction is pre-tax.
+            #
+            #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
+
+            # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction#attributes
+            class Attributes < FinchAPI::Internal::Type::BaseModel
+              # @!attribute metadata
+              #
+              #   @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, nil]
+              optional :metadata,
+                       -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata }
+
+              # @!method initialize(metadata: nil)
+              #   @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata]
+
+              # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes#metadata
+              class Metadata < FinchAPI::Internal::Type::BaseModel
+                # @!attribute metadata
+                #   The metadata to be attached to the entity by existing rules. It is a key-value
+                #   pairs where the values can be of any type (string, number, boolean, object,
+                #   array, etc.).
+                #
+                #   @return [Hash{Symbol=>Object}, nil]
+                optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+                # @!method initialize(metadata: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata}
+                #   for more details.
+                #
+                #   @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p
+                #   ...
+              end
+            end
+          end
+
+          class EmployerContribution < FinchAPI::Internal::Type::BaseModel
+            # @!attribute amount
+            #   The contribution amount in cents.
+            #
+            #   @return [Integer, nil]
+            optional :amount, Integer, nil?: true
+
+            # @!attribute attributes
+            #
+            #   @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil]
+            optional :attributes,
+                     -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes },
+                     nil?: true
+
+            # @!attribute currency
+            #   The contribution currency.
+            #
+            #   @return [String, nil]
+            optional :currency, String, nil?: true
+
+            # @!attribute name
+            #   The contribution name from the pay statement.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute type
+            #   Type of benefit.
+            #
+            #   @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
+            optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
+
+            # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil)
+            #   @param amount [Integer, nil] The contribution amount in cents.
+            #
+            #   @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil]
+            #
+            #   @param currency [String, nil] The contribution currency.
+            #
+            #   @param name [String, nil] The contribution name from the pay statement.
+            #
+            #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
+
+            # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution#attributes
+            class Attributes < FinchAPI::Internal::Type::BaseModel
+              # @!attribute metadata
+              #
+              #   @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, nil]
+              optional :metadata,
+                       -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata }
+
+              # @!method initialize(metadata: nil)
+              #   @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata]
+
+              # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes#metadata
+              class Metadata < FinchAPI::Internal::Type::BaseModel
+                # @!attribute metadata
+                #   The metadata to be attached to the entity by existing rules. It is a key-value
+                #   pairs where the values can be of any type (string, number, boolean, object,
+                #   array, etc.).
+                #
+                #   @return [Hash{Symbol=>Object}, nil]
+                optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+                # @!method initialize(metadata: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata}
+                #   for more details.
+                #
+                #   @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p
+                #   ...
+              end
+            end
+          end
+
+          # The payment method.
+          #
+          # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement#payment_method
+          module PaymentMethod
+            extend FinchAPI::Internal::Type::Enum
+
+            CHECK = :check
+            DIRECT_DEPOSIT = :direct_deposit
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          class Tax < FinchAPI::Internal::Type::BaseModel
+            # @!attribute amount
+            #   The tax amount in cents.
+            #
+            #   @return [Integer, nil]
+            optional :amount, Integer, nil?: true
+
+            # @!attribute attributes
+            #
+            #   @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil]
+            optional :attributes,
+                     -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes },
+                     nil?: true
+
+            # @!attribute currency
+            #   The currency code.
+            #
+            #   @return [String, nil]
+            optional :currency, String, nil?: true
+
+            # @!attribute employer
+            #   `true` if the amount is paid by the employers.
+            #
+            #   @return [Boolean, nil]
+            optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true
+
+            # @!attribute name
+            #   The exact name of tax from the pay statement.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute type
+            #   The type of taxes.
+            #
+            #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil]
+            optional :type,
+                     enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type },
+                     nil?: true
+
+            # @!method initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil)
+            #   @param amount [Integer, nil] The tax amount in cents.
+            #
+            #   @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil]
+            #
+            #   @param currency [String, nil] The currency code.
+            #
+            #   @param employer [Boolean, nil] `true` if the amount is paid by the employers.
+            #
+            #   @param name [String, nil] The exact name of tax from the pay statement.
+            #
+            #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil] The type of taxes.
+
+            # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax#attributes
+            class Attributes < FinchAPI::Internal::Type::BaseModel
+              # @!attribute metadata
+              #
+              #   @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, nil]
+              optional :metadata,
+                       -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata }
+
+              # @!method initialize(metadata: nil)
+              #   @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata]
+
+              # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes#metadata
+              class Metadata < FinchAPI::Internal::Type::BaseModel
+                # @!attribute metadata
+                #   The metadata to be attached to the entity by existing rules. It is a key-value
+                #   pairs where the values can be of any type (string, number, boolean, object,
+                #   array, etc.).
+                #
+                #   @return [Hash{Symbol=>Object}, nil]
+                optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+                # @!method initialize(metadata: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata}
+                #   for more details.
+                #
+                #   @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p
+                #   ...
+              end
+            end
+
+            # The type of taxes.
+            #
+            # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax#type
+            module Type
+              extend FinchAPI::Internal::Type::Enum
+
+              STATE = :state
+              FEDERAL = :federal
+              LOCAL = :local
+              FICA = :fica
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # The type of the payment associated with the pay statement.
+          #
+          # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            REGULAR_PAYROLL = :regular_payroll
+            OFF_CYCLE_PAYROLL = :off_cycle_payroll
+            ONE_TIME_PAYMENT = :one_time_payment
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/sandbox/payment_create_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      # @see FinchAPI::Resources::Sandbox::Payment#create
+      class PaymentCreateResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute pay_date
+        #   The date of the payment.
+        #
+        #   @return [String]
+        required :pay_date, String
+
+        # @!attribute payment_id
+        #   The ID of the payment.
+        #
+        #   @return [String]
+        required :payment_id, String
+
+        # @!method initialize(pay_date:, payment_id:)
+        #   @param pay_date [String] The date of the payment.
+        #
+        #   @param payment_id [String] The ID of the payment.
+      end
+    end
+  end
+end

data/lib/finch_api/models/webhook_event.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module WebhookEvent
+      extend FinchAPI::Internal::Type::Union
+
+      discriminator :event_type
+
+      variant :"account.updated", -> { FinchAPI::Models::AccountUpdateEvent }
+
+      variant :"company.updated", -> { FinchAPI::Models::CompanyEvent }
+
+      variant -> { FinchAPI::Models::JobCompletionEvent }
+
+      variant -> { FinchAPI::Models::DirectoryEvent }
+
+      variant -> { FinchAPI::Models::EmploymentEvent }
+
+      variant -> { FinchAPI::Models::IndividualEvent }
+
+      variant -> { FinchAPI::Models::PaymentEvent }
+
+      variant -> { FinchAPI::Models::PayStatementEvent }
+
+      # @!method self.variants
+      #   @return [Array(FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent)]
+    end
+  end
+end

data/lib/finch_api/request_options.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < FinchAPI::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in FinchAPI::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, FinchAPI::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+  end
+end