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

data/rbi/finch_api/resources/sandbox/connections.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Connections
+        sig { returns(FinchAPI::Resources::Sandbox::Connections::Accounts) }
+        attr_reader :accounts
+
+        # Create a new connection (new company/provider pair) with a new account
+        sig do
+          params(
+            provider_id: String,
+            authentication_type:
+              FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol,
+            employee_size: Integer,
+            products: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse)
+        end
+        def create(
+          # The provider associated with the connection
+          provider_id:,
+          authentication_type: nil,
+          # Optional: the size of the employer to be created with this connection. Defaults
+          # to 20. Note that if this is higher than 100, historical payroll data will not be
+          # generated, and instead only one pay period will be created.
+          employee_size: nil,
+          products: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/sandbox/directory.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Directory
+        # Add new individuals to a sandbox company
+        sig do
+          params(
+            body:
+              T::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::OrHash],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T::Array[T.anything])
+        end
+        def create(
+          # Array of individuals to create. Takes all combined fields from `/individual` and
+          # `/employment` endpoints. All fields are optional.
+          body: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/sandbox/employment.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Employment
+        # Update sandbox employment
+        sig do
+          params(
+            individual_id: String,
+            class_code: T.nilable(String),
+            custom_fields:
+              T::Array[
+                FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
+              ],
+            department:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash
+              ),
+            employment:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::OrHash
+              ),
+            employment_status:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol
+              ),
+            end_date: T.nilable(String),
+            first_name: T.nilable(String),
+            income: T.nilable(FinchAPI::Income::OrHash),
+            income_history:
+              T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
+            is_active: T.nilable(T::Boolean),
+            last_name: T.nilable(String),
+            latest_rehire_date: T.nilable(String),
+            location: T.nilable(FinchAPI::Location::OrHash),
+            manager:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash
+              ),
+            middle_name: T.nilable(String),
+            source_id: String,
+            start_date: T.nilable(String),
+            title: T.nilable(String),
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(FinchAPI::Models::Sandbox::EmploymentUpdateResponse)
+        end
+        def update(
+          individual_id,
+          # Worker's compensation classification code for this employee
+          class_code: nil,
+          # Custom fields for the individual. These are fields which are defined by the
+          # employer in the system. Custom fields are not currently supported for assisted
+          # connections.
+          custom_fields: nil,
+          # The department object.
+          department: nil,
+          # The employment object.
+          employment: nil,
+          # The detailed employment status of the individual.
+          employment_status: nil,
+          end_date: nil,
+          # The legal first name of the individual.
+          first_name: nil,
+          # 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.
+          income: nil,
+          # The array of income history.
+          income_history: nil,
+          # `true` if the individual an an active employee or contractor at the company.
+          is_active: nil,
+          # The legal last name of the individual.
+          last_name: nil,
+          latest_rehire_date: nil,
+          location: nil,
+          # The manager object representing the manager of the individual within the org.
+          manager: nil,
+          # The legal middle name of the individual.
+          middle_name: nil,
+          # The source system's unique employment identifier for this individual
+          source_id: nil,
+          start_date: nil,
+          # The current title of the individual.
+          title: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/sandbox/individual.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Individual
+        # Update sandbox individual
+        sig do
+          params(
+            individual_id: String,
+            dob: T.nilable(String),
+            emails:
+              T.nilable(
+                T::Array[
+                  FinchAPI::Sandbox::IndividualUpdateParams::Email::OrHash
+                ]
+              ),
+            encrypted_ssn: T.nilable(String),
+            ethnicity:
+              T.nilable(
+                FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol
+              ),
+            first_name: T.nilable(String),
+            gender:
+              T.nilable(
+                FinchAPI::Sandbox::IndividualUpdateParams::Gender::OrSymbol
+              ),
+            last_name: T.nilable(String),
+            middle_name: T.nilable(String),
+            phone_numbers:
+              T.nilable(
+                T::Array[
+                  T.nilable(
+                    FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::OrHash
+                  )
+                ]
+              ),
+            preferred_name: T.nilable(String),
+            residence: T.nilable(FinchAPI::Location::OrHash),
+            ssn: T.nilable(String),
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(FinchAPI::Models::Sandbox::IndividualUpdateResponse)
+        end
+        def update(
+          individual_id,
+          dob: nil,
+          emails: nil,
+          # Social Security Number of the individual in **encrypted** format. This field is
+          # only available with the `ssn` scope enabled and the
+          # `options: { include: ['ssn'] }` param set in the body.
+          encrypted_ssn: nil,
+          # The EEOC-defined ethnicity of the individual.
+          ethnicity: nil,
+          # The legal first name of the individual.
+          first_name: nil,
+          # The gender of the individual.
+          gender: nil,
+          # The legal last name of the individual.
+          last_name: nil,
+          # The legal middle name of the individual.
+          middle_name: nil,
+          phone_numbers: nil,
+          # The preferred name of the individual.
+          preferred_name: nil,
+          residence: nil,
+          # Social Security Number of the individual. This field is only available with the
+          # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
+          # body.
+          # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
+          ssn: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/sandbox/jobs/configuration.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Jobs
+        class Configuration
+          # Get configurations for sandbox jobs
+          sig do
+            params(request_options: FinchAPI::RequestOptions::OrHash).returns(
+              T::Array[FinchAPI::Sandbox::Jobs::SandboxJobConfiguration]
+            )
+          end
+          def retrieve(request_options: {})
+          end
+
+          # Update configurations for sandbox jobs
+          sig do
+            params(
+              completion_status:
+                FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol,
+              type:
+                FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol,
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(FinchAPI::Sandbox::Jobs::SandboxJobConfiguration)
+          end
+          def update(completion_status:, type:, request_options: {})
+          end
+
+          # @api private
+          sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/sandbox/jobs.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Jobs
+        sig { returns(FinchAPI::Resources::Sandbox::Jobs::Configuration) }
+        attr_reader :configuration
+
+        # Enqueue a new sandbox job
+        sig do
+          params(
+            type: FinchAPI::Sandbox::JobCreateParams::Type::OrSymbol,
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(FinchAPI::Models::Sandbox::JobCreateResponse)
+        end
+        def create(
+          # The type of job to start. Currently the only supported type is `data_sync_all`
+          type:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/sandbox/payment.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Payment
+        # Add a new sandbox payment
+        sig do
+          params(
+            end_date: String,
+            pay_statements:
+              T::Array[
+                FinchAPI::Sandbox::PaymentCreateParams::PayStatement::OrHash
+              ],
+            start_date: String,
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(FinchAPI::Models::Sandbox::PaymentCreateResponse)
+        end
+        def create(
+          end_date: nil,
+          pay_statements: nil,
+          start_date: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/sandbox.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      sig { returns(FinchAPI::Resources::Sandbox::Connections) }
+      attr_reader :connections
+
+      sig { returns(FinchAPI::Resources::Sandbox::Company) }
+      attr_reader :company
+
+      sig { returns(FinchAPI::Resources::Sandbox::Directory) }
+      attr_reader :directory
+
+      sig { returns(FinchAPI::Resources::Sandbox::Individual) }
+      attr_reader :individual
+
+      sig { returns(FinchAPI::Resources::Sandbox::Employment) }
+      attr_reader :employment
+
+      sig { returns(FinchAPI::Resources::Sandbox::Payment) }
+      attr_reader :payment
+
+      sig { returns(FinchAPI::Resources::Sandbox::Jobs) }
+      attr_reader :jobs
+
+      # @api private
+      sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/webhooks.rbi

@@ -0,0 +1,12 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class Webhooks
+      # @api private
+      sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/finch_api/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module FinchAPI
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/finch_api/client.rbs

@@ -0,0 +1,54 @@
+module FinchAPI
+  class Client < FinchAPI::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader access_token: String?
+
+    attr_reader client_id: String?
+
+    attr_reader client_secret: String?
+
+    attr_reader access_tokens: FinchAPI::Resources::AccessTokens
+
+    attr_reader hris: FinchAPI::Resources::HRIS
+
+    attr_reader providers: FinchAPI::Resources::Providers
+
+    attr_reader account: FinchAPI::Resources::Account
+
+    attr_reader webhooks: FinchAPI::Resources::Webhooks
+
+    attr_reader request_forwarding: FinchAPI::Resources::RequestForwarding
+
+    attr_reader jobs: FinchAPI::Resources::Jobs
+
+    attr_reader sandbox: FinchAPI::Resources::Sandbox
+
+    attr_reader payroll: FinchAPI::Resources::Payroll
+
+    attr_reader connect: FinchAPI::Resources::Connect
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    private def bearer_auth: -> ::Hash[String, String]
+
+    private def basic_auth: -> ::Hash[String, String]
+
+    def initialize: (
+      ?client_id: String?,
+      ?client_secret: String?,
+      ?access_token: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/finch_api/errors.rbs

@@ -0,0 +1,101 @@
+module FinchAPI
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < FinchAPI::Errors::Error
+    end
+
+    class APIError < FinchAPI::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < FinchAPI::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < FinchAPI::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < FinchAPI::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    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: Range[Integer]
+    end
+  end
+end

data/sig/finch_api/file_part.rbs

@@ -0,0 +1,21 @@
+module FinchAPI
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: String?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/finch_api/internal/individuals_page.rbs

@@ -0,0 +1,13 @@
+module FinchAPI
+  module Internal
+    class IndividualsPage[Elem]
+      include FinchAPI::Internal::Type::BasePage[Elem]
+
+      attr_accessor individuals: ::Array[Elem]?
+
+      attr_accessor paging: FinchAPI::Paging
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/finch_api/internal/page.rbs

@@ -0,0 +1,13 @@
+module FinchAPI
+  module Internal
+    class Page[Elem]
+      include FinchAPI::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor paging: FinchAPI::Paging
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/finch_api/internal/responses_page.rbs

@@ -0,0 +1,11 @@
+module FinchAPI
+  module Internal
+    class ResponsesPage[Elem]
+      include FinchAPI::Internal::Type::BasePage[Elem]
+
+      attr_accessor responses: ::Array[Elem]?
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/finch_api/internal/single_page.rbs

@@ -0,0 +1,15 @@
+module FinchAPI
+  module Internal
+    class SinglePage[Elem] < ::Array[Elem]
+      include FinchAPI::Internal::Type::BasePage[Elem]
+
+      def next_page?: -> bool
+
+      def next_page: -> self
+
+      def auto_paging_each: { (Elem arg0) -> void } -> void
+
+      def inspect: -> String
+    end
+  end
+end