Skip to content

Commit e7b5270

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent 4c65aec commit e7b5270

File tree

16 files changed

+150
-174
lines changed

16 files changed

+150
-174
lines changed

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 46
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-dbbf65e94ae7a53cd5a313974761102447ccda3096fd40967c137ad3f80f7154.yml
3-
openapi_spec_hash: 3cc9d87b60dc27283735d610d4b51a53
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-944a0f9d35f3b8ec2ba62fa12e551cf89f0b845f8ed1e3c7f67a9fb80b32d96f.yml
3+
openapi_spec_hash: 37c849e7b5dd941c011385b49467e077
44
config_hash: 53778a0b839c4f6ad34fbba051f5e8a6

‎lib/finch_api/models/hris/employment_data.rb‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
2525

2626
# @!attribute custom_fields
2727
# Custom fields for the individual. These are fields which are defined by the
28-
# employer in the system.
28+
# employer in the system. Custom fields are not currently supported for assisted
29+
# connections.
2930
#
3031
# @return [Array<FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField>, nil]
3132
required :custom_fields,
@@ -189,7 +190,7 @@ class CustomField < FinchAPI::Internal::Type::BaseModel
189190
# @!attribute name
190191
#
191192
# @return [String, nil]
192-
optional :name, String
193+
optional :name, String, nil?: true
193194

194195
# @!attribute value
195196
#
@@ -199,7 +200,7 @@ class CustomField < FinchAPI::Internal::Type::BaseModel
199200
nil?: true
200201

201202
# @!method initialize(name: nil, value: nil)
202-
# @param name [String]
203+
# @param name [String, nil]
203204
# @param value [String, Array<Object>, Object, Float, Boolean, nil]
204205

205206
# @see FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField#value
@@ -222,7 +223,7 @@ module Value
222223
# @return [Array(String, Array<Object>, Object, Float, Boolean)]
223224

224225
define_sorbet_constant!(:Variants) do
225-
T.type_alias { T.any(String, T::Array[T.anything], T.anything, Float, T::Boolean) }
226+
T.type_alias { T.nilable(T.any(String, T::Array[T.anything], T.anything, Float, T::Boolean)) }
226227
end
227228

228229
# @type [FinchAPI::Internal::Type::Converter]

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

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ class Body < FinchAPI::Internal::Type::BaseModel
4242
optional :custom_fields,
4343
-> {
4444
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]
45-
}
45+
},
46+
nil?: true
4647

4748
# @!attribute department
4849
# The department object.
@@ -71,7 +72,8 @@ class Body < FinchAPI::Internal::Type::BaseModel
7172
optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true
7273

7374
# @!attribute employment_status
74-
# The detailed employment status of the individual.
75+
# The detailed employment status of the individual. Available options: `active`,
76+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
7577
#
7678
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
7779
optional :employment_status,
@@ -188,7 +190,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
188190
# The source system's unique employment identifier for this individual
189191
#
190192
# @return [String, nil]
191-
optional :source_id, String
193+
optional :source_id, String, nil?: true
192194

193195
# @!attribute ssn
194196
# Social Security Number of the individual. This field is only available with the
@@ -216,7 +218,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
216218
#
217219
# @param class_code [String, nil] Worker's compensation classification code for this employee
218220
#
219-
# @param custom_fields [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
221+
# @param custom_fields [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
220222
#
221223
# @param department [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object.
222224
#
@@ -226,7 +228,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
226228
#
227229
# @param employment [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
228230
#
229-
# @param employment_status [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual.
231+
# @param employment_status [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
230232
#
231233
# @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
232234
#
@@ -260,7 +262,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
260262
#
261263
# @param residence [FinchAPI::Location, nil]
262264
#
263-
# @param source_id [String] The source system's unique employment identifier for this individual
265+
# @param source_id [String, nil] The source system's unique employment identifier for this individual
264266
#
265267
# @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
266268
#
@@ -356,7 +358,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel
356358
#
357359
# The employment object.
358360
#
359-
# @param subtype [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
361+
# @param subtype [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
360362
#
361363
# @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual.
362364

@@ -392,7 +394,8 @@ module Type
392394
end
393395
end
394396

395-
# The detailed employment status of the individual.
397+
# The detailed employment status of the individual. Available options: `active`,
398+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
396399
#
397400
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment_status
398401
module EmploymentStatus

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

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
2323
optional :custom_fields,
2424
-> {
2525
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
26-
}
26+
},
27+
nil?: true
2728

2829
# @!attribute department
2930
# The department object.
@@ -38,7 +39,8 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
3839
optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true
3940

4041
# @!attribute employment_status
41-
# The detailed employment status of the individual.
42+
# The detailed employment status of the individual. Available options: `active`,
43+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
4244
#
4345
# @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
4446
optional :employment_status,
@@ -110,7 +112,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
110112
# The source system's unique employment identifier for this individual
111113
#
112114
# @return [String, nil]
113-
optional :source_id, String
115+
optional :source_id, String, nil?: true
114116

115117
# @!attribute start_date
116118
#
@@ -129,13 +131,13 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
129131
#
130132
# @param class_code [String, nil] Worker's compensation classification code for this employee
131133
#
132-
# @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
134+
# @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
133135
#
134136
# @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
135137
#
136138
# @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
137139
#
138-
# @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
140+
# @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
139141
#
140142
# @param end_date [String, nil]
141143
#
@@ -157,7 +159,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
157159
#
158160
# @param middle_name [String, nil] The legal middle name of the individual.
159161
#
160-
# @param source_id [String] The source system's unique employment identifier for this individual
162+
# @param source_id [String, nil] The source system's unique employment identifier for this individual
161163
#
162164
# @param start_date [String, nil]
163165
#
@@ -218,7 +220,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel
218220
#
219221
# The employment object.
220222
#
221-
# @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
223+
# @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
222224
#
223225
# @param type [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual.
224226

@@ -254,7 +256,8 @@ module Type
254256
end
255257
end
256258

257-
# The detailed employment status of the individual.
259+
# The detailed employment status of the individual. Available options: `active`,
260+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
258261
module EmploymentStatus
259262
extend FinchAPI::Internal::Type::Enum
260263

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

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
2424
#
2525
# @return [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>, nil]
2626
optional :custom_fields,
27-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] }
27+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] },
28+
nil?: true
2829

2930
# @!attribute department
3031
# The department object.
@@ -39,7 +40,8 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
3940
optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment }, nil?: true
4041

4142
# @!attribute employment_status
42-
# The detailed employment status of the individual.
43+
# The detailed employment status of the individual. Available options: `active`,
44+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
4345
#
4446
# @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil]
4547
optional :employment_status,
@@ -111,7 +113,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
111113
# The source system's unique employment identifier for this individual
112114
#
113115
# @return [String, nil]
114-
optional :source_id, String
116+
optional :source_id, String, nil?: true
115117

116118
# @!attribute start_date
117119
#
@@ -132,13 +134,13 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
132134
#
133135
# @param class_code [String, nil] Worker's compensation classification code for this employee
134136
#
135-
# @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
137+
# @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
136138
#
137139
# @param department [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, nil] The department object.
138140
#
139141
# @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, nil] The employment object.
140142
#
141-
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual.
143+
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
142144
#
143145
# @param end_date [String, nil]
144146
#
@@ -160,7 +162,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
160162
#
161163
# @param middle_name [String, nil] The legal middle name of the individual.
162164
#
163-
# @param source_id [String] The source system's unique employment identifier for this individual
165+
# @param source_id [String, nil] The source system's unique employment identifier for this individual
164166
#
165167
# @param start_date [String, nil]
166168
#
@@ -222,7 +224,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel
222224
#
223225
# The employment object.
224226
#
225-
# @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
227+
# @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
226228
#
227229
# @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type, nil] The main employment type of the individual.
228230

@@ -258,7 +260,8 @@ module Type
258260
end
259261
end
260262

261-
# The detailed employment status of the individual.
263+
# The detailed employment status of the individual. Available options: `active`,
264+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
262265
#
263266
# @see FinchAPI::Models::Sandbox::EmploymentUpdateResponse#employment_status
264267
module EmploymentStatus

‎lib/finch_api/resources/sandbox/employment.rb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ class Employment
1515
#
1616
# @param class_code [String, nil] Worker's compensation classification code for this employee
1717
#
18-
# @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
18+
# @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
1919
#
2020
# @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
2121
#
2222
# @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
2323
#
24-
# @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
24+
# @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
2525
#
2626
# @param end_date [String, nil]
2727
#
@@ -43,7 +43,7 @@ class Employment
4343
#
4444
# @param middle_name [String, nil] The legal middle name of the individual.
4545
#
46-
# @param source_id [String] The source system's unique employment identifier for this individual
46+
# @param source_id [String, nil] The source system's unique employment identifier for this individual
4747
#
4848
# @param start_date [String, nil]
4949
#

‎rbi/finch_api/models/hris/employment_data.rbi‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ module FinchAPI
3232
attr_accessor :class_code
3333

3434
# Custom fields for the individual. These are fields which are defined by the
35-
# employer in the system.
35+
# employer in the system. Custom fields are not currently supported for assisted
36+
# connections.
3637
sig do
3738
returns(
3839
T.nilable(
@@ -217,7 +218,8 @@ module FinchAPI
217218
# Worker's compensation classification code for this employee
218219
class_code:,
219220
# Custom fields for the individual. These are fields which are defined by the
220-
# employer in the system.
221+
# employer in the system. Custom fields are not currently supported for assisted
222+
# connections.
221223
custom_fields:,
222224
# The department object.
223225
department:,
@@ -312,10 +314,7 @@ module FinchAPI
312314
end
313315

314316
sig { returns(T.nilable(String)) }
315-
attr_reader :name
316-
317-
sig { params(name: String).void }
318-
attr_writer :name
317+
attr_accessor :name
319318

320319
sig do
321320
returns(
@@ -334,7 +333,7 @@ module FinchAPI
334333

335334
sig do
336335
params(
337-
name: String,
336+
name: T.nilable(String),
338337
value:
339338
T.nilable(
340339
T.any(
@@ -353,7 +352,7 @@ module FinchAPI
353352
sig do
354353
override.returns(
355354
{
356-
name: String,
355+
name: T.nilable(String),
357356
value:
358357
T.nilable(
359358
T.any(
@@ -375,12 +374,14 @@ module FinchAPI
375374

376375
Variants =
377376
T.type_alias do
378-
T.any(
379-
String,
380-
T::Array[T.anything],
381-
T.anything,
382-
Float,
383-
T::Boolean
377+
T.nilable(
378+
T.any(
379+
String,
380+
T::Array[T.anything],
381+
T.anything,
382+
Float,
383+
T::Boolean
384+
)
384385
)
385386
end
386387

0 commit comments

Comments
 (0)