finch-api 0.1.0.pre.alpha.1

data/lib/finch-api/models/sandbox/company_update_response.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      class CompanyUpdateResponse < FinchAPI::BaseModel
+        # @!attribute accounts
+        #   An array of bank account objects associated with the payroll/HRIS system.
+        #
+        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account>, nil]
+        required :accounts,
+                 -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account] },
+                 nil?: true
+
+        # @!attribute departments
+        #   The array of company departments.
+        #
+        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil>, nil]
+        required :departments,
+                 -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil?: true] },
+                 nil?: true
+
+        # @!attribute ein
+        #   The employer identification number.
+        #
+        #   @return [String, nil]
+        required :ein, String, nil?: true
+
+        # @!attribute entity
+        #   The entity type object.
+        #
+        #   @return [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, nil]
+        required :entity, -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity }, nil?: true
+
+        # @!attribute legal_name
+        #   The legal name of the company.
+        #
+        #   @return [String, nil]
+        required :legal_name, String, nil?: true
+
+        # @!attribute locations
+        #
+        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
+        required :locations, -> { FinchAPI::ArrayOf[FinchAPI::Models::Location, nil?: true] }, nil?: true
+
+        # @!attribute primary_email
+        #   The email of the main administrator on the account.
+        #
+        #   @return [String, nil]
+        required :primary_email, String, nil?: true
+
+        # @!attribute primary_phone_number
+        #   The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
+        #
+        #   @return [String, nil]
+        required :primary_phone_number, String, nil?: true
+
+        # @!parse
+        #   # @param accounts [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account>, nil]
+        #   # @param departments [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil>, nil]
+        #   # @param ein [String, nil]
+        #   # @param entity [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, nil]
+        #   # @param legal_name [String, nil]
+        #   # @param locations [Array<FinchAPI::Models::Location, nil>, nil]
+        #   # @param primary_email [String, nil]
+        #   # @param primary_phone_number [String, nil]
+        #   #
+        #   def initialize(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class Account < FinchAPI::BaseModel
+          # @!attribute account_name
+          #   The name of the bank associated in the payroll/HRIS system.
+          #
+          #   @return [String, nil]
+          optional :account_name, String, nil?: true
+
+          # @!attribute account_number
+          #   10-12 digit number to specify the bank account
+          #
+          #   @return [String, nil]
+          optional :account_number, String, nil?: true
+
+          # @!attribute account_type
+          #   The type of bank account.
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType, nil]
+          optional :account_type,
+                   enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType },
+                   nil?: true
+
+          # @!attribute institution_name
+          #   Name of the banking institution.
+          #
+          #   @return [String, nil]
+          optional :institution_name, String, nil?: true
+
+          # @!attribute routing_number
+          #   A nine-digit code that's based on the U.S. Bank location where your account was
+          #     opened.
+          #
+          #   @return [String, nil]
+          optional :routing_number, String, nil?: true
+
+          # @!parse
+          #   # @param account_name [String, nil]
+          #   # @param account_number [String, nil]
+          #   # @param account_type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType, nil]
+          #   # @param institution_name [String, nil]
+          #   # @param routing_number [String, nil]
+          #   #
+          #   def initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # The type of bank account.
+          #
+          # @example
+          # ```ruby
+          # case account_type
+          # in :checking
+          #   # ...
+          # in :savings
+          #   # ...
+          # end
+          # ```
+          class AccountType < FinchAPI::Enum
+            CHECKING = :checking
+            SAVINGS = :savings
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+
+        class Department < FinchAPI::BaseModel
+          # @!attribute name
+          #   The department name.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute parent
+          #   The parent department, if present.
+          #
+          #   @return [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, nil]
+          optional :parent, -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent }, nil?: true
+
+          # @!parse
+          #   # @param name [String, nil]
+          #   # @param parent [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, nil]
+          #   #
+          #   def initialize(name: nil, parent: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          class Parent < FinchAPI::BaseModel
+            # @!attribute name
+            #   The parent department's name.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!parse
+            #   # The parent department, if present.
+            #   #
+            #   # @param name [String, nil]
+            #   #
+            #   def initialize(name: nil, **) = super
+
+            # def initialize: (Hash | FinchAPI::BaseModel) -> void
+          end
+        end
+
+        class Entity < FinchAPI::BaseModel
+          # @!attribute subtype
+          #   The tax payer subtype of the company.
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype, nil]
+          optional :subtype,
+                   enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype },
+                   nil?: true
+
+          # @!attribute type
+          #   The tax payer type of the company.
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type, nil]
+          optional :type, enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type }, nil?: true
+
+          # @!parse
+          #   # The entity type object.
+          #   #
+          #   # @param subtype [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype, nil]
+          #   # @param type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type, nil]
+          #   #
+          #   def initialize(subtype: nil, type: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # The tax payer subtype of the company.
+          #
+          # @example
+          # ```ruby
+          # case subtype
+          # in :s_corporation
+          #   # ...
+          # in :c_corporation
+          #   # ...
+          # in :b_corporation
+          #   # ...
+          # end
+          # ```
+          class Subtype < FinchAPI::Enum
+            S_CORPORATION = :s_corporation
+            C_CORPORATION = :c_corporation
+            B_CORPORATION = :b_corporation
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+
+          # @abstract
+          #
+          # The tax payer type of the company.
+          #
+          # @example
+          # ```ruby
+          # case type
+          # in :llc
+          #   # ...
+          # in :lp
+          #   # ...
+          # in :corporation
+          #   # ...
+          # in :sole_proprietor
+          #   # ...
+          # in :non_profit
+          #   # ...
+          # in ...
+          #   #...
+          # end
+          # ```
+          class Type < FinchAPI::Enum
+            LLC = :llc
+            LP = :lp
+            CORPORATION = :corporation
+            SOLE_PROPRIETOR = :sole_proprietor
+            NON_PROFIT = :non_profit
+            PARTNERSHIP = :partnership
+            COOPERATIVE = :cooperative
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/connection_create_params.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      class ConnectionCreateParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute provider_id
+        #   The provider associated with the connection
+        #
+        #   @return [String]
+        required :provider_id, String
+
+        # @!attribute [r] authentication_type
+        #
+        #   @return [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType, nil]
+        optional :authentication_type,
+                 enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType }
+
+        # @!parse
+        #   # @return [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType]
+        #   attr_writer :authentication_type
+
+        # @!attribute [r] employee_size
+        #   Optional: the size of the employer to be created with this connection. Defaults
+        #     to 20. Note that if this is higher than 100, historical payroll data will not be
+        #     generated, and instead only one pay period will be created.
+        #
+        #   @return [Integer, nil]
+        optional :employee_size, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :employee_size
+
+        # @!attribute [r] products
+        #
+        #   @return [Array<String>, nil]
+        optional :products, FinchAPI::ArrayOf[String]
+
+        # @!parse
+        #   # @return [Array<String>]
+        #   attr_writer :products
+
+        # @!parse
+        #   # @param provider_id [String]
+        #   # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType]
+        #   # @param employee_size [Integer]
+        #   # @param products [Array<String>]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(provider_id:, authentication_type: nil, employee_size: nil, products: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case authentication_type
+        # in :credential
+        #   # ...
+        # in :api_token
+        #   # ...
+        # in :oauth
+        #   # ...
+        # in :assisted
+        #   # ...
+        # end
+        # ```
+        class AuthenticationType < FinchAPI::Enum
+          CREDENTIAL = :credential
+          API_TOKEN = :api_token
+          OAUTH = :oauth
+          ASSISTED = :assisted
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/connection_create_response.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      class ConnectionCreateResponse < FinchAPI::BaseModel
+        # @!attribute access_token
+        #
+        #   @return [String]
+        required :access_token, String
+
+        # @!attribute account_id
+        #   [DEPRECATED] Use `connection_id` to associate a connection with an access token
+        #
+        #   @return [String]
+        required :account_id, String
+
+        # @!attribute authentication_type
+        #
+        #   @return [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType]
+        required :authentication_type,
+                 enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType }
+
+        # @!attribute company_id
+        #   [DEPRECATED] Use `connection_id` to associate a connection with an access token
+        #
+        #   @return [String]
+        required :company_id, String
+
+        # @!attribute connection_id
+        #   The ID of the new connection
+        #
+        #   @return [String]
+        required :connection_id, String
+
+        # @!attribute products
+        #
+        #   @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 [r] token_type
+        #
+        #   @return [String, nil]
+        optional :token_type, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :token_type
+
+        # @!parse
+        #   # @param access_token [String]
+        #   # @param account_id [String]
+        #   # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType]
+        #   # @param company_id [String]
+        #   # @param connection_id [String]
+        #   # @param products [Array<String>]
+        #   # @param provider_id [String]
+        #   # @param token_type [String]
+        #   #
+        #   def initialize(
+        #     access_token:,
+        #     account_id:,
+        #     authentication_type:,
+        #     company_id:,
+        #     connection_id:,
+        #     products:,
+        #     provider_id:,
+        #     token_type: nil,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case authentication_type
+        # in :credential
+        #   # ...
+        # in :api_token
+        #   # ...
+        # in :oauth
+        #   # ...
+        # in :assisted
+        #   # ...
+        # end
+        # ```
+        class AuthenticationType < FinchAPI::Enum
+          CREDENTIAL = :credential
+          API_TOKEN = :api_token
+          OAUTH = :oauth
+          ASSISTED = :assisted
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/connections/account_create_params.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Connections
+        class AccountCreateParams < FinchAPI::BaseModel
+          # @!parse
+          #   extend FinchAPI::RequestParameters::Converter
+          include FinchAPI::RequestParameters
+
+          # @!attribute company_id
+          #
+          #   @return [String]
+          required :company_id, String
+
+          # @!attribute provider_id
+          #   The provider associated with the `access_token`
+          #
+          #   @return [String]
+          required :provider_id, String
+
+          # @!attribute [r] authentication_type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil]
+          optional :authentication_type,
+                   enum: -> { FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType }
+
+          # @!parse
+          #   # @return [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType]
+          #   attr_writer :authentication_type
+
+          # @!attribute [r] products
+          #   Optional, defaults to Organization products (`company`, `directory`,
+          #     `employment`, `individual`)
+          #
+          #   @return [Array<String>, nil]
+          optional :products, FinchAPI::ArrayOf[String]
+
+          # @!parse
+          #   # @return [Array<String>]
+          #   attr_writer :products
+
+          # @!parse
+          #   # @param company_id [String]
+          #   # @param provider_id [String]
+          #   # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType]
+          #   # @param products [Array<String>]
+          #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(company_id:, provider_id:, authentication_type: nil, products: nil, request_options: {}, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case authentication_type
+          # in :credential
+          #   # ...
+          # in :api_token
+          #   # ...
+          # in :oauth
+          #   # ...
+          # in :assisted
+          #   # ...
+          # end
+          # ```
+          class AuthenticationType < FinchAPI::Enum
+            CREDENTIAL = :credential
+            API_TOKEN = :api_token
+            OAUTH = :oauth
+            ASSISTED = :assisted
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/connections/account_create_response.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Connections
+        class AccountCreateResponse < FinchAPI::BaseModel
+          # @!attribute access_token
+          #
+          #   @return [String]
+          required :access_token, String
+
+          # @!attribute account_id
+          #   [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          #
+          #   @return [String]
+          required :account_id, String
+
+          # @!attribute authentication_type
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType]
+          required :authentication_type,
+                   enum: -> { FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType }
+
+          # @!attribute company_id
+          #   [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          #
+          #   @return [String]
+          required :company_id, String
+
+          # @!attribute connection_id
+          #   The ID of the new connection
+          #
+          #   @return [String]
+          required :connection_id, String
+
+          # @!attribute products
+          #
+          #   @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
+
+          # @!parse
+          #   # @param access_token [String]
+          #   # @param account_id [String]
+          #   # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType]
+          #   # @param company_id [String]
+          #   # @param connection_id [String]
+          #   # @param products [Array<String>]
+          #   # @param provider_id [String]
+          #   #
+          #   def initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case authentication_type
+          # in :credential
+          #   # ...
+          # in :api_token
+          #   # ...
+          # in :oauth
+          #   # ...
+          # in :assisted
+          #   # ...
+          # end
+          # ```
+          class AuthenticationType < FinchAPI::Enum
+            CREDENTIAL = :credential
+            API_TOKEN = :api_token
+            OAUTH = :oauth
+            ASSISTED = :assisted
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/sandbox/connections/account_update_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      module Connections
+        class AccountUpdateParams < FinchAPI::BaseModel
+          # @!parse
+          #   extend FinchAPI::RequestParameters::Converter
+          include FinchAPI::RequestParameters
+
+          # @!attribute [r] connection_status
+          #
+          #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
+          optional :connection_status, enum: -> { FinchAPI::Models::ConnectionStatusType }
+
+          # @!parse
+          #   # @return [Symbol, FinchAPI::Models::ConnectionStatusType]
+          #   attr_writer :connection_status
+
+          # @!parse
+          #   # @param connection_status [Symbol, FinchAPI::Models::ConnectionStatusType]
+          #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(connection_status: nil, request_options: {}, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+      end
+    end
+  end
+end