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

data/lib/finch_api/models/base_webhook_event.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   @deprecated
+      #
+      #   [DEPRECATED] Unique Finch ID of the employer account used to make this
+      #   connection. Use `connection_id` instead to identify the connection associated
+      #   with this event.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute company_id
+      #   @deprecated
+      #
+      #   [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
+      #   `connection_id` instead to identify the connection associated with this event.
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute connection_id
+      #   Unique Finch ID of the connection associated with the webhook event.
+      #
+      #   @return [String, nil]
+      optional :connection_id, String
+
+      # @!method initialize(account_id:, company_id:, connection_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::BaseWebhookEvent} for more details.
+      #
+      #   @param account_id [String] [DEPRECATED] Unique Finch ID of the employer account used to make this connectio
+      #   ...
+      #
+      #   @param company_id [String] [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
+      #   ...
+      #
+      #   @param connection_id [String] Unique Finch ID of the connection associated with the webhook event.
+    end
+  end
+end

data/lib/finch_api/models/company_event.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class CompanyEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown], nil?: true
+
+      # @!attribute event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::CompanyEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::CompanyEvent::EventType }
+
+      # @!method initialize(data: nil, event_type: nil)
+      #   @param data [Hash{Symbol=>Object}, nil]
+      #   @param event_type [Symbol, FinchAPI::Models::CompanyEvent::EventType]
+
+      module EventType
+        extend FinchAPI::Internal::Type::Enum
+
+        COMPANY_UPDATED = :"company.updated"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/finch_api/models/connect/session_new_params.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Connect
+      # @see FinchAPI::Resources::Connect::Sessions#new
+      class SessionNewParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute customer_name
+        #
+        #   @return [String]
+        required :customer_name, String
+
+        # @!attribute products
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
+        required :products,
+                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::Connect::SessionNewParams::Product] }
+
+        # @!attribute customer_email
+        #
+        #   @return [String, nil]
+        optional :customer_email, String, nil?: true
+
+        # @!attribute integration
+        #
+        #   @return [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
+        optional :integration, -> { FinchAPI::Models::Connect::SessionNewParams::Integration }, nil?: true
+
+        # @!attribute manual
+        #
+        #   @return [Boolean, nil]
+        optional :manual, FinchAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute minutes_to_expire
+        #   The number of minutes until the session expires (defaults to 43,200, which is 30
+        #   days)
+        #
+        #   @return [Float, nil]
+        optional :minutes_to_expire, Float, nil?: true
+
+        # @!attribute redirect_uri
+        #
+        #   @return [String, nil]
+        optional :redirect_uri, String, nil?: true
+
+        # @!attribute sandbox
+        #
+        #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
+        optional :sandbox, enum: -> { FinchAPI::Models::Connect::SessionNewParams::Sandbox }, nil?: true
+
+        # @!method initialize(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Connect::SessionNewParams} for more details.
+        #
+        #   @param customer_id [String]
+        #
+        #   @param customer_name [String]
+        #
+        #   @param products [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
+        #
+        #   @param customer_email [String, nil]
+        #
+        #   @param integration [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
+        #
+        #   @param manual [Boolean, nil]
+        #
+        #   @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
+        #   ...
+        #
+        #   @param redirect_uri [String, nil]
+        #
+        #   @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The Finch products that can be requested during the Connect flow.
+        module Product
+          extend FinchAPI::Internal::Type::Enum
+
+          COMPANY = :company
+          DIRECTORY = :directory
+          INDIVIDUAL = :individual
+          EMPLOYMENT = :employment
+          PAYMENT = :payment
+          PAY_STATEMENT = :pay_statement
+          BENEFITS = :benefits
+          SSN = :ssn
+          DEDUCTION = :deduction
+          DOCUMENTS = :documents
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Integration < FinchAPI::Internal::Type::BaseModel
+          # @!attribute auth_method
+          #
+          #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
+          optional :auth_method,
+                   enum: -> { FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod },
+                   nil?: true
+
+          # @!attribute provider
+          #
+          #   @return [String, nil]
+          optional :provider, String, nil?: true
+
+          # @!method initialize(auth_method: nil, provider: nil)
+          #   @param auth_method [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
+          #   @param provider [String, nil]
+
+          # @see FinchAPI::Models::Connect::SessionNewParams::Integration#auth_method
+          module AuthMethod
+            extend FinchAPI::Internal::Type::Enum
+
+            ASSISTED = :assisted
+            CREDENTIAL = :credential
+            OAUTH = :oauth
+            API_TOKEN = :api_token
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        module Sandbox
+          extend FinchAPI::Internal::Type::Enum
+
+          FINCH = :finch
+          PROVIDER = :provider
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/connect/session_new_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Connect
+      # @see FinchAPI::Resources::Connect::Sessions#new
+      class SessionNewResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute connect_url
+        #   The Connect URL to redirect the user to for authentication
+        #
+        #   @return [String]
+        required :connect_url, String
+
+        # @!attribute session_id
+        #   The unique identifier for the created connect session
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!method initialize(connect_url:, session_id:)
+        #   @param connect_url [String] The Connect URL to redirect the user to for authentication
+        #
+        #   @param session_id [String] The unique identifier for the created connect session
+      end
+    end
+  end
+end

data/lib/finch_api/models/connect/session_reauthenticate_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Connect
+      # @see FinchAPI::Resources::Connect::Sessions#reauthenticate
+      class SessionReauthenticateParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute connection_id
+        #   The ID of the existing connection to reauthenticate
+        #
+        #   @return [String]
+        required :connection_id, String
+
+        # @!attribute minutes_to_expire
+        #   The number of minutes until the session expires (defaults to 43,200, which is 30
+        #   days)
+        #
+        #   @return [Integer, nil]
+        optional :minutes_to_expire, Integer, nil?: true
+
+        # @!attribute products
+        #   The products to request access to (optional for reauthentication)
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil]
+        optional :products,
+                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::Connect::SessionReauthenticateParams::Product] },
+                 nil?: true
+
+        # @!attribute redirect_uri
+        #   The URI to redirect to after the Connect flow is completed
+        #
+        #   @return [String, nil]
+        optional :redirect_uri, String, nil?: true
+
+        # @!method initialize(connection_id:, minutes_to_expire: nil, products: nil, redirect_uri: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Connect::SessionReauthenticateParams} for more details.
+        #
+        #   @param connection_id [String] The ID of the existing connection to reauthenticate
+        #
+        #   @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
+        #   ...
+        #
+        #   @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
+        #
+        #   @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The Finch products that can be requested during the Connect flow.
+        module Product
+          extend FinchAPI::Internal::Type::Enum
+
+          COMPANY = :company
+          DIRECTORY = :directory
+          INDIVIDUAL = :individual
+          EMPLOYMENT = :employment
+          PAYMENT = :payment
+          PAY_STATEMENT = :pay_statement
+          BENEFITS = :benefits
+          SSN = :ssn
+          DEDUCTION = :deduction
+          DOCUMENTS = :documents
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/connect/session_reauthenticate_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Connect
+      # @see FinchAPI::Resources::Connect::Sessions#reauthenticate
+      class SessionReauthenticateResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute connect_url
+        #   The Connect URL to redirect the user to for reauthentication
+        #
+        #   @return [String]
+        required :connect_url, String
+
+        # @!attribute session_id
+        #   The unique identifier for the created connect session
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!method initialize(connect_url:, session_id:)
+        #   @param connect_url [String] The Connect URL to redirect the user to for reauthentication
+        #
+        #   @param session_id [String] The unique identifier for the created connect session
+      end
+    end
+  end
+end

data/lib/finch_api/models/connection_status_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module ConnectionStatusType
+      extend FinchAPI::Internal::Type::Enum
+
+      PENDING = :pending
+      PROCESSING = :processing
+      CONNECTED = :connected
+      ERROR_NO_ACCOUNT_SETUP = :error_no_account_setup
+      ERROR_PERMISSIONS = :error_permissions
+      REAUTH = :reauth
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/finch_api/models/create_access_token_response.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @see FinchAPI::Resources::AccessTokens#create
+    class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
+      # @!attribute access_token
+      #   The access token for the connection.
+      #
+      #   @return [String]
+      required :access_token, String
+
+      # @!attribute account_id
+      #   @deprecated
+      #
+      #   [DEPRECATED] Use `connection_id` to identify the connection instead of this
+      #   account ID.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute client_type
+      #   The type of application associated with a token.
+      #
+      #   @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType]
+      required :client_type, enum: -> { FinchAPI::Models::CreateAccessTokenResponse::ClientType }
+
+      # @!attribute company_id
+      #   @deprecated
+      #
+      #   [DEPRECATED] Use `connection_id` to identify the 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_type
+      #   The type of the connection associated with the token.
+      #
+      #   - `provider` - connection to an external provider
+      #   - `finch` - finch-generated data.
+      #
+      #   @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType]
+      required :connection_type, enum: -> { FinchAPI::Models::CreateAccessTokenResponse::ConnectionType }
+
+      # @!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 customer_id
+      #   The ID of your customer you provided to Finch when a connect session was created
+      #   for this connection.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute token_type
+      #   The RFC 8693 token type (Finch uses `bearer` tokens)
+      #
+      #   @return [String, nil]
+      optional :token_type, String
+
+      # @!method initialize(access_token:, account_id:, client_type:, company_id:, connection_id:, connection_type:, products:, provider_id:, customer_id: nil, token_type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::CreateAccessTokenResponse} for more details.
+      #
+      #   @param access_token [String] The access token for the connection.
+      #
+      #   @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
+      #   ...
+      #
+      #   @param client_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
+      #
+      #   @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
+      #   ...
+      #
+      #   @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
+      #
+      #   @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token. ...
+      #
+      #   @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 customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
+      #   ...
+      #
+      #   @param token_type [String] The RFC 8693 token type (Finch uses `bearer` tokens)
+
+      # The type of application associated with a token.
+      #
+      # @see FinchAPI::Models::CreateAccessTokenResponse#client_type
+      module ClientType
+        extend FinchAPI::Internal::Type::Enum
+
+        PRODUCTION = :production
+        DEVELOPMENT = :development
+        SANDBOX = :sandbox
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of the connection associated with the token.
+      #
+      # - `provider` - connection to an external provider
+      # - `finch` - finch-generated data.
+      #
+      # @see FinchAPI::Models::CreateAccessTokenResponse#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/directory_event.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute data
+      #
+      #   @return [FinchAPI::Models::DirectoryEvent::Data, nil]
+      optional :data, -> { FinchAPI::Models::DirectoryEvent::Data }
+
+      # @!attribute event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::DirectoryEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::DirectoryEvent::EventType }
+
+      # @!method initialize(data: nil, event_type: nil)
+      #   @param data [FinchAPI::Models::DirectoryEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::DirectoryEvent::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
+
+        DIRECTORY_CREATED = :"directory.created"
+        DIRECTORY_UPDATED = :"directory.updated"
+        DIRECTORY_DELETED = :"directory.deleted"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/finch_api/models/disconnect_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @see FinchAPI::Resources::Account#disconnect
+    class DisconnectResponse < FinchAPI::Internal::Type::BaseModel
+      # @!attribute status
+      #   If the request is successful, Finch will return “success” (HTTP 200 status).
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!method initialize(status:)
+      #   @param status [String] If the request is successful, Finch will return “success” (HTTP 200 status).
+    end
+  end
+end

data/lib/finch_api/models/employment_event.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute data
+      #
+      #   @return [FinchAPI::Models::EmploymentEvent::Data, nil]
+      optional :data, -> { FinchAPI::Models::EmploymentEvent::Data }
+
+      # @!attribute event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::EmploymentEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::EmploymentEvent::EventType }
+
+      # @!method initialize(data: nil, event_type: nil)
+      #   @param data [FinchAPI::Models::EmploymentEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::EmploymentEvent::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
+
+        EMPLOYMENT_CREATED = :"employment.created"
+        EMPLOYMENT_UPDATED = :"employment.updated"
+        EMPLOYMENT_DELETED = :"employment.deleted"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/benefit_contribution.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitContribution < FinchAPI::Internal::Type::BaseModel
+        # @!attribute amount
+        #   Contribution amount in cents (if `fixed`) or basis points (if `percent`).
+        #
+        #   @return [Integer, nil]
+        optional :amount, Integer, nil?: true
+
+        # @!attribute type
+        #   Contribution type.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil]
+        optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitContribution::Type }, nil?: true
+
+        # @!method initialize(amount: nil, type: nil)
+        #   @param amount [Integer, nil] Contribution amount in cents (if `fixed`) or basis points (if `percent`).
+        #
+        #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil] Contribution type.
+
+        # Contribution type.
+        #
+        # @see FinchAPI::Models::HRIS::BenefitContribution#type
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          FIXED = :fixed
+          PERCENT = :percent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end