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

data/lib/finch-api/models/income.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    class Income < FinchAPI::BaseModel
-      # @!attribute amount
-      #   The income amount in cents.
-      #
-      #   @return [Integer, nil]
-      optional :amount, Integer, nil?: true
-
-      # @!attribute currency
-      #   The currency code.
-      #
-      #   @return [String, nil]
-      optional :currency, String, nil?: true
-
-      # @!attribute effective_date
-      #   The date the income amount went into effect.
-      #
-      #   @return [String, nil]
-      optional :effective_date, String, nil?: true
-
-      # @!attribute unit
-      #   The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
-      #     `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
-      #
-      #   @return [Symbol, FinchAPI::Models::Income::Unit, nil]
-      optional :unit, enum: -> { FinchAPI::Models::Income::Unit }, nil?: true
-
-      # @!parse
-      #   # 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.
-      #   #
-      #   # @param amount [Integer, nil]
-      #   # @param currency [String, nil]
-      #   # @param effective_date [String, nil]
-      #   # @param unit [Symbol, FinchAPI::Models::Income::Unit, nil]
-      #   #
-      #   def initialize(amount: nil, currency: nil, effective_date: nil, unit: nil, **) = super
-
-      # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-      # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
-      #   `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
-      module Unit
-        extend FinchAPI::Enum
-
-        YEARLY = :yearly
-        QUARTERLY = :quarterly
-        MONTHLY = :monthly
-        SEMI_MONTHLY = :semi_monthly
-        BI_WEEKLY = :bi_weekly
-        WEEKLY = :weekly
-        DAILY = :daily
-        HOURLY = :hourly
-        FIXED = :fixed
-
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
-      end
-    end
-  end
-end

data/lib/finch-api/models/individual_event.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    class IndividualEvent < FinchAPI::Models::BaseWebhookEvent
-      # @!attribute [r] data
-      #
-      #   @return [FinchAPI::Models::IndividualEvent::Data, nil]
-      optional :data, -> { FinchAPI::Models::IndividualEvent::Data }
-
-      # @!parse
-      #   # @return [FinchAPI::Models::IndividualEvent::Data]
-      #   attr_writer :data
-
-      # @!attribute [r] event_type
-      #
-      #   @return [Symbol, FinchAPI::Models::IndividualEvent::EventType, nil]
-      optional :event_type, enum: -> { FinchAPI::Models::IndividualEvent::EventType }
-
-      # @!parse
-      #   # @return [Symbol, FinchAPI::Models::IndividualEvent::EventType]
-      #   attr_writer :event_type
-
-      # @!parse
-      #   # @param data [FinchAPI::Models::IndividualEvent::Data]
-      #   # @param event_type [Symbol, FinchAPI::Models::IndividualEvent::EventType]
-      #   #
-      #   def initialize(data: nil, event_type: nil, **) = super
-
-      # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-      class Data < FinchAPI::BaseModel
-        # @!attribute [r] individual_id
-        #   The ID of the individual related to the event.
-        #
-        #   @return [String, nil]
-        optional :individual_id, String
-
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :individual_id
-
-        # @!parse
-        #   # @param individual_id [String]
-        #   #
-        #   def initialize(individual_id: nil, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-
-      module EventType
-        extend FinchAPI::Enum
-
-        INDIVIDUAL_CREATED = :"individual.created"
-        INDIVIDUAL_UPDATED = :"individual.updated"
-        INDIVIDUAL_DELETED = :"individual.deleted"
-
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
-      end
-    end
-  end
-end

data/lib/finch-api/models/introspection.rb

@@ -1,312 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    class Introspection < FinchAPI::BaseModel
-      # @!attribute account_id
-      #   [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
-      #     instead of this account ID.
-      #
-      #   @return [String]
-      required :account_id, String
-
-      # @!attribute authentication_methods
-      #
-      #   @return [Array<FinchAPI::Models::Introspection::AuthenticationMethod>]
-      required :authentication_methods,
-               -> { FinchAPI::ArrayOf[FinchAPI::Models::Introspection::AuthenticationMethod] }
-
-      # @!attribute client_id
-      #   The client ID of the application associated with the `access_token`.
-      #
-      #   @return [String]
-      required :client_id, String
-
-      # @!attribute client_type
-      #   The type of application associated with a token.
-      #
-      #   @return [Symbol, FinchAPI::Models::Introspection::ClientType]
-      required :client_type, enum: -> { FinchAPI::Models::Introspection::ClientType }
-
-      # @!attribute company_id
-      #   [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
-      #     instead of this company ID.
-      #
-      #   @return [String]
-      required :company_id, String
-
-      # @!attribute connection_id
-      #   The Finch UUID of the connection associated with the `access_token`.
-      #
-      #   @return [String]
-      required :connection_id, String
-
-      # @!attribute connection_status
-      #
-      #   @return [FinchAPI::Models::Introspection::ConnectionStatus]
-      required :connection_status, -> { FinchAPI::Models::Introspection::ConnectionStatus }
-
-      # @!attribute connection_type
-      #   The type of the connection associated with the token.
-      #
-      #     - `provider` - connection to an external provider
-      #     - `finch` - finch-generated data.
-      #
-      #   @return [Symbol, FinchAPI::Models::Introspection::ConnectionType]
-      required :connection_type, enum: -> { FinchAPI::Models::Introspection::ConnectionType }
-
-      # @!attribute customer_email
-      #   The email of your customer you provided to Finch when a connect session was
-      #     created for this connection.
-      #
-      #   @return [String, nil]
-      required :customer_email, String, nil?: true
-
-      # @!attribute customer_id
-      #   The ID of your customer you provided to Finch when a connect session was created
-      #     for this connection.
-      #
-      #   @return [String, nil]
-      required :customer_id, String, nil?: true
-
-      # @!attribute customer_name
-      #   The name of your customer you provided to Finch when a connect session was
-      #     created for this connection.
-      #
-      #   @return [String, nil]
-      required :customer_name, String, nil?: true
-
-      # @!attribute manual
-      #   Whether the connection associated with the `access_token` uses the Assisted
-      #     Connect Flow. (`true` if using Assisted Connect, `false` if connection is
-      #     automated)
-      #
-      #   @return [Boolean]
-      required :manual, FinchAPI::BooleanModel
-
-      # @!attribute payroll_provider_id
-      #   [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll
-      #     provider ID.
-      #
-      #   @return [String]
-      required :payroll_provider_id, String
-
-      # @!attribute products
-      #   An array of the authorized products associated with the `access_token`.
-      #
-      #   @return [Array<String>]
-      required :products, FinchAPI::ArrayOf[String]
-
-      # @!attribute provider_id
-      #   The ID of the provider associated with the `access_token`.
-      #
-      #   @return [String]
-      required :provider_id, String
-
-      # @!attribute username
-      #   The account username used for login associated with the `access_token`.
-      #
-      #   @return [String]
-      required :username, String
-
-      # @!parse
-      #   # @param account_id [String]
-      #   # @param authentication_methods [Array<FinchAPI::Models::Introspection::AuthenticationMethod>]
-      #   # @param client_id [String]
-      #   # @param client_type [Symbol, FinchAPI::Models::Introspection::ClientType]
-      #   # @param company_id [String]
-      #   # @param connection_id [String]
-      #   # @param connection_status [FinchAPI::Models::Introspection::ConnectionStatus]
-      #   # @param connection_type [Symbol, FinchAPI::Models::Introspection::ConnectionType]
-      #   # @param customer_email [String, nil]
-      #   # @param customer_id [String, nil]
-      #   # @param customer_name [String, nil]
-      #   # @param manual [Boolean]
-      #   # @param payroll_provider_id [String]
-      #   # @param products [Array<String>]
-      #   # @param provider_id [String]
-      #   # @param username [String]
-      #   #
-      #   def initialize(
-      #     account_id:,
-      #     authentication_methods:,
-      #     client_id:,
-      #     client_type:,
-      #     company_id:,
-      #     connection_id:,
-      #     connection_status:,
-      #     connection_type:,
-      #     customer_email:,
-      #     customer_id:,
-      #     customer_name:,
-      #     manual:,
-      #     payroll_provider_id:,
-      #     products:,
-      #     provider_id:,
-      #     username:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-      class AuthenticationMethod < FinchAPI::BaseModel
-        # @!attribute [r] connection_status
-        #
-        #   @return [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, nil]
-        optional :connection_status,
-                 -> { FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus }
-
-        # @!parse
-        #   # @return [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus]
-        #   attr_writer :connection_status
-
-        # @!attribute [r] products
-        #   An array of the authorized products associated with the `access_token`.
-        #
-        #   @return [Array<String>, nil]
-        optional :products, FinchAPI::ArrayOf[String]
-
-        # @!parse
-        #   # @return [Array<String>]
-        #   attr_writer :products
-
-        # @!attribute [r] type
-        #   The type of authentication method.
-        #
-        #   @return [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type, nil]
-        optional :type, enum: -> { FinchAPI::Models::Introspection::AuthenticationMethod::Type }
-
-        # @!parse
-        #   # @return [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type]
-        #   attr_writer :type
-
-        # @!parse
-        #   # @param connection_status [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus]
-        #   # @param products [Array<String>]
-        #   # @param type [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type]
-        #   #
-        #   def initialize(connection_status: nil, products: nil, type: nil, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        class ConnectionStatus < FinchAPI::BaseModel
-          # @!attribute [r] message
-          #
-          #   @return [String, nil]
-          optional :message, String
-
-          # @!parse
-          #   # @return [String]
-          #   attr_writer :message
-
-          # @!attribute [r] status
-          #
-          #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
-          optional :status, enum: -> { FinchAPI::Models::ConnectionStatusType }
-
-          # @!parse
-          #   # @return [Symbol, FinchAPI::Models::ConnectionStatusType]
-          #   attr_writer :status
-
-          # @!parse
-          #   # @param message [String]
-          #   # @param status [Symbol, FinchAPI::Models::ConnectionStatusType]
-          #   #
-          #   def initialize(message: nil, status: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-        end
-
-        # The type of authentication method.
-        module Type
-          extend FinchAPI::Enum
-
-          ASSISTED = :assisted
-          CREDENTIAL = :credential
-          API_TOKEN = :api_token
-          API_CREDENTIAL = :api_credential
-          OAUTH = :oauth
-
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
-        end
-      end
-
-      # The type of application associated with a token.
-      module ClientType
-        extend FinchAPI::Enum
-
-        PRODUCTION = :production
-        DEVELOPMENT = :development
-        SANDBOX = :sandbox
-
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
-      end
-
-      class ConnectionStatus < FinchAPI::BaseModel
-        # @!attribute [r] last_successful_sync
-        #   The datetime when the connection was last successfully synced.
-        #
-        #   @return [Time, nil]
-        optional :last_successful_sync, Time
-
-        # @!parse
-        #   # @return [Time]
-        #   attr_writer :last_successful_sync
-
-        # @!attribute [r] message
-        #
-        #   @return [String, nil]
-        optional :message, String
-
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :message
-
-        # @!attribute [r] status
-        #
-        #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
-        optional :status, enum: -> { FinchAPI::Models::ConnectionStatusType }
-
-        # @!parse
-        #   # @return [Symbol, FinchAPI::Models::ConnectionStatusType]
-        #   attr_writer :status
-
-        # @!parse
-        #   # @param last_successful_sync [Time]
-        #   # @param message [String]
-        #   # @param status [Symbol, FinchAPI::Models::ConnectionStatusType]
-        #   #
-        #   def initialize(last_successful_sync: nil, message: nil, status: nil, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-
-      # The type of the connection associated with the token.
-      #
-      #   - `provider` - connection to an external provider
-      #   - `finch` - finch-generated data.
-      module ConnectionType
-        extend FinchAPI::Enum
-
-        PROVIDER = :provider
-        FINCH = :finch
-
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
-      end
-    end
-  end
-end

data/lib/finch-api/models/job_completion_event.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent
-      # @!attribute [r] data
-      #
-      #   @return [FinchAPI::Models::JobCompletionEvent::Data, nil]
-      optional :data, -> { FinchAPI::Models::JobCompletionEvent::Data }
-
-      # @!parse
-      #   # @return [FinchAPI::Models::JobCompletionEvent::Data]
-      #   attr_writer :data
-
-      # @!attribute [r] event_type
-      #
-      #   @return [Symbol, FinchAPI::Models::JobCompletionEvent::EventType, nil]
-      optional :event_type, enum: -> { FinchAPI::Models::JobCompletionEvent::EventType }
-
-      # @!parse
-      #   # @return [Symbol, FinchAPI::Models::JobCompletionEvent::EventType]
-      #   attr_writer :event_type
-
-      # @!parse
-      #   # @param data [FinchAPI::Models::JobCompletionEvent::Data]
-      #   # @param event_type [Symbol, FinchAPI::Models::JobCompletionEvent::EventType]
-      #   #
-      #   def initialize(data: nil, event_type: nil, **) = super
-
-      # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-      class Data < FinchAPI::BaseModel
-        # @!attribute job_id
-        #   The id of the job which has completed.
-        #
-        #   @return [String]
-        required :job_id, String
-
-        # @!attribute job_url
-        #   The url to query the result of the job.
-        #
-        #   @return [String]
-        required :job_url, String
-
-        # @!parse
-        #   # @param job_id [String]
-        #   # @param job_url [String]
-        #   #
-        #   def initialize(job_id:, job_url:, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-
-      module EventType
-        extend 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"
-
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
-      end
-    end
-  end
-end

data/lib/finch-api/models/jobs/automated_async_job.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module Jobs
-      class AutomatedAsyncJob < FinchAPI::BaseModel
-        # @!attribute completed_at
-        #   The datetime the job completed.
-        #
-        #   @return [Time, nil]
-        required :completed_at, Time, nil?: true
-
-        # @!attribute created_at
-        #   The datetime when the job was created. for scheduled jobs, this will be the
-        #     initial connection time. For ad-hoc jobs, this will be the time the creation
-        #     request was received.
-        #
-        #   @return [Time]
-        required :created_at, Time
-
-        # @!attribute job_id
-        #   The id of the job that has been created.
-        #
-        #   @return [String]
-        required :job_id, String
-
-        # @!attribute job_url
-        #   The url that can be used to retrieve the job status
-        #
-        #   @return [String]
-        required :job_url, String
-
-        # @!attribute params
-        #   The input parameters for the job.
-        #
-        #   @return [FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, nil]
-        required :params, -> { FinchAPI::Models::Jobs::AutomatedAsyncJob::Params }, nil?: true
-
-        # @!attribute scheduled_at
-        #   The datetime a job is scheduled to be run. For scheduled jobs, this datetime can
-        #     be in the future if the job has not yet been enqueued. For ad-hoc jobs, this
-        #     field will be null.
-        #
-        #   @return [Time, nil]
-        required :scheduled_at, Time, nil?: true
-
-        # @!attribute started_at
-        #   The datetime a job entered into the job queue.
-        #
-        #   @return [Time, nil]
-        required :started_at, Time, nil?: true
-
-        # @!attribute status
-        #
-        #   @return [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status]
-        required :status, enum: -> { FinchAPI::Models::Jobs::AutomatedAsyncJob::Status }
-
-        # @!attribute type
-        #   The type of automated job
-        #
-        #   @return [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type]
-        required :type, enum: -> { FinchAPI::Models::Jobs::AutomatedAsyncJob::Type }
-
-        # @!parse
-        #   # @param completed_at [Time, nil]
-        #   # @param created_at [Time]
-        #   # @param job_id [String]
-        #   # @param job_url [String]
-        #   # @param params [FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, nil]
-        #   # @param scheduled_at [Time, nil]
-        #   # @param started_at [Time, nil]
-        #   # @param status [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status]
-        #   # @param type [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type]
-        #   #
-        #   def initialize(completed_at:, created_at:, job_id:, job_url:, params:, scheduled_at:, started_at:, status:, type:, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        class Params < FinchAPI::BaseModel
-          # @!attribute [r] individual_id
-          #   The ID of the individual that the job was completed for.
-          #
-          #   @return [String, nil]
-          optional :individual_id, String
-
-          # @!parse
-          #   # @return [String]
-          #   attr_writer :individual_id
-
-          # @!parse
-          #   # The input parameters for the job.
-          #   #
-          #   # @param individual_id [String]
-          #   #
-          #   def initialize(individual_id: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-        end
-
-        module Status
-          extend FinchAPI::Enum
-
-          PENDING = :pending
-          IN_PROGRESS = :in_progress
-          COMPLETE = :complete
-          ERROR = :error
-          REAUTH_ERROR = :reauth_error
-          PERMISSIONS_ERROR = :permissions_error
-
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
-        end
-
-        # The type of automated job
-        module Type
-          extend FinchAPI::Enum
-
-          DATA_SYNC_ALL = :data_sync_all
-          W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync
-
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
-        end
-      end
-    end
-  end
-end