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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: eddfa1529c8cfb3c7461b7553fc9ccebd1818115e88bd4a5a733dbcffad435d4
4
- data.tar.gz: 37306b10b432110b7b3ce09d4cd245b97b1dd16fe467b050e78a5a2101e18839
3
+ metadata.gz: 0ff09cfd2809bae5f9b52702347fcf21849a27675fb95528be522eafdf287f4e
4
+ data.tar.gz: 63986d1ec2d20d54b0aedbeb3e62de7aa35f23fa97950ac9c6c2dc7301c7ef2b
5
5
  SHA512:
6
- metadata.gz: 40f142561b69c398322f65338f567b6d7ed4e5c059ee067aaeddb2566be1ef3b1f19d9eac8bb635540cea61f1e1e63815020af5b3dc7ca9a920f8202f42d0a6f
7
- data.tar.gz: 6cf31655554a967db22163906ae8ea254457761f706ea5cdb5d1dbaf920bd4e55c72e4606525bbac868ec3e7b5b38c6c6135b48727f4e0ff717f9acad778bab9
6
+ metadata.gz: 8e5401957c9425a95156e4247e1ac2f5b38cb4733d6e7b2e1bc6d5546b676f2ff19940cfbcf87afaa1a9cbf8c6ef9ac946871a7ae855dcde208f361412e212b0
7
+ data.tar.gz: afdc341c62781b9e9602a529b4b65a62dbb488332d37b61b3e25b0869b105086e4612169836f2e06e9ac02683a4d2820597c9e43a84a989fb9f003c8f028e34e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.0-alpha.19 (2025-05-16)
4
+
5
+ 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)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([e7b5270](https://github.com/Finch-API/finch-api-ruby/commit/e7b527009b74ba9ea5a0c681d12627617971ce31))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **internal:** version bump ([4c65aec](https://github.com/Finch-API/finch-api-ruby/commit/4c65aecc566acd9f72c296c003b12bd36acbd8ca))
15
+
3
16
  ## 0.1.0-alpha.18 (2025-05-16)
4
17
 
5
18
  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)
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "finch-api", "~> 0.1.0.pre.alpha.18"
20
+ gem "finch-api", "~> 0.1.0.pre.alpha.19"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -25,7 +25,8 @@ module FinchAPI
25
25
 
26
26
  # @!attribute custom_fields
27
27
  # 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.
29
30
  #
30
31
  # @return [Array<FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField>, nil]
31
32
  required :custom_fields,
@@ -189,7 +190,7 @@ module FinchAPI
189
190
  # @!attribute name
190
191
  #
191
192
  # @return [String, nil]
192
- optional :name, String
193
+ optional :name, String, nil?: true
193
194
 
194
195
  # @!attribute value
195
196
  #
@@ -199,7 +200,7 @@ module FinchAPI
199
200
  nil?: true
200
201
 
201
202
  # @!method initialize(name: nil, value: nil)
202
- # @param name [String]
203
+ # @param name [String, nil]
203
204
  # @param value [String, Array<Object>, Object, Float, Boolean, nil]
204
205
 
205
206
  # @see FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField#value
@@ -222,7 +223,7 @@ module FinchAPI
222
223
  # @return [Array(String, Array<Object>, Object, Float, Boolean)]
223
224
 
224
225
  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)) }
226
227
  end
227
228
 
228
229
  # @type [FinchAPI::Internal::Type::Converter]
@@ -42,7 +42,8 @@ module FinchAPI
42
42
  optional :custom_fields,
43
43
  -> {
44
44
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]
45
- }
45
+ },
46
+ nil?: true
46
47
 
47
48
  # @!attribute department
48
49
  # The department object.
@@ -71,7 +72,8 @@ module FinchAPI
71
72
  optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true
72
73
 
73
74
  # @!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`.
75
77
  #
76
78
  # @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
77
79
  optional :employment_status,
@@ -188,7 +190,7 @@ module FinchAPI
188
190
  # The source system's unique employment identifier for this individual
189
191
  #
190
192
  # @return [String, nil]
191
- optional :source_id, String
193
+ optional :source_id, String, nil?: true
192
194
 
193
195
  # @!attribute ssn
194
196
  # Social Security Number of the individual. This field is only available with the
@@ -216,7 +218,7 @@ module FinchAPI
216
218
  #
217
219
  # @param class_code [String, nil] Worker's compensation classification code for this employee
218
220
  #
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
220
222
  #
221
223
  # @param department [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object.
222
224
  #
@@ -226,7 +228,7 @@ module FinchAPI
226
228
  #
227
229
  # @param employment [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
228
230
  #
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`, `
230
232
  #
231
233
  # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
232
234
  #
@@ -260,7 +262,7 @@ module FinchAPI
260
262
  #
261
263
  # @param residence [FinchAPI::Location, nil]
262
264
  #
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
264
266
  #
265
267
  # @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
266
268
  #
@@ -356,7 +358,7 @@ module FinchAPI
356
358
  #
357
359
  # The employment object.
358
360
  #
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
360
362
  #
361
363
  # @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual.
362
364
 
@@ -392,7 +394,8 @@ module FinchAPI
392
394
  end
393
395
  end
394
396
 
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`.
396
399
  #
397
400
  # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment_status
398
401
  module EmploymentStatus
@@ -23,7 +23,8 @@ module FinchAPI
23
23
  optional :custom_fields,
24
24
  -> {
25
25
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
26
- }
26
+ },
27
+ nil?: true
27
28
 
28
29
  # @!attribute department
29
30
  # The department object.
@@ -38,7 +39,8 @@ module FinchAPI
38
39
  optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true
39
40
 
40
41
  # @!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`.
42
44
  #
43
45
  # @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
44
46
  optional :employment_status,
@@ -110,7 +112,7 @@ module FinchAPI
110
112
  # The source system's unique employment identifier for this individual
111
113
  #
112
114
  # @return [String, nil]
113
- optional :source_id, String
115
+ optional :source_id, String, nil?: true
114
116
 
115
117
  # @!attribute start_date
116
118
  #
@@ -129,13 +131,13 @@ module FinchAPI
129
131
  #
130
132
  # @param class_code [String, nil] Worker's compensation classification code for this employee
131
133
  #
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
133
135
  #
134
136
  # @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
135
137
  #
136
138
  # @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
137
139
  #
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`, `
139
141
  #
140
142
  # @param end_date [String, nil]
141
143
  #
@@ -157,7 +159,7 @@ module FinchAPI
157
159
  #
158
160
  # @param middle_name [String, nil] The legal middle name of the individual.
159
161
  #
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
161
163
  #
162
164
  # @param start_date [String, nil]
163
165
  #
@@ -218,7 +220,7 @@ module FinchAPI
218
220
  #
219
221
  # The employment object.
220
222
  #
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
222
224
  #
223
225
  # @param type [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual.
224
226
 
@@ -254,7 +256,8 @@ module FinchAPI
254
256
  end
255
257
  end
256
258
 
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`.
258
261
  module EmploymentStatus
259
262
  extend FinchAPI::Internal::Type::Enum
260
263
 
@@ -24,7 +24,8 @@ module FinchAPI
24
24
  #
25
25
  # @return [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>, nil]
26
26
  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
28
29
 
29
30
  # @!attribute department
30
31
  # The department object.
@@ -39,7 +40,8 @@ module FinchAPI
39
40
  optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment }, nil?: true
40
41
 
41
42
  # @!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`.
43
45
  #
44
46
  # @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil]
45
47
  optional :employment_status,
@@ -111,7 +113,7 @@ module FinchAPI
111
113
  # The source system's unique employment identifier for this individual
112
114
  #
113
115
  # @return [String, nil]
114
- optional :source_id, String
116
+ optional :source_id, String, nil?: true
115
117
 
116
118
  # @!attribute start_date
117
119
  #
@@ -132,13 +134,13 @@ module FinchAPI
132
134
  #
133
135
  # @param class_code [String, nil] Worker's compensation classification code for this employee
134
136
  #
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
136
138
  #
137
139
  # @param department [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, nil] The department object.
138
140
  #
139
141
  # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, nil] The employment object.
140
142
  #
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`, `
142
144
  #
143
145
  # @param end_date [String, nil]
144
146
  #
@@ -160,7 +162,7 @@ module FinchAPI
160
162
  #
161
163
  # @param middle_name [String, nil] The legal middle name of the individual.
162
164
  #
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
164
166
  #
165
167
  # @param start_date [String, nil]
166
168
  #
@@ -222,7 +224,7 @@ module FinchAPI
222
224
  #
223
225
  # The employment object.
224
226
  #
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
226
228
  #
227
229
  # @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type, nil] The main employment type of the individual.
228
230
 
@@ -258,7 +260,8 @@ module FinchAPI
258
260
  end
259
261
  end
260
262
 
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`.
262
265
  #
263
266
  # @see FinchAPI::Models::Sandbox::EmploymentUpdateResponse#employment_status
264
267
  module EmploymentStatus
@@ -15,13 +15,13 @@ module FinchAPI
15
15
  #
16
16
  # @param class_code [String, nil] Worker's compensation classification code for this employee
17
17
  #
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
19
19
  #
20
20
  # @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
21
21
  #
22
22
  # @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
23
23
  #
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`, `
25
25
  #
26
26
  # @param end_date [String, nil]
27
27
  #
@@ -43,7 +43,7 @@ module FinchAPI
43
43
  #
44
44
  # @param middle_name [String, nil] The legal middle name of the individual.
45
45
  #
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
47
47
  #
48
48
  # @param start_date [String, nil]
49
49
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module FinchAPI
4
- VERSION = "0.1.0.pre.alpha.18"
4
+ VERSION = "0.1.0.pre.alpha.19"
5
5
  end
@@ -32,7 +32,8 @@ module FinchAPI
32
32
  attr_accessor :class_code
33
33
 
34
34
  # 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.
36
37
  sig do
37
38
  returns(
38
39
  T.nilable(
@@ -217,7 +218,8 @@ module FinchAPI
217
218
  # Worker's compensation classification code for this employee
218
219
  class_code:,
219
220
  # 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.
221
223
  custom_fields:,
222
224
  # The department object.
223
225
  department:,
@@ -312,10 +314,7 @@ module FinchAPI
312
314
  end
313
315
 
314
316
  sig { returns(T.nilable(String)) }
315
- attr_reader :name
316
-
317
- sig { params(name: String).void }
318
- attr_writer :name
317
+ attr_accessor :name
319
318
 
320
319
  sig do
321
320
  returns(
@@ -334,7 +333,7 @@ module FinchAPI
334
333
 
335
334
  sig do
336
335
  params(
337
- name: String,
336
+ name: T.nilable(String),
338
337
  value:
339
338
  T.nilable(
340
339
  T.any(
@@ -353,7 +352,7 @@ module FinchAPI
353
352
  sig do
354
353
  override.returns(
355
354
  {
356
- name: String,
355
+ name: T.nilable(String),
357
356
  value:
358
357
  T.nilable(
359
358
  T.any(
@@ -375,12 +374,14 @@ module FinchAPI
375
374
 
376
375
  Variants =
377
376
  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
+ )
384
385
  )
385
386
  end
386
387
 
@@ -83,17 +83,7 @@ module FinchAPI
83
83
  )
84
84
  )
85
85
  end
86
- attr_reader :custom_fields
87
-
88
- sig do
89
- params(
90
- custom_fields:
91
- T::Array[
92
- FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash
93
- ]
94
- ).void
95
- end
96
- attr_writer :custom_fields
86
+ attr_accessor :custom_fields
97
87
 
98
88
  # The department object.
99
89
  sig do
@@ -147,7 +137,8 @@ module FinchAPI
147
137
  end
148
138
  attr_writer :employment
149
139
 
150
- # The detailed employment status of the individual.
140
+ # The detailed employment status of the individual. Available options: `active`,
141
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
151
142
  sig do
152
143
  returns(
153
144
  T.nilable(
@@ -267,10 +258,7 @@ module FinchAPI
267
258
 
268
259
  # The source system's unique employment identifier for this individual
269
260
  sig { returns(T.nilable(String)) }
270
- attr_reader :source_id
271
-
272
- sig { params(source_id: String).void }
273
- attr_writer :source_id
261
+ attr_accessor :source_id
274
262
 
275
263
  # Social Security Number of the individual. This field is only available with the
276
264
  # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
@@ -290,9 +278,11 @@ module FinchAPI
290
278
  params(
291
279
  class_code: T.nilable(String),
292
280
  custom_fields:
293
- T::Array[
294
- FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash
295
- ],
281
+ T.nilable(
282
+ T::Array[
283
+ FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash
284
+ ]
285
+ ),
296
286
  department:
297
287
  T.nilable(
298
288
  FinchAPI::Sandbox::DirectoryCreateParams::Body::Department::OrHash
@@ -345,7 +335,7 @@ module FinchAPI
345
335
  ),
346
336
  preferred_name: T.nilable(String),
347
337
  residence: T.nilable(FinchAPI::Location::OrHash),
348
- source_id: String,
338
+ source_id: T.nilable(String),
349
339
  ssn: T.nilable(String),
350
340
  start_date: T.nilable(String),
351
341
  title: T.nilable(String)
@@ -364,7 +354,8 @@ module FinchAPI
364
354
  emails: nil,
365
355
  # The employment object.
366
356
  employment: nil,
367
- # The detailed employment status of the individual.
357
+ # The detailed employment status of the individual. Available options: `active`,
358
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
368
359
  employment_status: nil,
369
360
  # Social Security Number of the individual in **encrypted** format. This field is
370
361
  # only available with the `ssn` scope enabled and the
@@ -415,9 +406,11 @@ module FinchAPI
415
406
  {
416
407
  class_code: T.nilable(String),
417
408
  custom_fields:
418
- T::Array[
419
- FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField
420
- ],
409
+ T.nilable(
410
+ T::Array[
411
+ FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField
412
+ ]
413
+ ),
421
414
  department:
422
415
  T.nilable(
423
416
  FinchAPI::Sandbox::DirectoryCreateParams::Body::Department
@@ -470,7 +463,7 @@ module FinchAPI
470
463
  ),
471
464
  preferred_name: T.nilable(String),
472
465
  residence: T.nilable(FinchAPI::Location),
473
- source_id: String,
466
+ source_id: T.nilable(String),
474
467
  ssn: T.nilable(String),
475
468
  start_date: T.nilable(String),
476
469
  title: T.nilable(String)
@@ -785,7 +778,8 @@ module FinchAPI
785
778
  end
786
779
  end
787
780
 
788
- # The detailed employment status of the individual.
781
+ # The detailed employment status of the individual. Available options: `active`,
782
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
789
783
  module EmploymentStatus
790
784
  extend FinchAPI::Internal::Type::Enum
791
785
 
@@ -29,17 +29,7 @@ module FinchAPI
29
29
  )
30
30
  )
31
31
  end
32
- attr_reader :custom_fields
33
-
34
- sig do
35
- params(
36
- custom_fields:
37
- T::Array[
38
- FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
39
- ]
40
- ).void
41
- end
42
- attr_writer :custom_fields
32
+ attr_accessor :custom_fields
43
33
 
44
34
  # The department object.
45
35
  sig do
@@ -77,7 +67,8 @@ module FinchAPI
77
67
  end
78
68
  attr_writer :employment
79
69
 
80
- # The detailed employment status of the individual.
70
+ # The detailed employment status of the individual. Available options: `active`,
71
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
81
72
  sig do
82
73
  returns(
83
74
  T.nilable(
@@ -146,10 +137,7 @@ module FinchAPI
146
137
 
147
138
  # The source system's unique employment identifier for this individual
148
139
  sig { returns(T.nilable(String)) }
149
- attr_reader :source_id
150
-
151
- sig { params(source_id: String).void }
152
- attr_writer :source_id
140
+ attr_accessor :source_id
153
141
 
154
142
  sig { returns(T.nilable(String)) }
155
143
  attr_accessor :start_date
@@ -162,9 +150,11 @@ module FinchAPI
162
150
  params(
163
151
  class_code: T.nilable(String),
164
152
  custom_fields:
165
- T::Array[
166
- FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
167
- ],
153
+ T.nilable(
154
+ T::Array[
155
+ FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
156
+ ]
157
+ ),
168
158
  department:
169
159
  T.nilable(
170
160
  FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash
@@ -191,7 +181,7 @@ module FinchAPI
191
181
  FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash
192
182
  ),
193
183
  middle_name: T.nilable(String),
194
- source_id: String,
184
+ source_id: T.nilable(String),
195
185
  start_date: T.nilable(String),
196
186
  title: T.nilable(String),
197
187
  request_options: FinchAPI::RequestOptions::OrHash
@@ -208,7 +198,8 @@ module FinchAPI
208
198
  department: nil,
209
199
  # The employment object.
210
200
  employment: nil,
211
- # The detailed employment status of the individual.
201
+ # The detailed employment status of the individual. Available options: `active`,
202
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
212
203
  employment_status: nil,
213
204
  end_date: nil,
214
205
  # The legal first name of the individual.
@@ -243,9 +234,11 @@ module FinchAPI
243
234
  {
244
235
  class_code: T.nilable(String),
245
236
  custom_fields:
246
- T::Array[
247
- FinchAPI::Sandbox::EmploymentUpdateParams::CustomField
248
- ],
237
+ T.nilable(
238
+ T::Array[
239
+ FinchAPI::Sandbox::EmploymentUpdateParams::CustomField
240
+ ]
241
+ ),
249
242
  department:
250
243
  T.nilable(
251
244
  FinchAPI::Sandbox::EmploymentUpdateParams::Department
@@ -269,7 +262,7 @@ module FinchAPI
269
262
  manager:
270
263
  T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Manager),
271
264
  middle_name: T.nilable(String),
272
- source_id: String,
265
+ source_id: T.nilable(String),
273
266
  start_date: T.nilable(String),
274
267
  title: T.nilable(String),
275
268
  request_options: FinchAPI::RequestOptions
@@ -499,7 +492,8 @@ module FinchAPI
499
492
  end
500
493
  end
501
494
 
502
- # The detailed employment status of the individual.
495
+ # The detailed employment status of the individual. Available options: `active`,
496
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
503
497
  module EmploymentStatus
504
498
  extend FinchAPI::Internal::Type::Enum
505
499
 
@@ -35,17 +35,7 @@ module FinchAPI
35
35
  )
36
36
  )
37
37
  end
38
- attr_reader :custom_fields
39
-
40
- sig do
41
- params(
42
- custom_fields:
43
- T::Array[
44
- FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash
45
- ]
46
- ).void
47
- end
48
- attr_writer :custom_fields
38
+ attr_accessor :custom_fields
49
39
 
50
40
  # The department object.
51
41
  sig do
@@ -87,7 +77,8 @@ module FinchAPI
87
77
  end
88
78
  attr_writer :employment
89
79
 
90
- # The detailed employment status of the individual.
80
+ # The detailed employment status of the individual. Available options: `active`,
81
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
91
82
  sig do
92
83
  returns(
93
84
  T.nilable(
@@ -160,10 +151,7 @@ module FinchAPI
160
151
 
161
152
  # The source system's unique employment identifier for this individual
162
153
  sig { returns(T.nilable(String)) }
163
- attr_reader :source_id
164
-
165
- sig { params(source_id: String).void }
166
- attr_writer :source_id
154
+ attr_accessor :source_id
167
155
 
168
156
  sig { returns(T.nilable(String)) }
169
157
  attr_accessor :start_date
@@ -177,9 +165,11 @@ module FinchAPI
177
165
  id: String,
178
166
  class_code: T.nilable(String),
179
167
  custom_fields:
180
- T::Array[
181
- FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash
182
- ],
168
+ T.nilable(
169
+ T::Array[
170
+ FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash
171
+ ]
172
+ ),
183
173
  department:
184
174
  T.nilable(
185
175
  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department::OrHash
@@ -206,7 +196,7 @@ module FinchAPI
206
196
  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager::OrHash
207
197
  ),
208
198
  middle_name: T.nilable(String),
209
- source_id: String,
199
+ source_id: T.nilable(String),
210
200
  start_date: T.nilable(String),
211
201
  title: T.nilable(String)
212
202
  ).returns(T.attached_class)
@@ -224,7 +214,8 @@ module FinchAPI
224
214
  department: nil,
225
215
  # The employment object.
226
216
  employment: nil,
227
- # The detailed employment status of the individual.
217
+ # The detailed employment status of the individual. Available options: `active`,
218
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
228
219
  employment_status: nil,
229
220
  end_date: nil,
230
221
  # The legal first name of the individual.
@@ -259,9 +250,11 @@ module FinchAPI
259
250
  id: String,
260
251
  class_code: T.nilable(String),
261
252
  custom_fields:
262
- T::Array[
263
- FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField
264
- ],
253
+ T.nilable(
254
+ T::Array[
255
+ FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField
256
+ ]
257
+ ),
265
258
  department:
266
259
  T.nilable(
267
260
  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department
@@ -287,7 +280,7 @@ module FinchAPI
287
280
  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager
288
281
  ),
289
282
  middle_name: T.nilable(String),
290
- source_id: String,
283
+ source_id: T.nilable(String),
291
284
  start_date: T.nilable(String),
292
285
  title: T.nilable(String)
293
286
  }
@@ -516,7 +509,8 @@ module FinchAPI
516
509
  end
517
510
  end
518
511
 
519
- # The detailed employment status of the individual.
512
+ # The detailed employment status of the individual. Available options: `active`,
513
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
520
514
  module EmploymentStatus
521
515
  extend FinchAPI::Internal::Type::Enum
522
516
 
@@ -10,9 +10,11 @@ module FinchAPI
10
10
  individual_id: String,
11
11
  class_code: T.nilable(String),
12
12
  custom_fields:
13
- T::Array[
14
- FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
15
- ],
13
+ T.nilable(
14
+ T::Array[
15
+ FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
16
+ ]
17
+ ),
16
18
  department:
17
19
  T.nilable(
18
20
  FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash
@@ -39,7 +41,7 @@ module FinchAPI
39
41
  FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash
40
42
  ),
41
43
  middle_name: T.nilable(String),
42
- source_id: String,
44
+ source_id: T.nilable(String),
43
45
  start_date: T.nilable(String),
44
46
  title: T.nilable(String),
45
47
  request_options: FinchAPI::RequestOptions::OrHash
@@ -57,7 +59,8 @@ module FinchAPI
57
59
  department: nil,
58
60
  # The employment object.
59
61
  employment: nil,
60
- # The detailed employment status of the individual.
62
+ # The detailed employment status of the individual. Available options: `active`,
63
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
61
64
  employment_status: nil,
62
65
  end_date: nil,
63
66
  # The legal first name of the individual.
@@ -98,23 +98,21 @@ module FinchAPI
98
98
 
99
99
  type custom_field =
100
100
  {
101
- name: String,
101
+ name: String?,
102
102
  value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value?
103
103
  }
104
104
 
105
105
  class CustomField < FinchAPI::Internal::Type::BaseModel
106
- attr_reader name: String?
107
-
108
- def name=: (String) -> String
106
+ attr_accessor name: String?
109
107
 
110
108
  attr_accessor value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value?
111
109
 
112
110
  def initialize: (
113
- ?name: String,
111
+ ?name: String?,
114
112
  ?value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value?
115
113
  ) -> void
116
114
 
117
- type value = String | ::Array[top] | top | Float | bool
115
+ type value = (String | ::Array[top] | top | Float | bool)?
118
116
 
119
117
  module Value
120
118
  extend FinchAPI::Internal::Type::Union
@@ -23,7 +23,7 @@ module FinchAPI
23
23
  type body =
24
24
  {
25
25
  class_code: String?,
26
- custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField],
26
+ custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]?,
27
27
  department: FinchAPI::Sandbox::DirectoryCreateParams::Body::Department?,
28
28
  dob: String?,
29
29
  emails: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]?,
@@ -45,7 +45,7 @@ module FinchAPI
45
45
  phone_numbers: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?,
46
46
  preferred_name: String?,
47
47
  residence: FinchAPI::Location?,
48
- source_id: String,
48
+ source_id: String?,
49
49
  ssn: String?,
50
50
  start_date: String?,
51
51
  title: String?
@@ -54,11 +54,7 @@ module FinchAPI
54
54
  class Body < FinchAPI::Internal::Type::BaseModel
55
55
  attr_accessor class_code: String?
56
56
 
57
- attr_reader custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]?
58
-
59
- def custom_fields=: (
60
- ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]
61
- ) -> ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]
57
+ attr_accessor custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]?
62
58
 
63
59
  attr_accessor department: FinchAPI::Sandbox::DirectoryCreateParams::Body::Department?
64
60
 
@@ -102,9 +98,7 @@ module FinchAPI
102
98
 
103
99
  attr_accessor residence: FinchAPI::Location?
104
100
 
105
- attr_reader source_id: String?
106
-
107
- def source_id=: (String) -> String
101
+ attr_accessor source_id: String?
108
102
 
109
103
  attr_accessor ssn: String?
110
104
 
@@ -114,7 +108,7 @@ module FinchAPI
114
108
 
115
109
  def initialize: (
116
110
  ?class_code: String?,
117
- ?custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField],
111
+ ?custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]?,
118
112
  ?department: FinchAPI::Sandbox::DirectoryCreateParams::Body::Department?,
119
113
  ?dob: String?,
120
114
  ?emails: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]?,
@@ -136,7 +130,7 @@ module FinchAPI
136
130
  ?phone_numbers: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?,
137
131
  ?preferred_name: String?,
138
132
  ?residence: FinchAPI::Location?,
139
- ?source_id: String,
133
+ ?source_id: String?,
140
134
  ?ssn: String?,
141
135
  ?start_date: String?,
142
136
  ?title: String?
@@ -4,7 +4,7 @@ module FinchAPI
4
4
  type employment_update_params =
5
5
  {
6
6
  class_code: String?,
7
- custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField],
7
+ custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?,
8
8
  department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?,
9
9
  employment: FinchAPI::Sandbox::EmploymentUpdateParams::Employment?,
10
10
  employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?,
@@ -18,7 +18,7 @@ module FinchAPI
18
18
  location: FinchAPI::Location?,
19
19
  manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?,
20
20
  middle_name: String?,
21
- source_id: String,
21
+ source_id: String?,
22
22
  start_date: String?,
23
23
  title: String?
24
24
  }
@@ -30,11 +30,7 @@ module FinchAPI
30
30
 
31
31
  attr_accessor class_code: String?
32
32
 
33
- attr_reader custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?
34
-
35
- def custom_fields=: (
36
- ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
37
- ) -> ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
33
+ attr_accessor custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?
38
34
 
39
35
  attr_accessor department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?
40
36
 
@@ -62,9 +58,7 @@ module FinchAPI
62
58
 
63
59
  attr_accessor middle_name: String?
64
60
 
65
- attr_reader source_id: String?
66
-
67
- def source_id=: (String) -> String
61
+ attr_accessor source_id: String?
68
62
 
69
63
  attr_accessor start_date: String?
70
64
 
@@ -72,7 +66,7 @@ module FinchAPI
72
66
 
73
67
  def initialize: (
74
68
  ?class_code: String?,
75
- ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField],
69
+ ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?,
76
70
  ?department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?,
77
71
  ?employment: FinchAPI::Sandbox::EmploymentUpdateParams::Employment?,
78
72
  ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?,
@@ -86,7 +80,7 @@ module FinchAPI
86
80
  ?location: FinchAPI::Location?,
87
81
  ?manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?,
88
82
  ?middle_name: String?,
89
- ?source_id: String,
83
+ ?source_id: String?,
90
84
  ?start_date: String?,
91
85
  ?title: String?,
92
86
  ?request_options: FinchAPI::request_opts
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  {
6
6
  id: String,
7
7
  class_code: String?,
8
- custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField],
8
+ custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]?,
9
9
  department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?,
10
10
  employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?,
11
11
  employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?,
@@ -19,7 +19,7 @@ module FinchAPI
19
19
  location: FinchAPI::Location?,
20
20
  manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?,
21
21
  middle_name: String?,
22
- source_id: String,
22
+ source_id: String?,
23
23
  start_date: String?,
24
24
  title: String?
25
25
  }
@@ -31,11 +31,7 @@ module FinchAPI
31
31
 
32
32
  attr_accessor class_code: String?
33
33
 
34
- attr_reader custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]?
35
-
36
- def custom_fields=: (
37
- ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]
38
- ) -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]
34
+ attr_accessor custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]?
39
35
 
40
36
  attr_accessor department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?
41
37
 
@@ -63,9 +59,7 @@ module FinchAPI
63
59
 
64
60
  attr_accessor middle_name: String?
65
61
 
66
- attr_reader source_id: String?
67
-
68
- def source_id=: (String) -> String
62
+ attr_accessor source_id: String?
69
63
 
70
64
  attr_accessor start_date: String?
71
65
 
@@ -74,7 +68,7 @@ module FinchAPI
74
68
  def initialize: (
75
69
  ?id: String,
76
70
  ?class_code: String?,
77
- ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField],
71
+ ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]?,
78
72
  ?department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?,
79
73
  ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?,
80
74
  ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?,
@@ -88,7 +82,7 @@ module FinchAPI
88
82
  ?location: FinchAPI::Location?,
89
83
  ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?,
90
84
  ?middle_name: String?,
91
- ?source_id: String,
85
+ ?source_id: String?,
92
86
  ?start_date: String?,
93
87
  ?title: String?
94
88
  ) -> void
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  def update: (
6
6
  String individual_id,
7
7
  ?class_code: String?,
8
- ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField],
8
+ ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?,
9
9
  ?department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?,
10
10
  ?employment: FinchAPI::Sandbox::EmploymentUpdateParams::Employment?,
11
11
  ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?,
@@ -19,7 +19,7 @@ module FinchAPI
19
19
  ?location: FinchAPI::Location?,
20
20
  ?manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?,
21
21
  ?middle_name: String?,
22
- ?source_id: String,
22
+ ?source_id: String?,
23
23
  ?start_date: String?,
24
24
  ?title: String?,
25
25
  ?request_options: FinchAPI::request_opts
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: finch-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0.pre.alpha.18
4
+ version: 0.1.0.pre.alpha.19
5
5
  platform: ruby
6
6
  authors:
7
7
  - Finch
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-05-16 00:00:00.000000000 Z
11
+ date: 2025-05-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool