diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 3cf71e62..b386befd 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.18" + ".": "0.1.0-alpha.19" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index b63f6b19..eecdfce3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 46 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-dbbf65e94ae7a53cd5a313974761102447ccda3096fd40967c137ad3f80f7154.yml -openapi_spec_hash: 3cc9d87b60dc27283735d610d4b51a53 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-944a0f9d35f3b8ec2ba62fa12e551cf89f0b845f8ed1e3c7f67a9fb80b32d96f.yml +openapi_spec_hash: 37c849e7b5dd941c011385b49467e077 config_hash: 53778a0b839c4f6ad34fbba051f5e8a6 diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f36c25b..9dd515d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## 0.1.0-alpha.19 (2025-05-16) + +Full Changelog: [v0.1.0-alpha.18...v0.1.0-alpha.19](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.18...v0.1.0-alpha.19) + +### Features + +* **api:** api update ([e7b5270](https://github.com/Finch-API/finch-api-ruby/commit/e7b527009b74ba9ea5a0c681d12627617971ce31)) + + +### Chores + +* **internal:** version bump ([4c65aec](https://github.com/Finch-API/finch-api-ruby/commit/4c65aecc566acd9f72c296c003b12bd36acbd8ca)) + ## 0.1.0-alpha.18 (2025-05-16) Full Changelog: [v0.1.0-alpha.17...v0.1.0-alpha.18](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.17...v0.1.0-alpha.18) diff --git a/Gemfile.lock b/Gemfile.lock index 61347f18..f9b19ca2 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - finch-api (0.1.0.pre.alpha.17) + finch-api (0.1.0.pre.alpha.18) connection_pool GEM diff --git a/README.md b/README.md index 51701d52..6b40636d 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "finch-api", "~> 0.1.0.pre.alpha.18" +gem "finch-api", "~> 0.1.0.pre.alpha.19" ``` diff --git a/lib/finch_api/models/hris/employment_data.rb b/lib/finch_api/models/hris/employment_data.rb index 7370f73c..1f8e85e2 100644 --- a/lib/finch_api/models/hris/employment_data.rb +++ b/lib/finch_api/models/hris/employment_data.rb @@ -25,7 +25,8 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel # @!attribute custom_fields # Custom fields for the individual. These are fields which are defined by the - # employer in the system. + # employer in the system. Custom fields are not currently supported for assisted + # connections. # # @return [Array, nil] required :custom_fields, @@ -189,7 +190,7 @@ class CustomField < FinchAPI::Internal::Type::BaseModel # @!attribute name # # @return [String, nil] - optional :name, String + optional :name, String, nil?: true # @!attribute value # @@ -199,7 +200,7 @@ class CustomField < FinchAPI::Internal::Type::BaseModel nil?: true # @!method initialize(name: nil, value: nil) - # @param name [String] + # @param name [String, nil] # @param value [String, Array, Object, Float, Boolean, nil] # @see FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField#value @@ -222,7 +223,7 @@ module Value # @return [Array(String, Array, Object, Float, Boolean)] define_sorbet_constant!(:Variants) do - T.type_alias { T.any(String, T::Array[T.anything], T.anything, Float, T::Boolean) } + T.type_alias { T.nilable(T.any(String, T::Array[T.anything], T.anything, Float, T::Boolean)) } end # @type [FinchAPI::Internal::Type::Converter] diff --git a/lib/finch_api/models/sandbox/directory_create_params.rb b/lib/finch_api/models/sandbox/directory_create_params.rb index 7bddc314..fd1ae460 100644 --- a/lib/finch_api/models/sandbox/directory_create_params.rb +++ b/lib/finch_api/models/sandbox/directory_create_params.rb @@ -42,7 +42,8 @@ class Body < FinchAPI::Internal::Type::BaseModel optional :custom_fields, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField] - } + }, + nil?: true # @!attribute department # The department object. @@ -71,7 +72,8 @@ class Body < FinchAPI::Internal::Type::BaseModel 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] optional :employment_status, @@ -188,7 +190,7 @@ class Body < FinchAPI::Internal::Type::BaseModel # 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 @@ -216,7 +218,7 @@ class Body < FinchAPI::Internal::Type::BaseModel # # @param class_code [String, nil] Worker's compensation classification code for this employee # - # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl + # @param custom_fields [Array, 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. # @@ -226,7 +228,7 @@ class Body < FinchAPI::Internal::Type::BaseModel # # @param employment [FinchAPI::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::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 # @@ -260,7 +262,7 @@ class Body < FinchAPI::Internal::Type::BaseModel # # @param residence [FinchAPI::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 # @@ -356,7 +358,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel # # 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::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. @@ -392,7 +394,8 @@ module Type 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 module EmploymentStatus diff --git a/lib/finch_api/models/sandbox/employment_update_params.rb b/lib/finch_api/models/sandbox/employment_update_params.rb index c3449db2..a2e32117 100644 --- a/lib/finch_api/models/sandbox/employment_update_params.rb +++ b/lib/finch_api/models/sandbox/employment_update_params.rb @@ -23,7 +23,8 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel optional :custom_fields, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField] - } + }, + nil?: true # @!attribute department # The department object. @@ -38,7 +39,8 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::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::EmploymentUpdateParams::EmploymentStatus, nil] optional :employment_status, @@ -110,7 +112,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # The source system's unique employment identifier for this individual # # @return [String, nil] - optional :source_id, String + optional :source_id, String, nil?: true # @!attribute start_date # @@ -129,13 +131,13 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # # @param class_code [String, nil] Worker's compensation classification code for this employee # - # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl + # @param custom_fields [Array, 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 employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. + # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` # # @param end_date [String, nil] # @@ -157,7 +159,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # # @param middle_name [String, nil] The legal middle name of the individual. # - # @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 start_date [String, nil] # @@ -218,7 +220,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel # # The employment object. # - # @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti + # @param subtype [Symbol, FinchAPI::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. @@ -254,7 +256,8 @@ module Type 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`. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/sandbox/employment_update_response.rb b/lib/finch_api/models/sandbox/employment_update_response.rb index 2a8d48ed..3a415425 100644 --- a/lib/finch_api/models/sandbox/employment_update_response.rb +++ b/lib/finch_api/models/sandbox/employment_update_response.rb @@ -24,7 +24,8 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @return [Array, nil] optional :custom_fields, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] } + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] }, + nil?: true # @!attribute department # The department object. @@ -39,7 +40,8 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::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::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] optional :employment_status, @@ -111,7 +113,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # The source system's unique employment identifier for this individual # # @return [String, nil] - optional :source_id, String + optional :source_id, String, nil?: true # @!attribute start_date # @@ -132,13 +134,13 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @param class_code [String, nil] Worker's compensation classification code for this employee # - # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl + # @param custom_fields [Array, nil] Custom fields for the individual. These are fields which are defined by the empl # # @param department [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, nil] The department object. # # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. + # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` # # @param end_date [String, nil] # @@ -160,7 +162,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @param middle_name [String, nil] The legal middle name of the individual. # - # @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 start_date [String, nil] # @@ -222,7 +224,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel # # The employment object. # - # @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti + # @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim # # @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type, nil] The main employment type of the individual. @@ -258,7 +260,8 @@ module Type 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::Models::Sandbox::EmploymentUpdateResponse#employment_status module EmploymentStatus diff --git a/lib/finch_api/resources/sandbox/employment.rb b/lib/finch_api/resources/sandbox/employment.rb index 787fe7ce..9cb09c23 100644 --- a/lib/finch_api/resources/sandbox/employment.rb +++ b/lib/finch_api/resources/sandbox/employment.rb @@ -15,13 +15,13 @@ class Employment # # @param class_code [String, nil] Worker's compensation classification code for this employee # - # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl + # @param custom_fields [Array, 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 employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. + # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` # # @param end_date [String, nil] # @@ -43,7 +43,7 @@ class Employment # # @param middle_name [String, nil] The legal middle name of the individual. # - # @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 start_date [String, nil] # diff --git a/lib/finch_api/version.rb b/lib/finch_api/version.rb index e5497cfb..6a104193 100644 --- a/lib/finch_api/version.rb +++ b/lib/finch_api/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module FinchAPI - VERSION = "0.1.0.pre.alpha.18" + VERSION = "0.1.0.pre.alpha.19" end diff --git a/rbi/finch_api/models/hris/employment_data.rbi b/rbi/finch_api/models/hris/employment_data.rbi index 011235c4..18d2c3c8 100644 --- a/rbi/finch_api/models/hris/employment_data.rbi +++ b/rbi/finch_api/models/hris/employment_data.rbi @@ -32,7 +32,8 @@ module FinchAPI attr_accessor :class_code # Custom fields for the individual. These are fields which are defined by the - # employer in the system. + # employer in the system. Custom fields are not currently supported for assisted + # connections. sig do returns( T.nilable( @@ -217,7 +218,8 @@ module FinchAPI # Worker's compensation classification code for this employee class_code:, # Custom fields for the individual. These are fields which are defined by the - # employer in the system. + # employer in the system. Custom fields are not currently supported for assisted + # connections. custom_fields:, # The department object. department:, @@ -312,10 +314,7 @@ module FinchAPI end sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name + attr_accessor :name sig do returns( @@ -334,7 +333,7 @@ module FinchAPI sig do params( - name: String, + name: T.nilable(String), value: T.nilable( T.any( @@ -353,7 +352,7 @@ module FinchAPI sig do override.returns( { - name: String, + name: T.nilable(String), value: T.nilable( T.any( @@ -375,12 +374,14 @@ module FinchAPI Variants = T.type_alias do - T.any( - String, - T::Array[T.anything], - T.anything, - Float, - T::Boolean + T.nilable( + T.any( + String, + T::Array[T.anything], + T.anything, + Float, + T::Boolean + ) ) end diff --git a/rbi/finch_api/models/sandbox/directory_create_params.rbi b/rbi/finch_api/models/sandbox/directory_create_params.rbi index a1db145b..f415016f 100644 --- a/rbi/finch_api/models/sandbox/directory_create_params.rbi +++ b/rbi/finch_api/models/sandbox/directory_create_params.rbi @@ -83,17 +83,7 @@ module FinchAPI ) ) end - attr_reader :custom_fields - - sig do - params( - custom_fields: - T::Array[ - FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash - ] - ).void - end - attr_writer :custom_fields + attr_accessor :custom_fields # The department object. sig do @@ -147,7 +137,8 @@ module FinchAPI end attr_writer :employment - # The detailed employment status of the individual. + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. sig do returns( T.nilable( @@ -267,10 +258,7 @@ module FinchAPI # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } - attr_reader :source_id - - sig { params(source_id: String).void } - attr_writer :source_id + attr_accessor :source_id # Social Security Number of the individual. This field is only available with the # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the @@ -290,9 +278,11 @@ module FinchAPI params( class_code: T.nilable(String), custom_fields: - T::Array[ - FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash - ], + T.nilable( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash + ] + ), department: T.nilable( FinchAPI::Sandbox::DirectoryCreateParams::Body::Department::OrHash @@ -345,7 +335,7 @@ module FinchAPI ), preferred_name: T.nilable(String), residence: T.nilable(FinchAPI::Location::OrHash), - source_id: String, + source_id: T.nilable(String), ssn: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String) @@ -364,7 +354,8 @@ module FinchAPI emails: nil, # The employment object. employment: nil, - # The detailed employment status of the individual. + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. employment_status: nil, # Social Security Number of the individual in **encrypted** format. This field is # only available with the `ssn` scope enabled and the @@ -415,9 +406,11 @@ module FinchAPI { class_code: T.nilable(String), custom_fields: - T::Array[ - FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField - ], + T.nilable( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField + ] + ), department: T.nilable( FinchAPI::Sandbox::DirectoryCreateParams::Body::Department @@ -470,7 +463,7 @@ module FinchAPI ), preferred_name: T.nilable(String), residence: T.nilable(FinchAPI::Location), - source_id: String, + source_id: T.nilable(String), ssn: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String) @@ -785,7 +778,8 @@ 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`. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/rbi/finch_api/models/sandbox/employment_update_params.rbi b/rbi/finch_api/models/sandbox/employment_update_params.rbi index c63b7232..b00ad4aa 100644 --- a/rbi/finch_api/models/sandbox/employment_update_params.rbi +++ b/rbi/finch_api/models/sandbox/employment_update_params.rbi @@ -29,17 +29,7 @@ module FinchAPI ) ) end - attr_reader :custom_fields - - sig do - params( - custom_fields: - T::Array[ - FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash - ] - ).void - end - attr_writer :custom_fields + attr_accessor :custom_fields # The department object. sig do @@ -77,7 +67,8 @@ module FinchAPI end attr_writer :employment - # The detailed employment status of the individual. + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. sig do returns( T.nilable( @@ -146,10 +137,7 @@ module FinchAPI # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } - attr_reader :source_id - - sig { params(source_id: String).void } - attr_writer :source_id + attr_accessor :source_id sig { returns(T.nilable(String)) } attr_accessor :start_date @@ -162,9 +150,11 @@ module FinchAPI params( class_code: T.nilable(String), custom_fields: - T::Array[ - FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash - ], + T.nilable( + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash + ] + ), department: T.nilable( FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash @@ -191,7 +181,7 @@ module FinchAPI FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash ), middle_name: T.nilable(String), - source_id: String, + source_id: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String), request_options: FinchAPI::RequestOptions::OrHash @@ -208,7 +198,8 @@ module FinchAPI department: nil, # The employment object. employment: nil, - # The detailed employment status of the individual. + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. employment_status: nil, end_date: nil, # The legal first name of the individual. @@ -243,9 +234,11 @@ module FinchAPI { class_code: T.nilable(String), custom_fields: - T::Array[ - FinchAPI::Sandbox::EmploymentUpdateParams::CustomField - ], + T.nilable( + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::CustomField + ] + ), department: T.nilable( FinchAPI::Sandbox::EmploymentUpdateParams::Department @@ -269,7 +262,7 @@ module FinchAPI manager: T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Manager), middle_name: T.nilable(String), - source_id: String, + source_id: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String), request_options: FinchAPI::RequestOptions @@ -499,7 +492,8 @@ 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`. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/rbi/finch_api/models/sandbox/employment_update_response.rbi b/rbi/finch_api/models/sandbox/employment_update_response.rbi index 308d3fd6..722ecf21 100644 --- a/rbi/finch_api/models/sandbox/employment_update_response.rbi +++ b/rbi/finch_api/models/sandbox/employment_update_response.rbi @@ -35,17 +35,7 @@ module FinchAPI ) ) end - attr_reader :custom_fields - - sig do - params( - custom_fields: - T::Array[ - FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash - ] - ).void - end - attr_writer :custom_fields + attr_accessor :custom_fields # The department object. sig do @@ -87,7 +77,8 @@ module FinchAPI end attr_writer :employment - # The detailed employment status of the individual. + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. sig do returns( T.nilable( @@ -160,10 +151,7 @@ module FinchAPI # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } - attr_reader :source_id - - sig { params(source_id: String).void } - attr_writer :source_id + attr_accessor :source_id sig { returns(T.nilable(String)) } attr_accessor :start_date @@ -177,9 +165,11 @@ module FinchAPI id: String, class_code: T.nilable(String), custom_fields: - T::Array[ - FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash - ], + T.nilable( + T::Array[ + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash + ] + ), department: T.nilable( FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department::OrHash @@ -206,7 +196,7 @@ module FinchAPI FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager::OrHash ), middle_name: T.nilable(String), - source_id: String, + source_id: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String) ).returns(T.attached_class) @@ -224,7 +214,8 @@ module FinchAPI department: nil, # The employment object. employment: nil, - # The detailed employment status of the individual. + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. employment_status: nil, end_date: nil, # The legal first name of the individual. @@ -259,9 +250,11 @@ module FinchAPI id: String, class_code: T.nilable(String), custom_fields: - T::Array[ - FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField - ], + T.nilable( + T::Array[ + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField + ] + ), department: T.nilable( FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department @@ -287,7 +280,7 @@ module FinchAPI FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager ), middle_name: T.nilable(String), - source_id: String, + source_id: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String) } @@ -516,7 +509,8 @@ 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`. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/rbi/finch_api/resources/sandbox/employment.rbi b/rbi/finch_api/resources/sandbox/employment.rbi index 66137584..200984b1 100644 --- a/rbi/finch_api/resources/sandbox/employment.rbi +++ b/rbi/finch_api/resources/sandbox/employment.rbi @@ -10,9 +10,11 @@ module FinchAPI individual_id: String, class_code: T.nilable(String), custom_fields: - T::Array[ - FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash - ], + T.nilable( + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash + ] + ), department: T.nilable( FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash @@ -39,7 +41,7 @@ module FinchAPI FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash ), middle_name: T.nilable(String), - source_id: String, + source_id: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String), request_options: FinchAPI::RequestOptions::OrHash @@ -57,7 +59,8 @@ module FinchAPI department: nil, # The employment object. employment: nil, - # The detailed employment status of the individual. + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. employment_status: nil, end_date: nil, # The legal first name of the individual. diff --git a/sig/finch_api/models/hris/employment_data.rbs b/sig/finch_api/models/hris/employment_data.rbs index 0d2b6a4b..6d85a97b 100644 --- a/sig/finch_api/models/hris/employment_data.rbs +++ b/sig/finch_api/models/hris/employment_data.rbs @@ -98,23 +98,21 @@ module FinchAPI type custom_field = { - name: String, + name: String?, value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value? } class CustomField < FinchAPI::Internal::Type::BaseModel - attr_reader name: String? - - def name=: (String) -> String + attr_accessor name: String? attr_accessor value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value? def initialize: ( - ?name: String, + ?name: String?, ?value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value? ) -> void - type value = String | ::Array[top] | top | Float | bool + type value = (String | ::Array[top] | top | Float | bool)? module Value extend FinchAPI::Internal::Type::Union diff --git a/sig/finch_api/models/sandbox/directory_create_params.rbs b/sig/finch_api/models/sandbox/directory_create_params.rbs index a7902050..f7b64520 100644 --- a/sig/finch_api/models/sandbox/directory_create_params.rbs +++ b/sig/finch_api/models/sandbox/directory_create_params.rbs @@ -23,7 +23,7 @@ module FinchAPI type body = { class_code: String?, - custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField], + custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]?, department: FinchAPI::Sandbox::DirectoryCreateParams::Body::Department?, dob: String?, emails: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]?, @@ -45,7 +45,7 @@ module FinchAPI phone_numbers: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, preferred_name: String?, residence: FinchAPI::Location?, - source_id: String, + source_id: String?, ssn: String?, start_date: String?, title: String? @@ -54,11 +54,7 @@ module FinchAPI class Body < FinchAPI::Internal::Type::BaseModel attr_accessor class_code: String? - attr_reader custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]? - - def custom_fields=: ( - ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField] - ) -> ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField] + attr_accessor custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]? attr_accessor department: FinchAPI::Sandbox::DirectoryCreateParams::Body::Department? @@ -102,9 +98,7 @@ module FinchAPI attr_accessor residence: FinchAPI::Location? - attr_reader source_id: String? - - def source_id=: (String) -> String + attr_accessor source_id: String? attr_accessor ssn: String? @@ -114,7 +108,7 @@ module FinchAPI def initialize: ( ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField], + ?custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]?, ?department: FinchAPI::Sandbox::DirectoryCreateParams::Body::Department?, ?dob: String?, ?emails: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]?, @@ -136,7 +130,7 @@ module FinchAPI ?phone_numbers: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, ?preferred_name: String?, ?residence: FinchAPI::Location?, - ?source_id: String, + ?source_id: String?, ?ssn: String?, ?start_date: String?, ?title: String? diff --git a/sig/finch_api/models/sandbox/employment_update_params.rbs b/sig/finch_api/models/sandbox/employment_update_params.rbs index c1390400..b8f17cc8 100644 --- a/sig/finch_api/models/sandbox/employment_update_params.rbs +++ b/sig/finch_api/models/sandbox/employment_update_params.rbs @@ -4,7 +4,7 @@ module FinchAPI type employment_update_params = { class_code: String?, - custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField], + custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?, department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?, employment: FinchAPI::Sandbox::EmploymentUpdateParams::Employment?, employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, @@ -18,7 +18,7 @@ module FinchAPI location: FinchAPI::Location?, manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?, middle_name: String?, - source_id: String, + source_id: String?, start_date: String?, title: String? } @@ -30,11 +30,7 @@ module FinchAPI attr_accessor class_code: String? - attr_reader custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]? - - def custom_fields=: ( - ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField] - ) -> ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField] + attr_accessor custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]? attr_accessor department: FinchAPI::Sandbox::EmploymentUpdateParams::Department? @@ -62,9 +58,7 @@ module FinchAPI attr_accessor middle_name: String? - attr_reader source_id: String? - - def source_id=: (String) -> String + attr_accessor source_id: String? attr_accessor start_date: String? @@ -72,7 +66,7 @@ module FinchAPI def initialize: ( ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField], + ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?, ?department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?, ?employment: FinchAPI::Sandbox::EmploymentUpdateParams::Employment?, ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, @@ -86,7 +80,7 @@ module FinchAPI ?location: FinchAPI::Location?, ?manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?, ?middle_name: String?, - ?source_id: String, + ?source_id: String?, ?start_date: String?, ?title: String?, ?request_options: FinchAPI::request_opts diff --git a/sig/finch_api/models/sandbox/employment_update_response.rbs b/sig/finch_api/models/sandbox/employment_update_response.rbs index 457fdd8c..3ad57698 100644 --- a/sig/finch_api/models/sandbox/employment_update_response.rbs +++ b/sig/finch_api/models/sandbox/employment_update_response.rbs @@ -5,7 +5,7 @@ module FinchAPI { id: String, class_code: String?, - custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], + custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]?, department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?, employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?, employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?, @@ -19,7 +19,7 @@ module FinchAPI location: FinchAPI::Location?, manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?, middle_name: String?, - source_id: String, + source_id: String?, start_date: String?, title: String? } @@ -31,11 +31,7 @@ module FinchAPI attr_accessor class_code: String? - attr_reader custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]? - - def custom_fields=: ( - ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] - ) -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] + attr_accessor custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]? attr_accessor department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department? @@ -63,9 +59,7 @@ module FinchAPI attr_accessor middle_name: String? - attr_reader source_id: String? - - def source_id=: (String) -> String + attr_accessor source_id: String? attr_accessor start_date: String? @@ -74,7 +68,7 @@ module FinchAPI def initialize: ( ?id: String, ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]?, ?department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?, ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?, ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?, @@ -88,7 +82,7 @@ module FinchAPI ?location: FinchAPI::Location?, ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?, ?middle_name: String?, - ?source_id: String, + ?source_id: String?, ?start_date: String?, ?title: String? ) -> void diff --git a/sig/finch_api/resources/sandbox/employment.rbs b/sig/finch_api/resources/sandbox/employment.rbs index a5bdcd9c..d0db36dd 100644 --- a/sig/finch_api/resources/sandbox/employment.rbs +++ b/sig/finch_api/resources/sandbox/employment.rbs @@ -5,7 +5,7 @@ module FinchAPI def update: ( String individual_id, ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField], + ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?, ?department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?, ?employment: FinchAPI::Sandbox::EmploymentUpdateParams::Employment?, ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, @@ -19,7 +19,7 @@ module FinchAPI ?location: FinchAPI::Location?, ?manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?, ?middle_name: String?, - ?source_id: String, + ?source_id: String?, ?start_date: String?, ?title: String?, ?request_options: FinchAPI::request_opts