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

data/lib/finch_api/models/provider_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @see FinchAPI::Resources::Providers#list
+    class ProviderListParams < FinchAPI::Internal::Type::BaseModel
+      extend FinchAPI::Internal::Type::RequestParameters::Converter
+      include FinchAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/finch_api/models/request_forwarding_forward_params.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @see FinchAPI::Resources::RequestForwarding#forward
+    class RequestForwardingForwardParams < FinchAPI::Internal::Type::BaseModel
+      extend FinchAPI::Internal::Type::RequestParameters::Converter
+      include FinchAPI::Internal::Type::RequestParameters
+
+      # @!attribute method_
+      #   The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
+      #   , `PUT` , `DELETE` , and `PATCH`.
+      #
+      #   @return [String]
+      required :method_, String, api_name: :method
+
+      # @!attribute route
+      #   The URL route path for the forwarded request. This value must begin with a
+      #   forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and
+      #   underscores.
+      #
+      #   @return [String]
+      required :route, String
+
+      # @!attribute data
+      #   The body for the forwarded request. This value must be specified as either a
+      #   string or a valid JSON object.
+      #
+      #   @return [String, nil]
+      optional :data, String, nil?: true
+
+      # @!attribute headers
+      #   The HTTP headers to include on the forwarded request. This value must be
+      #   specified as an object of key-value pairs. Example:
+      #   `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
+      #
+      #   @return [Object, nil]
+      optional :headers, FinchAPI::Internal::Type::Unknown, nil?: true
+
+      # @!attribute params
+      #   The query parameters for the forwarded request. This value must be specified as
+      #   a valid JSON object rather than a query string.
+      #
+      #   @return [Object, nil]
+      optional :params, FinchAPI::Internal::Type::Unknown, nil?: true
+
+      # @!method initialize(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::RequestForwardingForwardParams} for more details.
+      #
+      #   @param method_ [String] The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
+      #
+      #   @param route [String] The URL route path for the forwarded request. This value must begin with a forwa
+      #
+      #   @param data [String, nil] The body for the forwarded request. This value must be specified as either a str
+      #
+      #   @param headers [Object, nil] The HTTP headers to include on the forwarded request. This value must be specifi
+      #
+      #   @param params [Object, nil] The query parameters for the forwarded request. This value must be specified as
+      #
+      #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/finch_api/models/request_forwarding_forward_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @see FinchAPI::Resources::RequestForwarding#forward
+    class RequestForwardingForwardResponse < FinchAPI::Internal::Type::BaseModel
+      # @!attribute data
+      #   A string representation of the HTTP response body of the forwarded request’s
+      #   response received from the underlying integration’s API. This field may be null
+      #   in the case where the upstream system’s response is empty.
+      #
+      #   @return [String, nil]
+      required :data, String, nil?: true
+
+      # @!attribute headers
+      #   The HTTP headers of the forwarded request’s response, exactly as received from
+      #   the underlying integration’s API.
+      #
+      #   @return [Object, nil]
+      required :headers, FinchAPI::Internal::Type::Unknown, nil?: true
+
+      # @!attribute request
+      #   An object containing details of your original forwarded request, for your ease
+      #   of reference.
+      #
+      #   @return [FinchAPI::Models::RequestForwardingForwardResponse::Request]
+      required :request, -> { FinchAPI::Models::RequestForwardingForwardResponse::Request }
+
+      # @!attribute status_code
+      #   The HTTP status code of the forwarded request’s response, exactly received from
+      #   the underlying integration’s API. This value will be returned as an integer.
+      #
+      #   @return [Integer]
+      required :status_code, Integer, api_name: :statusCode
+
+      # @!method initialize(data:, headers:, request:, status_code:)
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::RequestForwardingForwardResponse} for more details.
+      #
+      #   @param data [String, nil] A string representation of the HTTP response body of the forwarded request’s res
+      #
+      #   @param headers [Object, nil] The HTTP headers of the forwarded request’s response, exactly as received from t
+      #
+      #   @param request [FinchAPI::Models::RequestForwardingForwardResponse::Request] An object containing details of your original forwarded request, for your ease o
+      #
+      #   @param status_code [Integer] The HTTP status code of the forwarded request’s response, exactly received from
+
+      # @see FinchAPI::Models::RequestForwardingForwardResponse#request
+      class Request < FinchAPI::Internal::Type::BaseModel
+        # @!attribute data
+        #   The body that was specified for the forwarded request. If a value was not
+        #   specified in the original request, this value will be returned as null ;
+        #   otherwise, this value will always be returned as a string.
+        #
+        #   @return [String, nil]
+        required :data, String, nil?: true
+
+        # @!attribute headers
+        #   The specified HTTP headers that were included in the forwarded request. If no
+        #   headers were specified, this will be returned as `null`.
+        #
+        #   @return [Object, nil]
+        required :headers, FinchAPI::Internal::Type::Unknown, nil?: true
+
+        # @!attribute method_
+        #   The HTTP method that was specified for the forwarded request. Valid values
+        #   include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
+        #
+        #   @return [String]
+        required :method_, String, api_name: :method
+
+        # @!attribute params
+        #   The query parameters that were included in the forwarded request. If no query
+        #   parameters were specified, this will be returned as `null`.
+        #
+        #   @return [Object, nil]
+        required :params, FinchAPI::Internal::Type::Unknown, nil?: true
+
+        # @!attribute route
+        #   The URL route path that was specified for the forwarded request.
+        #
+        #   @return [String]
+        required :route, String
+
+        # @!method initialize(data:, headers:, method_:, params:, route:)
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::RequestForwardingForwardResponse::Request} for more details.
+        #
+        #   An object containing details of your original forwarded request, for your ease
+        #   of reference.
+        #
+        #   @param data [String, nil] The body that was specified for the forwarded request. If a value was not specif
+        #
+        #   @param headers [Object, nil] The specified HTTP headers that were included in the forwarded request. If no he
+        #
+        #   @param method_ [String] The HTTP method that was specified for the forwarded request. Valid values inclu
+        #
+        #   @param params [Object, nil] The query parameters that were included in the forwarded request. If no query pa
+        #
+        #   @param route [String] The URL route path that was specified for the forwarded request.
+      end
+    end
+  end
+end

data/lib/finch_api/models/sandbox/company_update_params.rb

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      # @see FinchAPI::Resources::Sandbox::Company#update
+      class CompanyUpdateParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute accounts
+        #   An array of bank account objects associated with the payroll/HRIS system.
+        #
+        #   @return [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil]
+        required :accounts,
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Account] },
+                 nil?: true
+
+        # @!attribute departments
+        #   The array of company departments.
+        #
+        #   @return [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil]
+        required :departments,
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::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::Sandbox::CompanyUpdateParams::Entity, nil]
+        required :entity, -> { FinchAPI::Sandbox::CompanyUpdateParams::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::Location, nil>, nil]
+        required :locations,
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::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: E.164, with
+        #   extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
+        #
+        #   @return [String, nil]
+        required :primary_phone_number, String, nil?: true
+
+        # @!method initialize(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Sandbox::CompanyUpdateParams} for more details.
+        #
+        #   @param accounts [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
+        #
+        #   @param departments [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
+        #
+        #   @param ein [String, nil] The employer identification number.
+        #
+        #   @param entity [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
+        #
+        #   @param legal_name [String, nil] The legal name of the company.
+        #
+        #   @param locations [Array<FinchAPI::Location, nil>, nil]
+        #
+        #   @param primary_email [String, nil] The email of the main administrator on the account.
+        #
+        #   @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        class Account < FinchAPI::Internal::Type::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::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
+          optional :account_type,
+                   enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::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
+
+          # @!method initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Sandbox::CompanyUpdateParams::Account} for more details.
+          #
+          #   @param account_name [String, nil] The name of the bank associated in the payroll/HRIS system.
+          #
+          #   @param account_number [String, nil] 10-12 digit number to specify the bank account
+          #
+          #   @param account_type [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType, nil] The type of bank account.
+          #
+          #   @param institution_name [String, nil] Name of the banking institution.
+          #
+          #   @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was
+
+          # The type of bank account.
+          #
+          # @see FinchAPI::Sandbox::CompanyUpdateParams::Account#account_type
+          module AccountType
+            extend FinchAPI::Internal::Type::Enum
+
+            CHECKING = :checking
+            SAVINGS = :savings
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Department < FinchAPI::Internal::Type::BaseModel
+          # @!attribute name
+          #   The department name.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute parent
+          #   The parent department, if present.
+          #
+          #   @return [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil]
+          optional :parent, -> { FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent }, nil?: true
+
+          # @!method initialize(name: nil, parent: nil)
+          #   @param name [String, nil] The department name.
+          #
+          #   @param parent [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil] The parent department, if present.
+
+          # @see FinchAPI::Sandbox::CompanyUpdateParams::Department#parent
+          class Parent < FinchAPI::Internal::Type::BaseModel
+            # @!attribute name
+            #   The parent department's name.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!method initialize(name: nil)
+            #   The parent department, if present.
+            #
+            #   @param name [String, nil] The parent department's name.
+          end
+        end
+
+        class Entity < FinchAPI::Internal::Type::BaseModel
+          # @!attribute subtype
+          #   The tax payer subtype of the company.
+          #
+          #   @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil]
+          optional :subtype, enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype }, nil?: true
+
+          # @!attribute type
+          #   The tax payer type of the company.
+          #
+          #   @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type, nil]
+          optional :type, enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type }, nil?: true
+
+          # @!method initialize(subtype: nil, type: nil)
+          #   The entity type object.
+          #
+          #   @param subtype [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] The tax payer subtype of the company.
+          #
+          #   @param type [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type, nil] The tax payer type of the company.
+
+          # The tax payer subtype of the company.
+          #
+          # @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#subtype
+          module Subtype
+            extend FinchAPI::Internal::Type::Enum
+
+            S_CORPORATION = :s_corporation
+            C_CORPORATION = :c_corporation
+            B_CORPORATION = :b_corporation
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The tax payer type of the company.
+          #
+          # @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            LLC = :llc
+            LP = :lp
+            CORPORATION = :corporation
+            SOLE_PROPRIETOR = :sole_proprietor
+            NON_PROFIT = :non_profit
+            PARTNERSHIP = :partnership
+            COOPERATIVE = :cooperative
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/sandbox/company_update_response.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module Sandbox
+      # @see FinchAPI::Resources::Sandbox::Company#update
+      class CompanyUpdateResponse < FinchAPI::Internal::Type::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::Internal::Type::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::Internal::Type::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::Location, nil>, nil]
+        required :locations,
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::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: E.164, with
+        #   extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
+        #
+        #   @return [String, nil]
+        required :primary_phone_number, String, nil?: true
+
+        # @!method initialize(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:)
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Sandbox::CompanyUpdateResponse} for more details.
+        #
+        #   @param accounts [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
+        #
+        #   @param departments [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil>, nil] The array of company departments.
+        #
+        #   @param ein [String, nil] The employer identification number.
+        #
+        #   @param entity [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, nil] The entity type object.
+        #
+        #   @param legal_name [String, nil] The legal name of the company.
+        #
+        #   @param locations [Array<FinchAPI::Location, nil>, nil]
+        #
+        #   @param primary_email [String, nil] The email of the main administrator on the account.
+        #
+        #   @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e
+
+        class Account < FinchAPI::Internal::Type::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
+
+          # @!method initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account} for more details.
+          #
+          #   @param account_name [String, nil] The name of the bank associated in the payroll/HRIS system.
+          #
+          #   @param account_number [String, nil] 10-12 digit number to specify the bank account
+          #
+          #   @param account_type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType, nil] The type of bank account.
+          #
+          #   @param institution_name [String, nil] Name of the banking institution.
+          #
+          #   @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was
+
+          # The type of bank account.
+          #
+          # @see FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account#account_type
+          module AccountType
+            extend FinchAPI::Internal::Type::Enum
+
+            CHECKING = :checking
+            SAVINGS = :savings
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Department < FinchAPI::Internal::Type::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
+
+          # @!method initialize(name: nil, parent: nil)
+          #   @param name [String, nil] The department name.
+          #
+          #   @param parent [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, nil] The parent department, if present.
+
+          # @see FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department#parent
+          class Parent < FinchAPI::Internal::Type::BaseModel
+            # @!attribute name
+            #   The parent department's name.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!method initialize(name: nil)
+            #   The parent department, if present.
+            #
+            #   @param name [String, nil] The parent department's name.
+          end
+        end
+
+        # @see FinchAPI::Models::Sandbox::CompanyUpdateResponse#entity
+        class Entity < FinchAPI::Internal::Type::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
+
+          # @!method initialize(subtype: nil, type: nil)
+          #   The entity type object.
+          #
+          #   @param subtype [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype, nil] The tax payer subtype of the company.
+          #
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type, nil] The tax payer type of the company.
+
+          # The tax payer subtype of the company.
+          #
+          # @see FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity#subtype
+          module Subtype
+            extend FinchAPI::Internal::Type::Enum
+
+            S_CORPORATION = :s_corporation
+            C_CORPORATION = :c_corporation
+            B_CORPORATION = :b_corporation
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The tax payer type of the company.
+          #
+          # @see FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            LLC = :llc
+            LP = :lp
+            CORPORATION = :corporation
+            SOLE_PROPRIETOR = :sole_proprietor
+            NON_PROFIT = :non_profit
+            PARTNERSHIP = :partnership
+            COOPERATIVE = :cooperative
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end