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

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

@@ -19,7 +19,7 @@ module FinchAPI
         #   employer in the system. Custom fields are not currently supported for assisted
         #   connections.
         #
-        #   @return [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>, nil]
+        #   @return [Array<FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField>, nil]
         optional :custom_fields,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
@@ -29,20 +29,20 @@ module FinchAPI
         # @!attribute department
         #   The department object.
         #
-        #   @return [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil]
+        #   @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil]
         optional :department, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Department }, nil?: true
 
         # @!attribute employment
         #   The employment object.
         #
-        #   @return [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil]
+        #   @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil]
         optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true
 
         # @!attribute employment_status
         #   The detailed employment status of the individual. Available options: `active`,
         #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
         #
-        #   @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
+        #   @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
         optional :employment_status,
                  enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus },
                  nil?: true
@@ -63,13 +63,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
@@ -93,13 +93,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::EmploymentUpdateParams::Manager, nil]
+        #   @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, nil]
         optional :manager, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Manager }, nil?: true
 
         # @!attribute middle_name
@@ -131,21 +131,21 @@ module FinchAPI
         #
         #   @param class_code [String, nil] Worker's compensation classification code for this employee
         #
-        #   @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
+        #   @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
         #
-        #   @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
+        #   @param department [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
         #
-        #   @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
+        #   @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
         #
-        #   @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
+        #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
         #
         #   @param end_date [String, nil]
         #
         #   @param first_name [String, nil] The legal first name 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.
         #
@@ -153,9 +153,9 @@ module FinchAPI
         #
         #   @param latest_rehire_date [String, nil]
         #
-        #   @param location [FinchAPI::Location, nil]
+        #   @param location [FinchAPI::Models::Location, nil]
         #
-        #   @param manager [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org.
+        #   @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateParams::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.
         #
@@ -201,7 +201,7 @@ module FinchAPI
           #   The secondary employment type of the individual. Options: `full_time`,
           #   `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
           #
-          #   @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil]
           optional :subtype,
                    enum: -> {
                      FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype
@@ -211,23 +211,24 @@ module FinchAPI
           # @!attribute type
           #   The main employment type of the individual.
           #
-          #   @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type, nil]
           optional :type, enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type }, nil?: true
 
           # @!method initialize(subtype: nil, type: nil)
           #   Some parameter documentations has been truncated, see
-          #   {FinchAPI::Sandbox::EmploymentUpdateParams::Employment} for more details.
+          #   {FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment} for more
+          #   details.
           #
           #   The employment object.
           #
-          #   @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
+          #   @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
           #
-          #   @param type [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual.
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::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::EmploymentUpdateParams::Employment#subtype
+          # @see FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment#subtype
           module Subtype
             extend FinchAPI::Internal::Type::Enum
 
@@ -244,7 +245,7 @@ module FinchAPI
 
           # The main employment type of the individual.
           #
-          # @see FinchAPI::Sandbox::EmploymentUpdateParams::Employment#type
+          # @see FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment#type
           module Type
             extend FinchAPI::Internal::Type::Enum
 

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

@@ -64,13 +64,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
@@ -94,7 +94,7 @@ module FinchAPI
 
         # @!attribute location
         #
-        #   @return [FinchAPI::Location, nil]
+        #   @return [FinchAPI::Models::Location, nil]
         optional :location, -> { FinchAPI::Location }, nil?: true
 
         # @!attribute manager
@@ -146,9 +146,9 @@ module FinchAPI
         #
         #   @param first_name [String, nil] The legal first name 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.
         #
@@ -156,7 +156,7 @@ module FinchAPI
         #
         #   @param latest_rehire_date [String, nil]
         #
-        #   @param location [FinchAPI::Location, nil]
+        #   @param location [FinchAPI::Models::Location, nil]
         #
         #   @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, nil] The manager object representing the manager of the individual within the org.
         #

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

@@ -15,7 +15,7 @@ module FinchAPI
 
         # @!attribute emails
         #
-        #   @return [Array<FinchAPI::Sandbox::IndividualUpdateParams::Email>, nil]
+        #   @return [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil]
         optional :emails,
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::IndividualUpdateParams::Email] },
                  nil?: true
@@ -31,7 +31,7 @@ module FinchAPI
         # @!attribute ethnicity
         #   The EEOC-defined ethnicity of the individual.
         #
-        #   @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil]
+        #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil]
         optional :ethnicity, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity }, nil?: true
 
         # @!attribute first_name
@@ -43,7 +43,7 @@ module FinchAPI
         # @!attribute gender
         #   The gender of the individual.
         #
-        #   @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender, nil]
+        #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil]
         optional :gender, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Gender }, nil?: true
 
         # @!attribute last_name
@@ -60,7 +60,7 @@ module FinchAPI
 
         # @!attribute phone_numbers
         #
-        #   @return [Array<FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
+        #   @return [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
         optional :phone_numbers,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber,
@@ -76,7 +76,7 @@ module FinchAPI
 
         # @!attribute residence
         #
-        #   @return [FinchAPI::Location, nil]
+        #   @return [FinchAPI::Models::Location, nil]
         optional :residence, -> { FinchAPI::Location }, nil?: true
 
         # @!attribute ssn
@@ -94,25 +94,25 @@ module FinchAPI
         #
         #   @param dob [String, nil]
         #
-        #   @param emails [Array<FinchAPI::Sandbox::IndividualUpdateParams::Email>, nil]
+        #   @param emails [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil]
         #
         #   @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
         #
-        #   @param ethnicity [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
+        #   @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::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::IndividualUpdateParams::Gender, nil] The gender of the individual.
+        #   @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual.
         #
         #   @param last_name [String, nil] The legal last name of the individual.
         #
         #   @param middle_name [String, nil] The legal middle name of the individual.
         #
-        #   @param phone_numbers [Array<FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
+        #   @param phone_numbers [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::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 ssn [String, nil] Social Security Number of the individual. This field is only available with the
         #
@@ -126,14 +126,14 @@ module FinchAPI
 
           # @!attribute type
           #
-          #   @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Email::Type, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type, nil]
           optional :type, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Email::Type }, nil?: true
 
           # @!method initialize(data: nil, type: nil)
           #   @param data [String]
-          #   @param type [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Email::Type, nil]
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type, nil]
 
-          # @see FinchAPI::Sandbox::IndividualUpdateParams::Email#type
+          # @see FinchAPI::Models::Sandbox::IndividualUpdateParams::Email#type
           module Type
             extend FinchAPI::Internal::Type::Enum
 
@@ -183,7 +183,7 @@ module FinchAPI
 
           # @!attribute type
           #
-          #   @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
           optional :type,
                    enum: -> {
                      FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type
@@ -192,9 +192,9 @@ module FinchAPI
 
           # @!method initialize(data: nil, type: nil)
           #   @param data [String, nil]
-          #   @param type [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
 
-          # @see FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber#type
+          # @see FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber#type
           module Type
             extend FinchAPI::Internal::Type::Enum
 

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

@@ -78,7 +78,7 @@ module FinchAPI
 
         # @!attribute residence
         #
-        #   @return [FinchAPI::Location, nil]
+        #   @return [FinchAPI::Models::Location, nil]
         optional :residence, -> { FinchAPI::Location }, nil?: true
 
         # @!attribute ssn
@@ -116,7 +116,7 @@ module FinchAPI
         #
         #   @param preferred_name [String, nil] The preferred name of the individual.
         #
-        #   @param residence [FinchAPI::Location, nil]
+        #   @param residence [FinchAPI::Models::Location, nil]
         #
         #   @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
 

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

@@ -11,11 +11,11 @@ module FinchAPI
         # @!attribute type
         #   The type of job to start. Currently the only supported type is `data_sync_all`
         #
-        #   @return [Symbol, FinchAPI::Sandbox::JobCreateParams::Type]
+        #   @return [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type]
         required :type, enum: -> { FinchAPI::Sandbox::JobCreateParams::Type }
 
         # @!method initialize(type:, request_options: {})
-        #   @param type [Symbol, FinchAPI::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
+        #   @param type [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb

@@ -8,20 +8,20 @@ module FinchAPI
         class SandboxJobConfiguration < FinchAPI::Internal::Type::BaseModel
           # @!attribute completion_status
           #
-          #   @return [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
           required :completion_status,
                    enum: -> { FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus }
 
           # @!attribute type
           #
-          #   @return [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type]
+          #   @return [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
           required :type, enum: -> { FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type }
 
           # @!method initialize(completion_status:, type:)
-          #   @param completion_status [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
-          #   @param type [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type]
+          #   @param completion_status [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
+          #   @param type [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
 
-          # @see FinchAPI::Sandbox::Jobs::SandboxJobConfiguration#completion_status
+          # @see FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration#completion_status
           module CompletionStatus
             extend FinchAPI::Internal::Type::Enum
 
@@ -34,7 +34,7 @@ module FinchAPI
             #   @return [Array<Symbol>]
           end
 
-          # @see FinchAPI::Sandbox::Jobs::SandboxJobConfiguration#type
+          # @see FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration#type
           module Type
             extend FinchAPI::Internal::Type::Enum