finch-api 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18
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 +43 -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 +19 -9
- 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 +48 -17
- 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/employment_data.rbs +6 -6
- 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
@@ -6,7 +6,12 @@ module FinchAPI
|
|
6
6
|
module Company
|
7
7
|
class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
|
8
8
|
OrHash =
|
9
|
-
T.type_alias
|
9
|
+
T.type_alias do
|
10
|
+
T.any(
|
11
|
+
FinchAPI::Models::HRIS::Company::PayStatementItemListResponse,
|
12
|
+
FinchAPI::Internal::AnyHash
|
13
|
+
)
|
14
|
+
end
|
10
15
|
|
11
16
|
# The attributes of the pay statement item.
|
12
17
|
sig do
|
@@ -86,7 +91,12 @@ module FinchAPI
|
|
86
91
|
|
87
92
|
class Attributes < FinchAPI::Internal::Type::BaseModel
|
88
93
|
OrHash =
|
89
|
-
T.type_alias
|
94
|
+
T.type_alias do
|
95
|
+
T.any(
|
96
|
+
FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes,
|
97
|
+
FinchAPI::Internal::AnyHash
|
98
|
+
)
|
99
|
+
end
|
90
100
|
|
91
101
|
# `true` if the amount is paid by the employers. This field is only available for
|
92
102
|
# taxes.
|
@@ -5,7 +5,9 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class HRISCompany < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::HRIS::HRISCompany, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
# A stable Finch `id` (UUID v4) for the company.
|
11
13
|
sig { returns(String) }
|
@@ -124,7 +126,12 @@ module FinchAPI
|
|
124
126
|
|
125
127
|
class Account < FinchAPI::Internal::Type::BaseModel
|
126
128
|
OrHash =
|
127
|
-
T.type_alias
|
129
|
+
T.type_alias do
|
130
|
+
T.any(
|
131
|
+
FinchAPI::HRIS::HRISCompany::Account,
|
132
|
+
FinchAPI::Internal::AnyHash
|
133
|
+
)
|
134
|
+
end
|
128
135
|
|
129
136
|
# The name of the bank associated in the payroll/HRIS system.
|
130
137
|
sig { returns(T.nilable(String)) }
|
@@ -232,7 +239,12 @@ module FinchAPI
|
|
232
239
|
|
233
240
|
class Department < FinchAPI::Internal::Type::BaseModel
|
234
241
|
OrHash =
|
235
|
-
T.type_alias
|
242
|
+
T.type_alias do
|
243
|
+
T.any(
|
244
|
+
FinchAPI::HRIS::HRISCompany::Department,
|
245
|
+
FinchAPI::Internal::AnyHash
|
246
|
+
)
|
247
|
+
end
|
236
248
|
|
237
249
|
# The department name.
|
238
250
|
sig { returns(T.nilable(String)) }
|
@@ -285,7 +297,12 @@ module FinchAPI
|
|
285
297
|
|
286
298
|
class Parent < FinchAPI::Internal::Type::BaseModel
|
287
299
|
OrHash =
|
288
|
-
T.type_alias
|
300
|
+
T.type_alias do
|
301
|
+
T.any(
|
302
|
+
FinchAPI::HRIS::HRISCompany::Department::Parent,
|
303
|
+
FinchAPI::Internal::AnyHash
|
304
|
+
)
|
305
|
+
end
|
289
306
|
|
290
307
|
# The parent department's name.
|
291
308
|
sig { returns(T.nilable(String)) }
|
@@ -307,7 +324,12 @@ module FinchAPI
|
|
307
324
|
|
308
325
|
class Entity < FinchAPI::Internal::Type::BaseModel
|
309
326
|
OrHash =
|
310
|
-
T.type_alias
|
327
|
+
T.type_alias do
|
328
|
+
T.any(
|
329
|
+
FinchAPI::HRIS::HRISCompany::Entity,
|
330
|
+
FinchAPI::Internal::AnyHash
|
331
|
+
)
|
332
|
+
end
|
311
333
|
|
312
334
|
# The tax payer subtype of the company.
|
313
335
|
sig do
|
@@ -5,7 +5,9 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class CompanyBenefit < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::HRIS::CompanyBenefit, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
# The id of the benefit.
|
11
13
|
sig { returns(String) }
|
@@ -85,7 +87,12 @@ module FinchAPI
|
|
85
87
|
|
86
88
|
class CompanyContribution < FinchAPI::Internal::Type::BaseModel
|
87
89
|
OrHash =
|
88
|
-
T.type_alias
|
90
|
+
T.type_alias do
|
91
|
+
T.any(
|
92
|
+
FinchAPI::HRIS::CompanyBenefit::CompanyContribution,
|
93
|
+
FinchAPI::Internal::AnyHash
|
94
|
+
)
|
95
|
+
end
|
89
96
|
|
90
97
|
sig do
|
91
98
|
returns(
|
@@ -156,7 +163,12 @@ module FinchAPI
|
|
156
163
|
|
157
164
|
class Tier < FinchAPI::Internal::Type::BaseModel
|
158
165
|
OrHash =
|
159
|
-
T.type_alias
|
166
|
+
T.type_alias do
|
167
|
+
T.any(
|
168
|
+
FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier,
|
169
|
+
FinchAPI::Internal::AnyHash
|
170
|
+
)
|
171
|
+
end
|
160
172
|
|
161
173
|
sig { returns(T.nilable(Integer)) }
|
162
174
|
attr_reader :match
|
@@ -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::HRIS::CompanyRetrieveParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig do
|
14
19
|
params(request_options: FinchAPI::RequestOptions::OrHash).returns(
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class CreateCompanyBenefitsResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::HRIS::CreateCompanyBenefitsResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# The id of the benefit.
|
11
16
|
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::HRIS::DirectoryListIndividualsParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# Number of employees to return (defaults to all)
|
14
19
|
sig { returns(T.nilable(Integer)) }
|
@@ -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::HRIS::DirectoryListParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# Number of employees to return (defaults to all)
|
14
19
|
sig { returns(T.nilable(Integer)) }
|
@@ -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::HRIS::DocumentListParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# Comma-delimited list of stable Finch uuids for each individual. If empty,
|
14
19
|
# defaults to all individuals
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class DocumentListResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::HRIS::DocumentListResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
sig { returns(T::Array[FinchAPI::HRIS::DocumentResponse]) }
|
11
16
|
attr_accessor :documents
|
@@ -5,7 +5,9 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class DocumentResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::HRIS::DocumentResponse, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
# A stable Finch id for the document.
|
11
13
|
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::HRIS::DocumentRetreiveParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig do
|
14
19
|
params(request_options: FinchAPI::RequestOptions::OrHash).returns(
|
@@ -16,7 +16,12 @@ module FinchAPI
|
|
16
16
|
|
17
17
|
class UnionMember0 < FinchAPI::Internal::Type::BaseModel
|
18
18
|
OrHash =
|
19
|
-
T.type_alias
|
19
|
+
T.type_alias do
|
20
|
+
T.any(
|
21
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0,
|
22
|
+
FinchAPI::Internal::AnyHash
|
23
|
+
)
|
24
|
+
end
|
20
25
|
|
21
26
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
22
27
|
sig { returns(String) }
|
@@ -136,10 +141,6 @@ module FinchAPI
|
|
136
141
|
sig { returns(T.nilable(String)) }
|
137
142
|
attr_accessor :middle_name
|
138
143
|
|
139
|
-
# The source system's unique employment identifier for this individual
|
140
|
-
sig { returns(T.nilable(String)) }
|
141
|
-
attr_accessor :source_id
|
142
|
-
|
143
144
|
sig { returns(T.nilable(String)) }
|
144
145
|
attr_accessor :start_date
|
145
146
|
|
@@ -164,6 +165,10 @@ module FinchAPI
|
|
164
165
|
sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Income)])) }
|
165
166
|
attr_accessor :income_history
|
166
167
|
|
168
|
+
# The source system's unique employment identifier for this individual
|
169
|
+
sig { returns(T.nilable(String)) }
|
170
|
+
attr_accessor :source_id
|
171
|
+
|
167
172
|
sig do
|
168
173
|
params(
|
169
174
|
id: String,
|
@@ -197,13 +202,13 @@ module FinchAPI
|
|
197
202
|
FinchAPI::HRIS::EmploymentData::UnionMember0::Manager::OrHash
|
198
203
|
),
|
199
204
|
middle_name: T.nilable(String),
|
200
|
-
source_id: T.nilable(String),
|
201
205
|
start_date: T.nilable(String),
|
202
206
|
title: T.nilable(String),
|
203
207
|
work_id: T.nilable(String),
|
204
208
|
income: T.nilable(FinchAPI::Income::OrHash),
|
205
209
|
income_history:
|
206
|
-
T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)])
|
210
|
+
T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
|
211
|
+
source_id: T.nilable(String)
|
207
212
|
).returns(T.attached_class)
|
208
213
|
end
|
209
214
|
def self.new(
|
@@ -234,8 +239,6 @@ module FinchAPI
|
|
234
239
|
manager:,
|
235
240
|
# The legal middle name of the individual.
|
236
241
|
middle_name:,
|
237
|
-
# The source system's unique employment identifier for this individual
|
238
|
-
source_id:,
|
239
242
|
start_date:,
|
240
243
|
# The current title of the individual.
|
241
244
|
title:,
|
@@ -246,7 +249,9 @@ module FinchAPI
|
|
246
249
|
# depending on what information the provider returns.
|
247
250
|
income: nil,
|
248
251
|
# The array of income history.
|
249
|
-
income_history: nil
|
252
|
+
income_history: nil,
|
253
|
+
# The source system's unique employment identifier for this individual
|
254
|
+
source_id: nil
|
250
255
|
)
|
251
256
|
end
|
252
257
|
|
@@ -284,12 +289,13 @@ module FinchAPI
|
|
284
289
|
FinchAPI::HRIS::EmploymentData::UnionMember0::Manager
|
285
290
|
),
|
286
291
|
middle_name: T.nilable(String),
|
287
|
-
source_id: T.nilable(String),
|
288
292
|
start_date: T.nilable(String),
|
289
293
|
title: T.nilable(String),
|
290
294
|
work_id: T.nilable(String),
|
291
295
|
income: T.nilable(FinchAPI::Income),
|
292
|
-
income_history:
|
296
|
+
income_history:
|
297
|
+
T.nilable(T::Array[T.nilable(FinchAPI::Income)]),
|
298
|
+
source_id: T.nilable(String)
|
293
299
|
}
|
294
300
|
)
|
295
301
|
end
|
@@ -298,7 +304,12 @@ module FinchAPI
|
|
298
304
|
|
299
305
|
class CustomField < FinchAPI::Internal::Type::BaseModel
|
300
306
|
OrHash =
|
301
|
-
T.type_alias
|
307
|
+
T.type_alias do
|
308
|
+
T.any(
|
309
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField,
|
310
|
+
FinchAPI::Internal::AnyHash
|
311
|
+
)
|
312
|
+
end
|
302
313
|
|
303
314
|
sig { returns(T.nilable(String)) }
|
304
315
|
attr_reader :name
|
@@ -395,7 +406,12 @@ module FinchAPI
|
|
395
406
|
|
396
407
|
class Department < FinchAPI::Internal::Type::BaseModel
|
397
408
|
OrHash =
|
398
|
-
T.type_alias
|
409
|
+
T.type_alias do
|
410
|
+
T.any(
|
411
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::Department,
|
412
|
+
FinchAPI::Internal::AnyHash
|
413
|
+
)
|
414
|
+
end
|
399
415
|
|
400
416
|
# The name of the department associated with the individual.
|
401
417
|
sig { returns(T.nilable(String)) }
|
@@ -416,7 +432,12 @@ module FinchAPI
|
|
416
432
|
|
417
433
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
418
434
|
OrHash =
|
419
|
-
T.type_alias
|
435
|
+
T.type_alias do
|
436
|
+
T.any(
|
437
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::Employment,
|
438
|
+
FinchAPI::Internal::AnyHash
|
439
|
+
)
|
440
|
+
end
|
420
441
|
|
421
442
|
# The secondary employment type of the individual. Options: `full_time`,
|
422
443
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
@@ -633,7 +654,12 @@ module FinchAPI
|
|
633
654
|
|
634
655
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
635
656
|
OrHash =
|
636
|
-
T.type_alias
|
657
|
+
T.type_alias do
|
658
|
+
T.any(
|
659
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::Manager,
|
660
|
+
FinchAPI::Internal::AnyHash
|
661
|
+
)
|
662
|
+
end
|
637
663
|
|
638
664
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
639
665
|
sig { returns(String) }
|
@@ -655,7 +681,12 @@ module FinchAPI
|
|
655
681
|
|
656
682
|
class BatchError < FinchAPI::Internal::Type::BaseModel
|
657
683
|
OrHash =
|
658
|
-
T.type_alias
|
684
|
+
T.type_alias do
|
685
|
+
T.any(
|
686
|
+
FinchAPI::HRIS::EmploymentData::BatchError,
|
687
|
+
FinchAPI::Internal::AnyHash
|
688
|
+
)
|
689
|
+
end
|
659
690
|
|
660
691
|
sig { returns(Float) }
|
661
692
|
attr_accessor :code
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class EmploymentDataResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::HRIS::EmploymentDataResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
sig do
|
11
16
|
returns(
|
@@ -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::HRIS::EmploymentRetrieveManyParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# The array of batch requests.
|
14
19
|
sig do
|
@@ -48,7 +53,12 @@ module FinchAPI
|
|
48
53
|
|
49
54
|
class Request < FinchAPI::Internal::Type::BaseModel
|
50
55
|
OrHash =
|
51
|
-
T.type_alias
|
56
|
+
T.type_alias do
|
57
|
+
T.any(
|
58
|
+
FinchAPI::HRIS::EmploymentRetrieveManyParams::Request,
|
59
|
+
FinchAPI::Internal::AnyHash
|
60
|
+
)
|
61
|
+
end
|
52
62
|
|
53
63
|
# A stable Finch `id` (UUID v4) for an individual in the company. There is no
|
54
64
|
# limit to the number of `individual_id` to send per request. It is preferantial
|
@@ -16,7 +16,12 @@ module FinchAPI
|
|
16
16
|
|
17
17
|
class UnionMember0 < FinchAPI::Internal::Type::BaseModel
|
18
18
|
OrHash =
|
19
|
-
T.type_alias
|
19
|
+
T.type_alias do
|
20
|
+
T.any(
|
21
|
+
FinchAPI::HRIS::Individual::UnionMember0,
|
22
|
+
FinchAPI::Internal::AnyHash
|
23
|
+
)
|
24
|
+
end
|
20
25
|
|
21
26
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
22
27
|
sig { returns(String) }
|
@@ -315,7 +320,12 @@ module FinchAPI
|
|
315
320
|
|
316
321
|
class PhoneNumber < FinchAPI::Internal::Type::BaseModel
|
317
322
|
OrHash =
|
318
|
-
T.type_alias
|
323
|
+
T.type_alias do
|
324
|
+
T.any(
|
325
|
+
FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber,
|
326
|
+
FinchAPI::Internal::AnyHash
|
327
|
+
)
|
328
|
+
end
|
319
329
|
|
320
330
|
sig { returns(T.nilable(String)) }
|
321
331
|
attr_accessor :data
|
@@ -392,7 +402,12 @@ module FinchAPI
|
|
392
402
|
|
393
403
|
class Email < FinchAPI::Internal::Type::BaseModel
|
394
404
|
OrHash =
|
395
|
-
T.type_alias
|
405
|
+
T.type_alias do
|
406
|
+
T.any(
|
407
|
+
FinchAPI::HRIS::Individual::UnionMember0::Email,
|
408
|
+
FinchAPI::Internal::AnyHash
|
409
|
+
)
|
410
|
+
end
|
396
411
|
|
397
412
|
sig { returns(String) }
|
398
413
|
attr_accessor :data
|
@@ -470,7 +485,12 @@ module FinchAPI
|
|
470
485
|
|
471
486
|
class BatchError < FinchAPI::Internal::Type::BaseModel
|
472
487
|
OrHash =
|
473
|
-
T.type_alias
|
488
|
+
T.type_alias do
|
489
|
+
T.any(
|
490
|
+
FinchAPI::HRIS::Individual::BatchError,
|
491
|
+
FinchAPI::Internal::AnyHash
|
492
|
+
)
|
493
|
+
end
|
474
494
|
|
475
495
|
sig { returns(Float) }
|
476
496
|
attr_accessor :code
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class IndividualInDirectory < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::HRIS::IndividualInDirectory,
|
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(String) }
|
@@ -110,7 +115,12 @@ module FinchAPI
|
|
110
115
|
|
111
116
|
class Department < FinchAPI::Internal::Type::BaseModel
|
112
117
|
OrHash =
|
113
|
-
T.type_alias
|
118
|
+
T.type_alias do
|
119
|
+
T.any(
|
120
|
+
FinchAPI::HRIS::IndividualInDirectory::Department,
|
121
|
+
FinchAPI::Internal::AnyHash
|
122
|
+
)
|
123
|
+
end
|
114
124
|
|
115
125
|
# The name of the department.
|
116
126
|
sig { returns(T.nilable(String)) }
|
@@ -131,7 +141,12 @@ module FinchAPI
|
|
131
141
|
|
132
142
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
133
143
|
OrHash =
|
134
|
-
T.type_alias
|
144
|
+
T.type_alias do
|
145
|
+
T.any(
|
146
|
+
FinchAPI::HRIS::IndividualInDirectory::Manager,
|
147
|
+
FinchAPI::Internal::AnyHash
|
148
|
+
)
|
149
|
+
end
|
135
150
|
|
136
151
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
137
152
|
sig { returns(String) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class IndividualResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::HRIS::IndividualResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
sig do
|
11
16
|
returns(
|
@@ -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::HRIS::IndividualRetrieveManyParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig do
|
14
19
|
returns(
|
@@ -80,7 +85,12 @@ module FinchAPI
|
|
80
85
|
|
81
86
|
class Options < FinchAPI::Internal::Type::BaseModel
|
82
87
|
OrHash =
|
83
|
-
T.type_alias
|
88
|
+
T.type_alias do
|
89
|
+
T.any(
|
90
|
+
FinchAPI::HRIS::IndividualRetrieveManyParams::Options,
|
91
|
+
FinchAPI::Internal::AnyHash
|
92
|
+
)
|
93
|
+
end
|
84
94
|
|
85
95
|
sig { returns(T.nilable(T::Array[String])) }
|
86
96
|
attr_reader :include
|
@@ -99,7 +109,12 @@ module FinchAPI
|
|
99
109
|
|
100
110
|
class Request < FinchAPI::Internal::Type::BaseModel
|
101
111
|
OrHash =
|
102
|
-
T.type_alias
|
112
|
+
T.type_alias do
|
113
|
+
T.any(
|
114
|
+
FinchAPI::HRIS::IndividualRetrieveManyParams::Request,
|
115
|
+
FinchAPI::Internal::AnyHash
|
116
|
+
)
|
117
|
+
end
|
103
118
|
|
104
119
|
sig { returns(T.nilable(String)) }
|
105
120
|
attr_reader :individual_id
|