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
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class AccountUpdateEvent < FinchAPI::Models::BaseWebhookEvent
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::AccountUpdateEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
sig { returns(T.nilable(FinchAPI::AccountUpdateEvent::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::AccountUpdateEvent::Data,
|
56
|
+
FinchAPI::Internal::AnyHash
|
57
|
+
)
|
58
|
+
end
|
51
59
|
|
52
60
|
sig do
|
53
61
|
returns(FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod)
|
@@ -89,7 +97,12 @@ module FinchAPI
|
|
89
97
|
|
90
98
|
class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
|
91
99
|
OrHash =
|
92
|
-
T.type_alias
|
100
|
+
T.type_alias do
|
101
|
+
T.any(
|
102
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod,
|
103
|
+
FinchAPI::Internal::AnyHash
|
104
|
+
)
|
105
|
+
end
|
93
106
|
|
94
107
|
# Each benefit type and their supported features. If the benefit type is not
|
95
108
|
# supported, the property will be null
|
@@ -183,7 +196,12 @@ module FinchAPI
|
|
183
196
|
|
184
197
|
class SupportedFields < FinchAPI::Internal::Type::BaseModel
|
185
198
|
OrHash =
|
186
|
-
T.type_alias
|
199
|
+
T.type_alias do
|
200
|
+
T.any(
|
201
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields,
|
202
|
+
FinchAPI::Internal::AnyHash
|
203
|
+
)
|
204
|
+
end
|
187
205
|
|
188
206
|
sig do
|
189
207
|
returns(
|
@@ -359,7 +377,12 @@ module FinchAPI
|
|
359
377
|
|
360
378
|
class Company < FinchAPI::Internal::Type::BaseModel
|
361
379
|
OrHash =
|
362
|
-
T.type_alias
|
380
|
+
T.type_alias do
|
381
|
+
T.any(
|
382
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company,
|
383
|
+
FinchAPI::Internal::AnyHash
|
384
|
+
)
|
385
|
+
end
|
363
386
|
|
364
387
|
sig { returns(T.nilable(T::Boolean)) }
|
365
388
|
attr_reader :id
|
@@ -514,7 +537,10 @@ module FinchAPI
|
|
514
537
|
class Accounts < FinchAPI::Internal::Type::BaseModel
|
515
538
|
OrHash =
|
516
539
|
T.type_alias do
|
517
|
-
T.any(
|
540
|
+
T.any(
|
541
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts,
|
542
|
+
FinchAPI::Internal::AnyHash
|
543
|
+
)
|
518
544
|
end
|
519
545
|
|
520
546
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -583,7 +609,10 @@ module FinchAPI
|
|
583
609
|
class Departments < FinchAPI::Internal::Type::BaseModel
|
584
610
|
OrHash =
|
585
611
|
T.type_alias do
|
586
|
-
T.any(
|
612
|
+
T.any(
|
613
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments,
|
614
|
+
FinchAPI::Internal::AnyHash
|
615
|
+
)
|
587
616
|
end
|
588
617
|
|
589
618
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -634,7 +663,10 @@ module FinchAPI
|
|
634
663
|
class Parent < FinchAPI::Internal::Type::BaseModel
|
635
664
|
OrHash =
|
636
665
|
T.type_alias do
|
637
|
-
T.any(
|
666
|
+
T.any(
|
667
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent,
|
668
|
+
FinchAPI::Internal::AnyHash
|
669
|
+
)
|
638
670
|
end
|
639
671
|
|
640
672
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -656,7 +688,10 @@ module FinchAPI
|
|
656
688
|
class Entity < FinchAPI::Internal::Type::BaseModel
|
657
689
|
OrHash =
|
658
690
|
T.type_alias do
|
659
|
-
T.any(
|
691
|
+
T.any(
|
692
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity,
|
693
|
+
FinchAPI::Internal::AnyHash
|
694
|
+
)
|
660
695
|
end
|
661
696
|
|
662
697
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -689,7 +724,10 @@ module FinchAPI
|
|
689
724
|
class Locations < FinchAPI::Internal::Type::BaseModel
|
690
725
|
OrHash =
|
691
726
|
T.type_alias do
|
692
|
-
T.any(
|
727
|
+
T.any(
|
728
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations,
|
729
|
+
FinchAPI::Internal::AnyHash
|
730
|
+
)
|
693
731
|
end
|
694
732
|
|
695
733
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -767,7 +805,12 @@ module FinchAPI
|
|
767
805
|
|
768
806
|
class Directory < FinchAPI::Internal::Type::BaseModel
|
769
807
|
OrHash =
|
770
|
-
T.type_alias
|
808
|
+
T.type_alias do
|
809
|
+
T.any(
|
810
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory,
|
811
|
+
FinchAPI::Internal::AnyHash
|
812
|
+
)
|
813
|
+
end
|
771
814
|
|
772
815
|
sig do
|
773
816
|
returns(
|
@@ -830,7 +873,10 @@ module FinchAPI
|
|
830
873
|
class Individuals < FinchAPI::Internal::Type::BaseModel
|
831
874
|
OrHash =
|
832
875
|
T.type_alias do
|
833
|
-
T.any(
|
876
|
+
T.any(
|
877
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals,
|
878
|
+
FinchAPI::Internal::AnyHash
|
879
|
+
)
|
834
880
|
end
|
835
881
|
|
836
882
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -929,7 +975,10 @@ module FinchAPI
|
|
929
975
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
930
976
|
OrHash =
|
931
977
|
T.type_alias do
|
932
|
-
T.any(
|
978
|
+
T.any(
|
979
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager,
|
980
|
+
FinchAPI::Internal::AnyHash
|
981
|
+
)
|
933
982
|
end
|
934
983
|
|
935
984
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -951,7 +1000,10 @@ module FinchAPI
|
|
951
1000
|
class Paging < FinchAPI::Internal::Type::BaseModel
|
952
1001
|
OrHash =
|
953
1002
|
T.type_alias do
|
954
|
-
T.any(
|
1003
|
+
T.any(
|
1004
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging,
|
1005
|
+
FinchAPI::Internal::AnyHash
|
1006
|
+
)
|
955
1007
|
end
|
956
1008
|
|
957
1009
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -984,7 +1036,12 @@ module FinchAPI
|
|
984
1036
|
|
985
1037
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
986
1038
|
OrHash =
|
987
|
-
T.type_alias
|
1039
|
+
T.type_alias do
|
1040
|
+
T.any(
|
1041
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment,
|
1042
|
+
FinchAPI::Internal::AnyHash
|
1043
|
+
)
|
1044
|
+
end
|
988
1045
|
|
989
1046
|
sig { returns(T.nilable(T::Boolean)) }
|
990
1047
|
attr_reader :id
|
@@ -1224,7 +1281,10 @@ module FinchAPI
|
|
1224
1281
|
class Department < FinchAPI::Internal::Type::BaseModel
|
1225
1282
|
OrHash =
|
1226
1283
|
T.type_alias do
|
1227
|
-
T.any(
|
1284
|
+
T.any(
|
1285
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department,
|
1286
|
+
FinchAPI::Internal::AnyHash
|
1287
|
+
)
|
1228
1288
|
end
|
1229
1289
|
|
1230
1290
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -1245,7 +1305,10 @@ module FinchAPI
|
|
1245
1305
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
1246
1306
|
OrHash =
|
1247
1307
|
T.type_alias do
|
1248
|
-
T.any(
|
1308
|
+
T.any(
|
1309
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment,
|
1310
|
+
FinchAPI::Internal::AnyHash
|
1311
|
+
)
|
1249
1312
|
end
|
1250
1313
|
|
1251
1314
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -1278,7 +1341,10 @@ module FinchAPI
|
|
1278
1341
|
class Income < FinchAPI::Internal::Type::BaseModel
|
1279
1342
|
OrHash =
|
1280
1343
|
T.type_alias do
|
1281
|
-
T.any(
|
1344
|
+
T.any(
|
1345
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income,
|
1346
|
+
FinchAPI::Internal::AnyHash
|
1347
|
+
)
|
1282
1348
|
end
|
1283
1349
|
|
1284
1350
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -1325,7 +1391,10 @@ module FinchAPI
|
|
1325
1391
|
class Location < FinchAPI::Internal::Type::BaseModel
|
1326
1392
|
OrHash =
|
1327
1393
|
T.type_alias do
|
1328
|
-
T.any(
|
1394
|
+
T.any(
|
1395
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location,
|
1396
|
+
FinchAPI::Internal::AnyHash
|
1397
|
+
)
|
1329
1398
|
end
|
1330
1399
|
|
1331
1400
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -1403,7 +1472,10 @@ module FinchAPI
|
|
1403
1472
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
1404
1473
|
OrHash =
|
1405
1474
|
T.type_alias do
|
1406
|
-
T.any(
|
1475
|
+
T.any(
|
1476
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager,
|
1477
|
+
FinchAPI::Internal::AnyHash
|
1478
|
+
)
|
1407
1479
|
end
|
1408
1480
|
|
1409
1481
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -1424,7 +1496,12 @@ module FinchAPI
|
|
1424
1496
|
|
1425
1497
|
class Individual < FinchAPI::Internal::Type::BaseModel
|
1426
1498
|
OrHash =
|
1427
|
-
T.type_alias
|
1499
|
+
T.type_alias do
|
1500
|
+
T.any(
|
1501
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual,
|
1502
|
+
FinchAPI::Internal::AnyHash
|
1503
|
+
)
|
1504
|
+
end
|
1428
1505
|
|
1429
1506
|
sig { returns(T.nilable(T::Boolean)) }
|
1430
1507
|
attr_reader :id
|
@@ -1602,7 +1679,10 @@ module FinchAPI
|
|
1602
1679
|
class Emails < FinchAPI::Internal::Type::BaseModel
|
1603
1680
|
OrHash =
|
1604
1681
|
T.type_alias do
|
1605
|
-
T.any(
|
1682
|
+
T.any(
|
1683
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails,
|
1684
|
+
FinchAPI::Internal::AnyHash
|
1685
|
+
)
|
1606
1686
|
end
|
1607
1687
|
|
1608
1688
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -1633,7 +1713,10 @@ module FinchAPI
|
|
1633
1713
|
class PhoneNumbers < FinchAPI::Internal::Type::BaseModel
|
1634
1714
|
OrHash =
|
1635
1715
|
T.type_alias do
|
1636
|
-
T.any(
|
1716
|
+
T.any(
|
1717
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers,
|
1718
|
+
FinchAPI::Internal::AnyHash
|
1719
|
+
)
|
1637
1720
|
end
|
1638
1721
|
|
1639
1722
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -1664,7 +1747,10 @@ module FinchAPI
|
|
1664
1747
|
class Residence < FinchAPI::Internal::Type::BaseModel
|
1665
1748
|
OrHash =
|
1666
1749
|
T.type_alias do
|
1667
|
-
T.any(
|
1750
|
+
T.any(
|
1751
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence,
|
1752
|
+
FinchAPI::Internal::AnyHash
|
1753
|
+
)
|
1668
1754
|
end
|
1669
1755
|
|
1670
1756
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -1742,7 +1828,12 @@ module FinchAPI
|
|
1742
1828
|
|
1743
1829
|
class PayGroup < FinchAPI::Internal::Type::BaseModel
|
1744
1830
|
OrHash =
|
1745
|
-
T.type_alias
|
1831
|
+
T.type_alias do
|
1832
|
+
T.any(
|
1833
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup,
|
1834
|
+
FinchAPI::Internal::AnyHash
|
1835
|
+
)
|
1836
|
+
end
|
1746
1837
|
|
1747
1838
|
sig { returns(T.nilable(T::Boolean)) }
|
1748
1839
|
attr_reader :id
|
@@ -1800,7 +1891,12 @@ module FinchAPI
|
|
1800
1891
|
|
1801
1892
|
class PayStatement < FinchAPI::Internal::Type::BaseModel
|
1802
1893
|
OrHash =
|
1803
|
-
T.type_alias
|
1894
|
+
T.type_alias do
|
1895
|
+
T.any(
|
1896
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement,
|
1897
|
+
FinchAPI::Internal::AnyHash
|
1898
|
+
)
|
1899
|
+
end
|
1804
1900
|
|
1805
1901
|
sig do
|
1806
1902
|
returns(
|
@@ -1863,7 +1959,10 @@ module FinchAPI
|
|
1863
1959
|
class Paging < FinchAPI::Internal::Type::BaseModel
|
1864
1960
|
OrHash =
|
1865
1961
|
T.type_alias do
|
1866
|
-
T.any(
|
1962
|
+
T.any(
|
1963
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging,
|
1964
|
+
FinchAPI::Internal::AnyHash
|
1965
|
+
)
|
1867
1966
|
end
|
1868
1967
|
|
1869
1968
|
sig { returns(T::Boolean) }
|
@@ -1890,7 +1989,10 @@ module FinchAPI
|
|
1890
1989
|
class PayStatements < FinchAPI::Internal::Type::BaseModel
|
1891
1990
|
OrHash =
|
1892
1991
|
T.type_alias do
|
1893
|
-
T.any(
|
1992
|
+
T.any(
|
1993
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements,
|
1994
|
+
FinchAPI::Internal::AnyHash
|
1995
|
+
)
|
1894
1996
|
end
|
1895
1997
|
|
1896
1998
|
sig do
|
@@ -2055,7 +2157,10 @@ module FinchAPI
|
|
2055
2157
|
class Earnings < FinchAPI::Internal::Type::BaseModel
|
2056
2158
|
OrHash =
|
2057
2159
|
T.type_alias do
|
2058
|
-
T.any(
|
2160
|
+
T.any(
|
2161
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings,
|
2162
|
+
FinchAPI::Internal::AnyHash
|
2163
|
+
)
|
2059
2164
|
end
|
2060
2165
|
|
2061
2166
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -2110,7 +2215,10 @@ module FinchAPI
|
|
2110
2215
|
class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel
|
2111
2216
|
OrHash =
|
2112
2217
|
T.type_alias do
|
2113
|
-
T.any(
|
2218
|
+
T.any(
|
2219
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions,
|
2220
|
+
FinchAPI::Internal::AnyHash
|
2221
|
+
)
|
2114
2222
|
end
|
2115
2223
|
|
2116
2224
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -2179,7 +2287,10 @@ module FinchAPI
|
|
2179
2287
|
class EmployerContributions < FinchAPI::Internal::Type::BaseModel
|
2180
2288
|
OrHash =
|
2181
2289
|
T.type_alias do
|
2182
|
-
T.any(
|
2290
|
+
T.any(
|
2291
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions,
|
2292
|
+
FinchAPI::Internal::AnyHash
|
2293
|
+
)
|
2183
2294
|
end
|
2184
2295
|
|
2185
2296
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -2226,7 +2337,10 @@ module FinchAPI
|
|
2226
2337
|
class Taxes < FinchAPI::Internal::Type::BaseModel
|
2227
2338
|
OrHash =
|
2228
2339
|
T.type_alias do
|
2229
|
-
T.any(
|
2340
|
+
T.any(
|
2341
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes,
|
2342
|
+
FinchAPI::Internal::AnyHash
|
2343
|
+
)
|
2230
2344
|
end
|
2231
2345
|
|
2232
2346
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -2296,7 +2410,12 @@ module FinchAPI
|
|
2296
2410
|
|
2297
2411
|
class Payment < FinchAPI::Internal::Type::BaseModel
|
2298
2412
|
OrHash =
|
2299
|
-
T.type_alias
|
2413
|
+
T.type_alias do
|
2414
|
+
T.any(
|
2415
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment,
|
2416
|
+
FinchAPI::Internal::AnyHash
|
2417
|
+
)
|
2418
|
+
end
|
2300
2419
|
|
2301
2420
|
sig { returns(T.nilable(T::Boolean)) }
|
2302
2421
|
attr_reader :id
|
@@ -2439,7 +2558,10 @@ module FinchAPI
|
|
2439
2558
|
class PayPeriod < FinchAPI::Internal::Type::BaseModel
|
2440
2559
|
OrHash =
|
2441
2560
|
T.type_alias do
|
2442
|
-
T.any(
|
2561
|
+
T.any(
|
2562
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod,
|
2563
|
+
FinchAPI::Internal::AnyHash
|
2564
|
+
)
|
2443
2565
|
end
|
2444
2566
|
|
2445
2567
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::BaseWebhookEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
# [DEPRECATED] Unique Finch ID of the employer account used to make this
|
9
12
|
# connection. Use `connection_id` instead to identify the connection associated
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class CompanyEvent < FinchAPI::Models::BaseWebhookEvent
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::CompanyEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
9
12
|
attr_accessor :data
|
@@ -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::Connect::SessionNewParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
sig { returns(String) }
|
14
19
|
attr_accessor :customer_id
|
@@ -194,7 +199,12 @@ module FinchAPI
|
|
194
199
|
|
195
200
|
class Integration < FinchAPI::Internal::Type::BaseModel
|
196
201
|
OrHash =
|
197
|
-
T.type_alias
|
202
|
+
T.type_alias do
|
203
|
+
T.any(
|
204
|
+
FinchAPI::Connect::SessionNewParams::Integration,
|
205
|
+
FinchAPI::Internal::AnyHash
|
206
|
+
)
|
207
|
+
end
|
198
208
|
|
199
209
|
sig do
|
200
210
|
returns(
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Connect
|
6
6
|
class SessionNewResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Connect::SessionNewResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# The Connect URL to redirect the user to for authentication
|
11
16
|
sig { returns(String) }
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::Connect::SessionReauthenticateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# The ID of the existing connection to reauthenticate
|
14
19
|
sig { returns(String) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module Connect
|
6
6
|
class SessionReauthenticateResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::Models::Connect::SessionReauthenticateResponse,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# The Connect URL to redirect the user to for reauthentication
|
11
16
|
sig { returns(String) }
|
@@ -3,7 +3,13 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(
|
9
|
+
FinchAPI::CreateAccessTokenResponse,
|
10
|
+
FinchAPI::Internal::AnyHash
|
11
|
+
)
|
12
|
+
end
|
7
13
|
|
8
14
|
# The access token for the connection.
|
9
15
|
sig { returns(String) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::DirectoryEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
sig { returns(T.nilable(FinchAPI::DirectoryEvent::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::DirectoryEvent::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 DisconnectResponse < FinchAPI::Internal::Type::BaseModel
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::DisconnectResponse, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
# If the request is successful, Finch will return “success” (HTTP 200 status).
|
9
12
|
sig { returns(String) }
|
@@ -3,7 +3,10 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent
|
6
|
-
OrHash =
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(FinchAPI::EmploymentEvent, FinchAPI::Internal::AnyHash)
|
9
|
+
end
|
7
10
|
|
8
11
|
sig { returns(T.nilable(FinchAPI::EmploymentEvent::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::EmploymentEvent::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)) }
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class BenefitContribution < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::HRIS::BenefitContribution,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
# Contribution amount in cents (if `fixed`) or basis points (if `percent`).
|
11
16
|
sig { returns(T.nilable(Integer)) }
|
@@ -8,7 +8,12 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
OrHash =
|
11
|
-
T.type_alias
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
FinchAPI::HRIS::BenefitCreateParams,
|
14
|
+
FinchAPI::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
12
17
|
|
13
18
|
# The company match for this benefit.
|
14
19
|
sig do
|
@@ -91,7 +96,12 @@ module FinchAPI
|
|
91
96
|
|
92
97
|
class CompanyContribution < FinchAPI::Internal::Type::BaseModel
|
93
98
|
OrHash =
|
94
|
-
T.type_alias
|
99
|
+
T.type_alias do
|
100
|
+
T.any(
|
101
|
+
FinchAPI::HRIS::BenefitCreateParams::CompanyContribution,
|
102
|
+
FinchAPI::Internal::AnyHash
|
103
|
+
)
|
104
|
+
end
|
95
105
|
|
96
106
|
sig do
|
97
107
|
returns(
|
@@ -162,7 +172,12 @@ module FinchAPI
|
|
162
172
|
|
163
173
|
class Tier < FinchAPI::Internal::Type::BaseModel
|
164
174
|
OrHash =
|
165
|
-
T.type_alias
|
175
|
+
T.type_alias do
|
176
|
+
T.any(
|
177
|
+
FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier,
|
178
|
+
FinchAPI::Internal::AnyHash
|
179
|
+
)
|
180
|
+
end
|
166
181
|
|
167
182
|
sig { returns(T.nilable(Integer)) }
|
168
183
|
attr_reader :match
|
@@ -5,7 +5,12 @@ module FinchAPI
|
|
5
5
|
module HRIS
|
6
6
|
class BenefitFeaturesAndOperations < FinchAPI::Internal::Type::BaseModel
|
7
7
|
OrHash =
|
8
|
-
T.type_alias
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
FinchAPI::HRIS::BenefitFeaturesAndOperations,
|
11
|
+
FinchAPI::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
9
14
|
|
10
15
|
sig do
|
11
16
|
returns(
|
@@ -58,7 +63,12 @@ module FinchAPI
|
|
58
63
|
|
59
64
|
class SupportedFeatures < FinchAPI::Internal::Type::BaseModel
|
60
65
|
OrHash =
|
61
|
-
T.type_alias
|
66
|
+
T.type_alias do
|
67
|
+
T.any(
|
68
|
+
FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures,
|
69
|
+
FinchAPI::Internal::AnyHash
|
70
|
+
)
|
71
|
+
end
|
62
72
|
|
63
73
|
# Whether the provider supports an annual maximum for this benefit.
|
64
74
|
sig { returns(T.nilable(T::Boolean)) }
|