finch-api 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

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.
Files changed (164) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +43 -0
  3. data/README.md +92 -53
  4. data/lib/finch_api/client.rb +4 -4
  5. data/lib/finch_api/errors.rb +1 -1
  6. data/lib/finch_api/internal/transport/base_client.rb +77 -5
  7. data/lib/finch_api/internal/transport/pooled_net_requester.rb +17 -1
  8. data/lib/finch_api/internal/type/array_of.rb +1 -1
  9. data/lib/finch_api/internal/type/base_model.rb +70 -30
  10. data/lib/finch_api/internal/type/converter.rb +18 -0
  11. data/lib/finch_api/internal/type/enum.rb +1 -0
  12. data/lib/finch_api/internal/type/hash_of.rb +1 -1
  13. data/lib/finch_api/internal/type/union.rb +1 -0
  14. data/lib/finch_api/internal/util.rb +56 -0
  15. data/lib/finch_api/internal.rb +6 -0
  16. data/lib/finch_api/models/hris/document_retreive_response.rb +4 -0
  17. data/lib/finch_api/models/hris/employment_data.rb +19 -9
  18. data/lib/finch_api/models/hris/individual.rb +6 -0
  19. data/lib/finch_api/models/hris/pay_statement.rb +1 -0
  20. data/lib/finch_api/models/sandbox/payment_create_params.rb +1 -0
  21. data/lib/finch_api/models/webhook_event.rb +15 -0
  22. data/lib/finch_api/models.rb +27 -0
  23. data/lib/finch_api/request_options.rb +4 -0
  24. data/lib/finch_api/version.rb +1 -1
  25. data/lib/finch_api.rb +2 -0
  26. data/rbi/finch_api/internal/transport/base_client.rbi +31 -16
  27. data/rbi/finch_api/internal/transport/pooled_net_requester.rbi +10 -5
  28. data/rbi/finch_api/internal/type/base_model.rbi +33 -15
  29. data/rbi/finch_api/internal/type/base_page.rbi +1 -2
  30. data/rbi/finch_api/internal/type/converter.rbi +2 -0
  31. data/rbi/finch_api/internal/type/enum.rbi +1 -0
  32. data/rbi/finch_api/internal/type/union.rbi +1 -0
  33. data/rbi/finch_api/internal/util.rbi +28 -5
  34. data/rbi/finch_api/internal.rbi +2 -0
  35. data/rbi/finch_api/models/access_token_create_params.rbi +4 -1
  36. data/rbi/finch_api/models/account_disconnect_params.rbi +4 -1
  37. data/rbi/finch_api/models/account_introspect_params.rbi +4 -1
  38. data/rbi/finch_api/models/account_update_event.rbi +156 -34
  39. data/rbi/finch_api/models/base_webhook_event.rbi +4 -1
  40. data/rbi/finch_api/models/company_event.rbi +4 -1
  41. data/rbi/finch_api/models/connect/session_new_params.rbi +12 -2
  42. data/rbi/finch_api/models/connect/session_new_response.rbi +6 -1
  43. data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +6 -1
  44. data/rbi/finch_api/models/connect/session_reauthenticate_response.rbi +6 -1
  45. data/rbi/finch_api/models/create_access_token_response.rbi +7 -1
  46. data/rbi/finch_api/models/directory_event.rbi +7 -2
  47. data/rbi/finch_api/models/disconnect_response.rbi +4 -1
  48. data/rbi/finch_api/models/employment_event.rbi +7 -2
  49. data/rbi/finch_api/models/hris/benefit_contribution.rbi +6 -1
  50. data/rbi/finch_api/models/hris/benefit_create_params.rbi +18 -3
  51. data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +12 -2
  52. data/rbi/finch_api/models/hris/benefit_list_params.rbi +6 -1
  53. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +6 -1
  54. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +6 -1
  55. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +6 -1
  56. data/rbi/finch_api/models/hris/benefit_update_params.rbi +6 -1
  57. data/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi +6 -1
  58. data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +12 -2
  59. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +26 -5
  60. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +6 -1
  61. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi +6 -1
  62. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +6 -1
  63. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +6 -1
  64. data/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi +6 -1
  65. data/rbi/finch_api/models/hris/benefits_support.rbi +3 -1
  66. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +18 -3
  67. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +18 -3
  68. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +6 -1
  69. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +18 -3
  70. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +6 -1
  71. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +18 -3
  72. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +6 -1
  73. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +18 -3
  74. data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +6 -1
  75. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +12 -2
  76. data/rbi/finch_api/models/hris/company.rbi +27 -5
  77. data/rbi/finch_api/models/hris/company_benefit.rbi +15 -3
  78. data/rbi/finch_api/models/hris/company_retrieve_params.rbi +6 -1
  79. data/rbi/finch_api/models/hris/create_company_benefits_response.rbi +6 -1
  80. data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +6 -1
  81. data/rbi/finch_api/models/hris/directory_list_params.rbi +6 -1
  82. data/rbi/finch_api/models/hris/document_list_params.rbi +6 -1
  83. data/rbi/finch_api/models/hris/document_list_response.rbi +6 -1
  84. data/rbi/finch_api/models/hris/document_response.rbi +3 -1
  85. data/rbi/finch_api/models/hris/document_retreive_params.rbi +6 -1
  86. data/rbi/finch_api/models/hris/employment_data.rbi +48 -17
  87. data/rbi/finch_api/models/hris/employment_data_response.rbi +6 -1
  88. data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +12 -2
  89. data/rbi/finch_api/models/hris/individual.rbi +24 -4
  90. data/rbi/finch_api/models/hris/individual_in_directory.rbi +18 -3
  91. data/rbi/finch_api/models/hris/individual_response.rbi +6 -1
  92. data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +18 -3
  93. data/rbi/finch_api/models/hris/pay_statement.rbi +80 -13
  94. data/rbi/finch_api/models/hris/pay_statement_response.rbi +6 -1
  95. data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +6 -1
  96. data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +12 -2
  97. data/rbi/finch_api/models/hris/payment.rbi +9 -2
  98. data/rbi/finch_api/models/hris/payment_list_params.rbi +6 -1
  99. data/rbi/finch_api/models/hris/support_per_benefit_type.rbi +6 -1
  100. data/rbi/finch_api/models/hris/supported_benefit.rbi +3 -1
  101. data/rbi/finch_api/models/hris/update_company_benefit_response.rbi +6 -1
  102. data/rbi/finch_api/models/hris/w42005.rbi +6 -2
  103. data/rbi/finch_api/models/hris/w42020.rbi +6 -2
  104. data/rbi/finch_api/models/income.rbi +2 -1
  105. data/rbi/finch_api/models/individual_event.rbi +7 -2
  106. data/rbi/finch_api/models/introspection.rbi +22 -4
  107. data/rbi/finch_api/models/job_completion_event.rbi +10 -2
  108. data/rbi/finch_api/models/jobs/automated_async_job.rbi +12 -2
  109. data/rbi/finch_api/models/jobs/automated_create_params.rbi +12 -2
  110. data/rbi/finch_api/models/jobs/automated_create_response.rbi +6 -1
  111. data/rbi/finch_api/models/jobs/automated_list_params.rbi +6 -1
  112. data/rbi/finch_api/models/jobs/automated_list_response.rbi +24 -4
  113. data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +6 -1
  114. data/rbi/finch_api/models/jobs/manual_async_job.rbi +3 -1
  115. data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +6 -1
  116. data/rbi/finch_api/models/location.rbi +2 -1
  117. data/rbi/finch_api/models/money.rbi +2 -1
  118. data/rbi/finch_api/models/operation_support_matrix.rbi +4 -1
  119. data/rbi/finch_api/models/paging.rbi +2 -1
  120. data/rbi/finch_api/models/pay_statement_event.rbi +10 -2
  121. data/rbi/finch_api/models/payment_event.rbi +7 -2
  122. data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +6 -1
  123. data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +6 -1
  124. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +6 -1
  125. data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +6 -1
  126. data/rbi/finch_api/models/provider.rbi +182 -33
  127. data/rbi/finch_api/models/provider_list_params.rbi +4 -1
  128. data/rbi/finch_api/models/request_forwarding_forward_params.rbi +7 -1
  129. data/rbi/finch_api/models/request_forwarding_forward_response.rbi +13 -2
  130. data/rbi/finch_api/models/sandbox/company_update_params.rbi +30 -5
  131. data/rbi/finch_api/models/sandbox/company_update_response.rbi +30 -5
  132. data/rbi/finch_api/models/sandbox/connection_create_params.rbi +6 -1
  133. data/rbi/finch_api/models/sandbox/connection_create_response.rbi +6 -1
  134. data/rbi/finch_api/models/sandbox/connections/account_create_params.rbi +6 -1
  135. data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +6 -1
  136. data/rbi/finch_api/models/sandbox/connections/account_update_params.rbi +6 -1
  137. data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +6 -1
  138. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +48 -8
  139. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +30 -5
  140. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +30 -5
  141. data/rbi/finch_api/models/sandbox/individual_update_params.rbi +18 -3
  142. data/rbi/finch_api/models/sandbox/individual_update_response.rbi +18 -3
  143. data/rbi/finch_api/models/sandbox/job_create_params.rbi +6 -1
  144. data/rbi/finch_api/models/sandbox/job_create_response.rbi +6 -1
  145. data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi +6 -1
  146. data/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi +6 -1
  147. data/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi +6 -1
  148. data/rbi/finch_api/models/sandbox/payment_create_params.rbi +81 -14
  149. data/rbi/finch_api/models/sandbox/payment_create_response.rbi +6 -1
  150. data/rbi/finch_api/request_options.rbi +4 -1
  151. data/sig/finch_api/internal/single_page.rbs +1 -1
  152. data/sig/finch_api/internal/transport/base_client.rbs +16 -1
  153. data/sig/finch_api/internal/transport/pooled_net_requester.rbs +4 -0
  154. data/sig/finch_api/internal/type/base_model.rbs +11 -5
  155. data/sig/finch_api/internal/type/base_page.rbs +1 -1
  156. data/sig/finch_api/internal/type/converter.rbs +2 -0
  157. data/sig/finch_api/internal/type/enum.rbs +1 -0
  158. data/sig/finch_api/internal/type/union.rbs +1 -0
  159. data/sig/finch_api/internal/util.rbs +13 -0
  160. data/sig/finch_api/internal.rbs +2 -0
  161. data/sig/finch_api/models/hris/employment_data.rbs +6 -6
  162. data/sig/finch_api/models/hris/pay_statement.rbs +2 -1
  163. data/sig/finch_api/models/sandbox/payment_create_params.rbs +2 -1
  164. metadata +2 -2
@@ -3,7 +3,8 @@
3
3
  module FinchAPI
4
4
  module Models
5
5
  class Location < FinchAPI::Internal::Type::BaseModel
6
- OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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 { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
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) }
@@ -3,7 +3,8 @@
3
3
  module FinchAPI
4
4
  module Models
5
5
  class Provider < FinchAPI::Internal::Type::BaseModel
6
- OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
6
+ OrHash =
7
+ T.type_alias { T.any(FinchAPI::Provider, FinchAPI::Internal::AnyHash) }
7
8
 
8
9
  # The id of the payroll provider used in Connect.
9
10
  sig { returns(T.nilable(String)) }
@@ -147,7 +148,12 @@ module FinchAPI
147
148
 
148
149
  class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
149
150
  OrHash =
150
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
151
+ T.type_alias do
152
+ T.any(
153
+ FinchAPI::Provider::AuthenticationMethod,
154
+ FinchAPI::Internal::AnyHash
155
+ )
156
+ end
151
157
 
152
158
  # Each benefit type and their supported features. If the benefit type is not
153
159
  # supported, the property will be null
@@ -235,7 +241,12 @@ module FinchAPI
235
241
 
236
242
  class SupportedFields < FinchAPI::Internal::Type::BaseModel
237
243
  OrHash =
238
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
244
+ T.type_alias do
245
+ T.any(
246
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields,
247
+ FinchAPI::Internal::AnyHash
248
+ )
249
+ end
239
250
 
240
251
  sig do
241
252
  returns(
@@ -411,7 +422,12 @@ module FinchAPI
411
422
 
412
423
  class Company < FinchAPI::Internal::Type::BaseModel
413
424
  OrHash =
414
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
425
+ T.type_alias do
426
+ T.any(
427
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company,
428
+ FinchAPI::Internal::AnyHash
429
+ )
430
+ end
415
431
 
416
432
  sig { returns(T.nilable(T::Boolean)) }
417
433
  attr_reader :id
@@ -565,7 +581,12 @@ module FinchAPI
565
581
 
566
582
  class Accounts < FinchAPI::Internal::Type::BaseModel
567
583
  OrHash =
568
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
584
+ T.type_alias do
585
+ T.any(
586
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts,
587
+ FinchAPI::Internal::AnyHash
588
+ )
589
+ end
569
590
 
570
591
  sig { returns(T.nilable(T::Boolean)) }
571
592
  attr_reader :account_name
@@ -632,7 +653,12 @@ module FinchAPI
632
653
 
633
654
  class Departments < FinchAPI::Internal::Type::BaseModel
634
655
  OrHash =
635
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
656
+ T.type_alias do
657
+ T.any(
658
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments,
659
+ FinchAPI::Internal::AnyHash
660
+ )
661
+ end
636
662
 
637
663
  sig { returns(T.nilable(T::Boolean)) }
638
664
  attr_reader :name
@@ -682,7 +708,10 @@ module FinchAPI
682
708
  class Parent < FinchAPI::Internal::Type::BaseModel
683
709
  OrHash =
684
710
  T.type_alias do
685
- T.any(T.self_type, FinchAPI::Internal::AnyHash)
711
+ T.any(
712
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent,
713
+ FinchAPI::Internal::AnyHash
714
+ )
686
715
  end
687
716
 
688
717
  sig { returns(T.nilable(T::Boolean)) }
@@ -703,7 +732,12 @@ module FinchAPI
703
732
 
704
733
  class Entity < FinchAPI::Internal::Type::BaseModel
705
734
  OrHash =
706
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
735
+ T.type_alias do
736
+ T.any(
737
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity,
738
+ FinchAPI::Internal::AnyHash
739
+ )
740
+ end
707
741
 
708
742
  sig { returns(T.nilable(T::Boolean)) }
709
743
  attr_reader :subtype
@@ -734,7 +768,12 @@ module FinchAPI
734
768
 
735
769
  class Locations < FinchAPI::Internal::Type::BaseModel
736
770
  OrHash =
737
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
771
+ T.type_alias do
772
+ T.any(
773
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations,
774
+ FinchAPI::Internal::AnyHash
775
+ )
776
+ end
738
777
 
739
778
  sig { returns(T.nilable(T::Boolean)) }
740
779
  attr_reader :city
@@ -811,7 +850,12 @@ module FinchAPI
811
850
 
812
851
  class Directory < FinchAPI::Internal::Type::BaseModel
813
852
  OrHash =
814
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
853
+ T.type_alias do
854
+ T.any(
855
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory,
856
+ FinchAPI::Internal::AnyHash
857
+ )
858
+ end
815
859
 
816
860
  sig do
817
861
  returns(
@@ -873,7 +917,12 @@ module FinchAPI
873
917
 
874
918
  class Individuals < FinchAPI::Internal::Type::BaseModel
875
919
  OrHash =
876
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
920
+ T.type_alias do
921
+ T.any(
922
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals,
923
+ FinchAPI::Internal::AnyHash
924
+ )
925
+ end
877
926
 
878
927
  sig { returns(T.nilable(T::Boolean)) }
879
928
  attr_reader :id
@@ -971,7 +1020,10 @@ module FinchAPI
971
1020
  class Manager < FinchAPI::Internal::Type::BaseModel
972
1021
  OrHash =
973
1022
  T.type_alias do
974
- T.any(T.self_type, FinchAPI::Internal::AnyHash)
1023
+ T.any(
1024
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager,
1025
+ FinchAPI::Internal::AnyHash
1026
+ )
975
1027
  end
976
1028
 
977
1029
  sig { returns(T.nilable(T::Boolean)) }
@@ -992,7 +1044,12 @@ module FinchAPI
992
1044
 
993
1045
  class Paging < FinchAPI::Internal::Type::BaseModel
994
1046
  OrHash =
995
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1047
+ T.type_alias do
1048
+ T.any(
1049
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging,
1050
+ FinchAPI::Internal::AnyHash
1051
+ )
1052
+ end
996
1053
 
997
1054
  sig { returns(T.nilable(T::Boolean)) }
998
1055
  attr_reader :count
@@ -1024,7 +1081,12 @@ module FinchAPI
1024
1081
 
1025
1082
  class Employment < FinchAPI::Internal::Type::BaseModel
1026
1083
  OrHash =
1027
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1084
+ T.type_alias do
1085
+ T.any(
1086
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment,
1087
+ FinchAPI::Internal::AnyHash
1088
+ )
1089
+ end
1028
1090
 
1029
1091
  sig { returns(T.nilable(T::Boolean)) }
1030
1092
  attr_reader :id
@@ -1263,7 +1325,12 @@ module FinchAPI
1263
1325
 
1264
1326
  class Department < FinchAPI::Internal::Type::BaseModel
1265
1327
  OrHash =
1266
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1328
+ T.type_alias do
1329
+ T.any(
1330
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department,
1331
+ FinchAPI::Internal::AnyHash
1332
+ )
1333
+ end
1267
1334
 
1268
1335
  sig { returns(T.nilable(T::Boolean)) }
1269
1336
  attr_reader :name
@@ -1282,7 +1349,12 @@ module FinchAPI
1282
1349
 
1283
1350
  class Employment < FinchAPI::Internal::Type::BaseModel
1284
1351
  OrHash =
1285
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1352
+ T.type_alias do
1353
+ T.any(
1354
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment,
1355
+ FinchAPI::Internal::AnyHash
1356
+ )
1357
+ end
1286
1358
 
1287
1359
  sig { returns(T.nilable(T::Boolean)) }
1288
1360
  attr_reader :subtype
@@ -1313,7 +1385,12 @@ module FinchAPI
1313
1385
 
1314
1386
  class Income < FinchAPI::Internal::Type::BaseModel
1315
1387
  OrHash =
1316
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1388
+ T.type_alias do
1389
+ T.any(
1390
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income,
1391
+ FinchAPI::Internal::AnyHash
1392
+ )
1393
+ end
1317
1394
 
1318
1395
  sig { returns(T.nilable(T::Boolean)) }
1319
1396
  attr_reader :amount
@@ -1354,7 +1431,12 @@ module FinchAPI
1354
1431
 
1355
1432
  class Location < FinchAPI::Internal::Type::BaseModel
1356
1433
  OrHash =
1357
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1434
+ T.type_alias do
1435
+ T.any(
1436
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location,
1437
+ FinchAPI::Internal::AnyHash
1438
+ )
1439
+ end
1358
1440
 
1359
1441
  sig { returns(T.nilable(T::Boolean)) }
1360
1442
  attr_reader :city
@@ -1430,7 +1512,12 @@ module FinchAPI
1430
1512
 
1431
1513
  class Manager < FinchAPI::Internal::Type::BaseModel
1432
1514
  OrHash =
1433
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1515
+ T.type_alias do
1516
+ T.any(
1517
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager,
1518
+ FinchAPI::Internal::AnyHash
1519
+ )
1520
+ end
1434
1521
 
1435
1522
  sig { returns(T.nilable(T::Boolean)) }
1436
1523
  attr_reader :id
@@ -1450,7 +1537,12 @@ module FinchAPI
1450
1537
 
1451
1538
  class Individual < FinchAPI::Internal::Type::BaseModel
1452
1539
  OrHash =
1453
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1540
+ T.type_alias do
1541
+ T.any(
1542
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual,
1543
+ FinchAPI::Internal::AnyHash
1544
+ )
1545
+ end
1454
1546
 
1455
1547
  sig { returns(T.nilable(T::Boolean)) }
1456
1548
  attr_reader :id
@@ -1627,7 +1719,12 @@ module FinchAPI
1627
1719
 
1628
1720
  class Emails < FinchAPI::Internal::Type::BaseModel
1629
1721
  OrHash =
1630
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1722
+ T.type_alias do
1723
+ T.any(
1724
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails,
1725
+ FinchAPI::Internal::AnyHash
1726
+ )
1727
+ end
1631
1728
 
1632
1729
  sig { returns(T.nilable(T::Boolean)) }
1633
1730
  attr_reader :data
@@ -1656,7 +1753,12 @@ module FinchAPI
1656
1753
 
1657
1754
  class PhoneNumbers < FinchAPI::Internal::Type::BaseModel
1658
1755
  OrHash =
1659
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1756
+ T.type_alias do
1757
+ T.any(
1758
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers,
1759
+ FinchAPI::Internal::AnyHash
1760
+ )
1761
+ end
1660
1762
 
1661
1763
  sig { returns(T.nilable(T::Boolean)) }
1662
1764
  attr_reader :data
@@ -1685,7 +1787,12 @@ module FinchAPI
1685
1787
 
1686
1788
  class Residence < FinchAPI::Internal::Type::BaseModel
1687
1789
  OrHash =
1688
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1790
+ T.type_alias do
1791
+ T.any(
1792
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence,
1793
+ FinchAPI::Internal::AnyHash
1794
+ )
1795
+ end
1689
1796
 
1690
1797
  sig { returns(T.nilable(T::Boolean)) }
1691
1798
  attr_reader :city
@@ -1762,7 +1869,12 @@ module FinchAPI
1762
1869
 
1763
1870
  class PayGroup < FinchAPI::Internal::Type::BaseModel
1764
1871
  OrHash =
1765
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1872
+ T.type_alias do
1873
+ T.any(
1874
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup,
1875
+ FinchAPI::Internal::AnyHash
1876
+ )
1877
+ end
1766
1878
 
1767
1879
  sig { returns(T.nilable(T::Boolean)) }
1768
1880
  attr_reader :id
@@ -1820,7 +1932,12 @@ module FinchAPI
1820
1932
 
1821
1933
  class PayStatement < FinchAPI::Internal::Type::BaseModel
1822
1934
  OrHash =
1823
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
1935
+ T.type_alias do
1936
+ T.any(
1937
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement,
1938
+ FinchAPI::Internal::AnyHash
1939
+ )
1940
+ end
1824
1941
 
1825
1942
  sig do
1826
1943
  returns(
@@ -1882,7 +1999,12 @@ module FinchAPI
1882
1999
 
1883
2000
  class Paging < FinchAPI::Internal::Type::BaseModel
1884
2001
  OrHash =
1885
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
2002
+ T.type_alias do
2003
+ T.any(
2004
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging,
2005
+ FinchAPI::Internal::AnyHash
2006
+ )
2007
+ end
1886
2008
 
1887
2009
  sig { returns(T::Boolean) }
1888
2010
  attr_accessor :count
@@ -1907,7 +2029,12 @@ module FinchAPI
1907
2029
 
1908
2030
  class PayStatements < FinchAPI::Internal::Type::BaseModel
1909
2031
  OrHash =
1910
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
2032
+ T.type_alias do
2033
+ T.any(
2034
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements,
2035
+ FinchAPI::Internal::AnyHash
2036
+ )
2037
+ end
1911
2038
 
1912
2039
  sig do
1913
2040
  returns(
@@ -2071,7 +2198,10 @@ module FinchAPI
2071
2198
  class Earnings < FinchAPI::Internal::Type::BaseModel
2072
2199
  OrHash =
2073
2200
  T.type_alias do
2074
- T.any(T.self_type, FinchAPI::Internal::AnyHash)
2201
+ T.any(
2202
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings,
2203
+ FinchAPI::Internal::AnyHash
2204
+ )
2075
2205
  end
2076
2206
 
2077
2207
  sig { returns(T.nilable(T::Boolean)) }
@@ -2126,7 +2256,10 @@ module FinchAPI
2126
2256
  class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel
2127
2257
  OrHash =
2128
2258
  T.type_alias do
2129
- T.any(T.self_type, FinchAPI::Internal::AnyHash)
2259
+ T.any(
2260
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions,
2261
+ FinchAPI::Internal::AnyHash
2262
+ )
2130
2263
  end
2131
2264
 
2132
2265
  sig { returns(T.nilable(T::Boolean)) }
@@ -2195,7 +2328,10 @@ module FinchAPI
2195
2328
  class EmployerContributions < FinchAPI::Internal::Type::BaseModel
2196
2329
  OrHash =
2197
2330
  T.type_alias do
2198
- T.any(T.self_type, FinchAPI::Internal::AnyHash)
2331
+ T.any(
2332
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions,
2333
+ FinchAPI::Internal::AnyHash
2334
+ )
2199
2335
  end
2200
2336
 
2201
2337
  sig { returns(T.nilable(T::Boolean)) }
@@ -2242,7 +2378,10 @@ module FinchAPI
2242
2378
  class Taxes < FinchAPI::Internal::Type::BaseModel
2243
2379
  OrHash =
2244
2380
  T.type_alias do
2245
- T.any(T.self_type, FinchAPI::Internal::AnyHash)
2381
+ T.any(
2382
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes,
2383
+ FinchAPI::Internal::AnyHash
2384
+ )
2246
2385
  end
2247
2386
 
2248
2387
  sig { returns(T.nilable(T::Boolean)) }
@@ -2312,7 +2451,12 @@ module FinchAPI
2312
2451
 
2313
2452
  class Payment < FinchAPI::Internal::Type::BaseModel
2314
2453
  OrHash =
2315
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
2454
+ T.type_alias do
2455
+ T.any(
2456
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment,
2457
+ FinchAPI::Internal::AnyHash
2458
+ )
2459
+ end
2316
2460
 
2317
2461
  sig { returns(T.nilable(T::Boolean)) }
2318
2462
  attr_reader :id
@@ -2454,7 +2598,12 @@ module FinchAPI
2454
2598
 
2455
2599
  class PayPeriod < FinchAPI::Internal::Type::BaseModel
2456
2600
  OrHash =
2457
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
2601
+ T.type_alias do
2602
+ T.any(
2603
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod,
2604
+ FinchAPI::Internal::AnyHash
2605
+ )
2606
+ end
2458
2607
 
2459
2608
  sig { returns(T.nilable(T::Boolean)) }
2460
2609
  attr_reader :end_date
@@ -6,7 +6,10 @@ module FinchAPI
6
6
  extend FinchAPI::Internal::Type::RequestParameters::Converter
7
7
  include FinchAPI::Internal::Type::RequestParameters
8
8
 
9
- OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(FinchAPI::ProviderListParams, FinchAPI::Internal::AnyHash)
12
+ end
10
13
 
11
14
  sig do
12
15
  params(request_options: FinchAPI::RequestOptions::OrHash).returns(
@@ -6,7 +6,13 @@ module FinchAPI
6
6
  extend FinchAPI::Internal::Type::RequestParameters::Converter
7
7
  include FinchAPI::Internal::Type::RequestParameters
8
8
 
9
- OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ FinchAPI::RequestForwardingForwardParams,
13
+ FinchAPI::Internal::AnyHash
14
+ )
15
+ end
10
16
 
11
17
  # The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
12
18
  # , `PUT` , `DELETE` , and `PATCH`.
@@ -3,7 +3,13 @@
3
3
  module FinchAPI
4
4
  module Models
5
5
  class RequestForwardingForwardResponse < FinchAPI::Internal::Type::BaseModel
6
- OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(
9
+ FinchAPI::Models::RequestForwardingForwardResponse,
10
+ FinchAPI::Internal::AnyHash
11
+ )
12
+ end
7
13
 
8
14
  # A string representation of the HTTP response body of the forwarded request’s
9
15
  # response received from the underlying integration’s API. This field may be null
@@ -78,7 +84,12 @@ module FinchAPI
78
84
 
79
85
  class Request < FinchAPI::Internal::Type::BaseModel
80
86
  OrHash =
81
- T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
87
+ T.type_alias do
88
+ T.any(
89
+ FinchAPI::Models::RequestForwardingForwardResponse::Request,
90
+ FinchAPI::Internal::AnyHash
91
+ )
92
+ end
82
93
 
83
94
  # The body that was specified for the forwarded request. If a value was not
84
95
  # specified in the original request, this value will be returned as null ;