finch-api 0.1.0.pre.alpha.1

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

@@ -0,0 +1,204 @@
+module FinchAPI
+  module Models
+    type introspection =
+      {
+        account_id: String,
+        authentication_methods: ::Array[FinchAPI::Models::Introspection::AuthenticationMethod],
+        client_id: String,
+        client_type: FinchAPI::Models::Introspection::client_type,
+        company_id: String,
+        connection_id: String,
+        connection_status: FinchAPI::Models::Introspection::ConnectionStatus,
+        connection_type: FinchAPI::Models::Introspection::connection_type,
+        customer_email: String?,
+        customer_id: String?,
+        customer_name: String?,
+        manual: bool,
+        payroll_provider_id: String,
+        products: ::Array[String],
+        provider_id: String,
+        username: String
+      }
+
+    class Introspection < FinchAPI::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor authentication_methods: ::Array[FinchAPI::Models::Introspection::AuthenticationMethod]
+
+      attr_accessor client_id: String
+
+      attr_accessor client_type: FinchAPI::Models::Introspection::client_type
+
+      attr_accessor company_id: String
+
+      attr_accessor connection_id: String
+
+      attr_accessor connection_status: FinchAPI::Models::Introspection::ConnectionStatus
+
+      attr_accessor connection_type: FinchAPI::Models::Introspection::connection_type
+
+      attr_accessor customer_email: String?
+
+      attr_accessor customer_id: String?
+
+      attr_accessor customer_name: String?
+
+      attr_accessor manual: bool
+
+      attr_accessor payroll_provider_id: String
+
+      attr_accessor products: ::Array[String]
+
+      attr_accessor provider_id: String
+
+      attr_accessor username: String
+
+      def initialize:
+        (
+          account_id: String,
+          authentication_methods: ::Array[FinchAPI::Models::Introspection::AuthenticationMethod],
+          client_id: String,
+          client_type: FinchAPI::Models::Introspection::client_type,
+          company_id: String,
+          connection_id: String,
+          connection_status: FinchAPI::Models::Introspection::ConnectionStatus,
+          connection_type: FinchAPI::Models::Introspection::connection_type,
+          customer_email: String?,
+          customer_id: String?,
+          customer_name: String?,
+          manual: bool,
+          payroll_provider_id: String,
+          products: ::Array[String],
+          provider_id: String,
+          username: String
+        ) -> void
+        | (?FinchAPI::Models::introspection | FinchAPI::BaseModel data) -> void
+
+      def to_hash: -> FinchAPI::Models::introspection
+
+      type authentication_method =
+        {
+          connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus,
+          products: ::Array[String],
+          type: FinchAPI::Models::Introspection::AuthenticationMethod::type_
+        }
+
+      class AuthenticationMethod < FinchAPI::BaseModel
+        attr_reader connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus?
+
+        def connection_status=: (
+          FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus
+        ) -> FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus
+
+        attr_reader products: ::Array[String]?
+
+        def products=: (::Array[String]) -> ::Array[String]
+
+        attr_reader type: FinchAPI::Models::Introspection::AuthenticationMethod::type_?
+
+        def type=: (
+          FinchAPI::Models::Introspection::AuthenticationMethod::type_
+        ) -> FinchAPI::Models::Introspection::AuthenticationMethod::type_
+
+        def initialize:
+          (
+            connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus,
+            products: ::Array[String],
+            type: FinchAPI::Models::Introspection::AuthenticationMethod::type_
+          ) -> void
+          | (
+            ?FinchAPI::Models::Introspection::authentication_method
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Introspection::authentication_method
+
+        type connection_status =
+          { message: String, status: FinchAPI::Models::connection_status_type }
+
+        class ConnectionStatus < FinchAPI::BaseModel
+          attr_reader message: String?
+
+          def message=: (String) -> String
+
+          attr_reader status: FinchAPI::Models::connection_status_type?
+
+          def status=: (
+            FinchAPI::Models::connection_status_type
+          ) -> FinchAPI::Models::connection_status_type
+
+          def initialize:
+            (
+              message: String,
+              status: FinchAPI::Models::connection_status_type
+            ) -> void
+            | (
+              ?FinchAPI::Models::Introspection::AuthenticationMethod::connection_status
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::Introspection::AuthenticationMethod::connection_status
+        end
+
+        type type_ =
+          :assisted | :credential | :api_token | :api_credential | :oauth
+
+        class Type < FinchAPI::Enum
+          ASSISTED: :assisted
+          CREDENTIAL: :credential
+          API_TOKEN: :api_token
+          API_CREDENTIAL: :api_credential
+          OAUTH: :oauth
+
+          def self.values: -> ::Array[FinchAPI::Models::Introspection::AuthenticationMethod::type_]
+        end
+      end
+
+      type client_type = :production | :development | :sandbox
+
+      class ClientType < FinchAPI::Enum
+        PRODUCTION: :production
+        DEVELOPMENT: :development
+        SANDBOX: :sandbox
+
+        def self.values: -> ::Array[FinchAPI::Models::Introspection::client_type]
+      end
+
+      type connection_status =
+        { message: String, status: FinchAPI::Models::connection_status_type }
+
+      class ConnectionStatus < FinchAPI::BaseModel
+        attr_reader message: String?
+
+        def message=: (String) -> String
+
+        attr_reader status: FinchAPI::Models::connection_status_type?
+
+        def status=: (
+          FinchAPI::Models::connection_status_type
+        ) -> FinchAPI::Models::connection_status_type
+
+        def initialize:
+          (
+            message: String,
+            status: FinchAPI::Models::connection_status_type
+          ) -> void
+          | (
+            ?FinchAPI::Models::Introspection::connection_status
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Introspection::connection_status
+      end
+
+      type connection_type = :provider | :finch
+
+      class ConnectionType < FinchAPI::Enum
+        PROVIDER: :provider
+        FINCH: :finch
+
+        def self.values: -> ::Array[FinchAPI::Models::Introspection::connection_type]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module FinchAPI
+  module Models
+    type job_completion_event =
+      {
+        data: FinchAPI::Models::JobCompletionEvent::Data,
+        event_type: FinchAPI::Models::JobCompletionEvent::event_type
+      }
+
+    class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent
+      attr_reader data: FinchAPI::Models::JobCompletionEvent::Data?
+
+      def data=: (
+        FinchAPI::Models::JobCompletionEvent::Data
+      ) -> FinchAPI::Models::JobCompletionEvent::Data
+
+      attr_reader event_type: FinchAPI::Models::JobCompletionEvent::event_type?
+
+      def event_type=: (
+        FinchAPI::Models::JobCompletionEvent::event_type
+      ) -> FinchAPI::Models::JobCompletionEvent::event_type
+
+      def initialize:
+        (
+          data: FinchAPI::Models::JobCompletionEvent::Data,
+          event_type: FinchAPI::Models::JobCompletionEvent::event_type
+        ) -> void
+        | (
+          ?FinchAPI::Models::job_completion_event | FinchAPI::BaseModel data
+        ) -> void
+
+      def to_hash: -> FinchAPI::Models::job_completion_event
+
+      type data = { job_id: String, job_url: String }
+
+      class Data < FinchAPI::BaseModel
+        attr_accessor job_id: String
+
+        attr_accessor job_url: String
+
+        def initialize:
+          (job_id: String, job_url: String) -> void
+          | (
+            ?FinchAPI::Models::JobCompletionEvent::data
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::JobCompletionEvent::data
+      end
+
+      type event_type =
+        :"job.benefit_create.completed"
+        | :"job.benefit_enroll.completed"
+        | :"job.benefit_register.completed"
+        | :"job.benefit_unenroll.completed"
+        | :"job.benefit_update.completed"
+        | :"job.data_sync_all.completed"
+
+      class EventType < FinchAPI::Enum
+        JOB_BENEFIT_CREATE_COMPLETED: :"job.benefit_create.completed"
+        JOB_BENEFIT_ENROLL_COMPLETED: :"job.benefit_enroll.completed"
+        JOB_BENEFIT_REGISTER_COMPLETED: :"job.benefit_register.completed"
+        JOB_BENEFIT_UNENROLL_COMPLETED: :"job.benefit_unenroll.completed"
+        JOB_BENEFIT_UPDATE_COMPLETED: :"job.benefit_update.completed"
+        JOB_DATA_SYNC_ALL_COMPLETED: :"job.data_sync_all.completed"
+
+        def self.values: -> ::Array[FinchAPI::Models::JobCompletionEvent::event_type]
+      end
+    end
+  end
+end

data/sig/finch-api/models/jobs/automated_async_job.rbs

@@ -0,0 +1,102 @@
+module FinchAPI
+  module Models
+    module Jobs
+      type automated_async_job =
+        {
+          completed_at: Time?,
+          created_at: Time,
+          job_id: String,
+          job_url: String,
+          params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params?,
+          scheduled_at: Time?,
+          started_at: Time?,
+          status: FinchAPI::Models::Jobs::AutomatedAsyncJob::status,
+          type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_
+        }
+
+      class AutomatedAsyncJob < FinchAPI::BaseModel
+        attr_accessor completed_at: Time?
+
+        attr_accessor created_at: Time
+
+        attr_accessor job_id: String
+
+        attr_accessor job_url: String
+
+        attr_accessor params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params?
+
+        attr_accessor scheduled_at: Time?
+
+        attr_accessor started_at: Time?
+
+        attr_accessor status: FinchAPI::Models::Jobs::AutomatedAsyncJob::status
+
+        attr_accessor type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_
+
+        def initialize:
+          (
+            completed_at: Time?,
+            created_at: Time,
+            job_id: String,
+            job_url: String,
+            params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params?,
+            scheduled_at: Time?,
+            started_at: Time?,
+            status: FinchAPI::Models::Jobs::AutomatedAsyncJob::status,
+            type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_
+          ) -> void
+          | (
+            ?FinchAPI::Models::Jobs::automated_async_job
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Jobs::automated_async_job
+
+        type params = { individual_id: String }
+
+        class Params < FinchAPI::BaseModel
+          attr_reader individual_id: String?
+
+          def individual_id=: (String) -> String
+
+          def initialize:
+            (individual_id: String) -> void
+            | (
+              ?FinchAPI::Models::Jobs::AutomatedAsyncJob::params
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::Jobs::AutomatedAsyncJob::params
+        end
+
+        type status =
+          :pending
+          | :in_progress
+          | :complete
+          | :error
+          | :reauth_error
+          | :permissions_error
+
+        class Status < FinchAPI::Enum
+          PENDING: :pending
+          IN_PROGRESS: :in_progress
+          COMPLETE: :complete
+          ERROR: :error
+          REAUTH_ERROR: :reauth_error
+          PERMISSIONS_ERROR: :permissions_error
+
+          def self.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::status]
+        end
+
+        type type_ = :data_sync_all | :w4_form_employee_sync
+
+        class Type < FinchAPI::Enum
+          DATA_SYNC_ALL: :data_sync_all
+          W4_FORM_EMPLOYEE_SYNC: :w4_form_employee_sync
+
+          def self.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::type_]
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/jobs/automated_create_params.rbs

@@ -0,0 +1,57 @@
+module FinchAPI
+  module Models
+    module Jobs
+      type automated_create_params =
+        {
+          type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_,
+          params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params
+        }
+        & FinchAPI::request_parameters
+
+      class AutomatedCreateParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_accessor type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_
+
+        attr_accessor params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params
+
+        def initialize:
+          (
+            type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_,
+            params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params,
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::Jobs::automated_create_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Jobs::automated_create_params
+
+        type type_ = :w4_form_employee_sync
+
+        class Type < FinchAPI::Enum
+          W4_FORM_EMPLOYEE_SYNC: :w4_form_employee_sync
+
+          def self.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::type_]
+        end
+
+        type params = { individual_id: String }
+
+        class Params < FinchAPI::BaseModel
+          attr_accessor individual_id: String
+
+          def initialize:
+            (individual_id: String) -> void
+            | (
+              ?FinchAPI::Models::Jobs::AutomatedCreateParams::params
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::Jobs::AutomatedCreateParams::params
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/jobs/automated_create_response.rbs

@@ -0,0 +1,37 @@
+module FinchAPI
+  module Models
+    module Jobs
+      type automated_create_response =
+        {
+          allowed_refreshes: Integer,
+          job_id: String,
+          job_url: String,
+          remaining_refreshes: Integer
+        }
+
+      class AutomatedCreateResponse < FinchAPI::BaseModel
+        attr_accessor allowed_refreshes: Integer
+
+        attr_accessor job_id: String
+
+        attr_accessor job_url: String
+
+        attr_accessor remaining_refreshes: Integer
+
+        def initialize:
+          (
+            allowed_refreshes: Integer,
+            job_id: String,
+            job_url: String,
+            remaining_refreshes: Integer
+          ) -> void
+          | (
+            ?FinchAPI::Models::Jobs::automated_create_response
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Jobs::automated_create_response
+      end
+    end
+  end
+end

data/sig/finch-api/models/jobs/automated_list_params.rbs

@@ -0,0 +1,34 @@
+module FinchAPI
+  module Models
+    module Jobs
+      type automated_list_params =
+        { limit: Integer, offset: Integer } & FinchAPI::request_parameters
+
+      class AutomatedListParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        attr_reader offset: Integer?
+
+        def offset=: (Integer) -> Integer
+
+        def initialize:
+          (
+            limit: Integer,
+            offset: Integer,
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::Jobs::automated_list_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Jobs::automated_list_params
+      end
+    end
+  end
+end

data/sig/finch-api/models/jobs/automated_retrieve_params.rbs

@@ -0,0 +1,21 @@
+module FinchAPI
+  module Models
+    module Jobs
+      type automated_retrieve_params = {  } & FinchAPI::request_parameters
+
+      class AutomatedRetrieveParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        def initialize:
+          (request_options: FinchAPI::request_opts) -> void
+          | (
+            ?FinchAPI::Models::Jobs::automated_retrieve_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Jobs::automated_retrieve_params
+      end
+    end
+  end
+end

data/sig/finch-api/models/jobs/manual_async_job.rbs

@@ -0,0 +1,43 @@
+module FinchAPI
+  module Models
+    module Jobs
+      type manual_async_job =
+        {
+          body: ::Array[top]?,
+          job_id: String,
+          status: FinchAPI::Models::Jobs::ManualAsyncJob::status
+        }
+
+      class ManualAsyncJob < FinchAPI::BaseModel
+        attr_accessor body: ::Array[top]?
+
+        attr_accessor job_id: String
+
+        attr_accessor status: FinchAPI::Models::Jobs::ManualAsyncJob::status
+
+        def initialize:
+          (
+            body: ::Array[top]?,
+            job_id: String,
+            status: FinchAPI::Models::Jobs::ManualAsyncJob::status
+          ) -> void
+          | (
+            ?FinchAPI::Models::Jobs::manual_async_job | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Jobs::manual_async_job
+
+        type status = :pending | :in_progress | :error | :complete
+
+        class Status < FinchAPI::Enum
+          PENDING: :pending
+          IN_PROGRESS: :in_progress
+          ERROR: :error
+          COMPLETE: :complete
+
+          def self.values: -> ::Array[FinchAPI::Models::Jobs::ManualAsyncJob::status]
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/jobs/manual_retrieve_params.rbs

@@ -0,0 +1,21 @@
+module FinchAPI
+  module Models
+    module Jobs
+      type manual_retrieve_params = {  } & FinchAPI::request_parameters
+
+      class ManualRetrieveParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        def initialize:
+          (request_options: FinchAPI::request_opts) -> void
+          | (
+            ?FinchAPI::Models::Jobs::manual_retrieve_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::Jobs::manual_retrieve_params
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module FinchAPI
+  module Models
+    type location =
+      {
+        city: String?,
+        country: String?,
+        :line1 => String?,
+        :line2 => String?,
+        name: String?,
+        postal_code: String?,
+        source_id: String?,
+        state: String?
+      }
+
+    class Location < FinchAPI::BaseModel
+      attr_accessor city: String?
+
+      attr_accessor country: String?
+
+      attr_accessor line1: String?
+
+      attr_accessor line2: String?
+
+      attr_accessor name: String?
+
+      attr_accessor postal_code: String?
+
+      attr_accessor source_id: String?
+
+      attr_accessor state: String?
+
+      def initialize:
+        (
+          city: String?,
+          country: String?,
+          line1: String?,
+          line2: String?,
+          name: String?,
+          postal_code: String?,
+          source_id: String?,
+          state: String?
+        ) -> void
+        | (?FinchAPI::Models::location | FinchAPI::BaseModel data) -> void
+
+      def to_hash: -> FinchAPI::Models::location
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module FinchAPI
+  module Models
+    type money = { amount: Integer?, currency: String }
+
+    class Money < FinchAPI::BaseModel
+      attr_accessor amount: Integer?
+
+      attr_reader currency: String?
+
+      def currency=: (String) -> String
+
+      def initialize:
+        (amount: Integer?, currency: String) -> void
+        | (?FinchAPI::Models::money | FinchAPI::BaseModel data) -> void
+
+      def to_hash: -> FinchAPI::Models::money
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module FinchAPI
+  module Models
+    type operation_support =
+      :supported
+      | :not_supported_by_finch
+      | :not_supported_by_provider
+      | :client_access_only
+
+    class OperationSupport < FinchAPI::Enum
+      SUPPORTED: :supported
+      NOT_SUPPORTED_BY_FINCH: :not_supported_by_finch
+      NOT_SUPPORTED_BY_PROVIDER: :not_supported_by_provider
+      CLIENT_ACCESS_ONLY: :client_access_only
+
+      def self.values: -> ::Array[FinchAPI::Models::operation_support]
+    end
+  end
+end