finch-api 0.1.0.pre.alpha.1

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class BaseWebhookEvent < FinchAPI::BaseModel
+      # @!attribute account_id
+      #   [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] 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 [r] connection_id
+      #   Unique Finch ID of the connection associated with the webhook event.
+      #
+      #   @return [String, nil]
+      optional :connection_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :connection_id
+
+      # @!parse
+      #   # @param account_id [String]
+      #   # @param company_id [String]
+      #   # @param connection_id [String]
+      #   #
+      #   def initialize(account_id:, company_id:, connection_id: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class CompanyEvent < FinchAPI::Models::BaseWebhookEvent
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, FinchAPI::HashOf[FinchAPI::Unknown], nil?: true
+
+      # @!attribute [r] event_type
+      #
+      #   @return [Symbol, FinchAPI::Models::CompanyEvent::EventType, nil]
+      optional :event_type, enum: -> { FinchAPI::Models::CompanyEvent::EventType }
+
+      # @!parse
+      #   # @return [Symbol, FinchAPI::Models::CompanyEvent::EventType]
+      #   attr_writer :event_type
+
+      # @!parse
+      #   # @param data [Hash{Symbol=>Object}, nil]
+      #   # @param event_type [Symbol, FinchAPI::Models::CompanyEvent::EventType]
+      #   #
+      #   def initialize(data: nil, event_type: nil, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+      # @abstract
+      #
+      # @example
+      # ```ruby
+      # case event_type
+      # in :"company.updated"
+      #   # ...
+      # end
+      # ```
+      class EventType < FinchAPI::Enum
+        COMPANY_UPDATED = :"company.updated"
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/finch-api/models/connect/session_new_params.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Connect
+      class SessionNewParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::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::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::BooleanModel, 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
+
+        # @!parse
+        #   # @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]
+        #   # @param redirect_uri [String, nil]
+        #   # @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(
+        #     customer_id:,
+        #     customer_name:,
+        #     products:,
+        #     customer_email: nil,
+        #     integration: nil,
+        #     manual: nil,
+        #     minutes_to_expire: nil,
+        #     redirect_uri: nil,
+        #     sandbox: nil,
+        #     request_options: {},
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # The Finch products that can be requested during the Connect flow.
+        #
+        # @example
+        # ```ruby
+        # case product
+        # in :company
+        #   # ...
+        # in :directory
+        #   # ...
+        # in :individual
+        #   # ...
+        # in :employment
+        #   # ...
+        # in :payment
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class Product < FinchAPI::Enum
+          COMPANY = :company
+          DIRECTORY = :directory
+          INDIVIDUAL = :individual
+          EMPLOYMENT = :employment
+          PAYMENT = :payment
+          PAY_STATEMENT = :pay_statement
+          BENEFITS = :benefits
+          SSN = :ssn
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        class Integration < FinchAPI::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
+
+          # @!parse
+          #   # @param auth_method [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
+          #   # @param provider [String, nil]
+          #   #
+          #   def initialize(auth_method: nil, provider: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case auth_method
+          # in :assisted
+          #   # ...
+          # in :credential
+          #   # ...
+          # in :oauth
+          #   # ...
+          # in :api_token
+          #   # ...
+          # end
+          # ```
+          class AuthMethod < FinchAPI::Enum
+            ASSISTED = :assisted
+            CREDENTIAL = :credential
+            OAUTH = :oauth
+            API_TOKEN = :api_token
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case sandbox
+        # in :finch
+        #   # ...
+        # in :provider
+        #   # ...
+        # end
+        # ```
+        class Sandbox < FinchAPI::Enum
+          FINCH = :finch
+          PROVIDER = :provider
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/connect/session_new_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Connect
+      class SessionNewResponse < FinchAPI::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
+
+        # @!parse
+        #   # @param connect_url [String]
+        #   # @param session_id [String]
+        #   #
+        #   def initialize(connect_url:, session_id:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/connect/session_reauthenticate_params.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Connect
+      class SessionReauthenticateParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::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::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
+
+        # @!parse
+        #   # @param connection_id [String]
+        #   # @param minutes_to_expire [Integer, nil]
+        #   # @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil]
+        #   # @param redirect_uri [String, nil]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(connection_id:, minutes_to_expire: nil, products: nil, redirect_uri: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # The Finch products that can be requested during the Connect flow.
+        #
+        # @example
+        # ```ruby
+        # case product
+        # in :company
+        #   # ...
+        # in :directory
+        #   # ...
+        # in :individual
+        #   # ...
+        # in :employment
+        #   # ...
+        # in :payment
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class Product < FinchAPI::Enum
+          COMPANY = :company
+          DIRECTORY = :directory
+          INDIVIDUAL = :individual
+          EMPLOYMENT = :employment
+          PAYMENT = :payment
+          PAY_STATEMENT = :pay_statement
+          BENEFITS = :benefits
+          SSN = :ssn
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/connect/session_reauthenticate_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Connect
+      class SessionReauthenticateResponse < FinchAPI::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
+
+        # @!parse
+        #   # @param connect_url [String]
+        #   # @param session_id [String]
+        #   #
+        #   def initialize(connect_url:, session_id:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @abstract
+    #
+    # @example
+    # ```ruby
+    # case connection_status_type
+    # in :pending
+    #   # ...
+    # in :processing
+    #   # ...
+    # in :connected
+    #   # ...
+    # in :error_no_account_setup
+    #   # ...
+    # in :error_permissions
+    #   # ...
+    # in ...
+    #   #...
+    # end
+    # ```
+    class ConnectionStatusType < FinchAPI::Enum
+      PENDING = :pending
+      PROCESSING = :processing
+      CONNECTED = :connected
+      ERROR_NO_ACCOUNT_SETUP = :error_no_account_setup
+      ERROR_PERMISSIONS = :error_permissions
+      REAUTH = :reauth
+
+      finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   #
+      #   def self.values; end
+    end
+  end
+end

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

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class CreateAccessTokenResponse < FinchAPI::BaseModel
+      # @!attribute access_token
+      #   The access token for the connection.
+      #
+      #   @return [String]
+      required :access_token, String
+
+      # @!attribute account_id
+      #   [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] 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::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 [r] token_type
+      #   The RFC 8693 token type (Finch uses `bearer` tokens)
+      #
+      #   @return [String, nil]
+      optional :token_type, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :token_type
+
+      # @!parse
+      #   # @param access_token [String]
+      #   # @param account_id [String]
+      #   # @param client_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType]
+      #   # @param company_id [String]
+      #   # @param connection_id [String]
+      #   # @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType]
+      #   # @param products [Array<String>]
+      #   # @param provider_id [String]
+      #   # @param customer_id [String, nil]
+      #   # @param token_type [String]
+      #   #
+      #   def initialize(
+      #     access_token:,
+      #     account_id:,
+      #     client_type:,
+      #     company_id:,
+      #     connection_id:,
+      #     connection_type:,
+      #     products:,
+      #     provider_id:,
+      #     customer_id: nil,
+      #     token_type: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+      # @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
+        PRODUCTION = :production
+        DEVELOPMENT = :development
+        SANDBOX = :sandbox
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      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
+        PROVIDER = :provider
+        FINCH = :finch
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end