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

data/lib/finch_api.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "finch_api/version"
+require_relative "finch_api/internal/util"
+require_relative "finch_api/internal/type/converter"
+require_relative "finch_api/internal/type/unknown"
+require_relative "finch_api/internal/type/boolean"
+require_relative "finch_api/internal/type/file_input"
+require_relative "finch_api/internal/type/enum"
+require_relative "finch_api/internal/type/union"
+require_relative "finch_api/internal/type/array_of"
+require_relative "finch_api/internal/type/hash_of"
+require_relative "finch_api/internal/type/base_model"
+require_relative "finch_api/internal/type/base_page"
+require_relative "finch_api/internal/type/request_parameters"
+require_relative "finch_api/internal"
+require_relative "finch_api/request_options"
+require_relative "finch_api/file_part"
+require_relative "finch_api/errors"
+require_relative "finch_api/internal/transport/base_client"
+require_relative "finch_api/internal/transport/pooled_net_requester"
+require_relative "finch_api/client"
+require_relative "finch_api/internal/individuals_page"
+require_relative "finch_api/internal/page"
+require_relative "finch_api/internal/responses_page"
+require_relative "finch_api/internal/single_page"
+require_relative "finch_api/models/base_webhook_event"
+require_relative "finch_api/models/hris/benefit_contribution"
+require_relative "finch_api/models/sandbox/jobs/sandbox_job_configuration"
+require_relative "finch_api/models/access_token_create_params"
+require_relative "finch_api/models/account_disconnect_params"
+require_relative "finch_api/models/account_introspect_params"
+require_relative "finch_api/models/account_update_event"
+require_relative "finch_api/models/company_event"
+require_relative "finch_api/models/connect/session_new_params"
+require_relative "finch_api/models/connect/session_new_response"
+require_relative "finch_api/models/connect/session_reauthenticate_params"
+require_relative "finch_api/models/connect/session_reauthenticate_response"
+require_relative "finch_api/models/connection_status_type"
+require_relative "finch_api/models/create_access_token_response"
+require_relative "finch_api/models/directory_event"
+require_relative "finch_api/models/disconnect_response"
+require_relative "finch_api/models/employment_event"
+require_relative "finch_api/models/hris/benefit_create_params"
+require_relative "finch_api/models/hris/benefit_features_and_operations"
+require_relative "finch_api/models/hris/benefit_frequency"
+require_relative "finch_api/models/hris/benefit_list_params"
+require_relative "finch_api/models/hris/benefit_list_supported_benefits_params"
+require_relative "finch_api/models/hris/benefit_list_supported_benefits_response"
+require_relative "finch_api/models/hris/benefit_retrieve_params"
+require_relative "finch_api/models/hris/benefits/enrolled_individual_benefit_response"
+require_relative "finch_api/models/hris/benefits/individual_benefit"
+require_relative "finch_api/models/hris/benefits/individual_enrolled_ids_params"
+require_relative "finch_api/models/hris/benefits/individual_enrolled_ids_response"
+require_relative "finch_api/models/hris/benefits/individual_enroll_many_params"
+require_relative "finch_api/models/hris/benefits/individual_retrieve_many_benefits_params"
+require_relative "finch_api/models/hris/benefits/individual_unenroll_many_params"
+require_relative "finch_api/models/hris/benefits/unenrolled_individual_benefit_response"
+require_relative "finch_api/models/hris/benefits_support"
+require_relative "finch_api/models/hris/benefit_type"
+require_relative "finch_api/models/hris/benefit_update_params"
+require_relative "finch_api/models/hris/benfit_contribution"
+require_relative "finch_api/models/hris/company/pay_statement_item/rule_create_params"
+require_relative "finch_api/models/hris/company/pay_statement_item/rule_create_response"
+require_relative "finch_api/models/hris/company/pay_statement_item/rule_delete_params"
+require_relative "finch_api/models/hris/company/pay_statement_item/rule_delete_response"
+require_relative "finch_api/models/hris/company/pay_statement_item/rule_list_params"
+require_relative "finch_api/models/hris/company/pay_statement_item/rule_list_response"
+require_relative "finch_api/models/hris/company/pay_statement_item/rule_update_params"
+require_relative "finch_api/models/hris/company/pay_statement_item/rule_update_response"
+require_relative "finch_api/models/hris/company/pay_statement_item_list_params"
+require_relative "finch_api/models/hris/company/pay_statement_item_list_response"
+require_relative "finch_api/models/hris/company_benefit"
+require_relative "finch_api/models/hris/company_retrieve_params"
+require_relative "finch_api/models/hris/create_company_benefits_response"
+require_relative "finch_api/models/hris/directory_list_individuals_params"
+require_relative "finch_api/models/hris/directory_list_params"
+require_relative "finch_api/models/hris/document_list_params"
+require_relative "finch_api/models/hris/document_list_response"
+require_relative "finch_api/models/hris/document_response"
+require_relative "finch_api/models/hris/document_retreive_params"
+require_relative "finch_api/models/hris/document_retreive_response"
+require_relative "finch_api/models/hris/employment_data"
+require_relative "finch_api/models/hris/employment_data_response"
+require_relative "finch_api/models/hris/employment_retrieve_many_params"
+require_relative "finch_api/models/hris/company"
+require_relative "finch_api/models/hris/individual"
+require_relative "finch_api/models/hris/individual_in_directory"
+require_relative "finch_api/models/hris/individual_response"
+require_relative "finch_api/models/hris/individual_retrieve_many_params"
+require_relative "finch_api/models/hris/payment"
+require_relative "finch_api/models/hris/payment_list_params"
+require_relative "finch_api/models/hris/pay_statement"
+require_relative "finch_api/models/hris/pay_statement_response"
+require_relative "finch_api/models/hris/pay_statement_response_body"
+require_relative "finch_api/models/hris/pay_statement_retrieve_many_params"
+require_relative "finch_api/models/hris/supported_benefit"
+require_relative "finch_api/models/hris/support_per_benefit_type"
+require_relative "finch_api/models/hris/update_company_benefit_response"
+require_relative "finch_api/models/hris/w42005"
+require_relative "finch_api/models/hris/w42020"
+require_relative "finch_api/models/income"
+require_relative "finch_api/models/individual_event"
+require_relative "finch_api/models/introspection"
+require_relative "finch_api/models/job_completion_event"
+require_relative "finch_api/models/jobs/automated_async_job"
+require_relative "finch_api/models/jobs/automated_create_params"
+require_relative "finch_api/models/jobs/automated_create_response"
+require_relative "finch_api/models/jobs/automated_list_params"
+require_relative "finch_api/models/jobs/automated_list_response"
+require_relative "finch_api/models/jobs/automated_retrieve_params"
+require_relative "finch_api/models/jobs/manual_async_job"
+require_relative "finch_api/models/jobs/manual_retrieve_params"
+require_relative "finch_api/models/location"
+require_relative "finch_api/models/money"
+require_relative "finch_api/models/operation_support"
+require_relative "finch_api/models/operation_support_matrix"
+require_relative "finch_api/models/paging"
+require_relative "finch_api/models/payment_event"
+require_relative "finch_api/models/payroll/pay_group_list_params"
+require_relative "finch_api/models/payroll/pay_group_list_response"
+require_relative "finch_api/models/payroll/pay_group_retrieve_params"
+require_relative "finch_api/models/payroll/pay_group_retrieve_response"
+require_relative "finch_api/models/pay_statement_event"
+require_relative "finch_api/models/provider"
+require_relative "finch_api/models/provider_list_params"
+require_relative "finch_api/models/request_forwarding_forward_params"
+require_relative "finch_api/models/request_forwarding_forward_response"
+require_relative "finch_api/models/sandbox/company_update_params"
+require_relative "finch_api/models/sandbox/company_update_response"
+require_relative "finch_api/models/sandbox/connection_create_params"
+require_relative "finch_api/models/sandbox/connection_create_response"
+require_relative "finch_api/models/sandbox/connections/account_create_params"
+require_relative "finch_api/models/sandbox/connections/account_create_response"
+require_relative "finch_api/models/sandbox/connections/account_update_params"
+require_relative "finch_api/models/sandbox/connections/account_update_response"
+require_relative "finch_api/models/sandbox/directory_create_params"
+require_relative "finch_api/models/sandbox/directory_create_response"
+require_relative "finch_api/models/sandbox/employment_update_params"
+require_relative "finch_api/models/sandbox/employment_update_response"
+require_relative "finch_api/models/sandbox/individual_update_params"
+require_relative "finch_api/models/sandbox/individual_update_response"
+require_relative "finch_api/models/sandbox/job_create_params"
+require_relative "finch_api/models/sandbox/job_create_response"
+require_relative "finch_api/models/sandbox/jobs/configuration_retrieve_params"
+require_relative "finch_api/models/sandbox/jobs/configuration_retrieve_response"
+require_relative "finch_api/models/sandbox/jobs/configuration_update_params"
+require_relative "finch_api/models/sandbox/payment_create_params"
+require_relative "finch_api/models/sandbox/payment_create_response"
+require_relative "finch_api/models/webhook_event"
+require_relative "finch_api/models"
+require_relative "finch_api/resources/access_tokens"
+require_relative "finch_api/resources/account"
+require_relative "finch_api/resources/connect"
+require_relative "finch_api/resources/connect/sessions"
+require_relative "finch_api/resources/hris"
+require_relative "finch_api/resources/hris/benefits"
+require_relative "finch_api/resources/hris/benefits/individuals"
+require_relative "finch_api/resources/hris/company"
+require_relative "finch_api/resources/hris/company/pay_statement_item"
+require_relative "finch_api/resources/hris/company/pay_statement_item/rules"
+require_relative "finch_api/resources/hris/directory"
+require_relative "finch_api/resources/hris/documents"
+require_relative "finch_api/resources/hris/employments"
+require_relative "finch_api/resources/hris/individuals"
+require_relative "finch_api/resources/hris/payments"
+require_relative "finch_api/resources/hris/pay_statements"
+require_relative "finch_api/resources/jobs"
+require_relative "finch_api/resources/jobs/automated"
+require_relative "finch_api/resources/jobs/manual"
+require_relative "finch_api/resources/payroll"
+require_relative "finch_api/resources/payroll/pay_groups"
+require_relative "finch_api/resources/providers"
+require_relative "finch_api/resources/request_forwarding"
+require_relative "finch_api/resources/sandbox"
+require_relative "finch_api/resources/sandbox/company"
+require_relative "finch_api/resources/sandbox/connections"
+require_relative "finch_api/resources/sandbox/connections/accounts"
+require_relative "finch_api/resources/sandbox/directory"
+require_relative "finch_api/resources/sandbox/employment"
+require_relative "finch_api/resources/sandbox/individual"
+require_relative "finch_api/resources/sandbox/jobs"
+require_relative "finch_api/resources/sandbox/jobs/configuration"
+require_relative "finch_api/resources/sandbox/payment"
+require_relative "finch_api/resources/webhooks"

data/manifest.yaml

@@ -1,4 +1,5 @@
 dependencies:
+  - English
   - cgi
   - date
   - erb

data/rbi/finch_api/client.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module FinchAPI
+  class Client < FinchAPI::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :access_token
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :client_id
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :client_secret
+
+    sig { returns(FinchAPI::Resources::AccessTokens) }
+    attr_reader :access_tokens
+
+    sig { returns(FinchAPI::Resources::HRIS) }
+    attr_reader :hris
+
+    sig { returns(FinchAPI::Resources::Providers) }
+    attr_reader :providers
+
+    sig { returns(FinchAPI::Resources::Account) }
+    attr_reader :account
+
+    sig { returns(FinchAPI::Resources::Webhooks) }
+    attr_reader :webhooks
+
+    sig { returns(FinchAPI::Resources::RequestForwarding) }
+    attr_reader :request_forwarding
+
+    sig { returns(FinchAPI::Resources::Jobs) }
+    attr_reader :jobs
+
+    sig { returns(FinchAPI::Resources::Sandbox) }
+    attr_reader :sandbox
+
+    sig { returns(FinchAPI::Resources::Payroll) }
+    attr_reader :payroll
+
+    sig { returns(FinchAPI::Resources::Connect) }
+    attr_reader :connect
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # @api private
+    sig { returns(T::Hash[String, String]) }
+    private def bearer_auth
+    end
+
+    # @api private
+    sig { returns(T::Hash[String, String]) }
+    private def basic_auth
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        client_id: T.nilable(String),
+        client_secret: T.nilable(String),
+        access_token: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["FINCH_CLIENT_ID"]`
+      client_id: ENV["FINCH_CLIENT_ID"],
+      # Defaults to `ENV["FINCH_CLIENT_SECRET"]`
+      client_secret: ENV["FINCH_CLIENT_SECRET"],
+      access_token: nil,
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["FINCH_BASE_URL"]`
+      base_url: ENV["FINCH_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: FinchAPI::Client::DEFAULT_MAX_RETRIES,
+      timeout: FinchAPI::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: FinchAPI::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: FinchAPI::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/finch_api/errors.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module FinchAPI
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < FinchAPI::Errors::Error
+    end
+
+    class APIError < FinchAPI::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < FinchAPI::Errors::APIError
+      sig { void }
+      attr_accessor :status
+
+      sig { void }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < FinchAPI::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < FinchAPI::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
+      end
+    end
+
+    class BadRequestError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/finch_api/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module FinchAPI
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(String),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end

data/rbi/finch_api/internal/individuals_page.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module FinchAPI
+  module Internal
+    class IndividualsPage
+      include FinchAPI::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :individuals
+
+      sig { returns(FinchAPI::Paging) }
+      attr_accessor :paging
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+    end
+  end
+end

data/rbi/finch_api/internal/page.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module FinchAPI
+  module Internal
+    class Page
+      include FinchAPI::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :data
+
+      sig { returns(FinchAPI::Paging) }
+      attr_accessor :paging
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+    end
+  end
+end

data/rbi/finch_api/internal/responses_page.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module FinchAPI
+  module Internal
+    class ResponsesPage
+      include FinchAPI::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :responses
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+    end
+  end
+end

data/rbi/finch_api/internal/single_page.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module FinchAPI
+  module Internal
+    class SinglePage < ::Array
+      include FinchAPI::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { override.returns(T::Boolean) }
+      def next_page?
+      end
+
+      sig { override.returns(T.self_type) }
+      def next_page
+      end
+
+      sig { override.params(blk: T.proc.params(arg0: Elem).void).void }
+      def auto_paging_each(&blk)
+      end
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+    end
+  end
+end