finch-api 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

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

@@ -48,20 +48,9 @@ module FinchAPI
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case event_type
-      # in :"individual.created"
-      #   # ...
-      # in :"individual.updated"
-      #   # ...
-      # in :"individual.deleted"
-      #   # ...
-      # end
-      # ```
-      class EventType < FinchAPI::Enum
+      module EventType
+        extend FinchAPI::Enum
+
         INDIVIDUAL_CREATED = :"individual.created"
         INDIVIDUAL_UPDATED = :"individual.updated"
         INDIVIDUAL_DELETED = :"individual.deleted"
@@ -70,7 +59,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

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

@@ -219,26 +219,10 @@ module FinchAPI
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
         end
 
-        # @abstract
-        #
         # The type of authentication method.
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :assisted
-        #   # ...
-        # in :credential
-        #   # ...
-        # in :api_token
-        #   # ...
-        # in :api_credential
-        #   # ...
-        # in :oauth
-        #   # ...
-        # end
-        # ```
-        class Type < FinchAPI::Enum
+        module Type
+          extend FinchAPI::Enum
+
           ASSISTED = :assisted
           CREDENTIAL = :credential
           API_TOKEN = :api_token
@@ -249,27 +233,14 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      # @abstract
-      #
       # The type of application associated with a token.
-      #
-      # @example
-      # ```ruby
-      # case client_type
-      # in :production
-      #   # ...
-      # in :development
-      #   # ...
-      # in :sandbox
-      #   # ...
-      # end
-      # ```
-      class ClientType < FinchAPI::Enum
+      module ClientType
+        extend FinchAPI::Enum
+
         PRODUCTION = :production
         DEVELOPMENT = :development
         SANDBOX = :sandbox
@@ -278,7 +249,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -310,23 +280,13 @@ module FinchAPI
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # The type of the connection associated with the token.
       #
       #   - `provider` - connection to an external provider
       #   - `finch` - finch-generated data.
-      #
-      # @example
-      # ```ruby
-      # case connection_type
-      # in :provider
-      #   # ...
-      # in :finch
-      #   # ...
-      # end
-      # ```
-      class ConnectionType < FinchAPI::Enum
+      module ConnectionType
+        extend FinchAPI::Enum
+
         PROVIDER = :provider
         FINCH = :finch
 
@@ -334,7 +294,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

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

@@ -51,26 +51,9 @@ module FinchAPI
         # 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
+      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"
@@ -82,7 +65,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

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

@@ -97,26 +97,9 @@ module FinchAPI
           # 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
+        module Status
+          extend FinchAPI::Enum
+
           PENDING = :pending
           IN_PROGRESS = :in_progress
           COMPLETE = :complete
@@ -128,24 +111,13 @@ module FinchAPI
 
           # @!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
+        module Type
+          extend FinchAPI::Enum
+
           DATA_SYNC_ALL = :data_sync_all
           W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync
 
@@ -153,7 +125,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

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

@@ -28,25 +28,16 @@ module FinchAPI
 
         # 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
+        module Type
+          extend FinchAPI::Enum
+
           W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync
 
           finalize!
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      class AutomatedListResponse < FinchAPI::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<FinchAPI::Models::Jobs::AutomatedAsyncJob>]
+        required :data, -> { FinchAPI::ArrayOf[FinchAPI::Models::Jobs::AutomatedAsyncJob] }
+
+        # @!attribute meta
+        #
+        #   @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta]
+        required :meta, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta }
+
+        # @!parse
+        #   # @param data [Array<FinchAPI::Models::Jobs::AutomatedAsyncJob>]
+        #   # @param meta [FinchAPI::Models::Jobs::AutomatedListResponse::Meta]
+        #   #
+        #   def initialize(data:, meta:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class Meta < FinchAPI::BaseModel
+          # @!attribute [r] quotas
+          #   Information about remaining quotas for this connection. Only applicable for
+          #     customers opted in to use Finch's Data Sync Refresh endpoint
+          #     (`POST /jobs/automated`). Please contact a Finch representative for more
+          #     details.
+          #
+          #   @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, nil]
+          optional :quotas, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas }
+
+          # @!parse
+          #   # @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas]
+          #   attr_writer :quotas
+
+          # @!parse
+          #   # @param quotas [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas]
+          #   #
+          #   def initialize(quotas: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          class Quotas < FinchAPI::BaseModel
+            # @!attribute [r] data_sync_all
+            #
+            #   @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, nil]
+            optional :data_sync_all, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll }
+
+            # @!parse
+            #   # @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll]
+            #   attr_writer :data_sync_all
+
+            # @!parse
+            #   # Information about remaining quotas for this connection. Only applicable for
+            #   #   customers opted in to use Finch's Data Sync Refresh endpoint
+            #   #   (`POST /jobs/automated`). Please contact a Finch representative for more
+            #   #   details.
+            #   #
+            #   # @param data_sync_all [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll]
+            #   #
+            #   def initialize(data_sync_all: nil, **) = super
+
+            # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+            class DataSyncAll < FinchAPI::BaseModel
+              # @!attribute [r] allowed_refreshes
+              #
+              #   @return [Integer, nil]
+              optional :allowed_refreshes, Integer
+
+              # @!parse
+              #   # @return [Integer]
+              #   attr_writer :allowed_refreshes
+
+              # @!attribute [r] remaining_refreshes
+              #
+              #   @return [Integer, nil]
+              optional :remaining_refreshes, Integer
+
+              # @!parse
+              #   # @return [Integer]
+              #   attr_writer :remaining_refreshes
+
+              # @!parse
+              #   # @param allowed_refreshes [Integer]
+              #   # @param remaining_refreshes [Integer]
+              #   #
+              #   def initialize(allowed_refreshes: nil, remaining_refreshes: nil, **) = super
+
+              # def initialize: (Hash | FinchAPI::BaseModel) -> void
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -29,22 +29,9 @@ module FinchAPI
 
         # 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
+        module Status
+          extend FinchAPI::Enum
+
           PENDING = :pending
           IN_PROGRESS = :in_progress
           ERROR = :error
@@ -54,7 +41,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

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

@@ -2,8 +2,6 @@
 
 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
@@ -11,21 +9,9 @@ module FinchAPI
     #     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
+    module OperationSupport
+      extend FinchAPI::Enum
+
       SUPPORTED = :supported
       NOT_SUPPORTED_BY_FINCH = :not_supported_by_finch
       NOT_SUPPORTED_BY_PROVIDER = :not_supported_by_provider
@@ -35,7 +21,6 @@ module FinchAPI
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end

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

@@ -59,20 +59,9 @@ module FinchAPI
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case event_type
-      # in :"pay_statement.created"
-      #   # ...
-      # in :"pay_statement.updated"
-      #   # ...
-      # in :"pay_statement.deleted"
-      #   # ...
-      # end
-      # ```
-      class EventType < FinchAPI::Enum
+      module EventType
+        extend FinchAPI::Enum
+
         PAY_STATEMENT_CREATED = :"pay_statement.created"
         PAY_STATEMENT_UPDATED = :"pay_statement.updated"
         PAY_STATEMENT_DELETED = :"pay_statement.deleted"
@@ -81,7 +70,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

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

@@ -51,20 +51,9 @@ module FinchAPI
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case event_type
-      # in :"payment.created"
-      #   # ...
-      # in :"payment.updated"
-      #   # ...
-      # in :"payment.deleted"
-      #   # ...
-      # end
-      # ```
-      class EventType < FinchAPI::Enum
+      module EventType
+        extend FinchAPI::Enum
+
         PAYMENT_CREATED = :"payment.created"
         PAYMENT_UPDATED = :"payment.updated"
         PAYMENT_DELETED = :"payment.deleted"
@@ -73,7 +62,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/finch-api/models/payroll/pay_group_list_response.rb

@@ -44,26 +44,9 @@ module FinchAPI
 
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case pay_frequency
-        # in :annually
-        #   # ...
-        # in :semi_annually
-        #   # ...
-        # in :quarterly
-        #   # ...
-        # in :monthly
-        #   # ...
-        # in :semi_monthly
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class PayFrequency < FinchAPI::Enum
+        module PayFrequency
+          extend FinchAPI::Enum
+
           ANNUALLY = :annually
           SEMI_ANNUALLY = :semi_annually
           QUARTERLY = :quarterly
@@ -78,7 +61,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/finch-api/models/payroll/pay_group_retrieve_response.rb

@@ -38,26 +38,9 @@ module FinchAPI
 
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case pay_frequency
-        # in :annually
-        #   # ...
-        # in :semi_annually
-        #   # ...
-        # in :quarterly
-        #   # ...
-        # in :monthly
-        #   # ...
-        # in :semi_monthly
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class PayFrequency < FinchAPI::Enum
+        module PayFrequency
+          extend FinchAPI::Enum
+
           ANNUALLY = :annually
           SEMI_ANNUALLY = :semi_annually
           QUARTERLY = :quarterly
@@ -72,7 +55,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

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

@@ -2000,26 +2000,10 @@ module FinchAPI
           end
         end
 
-        # @abstract
-        #
         # The type of authentication method.
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :assisted
-        #   # ...
-        # in :credential
-        #   # ...
-        # in :api_token
-        #   # ...
-        # in :api_credential
-        #   # ...
-        # in :oauth
-        #   # ...
-        # end
-        # ```
-        class Type < FinchAPI::Enum
+        module Type
+          extend FinchAPI::Enum
+
           ASSISTED = :assisted
           CREDENTIAL = :credential
           API_TOKEN = :api_token
@@ -2030,7 +2014,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end