finch-api 0.1.0.pre.alpha.41 → 0.1.0.pre.alpha.43
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 +73 -0
- data/README.md +3 -3
- data/lib/finch_api/client.rb +22 -4
- data/lib/finch_api/internal/transport/base_client.rb +30 -3
- data/lib/finch_api/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/finch_api/internal/util.rb +54 -8
- data/lib/finch_api/models/account_disconnect_entity_params.rb +22 -0
- data/lib/finch_api/models/base_webhook_event.rb +9 -1
- data/lib/finch_api/models/connect/session_new_params.rb +5 -3
- data/lib/finch_api/models/connect/session_reauthenticate_params.rb +5 -3
- data/lib/finch_api/models/create_access_token_response.rb +10 -1
- data/lib/finch_api/models/disconnect_entity_response.rb +17 -0
- data/lib/finch_api/models/hris/benefit_contribution.rb +24 -23
- data/lib/finch_api/models/hris/benefit_register_params.rb +47 -0
- data/lib/finch_api/models/hris/benefit_retrieve_params.rb +8 -1
- data/lib/finch_api/models/hris/benefit_update_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_benefit.rb +63 -59
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +8 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +8 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +8 -1
- data/lib/finch_api/models/hris/document_retreive_params.rb +8 -1
- data/lib/finch_api/models/hris/employment_data.rb +76 -37
- data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
- data/lib/finch_api/models/hris/individual.rb +38 -28
- data/lib/finch_api/models/hris/individual_response.rb +2 -2
- data/lib/finch_api/models/hris/register_company_benefit_response.rb +26 -0
- data/lib/finch_api/models/introspection.rb +27 -1
- data/lib/finch_api/models/job_completion_event.rb +3 -0
- data/lib/finch_api/models/jobs/automated_create_params.rb +53 -29
- data/lib/finch_api/models/jobs/automated_retrieve_params.rb +7 -1
- data/lib/finch_api/models/jobs/manual_retrieve_params.rb +7 -1
- data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +8 -1
- data/lib/finch_api/models/sandbox/directory_create_params.rb +55 -4
- data/lib/finch_api/models/sandbox/employment_update_params.rb +58 -4
- data/lib/finch_api/models/sandbox/employment_update_response.rb +53 -4
- data/lib/finch_api/models/sandbox/individual_update_params.rb +8 -1
- data/lib/finch_api/models.rb +4 -0
- data/lib/finch_api/resources/access_tokens.rb +1 -0
- data/lib/finch_api/resources/account.rb +26 -0
- data/lib/finch_api/resources/connect/sessions.rb +4 -2
- data/lib/finch_api/resources/hris/benefits/individuals.rb +13 -5
- data/lib/finch_api/resources/hris/benefits.rb +50 -7
- data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +14 -6
- data/lib/finch_api/resources/hris/company/pay_statement_item.rb +3 -1
- data/lib/finch_api/resources/hris/company.rb +3 -1
- data/lib/finch_api/resources/hris/directory.rb +3 -1
- data/lib/finch_api/resources/hris/documents.rb +6 -2
- data/lib/finch_api/resources/hris/employments.rb +4 -2
- data/lib/finch_api/resources/hris/individuals.rb +4 -2
- data/lib/finch_api/resources/hris/pay_statements.rb +4 -2
- data/lib/finch_api/resources/hris/payments.rb +3 -1
- data/lib/finch_api/resources/jobs/automated.rb +8 -7
- data/lib/finch_api/resources/jobs/manual.rb +1 -0
- data/lib/finch_api/resources/payroll/pay_groups.rb +6 -2
- data/lib/finch_api/resources/providers.rb +1 -0
- data/lib/finch_api/resources/request_forwarding.rb +1 -0
- data/lib/finch_api/resources/sandbox/company.rb +1 -0
- data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -0
- data/lib/finch_api/resources/sandbox/connections.rb +1 -0
- data/lib/finch_api/resources/sandbox/directory.rb +1 -0
- data/lib/finch_api/resources/sandbox/employment.rb +4 -1
- data/lib/finch_api/resources/sandbox/individual.rb +1 -0
- data/lib/finch_api/resources/sandbox/jobs/configuration.rb +2 -0
- data/lib/finch_api/resources/sandbox/jobs.rb +1 -0
- data/lib/finch_api/resources/sandbox/payment.rb +1 -0
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +4 -0
- data/rbi/finch_api/client.rbi +12 -2
- data/rbi/finch_api/internal/transport/base_client.rbi +6 -1
- data/rbi/finch_api/internal/util.rbi +29 -1
- data/rbi/finch_api/models/account_disconnect_entity_params.rbi +46 -0
- data/rbi/finch_api/models/base_webhook_event.rbi +18 -3
- data/rbi/finch_api/models/connect/session_new_params.rbi +11 -3
- data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +11 -3
- data/rbi/finch_api/models/create_access_token_response.rbi +13 -3
- data/rbi/finch_api/models/disconnect_entity_response.rbi +27 -0
- data/rbi/finch_api/models/hris/benefit_contribution.rbi +33 -31
- data/rbi/finch_api/models/hris/benefit_register_params.rbi +76 -0
- data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefit_update_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +71 -71
- data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +6 -0
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +6 -0
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +6 -0
- data/rbi/finch_api/models/hris/document_retreive_params.rbi +6 -0
- data/rbi/finch_api/models/hris/employment_data.rbi +121 -56
- data/rbi/finch_api/models/hris/employment_data_response.rbi +1 -1
- data/rbi/finch_api/models/hris/individual.rbi +54 -47
- data/rbi/finch_api/models/hris/individual_response.rbi +1 -1
- data/rbi/finch_api/models/hris/register_company_benefit_response.rbi +38 -0
- data/rbi/finch_api/models/introspection.rbi +66 -3
- data/rbi/finch_api/models/job_completion_event.rbi +15 -0
- data/rbi/finch_api/models/jobs/automated_create_params.rbi +126 -56
- data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +13 -5
- data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +13 -5
- data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +6 -0
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +122 -9
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +128 -9
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +122 -9
- data/rbi/finch_api/models/sandbox/individual_update_params.rbi +6 -0
- data/rbi/finch_api/models.rbi +5 -0
- data/rbi/finch_api/resources/account.rbi +15 -0
- data/rbi/finch_api/resources/connect/sessions.rbi +6 -2
- data/rbi/finch_api/resources/hris/benefits.rbi +24 -0
- data/rbi/finch_api/resources/jobs/automated.rbi +6 -8
- data/rbi/finch_api/resources/sandbox/employment.rbi +7 -0
- data/sig/finch_api/client.rbs +6 -1
- data/sig/finch_api/internal/transport/base_client.rbs +2 -0
- data/sig/finch_api/internal/util.rbs +14 -0
- data/sig/finch_api/models/account_disconnect_entity_params.rbs +24 -0
- data/sig/finch_api/models/base_webhook_event.rbs +14 -3
- data/sig/finch_api/models/connect/session_new_params.rbs +2 -0
- data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +2 -0
- data/sig/finch_api/models/create_access_token_response.rbs +8 -3
- data/sig/finch_api/models/disconnect_entity_response.rbs +13 -0
- data/sig/finch_api/models/hris/benefit_contribution.rbs +28 -28
- data/sig/finch_api/models/hris/benefit_register_params.rbs +47 -0
- data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +62 -62
- data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +9 -1
- data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +9 -1
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +5 -1
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +9 -1
- data/sig/finch_api/models/hris/document_retreive_params.rbs +5 -1
- data/sig/finch_api/models/hris/employment_data.rbs +56 -39
- data/sig/finch_api/models/hris/individual.rbs +31 -31
- data/sig/finch_api/models/hris/register_company_benefit_response.rbs +18 -0
- data/sig/finch_api/models/introspection.rbs +44 -3
- data/sig/finch_api/models/job_completion_event.rbs +6 -0
- data/sig/finch_api/models/jobs/automated_create_params.rbs +47 -22
- data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +11 -3
- data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +11 -3
- data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +5 -1
- data/sig/finch_api/models/sandbox/directory_create_params.rbs +40 -5
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +45 -5
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +40 -5
- data/sig/finch_api/models/sandbox/individual_update_params.rbs +5 -0
- data/sig/finch_api/models.rbs +4 -0
- data/sig/finch_api/resources/account.rbs +5 -0
- data/sig/finch_api/resources/hris/benefits.rbs +8 -0
- data/sig/finch_api/resources/jobs/automated.rbs +1 -2
- data/sig/finch_api/resources/sandbox/employment.rbs +1 -0
- metadata +14 -2
|
@@ -6,13 +6,13 @@ module FinchAPI
|
|
|
6
6
|
module BenefitContribution
|
|
7
7
|
extend FinchAPI::Internal::Type::Union
|
|
8
8
|
|
|
9
|
-
variant -> { FinchAPI::HRIS::BenefitContribution::
|
|
9
|
+
variant -> { FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed }
|
|
10
10
|
|
|
11
|
-
variant -> { FinchAPI::HRIS::BenefitContribution::
|
|
11
|
+
variant -> { FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent }
|
|
12
12
|
|
|
13
|
-
variant -> { FinchAPI::HRIS::BenefitContribution::
|
|
13
|
+
variant -> { FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered }
|
|
14
14
|
|
|
15
|
-
class
|
|
15
|
+
class BenefitContributionFixed < FinchAPI::Internal::Type::BaseModel
|
|
16
16
|
# @!attribute amount
|
|
17
17
|
# Contribution amount in cents.
|
|
18
18
|
#
|
|
@@ -22,17 +22,17 @@ module FinchAPI
|
|
|
22
22
|
# @!attribute type
|
|
23
23
|
# Fixed contribution type.
|
|
24
24
|
#
|
|
25
|
-
# @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::
|
|
26
|
-
required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::
|
|
25
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionFixed::Type]
|
|
26
|
+
required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed::Type }
|
|
27
27
|
|
|
28
28
|
# @!method initialize(amount:, type:)
|
|
29
29
|
# @param amount [Integer] Contribution amount in cents.
|
|
30
30
|
#
|
|
31
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::
|
|
31
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionFixed::Type] Fixed contribution type.
|
|
32
32
|
|
|
33
33
|
# Fixed contribution type.
|
|
34
34
|
#
|
|
35
|
-
# @see FinchAPI::Models::HRIS::BenefitContribution::
|
|
35
|
+
# @see FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionFixed#type
|
|
36
36
|
module Type
|
|
37
37
|
extend FinchAPI::Internal::Type::Enum
|
|
38
38
|
|
|
@@ -43,7 +43,7 @@ module FinchAPI
|
|
|
43
43
|
end
|
|
44
44
|
end
|
|
45
45
|
|
|
46
|
-
class
|
|
46
|
+
class BenefitContributionPercent < FinchAPI::Internal::Type::BaseModel
|
|
47
47
|
# @!attribute amount
|
|
48
48
|
# Contribution amount in basis points (1/100th of a percent).
|
|
49
49
|
#
|
|
@@ -53,17 +53,17 @@ module FinchAPI
|
|
|
53
53
|
# @!attribute type
|
|
54
54
|
# Percentage contribution type.
|
|
55
55
|
#
|
|
56
|
-
# @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::
|
|
57
|
-
required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::
|
|
56
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionPercent::Type]
|
|
57
|
+
required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent::Type }
|
|
58
58
|
|
|
59
59
|
# @!method initialize(amount:, type:)
|
|
60
60
|
# @param amount [Integer] Contribution amount in basis points (1/100th of a percent).
|
|
61
61
|
#
|
|
62
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::
|
|
62
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionPercent::Type] Percentage contribution type.
|
|
63
63
|
|
|
64
64
|
# Percentage contribution type.
|
|
65
65
|
#
|
|
66
|
-
# @see FinchAPI::Models::HRIS::BenefitContribution::
|
|
66
|
+
# @see FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionPercent#type
|
|
67
67
|
module Type
|
|
68
68
|
extend FinchAPI::Internal::Type::Enum
|
|
69
69
|
|
|
@@ -74,28 +74,29 @@ module FinchAPI
|
|
|
74
74
|
end
|
|
75
75
|
end
|
|
76
76
|
|
|
77
|
-
class
|
|
77
|
+
class BenefitContributionTiered < FinchAPI::Internal::Type::BaseModel
|
|
78
78
|
# @!attribute tiers
|
|
79
79
|
# Array of tier objects defining employer match tiers based on employee
|
|
80
80
|
# contribution thresholds.
|
|
81
81
|
#
|
|
82
|
-
# @return [Array<FinchAPI::Models::HRIS::BenefitContribution::
|
|
82
|
+
# @return [Array<FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionTiered::Tier>]
|
|
83
83
|
required :tiers,
|
|
84
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitContribution::
|
|
84
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Tier] }
|
|
85
85
|
|
|
86
86
|
# @!attribute type
|
|
87
87
|
# Tiered contribution type (only valid for company_contribution).
|
|
88
88
|
#
|
|
89
|
-
# @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::
|
|
90
|
-
required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::
|
|
89
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionTiered::Type]
|
|
90
|
+
required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Type }
|
|
91
91
|
|
|
92
92
|
# @!method initialize(tiers:, type:)
|
|
93
93
|
# Some parameter documentations has been truncated, see
|
|
94
|
-
# {FinchAPI::Models::HRIS::BenefitContribution::
|
|
94
|
+
# {FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionTiered} for
|
|
95
|
+
# more details.
|
|
95
96
|
#
|
|
96
|
-
# @param tiers [Array<FinchAPI::Models::HRIS::BenefitContribution::
|
|
97
|
+
# @param tiers [Array<FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionTiered::Tier>] Array of tier objects defining employer match tiers based on employee contributi
|
|
97
98
|
#
|
|
98
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::
|
|
99
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionTiered::Type] Tiered contribution type (only valid for company_contribution).
|
|
99
100
|
|
|
100
101
|
class Tier < FinchAPI::Internal::Type::BaseModel
|
|
101
102
|
# @!attribute match
|
|
@@ -115,7 +116,7 @@ module FinchAPI
|
|
|
115
116
|
|
|
116
117
|
# Tiered contribution type (only valid for company_contribution).
|
|
117
118
|
#
|
|
118
|
-
# @see FinchAPI::Models::HRIS::BenefitContribution::
|
|
119
|
+
# @see FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionTiered#type
|
|
119
120
|
module Type
|
|
120
121
|
extend FinchAPI::Internal::Type::Enum
|
|
121
122
|
|
|
@@ -127,7 +128,7 @@ module FinchAPI
|
|
|
127
128
|
end
|
|
128
129
|
|
|
129
130
|
# @!method self.variants
|
|
130
|
-
# @return [Array(FinchAPI::Models::HRIS::BenefitContribution::
|
|
131
|
+
# @return [Array(FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionFixed, FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionPercent, FinchAPI::Models::HRIS::BenefitContribution::BenefitContributionTiered)]
|
|
131
132
|
end
|
|
132
133
|
end
|
|
133
134
|
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module FinchAPI
|
|
4
|
+
module Models
|
|
5
|
+
module HRIS
|
|
6
|
+
# @see FinchAPI::Resources::HRIS::Benefits#register
|
|
7
|
+
class BenefitRegisterParams < FinchAPI::Internal::Type::BaseModel
|
|
8
|
+
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include FinchAPI::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute entity_ids
|
|
12
|
+
# The entity IDs to specify which entities' data to access.
|
|
13
|
+
#
|
|
14
|
+
# @return [Array<String>, nil]
|
|
15
|
+
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
16
|
+
|
|
17
|
+
# @!attribute description
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :description, String
|
|
21
|
+
|
|
22
|
+
# @!attribute frequency
|
|
23
|
+
# The frequency of the benefit deduction/contribution.
|
|
24
|
+
#
|
|
25
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
|
|
26
|
+
optional :frequency, enum: -> { FinchAPI::HRIS::BenefitFrequency }, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute type
|
|
29
|
+
# Type of benefit.
|
|
30
|
+
#
|
|
31
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
|
|
32
|
+
optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!method initialize(entity_ids: nil, description: nil, frequency: nil, type: nil, request_options: {})
|
|
35
|
+
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
36
|
+
#
|
|
37
|
+
# @param description [String]
|
|
38
|
+
#
|
|
39
|
+
# @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
|
|
40
|
+
#
|
|
41
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
|
|
42
|
+
#
|
|
43
|
+
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -8,13 +8,20 @@ module FinchAPI
|
|
|
8
8
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute benefit_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :benefit_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute entity_ids
|
|
12
17
|
# The entity IDs to specify which entities' data to access.
|
|
13
18
|
#
|
|
14
19
|
# @return [Array<String>, nil]
|
|
15
20
|
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
16
21
|
|
|
17
|
-
# @!method initialize(entity_ids: nil, request_options: {})
|
|
22
|
+
# @!method initialize(benefit_id:, entity_ids: nil, request_options: {})
|
|
23
|
+
# @param benefit_id [String]
|
|
24
|
+
#
|
|
18
25
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
19
26
|
#
|
|
20
27
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -8,6 +8,11 @@ module FinchAPI
|
|
|
8
8
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute benefit_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :benefit_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute entity_ids
|
|
12
17
|
# The entity IDs to specify which entities' data to access.
|
|
13
18
|
#
|
|
@@ -20,7 +25,9 @@ module FinchAPI
|
|
|
20
25
|
# @return [String, nil]
|
|
21
26
|
optional :description, String
|
|
22
27
|
|
|
23
|
-
# @!method initialize(entity_ids: nil, description: nil, request_options: {})
|
|
28
|
+
# @!method initialize(benefit_id:, entity_ids: nil, description: nil, request_options: {})
|
|
29
|
+
# @param benefit_id [String]
|
|
30
|
+
#
|
|
24
31
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
25
32
|
#
|
|
26
33
|
# @param description [String] Updated name or description.
|
|
@@ -8,7 +8,7 @@ module FinchAPI
|
|
|
8
8
|
class IndividualBenefit < FinchAPI::Internal::Type::BaseModel
|
|
9
9
|
# @!attribute body
|
|
10
10
|
#
|
|
11
|
-
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
11
|
+
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::BatchError]
|
|
12
12
|
required :body, union: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body }
|
|
13
13
|
|
|
14
14
|
# @!attribute code
|
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
|
22
22
|
required :individual_id, String
|
|
23
23
|
|
|
24
24
|
# @!method initialize(body:, code:, individual_id:)
|
|
25
|
-
# @param body [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
25
|
+
# @param body [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::BatchError]
|
|
26
26
|
# @param code [Integer]
|
|
27
27
|
# @param individual_id [String]
|
|
28
28
|
|
|
@@ -30,11 +30,11 @@ module FinchAPI
|
|
|
30
30
|
module Body
|
|
31
31
|
extend FinchAPI::Internal::Type::Union
|
|
32
32
|
|
|
33
|
-
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
33
|
+
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit }
|
|
34
34
|
|
|
35
35
|
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::BatchError }
|
|
36
36
|
|
|
37
|
-
class
|
|
37
|
+
class IndividualBenefit < FinchAPI::Internal::Type::BaseModel
|
|
38
38
|
# @!attribute annual_maximum
|
|
39
39
|
# If the benefit supports annual maximum, the amount in cents for this individual.
|
|
40
40
|
#
|
|
@@ -53,10 +53,10 @@ module FinchAPI
|
|
|
53
53
|
# percentage-based contributions (in basis points where 100 = 1%), or tiered
|
|
54
54
|
# matching structures.
|
|
55
55
|
#
|
|
56
|
-
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
56
|
+
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered, nil]
|
|
57
57
|
required :company_contribution,
|
|
58
58
|
union: -> {
|
|
59
|
-
FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
59
|
+
FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution
|
|
60
60
|
},
|
|
61
61
|
nil?: true
|
|
62
62
|
|
|
@@ -64,53 +64,53 @@ module FinchAPI
|
|
|
64
64
|
# Employee deduction configuration. Supports both fixed amounts (in cents) and
|
|
65
65
|
# percentage-based contributions (in basis points where 100 = 1%).
|
|
66
66
|
#
|
|
67
|
-
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
67
|
+
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent, nil]
|
|
68
68
|
required :employee_deduction,
|
|
69
69
|
union: -> {
|
|
70
|
-
FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
70
|
+
FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction
|
|
71
71
|
},
|
|
72
72
|
nil?: true
|
|
73
73
|
|
|
74
74
|
# @!attribute hsa_contribution_limit
|
|
75
75
|
# Type for HSA contribution limit if the benefit is a HSA.
|
|
76
76
|
#
|
|
77
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
77
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::HsaContributionLimit, nil]
|
|
78
78
|
optional :hsa_contribution_limit,
|
|
79
79
|
enum: -> {
|
|
80
|
-
FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
80
|
+
FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::HsaContributionLimit
|
|
81
81
|
},
|
|
82
82
|
nil?: true
|
|
83
83
|
|
|
84
84
|
# @!method initialize(annual_maximum:, catch_up:, company_contribution:, employee_deduction:, hsa_contribution_limit: nil)
|
|
85
85
|
# Some parameter documentations has been truncated, see
|
|
86
|
-
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
87
|
-
# more details.
|
|
86
|
+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit}
|
|
87
|
+
# for more details.
|
|
88
88
|
#
|
|
89
89
|
# @param annual_maximum [Integer, nil] If the benefit supports annual maximum, the amount in cents for this individual.
|
|
90
90
|
#
|
|
91
91
|
# @param catch_up [Boolean, nil] If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
|
|
92
92
|
#
|
|
93
|
-
# @param company_contribution [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
93
|
+
# @param company_contribution [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered, nil] Company contribution configuration. Supports fixed amounts (in cents), percentag
|
|
94
94
|
#
|
|
95
|
-
# @param employee_deduction [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
95
|
+
# @param employee_deduction [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent, nil] Employee deduction configuration. Supports both fixed amounts (in cents) and per
|
|
96
96
|
#
|
|
97
|
-
# @param hsa_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
97
|
+
# @param hsa_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA.
|
|
98
98
|
|
|
99
99
|
# Company contribution configuration. Supports fixed amounts (in cents),
|
|
100
100
|
# percentage-based contributions (in basis points where 100 = 1%), or tiered
|
|
101
101
|
# matching structures.
|
|
102
102
|
#
|
|
103
|
-
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
103
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit#company_contribution
|
|
104
104
|
module CompanyContribution
|
|
105
105
|
extend FinchAPI::Internal::Type::Union
|
|
106
106
|
|
|
107
|
-
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
107
|
+
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed }
|
|
108
108
|
|
|
109
|
-
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
109
|
+
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent }
|
|
110
110
|
|
|
111
|
-
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
111
|
+
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered }
|
|
112
112
|
|
|
113
|
-
class
|
|
113
|
+
class CompanyContributionFixed < FinchAPI::Internal::Type::BaseModel
|
|
114
114
|
# @!attribute amount
|
|
115
115
|
# Contribution amount in cents (for type=fixed) or basis points (for type=percent,
|
|
116
116
|
# where 100 = 1%). Not used for type=tiered.
|
|
@@ -122,23 +122,23 @@ module FinchAPI
|
|
|
122
122
|
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
|
|
123
123
|
# (amount in basis points), or "tiered" (multi-tier matching).
|
|
124
124
|
#
|
|
125
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
125
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed::Type]
|
|
126
126
|
required :type,
|
|
127
|
-
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
127
|
+
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed::Type }
|
|
128
128
|
|
|
129
129
|
# @!method initialize(amount:, type:)
|
|
130
130
|
# Some parameter documentations has been truncated, see
|
|
131
|
-
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
131
|
+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed}
|
|
132
132
|
# for more details.
|
|
133
133
|
#
|
|
134
134
|
# @param amount [Integer] Contribution amount in cents (for type=fixed) or basis points (for type=percent,
|
|
135
135
|
#
|
|
136
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
136
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed::Type] Contribution type. Supported values: "fixed" (amount in cents), "percent" (amoun
|
|
137
137
|
|
|
138
138
|
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
|
|
139
139
|
# (amount in basis points), or "tiered" (multi-tier matching).
|
|
140
140
|
#
|
|
141
|
-
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
141
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed#type
|
|
142
142
|
module Type
|
|
143
143
|
extend FinchAPI::Internal::Type::Enum
|
|
144
144
|
|
|
@@ -149,7 +149,7 @@ module FinchAPI
|
|
|
149
149
|
end
|
|
150
150
|
end
|
|
151
151
|
|
|
152
|
-
class
|
|
152
|
+
class CompanyContributionPercent < FinchAPI::Internal::Type::BaseModel
|
|
153
153
|
# @!attribute amount
|
|
154
154
|
# Contribution amount in cents (for type=fixed) or basis points (for type=percent,
|
|
155
155
|
# where 100 = 1%). Not used for type=tiered.
|
|
@@ -161,23 +161,23 @@ module FinchAPI
|
|
|
161
161
|
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
|
|
162
162
|
# (amount in basis points), or "tiered" (multi-tier matching).
|
|
163
163
|
#
|
|
164
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
164
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent::Type]
|
|
165
165
|
required :type,
|
|
166
|
-
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
166
|
+
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent::Type }
|
|
167
167
|
|
|
168
168
|
# @!method initialize(amount:, type:)
|
|
169
169
|
# Some parameter documentations has been truncated, see
|
|
170
|
-
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
170
|
+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent}
|
|
171
171
|
# for more details.
|
|
172
172
|
#
|
|
173
173
|
# @param amount [Integer] Contribution amount in cents (for type=fixed) or basis points (for type=percent,
|
|
174
174
|
#
|
|
175
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
175
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent::Type] Contribution type. Supported values: "fixed" (amount in cents), "percent" (amoun
|
|
176
176
|
|
|
177
177
|
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
|
|
178
178
|
# (amount in basis points), or "tiered" (multi-tier matching).
|
|
179
179
|
#
|
|
180
|
-
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
180
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent#type
|
|
181
181
|
module Type
|
|
182
182
|
extend FinchAPI::Internal::Type::Enum
|
|
183
183
|
|
|
@@ -188,31 +188,35 @@ module FinchAPI
|
|
|
188
188
|
end
|
|
189
189
|
end
|
|
190
190
|
|
|
191
|
-
class
|
|
191
|
+
class CompanyContributionTiered < FinchAPI::Internal::Type::BaseModel
|
|
192
192
|
# @!attribute tiers
|
|
193
193
|
# Array of tier objects defining employer match tiers based on employee
|
|
194
194
|
# contribution thresholds. Required when type=tiered.
|
|
195
195
|
#
|
|
196
|
-
# @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
196
|
+
# @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered::Tier>]
|
|
197
197
|
required :tiers,
|
|
198
|
-
->
|
|
198
|
+
-> do
|
|
199
|
+
FinchAPI::Internal::Type::ArrayOf[
|
|
200
|
+
FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered::Tier
|
|
201
|
+
]
|
|
202
|
+
end
|
|
199
203
|
|
|
200
204
|
# @!attribute type
|
|
201
205
|
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
|
|
202
206
|
# (amount in basis points), or "tiered" (multi-tier matching).
|
|
203
207
|
#
|
|
204
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
208
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered::Type]
|
|
205
209
|
required :type,
|
|
206
|
-
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
210
|
+
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered::Type }
|
|
207
211
|
|
|
208
212
|
# @!method initialize(tiers:, type:)
|
|
209
213
|
# Some parameter documentations has been truncated, see
|
|
210
|
-
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
214
|
+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered}
|
|
211
215
|
# for more details.
|
|
212
216
|
#
|
|
213
|
-
# @param tiers [Array<FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
217
|
+
# @param tiers [Array<FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered::Tier>] Array of tier objects defining employer match tiers based on employee contributi
|
|
214
218
|
#
|
|
215
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
219
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered::Type] Contribution type. Supported values: "fixed" (amount in cents), "percent" (amoun
|
|
216
220
|
|
|
217
221
|
class Tier < FinchAPI::Internal::Type::BaseModel
|
|
218
222
|
# @!attribute match
|
|
@@ -233,7 +237,7 @@ module FinchAPI
|
|
|
233
237
|
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
|
|
234
238
|
# (amount in basis points), or "tiered" (multi-tier matching).
|
|
235
239
|
#
|
|
236
|
-
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
240
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered#type
|
|
237
241
|
module Type
|
|
238
242
|
extend FinchAPI::Internal::Type::Enum
|
|
239
243
|
|
|
@@ -245,21 +249,21 @@ module FinchAPI
|
|
|
245
249
|
end
|
|
246
250
|
|
|
247
251
|
# @!method self.variants
|
|
248
|
-
# @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
252
|
+
# @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionFixed, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionPercent, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::CompanyContribution::CompanyContributionTiered)]
|
|
249
253
|
end
|
|
250
254
|
|
|
251
255
|
# Employee deduction configuration. Supports both fixed amounts (in cents) and
|
|
252
256
|
# percentage-based contributions (in basis points where 100 = 1%).
|
|
253
257
|
#
|
|
254
|
-
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
258
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit#employee_deduction
|
|
255
259
|
module EmployeeDeduction
|
|
256
260
|
extend FinchAPI::Internal::Type::Union
|
|
257
261
|
|
|
258
|
-
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
262
|
+
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed }
|
|
259
263
|
|
|
260
|
-
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
264
|
+
variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent }
|
|
261
265
|
|
|
262
|
-
class
|
|
266
|
+
class EmployeeDeductionContributionFixed < FinchAPI::Internal::Type::BaseModel
|
|
263
267
|
# @!attribute amount
|
|
264
268
|
# Contribution amount in cents (for type=fixed) or basis points (for type=percent,
|
|
265
269
|
# where 100 = 1%).
|
|
@@ -271,23 +275,23 @@ module FinchAPI
|
|
|
271
275
|
# Contribution type. Supported values: "fixed" (amount in cents) or "percent"
|
|
272
276
|
# (amount in basis points).
|
|
273
277
|
#
|
|
274
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
278
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed::Type]
|
|
275
279
|
required :type,
|
|
276
|
-
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
280
|
+
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed::Type }
|
|
277
281
|
|
|
278
282
|
# @!method initialize(amount:, type:)
|
|
279
283
|
# Some parameter documentations has been truncated, see
|
|
280
|
-
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
284
|
+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed}
|
|
281
285
|
# for more details.
|
|
282
286
|
#
|
|
283
287
|
# @param amount [Integer] Contribution amount in cents (for type=fixed) or basis points (for type=percent,
|
|
284
288
|
#
|
|
285
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
289
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed::Type] Contribution type. Supported values: "fixed" (amount in cents) or "percent" (amo
|
|
286
290
|
|
|
287
291
|
# Contribution type. Supported values: "fixed" (amount in cents) or "percent"
|
|
288
292
|
# (amount in basis points).
|
|
289
293
|
#
|
|
290
|
-
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
294
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed#type
|
|
291
295
|
module Type
|
|
292
296
|
extend FinchAPI::Internal::Type::Enum
|
|
293
297
|
|
|
@@ -298,7 +302,7 @@ module FinchAPI
|
|
|
298
302
|
end
|
|
299
303
|
end
|
|
300
304
|
|
|
301
|
-
class
|
|
305
|
+
class EmployeeDeductionContributionPercent < FinchAPI::Internal::Type::BaseModel
|
|
302
306
|
# @!attribute amount
|
|
303
307
|
# Contribution amount in cents (for type=fixed) or basis points (for type=percent,
|
|
304
308
|
# where 100 = 1%).
|
|
@@ -310,23 +314,23 @@ module FinchAPI
|
|
|
310
314
|
# Contribution type. Supported values: "fixed" (amount in cents) or "percent"
|
|
311
315
|
# (amount in basis points).
|
|
312
316
|
#
|
|
313
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
317
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent::Type]
|
|
314
318
|
required :type,
|
|
315
|
-
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::
|
|
319
|
+
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent::Type }
|
|
316
320
|
|
|
317
321
|
# @!method initialize(amount:, type:)
|
|
318
322
|
# Some parameter documentations has been truncated, see
|
|
319
|
-
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
323
|
+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent}
|
|
320
324
|
# for more details.
|
|
321
325
|
#
|
|
322
326
|
# @param amount [Integer] Contribution amount in cents (for type=fixed) or basis points (for type=percent,
|
|
323
327
|
#
|
|
324
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
328
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent::Type] Contribution type. Supported values: "fixed" (amount in cents) or "percent" (amo
|
|
325
329
|
|
|
326
330
|
# Contribution type. Supported values: "fixed" (amount in cents) or "percent"
|
|
327
331
|
# (amount in basis points).
|
|
328
332
|
#
|
|
329
|
-
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
333
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent#type
|
|
330
334
|
module Type
|
|
331
335
|
extend FinchAPI::Internal::Type::Enum
|
|
332
336
|
|
|
@@ -338,12 +342,12 @@ module FinchAPI
|
|
|
338
342
|
end
|
|
339
343
|
|
|
340
344
|
# @!method self.variants
|
|
341
|
-
# @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
345
|
+
# @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionFixed, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit::EmployeeDeduction::EmployeeDeductionContributionPercent)]
|
|
342
346
|
end
|
|
343
347
|
|
|
344
348
|
# Type for HSA contribution limit if the benefit is a HSA.
|
|
345
349
|
#
|
|
346
|
-
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
350
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit#hsa_contribution_limit
|
|
347
351
|
module HsaContributionLimit
|
|
348
352
|
extend FinchAPI::Internal::Type::Enum
|
|
349
353
|
|
|
@@ -384,7 +388,7 @@ module FinchAPI
|
|
|
384
388
|
end
|
|
385
389
|
|
|
386
390
|
# @!method self.variants
|
|
387
|
-
# @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::
|
|
391
|
+
# @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::IndividualBenefit, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::BatchError)]
|
|
388
392
|
end
|
|
389
393
|
end
|
|
390
394
|
end
|
|
@@ -9,6 +9,11 @@ module FinchAPI
|
|
|
9
9
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include FinchAPI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute benefit_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :benefit_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute entity_ids
|
|
13
18
|
# The entity IDs to specify which entities' data to access.
|
|
14
19
|
#
|
|
@@ -22,7 +27,9 @@ module FinchAPI
|
|
|
22
27
|
optional :individuals,
|
|
23
28
|
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] }
|
|
24
29
|
|
|
25
|
-
# @!method initialize(entity_ids: nil, individuals: nil, request_options: {})
|
|
30
|
+
# @!method initialize(benefit_id:, entity_ids: nil, individuals: nil, request_options: {})
|
|
31
|
+
# @param benefit_id [String]
|
|
32
|
+
#
|
|
26
33
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
27
34
|
#
|
|
28
35
|
# @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
|
|
@@ -9,13 +9,20 @@ module FinchAPI
|
|
|
9
9
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include FinchAPI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute benefit_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :benefit_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute entity_ids
|
|
13
18
|
# The entity IDs to specify which entities' data to access.
|
|
14
19
|
#
|
|
15
20
|
# @return [Array<String>, nil]
|
|
16
21
|
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
17
22
|
|
|
18
|
-
# @!method initialize(entity_ids: nil, request_options: {})
|
|
23
|
+
# @!method initialize(benefit_id:, entity_ids: nil, request_options: {})
|
|
24
|
+
# @param benefit_id [String]
|
|
25
|
+
#
|
|
19
26
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
20
27
|
#
|
|
21
28
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|