finch-api 0.1.0.pre.alpha.1

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

@@ -0,0 +1,90 @@
+# 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
+
+      # @abstract
+      #
+      # @example
+      # ```ruby
+      # case event_type
+      # in :"job.benefit_create.completed"
+      #   # ...
+      # in :"job.benefit_enroll.completed"
+      #   # ...
+      # in :"job.benefit_register.completed"
+      #   # ...
+      # in :"job.benefit_unenroll.completed"
+      #   # ...
+      # in :"job.benefit_update.completed"
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      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"
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,162 @@
+# 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
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case status
+        # in :pending
+        #   # ...
+        # in :in_progress
+        #   # ...
+        # in :complete
+        #   # ...
+        # in :error
+        #   # ...
+        # in :reauth_error
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class Status < 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
+
+        # @abstract
+        #
+        # The type of automated job
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :data_sync_all
+        #   # ...
+        # in :w4_form_employee_sync
+        #   # ...
+        # end
+        # ```
+        class Type < 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

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      class AutomatedCreateParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute type
+        #   The type of job to start.
+        #
+        #   @return [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type]
+        required :type, enum: -> { FinchAPI::Models::Jobs::AutomatedCreateParams::Type }
+
+        # @!attribute params
+        #
+        #   @return [FinchAPI::Models::Jobs::AutomatedCreateParams::Params]
+        required :params, -> { FinchAPI::Models::Jobs::AutomatedCreateParams::Params }
+
+        # @!parse
+        #   # @param type [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type]
+        #   # @param params [FinchAPI::Models::Jobs::AutomatedCreateParams::Params]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(type:, params:, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # The type of job to start.
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :w4_form_employee_sync
+        #   # ...
+        # end
+        # ```
+        class Type < FinchAPI::Enum
+          W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        class Params < FinchAPI::BaseModel
+          # @!attribute individual_id
+          #   The unique ID of the individual for W-4 data sync.
+          #
+          #   @return [String]
+          required :individual_id, String
+
+          # @!parse
+          #   # @param individual_id [String]
+          #   #
+          #   def initialize(individual_id:, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      class AutomatedCreateResponse < FinchAPI::BaseModel
+        # @!attribute allowed_refreshes
+        #   The number of allowed refreshes per hour (per hour, fixed window)
+        #
+        #   @return [Integer]
+        required :allowed_refreshes, Integer
+
+        # @!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 remaining_refreshes
+        #   The number of remaining refreshes available (per hour, fixed window)
+        #
+        #   @return [Integer]
+        required :remaining_refreshes, Integer
+
+        # @!parse
+        #   # @param allowed_refreshes [Integer]
+        #   # @param job_id [String]
+        #   # @param job_url [String]
+        #   # @param remaining_refreshes [Integer]
+        #   #
+        #   def initialize(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      class AutomatedListParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute [r] limit
+        #   Number of items to return
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :limit
+
+        # @!attribute [r] offset
+        #   Index to start from (defaults to 0)
+        #
+        #   @return [Integer, nil]
+        optional :offset, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :offset
+
+        # @!parse
+        #   # @param limit [Integer]
+        #   # @param offset [Integer]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(limit: nil, offset: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      class AutomatedRetrieveParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!parse
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      class ManualAsyncJob < FinchAPI::BaseModel
+        # @!attribute body
+        #   Specific information about the job, such as individual statuses for batch jobs.
+        #
+        #   @return [Array<Object>, nil]
+        required :body, FinchAPI::ArrayOf[FinchAPI::Unknown], nil?: true
+
+        # @!attribute job_id
+        #
+        #   @return [String]
+        required :job_id, String
+
+        # @!attribute status
+        #
+        #   @return [Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status]
+        required :status, enum: -> { FinchAPI::Models::Jobs::ManualAsyncJob::Status }
+
+        # @!parse
+        #   # @param body [Array<Object>, nil]
+        #   # @param job_id [String]
+        #   # @param status [Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status]
+        #   #
+        #   def initialize(body:, job_id:, status:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case status
+        # in :pending
+        #   # ...
+        # in :in_progress
+        #   # ...
+        # in :error
+        #   # ...
+        # in :complete
+        #   # ...
+        # end
+        # ```
+        class Status < FinchAPI::Enum
+          PENDING = :pending
+          IN_PROGRESS = :in_progress
+          ERROR = :error
+          COMPLETE = :complete
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      class ManualRetrieveParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!parse
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Location < FinchAPI::BaseModel
+      # @!attribute city
+      #   City, district, suburb, town, or village.
+      #
+      #   @return [String, nil]
+      optional :city, String, nil?: true
+
+      # @!attribute country
+      #   The 2-letter ISO 3166 country code.
+      #
+      #   @return [String, nil]
+      optional :country, String, nil?: true
+
+      # @!attribute line1
+      #   Street address or PO box.
+      #
+      #   @return [String, nil]
+      optional :line1, String, nil?: true
+
+      # @!attribute line2
+      #   Apartment, suite, unit, or building.
+      #
+      #   @return [String, nil]
+      optional :line2, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute postal_code
+      #   The postal code or zip code.
+      #
+      #   @return [String, nil]
+      optional :postal_code, String, nil?: true
+
+      # @!attribute source_id
+      #
+      #   @return [String, nil]
+      optional :source_id, String, nil?: true
+
+      # @!attribute state
+      #   The state code.
+      #
+      #   @return [String, nil]
+      optional :state, String, nil?: true
+
+      # @!parse
+      #   # @param city [String, nil]
+      #   # @param country [String, nil]
+      #   # @param line1 [String, nil]
+      #   # @param line2 [String, nil]
+      #   # @param name [String, nil]
+      #   # @param postal_code [String, nil]
+      #   # @param source_id [String, nil]
+      #   # @param state [String, nil]
+      #   #
+      #   def initialize(
+      #     city: nil,
+      #     country: nil,
+      #     line1: nil,
+      #     line2: nil,
+      #     name: nil,
+      #     postal_code: nil,
+      #     source_id: nil,
+      #     state: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Money < FinchAPI::BaseModel
+      # @!attribute amount
+      #   Amount for money object (in cents)
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer, nil?: true
+
+      # @!attribute [r] currency
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :currency
+
+      # @!parse
+      #   # @param amount [Integer, nil]
+      #   # @param currency [String]
+      #   #
+      #   def initialize(amount: nil, currency: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @abstract
+    #
+    # - `supported`: This operation is supported by both the provider and Finch
+    #   - `not_supported_by_finch`: This operation is not supported by Finch but
+    #     supported by the provider
+    #   - `not_supported_by_provider`: This operation is not supported by the provider,
+    #     so Finch cannot support
+    #   - `client_access_only`: This behavior is supported by the provider, but only
+    #     available to the client and not to Finch
+    #
+    # @example
+    # ```ruby
+    # case operation_support
+    # in :supported
+    #   # ...
+    # in :not_supported_by_finch
+    #   # ...
+    # in :not_supported_by_provider
+    #   # ...
+    # in :client_access_only
+    #   # ...
+    # end
+    # ```
+    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
+
+      finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   #
+      #   def self.values; end
+    end
+  end
+end