finch-api 0.1.0.pre.alpha.16 → 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 +30 -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::HRIS::BenefitListParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig do
|
14
19
|
params(request_options: FinchAPI::RequestOptions::OrHash).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::BenefitListSupportedBenefitsParams,
|
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 BenefitListSupportedBenefitsResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# Whether the provider supports an annual maximum for this benefit.
|
11
16
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -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::BenefitRetrieveParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig do
|
14
19
|
params(request_options: FinchAPI::RequestOptions::OrHash).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::BenefitUpdateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# Updated name or description.
|
14
19
|
sig { returns(T.nilable(String)) }
|
@@ -6,7 +6,12 @@ module FinchAPI
|
|
6
6
|
module Benefits
|
7
7
|
class EnrolledIndividualBenefitResponse < FinchAPI::Internal::Type::BaseModel
|
8
8
|
OrHash =
|
9
|
-
T.type_alias
|
9
|
+
T.type_alias do
|
10
|
+
T.any(
|
11
|
+
FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse,
|
12
|
+
FinchAPI::Internal::AnyHash
|
13
|
+
)
|
14
|
+
end
|
10
15
|
|
11
16
|
sig { returns(String) }
|
12
17
|
attr_accessor :job_id
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
module Benefits
|
9
9
|
class IndividualBenefit < FinchAPI::Internal::Type::BaseModel
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::HRIS::Benefits::IndividualBenefit,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig do
|
14
19
|
returns(
|
@@ -60,7 +65,12 @@ module FinchAPI
|
|
60
65
|
|
61
66
|
class Body < FinchAPI::Internal::Type::BaseModel
|
62
67
|
OrHash =
|
63
|
-
T.type_alias
|
68
|
+
T.type_alias do
|
69
|
+
T.any(
|
70
|
+
FinchAPI::HRIS::Benefits::IndividualBenefit::Body,
|
71
|
+
FinchAPI::Internal::AnyHash
|
72
|
+
)
|
73
|
+
end
|
64
74
|
|
65
75
|
# If the benefit supports annual maximum, the amount in cents for this individual.
|
66
76
|
sig { returns(T.nilable(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::HRIS::Benefits::IndividualEnrollManyParams,
|
15
|
+
FinchAPI::Internal::AnyHash
|
16
|
+
)
|
17
|
+
end
|
13
18
|
|
14
19
|
# Array of the individual_id to enroll and a configuration object.
|
15
20
|
sig do
|
@@ -65,7 +70,12 @@ module FinchAPI
|
|
65
70
|
|
66
71
|
class Individual < FinchAPI::Internal::Type::BaseModel
|
67
72
|
OrHash =
|
68
|
-
T.type_alias
|
73
|
+
T.type_alias do
|
74
|
+
T.any(
|
75
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual,
|
76
|
+
FinchAPI::Internal::AnyHash
|
77
|
+
)
|
78
|
+
end
|
69
79
|
|
70
80
|
sig do
|
71
81
|
returns(
|
@@ -119,7 +129,12 @@ module FinchAPI
|
|
119
129
|
|
120
130
|
class Configuration < FinchAPI::Internal::Type::BaseModel
|
121
131
|
OrHash =
|
122
|
-
T.type_alias
|
132
|
+
T.type_alias do
|
133
|
+
T.any(
|
134
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration,
|
135
|
+
FinchAPI::Internal::AnyHash
|
136
|
+
)
|
137
|
+
end
|
123
138
|
|
124
139
|
# For HSA benefits only - whether the contribution limit is for an individual or
|
125
140
|
# family
|
@@ -277,7 +292,10 @@ module FinchAPI
|
|
277
292
|
class CompanyContribution < FinchAPI::Internal::Type::BaseModel
|
278
293
|
OrHash =
|
279
294
|
T.type_alias do
|
280
|
-
T.any(
|
295
|
+
T.any(
|
296
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution,
|
297
|
+
FinchAPI::Internal::AnyHash
|
298
|
+
)
|
281
299
|
end
|
282
300
|
|
283
301
|
# Amount in cents for fixed type or basis points (1/100th of a percent) for
|
@@ -370,7 +388,10 @@ module FinchAPI
|
|
370
388
|
class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
|
371
389
|
OrHash =
|
372
390
|
T.type_alias do
|
373
|
-
T.any(
|
391
|
+
T.any(
|
392
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction,
|
393
|
+
FinchAPI::Internal::AnyHash
|
394
|
+
)
|
374
395
|
end
|
375
396
|
|
376
397
|
# Amount in cents for fixed type or basis points (1/100th of a percent) for
|
@@ -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::HRIS::Benefits::IndividualEnrolledIDsParams,
|
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 Benefits
|
7
7
|
class IndividualEnrolledIDsResponse < FinchAPI::Internal::Type::BaseModel
|
8
8
|
OrHash =
|
9
|
-
T.type_alias
|
9
|
+
T.type_alias do
|
10
|
+
T.any(
|
11
|
+
FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse,
|
12
|
+
FinchAPI::Internal::AnyHash
|
13
|
+
)
|
14
|
+
end
|
10
15
|
|
11
16
|
# The id of the benefit.
|
12
17
|
sig { returns(String) }
|
@@ -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::HRIS::Benefits::IndividualRetrieveManyBenefitsParams,
|
15
|
+
FinchAPI::Internal::AnyHash
|
16
|
+
)
|
17
|
+
end
|
13
18
|
|
14
19
|
# comma-delimited list of stable Finch uuids for each individual. If empty,
|
15
20
|
# defaults to all individuals
|
@@ -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::HRIS::Benefits::IndividualUnenrollManyParams,
|
15
|
+
FinchAPI::Internal::AnyHash
|
16
|
+
)
|
17
|
+
end
|
13
18
|
|
14
19
|
# Array of individual_ids to unenroll.
|
15
20
|
sig { returns(T.nilable(T::Array[String])) }
|
@@ -6,7 +6,12 @@ module FinchAPI
|
|
6
6
|
module Benefits
|
7
7
|
class UnenrolledIndividualBenefitResponse < FinchAPI::Internal::Type::BaseModel
|
8
8
|
OrHash =
|
9
|
-
T.type_alias
|
9
|
+
T.type_alias do
|
10
|
+
T.any(
|
11
|
+
FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse,
|
12
|
+
FinchAPI::Internal::AnyHash
|
13
|
+
)
|
14
|
+
end
|
10
15
|
|
11
16
|
sig { returns(String) }
|
12
17
|
attr_accessor :job_id
|
@@ -5,7 +5,9 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class BenefitsSupport < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::HRIS::BenefitsSupport, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) }
|
11
13
|
attr_reader :commuter
|
@@ -10,7 +10,12 @@ module FinchAPI
|
|
10
10
|
include FinchAPI::Internal::Type::RequestParameters
|
11
11
|
|
12
12
|
OrHash =
|
13
|
-
T.type_alias
|
13
|
+
T.type_alias do
|
14
|
+
T.any(
|
15
|
+
FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams,
|
16
|
+
FinchAPI::Internal::AnyHash
|
17
|
+
)
|
18
|
+
end
|
14
19
|
|
15
20
|
# Specifies the fields to be applied when the condition is met.
|
16
21
|
sig do
|
@@ -128,7 +133,12 @@ module FinchAPI
|
|
128
133
|
|
129
134
|
class Attributes < FinchAPI::Internal::Type::BaseModel
|
130
135
|
OrHash =
|
131
|
-
T.type_alias
|
136
|
+
T.type_alias do
|
137
|
+
T.any(
|
138
|
+
FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes,
|
139
|
+
FinchAPI::Internal::AnyHash
|
140
|
+
)
|
141
|
+
end
|
132
142
|
|
133
143
|
# The metadata to be attached in the entity. It is a key-value pairs where the
|
134
144
|
# values can be of any type (string, number, boolean, object, array, etc.).
|
@@ -160,7 +170,12 @@ module FinchAPI
|
|
160
170
|
|
161
171
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
162
172
|
OrHash =
|
163
|
-
T.type_alias
|
173
|
+
T.type_alias do
|
174
|
+
T.any(
|
175
|
+
FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition,
|
176
|
+
FinchAPI::Internal::AnyHash
|
177
|
+
)
|
178
|
+
end
|
164
179
|
|
165
180
|
# The field to be checked in the rule.
|
166
181
|
sig { returns(T.nilable(String)) }
|
@@ -7,7 +7,12 @@ module FinchAPI
|
|
7
7
|
module PayStatementItem
|
8
8
|
class RuleCreateResponse < FinchAPI::Internal::Type::BaseModel
|
9
9
|
OrHash =
|
10
|
-
T.type_alias
|
10
|
+
T.type_alias do
|
11
|
+
T.any(
|
12
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse,
|
13
|
+
FinchAPI::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
11
16
|
|
12
17
|
# Finch id (uuidv4) for the rule.
|
13
18
|
sig { returns(T.nilable(String)) }
|
@@ -166,7 +171,12 @@ module FinchAPI
|
|
166
171
|
|
167
172
|
class Attributes < FinchAPI::Internal::Type::BaseModel
|
168
173
|
OrHash =
|
169
|
-
T.type_alias
|
174
|
+
T.type_alias do
|
175
|
+
T.any(
|
176
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes,
|
177
|
+
FinchAPI::Internal::AnyHash
|
178
|
+
)
|
179
|
+
end
|
170
180
|
|
171
181
|
# The metadata to be attached in the entity. It is a key-value pairs where the
|
172
182
|
# values can be of any type (string, number, boolean, object, array, etc.).
|
@@ -198,7 +208,12 @@ module FinchAPI
|
|
198
208
|
|
199
209
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
200
210
|
OrHash =
|
201
|
-
T.type_alias
|
211
|
+
T.type_alias do
|
212
|
+
T.any(
|
213
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition,
|
214
|
+
FinchAPI::Internal::AnyHash
|
215
|
+
)
|
216
|
+
end
|
202
217
|
|
203
218
|
# The field to be checked in the rule.
|
204
219
|
sig { returns(T.nilable(String)) }
|
@@ -10,7 +10,12 @@ module FinchAPI
|
|
10
10
|
include FinchAPI::Internal::Type::RequestParameters
|
11
11
|
|
12
12
|
OrHash =
|
13
|
-
T.type_alias
|
13
|
+
T.type_alias do
|
14
|
+
T.any(
|
15
|
+
FinchAPI::HRIS::Company::PayStatementItem::RuleDeleteParams,
|
16
|
+
FinchAPI::Internal::AnyHash
|
17
|
+
)
|
18
|
+
end
|
14
19
|
|
15
20
|
sig do
|
16
21
|
params(request_options: FinchAPI::RequestOptions::OrHash).returns(
|
@@ -7,7 +7,12 @@ module FinchAPI
|
|
7
7
|
module PayStatementItem
|
8
8
|
class RuleDeleteResponse < FinchAPI::Internal::Type::BaseModel
|
9
9
|
OrHash =
|
10
|
-
T.type_alias
|
10
|
+
T.type_alias do
|
11
|
+
T.any(
|
12
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse,
|
13
|
+
FinchAPI::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
11
16
|
|
12
17
|
# Finch id (uuidv4) for the rule.
|
13
18
|
sig { returns(T.nilable(String)) }
|
@@ -177,7 +182,12 @@ module FinchAPI
|
|
177
182
|
|
178
183
|
class Attributes < FinchAPI::Internal::Type::BaseModel
|
179
184
|
OrHash =
|
180
|
-
T.type_alias
|
185
|
+
T.type_alias do
|
186
|
+
T.any(
|
187
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes,
|
188
|
+
FinchAPI::Internal::AnyHash
|
189
|
+
)
|
190
|
+
end
|
181
191
|
|
182
192
|
# The metadata to be attached in the entity. It is a key-value pairs where the
|
183
193
|
# values can be of any type (string, number, boolean, object, array, etc.).
|
@@ -209,7 +219,12 @@ module FinchAPI
|
|
209
219
|
|
210
220
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
211
221
|
OrHash =
|
212
|
-
T.type_alias
|
222
|
+
T.type_alias do
|
223
|
+
T.any(
|
224
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition,
|
225
|
+
FinchAPI::Internal::AnyHash
|
226
|
+
)
|
227
|
+
end
|
213
228
|
|
214
229
|
# The field to be checked in the rule.
|
215
230
|
sig { returns(T.nilable(String)) }
|
@@ -10,7 +10,12 @@ module FinchAPI
|
|
10
10
|
include FinchAPI::Internal::Type::RequestParameters
|
11
11
|
|
12
12
|
OrHash =
|
13
|
-
T.type_alias
|
13
|
+
T.type_alias do
|
14
|
+
T.any(
|
15
|
+
FinchAPI::HRIS::Company::PayStatementItem::RuleListParams,
|
16
|
+
FinchAPI::Internal::AnyHash
|
17
|
+
)
|
18
|
+
end
|
14
19
|
|
15
20
|
sig do
|
16
21
|
params(request_options: FinchAPI::RequestOptions::OrHash).returns(
|
@@ -7,7 +7,12 @@ module FinchAPI
|
|
7
7
|
module PayStatementItem
|
8
8
|
class RuleListResponse < FinchAPI::Internal::Type::BaseModel
|
9
9
|
OrHash =
|
10
|
-
T.type_alias
|
10
|
+
T.type_alias do
|
11
|
+
T.any(
|
12
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse,
|
13
|
+
FinchAPI::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
11
16
|
|
12
17
|
# Finch id (uuidv4) for the rule.
|
13
18
|
sig { returns(T.nilable(String)) }
|
@@ -166,7 +171,12 @@ module FinchAPI
|
|
166
171
|
|
167
172
|
class Attributes < FinchAPI::Internal::Type::BaseModel
|
168
173
|
OrHash =
|
169
|
-
T.type_alias
|
174
|
+
T.type_alias do
|
175
|
+
T.any(
|
176
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes,
|
177
|
+
FinchAPI::Internal::AnyHash
|
178
|
+
)
|
179
|
+
end
|
170
180
|
|
171
181
|
# The metadata to be attached in the entity. It is a key-value pairs where the
|
172
182
|
# values can be of any type (string, number, boolean, object, array, etc.).
|
@@ -198,7 +208,12 @@ module FinchAPI
|
|
198
208
|
|
199
209
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
200
210
|
OrHash =
|
201
|
-
T.type_alias
|
211
|
+
T.type_alias do
|
212
|
+
T.any(
|
213
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition,
|
214
|
+
FinchAPI::Internal::AnyHash
|
215
|
+
)
|
216
|
+
end
|
202
217
|
|
203
218
|
# The field to be checked in the rule.
|
204
219
|
sig { returns(T.nilable(String)) }
|
@@ -10,7 +10,12 @@ module FinchAPI
|
|
10
10
|
include FinchAPI::Internal::Type::RequestParameters
|
11
11
|
|
12
12
|
OrHash =
|
13
|
-
T.type_alias
|
13
|
+
T.type_alias do
|
14
|
+
T.any(
|
15
|
+
FinchAPI::HRIS::Company::PayStatementItem::RuleUpdateParams,
|
16
|
+
FinchAPI::Internal::AnyHash
|
17
|
+
)
|
18
|
+
end
|
14
19
|
|
15
20
|
sig { returns(T.nilable(T.anything)) }
|
16
21
|
attr_reader :optional_property
|
@@ -7,7 +7,12 @@ module FinchAPI
|
|
7
7
|
module PayStatementItem
|
8
8
|
class RuleUpdateResponse < FinchAPI::Internal::Type::BaseModel
|
9
9
|
OrHash =
|
10
|
-
T.type_alias
|
10
|
+
T.type_alias do
|
11
|
+
T.any(
|
12
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse,
|
13
|
+
FinchAPI::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
11
16
|
|
12
17
|
# Finch id (uuidv4) for the rule.
|
13
18
|
sig { returns(T.nilable(String)) }
|
@@ -166,7 +171,12 @@ module FinchAPI
|
|
166
171
|
|
167
172
|
class Attributes < FinchAPI::Internal::Type::BaseModel
|
168
173
|
OrHash =
|
169
|
-
T.type_alias
|
174
|
+
T.type_alias do
|
175
|
+
T.any(
|
176
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes,
|
177
|
+
FinchAPI::Internal::AnyHash
|
178
|
+
)
|
179
|
+
end
|
170
180
|
|
171
181
|
# The metadata to be attached in the entity. It is a key-value pairs where the
|
172
182
|
# values can be of any type (string, number, boolean, object, array, etc.).
|
@@ -198,7 +208,12 @@ module FinchAPI
|
|
198
208
|
|
199
209
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
200
210
|
OrHash =
|
201
|
-
T.type_alias
|
211
|
+
T.type_alias do
|
212
|
+
T.any(
|
213
|
+
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition,
|
214
|
+
FinchAPI::Internal::AnyHash
|
215
|
+
)
|
216
|
+
end
|
202
217
|
|
203
218
|
# The field to be checked in the rule.
|
204
219
|
sig { returns(T.nilable(String)) }
|
@@ -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::HRIS::Company::PayStatementItemListParams,
|
15
|
+
FinchAPI::Internal::AnyHash
|
16
|
+
)
|
17
|
+
end
|
13
18
|
|
14
19
|
# Comma-delimited list of pay statement item categories to filter on. If empty,
|
15
20
|
# defaults to all categories.
|
@@ -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
|