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

data/lib/finch_api/models/individual_event.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class IndividualEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute data
+      #
+      #   @return [FinchAPI::IndividualEvent::Data, nil]
+      optional :data, -> { FinchAPI::IndividualEvent::Data }
+
+      # @!attribute event_type
+      #
+      #   @return [Symbol, FinchAPI::IndividualEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::IndividualEvent::EventType }
+
+      # @!method initialize(data: nil, event_type: nil)
+      #   @param data [FinchAPI::IndividualEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::IndividualEvent::EventType]
+
+      class Data < FinchAPI::Internal::Type::BaseModel
+        # @!attribute individual_id
+        #   The ID of the individual related to the event.
+        #
+        #   @return [String, nil]
+        optional :individual_id, String
+
+        # @!method initialize(individual_id: nil)
+        #   @param individual_id [String] The ID of the individual related to the event.
+      end
+
+      module EventType
+        extend FinchAPI::Internal::Type::Enum
+
+        INDIVIDUAL_CREATED = :"individual.created"
+        INDIVIDUAL_UPDATED = :"individual.updated"
+        INDIVIDUAL_DELETED = :"individual.deleted"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/finch_api/models/introspection.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @see FinchAPI::Resources::Account#introspect
+    class Introspection < FinchAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Finch UUID of the token being introspected.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   @deprecated
+      #
+      #   [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::Introspection::AuthenticationMethod>]
+      required :authentication_methods,
+               -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::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::Introspection::ClientType]
+      required :client_type, enum: -> { FinchAPI::Introspection::ClientType }
+
+      # @!attribute company_id
+      #   @deprecated
+      #
+      #   [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::Introspection::ConnectionStatus]
+      required :connection_status, -> { FinchAPI::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::Introspection::ConnectionType]
+      required :connection_type, enum: -> { FinchAPI::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::Internal::Type::Boolean
+
+      # @!attribute payroll_provider_id
+      #   @deprecated
+      #
+      #   [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::Internal::Type::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
+
+      # @!method initialize(id:, 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:)
+      #   Some parameter documentations has been truncated, see {FinchAPI::Introspection}
+      #   for more details.
+      #
+      #   @param id [String] The Finch UUID of the token being introspected.
+      #
+      #   @param account_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins
+      #
+      #   @param authentication_methods [Array<FinchAPI::Introspection::AuthenticationMethod>]
+      #
+      #   @param client_id [String] The client ID of the application associated with the `access_token`.
+      #
+      #   @param client_type [Symbol, FinchAPI::Introspection::ClientType] The type of application associated with a token.
+      #
+      #   @param company_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins
+      #
+      #   @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
+      #
+      #   @param connection_status [FinchAPI::Introspection::ConnectionStatus]
+      #
+      #   @param connection_type [Symbol, FinchAPI::Introspection::ConnectionType] The type of the connection associated with the token.
+      #
+      #   @param customer_email [String, nil] The email of your customer you provided to Finch when a connect session was crea
+      #
+      #   @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
+      #
+      #   @param customer_name [String, nil] The name of your customer you provided to Finch when a connect session was creat
+      #
+      #   @param manual [Boolean] Whether the connection associated with the `access_token` uses the Assisted Conn
+      #
+      #   @param payroll_provider_id [String] [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll
+      #
+      #   @param products [Array<String>] An array of the authorized products associated with the `access_token`.
+      #
+      #   @param provider_id [String] The ID of the provider associated with the `access_token`.
+      #
+      #   @param username [String] The account username used for login associated with the `access_token`.
+
+      class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
+        # @!attribute connection_status
+        #
+        #   @return [FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus, nil]
+        optional :connection_status, -> { FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus }
+
+        # @!attribute products
+        #   An array of the authorized products associated with the `access_token`.
+        #
+        #   @return [Array<String>, nil]
+        optional :products, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!attribute type
+        #   The type of authentication method.
+        #
+        #   @return [Symbol, FinchAPI::Introspection::AuthenticationMethod::Type, nil]
+        optional :type, enum: -> { FinchAPI::Introspection::AuthenticationMethod::Type }
+
+        # @!method initialize(connection_status: nil, products: nil, type: nil)
+        #   @param connection_status [FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus]
+        #
+        #   @param products [Array<String>] An array of the authorized products associated with the `access_token`.
+        #
+        #   @param type [Symbol, FinchAPI::Introspection::AuthenticationMethod::Type] The type of authentication method.
+
+        # @see FinchAPI::Introspection::AuthenticationMethod#connection_status
+        class ConnectionStatus < FinchAPI::Internal::Type::BaseModel
+          # @!attribute message
+          #
+          #   @return [String, nil]
+          optional :message, String
+
+          # @!attribute status
+          #
+          #   @return [Symbol, FinchAPI::ConnectionStatusType, nil]
+          optional :status, enum: -> { FinchAPI::ConnectionStatusType }
+
+          # @!method initialize(message: nil, status: nil)
+          #   @param message [String]
+          #   @param status [Symbol, FinchAPI::ConnectionStatusType]
+        end
+
+        # The type of authentication method.
+        #
+        # @see FinchAPI::Introspection::AuthenticationMethod#type
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          ASSISTED = :assisted
+          CREDENTIAL = :credential
+          API_TOKEN = :api_token
+          API_CREDENTIAL = :api_credential
+          OAUTH = :oauth
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The type of application associated with a token.
+      #
+      # @see FinchAPI::Introspection#client_type
+      module ClientType
+        extend FinchAPI::Internal::Type::Enum
+
+        PRODUCTION = :production
+        DEVELOPMENT = :development
+        SANDBOX = :sandbox
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see FinchAPI::Introspection#connection_status
+      class ConnectionStatus < FinchAPI::Internal::Type::BaseModel
+        # @!attribute last_successful_sync
+        #   The datetime when the connection was last successfully synced.
+        #
+        #   @return [Time, nil]
+        optional :last_successful_sync, Time
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute status
+        #
+        #   @return [Symbol, FinchAPI::ConnectionStatusType, nil]
+        optional :status, enum: -> { FinchAPI::ConnectionStatusType }
+
+        # @!method initialize(last_successful_sync: nil, message: nil, status: nil)
+        #   @param last_successful_sync [Time] The datetime when the connection was last successfully synced.
+        #
+        #   @param message [String]
+        #
+        #   @param status [Symbol, FinchAPI::ConnectionStatusType]
+      end
+
+      # The type of the connection associated with the token.
+      #
+      # - `provider` - connection to an external provider
+      # - `finch` - finch-generated data.
+      #
+      # @see FinchAPI::Introspection#connection_type
+      module ConnectionType
+        extend FinchAPI::Internal::Type::Enum
+
+        PROVIDER = :provider
+        FINCH = :finch
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/finch_api/models/job_completion_event.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute data
+      #
+      #   @return [FinchAPI::JobCompletionEvent::Data, nil]
+      optional :data, -> { FinchAPI::JobCompletionEvent::Data }
+
+      # @!attribute event_type
+      #
+      #   @return [Symbol, FinchAPI::JobCompletionEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::JobCompletionEvent::EventType }
+
+      # @!method initialize(data: nil, event_type: nil)
+      #   @param data [FinchAPI::JobCompletionEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::JobCompletionEvent::EventType]
+
+      class Data < FinchAPI::Internal::Type::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
+
+        # @!method initialize(job_id:, job_url:)
+        #   @param job_id [String] The id of the job which has completed.
+        #
+        #   @param job_url [String] The url to query the result of the job.
+      end
+
+      module EventType
+        extend FinchAPI::Internal::Type::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"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/finch_api/models/jobs/automated_async_job.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      # @see FinchAPI::Resources::Jobs::Automated#retrieve
+      class AutomatedAsyncJob < FinchAPI::Internal::Type::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::Jobs::AutomatedAsyncJob::Params, nil]
+        required :params, -> { FinchAPI::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::Jobs::AutomatedAsyncJob::Status]
+        required :status, enum: -> { FinchAPI::Jobs::AutomatedAsyncJob::Status }
+
+        # @!attribute type
+        #   The type of automated job
+        #
+        #   @return [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Type]
+        required :type, enum: -> { FinchAPI::Jobs::AutomatedAsyncJob::Type }
+
+        # @!method initialize(completed_at:, created_at:, job_id:, job_url:, params:, scheduled_at:, started_at:, status:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Jobs::AutomatedAsyncJob} for more details.
+        #
+        #   @param completed_at [Time, nil] The datetime the job completed.
+        #
+        #   @param created_at [Time] The datetime when the job was created. for scheduled jobs, this will be the init
+        #
+        #   @param job_id [String] The id of the job that has been created.
+        #
+        #   @param job_url [String] The url that can be used to retrieve the job status
+        #
+        #   @param params [FinchAPI::Jobs::AutomatedAsyncJob::Params, nil] The input parameters for the job.
+        #
+        #   @param scheduled_at [Time, nil] The datetime a job is scheduled to be run. For scheduled jobs, this datetime can
+        #
+        #   @param started_at [Time, nil] The datetime a job entered into the job queue.
+        #
+        #   @param status [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Status]
+        #
+        #   @param type [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Type] The type of automated job
+
+        # @see FinchAPI::Jobs::AutomatedAsyncJob#params
+        class Params < FinchAPI::Internal::Type::BaseModel
+          # @!attribute individual_id
+          #   The ID of the individual that the job was completed for.
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!method initialize(individual_id: nil)
+          #   The input parameters for the job.
+          #
+          #   @param individual_id [String] The ID of the individual that the job was completed for.
+        end
+
+        # @see FinchAPI::Jobs::AutomatedAsyncJob#status
+        module Status
+          extend FinchAPI::Internal::Type::Enum
+
+          PENDING = :pending
+          IN_PROGRESS = :in_progress
+          COMPLETE = :complete
+          ERROR = :error
+          REAUTH_ERROR = :reauth_error
+          PERMISSIONS_ERROR = :permissions_error
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The type of automated job
+        #
+        # @see FinchAPI::Jobs::AutomatedAsyncJob#type
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          DATA_SYNC_ALL = :data_sync_all
+          W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/jobs/automated_create_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      # @see FinchAPI::Resources::Jobs::Automated#create
+      class AutomatedCreateParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute type
+        #   The type of job to start.
+        #
+        #   @return [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type]
+        required :type, enum: -> { FinchAPI::Jobs::AutomatedCreateParams::Type }
+
+        # @!attribute params
+        #
+        #   @return [FinchAPI::Jobs::AutomatedCreateParams::Params]
+        required :params, -> { FinchAPI::Jobs::AutomatedCreateParams::Params }
+
+        # @!method initialize(type:, params:, request_options: {})
+        #   @param type [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type] The type of job to start.
+        #
+        #   @param params [FinchAPI::Jobs::AutomatedCreateParams::Params]
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The type of job to start.
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Params < FinchAPI::Internal::Type::BaseModel
+          # @!attribute individual_id
+          #   The unique ID of the individual for W-4 data sync.
+          #
+          #   @return [String]
+          required :individual_id, String
+
+          # @!method initialize(individual_id:)
+          #   @param individual_id [String] The unique ID of the individual for W-4 data sync.
+        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
+      # @see FinchAPI::Resources::Jobs::Automated#create
+      class AutomatedCreateResponse < FinchAPI::Internal::Type::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
+
+        # @!method initialize(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:)
+        #   @param allowed_refreshes [Integer] The number of allowed refreshes per hour (per hour, fixed window)
+        #
+        #   @param job_id [String] The id of the job that has been created.
+        #
+        #   @param job_url [String] The url that can be used to retrieve the job status
+        #
+        #   @param remaining_refreshes [Integer] The number of remaining refreshes available (per hour, fixed window)
+      end
+    end
+  end
+end

data/lib/finch_api/models/jobs/automated_list_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Jobs
+      # @see FinchAPI::Resources::Jobs::Automated#list
+      class AutomatedListParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute limit
+        #   Number of items to return
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute offset
+        #   Index to start from (defaults to 0)
+        #
+        #   @return [Integer, nil]
+        optional :offset, Integer
+
+        # @!method initialize(limit: nil, offset: nil, request_options: {})
+        #   @param limit [Integer] Number of items to return
+        #
+        #   @param offset [Integer] Index to start from (defaults to 0)
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end