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
@@ -5,7 +5,9 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class Payment < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::HRIS::Payment, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
# The unique id for the payment.
|
11
13
|
sig { returns(T.nilable(String)) }
|
@@ -197,7 +199,12 @@ module FinchAPI
|
|
197
199
|
|
198
200
|
class PayPeriod < FinchAPI::Internal::Type::BaseModel
|
199
201
|
OrHash =
|
200
|
-
T.type_alias
|
202
|
+
T.type_alias do
|
203
|
+
T.any(
|
204
|
+
FinchAPI::HRIS::Payment::PayPeriod,
|
205
|
+
FinchAPI::Internal::AnyHash
|
206
|
+
)
|
207
|
+
end
|
201
208
|
|
202
209
|
sig { returns(T.nilable(String)) }
|
203
210
|
attr_accessor :end_date
|
@@ -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::PaymentListParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
|
14
19
|
# format.
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class SupportPerBenefitType < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::HRIS::SupportPerBenefitType,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
sig { returns(T.nilable(FinchAPI::OperationSupportMatrix)) }
|
11
16
|
attr_reader :company_benefits
|
@@ -5,7 +5,9 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class SupportedBenefit < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::HRIS::SupportedBenefit, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
# Whether the provider supports an annual maximum for this benefit.
|
11
13
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class UpdateCompanyBenefitResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::HRIS::UpdateCompanyBenefitResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# The id of the benefit.
|
11
16
|
sig { returns(String) }
|
@@ -5,7 +5,9 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class W42005 < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::HRIS::W42005, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
# Detailed information specific to the 2005 W4 form.
|
11
13
|
sig { returns(T.nilable(FinchAPI::HRIS::W42005::Data)) }
|
@@ -58,7 +60,9 @@ module FinchAPI
|
|
58
60
|
|
59
61
|
class Data < FinchAPI::Internal::Type::BaseModel
|
60
62
|
OrHash =
|
61
|
-
T.type_alias
|
63
|
+
T.type_alias do
|
64
|
+
T.any(FinchAPI::HRIS::W42005::Data, FinchAPI::Internal::AnyHash)
|
65
|
+
end
|
62
66
|
|
63
67
|
# Additional withholding amount (in cents).
|
64
68
|
sig { returns(T.nilable(Integer)) }
|
@@ -5,7 +5,9 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class W42020 < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::HRIS::W42020, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
# Detailed information specific to the 2020 W4 form.
|
11
13
|
sig { returns(T.nilable(FinchAPI::HRIS::W42020::Data)) }
|
@@ -58,7 +60,9 @@ module FinchAPI
|
|
58
60
|
|
59
61
|
class Data < FinchAPI::Internal::Type::BaseModel
|
60
62
|
OrHash =
|
61
|
-
T.type_alias
|
63
|
+
T.type_alias do
|
64
|
+
T.any(FinchAPI::HRIS::W42020::Data, FinchAPI::Internal::AnyHash)
|
65
|
+
end
|
62
66
|
|
63
67
|
# Amount claimed for dependents other than qualifying children under 17 (in
|
64
68
|
# cents).
|
@@ -3,7 +3,8 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class Income < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias { T.any(FinchAPI::Income, FinchAPI::Internal::AnyHash) }
|
7
8
|
|
8
9
|
# The income amount in cents.
|
9
10
|
sig { returns(T.nilable(Integer)) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class IndividualEvent < FinchAPI::Models::BaseWebhookEvent
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::IndividualEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
sig { returns(T.nilable(FinchAPI::IndividualEvent::Data)) }
|
9
12
|
attr_reader :data
|
@@ -43,7 +46,9 @@ module FinchAPI
|
|
43
46
|
|
44
47
|
class Data < FinchAPI::Internal::Type::BaseModel
|
45
48
|
OrHash =
|
46
|
-
T.type_alias
|
49
|
+
T.type_alias do
|
50
|
+
T.any(FinchAPI::IndividualEvent::Data, FinchAPI::Internal::AnyHash)
|
51
|
+
end
|
47
52
|
|
48
53
|
# The ID of the individual related to the event.
|
49
54
|
sig { returns(T.nilable(String)) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class Introspection < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::Introspection, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
# The Finch UUID of the token being introspected.
|
9
12
|
sig { returns(String) }
|
@@ -188,7 +191,12 @@ module FinchAPI
|
|
188
191
|
|
189
192
|
class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
|
190
193
|
OrHash =
|
191
|
-
T.type_alias
|
194
|
+
T.type_alias do
|
195
|
+
T.any(
|
196
|
+
FinchAPI::Introspection::AuthenticationMethod,
|
197
|
+
FinchAPI::Internal::AnyHash
|
198
|
+
)
|
199
|
+
end
|
192
200
|
|
193
201
|
sig do
|
194
202
|
returns(
|
@@ -264,7 +272,12 @@ module FinchAPI
|
|
264
272
|
|
265
273
|
class ConnectionStatus < FinchAPI::Internal::Type::BaseModel
|
266
274
|
OrHash =
|
267
|
-
T.type_alias
|
275
|
+
T.type_alias do
|
276
|
+
T.any(
|
277
|
+
FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus,
|
278
|
+
FinchAPI::Internal::AnyHash
|
279
|
+
)
|
280
|
+
end
|
268
281
|
|
269
282
|
sig { returns(T.nilable(String)) }
|
270
283
|
attr_reader :message
|
@@ -375,7 +388,12 @@ module FinchAPI
|
|
375
388
|
|
376
389
|
class ConnectionStatus < FinchAPI::Internal::Type::BaseModel
|
377
390
|
OrHash =
|
378
|
-
T.type_alias
|
391
|
+
T.type_alias do
|
392
|
+
T.any(
|
393
|
+
FinchAPI::Introspection::ConnectionStatus,
|
394
|
+
FinchAPI::Internal::AnyHash
|
395
|
+
)
|
396
|
+
end
|
379
397
|
|
380
398
|
# The datetime when the connection was last successfully synced.
|
381
399
|
sig { returns(T.nilable(Time)) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::JobCompletionEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
sig { returns(T.nilable(FinchAPI::JobCompletionEvent::Data)) }
|
9
12
|
attr_reader :data
|
@@ -47,7 +50,12 @@ module FinchAPI
|
|
47
50
|
|
48
51
|
class Data < FinchAPI::Internal::Type::BaseModel
|
49
52
|
OrHash =
|
50
|
-
T.type_alias
|
53
|
+
T.type_alias do
|
54
|
+
T.any(
|
55
|
+
FinchAPI::JobCompletionEvent::Data,
|
56
|
+
FinchAPI::Internal::AnyHash
|
57
|
+
)
|
58
|
+
end
|
51
59
|
|
52
60
|
# The id of the job which has completed.
|
53
61
|
sig { returns(String) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Jobs
|
6
6
|
class AutomatedAsyncJob < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Jobs::AutomatedAsyncJob,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# The datetime the job completed.
|
11
16
|
sig { returns(T.nilable(Time)) }
|
@@ -112,7 +117,12 @@ module FinchAPI
|
|
112
117
|
|
113
118
|
class Params < FinchAPI::Internal::Type::BaseModel
|
114
119
|
OrHash =
|
115
|
-
T.type_alias
|
120
|
+
T.type_alias do
|
121
|
+
T.any(
|
122
|
+
FinchAPI::Jobs::AutomatedAsyncJob::Params,
|
123
|
+
FinchAPI::Internal::AnyHash
|
124
|
+
)
|
125
|
+
end
|
116
126
|
|
117
127
|
# The ID of the individual that the job was completed for.
|
118
128
|
sig { returns(T.nilable(String)) }
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Jobs::AutomatedCreateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# The type of job to start.
|
14
19
|
sig { returns(FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol) }
|
@@ -80,7 +85,12 @@ module FinchAPI
|
|
80
85
|
|
81
86
|
class Params < FinchAPI::Internal::Type::BaseModel
|
82
87
|
OrHash =
|
83
|
-
T.type_alias
|
88
|
+
T.type_alias do
|
89
|
+
T.any(
|
90
|
+
FinchAPI::Jobs::AutomatedCreateParams::Params,
|
91
|
+
FinchAPI::Internal::AnyHash
|
92
|
+
)
|
93
|
+
end
|
84
94
|
|
85
95
|
# The unique ID of the individual for W-4 data sync.
|
86
96
|
sig { returns(String) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Jobs
|
6
6
|
class AutomatedCreateResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Jobs::AutomatedCreateResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# The number of allowed refreshes per hour (per hour, fixed window)
|
11
16
|
sig { returns(Integer) }
|
@@ -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::Jobs::AutomatedListParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# Number of items to return
|
14
19
|
sig { returns(T.nilable(Integer)) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Jobs
|
6
6
|
class AutomatedListResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Jobs::AutomatedListResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
sig { returns(T::Array[FinchAPI::Jobs::AutomatedAsyncJob]) }
|
11
16
|
attr_accessor :data
|
@@ -42,7 +47,12 @@ module FinchAPI
|
|
42
47
|
|
43
48
|
class Meta < FinchAPI::Internal::Type::BaseModel
|
44
49
|
OrHash =
|
45
|
-
T.type_alias
|
50
|
+
T.type_alias do
|
51
|
+
T.any(
|
52
|
+
FinchAPI::Models::Jobs::AutomatedListResponse::Meta,
|
53
|
+
FinchAPI::Internal::AnyHash
|
54
|
+
)
|
55
|
+
end
|
46
56
|
|
47
57
|
# Information about remaining quotas for this connection. Only applicable for
|
48
58
|
# customers opted in to use Finch's Data Sync Refresh endpoint
|
@@ -93,7 +103,12 @@ module FinchAPI
|
|
93
103
|
|
94
104
|
class Quotas < FinchAPI::Internal::Type::BaseModel
|
95
105
|
OrHash =
|
96
|
-
T.type_alias
|
106
|
+
T.type_alias do
|
107
|
+
T.any(
|
108
|
+
FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas,
|
109
|
+
FinchAPI::Internal::AnyHash
|
110
|
+
)
|
111
|
+
end
|
97
112
|
|
98
113
|
sig do
|
99
114
|
returns(
|
@@ -138,7 +153,12 @@ module FinchAPI
|
|
138
153
|
|
139
154
|
class DataSyncAll < FinchAPI::Internal::Type::BaseModel
|
140
155
|
OrHash =
|
141
|
-
T.type_alias
|
156
|
+
T.type_alias do
|
157
|
+
T.any(
|
158
|
+
FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll,
|
159
|
+
FinchAPI::Internal::AnyHash
|
160
|
+
)
|
161
|
+
end
|
142
162
|
|
143
163
|
sig { returns(T.nilable(Integer)) }
|
144
164
|
attr_reader :allowed_refreshes
|
@@ -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::Jobs::AutomatedRetrieveParams,
|
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,9 @@ module FinchAPI
|
|
5
5
|
module Jobs
|
6
6
|
class ManualAsyncJob < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(FinchAPI::Jobs::ManualAsyncJob, FinchAPI::Internal::AnyHash)
|
10
|
+
end
|
9
11
|
|
10
12
|
# Specific information about the job, such as individual statuses for batch jobs.
|
11
13
|
sig { returns(T.nilable(T::Array[T.anything])) }
|
@@ -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::Jobs::ManualRetrieveParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig do
|
14
19
|
params(request_options: FinchAPI::RequestOptions::OrHash).returns(
|
@@ -3,7 +3,8 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class Location < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias { T.any(FinchAPI::Location, FinchAPI::Internal::AnyHash) }
|
7
8
|
|
8
9
|
# City, district, suburb, town, or village.
|
9
10
|
sig { returns(T.nilable(String)) }
|
@@ -3,7 +3,8 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class Money < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias { T.any(FinchAPI::Money, FinchAPI::Internal::AnyHash) }
|
7
8
|
|
8
9
|
# Amount for money object (in cents)
|
9
10
|
sig { returns(T.nilable(Integer)) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class OperationSupportMatrix < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::OperationSupportMatrix, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
# - `supported`: This operation is supported by both the provider and Finch
|
9
12
|
# - `not_supported_by_finch`: This operation is not supported by Finch but
|
@@ -3,7 +3,8 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class Paging < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias { T.any(FinchAPI::Paging, FinchAPI::Internal::AnyHash) }
|
7
8
|
|
8
9
|
# The current start index of the returned list of elements
|
9
10
|
sig { returns(Integer) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::PayStatementEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
sig { returns(T.nilable(FinchAPI::PayStatementEvent::Data)) }
|
9
12
|
attr_reader :data
|
@@ -45,7 +48,12 @@ module FinchAPI
|
|
45
48
|
|
46
49
|
class Data < FinchAPI::Internal::Type::BaseModel
|
47
50
|
OrHash =
|
48
|
-
T.type_alias
|
51
|
+
T.type_alias do
|
52
|
+
T.any(
|
53
|
+
FinchAPI::PayStatementEvent::Data,
|
54
|
+
FinchAPI::Internal::AnyHash
|
55
|
+
)
|
56
|
+
end
|
49
57
|
|
50
58
|
# The ID of the individual associated with the pay statement.
|
51
59
|
sig { returns(T.nilable(String)) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class PaymentEvent < FinchAPI::Models::BaseWebhookEvent
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::PaymentEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
sig { returns(T.nilable(FinchAPI::PaymentEvent::Data)) }
|
9
12
|
attr_reader :data
|
@@ -43,7 +46,9 @@ module FinchAPI
|
|
43
46
|
|
44
47
|
class Data < FinchAPI::Internal::Type::BaseModel
|
45
48
|
OrHash =
|
46
|
-
T.type_alias
|
49
|
+
T.type_alias do
|
50
|
+
T.any(FinchAPI::PaymentEvent::Data, FinchAPI::Internal::AnyHash)
|
51
|
+
end
|
47
52
|
|
48
53
|
# The date of the payment.
|
49
54
|
sig { returns(String) }
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Payroll::PayGroupListParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig { returns(T.nilable(String)) }
|
14
19
|
attr_reader :individual_id
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Payroll
|
6
6
|
class PayGroupListResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Payroll::PayGroupListResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# Finch id (uuidv4) for the pay group
|
11
16
|
sig { returns(T.nilable(String)) }
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Payroll::PayGroupRetrieveParams,
|
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 Payroll
|
6
6
|
class PayGroupRetrieveResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Payroll::PayGroupRetrieveResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# Finch id (uuidv4) for the pay group
|
11
16
|
sig { returns(String) }
|