finch-api 0.1.0.pre.alpha.1

data/sig/finch-api/models/base_webhook_event.rbs

@@ -0,0 +1,24 @@
+module FinchAPI
+  module Models
+    type base_webhook_event =
+      { account_id: String, company_id: String, connection_id: String }
+
+    class BaseWebhookEvent < FinchAPI::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor company_id: String
+
+      attr_reader connection_id: String?
+
+      def connection_id=: (String) -> String
+
+      def initialize:
+        (account_id: String, company_id: String, connection_id: String) -> void
+        | (
+          ?FinchAPI::Models::base_webhook_event | FinchAPI::BaseModel data
+        ) -> void
+
+      def to_hash: -> FinchAPI::Models::base_webhook_event
+    end
+  end
+end

data/sig/finch-api/models/company_event.rbs

@@ -0,0 +1,36 @@
+module FinchAPI
+  module Models
+    type company_event =
+      {
+        data: ::Hash[Symbol, top]?,
+        event_type: FinchAPI::Models::CompanyEvent::event_type
+      }
+
+    class CompanyEvent < FinchAPI::Models::BaseWebhookEvent
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_reader event_type: FinchAPI::Models::CompanyEvent::event_type?
+
+      def event_type=: (
+        FinchAPI::Models::CompanyEvent::event_type
+      ) -> FinchAPI::Models::CompanyEvent::event_type
+
+      def initialize:
+        (
+          data: ::Hash[Symbol, top]?,
+          event_type: FinchAPI::Models::CompanyEvent::event_type
+        ) -> void
+        | (?FinchAPI::Models::company_event | FinchAPI::BaseModel data) -> void
+
+      def to_hash: -> FinchAPI::Models::company_event
+
+      type event_type = :"company.updated"
+
+      class EventType < FinchAPI::Enum
+        COMPANY_UPDATED: :"company.updated"
+
+        def self.values: -> ::Array[FinchAPI::Models::CompanyEvent::event_type]
+      end
+    end
+  end
+end

data/sig/finch-api/models/connect/session_new_params.rbs

@@ -0,0 +1,129 @@
+module FinchAPI
+  module Models
+    module Connect
+      type session_new_params =
+        {
+          customer_id: String,
+          customer_name: String,
+          products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product],
+          customer_email: String?,
+          integration: FinchAPI::Models::Connect::SessionNewParams::Integration?,
+          manual: bool?,
+          minutes_to_expire: Float?,
+          redirect_uri: String?,
+          sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?
+        }
+        & FinchAPI::request_parameters
+
+      class SessionNewParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_accessor customer_id: String
+
+        attr_accessor customer_name: String
+
+        attr_accessor products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product]
+
+        attr_accessor customer_email: String?
+
+        attr_accessor integration: FinchAPI::Models::Connect::SessionNewParams::Integration?
+
+        attr_accessor manual: bool?
+
+        attr_accessor minutes_to_expire: Float?
+
+        attr_accessor redirect_uri: String?
+
+        attr_accessor sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?
+
+        def initialize:
+          (
+            customer_id: String,
+            customer_name: String,
+            products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product],
+            customer_email: String?,
+            integration: FinchAPI::Models::Connect::SessionNewParams::Integration?,
+            manual: bool?,
+            minutes_to_expire: Float?,
+            redirect_uri: String?,
+            sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?,
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::Connect::session_new_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Connect::session_new_params
+
+        type product =
+          :company
+          | :directory
+          | :individual
+          | :employment
+          | :payment
+          | :pay_statement
+          | :benefits
+          | :ssn
+
+        class Product < FinchAPI::Enum
+          COMPANY: :company
+          DIRECTORY: :directory
+          INDIVIDUAL: :individual
+          EMPLOYMENT: :employment
+          PAYMENT: :payment
+          PAY_STATEMENT: :pay_statement
+          BENEFITS: :benefits
+          SSN: :ssn
+
+          def self.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::product]
+        end
+
+        type integration =
+          {
+            auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?,
+            provider: String?
+          }
+
+        class Integration < FinchAPI::BaseModel
+          attr_accessor auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?
+
+          attr_accessor provider: String?
+
+          def initialize:
+            (
+              auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?,
+              provider: String?
+            ) -> void
+            | (
+              ?FinchAPI::Models::Connect::SessionNewParams::integration
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::Connect::SessionNewParams::integration
+
+          type auth_method = :assisted | :credential | :oauth | :api_token
+
+          class AuthMethod < FinchAPI::Enum
+            ASSISTED: :assisted
+            CREDENTIAL: :credential
+            OAUTH: :oauth
+            API_TOKEN: :api_token
+
+            def self.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method]
+          end
+        end
+
+        type sandbox = :finch | :provider
+
+        class Sandbox < FinchAPI::Enum
+          FINCH: :finch
+          PROVIDER: :provider
+
+          def self.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::sandbox]
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/connect/session_new_response.rbs

@@ -0,0 +1,22 @@
+module FinchAPI
+  module Models
+    module Connect
+      type session_new_response = { connect_url: String, session_id: String }
+
+      class SessionNewResponse < FinchAPI::BaseModel
+        attr_accessor connect_url: String
+
+        attr_accessor session_id: String
+
+        def initialize:
+          (connect_url: String, session_id: String) -> void
+          | (
+            ?FinchAPI::Models::Connect::session_new_response
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Connect::session_new_response
+      end
+    end
+  end
+end

data/sig/finch-api/models/connect/session_reauthenticate_params.rbs

@@ -0,0 +1,65 @@
+module FinchAPI
+  module Models
+    module Connect
+      type session_reauthenticate_params =
+        {
+          connection_id: String,
+          minutes_to_expire: Integer?,
+          products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?,
+          redirect_uri: String?
+        }
+        & FinchAPI::request_parameters
+
+      class SessionReauthenticateParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_accessor connection_id: String
+
+        attr_accessor minutes_to_expire: Integer?
+
+        attr_accessor products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?
+
+        attr_accessor redirect_uri: String?
+
+        def initialize:
+          (
+            connection_id: String,
+            minutes_to_expire: Integer?,
+            products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?,
+            redirect_uri: String?,
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::Connect::session_reauthenticate_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Connect::session_reauthenticate_params
+
+        type product =
+          :company
+          | :directory
+          | :individual
+          | :employment
+          | :payment
+          | :pay_statement
+          | :benefits
+          | :ssn
+
+        class Product < FinchAPI::Enum
+          COMPANY: :company
+          DIRECTORY: :directory
+          INDIVIDUAL: :individual
+          EMPLOYMENT: :employment
+          PAYMENT: :payment
+          PAY_STATEMENT: :pay_statement
+          BENEFITS: :benefits
+          SSN: :ssn
+
+          def self.values: -> ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/connect/session_reauthenticate_response.rbs

@@ -0,0 +1,23 @@
+module FinchAPI
+  module Models
+    module Connect
+      type session_reauthenticate_response =
+        { connect_url: String, session_id: String }
+
+      class SessionReauthenticateResponse < FinchAPI::BaseModel
+        attr_accessor connect_url: String
+
+        attr_accessor session_id: String
+
+        def initialize:
+          (connect_url: String, session_id: String) -> void
+          | (
+            ?FinchAPI::Models::Connect::session_reauthenticate_response
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Connect::session_reauthenticate_response
+      end
+    end
+  end
+end

data/sig/finch-api/models/connection_status_type.rbs

@@ -0,0 +1,22 @@
+module FinchAPI
+  module Models
+    type connection_status_type =
+      :pending
+      | :processing
+      | :connected
+      | :error_no_account_setup
+      | :error_permissions
+      | :reauth
+
+    class ConnectionStatusType < FinchAPI::Enum
+      PENDING: :pending
+      PROCESSING: :processing
+      CONNECTED: :connected
+      ERROR_NO_ACCOUNT_SETUP: :error_no_account_setup
+      ERROR_PERMISSIONS: :error_permissions
+      REAUTH: :reauth
+
+      def self.values: -> ::Array[FinchAPI::Models::connection_status_type]
+    end
+  end
+end

data/sig/finch-api/models/create_access_token_response.rbs

@@ -0,0 +1,80 @@
+module FinchAPI
+  module Models
+    type create_access_token_response =
+      {
+        access_token: String,
+        account_id: String,
+        client_type: FinchAPI::Models::CreateAccessTokenResponse::client_type,
+        company_id: String,
+        connection_id: String,
+        connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type,
+        products: ::Array[String],
+        provider_id: String,
+        customer_id: String?,
+        token_type: String
+      }
+
+    class CreateAccessTokenResponse < FinchAPI::BaseModel
+      attr_accessor access_token: String
+
+      attr_accessor account_id: String
+
+      attr_accessor client_type: FinchAPI::Models::CreateAccessTokenResponse::client_type
+
+      attr_accessor company_id: String
+
+      attr_accessor connection_id: String
+
+      attr_accessor connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type
+
+      attr_accessor products: ::Array[String]
+
+      attr_accessor provider_id: String
+
+      attr_accessor customer_id: String?
+
+      attr_reader token_type: String?
+
+      def token_type=: (String) -> String
+
+      def initialize:
+        (
+          access_token: String,
+          account_id: String,
+          client_type: FinchAPI::Models::CreateAccessTokenResponse::client_type,
+          company_id: String,
+          connection_id: String,
+          connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type,
+          products: ::Array[String],
+          provider_id: String,
+          customer_id: String?,
+          token_type: String
+        ) -> void
+        | (
+          ?FinchAPI::Models::create_access_token_response
+          | FinchAPI::BaseModel data
+        ) -> void
+
+      def to_hash: -> FinchAPI::Models::create_access_token_response
+
+      type client_type = :production | :development | :sandbox
+
+      class ClientType < FinchAPI::Enum
+        PRODUCTION: :production
+        DEVELOPMENT: :development
+        SANDBOX: :sandbox
+
+        def self.values: -> ::Array[FinchAPI::Models::CreateAccessTokenResponse::client_type]
+      end
+
+      type connection_type = :provider | :finch
+
+      class ConnectionType < FinchAPI::Enum
+        PROVIDER: :provider
+        FINCH: :finch
+
+        def self.values: -> ::Array[FinchAPI::Models::CreateAccessTokenResponse::connection_type]
+      end
+    end
+  end
+end

data/sig/finch-api/models/directory_event.rbs

@@ -0,0 +1,61 @@
+module FinchAPI
+  module Models
+    type directory_event =
+      {
+        data: FinchAPI::Models::DirectoryEvent::Data,
+        event_type: FinchAPI::Models::DirectoryEvent::event_type
+      }
+
+    class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent
+      attr_reader data: FinchAPI::Models::DirectoryEvent::Data?
+
+      def data=: (
+        FinchAPI::Models::DirectoryEvent::Data
+      ) -> FinchAPI::Models::DirectoryEvent::Data
+
+      attr_reader event_type: FinchAPI::Models::DirectoryEvent::event_type?
+
+      def event_type=: (
+        FinchAPI::Models::DirectoryEvent::event_type
+      ) -> FinchAPI::Models::DirectoryEvent::event_type
+
+      def initialize:
+        (
+          data: FinchAPI::Models::DirectoryEvent::Data,
+          event_type: FinchAPI::Models::DirectoryEvent::event_type
+        ) -> void
+        | (
+          ?FinchAPI::Models::directory_event | FinchAPI::BaseModel data
+        ) -> void
+
+      def to_hash: -> FinchAPI::Models::directory_event
+
+      type data = { individual_id: String }
+
+      class Data < FinchAPI::BaseModel
+        attr_reader individual_id: String?
+
+        def individual_id=: (String) -> String
+
+        def initialize:
+          (individual_id: String) -> void
+          | (
+            ?FinchAPI::Models::DirectoryEvent::data | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::DirectoryEvent::data
+      end
+
+      type event_type =
+        :"directory.created" | :"directory.updated" | :"directory.deleted"
+
+      class EventType < FinchAPI::Enum
+        DIRECTORY_CREATED: :"directory.created"
+        DIRECTORY_UPDATED: :"directory.updated"
+        DIRECTORY_DELETED: :"directory.deleted"
+
+        def self.values: -> ::Array[FinchAPI::Models::DirectoryEvent::event_type]
+      end
+    end
+  end
+end

data/sig/finch-api/models/disconnect_response.rbs

@@ -0,0 +1,17 @@
+module FinchAPI
+  module Models
+    type disconnect_response = { status: String }
+
+    class DisconnectResponse < FinchAPI::BaseModel
+      attr_accessor status: String
+
+      def initialize:
+        (status: String) -> void
+        | (
+          ?FinchAPI::Models::disconnect_response | FinchAPI::BaseModel data
+        ) -> void
+
+      def to_hash: -> FinchAPI::Models::disconnect_response
+    end
+  end
+end

data/sig/finch-api/models/employment_event.rbs

@@ -0,0 +1,61 @@
+module FinchAPI
+  module Models
+    type employment_event =
+      {
+        data: FinchAPI::Models::EmploymentEvent::Data,
+        event_type: FinchAPI::Models::EmploymentEvent::event_type
+      }
+
+    class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent
+      attr_reader data: FinchAPI::Models::EmploymentEvent::Data?
+
+      def data=: (
+        FinchAPI::Models::EmploymentEvent::Data
+      ) -> FinchAPI::Models::EmploymentEvent::Data
+
+      attr_reader event_type: FinchAPI::Models::EmploymentEvent::event_type?
+
+      def event_type=: (
+        FinchAPI::Models::EmploymentEvent::event_type
+      ) -> FinchAPI::Models::EmploymentEvent::event_type
+
+      def initialize:
+        (
+          data: FinchAPI::Models::EmploymentEvent::Data,
+          event_type: FinchAPI::Models::EmploymentEvent::event_type
+        ) -> void
+        | (
+          ?FinchAPI::Models::employment_event | FinchAPI::BaseModel data
+        ) -> void
+
+      def to_hash: -> FinchAPI::Models::employment_event
+
+      type data = { individual_id: String }
+
+      class Data < FinchAPI::BaseModel
+        attr_reader individual_id: String?
+
+        def individual_id=: (String) -> String
+
+        def initialize:
+          (individual_id: String) -> void
+          | (
+            ?FinchAPI::Models::EmploymentEvent::data | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::EmploymentEvent::data
+      end
+
+      type event_type =
+        :"employment.created" | :"employment.updated" | :"employment.deleted"
+
+      class EventType < FinchAPI::Enum
+        EMPLOYMENT_CREATED: :"employment.created"
+        EMPLOYMENT_UPDATED: :"employment.updated"
+        EMPLOYMENT_DELETED: :"employment.deleted"
+
+        def self.values: -> ::Array[FinchAPI::Models::EmploymentEvent::event_type]
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/benefit_contribution.rbs

@@ -0,0 +1,38 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type benefit_contribution =
+        {
+          amount: Integer?,
+          type: FinchAPI::Models::HRIS::BenefitContribution::type_?
+        }
+
+      class BenefitContribution < FinchAPI::BaseModel
+        attr_accessor amount: Integer?
+
+        attr_accessor type: FinchAPI::Models::HRIS::BenefitContribution::type_?
+
+        def initialize:
+          (
+            amount: Integer?,
+            type: FinchAPI::Models::HRIS::BenefitContribution::type_?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::benefit_contribution
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::benefit_contribution
+
+        type type_ = :fixed | :percent
+
+        class Type < FinchAPI::Enum
+          FIXED: :fixed
+          PERCENT: :percent
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::BenefitContribution::type_]
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/benefit_create_params.rbs

@@ -0,0 +1,40 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type benefit_create_params =
+        {
+          description: String,
+          frequency: FinchAPI::Models::HRIS::benefit_frequency?,
+          type: FinchAPI::Models::HRIS::benefit_type?
+        }
+        & FinchAPI::request_parameters
+
+      class BenefitCreateParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_reader description: String?
+
+        def description=: (String) -> String
+
+        attr_accessor frequency: FinchAPI::Models::HRIS::benefit_frequency?
+
+        attr_accessor type: FinchAPI::Models::HRIS::benefit_type?
+
+        def initialize:
+          (
+            description: String,
+            frequency: FinchAPI::Models::HRIS::benefit_frequency?,
+            type: FinchAPI::Models::HRIS::benefit_type?,
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::benefit_create_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::benefit_create_params
+      end
+    end
+  end
+end