finch-api 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17
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 +4 -4
- data/CHANGELOG.md +38 -0
- data/README.md +92 -53
- data/lib/finch_api/client.rb +4 -4
- data/lib/finch_api/errors.rb +1 -1
- data/lib/finch_api/internal/transport/base_client.rb +77 -5
- data/lib/finch_api/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/finch_api/internal/type/array_of.rb +1 -1
- data/lib/finch_api/internal/type/base_model.rb +70 -30
- data/lib/finch_api/internal/type/converter.rb +18 -0
- data/lib/finch_api/internal/type/enum.rb +1 -0
- data/lib/finch_api/internal/type/hash_of.rb +1 -1
- data/lib/finch_api/internal/type/union.rb +1 -0
- data/lib/finch_api/internal/util.rb +56 -0
- data/lib/finch_api/internal.rb +6 -0
- data/lib/finch_api/models/hris/document_retreive_response.rb +4 -0
- data/lib/finch_api/models/hris/employment_data.rb +10 -0
- data/lib/finch_api/models/hris/individual.rb +6 -0
- data/lib/finch_api/models/hris/pay_statement.rb +1 -0
- data/lib/finch_api/models/sandbox/payment_create_params.rb +1 -0
- data/lib/finch_api/models/webhook_event.rb +15 -0
- data/lib/finch_api/models.rb +27 -0
- data/lib/finch_api/request_options.rb +4 -0
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +2 -0
- data/rbi/finch_api/internal/transport/base_client.rbi +31 -16
- data/rbi/finch_api/internal/transport/pooled_net_requester.rbi +10 -5
- data/rbi/finch_api/internal/type/base_model.rbi +33 -15
- data/rbi/finch_api/internal/type/base_page.rbi +1 -2
- data/rbi/finch_api/internal/type/converter.rbi +2 -0
- data/rbi/finch_api/internal/type/enum.rbi +1 -0
- data/rbi/finch_api/internal/type/union.rbi +1 -0
- data/rbi/finch_api/internal/util.rbi +28 -5
- data/rbi/finch_api/internal.rbi +2 -0
- data/rbi/finch_api/models/access_token_create_params.rbi +4 -1
- data/rbi/finch_api/models/account_disconnect_params.rbi +4 -1
- data/rbi/finch_api/models/account_introspect_params.rbi +4 -1
- data/rbi/finch_api/models/account_update_event.rbi +156 -34
- data/rbi/finch_api/models/base_webhook_event.rbi +4 -1
- data/rbi/finch_api/models/company_event.rbi +4 -1
- data/rbi/finch_api/models/connect/session_new_params.rbi +12 -2
- data/rbi/finch_api/models/connect/session_new_response.rbi +6 -1
- data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +6 -1
- data/rbi/finch_api/models/connect/session_reauthenticate_response.rbi +6 -1
- data/rbi/finch_api/models/create_access_token_response.rbi +7 -1
- data/rbi/finch_api/models/directory_event.rbi +7 -2
- data/rbi/finch_api/models/disconnect_response.rbi +4 -1
- data/rbi/finch_api/models/employment_event.rbi +7 -2
- data/rbi/finch_api/models/hris/benefit_contribution.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_create_params.rbi +18 -3
- data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +12 -2
- data/rbi/finch_api/models/hris/benefit_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_update_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +12 -2
- data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +26 -5
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits_support.rbi +3 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +6 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +6 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +12 -2
- data/rbi/finch_api/models/hris/company.rbi +27 -5
- data/rbi/finch_api/models/hris/company_benefit.rbi +15 -3
- data/rbi/finch_api/models/hris/company_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/hris/create_company_benefits_response.rbi +6 -1
- data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +6 -1
- data/rbi/finch_api/models/hris/directory_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/document_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/document_list_response.rbi +6 -1
- data/rbi/finch_api/models/hris/document_response.rbi +3 -1
- data/rbi/finch_api/models/hris/document_retreive_params.rbi +6 -1
- data/rbi/finch_api/models/hris/employment_data.rbi +36 -6
- data/rbi/finch_api/models/hris/employment_data_response.rbi +6 -1
- data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +12 -2
- data/rbi/finch_api/models/hris/individual.rbi +24 -4
- data/rbi/finch_api/models/hris/individual_in_directory.rbi +18 -3
- data/rbi/finch_api/models/hris/individual_response.rbi +6 -1
- data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +18 -3
- data/rbi/finch_api/models/hris/pay_statement.rbi +80 -13
- data/rbi/finch_api/models/hris/pay_statement_response.rbi +6 -1
- data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +6 -1
- data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +12 -2
- data/rbi/finch_api/models/hris/payment.rbi +9 -2
- data/rbi/finch_api/models/hris/payment_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/support_per_benefit_type.rbi +6 -1
- data/rbi/finch_api/models/hris/supported_benefit.rbi +3 -1
- data/rbi/finch_api/models/hris/update_company_benefit_response.rbi +6 -1
- data/rbi/finch_api/models/hris/w42005.rbi +6 -2
- data/rbi/finch_api/models/hris/w42020.rbi +6 -2
- data/rbi/finch_api/models/income.rbi +2 -1
- data/rbi/finch_api/models/individual_event.rbi +7 -2
- data/rbi/finch_api/models/introspection.rbi +22 -4
- data/rbi/finch_api/models/job_completion_event.rbi +10 -2
- data/rbi/finch_api/models/jobs/automated_async_job.rbi +12 -2
- data/rbi/finch_api/models/jobs/automated_create_params.rbi +12 -2
- data/rbi/finch_api/models/jobs/automated_create_response.rbi +6 -1
- data/rbi/finch_api/models/jobs/automated_list_params.rbi +6 -1
- data/rbi/finch_api/models/jobs/automated_list_response.rbi +24 -4
- data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/jobs/manual_async_job.rbi +3 -1
- data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/location.rbi +2 -1
- data/rbi/finch_api/models/money.rbi +2 -1
- data/rbi/finch_api/models/operation_support_matrix.rbi +4 -1
- data/rbi/finch_api/models/paging.rbi +2 -1
- data/rbi/finch_api/models/pay_statement_event.rbi +10 -2
- data/rbi/finch_api/models/payment_event.rbi +7 -2
- data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +6 -1
- data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +6 -1
- data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +6 -1
- data/rbi/finch_api/models/provider.rbi +182 -33
- data/rbi/finch_api/models/provider_list_params.rbi +4 -1
- data/rbi/finch_api/models/request_forwarding_forward_params.rbi +7 -1
- data/rbi/finch_api/models/request_forwarding_forward_response.rbi +13 -2
- data/rbi/finch_api/models/sandbox/company_update_params.rbi +30 -5
- data/rbi/finch_api/models/sandbox/company_update_response.rbi +30 -5
- data/rbi/finch_api/models/sandbox/connection_create_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connection_create_response.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connections/account_create_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connections/account_update_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +6 -1
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +48 -8
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +30 -5
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +30 -5
- data/rbi/finch_api/models/sandbox/individual_update_params.rbi +18 -3
- data/rbi/finch_api/models/sandbox/individual_update_response.rbi +18 -3
- data/rbi/finch_api/models/sandbox/job_create_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/job_create_response.rbi +6 -1
- data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi +6 -1
- data/rbi/finch_api/models/sandbox/payment_create_params.rbi +81 -14
- data/rbi/finch_api/models/sandbox/payment_create_response.rbi +6 -1
- data/rbi/finch_api/request_options.rbi +4 -1
- data/sig/finch_api/internal/single_page.rbs +1 -1
- data/sig/finch_api/internal/transport/base_client.rbs +16 -1
- data/sig/finch_api/internal/transport/pooled_net_requester.rbs +4 -0
- data/sig/finch_api/internal/type/base_model.rbs +11 -5
- data/sig/finch_api/internal/type/base_page.rbs +1 -1
- data/sig/finch_api/internal/type/converter.rbs +2 -0
- data/sig/finch_api/internal/type/enum.rbs +1 -0
- data/sig/finch_api/internal/type/union.rbs +1 -0
- data/sig/finch_api/internal/util.rbs +13 -0
- data/sig/finch_api/internal.rbs +2 -0
- data/sig/finch_api/models/hris/pay_statement.rbs +2 -1
- data/sig/finch_api/models/sandbox/payment_create_params.rbs +2 -1
- metadata +2 -2
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Sandbox::CompanyUpdateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# An array of bank account objects associated with the payroll/HRIS system.
|
14
19
|
sig do
|
@@ -142,7 +147,12 @@ module FinchAPI
|
|
142
147
|
|
143
148
|
class Account < FinchAPI::Internal::Type::BaseModel
|
144
149
|
OrHash =
|
145
|
-
T.type_alias
|
150
|
+
T.type_alias do
|
151
|
+
T.any(
|
152
|
+
FinchAPI::Sandbox::CompanyUpdateParams::Account,
|
153
|
+
FinchAPI::Internal::AnyHash
|
154
|
+
)
|
155
|
+
end
|
146
156
|
|
147
157
|
# The name of the bank associated in the payroll/HRIS system.
|
148
158
|
sig { returns(T.nilable(String)) }
|
@@ -253,7 +263,12 @@ module FinchAPI
|
|
253
263
|
|
254
264
|
class Department < FinchAPI::Internal::Type::BaseModel
|
255
265
|
OrHash =
|
256
|
-
T.type_alias
|
266
|
+
T.type_alias do
|
267
|
+
T.any(
|
268
|
+
FinchAPI::Sandbox::CompanyUpdateParams::Department,
|
269
|
+
FinchAPI::Internal::AnyHash
|
270
|
+
)
|
271
|
+
end
|
257
272
|
|
258
273
|
# The department name.
|
259
274
|
sig { returns(T.nilable(String)) }
|
@@ -312,7 +327,12 @@ module FinchAPI
|
|
312
327
|
|
313
328
|
class Parent < FinchAPI::Internal::Type::BaseModel
|
314
329
|
OrHash =
|
315
|
-
T.type_alias
|
330
|
+
T.type_alias do
|
331
|
+
T.any(
|
332
|
+
FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent,
|
333
|
+
FinchAPI::Internal::AnyHash
|
334
|
+
)
|
335
|
+
end
|
316
336
|
|
317
337
|
# The parent department's name.
|
318
338
|
sig { returns(T.nilable(String)) }
|
@@ -334,7 +354,12 @@ module FinchAPI
|
|
334
354
|
|
335
355
|
class Entity < FinchAPI::Internal::Type::BaseModel
|
336
356
|
OrHash =
|
337
|
-
T.type_alias
|
357
|
+
T.type_alias do
|
358
|
+
T.any(
|
359
|
+
FinchAPI::Sandbox::CompanyUpdateParams::Entity,
|
360
|
+
FinchAPI::Internal::AnyHash
|
361
|
+
)
|
362
|
+
end
|
338
363
|
|
339
364
|
# The tax payer subtype of the company.
|
340
365
|
sig do
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Sandbox
|
6
6
|
class CompanyUpdateResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Sandbox::CompanyUpdateResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# An array of bank account objects associated with the payroll/HRIS system.
|
11
16
|
sig do
|
@@ -153,7 +158,12 @@ module FinchAPI
|
|
153
158
|
|
154
159
|
class Account < FinchAPI::Internal::Type::BaseModel
|
155
160
|
OrHash =
|
156
|
-
T.type_alias
|
161
|
+
T.type_alias do
|
162
|
+
T.any(
|
163
|
+
FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account,
|
164
|
+
FinchAPI::Internal::AnyHash
|
165
|
+
)
|
166
|
+
end
|
157
167
|
|
158
168
|
# The name of the bank associated in the payroll/HRIS system.
|
159
169
|
sig { returns(T.nilable(String)) }
|
@@ -264,7 +274,12 @@ module FinchAPI
|
|
264
274
|
|
265
275
|
class Department < FinchAPI::Internal::Type::BaseModel
|
266
276
|
OrHash =
|
267
|
-
T.type_alias
|
277
|
+
T.type_alias do
|
278
|
+
T.any(
|
279
|
+
FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department,
|
280
|
+
FinchAPI::Internal::AnyHash
|
281
|
+
)
|
282
|
+
end
|
268
283
|
|
269
284
|
# The department name.
|
270
285
|
sig { returns(T.nilable(String)) }
|
@@ -323,7 +338,12 @@ module FinchAPI
|
|
323
338
|
|
324
339
|
class Parent < FinchAPI::Internal::Type::BaseModel
|
325
340
|
OrHash =
|
326
|
-
T.type_alias
|
341
|
+
T.type_alias do
|
342
|
+
T.any(
|
343
|
+
FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent,
|
344
|
+
FinchAPI::Internal::AnyHash
|
345
|
+
)
|
346
|
+
end
|
327
347
|
|
328
348
|
# The parent department's name.
|
329
349
|
sig { returns(T.nilable(String)) }
|
@@ -345,7 +365,12 @@ module FinchAPI
|
|
345
365
|
|
346
366
|
class Entity < FinchAPI::Internal::Type::BaseModel
|
347
367
|
OrHash =
|
348
|
-
T.type_alias
|
368
|
+
T.type_alias do
|
369
|
+
T.any(
|
370
|
+
FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity,
|
371
|
+
FinchAPI::Internal::AnyHash
|
372
|
+
)
|
373
|
+
end
|
349
374
|
|
350
375
|
# The tax payer subtype of the company.
|
351
376
|
sig do
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Sandbox::ConnectionCreateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# The provider associated with the connection
|
14
19
|
sig { returns(String) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Sandbox
|
6
6
|
class ConnectionCreateResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Sandbox::ConnectionCreateResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
sig { returns(String) }
|
11
16
|
attr_accessor :access_token
|
@@ -9,7 +9,12 @@ module FinchAPI
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
10
10
|
|
11
11
|
OrHash =
|
12
|
-
T.type_alias
|
12
|
+
T.type_alias do
|
13
|
+
T.any(
|
14
|
+
FinchAPI::Sandbox::Connections::AccountCreateParams,
|
15
|
+
FinchAPI::Internal::AnyHash
|
16
|
+
)
|
17
|
+
end
|
13
18
|
|
14
19
|
sig { returns(String) }
|
15
20
|
attr_accessor :company_id
|
@@ -6,7 +6,12 @@ module FinchAPI
|
|
6
6
|
module Connections
|
7
7
|
class AccountCreateResponse < FinchAPI::Internal::Type::BaseModel
|
8
8
|
OrHash =
|
9
|
-
T.type_alias
|
9
|
+
T.type_alias do
|
10
|
+
T.any(
|
11
|
+
FinchAPI::Models::Sandbox::Connections::AccountCreateResponse,
|
12
|
+
FinchAPI::Internal::AnyHash
|
13
|
+
)
|
14
|
+
end
|
10
15
|
|
11
16
|
sig { returns(String) }
|
12
17
|
attr_accessor :access_token
|
@@ -9,7 +9,12 @@ module FinchAPI
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
10
10
|
|
11
11
|
OrHash =
|
12
|
-
T.type_alias
|
12
|
+
T.type_alias do
|
13
|
+
T.any(
|
14
|
+
FinchAPI::Sandbox::Connections::AccountUpdateParams,
|
15
|
+
FinchAPI::Internal::AnyHash
|
16
|
+
)
|
17
|
+
end
|
13
18
|
|
14
19
|
sig { returns(T.nilable(FinchAPI::ConnectionStatusType::OrSymbol)) }
|
15
20
|
attr_reader :connection_status
|
@@ -6,7 +6,12 @@ module FinchAPI
|
|
6
6
|
module Connections
|
7
7
|
class AccountUpdateResponse < FinchAPI::Internal::Type::BaseModel
|
8
8
|
OrHash =
|
9
|
-
T.type_alias
|
9
|
+
T.type_alias do
|
10
|
+
T.any(
|
11
|
+
FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse,
|
12
|
+
FinchAPI::Internal::AnyHash
|
13
|
+
)
|
14
|
+
end
|
10
15
|
|
11
16
|
# [DEPRECATED] Use `connection_id` to associate a connection with an access token
|
12
17
|
sig { returns(String) }
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Sandbox::DirectoryCreateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# Array of individuals to create. Takes all combined fields from `/individual` and
|
14
19
|
# `/employment` endpoints. All fields are optional.
|
@@ -55,7 +60,12 @@ module FinchAPI
|
|
55
60
|
|
56
61
|
class Body < FinchAPI::Internal::Type::BaseModel
|
57
62
|
OrHash =
|
58
|
-
T.type_alias
|
63
|
+
T.type_alias do
|
64
|
+
T.any(
|
65
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body,
|
66
|
+
FinchAPI::Internal::AnyHash
|
67
|
+
)
|
68
|
+
end
|
59
69
|
|
60
70
|
# Worker's compensation classification code for this employee
|
61
71
|
sig { returns(T.nilable(String)) }
|
@@ -472,7 +482,12 @@ module FinchAPI
|
|
472
482
|
|
473
483
|
class CustomField < FinchAPI::Internal::Type::BaseModel
|
474
484
|
OrHash =
|
475
|
-
T.type_alias
|
485
|
+
T.type_alias do
|
486
|
+
T.any(
|
487
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField,
|
488
|
+
FinchAPI::Internal::AnyHash
|
489
|
+
)
|
490
|
+
end
|
476
491
|
|
477
492
|
sig { returns(T.nilable(String)) }
|
478
493
|
attr_accessor :name
|
@@ -500,7 +515,12 @@ module FinchAPI
|
|
500
515
|
|
501
516
|
class Department < FinchAPI::Internal::Type::BaseModel
|
502
517
|
OrHash =
|
503
|
-
T.type_alias
|
518
|
+
T.type_alias do
|
519
|
+
T.any(
|
520
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::Department,
|
521
|
+
FinchAPI::Internal::AnyHash
|
522
|
+
)
|
523
|
+
end
|
504
524
|
|
505
525
|
# The name of the department associated with the individual.
|
506
526
|
sig { returns(T.nilable(String)) }
|
@@ -521,7 +541,12 @@ module FinchAPI
|
|
521
541
|
|
522
542
|
class Email < FinchAPI::Internal::Type::BaseModel
|
523
543
|
OrHash =
|
524
|
-
T.type_alias
|
544
|
+
T.type_alias do
|
545
|
+
T.any(
|
546
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::Email,
|
547
|
+
FinchAPI::Internal::AnyHash
|
548
|
+
)
|
549
|
+
end
|
525
550
|
|
526
551
|
sig { returns(T.nilable(String)) }
|
527
552
|
attr_reader :data
|
@@ -601,7 +626,12 @@ module FinchAPI
|
|
601
626
|
|
602
627
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
603
628
|
OrHash =
|
604
|
-
T.type_alias
|
629
|
+
T.type_alias do
|
630
|
+
T.any(
|
631
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment,
|
632
|
+
FinchAPI::Internal::AnyHash
|
633
|
+
)
|
634
|
+
end
|
605
635
|
|
606
636
|
# The secondary employment type of the individual. Options: `full_time`,
|
607
637
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
@@ -927,7 +957,12 @@ module FinchAPI
|
|
927
957
|
|
928
958
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
929
959
|
OrHash =
|
930
|
-
T.type_alias
|
960
|
+
T.type_alias do
|
961
|
+
T.any(
|
962
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager,
|
963
|
+
FinchAPI::Internal::AnyHash
|
964
|
+
)
|
965
|
+
end
|
931
966
|
|
932
967
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
933
968
|
sig { returns(T.nilable(String)) }
|
@@ -951,7 +986,12 @@ module FinchAPI
|
|
951
986
|
|
952
987
|
class PhoneNumber < FinchAPI::Internal::Type::BaseModel
|
953
988
|
OrHash =
|
954
|
-
T.type_alias
|
989
|
+
T.type_alias do
|
990
|
+
T.any(
|
991
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber,
|
992
|
+
FinchAPI::Internal::AnyHash
|
993
|
+
)
|
994
|
+
end
|
955
995
|
|
956
996
|
sig { returns(T.nilable(String)) }
|
957
997
|
attr_accessor :data
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Sandbox::EmploymentUpdateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# Worker's compensation classification code for this employee
|
14
19
|
sig { returns(T.nilable(String)) }
|
@@ -276,7 +281,12 @@ module FinchAPI
|
|
276
281
|
|
277
282
|
class CustomField < FinchAPI::Internal::Type::BaseModel
|
278
283
|
OrHash =
|
279
|
-
T.type_alias
|
284
|
+
T.type_alias do
|
285
|
+
T.any(
|
286
|
+
FinchAPI::Sandbox::EmploymentUpdateParams::CustomField,
|
287
|
+
FinchAPI::Internal::AnyHash
|
288
|
+
)
|
289
|
+
end
|
280
290
|
|
281
291
|
sig { returns(T.nilable(String)) }
|
282
292
|
attr_accessor :name
|
@@ -304,7 +314,12 @@ module FinchAPI
|
|
304
314
|
|
305
315
|
class Department < FinchAPI::Internal::Type::BaseModel
|
306
316
|
OrHash =
|
307
|
-
T.type_alias
|
317
|
+
T.type_alias do
|
318
|
+
T.any(
|
319
|
+
FinchAPI::Sandbox::EmploymentUpdateParams::Department,
|
320
|
+
FinchAPI::Internal::AnyHash
|
321
|
+
)
|
322
|
+
end
|
308
323
|
|
309
324
|
# The name of the department associated with the individual.
|
310
325
|
sig { returns(T.nilable(String)) }
|
@@ -325,7 +340,12 @@ module FinchAPI
|
|
325
340
|
|
326
341
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
327
342
|
OrHash =
|
328
|
-
T.type_alias
|
343
|
+
T.type_alias do
|
344
|
+
T.any(
|
345
|
+
FinchAPI::Sandbox::EmploymentUpdateParams::Employment,
|
346
|
+
FinchAPI::Internal::AnyHash
|
347
|
+
)
|
348
|
+
end
|
329
349
|
|
330
350
|
# The secondary employment type of the individual. Options: `full_time`,
|
331
351
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
@@ -541,7 +561,12 @@ module FinchAPI
|
|
541
561
|
|
542
562
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
543
563
|
OrHash =
|
544
|
-
T.type_alias
|
564
|
+
T.type_alias do
|
565
|
+
T.any(
|
566
|
+
FinchAPI::Sandbox::EmploymentUpdateParams::Manager,
|
567
|
+
FinchAPI::Internal::AnyHash
|
568
|
+
)
|
569
|
+
end
|
545
570
|
|
546
571
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
547
572
|
sig { returns(T.nilable(String)) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Sandbox
|
6
6
|
class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Sandbox::EmploymentUpdateResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
11
16
|
sig { returns(T.nilable(String)) }
|
@@ -293,7 +298,12 @@ module FinchAPI
|
|
293
298
|
|
294
299
|
class CustomField < FinchAPI::Internal::Type::BaseModel
|
295
300
|
OrHash =
|
296
|
-
T.type_alias
|
301
|
+
T.type_alias do
|
302
|
+
T.any(
|
303
|
+
FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField,
|
304
|
+
FinchAPI::Internal::AnyHash
|
305
|
+
)
|
306
|
+
end
|
297
307
|
|
298
308
|
sig { returns(T.nilable(String)) }
|
299
309
|
attr_accessor :name
|
@@ -321,7 +331,12 @@ module FinchAPI
|
|
321
331
|
|
322
332
|
class Department < FinchAPI::Internal::Type::BaseModel
|
323
333
|
OrHash =
|
324
|
-
T.type_alias
|
334
|
+
T.type_alias do
|
335
|
+
T.any(
|
336
|
+
FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department,
|
337
|
+
FinchAPI::Internal::AnyHash
|
338
|
+
)
|
339
|
+
end
|
325
340
|
|
326
341
|
# The name of the department associated with the individual.
|
327
342
|
sig { returns(T.nilable(String)) }
|
@@ -342,7 +357,12 @@ module FinchAPI
|
|
342
357
|
|
343
358
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
344
359
|
OrHash =
|
345
|
-
T.type_alias
|
360
|
+
T.type_alias do
|
361
|
+
T.any(
|
362
|
+
FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment,
|
363
|
+
FinchAPI::Internal::AnyHash
|
364
|
+
)
|
365
|
+
end
|
346
366
|
|
347
367
|
# The secondary employment type of the individual. Options: `full_time`,
|
348
368
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
@@ -558,7 +578,12 @@ module FinchAPI
|
|
558
578
|
|
559
579
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
560
580
|
OrHash =
|
561
|
-
T.type_alias
|
581
|
+
T.type_alias do
|
582
|
+
T.any(
|
583
|
+
FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager,
|
584
|
+
FinchAPI::Internal::AnyHash
|
585
|
+
)
|
586
|
+
end
|
562
587
|
|
563
588
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
564
589
|
sig { returns(T.nilable(String)) }
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Sandbox::IndividualUpdateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig { returns(T.nilable(String)) }
|
14
19
|
attr_accessor :dob
|
@@ -195,7 +200,12 @@ module FinchAPI
|
|
195
200
|
|
196
201
|
class Email < FinchAPI::Internal::Type::BaseModel
|
197
202
|
OrHash =
|
198
|
-
T.type_alias
|
203
|
+
T.type_alias do
|
204
|
+
T.any(
|
205
|
+
FinchAPI::Sandbox::IndividualUpdateParams::Email,
|
206
|
+
FinchAPI::Internal::AnyHash
|
207
|
+
)
|
208
|
+
end
|
199
209
|
|
200
210
|
sig { returns(T.nilable(String)) }
|
201
211
|
attr_reader :data
|
@@ -382,7 +392,12 @@ module FinchAPI
|
|
382
392
|
|
383
393
|
class PhoneNumber < FinchAPI::Internal::Type::BaseModel
|
384
394
|
OrHash =
|
385
|
-
T.type_alias
|
395
|
+
T.type_alias do
|
396
|
+
T.any(
|
397
|
+
FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber,
|
398
|
+
FinchAPI::Internal::AnyHash
|
399
|
+
)
|
400
|
+
end
|
386
401
|
|
387
402
|
sig { returns(T.nilable(String)) }
|
388
403
|
attr_accessor :data
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Sandbox
|
6
6
|
class IndividualUpdateResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Sandbox::IndividualUpdateResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
11
16
|
sig { returns(T.nilable(String)) }
|
@@ -204,7 +209,12 @@ module FinchAPI
|
|
204
209
|
|
205
210
|
class Email < FinchAPI::Internal::Type::BaseModel
|
206
211
|
OrHash =
|
207
|
-
T.type_alias
|
212
|
+
T.type_alias do
|
213
|
+
T.any(
|
214
|
+
FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email,
|
215
|
+
FinchAPI::Internal::AnyHash
|
216
|
+
)
|
217
|
+
end
|
208
218
|
|
209
219
|
sig { returns(T.nilable(String)) }
|
210
220
|
attr_reader :data
|
@@ -394,7 +404,12 @@ module FinchAPI
|
|
394
404
|
|
395
405
|
class PhoneNumber < FinchAPI::Internal::Type::BaseModel
|
396
406
|
OrHash =
|
397
|
-
T.type_alias
|
407
|
+
T.type_alias do
|
408
|
+
T.any(
|
409
|
+
FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber,
|
410
|
+
FinchAPI::Internal::AnyHash
|
411
|
+
)
|
412
|
+
end
|
398
413
|
|
399
414
|
sig { returns(T.nilable(String)) }
|
400
415
|
attr_accessor :data
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Sandbox::JobCreateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# The type of job to start. Currently the only supported type is `data_sync_all`
|
14
19
|
sig { returns(FinchAPI::Sandbox::JobCreateParams::Type::OrSymbol) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Sandbox
|
6
6
|
class JobCreateResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Sandbox::JobCreateResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# The number of allowed refreshes per hour (per hour, fixed window)
|
11
16
|
sig { returns(Integer) }
|
@@ -9,7 +9,12 @@ module FinchAPI
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
10
10
|
|
11
11
|
OrHash =
|
12
|
-
T.type_alias
|
12
|
+
T.type_alias do
|
13
|
+
T.any(
|
14
|
+
FinchAPI::Sandbox::Jobs::ConfigurationRetrieveParams,
|
15
|
+
FinchAPI::Internal::AnyHash
|
16
|
+
)
|
17
|
+
end
|
13
18
|
|
14
19
|
sig do
|
15
20
|
params(request_options: FinchAPI::RequestOptions::OrHash).returns(
|
@@ -9,7 +9,12 @@ module FinchAPI
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
10
10
|
|
11
11
|
OrHash =
|
12
|
-
T.type_alias
|
12
|
+
T.type_alias do
|
13
|
+
T.any(
|
14
|
+
FinchAPI::Sandbox::Jobs::ConfigurationUpdateParams,
|
15
|
+
FinchAPI::Internal::AnyHash
|
16
|
+
)
|
17
|
+
end
|
13
18
|
|
14
19
|
sig do
|
15
20
|
params(request_options: FinchAPI::RequestOptions::OrHash).returns(
|
@@ -6,7 +6,12 @@ module FinchAPI
|
|
6
6
|
module Jobs
|
7
7
|
class SandboxJobConfiguration < FinchAPI::Internal::Type::BaseModel
|
8
8
|
OrHash =
|
9
|
-
T.type_alias
|
9
|
+
T.type_alias do
|
10
|
+
T.any(
|
11
|
+
FinchAPI::Sandbox::Jobs::SandboxJobConfiguration,
|
12
|
+
FinchAPI::Internal::AnyHash
|
13
|
+
)
|
14
|
+
end
|
10
15
|
|
11
16
|
sig do
|
12
17
|
returns(
|