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
|
@@ -25,12 +25,14 @@ module FinchAPI
|
|
|
25
25
|
# @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams
|
|
26
26
|
def enroll_many(benefit_id, params = {})
|
|
27
27
|
parsed, options = FinchAPI::HRIS::Benefits::IndividualEnrollManyParams.dump_request(params)
|
|
28
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.except(:individuals))
|
|
28
29
|
@client.request(
|
|
29
30
|
method: :post,
|
|
30
31
|
path: ["employer/benefits/%1$s/individuals", benefit_id],
|
|
31
|
-
query:
|
|
32
|
+
query: query,
|
|
32
33
|
body: parsed[:individuals],
|
|
33
34
|
model: FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse,
|
|
35
|
+
security: {bearer_auth: true},
|
|
34
36
|
options: options
|
|
35
37
|
)
|
|
36
38
|
end
|
|
@@ -50,11 +52,13 @@ module FinchAPI
|
|
|
50
52
|
# @see FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsParams
|
|
51
53
|
def enrolled_ids(benefit_id, params = {})
|
|
52
54
|
parsed, options = FinchAPI::HRIS::Benefits::IndividualEnrolledIDsParams.dump_request(params)
|
|
55
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
53
56
|
@client.request(
|
|
54
57
|
method: :get,
|
|
55
58
|
path: ["employer/benefits/%1$s/enrolled", benefit_id],
|
|
56
|
-
query:
|
|
59
|
+
query: query,
|
|
57
60
|
model: FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse,
|
|
61
|
+
security: {bearer_auth: true},
|
|
58
62
|
options: options
|
|
59
63
|
)
|
|
60
64
|
end
|
|
@@ -80,12 +84,14 @@ module FinchAPI
|
|
|
80
84
|
# @see FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams
|
|
81
85
|
def retrieve_many_benefits(benefit_id, params = {})
|
|
82
86
|
parsed, options = FinchAPI::HRIS::Benefits::IndividualRetrieveManyBenefitsParams.dump_request(params)
|
|
87
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
83
88
|
@client.request(
|
|
84
89
|
method: :get,
|
|
85
90
|
path: ["employer/benefits/%1$s/individuals", benefit_id],
|
|
86
|
-
query:
|
|
91
|
+
query: query,
|
|
87
92
|
page: FinchAPI::Internal::SinglePage,
|
|
88
93
|
model: FinchAPI::HRIS::Benefits::IndividualBenefit,
|
|
94
|
+
security: {bearer_auth: true},
|
|
89
95
|
options: options
|
|
90
96
|
)
|
|
91
97
|
end
|
|
@@ -106,14 +112,16 @@ module FinchAPI
|
|
|
106
112
|
#
|
|
107
113
|
# @see FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams
|
|
108
114
|
def unenroll_many(benefit_id, params = {})
|
|
109
|
-
parsed, options = FinchAPI::HRIS::Benefits::IndividualUnenrollManyParams.dump_request(params)
|
|
110
115
|
query_params = [:entity_ids]
|
|
116
|
+
parsed, options = FinchAPI::HRIS::Benefits::IndividualUnenrollManyParams.dump_request(params)
|
|
117
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
111
118
|
@client.request(
|
|
112
119
|
method: :delete,
|
|
113
120
|
path: ["employer/benefits/%1$s/individuals", benefit_id],
|
|
114
|
-
query:
|
|
121
|
+
query: query,
|
|
115
122
|
body: parsed.except(*query_params),
|
|
116
123
|
model: FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse,
|
|
124
|
+
security: {bearer_auth: true},
|
|
117
125
|
options: options
|
|
118
126
|
)
|
|
119
127
|
end
|
|
@@ -31,14 +31,16 @@ module FinchAPI
|
|
|
31
31
|
#
|
|
32
32
|
# @see FinchAPI::Models::HRIS::BenefitCreateParams
|
|
33
33
|
def create(params = {})
|
|
34
|
-
parsed, options = FinchAPI::HRIS::BenefitCreateParams.dump_request(params)
|
|
35
34
|
query_params = [:entity_ids]
|
|
35
|
+
parsed, options = FinchAPI::HRIS::BenefitCreateParams.dump_request(params)
|
|
36
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
36
37
|
@client.request(
|
|
37
38
|
method: :post,
|
|
38
39
|
path: "employer/benefits",
|
|
39
|
-
query:
|
|
40
|
+
query: query,
|
|
40
41
|
body: parsed.except(*query_params),
|
|
41
42
|
model: FinchAPI::HRIS::CreateCompanyBenefitsResponse,
|
|
43
|
+
security: {bearer_auth: true},
|
|
42
44
|
options: options
|
|
43
45
|
)
|
|
44
46
|
end
|
|
@@ -58,11 +60,13 @@ module FinchAPI
|
|
|
58
60
|
# @see FinchAPI::Models::HRIS::BenefitRetrieveParams
|
|
59
61
|
def retrieve(benefit_id, params = {})
|
|
60
62
|
parsed, options = FinchAPI::HRIS::BenefitRetrieveParams.dump_request(params)
|
|
63
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
61
64
|
@client.request(
|
|
62
65
|
method: :get,
|
|
63
66
|
path: ["employer/benefits/%1$s", benefit_id],
|
|
64
|
-
query:
|
|
67
|
+
query: query,
|
|
65
68
|
model: FinchAPI::HRIS::CompanyBenefit,
|
|
69
|
+
security: {bearer_auth: true},
|
|
66
70
|
options: options
|
|
67
71
|
)
|
|
68
72
|
end
|
|
@@ -83,14 +87,16 @@ module FinchAPI
|
|
|
83
87
|
#
|
|
84
88
|
# @see FinchAPI::Models::HRIS::BenefitUpdateParams
|
|
85
89
|
def update(benefit_id, params = {})
|
|
86
|
-
parsed, options = FinchAPI::HRIS::BenefitUpdateParams.dump_request(params)
|
|
87
90
|
query_params = [:entity_ids]
|
|
91
|
+
parsed, options = FinchAPI::HRIS::BenefitUpdateParams.dump_request(params)
|
|
92
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
88
93
|
@client.request(
|
|
89
94
|
method: :post,
|
|
90
95
|
path: ["employer/benefits/%1$s", benefit_id],
|
|
91
|
-
query:
|
|
96
|
+
query: query,
|
|
92
97
|
body: parsed.except(*query_params),
|
|
93
98
|
model: FinchAPI::HRIS::UpdateCompanyBenefitResponse,
|
|
99
|
+
security: {bearer_auth: true},
|
|
94
100
|
options: options
|
|
95
101
|
)
|
|
96
102
|
end
|
|
@@ -108,12 +114,14 @@ module FinchAPI
|
|
|
108
114
|
# @see FinchAPI::Models::HRIS::BenefitListParams
|
|
109
115
|
def list(params = {})
|
|
110
116
|
parsed, options = FinchAPI::HRIS::BenefitListParams.dump_request(params)
|
|
117
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
111
118
|
@client.request(
|
|
112
119
|
method: :get,
|
|
113
120
|
path: "employer/benefits",
|
|
114
|
-
query:
|
|
121
|
+
query: query,
|
|
115
122
|
page: FinchAPI::Internal::SinglePage,
|
|
116
123
|
model: FinchAPI::HRIS::CompanyBenefit,
|
|
124
|
+
security: {bearer_auth: true},
|
|
117
125
|
options: options
|
|
118
126
|
)
|
|
119
127
|
end
|
|
@@ -131,12 +139,47 @@ module FinchAPI
|
|
|
131
139
|
# @see FinchAPI::Models::HRIS::BenefitListSupportedBenefitsParams
|
|
132
140
|
def list_supported_benefits(params = {})
|
|
133
141
|
parsed, options = FinchAPI::HRIS::BenefitListSupportedBenefitsParams.dump_request(params)
|
|
142
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
134
143
|
@client.request(
|
|
135
144
|
method: :get,
|
|
136
145
|
path: "employer/benefits/meta",
|
|
137
|
-
query:
|
|
146
|
+
query: query,
|
|
138
147
|
page: FinchAPI::Internal::SinglePage,
|
|
139
148
|
model: FinchAPI::HRIS::SupportedBenefit,
|
|
149
|
+
security: {bearer_auth: true},
|
|
150
|
+
options: options
|
|
151
|
+
)
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Register existing benefits from the customer on the provider, on Finch's end.
|
|
155
|
+
# Please use the `/provider` endpoint to view available types for each provider.
|
|
156
|
+
#
|
|
157
|
+
# @overload register(entity_ids: nil, description: nil, frequency: nil, type: nil, request_options: {})
|
|
158
|
+
#
|
|
159
|
+
# @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
|
|
160
|
+
#
|
|
161
|
+
# @param description [String] Body param
|
|
162
|
+
#
|
|
163
|
+
# @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] Body param: The frequency of the benefit deduction/contribution.
|
|
164
|
+
#
|
|
165
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Body param: Type of benefit.
|
|
166
|
+
#
|
|
167
|
+
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
168
|
+
#
|
|
169
|
+
# @return [FinchAPI::Models::HRIS::RegisterCompanyBenefitResponse]
|
|
170
|
+
#
|
|
171
|
+
# @see FinchAPI::Models::HRIS::BenefitRegisterParams
|
|
172
|
+
def register(params = {})
|
|
173
|
+
query_params = [:entity_ids]
|
|
174
|
+
parsed, options = FinchAPI::HRIS::BenefitRegisterParams.dump_request(params)
|
|
175
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
176
|
+
@client.request(
|
|
177
|
+
method: :post,
|
|
178
|
+
path: "employer/benefits/register",
|
|
179
|
+
query: query,
|
|
180
|
+
body: parsed.except(*query_params),
|
|
181
|
+
model: FinchAPI::HRIS::RegisterCompanyBenefitResponse,
|
|
182
|
+
security: {bearer_auth: true},
|
|
140
183
|
options: options
|
|
141
184
|
)
|
|
142
185
|
end
|
|
@@ -35,14 +35,16 @@ module FinchAPI
|
|
|
35
35
|
#
|
|
36
36
|
# @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams
|
|
37
37
|
def create(params = {})
|
|
38
|
-
parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams.dump_request(params)
|
|
39
38
|
query_params = [:entity_ids]
|
|
39
|
+
parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams.dump_request(params)
|
|
40
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
40
41
|
@client.request(
|
|
41
42
|
method: :post,
|
|
42
43
|
path: "employer/pay-statement-item/rule",
|
|
43
|
-
query:
|
|
44
|
+
query: query,
|
|
44
45
|
body: parsed.except(*query_params),
|
|
45
46
|
model: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse,
|
|
47
|
+
security: {bearer_auth: true},
|
|
46
48
|
options: options
|
|
47
49
|
)
|
|
48
50
|
end
|
|
@@ -63,14 +65,16 @@ module FinchAPI
|
|
|
63
65
|
#
|
|
64
66
|
# @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateParams
|
|
65
67
|
def update(rule_id, params = {})
|
|
66
|
-
parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleUpdateParams.dump_request(params)
|
|
67
68
|
query_params = [:entity_ids]
|
|
69
|
+
parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleUpdateParams.dump_request(params)
|
|
70
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
68
71
|
@client.request(
|
|
69
72
|
method: :put,
|
|
70
73
|
path: ["employer/pay-statement-item/rule/%1$s", rule_id],
|
|
71
|
-
query:
|
|
74
|
+
query: query,
|
|
72
75
|
body: parsed.except(*query_params),
|
|
73
76
|
model: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse,
|
|
77
|
+
security: {bearer_auth: true},
|
|
74
78
|
options: options
|
|
75
79
|
)
|
|
76
80
|
end
|
|
@@ -88,12 +92,14 @@ module FinchAPI
|
|
|
88
92
|
# @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListParams
|
|
89
93
|
def list(params = {})
|
|
90
94
|
parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleListParams.dump_request(params)
|
|
95
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
91
96
|
@client.request(
|
|
92
97
|
method: :get,
|
|
93
98
|
path: "employer/pay-statement-item/rule",
|
|
94
|
-
query:
|
|
99
|
+
query: query,
|
|
95
100
|
page: FinchAPI::Internal::ResponsesPage,
|
|
96
101
|
model: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse,
|
|
102
|
+
security: {bearer_auth: true},
|
|
97
103
|
options: options
|
|
98
104
|
)
|
|
99
105
|
end
|
|
@@ -113,11 +119,13 @@ module FinchAPI
|
|
|
113
119
|
# @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteParams
|
|
114
120
|
def delete(rule_id, params = {})
|
|
115
121
|
parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleDeleteParams.dump_request(params)
|
|
122
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
116
123
|
@client.request(
|
|
117
124
|
method: :delete,
|
|
118
125
|
path: ["employer/pay-statement-item/rule/%1$s", rule_id],
|
|
119
|
-
query:
|
|
126
|
+
query: query,
|
|
120
127
|
model: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse,
|
|
128
|
+
security: {bearer_auth: true},
|
|
121
129
|
options: options
|
|
122
130
|
)
|
|
123
131
|
end
|
|
@@ -35,12 +35,14 @@ module FinchAPI
|
|
|
35
35
|
# @see FinchAPI::Models::HRIS::Company::PayStatementItemListParams
|
|
36
36
|
def list(params = {})
|
|
37
37
|
parsed, options = FinchAPI::HRIS::Company::PayStatementItemListParams.dump_request(params)
|
|
38
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
38
39
|
@client.request(
|
|
39
40
|
method: :get,
|
|
40
41
|
path: "employer/pay-statement-item",
|
|
41
|
-
query:
|
|
42
|
+
query: query,
|
|
42
43
|
page: FinchAPI::Internal::ResponsesPage,
|
|
43
44
|
model: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse,
|
|
45
|
+
security: {bearer_auth: true},
|
|
44
46
|
options: options
|
|
45
47
|
)
|
|
46
48
|
end
|
|
@@ -20,11 +20,13 @@ module FinchAPI
|
|
|
20
20
|
# @see FinchAPI::Models::HRIS::CompanyRetrieveParams
|
|
21
21
|
def retrieve(params = {})
|
|
22
22
|
parsed, options = FinchAPI::HRIS::CompanyRetrieveParams.dump_request(params)
|
|
23
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
23
24
|
@client.request(
|
|
24
25
|
method: :get,
|
|
25
26
|
path: "employer/company",
|
|
26
|
-
query:
|
|
27
|
+
query: query,
|
|
27
28
|
model: FinchAPI::HRIS::HRISCompany,
|
|
29
|
+
security: {bearer_auth: true},
|
|
28
30
|
options: options
|
|
29
31
|
)
|
|
30
32
|
end
|
|
@@ -21,12 +21,14 @@ module FinchAPI
|
|
|
21
21
|
# @see FinchAPI::Models::HRIS::DirectoryListParams
|
|
22
22
|
def list(params = {})
|
|
23
23
|
parsed, options = FinchAPI::HRIS::DirectoryListParams.dump_request(params)
|
|
24
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
24
25
|
@client.request(
|
|
25
26
|
method: :get,
|
|
26
27
|
path: "employer/directory",
|
|
27
|
-
query:
|
|
28
|
+
query: query,
|
|
28
29
|
page: FinchAPI::Internal::IndividualsPage,
|
|
29
30
|
model: FinchAPI::HRIS::IndividualInDirectory,
|
|
31
|
+
security: {bearer_auth: true},
|
|
30
32
|
options: options
|
|
31
33
|
)
|
|
32
34
|
end
|
|
@@ -29,11 +29,13 @@ module FinchAPI
|
|
|
29
29
|
# @see FinchAPI::Models::HRIS::DocumentListParams
|
|
30
30
|
def list(params = {})
|
|
31
31
|
parsed, options = FinchAPI::HRIS::DocumentListParams.dump_request(params)
|
|
32
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
32
33
|
@client.request(
|
|
33
34
|
method: :get,
|
|
34
35
|
path: "employer/documents",
|
|
35
|
-
query:
|
|
36
|
+
query: query,
|
|
36
37
|
model: FinchAPI::Models::HRIS::DocumentListResponse,
|
|
38
|
+
security: {bearer_auth: true},
|
|
37
39
|
options: options
|
|
38
40
|
)
|
|
39
41
|
end
|
|
@@ -54,11 +56,13 @@ module FinchAPI
|
|
|
54
56
|
# @see FinchAPI::Models::HRIS::DocumentRetreiveParams
|
|
55
57
|
def retreive(document_id, params = {})
|
|
56
58
|
parsed, options = FinchAPI::HRIS::DocumentRetreiveParams.dump_request(params)
|
|
59
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
57
60
|
@client.request(
|
|
58
61
|
method: :get,
|
|
59
62
|
path: ["employer/documents/%1$s", document_id],
|
|
60
|
-
query:
|
|
63
|
+
query: query,
|
|
61
64
|
model: FinchAPI::Models::HRIS::DocumentRetreiveResponse,
|
|
65
|
+
security: {bearer_auth: true},
|
|
62
66
|
options: options
|
|
63
67
|
)
|
|
64
68
|
end
|
|
@@ -18,15 +18,17 @@ module FinchAPI
|
|
|
18
18
|
#
|
|
19
19
|
# @see FinchAPI::Models::HRIS::EmploymentRetrieveManyParams
|
|
20
20
|
def retrieve_many(params)
|
|
21
|
-
parsed, options = FinchAPI::HRIS::EmploymentRetrieveManyParams.dump_request(params)
|
|
22
21
|
query_params = [:entity_ids]
|
|
22
|
+
parsed, options = FinchAPI::HRIS::EmploymentRetrieveManyParams.dump_request(params)
|
|
23
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
23
24
|
@client.request(
|
|
24
25
|
method: :post,
|
|
25
26
|
path: "employer/employment",
|
|
26
|
-
query:
|
|
27
|
+
query: query,
|
|
27
28
|
body: parsed.except(*query_params),
|
|
28
29
|
page: FinchAPI::Internal::ResponsesPage,
|
|
29
30
|
model: FinchAPI::HRIS::EmploymentDataResponse,
|
|
31
|
+
security: {bearer_auth: true},
|
|
30
32
|
options: options
|
|
31
33
|
)
|
|
32
34
|
end
|
|
@@ -20,15 +20,17 @@ module FinchAPI
|
|
|
20
20
|
#
|
|
21
21
|
# @see FinchAPI::Models::HRIS::IndividualRetrieveManyParams
|
|
22
22
|
def retrieve_many(params = {})
|
|
23
|
-
parsed, options = FinchAPI::HRIS::IndividualRetrieveManyParams.dump_request(params)
|
|
24
23
|
query_params = [:entity_ids]
|
|
24
|
+
parsed, options = FinchAPI::HRIS::IndividualRetrieveManyParams.dump_request(params)
|
|
25
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
25
26
|
@client.request(
|
|
26
27
|
method: :post,
|
|
27
28
|
path: "employer/individual",
|
|
28
|
-
query:
|
|
29
|
+
query: query,
|
|
29
30
|
body: parsed.except(*query_params),
|
|
30
31
|
page: FinchAPI::Internal::ResponsesPage,
|
|
31
32
|
model: FinchAPI::HRIS::IndividualResponse,
|
|
33
|
+
security: {bearer_auth: true},
|
|
32
34
|
options: options
|
|
33
35
|
)
|
|
34
36
|
end
|
|
@@ -21,15 +21,17 @@ module FinchAPI
|
|
|
21
21
|
#
|
|
22
22
|
# @see FinchAPI::Models::HRIS::PayStatementRetrieveManyParams
|
|
23
23
|
def retrieve_many(params)
|
|
24
|
-
parsed, options = FinchAPI::HRIS::PayStatementRetrieveManyParams.dump_request(params)
|
|
25
24
|
query_params = [:entity_ids]
|
|
25
|
+
parsed, options = FinchAPI::HRIS::PayStatementRetrieveManyParams.dump_request(params)
|
|
26
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
26
27
|
@client.request(
|
|
27
28
|
method: :post,
|
|
28
29
|
path: "employer/pay-statement",
|
|
29
|
-
query:
|
|
30
|
+
query: query,
|
|
30
31
|
body: parsed.except(*query_params),
|
|
31
32
|
page: FinchAPI::Internal::ResponsesPage,
|
|
32
33
|
model: FinchAPI::HRIS::PayStatementResponse,
|
|
34
|
+
security: {bearer_auth: true},
|
|
33
35
|
options: options
|
|
34
36
|
)
|
|
35
37
|
end
|
|
@@ -24,12 +24,14 @@ module FinchAPI
|
|
|
24
24
|
# @see FinchAPI::Models::HRIS::PaymentListParams
|
|
25
25
|
def list(params)
|
|
26
26
|
parsed, options = FinchAPI::HRIS::PaymentListParams.dump_request(params)
|
|
27
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
27
28
|
@client.request(
|
|
28
29
|
method: :get,
|
|
29
30
|
path: "employer/payment",
|
|
30
|
-
query:
|
|
31
|
+
query: query,
|
|
31
32
|
page: FinchAPI::Internal::SinglePage,
|
|
32
33
|
model: FinchAPI::HRIS::Payment,
|
|
34
|
+
security: {bearer_auth: true},
|
|
33
35
|
options: options
|
|
34
36
|
)
|
|
35
37
|
end
|
|
@@ -19,12 +19,9 @@ module FinchAPI
|
|
|
19
19
|
# This endpoint is available for _Scale_ tier customers as an add-on. To request
|
|
20
20
|
# access to this endpoint, please contact your Finch account manager.
|
|
21
21
|
#
|
|
22
|
-
# @overload create(
|
|
23
|
-
#
|
|
24
|
-
# @param type [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type] The type of job to start.
|
|
25
|
-
#
|
|
26
|
-
# @param params [FinchAPI::Models::Jobs::AutomatedCreateParams::Params]
|
|
22
|
+
# @overload create(body:, request_options: {})
|
|
27
23
|
#
|
|
24
|
+
# @param body [FinchAPI::Models::Jobs::AutomatedCreateParams::Body::DataSyncAll, FinchAPI::Models::Jobs::AutomatedCreateParams::Body::W4FormEmployeeSync]
|
|
28
25
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
29
26
|
#
|
|
30
27
|
# @return [FinchAPI::Models::Jobs::AutomatedCreateResponse]
|
|
@@ -35,8 +32,9 @@ module FinchAPI
|
|
|
35
32
|
@client.request(
|
|
36
33
|
method: :post,
|
|
37
34
|
path: "jobs/automated",
|
|
38
|
-
body: parsed,
|
|
35
|
+
body: parsed[:body],
|
|
39
36
|
model: FinchAPI::Models::Jobs::AutomatedCreateResponse,
|
|
37
|
+
security: {bearer_auth: true},
|
|
40
38
|
options: options
|
|
41
39
|
)
|
|
42
40
|
end
|
|
@@ -56,6 +54,7 @@ module FinchAPI
|
|
|
56
54
|
method: :get,
|
|
57
55
|
path: ["jobs/automated/%1$s", job_id],
|
|
58
56
|
model: FinchAPI::Jobs::AutomatedAsyncJob,
|
|
57
|
+
security: {bearer_auth: true},
|
|
59
58
|
options: params[:request_options]
|
|
60
59
|
)
|
|
61
60
|
end
|
|
@@ -77,11 +76,13 @@ module FinchAPI
|
|
|
77
76
|
# @see FinchAPI::Models::Jobs::AutomatedListParams
|
|
78
77
|
def list(params = {})
|
|
79
78
|
parsed, options = FinchAPI::Jobs::AutomatedListParams.dump_request(params)
|
|
79
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
80
80
|
@client.request(
|
|
81
81
|
method: :get,
|
|
82
82
|
path: "jobs/automated",
|
|
83
|
-
query:
|
|
83
|
+
query: query,
|
|
84
84
|
model: FinchAPI::Models::Jobs::AutomatedListResponse,
|
|
85
|
+
security: {bearer_auth: true},
|
|
85
86
|
options: options
|
|
86
87
|
)
|
|
87
88
|
end
|
|
@@ -19,11 +19,13 @@ module FinchAPI
|
|
|
19
19
|
# @see FinchAPI::Models::Payroll::PayGroupRetrieveParams
|
|
20
20
|
def retrieve(pay_group_id, params = {})
|
|
21
21
|
parsed, options = FinchAPI::Payroll::PayGroupRetrieveParams.dump_request(params)
|
|
22
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
22
23
|
@client.request(
|
|
23
24
|
method: :get,
|
|
24
25
|
path: ["employer/pay-groups/%1$s", pay_group_id],
|
|
25
|
-
query:
|
|
26
|
+
query: query,
|
|
26
27
|
model: FinchAPI::Models::Payroll::PayGroupRetrieveResponse,
|
|
28
|
+
security: {bearer_auth: true},
|
|
27
29
|
options: options
|
|
28
30
|
)
|
|
29
31
|
end
|
|
@@ -45,12 +47,14 @@ module FinchAPI
|
|
|
45
47
|
# @see FinchAPI::Models::Payroll::PayGroupListParams
|
|
46
48
|
def list(params = {})
|
|
47
49
|
parsed, options = FinchAPI::Payroll::PayGroupListParams.dump_request(params)
|
|
50
|
+
query = FinchAPI::Internal::Util.encode_query_params(parsed)
|
|
48
51
|
@client.request(
|
|
49
52
|
method: :get,
|
|
50
53
|
path: "employer/pay-groups",
|
|
51
|
-
query:
|
|
54
|
+
query: query,
|
|
52
55
|
page: FinchAPI::Internal::SinglePage,
|
|
53
56
|
model: FinchAPI::Models::Payroll::PayGroupListResponse,
|
|
57
|
+
security: {bearer_auth: true},
|
|
54
58
|
options: options
|
|
55
59
|
)
|
|
56
60
|
end
|
|
@@ -32,6 +32,7 @@ module FinchAPI
|
|
|
32
32
|
path: "sandbox/connections/accounts",
|
|
33
33
|
body: parsed,
|
|
34
34
|
model: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse,
|
|
35
|
+
security: {basic_auth: true},
|
|
35
36
|
options: options
|
|
36
37
|
)
|
|
37
38
|
end
|
|
@@ -54,6 +55,7 @@ module FinchAPI
|
|
|
54
55
|
path: "sandbox/connections/accounts",
|
|
55
56
|
body: parsed,
|
|
56
57
|
model: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse,
|
|
58
|
+
security: {bearer_auth: true},
|
|
57
59
|
options: options
|
|
58
60
|
)
|
|
59
61
|
end
|
|
@@ -9,7 +9,7 @@ module FinchAPI
|
|
|
9
9
|
#
|
|
10
10
|
# Update sandbox employment
|
|
11
11
|
#
|
|
12
|
-
# @overload update(individual_id, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, request_options: {})
|
|
12
|
+
# @overload update(individual_id, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, request_options: {})
|
|
13
13
|
#
|
|
14
14
|
# @param individual_id [String]
|
|
15
15
|
#
|
|
@@ -27,6 +27,8 @@ module FinchAPI
|
|
|
27
27
|
#
|
|
28
28
|
# @param first_name [String, nil] The legal first name of the individual.
|
|
29
29
|
#
|
|
30
|
+
# @param flsa_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::FlsaStatus, nil] The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `u
|
|
31
|
+
#
|
|
30
32
|
# @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
|
31
33
|
#
|
|
32
34
|
# @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
|
|
@@ -61,6 +63,7 @@ module FinchAPI
|
|
|
61
63
|
path: ["sandbox/employment/%1$s", individual_id],
|
|
62
64
|
body: parsed,
|
|
63
65
|
model: FinchAPI::Models::Sandbox::EmploymentUpdateResponse,
|
|
66
|
+
security: {bearer_auth: true},
|
|
64
67
|
options: options
|
|
65
68
|
)
|
|
66
69
|
end
|
|
@@ -19,6 +19,7 @@ module FinchAPI
|
|
|
19
19
|
method: :get,
|
|
20
20
|
path: "sandbox/jobs/configuration",
|
|
21
21
|
model: FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::Jobs::SandboxJobConfiguration],
|
|
22
|
+
security: {bearer_auth: true},
|
|
22
23
|
options: params[:request_options]
|
|
23
24
|
)
|
|
24
25
|
end
|
|
@@ -41,6 +42,7 @@ module FinchAPI
|
|
|
41
42
|
path: "sandbox/jobs/configuration",
|
|
42
43
|
body: parsed,
|
|
43
44
|
model: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration,
|
|
45
|
+
security: {bearer_auth: true},
|
|
44
46
|
options: options
|
|
45
47
|
)
|
|
46
48
|
end
|
data/lib/finch_api/version.rb
CHANGED