finch-api 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

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

@@ -11,7 +11,7 @@ module FinchAPI
         # @!attribute accounts
         #   An array of bank account objects associated with the payroll/HRIS system.
         #
-        #   @return [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil]
+        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil]
         required :accounts,
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Account] },
                  nil?: true
@@ -19,7 +19,7 @@ module FinchAPI
         # @!attribute departments
         #   The array of company departments.
         #
-        #   @return [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil]
+        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil]
         required :departments,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Department,
@@ -36,7 +36,7 @@ module FinchAPI
         # @!attribute entity
         #   The entity type object.
         #
-        #   @return [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil]
+        #   @return [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil]
         required :entity, -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity }, nil?: true
 
         # @!attribute legal_name
@@ -47,7 +47,7 @@ module FinchAPI
 
         # @!attribute locations
         #
-        #   @return [Array<FinchAPI::Location, nil>, nil]
+        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
         required :locations,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]
@@ -71,17 +71,17 @@ module FinchAPI
         #   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 accounts [Array<FinchAPI::Models::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 departments [Array<FinchAPI::Models::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 entity [FinchAPI::Models::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 locations [Array<FinchAPI::Models::Location, nil>, nil]
         #
         #   @param primary_email [String, nil] The email of the main administrator on the account.
         #
@@ -105,7 +105,7 @@ module FinchAPI
           # @!attribute account_type
           #   The type of bank account.
           #
-          #   @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
           optional :account_type,
                    enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType },
                    nil?: true
@@ -125,13 +125,13 @@ module FinchAPI
 
           # @!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.
+          #   {FinchAPI::Models::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 account_type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil] The type of bank account.
           #
           #   @param institution_name [String, nil] Name of the banking institution.
           #
@@ -139,7 +139,7 @@ module FinchAPI
 
           # The type of bank account.
           #
-          # @see FinchAPI::Sandbox::CompanyUpdateParams::Account#account_type
+          # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Account#account_type
           module AccountType
             extend FinchAPI::Internal::Type::Enum
 
@@ -161,15 +161,15 @@ module FinchAPI
           # @!attribute parent
           #   The parent department, if present.
           #
-          #   @return [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil]
+          #   @return [FinchAPI::Models::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.
+          #   @param parent [FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, nil] The parent department, if present.
 
-          # @see FinchAPI::Sandbox::CompanyUpdateParams::Department#parent
+          # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Department#parent
           class Parent < FinchAPI::Internal::Type::BaseModel
             # @!attribute name
             #   The parent department's name.
@@ -188,25 +188,25 @@ module FinchAPI
           # @!attribute subtype
           #   The tax payer subtype of the company.
           #
-          #   @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil]
+          #   @return [Symbol, FinchAPI::Models::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]
+          #   @return [Symbol, FinchAPI::Models::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 subtype [Symbol, FinchAPI::Models::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.
+          #   @param type [Symbol, FinchAPI::Models::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
+          # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity#subtype
           module Subtype
             extend FinchAPI::Internal::Type::Enum
 
@@ -220,7 +220,7 @@ module FinchAPI
 
           # The tax payer type of the company.
           #
-          # @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#type
+          # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity#type
           module Type
             extend FinchAPI::Internal::Type::Enum
 

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

@@ -41,7 +41,7 @@ module FinchAPI
 
         # @!attribute locations
         #
-        #   @return [Array<FinchAPI::Location, nil>, nil]
+        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
         required :locations,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]
@@ -75,7 +75,7 @@ module FinchAPI
         #
         #   @param legal_name [String, nil] The legal name of the company.
         #
-        #   @param locations [Array<FinchAPI::Location, nil>, nil]
+        #   @param locations [Array<FinchAPI::Models::Location, nil>, nil]
         #
         #   @param primary_email [String, nil] The email of the main administrator on the account.
         #

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

@@ -16,7 +16,7 @@ module FinchAPI
 
         # @!attribute authentication_type
         #
-        #   @return [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType, nil]
+        #   @return [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType, nil]
         optional :authentication_type,
                  enum: -> {
                    FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType
@@ -41,7 +41,7 @@ module FinchAPI
         #
         #   @param provider_id [String] The provider associated with the connection
         #
-        #   @param authentication_type [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType]
+        #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType]
         #
         #   @param employee_size [Integer] Optional: the size of the employer to be created with this connection. Defaults
         #

data/lib/finch_api/models/sandbox/connections/account_create_params.rb

@@ -22,7 +22,7 @@ module FinchAPI
 
           # @!attribute authentication_type
           #
-          #   @return [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil]
           optional :authentication_type,
                    enum: -> { FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType }
 
@@ -41,7 +41,7 @@ module FinchAPI
           #
           #   @param provider_id [String] The provider associated with the `access_token`
           #
-          #   @param authentication_type [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType]
+          #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType]
           #
           #   @param products [Array<String>] Optional, defaults to Organization products (`company`, `directory`, `employment
           #

data/lib/finch_api/models/sandbox/connections/account_update_params.rb

@@ -11,11 +11,11 @@ module FinchAPI
 
           # @!attribute connection_status
           #
-          #   @return [Symbol, FinchAPI::ConnectionStatusType, nil]
+          #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
           optional :connection_status, enum: -> { FinchAPI::ConnectionStatusType }
 
           # @!method initialize(connection_status: nil, request_options: {})
-          #   @param connection_status [Symbol, FinchAPI::ConnectionStatusType]
+          #   @param connection_status [Symbol, FinchAPI::Models::ConnectionStatusType]
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
         end
       end

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

@@ -12,7 +12,7 @@ module FinchAPI
         #   Array of individuals to create. Takes all combined fields from `/individual` and
         #   `/employment` endpoints. All fields are optional.
         #
-        #   @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body>, nil]
+        #   @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body>, nil]
         optional :body,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body]
@@ -22,7 +22,7 @@ module FinchAPI
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Sandbox::DirectoryCreateParams} for more details.
         #
-        #   @param body [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
+        #   @param body [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -38,16 +38,17 @@ module FinchAPI
           #   employer in the system. Custom fields are not currently supported for assisted
           #   connections.
           #
-          #   @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>, nil]
+          #   @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField>, nil]
           optional :custom_fields,
                    -> {
                      FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]
-                   }
+                   },
+                   nil?: true
 
           # @!attribute department
           #   The department object.
           #
-          #   @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil]
+          #   @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, nil]
           optional :department, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Department }, nil?: true
 
           # @!attribute dob
@@ -57,7 +58,7 @@ module FinchAPI
 
           # @!attribute emails
           #
-          #   @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::Email>, nil]
+          #   @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email>, nil]
           optional :emails,
                    -> {
                      FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]
@@ -67,13 +68,14 @@ module FinchAPI
           # @!attribute employment
           #   The employment object.
           #
-          #   @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil]
+          #   @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil]
           optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true
 
           # @!attribute employment_status
-          #   The detailed employment status of the individual.
+          #   The detailed employment status of the individual. Available options: `active`,
+          #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
           #
-          #   @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
           optional :employment_status,
                    enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus },
                    nil?: true
@@ -94,7 +96,7 @@ module FinchAPI
           # @!attribute ethnicity
           #   The EEOC-defined ethnicity of the individual.
           #
-          #   @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil]
           optional :ethnicity,
                    enum: -> {
                      FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity
@@ -110,7 +112,7 @@ module FinchAPI
           # @!attribute gender
           #   The gender of the individual.
           #
-          #   @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender, nil]
           optional :gender, enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender }, nil?: true
 
           # @!attribute income
@@ -118,13 +120,13 @@ module FinchAPI
           #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
           #   depending on what information the provider returns.
           #
-          #   @return [FinchAPI::Income, nil]
+          #   @return [FinchAPI::Models::Income, nil]
           optional :income, -> { FinchAPI::Income }, nil?: true
 
           # @!attribute income_history
           #   The array of income history.
           #
-          #   @return [Array<FinchAPI::Income, nil>, nil]
+          #   @return [Array<FinchAPI::Models::Income, nil>, nil]
           optional :income_history,
                    -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
                    nil?: true
@@ -148,13 +150,13 @@ module FinchAPI
 
           # @!attribute location
           #
-          #   @return [FinchAPI::Location, nil]
+          #   @return [FinchAPI::Models::Location, nil]
           optional :location, -> { FinchAPI::Location }, nil?: true
 
           # @!attribute manager
           #   The manager object representing the manager of the individual within the org.
           #
-          #   @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager, nil]
+          #   @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, nil]
           optional :manager, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager }, nil?: true
 
           # @!attribute middle_name
@@ -165,7 +167,7 @@ module FinchAPI
 
           # @!attribute phone_numbers
           #
-          #   @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
+          #   @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
           optional :phone_numbers,
                    -> {
                      FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber,
@@ -181,14 +183,14 @@ module FinchAPI
 
           # @!attribute residence
           #
-          #   @return [FinchAPI::Location, nil]
+          #   @return [FinchAPI::Models::Location, nil]
           optional :residence, -> { FinchAPI::Location }, nil?: true
 
           # @!attribute source_id
           #   The source system's unique employment identifier for this individual
           #
           #   @return [String, nil]
-          optional :source_id, String
+          optional :source_id, String, nil?: true
 
           # @!attribute ssn
           #   Social Security Number of the individual. This field is only available with the
@@ -212,35 +214,35 @@ module FinchAPI
 
           # @!method initialize(class_code: nil, custom_fields: nil, department: nil, dob: nil, emails: nil, employment: nil, employment_status: nil, encrypted_ssn: nil, end_date: nil, ethnicity: nil, first_name: nil, gender: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, source_id: nil, ssn: nil, start_date: nil, title: nil)
           #   Some parameter documentations has been truncated, see
-          #   {FinchAPI::Sandbox::DirectoryCreateParams::Body} for more details.
+          #   {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body} for more details.
           #
           #   @param class_code [String, nil] Worker's compensation classification code for this employee
           #
-          #   @param custom_fields [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
+          #   @param custom_fields [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
           #
-          #   @param department [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object.
+          #   @param department [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object.
           #
           #   @param dob [String, nil]
           #
-          #   @param emails [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::Email>, nil]
+          #   @param emails [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email>, nil]
           #
-          #   @param employment [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
+          #   @param employment [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
           #
-          #   @param employment_status [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual.
+          #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
           #
           #   @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
           #
           #   @param end_date [String, nil]
           #
-          #   @param ethnicity [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
+          #   @param ethnicity [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
           #
           #   @param first_name [String, nil] The legal first name of the individual.
           #
-          #   @param gender [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender, nil] The gender of the individual.
+          #   @param gender [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender, nil] The gender of the individual.
           #
-          #   @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
+          #   @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
           #
-          #   @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
+          #   @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
           #
           #   @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
           #
@@ -248,19 +250,19 @@ module FinchAPI
           #
           #   @param latest_rehire_date [String, nil]
           #
-          #   @param location [FinchAPI::Location, nil]
+          #   @param location [FinchAPI::Models::Location, nil]
           #
-          #   @param manager [FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager, nil] The manager object representing the manager of the individual within the org.
+          #   @param manager [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, nil] The manager object representing the manager of the individual within the org.
           #
           #   @param middle_name [String, nil] The legal middle name of the individual.
           #
-          #   @param phone_numbers [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
+          #   @param phone_numbers [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
           #
           #   @param preferred_name [String, nil] The preferred name of the individual.
           #
-          #   @param residence [FinchAPI::Location, nil]
+          #   @param residence [FinchAPI::Models::Location, nil]
           #
-          #   @param source_id [String] The source system's unique employment identifier for this individual
+          #   @param source_id [String, nil] The source system's unique employment identifier for this individual
           #
           #   @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
           #
@@ -284,7 +286,7 @@ module FinchAPI
             #   @param value [Object]
           end
 
-          # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#department
+          # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#department
           class Department < FinchAPI::Internal::Type::BaseModel
             # @!attribute name
             #   The name of the department associated with the individual.
@@ -306,7 +308,7 @@ module FinchAPI
 
             # @!attribute type
             #
-            #   @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
+            #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
             optional :type,
                      enum: -> {
                        FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type
@@ -315,9 +317,9 @@ module FinchAPI
 
             # @!method initialize(data: nil, type: nil)
             #   @param data [String]
-            #   @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
+            #   @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
 
-            # @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Email#type
+            # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email#type
             module Type
               extend FinchAPI::Internal::Type::Enum
 
@@ -329,13 +331,13 @@ module FinchAPI
             end
           end
 
-          # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment
+          # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment
           class Employment < FinchAPI::Internal::Type::BaseModel
             # @!attribute subtype
             #   The secondary employment type of the individual. Options: `full_time`,
             #   `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
             #
-            #   @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil]
+            #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil]
             optional :subtype,
                      enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype },
                      nil?: true
@@ -343,7 +345,7 @@ module FinchAPI
             # @!attribute type
             #   The main employment type of the individual.
             #
-            #   @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil]
+            #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil]
             optional :type,
                      enum: -> {
                        FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type
@@ -352,18 +354,19 @@ module FinchAPI
 
             # @!method initialize(subtype: nil, type: nil)
             #   Some parameter documentations has been truncated, see
-            #   {FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment} for more details.
+            #   {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment} for more
+            #   details.
             #
             #   The employment object.
             #
-            #   @param subtype [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
+            #   @param subtype [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
             #
-            #   @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual.
+            #   @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual.
 
             # The secondary employment type of the individual. Options: `full_time`,
             # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
             #
-            # @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment#subtype
+            # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment#subtype
             module Subtype
               extend FinchAPI::Internal::Type::Enum
 
@@ -380,7 +383,7 @@ module FinchAPI
 
             # The main employment type of the individual.
             #
-            # @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment#type
+            # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment#type
             module Type
               extend FinchAPI::Internal::Type::Enum
 
@@ -392,9 +395,10 @@ module FinchAPI
             end
           end
 
-          # The detailed employment status of the individual.
+          # The detailed employment status of the individual. Available options: `active`,
+          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
           #
-          # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment_status
+          # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment_status
           module EmploymentStatus
             extend FinchAPI::Internal::Type::Enum
 
@@ -412,7 +416,7 @@ module FinchAPI
 
           # The EEOC-defined ethnicity of the individual.
           #
-          # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#ethnicity
+          # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#ethnicity
           module Ethnicity
             extend FinchAPI::Internal::Type::Enum
 
@@ -431,7 +435,7 @@ module FinchAPI
 
           # The gender of the individual.
           #
-          # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#gender
+          # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#gender
           module Gender
             extend FinchAPI::Internal::Type::Enum
 
@@ -444,7 +448,7 @@ module FinchAPI
             #   @return [Array<Symbol>]
           end
 
-          # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#manager
+          # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#manager
           class Manager < FinchAPI::Internal::Type::BaseModel
             # @!attribute id
             #   A stable Finch `id` (UUID v4) for an individual in the company.
@@ -466,7 +470,7 @@ module FinchAPI
 
             # @!attribute type
             #
-            #   @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
+            #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
             optional :type,
                      enum: -> {
                        FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type
@@ -475,9 +479,9 @@ module FinchAPI
 
             # @!method initialize(data: nil, type: nil)
             #   @param data [String, nil]
-            #   @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
+            #   @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
 
-            # @see FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber#type
+            # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber#type
             module Type
               extend FinchAPI::Internal::Type::Enum