finch-api 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.31

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 (205) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +40 -0
  3. data/README.md +1 -1
  4. data/lib/finch_api/errors.rb +25 -11
  5. data/lib/finch_api/file_part.rb +10 -7
  6. data/lib/finch_api/internal/individuals_page.rb +1 -1
  7. data/lib/finch_api/internal/page.rb +1 -1
  8. data/lib/finch_api/internal/responses_page.rb +1 -1
  9. data/lib/finch_api/internal/single_page.rb +1 -1
  10. data/lib/finch_api/internal/transport/base_client.rb +11 -7
  11. data/lib/finch_api/internal/transport/pooled_net_requester.rb +34 -31
  12. data/lib/finch_api/internal/type/base_page.rb +1 -1
  13. data/lib/finch_api/internal/type/file_input.rb +7 -4
  14. data/lib/finch_api/internal/util.rb +8 -7
  15. data/lib/finch_api/models/connect/session_new_params.rb +66 -50
  16. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +10 -10
  17. data/lib/finch_api/models/create_access_token_response.rb +9 -1
  18. data/lib/finch_api/models/hris/benefit_contribution.rb +124 -29
  19. data/lib/finch_api/models/hris/benefit_create_params.rb +9 -1
  20. data/lib/finch_api/models/hris/benefit_list_params.rb +9 -1
  21. data/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb +9 -1
  22. data/lib/finch_api/models/hris/benefit_retrieve_params.rb +9 -1
  23. data/lib/finch_api/models/hris/benefit_update_params.rb +9 -1
  24. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +222 -6
  25. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +40 -2
  26. data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +9 -1
  27. data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +9 -1
  28. data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +9 -1
  29. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +9 -1
  30. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +9 -1
  31. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_params.rb +9 -1
  32. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +10 -1
  33. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +9 -1
  34. data/lib/finch_api/models/hris/company_retrieve_params.rb +9 -1
  35. data/lib/finch_api/models/hris/directory_list_individuals_params.rb +9 -1
  36. data/lib/finch_api/models/hris/directory_list_params.rb +9 -1
  37. data/lib/finch_api/models/hris/document_list_params.rb +9 -1
  38. data/lib/finch_api/models/hris/document_response.rb +11 -11
  39. data/lib/finch_api/models/hris/document_retreive_params.rb +9 -1
  40. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +9 -1
  41. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +11 -1
  42. data/lib/finch_api/models/hris/pay_statement.rb +11 -15
  43. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +9 -1
  44. data/lib/finch_api/models/hris/payment_list_params.rb +9 -1
  45. data/lib/finch_api/models/hris/supported_benefit.rb +1 -0
  46. data/lib/finch_api/models/hris/w42005.rb +20 -20
  47. data/lib/finch_api/models/hris/w42020.rb +30 -30
  48. data/lib/finch_api/models/introspection.rb +38 -23
  49. data/lib/finch_api/models/jobs/automated_list_params.rb +1 -14
  50. data/lib/finch_api/models/jobs/automated_retrieve_params.rb +1 -14
  51. data/lib/finch_api/models/jobs/manual_retrieve_params.rb +1 -14
  52. data/lib/finch_api/models/payroll/pay_group_list_params.rb +11 -1
  53. data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +9 -1
  54. data/lib/finch_api/models/provider.rb +42 -1092
  55. data/lib/finch_api/models/provider_list_response.rb +143 -0
  56. data/lib/finch_api/models/request_forwarding_forward_params.rb +10 -6
  57. data/lib/finch_api/models/request_forwarding_forward_response.rb +69 -48
  58. data/lib/finch_api/resources/connect/sessions.rb +12 -12
  59. data/lib/finch_api/resources/hris/benefits/individuals.rb +24 -10
  60. data/lib/finch_api/resources/hris/benefits.rb +37 -16
  61. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +38 -15
  62. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +3 -1
  63. data/lib/finch_api/resources/hris/company.rb +6 -2
  64. data/lib/finch_api/resources/hris/directory.rb +3 -1
  65. data/lib/finch_api/resources/hris/documents.rb +9 -3
  66. data/lib/finch_api/resources/hris/employments.rb +7 -3
  67. data/lib/finch_api/resources/hris/individuals.rb +10 -4
  68. data/lib/finch_api/resources/hris/pay_statements.rb +7 -3
  69. data/lib/finch_api/resources/hris/payments.rb +3 -1
  70. data/lib/finch_api/resources/jobs/automated.rb +3 -16
  71. data/lib/finch_api/resources/jobs/manual.rb +2 -10
  72. data/lib/finch_api/resources/payroll/pay_groups.rb +12 -3
  73. data/lib/finch_api/resources/providers.rb +2 -2
  74. data/lib/finch_api/resources/request_forwarding.rb +2 -2
  75. data/lib/finch_api/version.rb +1 -1
  76. data/lib/finch_api.rb +1 -0
  77. data/rbi/finch_api/errors.rbi +29 -2
  78. data/rbi/finch_api/file_part.rbi +1 -1
  79. data/rbi/finch_api/internal/transport/base_client.rbi +4 -5
  80. data/rbi/finch_api/internal/type/base_page.rbi +1 -1
  81. data/rbi/finch_api/internal/util.rbi +1 -1
  82. data/rbi/finch_api/models/connect/session_new_params.rbi +124 -98
  83. data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +23 -23
  84. data/rbi/finch_api/models/create_access_token_response.rbi +8 -0
  85. data/rbi/finch_api/models/hris/benefit_contribution.rbi +270 -52
  86. data/rbi/finch_api/models/hris/benefit_create_params.rbi +11 -0
  87. data/rbi/finch_api/models/hris/benefit_list_params.rbi +24 -5
  88. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +24 -5
  89. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +24 -5
  90. data/rbi/finch_api/models/hris/benefit_update_params.rbi +15 -1
  91. data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +515 -20
  92. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +87 -0
  93. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +22 -5
  94. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +11 -0
  95. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +11 -0
  96. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +11 -0
  97. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +22 -5
  98. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +22 -5
  99. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +15 -1
  100. data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +11 -0
  101. data/rbi/finch_api/models/hris/company_retrieve_params.rbi +24 -5
  102. data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +11 -0
  103. data/rbi/finch_api/models/hris/directory_list_params.rbi +11 -0
  104. data/rbi/finch_api/models/hris/document_list_params.rbi +11 -0
  105. data/rbi/finch_api/models/hris/document_response.rbi +14 -29
  106. data/rbi/finch_api/models/hris/document_retreive_params.rbi +24 -5
  107. data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +11 -0
  108. data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +16 -1
  109. data/rbi/finch_api/models/hris/pay_statement.rbi +9 -34
  110. data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +11 -0
  111. data/rbi/finch_api/models/hris/payment_list_params.rbi +11 -0
  112. data/rbi/finch_api/models/hris/supported_benefit.rbi +5 -0
  113. data/rbi/finch_api/models/hris/w42005.rbi +28 -38
  114. data/rbi/finch_api/models/hris/w42020.rbi +37 -43
  115. data/rbi/finch_api/models/introspection.rbi +57 -33
  116. data/rbi/finch_api/models/jobs/automated_list_params.rbi +0 -15
  117. data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +5 -25
  118. data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +5 -25
  119. data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +11 -0
  120. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +24 -5
  121. data/rbi/finch_api/models/provider.rbi +75 -2507
  122. data/rbi/finch_api/models/provider_list_response.rbi +280 -0
  123. data/rbi/finch_api/models/request_forwarding_forward_params.rbi +6 -6
  124. data/rbi/finch_api/models/request_forwarding_forward_response.rbi +93 -60
  125. data/rbi/finch_api/resources/connect/sessions.rbi +22 -14
  126. data/rbi/finch_api/resources/hris/benefits/individuals.rbi +20 -3
  127. data/rbi/finch_api/resources/hris/benefits.rbi +39 -12
  128. data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +35 -8
  129. data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +3 -0
  130. data/rbi/finch_api/resources/hris/company.rbi +9 -4
  131. data/rbi/finch_api/resources/hris/directory.rbi +3 -0
  132. data/rbi/finch_api/resources/hris/documents.rbi +6 -0
  133. data/rbi/finch_api/resources/hris/employments.rbi +4 -1
  134. data/rbi/finch_api/resources/hris/individuals.rbi +10 -1
  135. data/rbi/finch_api/resources/hris/pay_statements.rbi +4 -1
  136. data/rbi/finch_api/resources/hris/payments.rbi +3 -0
  137. data/rbi/finch_api/resources/jobs/automated.rbi +1 -14
  138. data/rbi/finch_api/resources/jobs/manual.rbi +1 -9
  139. data/rbi/finch_api/resources/payroll/pay_groups.rbi +15 -2
  140. data/rbi/finch_api/resources/providers.rbi +1 -1
  141. data/rbi/finch_api/resources/request_forwarding.rbi +2 -2
  142. data/sig/finch_api/errors.rbs +7 -0
  143. data/sig/finch_api/file_part.rbs +1 -1
  144. data/sig/finch_api/models/connect/session_new_params.rbs +45 -45
  145. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +15 -15
  146. data/sig/finch_api/models/create_access_token_response.rbs +5 -0
  147. data/sig/finch_api/models/hris/benefit_contribution.rbs +107 -21
  148. data/sig/finch_api/models/hris/benefit_create_params.rbs +7 -0
  149. data/sig/finch_api/models/hris/benefit_list_params.rbs +14 -3
  150. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +14 -3
  151. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +14 -3
  152. data/sig/finch_api/models/hris/benefit_update_params.rbs +8 -1
  153. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +201 -8
  154. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +30 -1
  155. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +14 -3
  156. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +7 -1
  157. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +7 -1
  158. data/sig/finch_api/models/hris/benfit_contribution.rbs +1 -1
  159. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +7 -0
  160. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +14 -3
  161. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +14 -3
  162. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +7 -1
  163. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +7 -0
  164. data/sig/finch_api/models/hris/company_retrieve_params.rbs +14 -3
  165. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +7 -1
  166. data/sig/finch_api/models/hris/directory_list_params.rbs +7 -1
  167. data/sig/finch_api/models/hris/document_list_params.rbs +7 -0
  168. data/sig/finch_api/models/hris/document_response.rbs +11 -19
  169. data/sig/finch_api/models/hris/document_retreive_params.rbs +14 -3
  170. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +8 -1
  171. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +7 -0
  172. data/sig/finch_api/models/hris/pay_statement.rbs +12 -12
  173. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +8 -1
  174. data/sig/finch_api/models/hris/payment_list_params.rbs +7 -1
  175. data/sig/finch_api/models/hris/supported_benefit.rbs +2 -1
  176. data/sig/finch_api/models/hris/w42005.rbs +23 -37
  177. data/sig/finch_api/models/hris/w42020.rbs +35 -45
  178. data/sig/finch_api/models/introspection.rbs +29 -20
  179. data/sig/finch_api/models/jobs/automated_list_params.rbs +1 -7
  180. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +3 -13
  181. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +3 -13
  182. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +11 -1
  183. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +14 -3
  184. data/sig/finch_api/models/provider.rbs +31 -1366
  185. data/sig/finch_api/models/provider_list_response.rbs +128 -0
  186. data/sig/finch_api/models/request_forwarding_forward_params.rbs +8 -8
  187. data/sig/finch_api/models/request_forwarding_forward_response.rbs +40 -30
  188. data/sig/finch_api/resources/connect/sessions.rbs +9 -9
  189. data/sig/finch_api/resources/hris/benefits/individuals.rbs +4 -0
  190. data/sig/finch_api/resources/hris/benefits.rbs +5 -0
  191. data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +4 -0
  192. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -0
  193. data/sig/finch_api/resources/hris/company.rbs +1 -0
  194. data/sig/finch_api/resources/hris/directory.rbs +1 -0
  195. data/sig/finch_api/resources/hris/documents.rbs +2 -0
  196. data/sig/finch_api/resources/hris/employments.rbs +1 -0
  197. data/sig/finch_api/resources/hris/individuals.rbs +1 -0
  198. data/sig/finch_api/resources/hris/pay_statements.rbs +1 -0
  199. data/sig/finch_api/resources/hris/payments.rbs +1 -0
  200. data/sig/finch_api/resources/jobs/automated.rbs +0 -2
  201. data/sig/finch_api/resources/jobs/manual.rbs +0 -1
  202. data/sig/finch_api/resources/payroll/pay_groups.rbs +2 -0
  203. data/sig/finch_api/resources/providers.rbs +1 -1
  204. data/sig/finch_api/resources/request_forwarding.rbs +2 -2
  205. metadata +5 -2
@@ -7,13 +7,18 @@ module FinchAPI
7
7
  T.type_alias { T.any(FinchAPI::Provider, FinchAPI::Internal::AnyHash) }
8
8
 
9
9
  # The id of the payroll provider used in Connect.
10
- sig { returns(T.nilable(String)) }
11
- attr_reader :id
10
+ sig { returns(String) }
11
+ attr_accessor :id
12
+
13
+ # The display name of the payroll provider.
14
+ sig { returns(String) }
15
+ attr_accessor :display_name
12
16
 
13
- sig { params(id: String).void }
14
- attr_writer :id
17
+ # The list of Finch products supported on this payroll provider.
18
+ sig { returns(T::Array[String]) }
19
+ attr_accessor :products
15
20
 
16
- # The list of authentication methods supported by the provider.
21
+ # The authentication methods supported by the provider.
17
22
  sig do
18
23
  returns(T.nilable(T::Array[FinchAPI::Provider::AuthenticationMethod]))
19
24
  end
@@ -34,13 +39,6 @@ module FinchAPI
34
39
  sig { params(beta: T::Boolean).void }
35
40
  attr_writer :beta
36
41
 
37
- # The display name of the payroll provider.
38
- sig { returns(T.nilable(String)) }
39
- attr_reader :display_name
40
-
41
- sig { params(display_name: String).void }
42
- attr_writer :display_name
43
-
44
42
  # The url to the official icon of the payroll provider.
45
43
  sig { returns(T.nilable(String)) }
46
44
  attr_reader :icon
@@ -78,37 +76,32 @@ module FinchAPI
78
76
  sig { params(primary_color: String).void }
79
77
  attr_writer :primary_color
80
78
 
81
- # The list of Finch products supported on this payroll provider.
82
- sig { returns(T.nilable(T::Array[String])) }
83
- attr_reader :products
84
-
85
- sig { params(products: T::Array[String]).void }
86
- attr_writer :products
87
-
88
79
  sig do
89
80
  params(
90
81
  id: String,
82
+ display_name: String,
83
+ products: T::Array[String],
91
84
  authentication_methods:
92
85
  T::Array[FinchAPI::Provider::AuthenticationMethod::OrHash],
93
86
  beta: T::Boolean,
94
- display_name: String,
95
87
  icon: String,
96
88
  logo: String,
97
89
  manual: T::Boolean,
98
90
  mfa_required: T::Boolean,
99
- primary_color: String,
100
- products: T::Array[String]
91
+ primary_color: String
101
92
  ).returns(T.attached_class)
102
93
  end
103
94
  def self.new(
104
95
  # The id of the payroll provider used in Connect.
105
- id: nil,
106
- # The list of authentication methods supported by the provider.
96
+ id:,
97
+ # The display name of the payroll provider.
98
+ display_name:,
99
+ # The list of Finch products supported on this payroll provider.
100
+ products:,
101
+ # The authentication methods supported by the provider.
107
102
  authentication_methods: nil,
108
103
  # `true` if the integration is in a beta state, `false` otherwise
109
104
  beta: nil,
110
- # The display name of the payroll provider.
111
- display_name: nil,
112
105
  # The url to the official icon of the payroll provider.
113
106
  icon: nil,
114
107
  # The url to the official logo of the payroll provider.
@@ -120,9 +113,7 @@ module FinchAPI
120
113
  # whether MFA is required for the provider.
121
114
  mfa_required: nil,
122
115
  # The hex code for the primary color of the payroll provider.
123
- primary_color: nil,
124
- # The list of Finch products supported on this payroll provider.
125
- products: nil
116
+ primary_color: nil
126
117
  )
127
118
  end
128
119
 
@@ -130,16 +121,16 @@ module FinchAPI
130
121
  override.returns(
131
122
  {
132
123
  id: String,
124
+ display_name: String,
125
+ products: T::Array[String],
133
126
  authentication_methods:
134
127
  T::Array[FinchAPI::Provider::AuthenticationMethod],
135
128
  beta: T::Boolean,
136
- display_name: String,
137
129
  icon: String,
138
130
  logo: String,
139
131
  manual: T::Boolean,
140
132
  mfa_required: T::Boolean,
141
- primary_color: String,
142
- products: T::Array[String]
133
+ primary_color: String
143
134
  }
144
135
  )
145
136
  end
@@ -155,2520 +146,97 @@ module FinchAPI
155
146
  )
156
147
  end
157
148
 
158
- # Each benefit type and their supported features. If the benefit type is not
159
- # supported, the property will be null
160
- sig { returns(T.nilable(FinchAPI::HRIS::BenefitsSupport)) }
149
+ # The type of authentication method
150
+ sig do
151
+ returns(FinchAPI::Provider::AuthenticationMethod::Type::OrSymbol)
152
+ end
153
+ attr_accessor :type
154
+
155
+ # The supported benefit types and their configurations
156
+ sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
161
157
  attr_reader :benefits_support
162
158
 
163
159
  sig do
164
- params(
165
- benefits_support: T.nilable(FinchAPI::HRIS::BenefitsSupport::OrHash)
166
- ).void
160
+ params(benefits_support: T::Hash[Symbol, T.nilable(T.anything)]).void
167
161
  end
168
162
  attr_writer :benefits_support
169
163
 
170
- # The supported data fields returned by our HR and payroll endpoints
171
- sig do
172
- returns(
173
- T.nilable(FinchAPI::Provider::AuthenticationMethod::SupportedFields)
174
- )
175
- end
164
+ # The supported fields for each Finch product
165
+ sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
176
166
  attr_reader :supported_fields
177
167
 
178
168
  sig do
179
- params(
180
- supported_fields:
181
- T.nilable(
182
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::OrHash
183
- )
184
- ).void
169
+ params(supported_fields: T::Hash[Symbol, T.nilable(T.anything)]).void
185
170
  end
186
171
  attr_writer :supported_fields
187
172
 
188
- # The type of authentication method.
189
- sig do
190
- returns(
191
- T.nilable(
192
- FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
193
- )
194
- )
195
- end
196
- attr_reader :type
197
-
198
- sig do
199
- params(
200
- type: FinchAPI::Provider::AuthenticationMethod::Type::OrSymbol
201
- ).void
202
- end
203
- attr_writer :type
204
-
205
173
  sig do
206
174
  params(
207
- benefits_support:
208
- T.nilable(FinchAPI::HRIS::BenefitsSupport::OrHash),
209
- supported_fields:
210
- T.nilable(
211
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::OrHash
212
- ),
213
- type: FinchAPI::Provider::AuthenticationMethod::Type::OrSymbol
175
+ type: FinchAPI::Provider::AuthenticationMethod::Type::OrSymbol,
176
+ benefits_support: T::Hash[Symbol, T.nilable(T.anything)],
177
+ supported_fields: T::Hash[Symbol, T.nilable(T.anything)]
214
178
  ).returns(T.attached_class)
215
179
  end
216
180
  def self.new(
217
- # Each benefit type and their supported features. If the benefit type is not
218
- # supported, the property will be null
181
+ # The type of authentication method
182
+ type:,
183
+ # The supported benefit types and their configurations
219
184
  benefits_support: nil,
220
- # The supported data fields returned by our HR and payroll endpoints
221
- supported_fields: nil,
222
- # The type of authentication method.
223
- type: nil
185
+ # The supported fields for each Finch product
186
+ supported_fields: nil
224
187
  )
225
188
  end
226
189
 
227
190
  sig do
228
191
  override.returns(
229
192
  {
230
- benefits_support: T.nilable(FinchAPI::HRIS::BenefitsSupport),
231
- supported_fields:
232
- T.nilable(
233
- FinchAPI::Provider::AuthenticationMethod::SupportedFields
234
- ),
235
- type: FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
193
+ type: FinchAPI::Provider::AuthenticationMethod::Type::OrSymbol,
194
+ benefits_support: T::Hash[Symbol, T.nilable(T.anything)],
195
+ supported_fields: T::Hash[Symbol, T.nilable(T.anything)]
236
196
  }
237
197
  )
238
198
  end
239
199
  def to_hash
240
200
  end
241
201
 
242
- class SupportedFields < FinchAPI::Internal::Type::BaseModel
243
- OrHash =
202
+ # The type of authentication method
203
+ module Type
204
+ extend FinchAPI::Internal::Type::Enum
205
+
206
+ TaggedSymbol =
244
207
  T.type_alias do
245
- T.any(
246
- FinchAPI::Provider::AuthenticationMethod::SupportedFields,
247
- FinchAPI::Internal::AnyHash
248
- )
208
+ T.all(Symbol, FinchAPI::Provider::AuthenticationMethod::Type)
249
209
  end
210
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
250
211
 
251
- sig do
252
- returns(
253
- T.nilable(
254
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company
255
- )
256
- )
257
- end
258
- attr_reader :company
259
-
260
- sig do
261
- params(
262
- company:
263
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::OrHash
264
- ).void
265
- end
266
- attr_writer :company
267
-
268
- sig do
269
- returns(
270
- T.nilable(
271
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory
272
- )
273
- )
274
- end
275
- attr_reader :directory
276
-
277
- sig do
278
- params(
279
- directory:
280
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::OrHash
281
- ).void
282
- end
283
- attr_writer :directory
284
-
285
- sig do
286
- returns(
287
- T.nilable(
288
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment
289
- )
290
- )
291
- end
292
- attr_reader :employment
293
-
294
- sig do
295
- params(
296
- employment:
297
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::OrHash
298
- ).void
299
- end
300
- attr_writer :employment
301
-
302
- sig do
303
- returns(
304
- T.nilable(
305
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual
306
- )
307
- )
308
- end
309
- attr_reader :individual
310
-
311
- sig do
312
- params(
313
- individual:
314
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::OrHash
315
- ).void
316
- end
317
- attr_writer :individual
318
-
319
- sig do
320
- returns(
321
- T.nilable(
322
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup
323
- )
212
+ ASSISTED =
213
+ T.let(
214
+ :assisted,
215
+ FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
324
216
  )
325
- end
326
- attr_reader :pay_group
327
-
328
- sig do
329
- params(
330
- pay_group:
331
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup::OrHash
332
- ).void
333
- end
334
- attr_writer :pay_group
335
-
336
- sig do
337
- returns(
338
- T.nilable(
339
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement
340
- )
217
+ CREDENTIAL =
218
+ T.let(
219
+ :credential,
220
+ FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
341
221
  )
342
- end
343
- attr_reader :pay_statement
344
-
345
- sig do
346
- params(
347
- pay_statement:
348
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::OrHash
349
- ).void
350
- end
351
- attr_writer :pay_statement
352
-
353
- sig do
354
- returns(
355
- T.nilable(
356
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment
357
- )
222
+ API_TOKEN =
223
+ T.let(
224
+ :api_token,
225
+ FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
358
226
  )
359
- end
360
- attr_reader :payment
361
-
362
- sig do
363
- params(
364
- payment:
365
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::OrHash
366
- ).void
367
- end
368
- attr_writer :payment
369
-
370
- # The supported data fields returned by our HR and payroll endpoints
371
- sig do
372
- params(
373
- company:
374
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::OrHash,
375
- directory:
376
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::OrHash,
377
- employment:
378
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::OrHash,
379
- individual:
380
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::OrHash,
381
- pay_group:
382
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup::OrHash,
383
- pay_statement:
384
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::OrHash,
385
- payment:
386
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::OrHash
387
- ).returns(T.attached_class)
388
- end
389
- def self.new(
390
- company: nil,
391
- directory: nil,
392
- employment: nil,
393
- individual: nil,
394
- pay_group: nil,
395
- pay_statement: nil,
396
- payment: nil
397
- )
398
- end
399
-
400
- sig do
401
- override.returns(
402
- {
403
- company:
404
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company,
405
- directory:
406
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory,
407
- employment:
408
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment,
409
- individual:
410
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual,
411
- pay_group:
412
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup,
413
- pay_statement:
414
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement,
415
- payment:
416
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment
417
- }
227
+ API_CREDENTIAL =
228
+ T.let(
229
+ :api_credential,
230
+ FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
418
231
  )
419
- end
420
- def to_hash
421
- end
422
-
423
- class Company < FinchAPI::Internal::Type::BaseModel
424
- OrHash =
425
- T.type_alias do
426
- T.any(
427
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company,
428
- FinchAPI::Internal::AnyHash
429
- )
430
- end
431
-
432
- sig { returns(T.nilable(T::Boolean)) }
433
- attr_reader :id
434
-
435
- sig { params(id: T::Boolean).void }
436
- attr_writer :id
437
-
438
- sig do
439
- returns(
440
- T.nilable(
441
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts
442
- )
443
- )
444
- end
445
- attr_reader :accounts
446
-
447
- sig do
448
- params(
449
- accounts:
450
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts::OrHash
451
- ).void
452
- end
453
- attr_writer :accounts
454
-
455
- sig do
456
- returns(
457
- T.nilable(
458
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments
459
- )
460
- )
461
- end
462
- attr_reader :departments
463
-
464
- sig do
465
- params(
466
- departments:
467
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::OrHash
468
- ).void
469
- end
470
- attr_writer :departments
471
-
472
- sig { returns(T.nilable(T::Boolean)) }
473
- attr_reader :ein
474
-
475
- sig { params(ein: T::Boolean).void }
476
- attr_writer :ein
477
-
478
- sig do
479
- returns(
480
- T.nilable(
481
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity
482
- )
483
- )
484
- end
485
- attr_reader :entity
486
-
487
- sig do
488
- params(
489
- entity:
490
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity::OrHash
491
- ).void
492
- end
493
- attr_writer :entity
494
-
495
- sig { returns(T.nilable(T::Boolean)) }
496
- attr_reader :legal_name
497
-
498
- sig { params(legal_name: T::Boolean).void }
499
- attr_writer :legal_name
500
-
501
- sig do
502
- returns(
503
- T.nilable(
504
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations
505
- )
506
- )
507
- end
508
- attr_reader :locations
509
-
510
- sig do
511
- params(
512
- locations:
513
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations::OrHash
514
- ).void
515
- end
516
- attr_writer :locations
517
-
518
- sig { returns(T.nilable(T::Boolean)) }
519
- attr_reader :primary_email
520
-
521
- sig { params(primary_email: T::Boolean).void }
522
- attr_writer :primary_email
523
-
524
- sig { returns(T.nilable(T::Boolean)) }
525
- attr_reader :primary_phone_number
526
-
527
- sig { params(primary_phone_number: T::Boolean).void }
528
- attr_writer :primary_phone_number
529
-
530
- sig do
531
- params(
532
- id: T::Boolean,
533
- accounts:
534
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts::OrHash,
535
- departments:
536
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::OrHash,
537
- ein: T::Boolean,
538
- entity:
539
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity::OrHash,
540
- legal_name: T::Boolean,
541
- locations:
542
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations::OrHash,
543
- primary_email: T::Boolean,
544
- primary_phone_number: T::Boolean
545
- ).returns(T.attached_class)
546
- end
547
- def self.new(
548
- id: nil,
549
- accounts: nil,
550
- departments: nil,
551
- ein: nil,
552
- entity: nil,
553
- legal_name: nil,
554
- locations: nil,
555
- primary_email: nil,
556
- primary_phone_number: nil
232
+ OAUTH =
233
+ T.let(
234
+ :oauth,
235
+ FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
557
236
  )
558
- end
559
-
560
- sig do
561
- override.returns(
562
- {
563
- id: T::Boolean,
564
- accounts:
565
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts,
566
- departments:
567
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments,
568
- ein: T::Boolean,
569
- entity:
570
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity,
571
- legal_name: T::Boolean,
572
- locations:
573
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations,
574
- primary_email: T::Boolean,
575
- primary_phone_number: T::Boolean
576
- }
577
- )
578
- end
579
- def to_hash
580
- end
581
-
582
- class Accounts < FinchAPI::Internal::Type::BaseModel
583
- OrHash =
584
- T.type_alias do
585
- T.any(
586
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts,
587
- FinchAPI::Internal::AnyHash
588
- )
589
- end
590
-
591
- sig { returns(T.nilable(T::Boolean)) }
592
- attr_reader :account_name
593
-
594
- sig { params(account_name: T::Boolean).void }
595
- attr_writer :account_name
596
-
597
- sig { returns(T.nilable(T::Boolean)) }
598
- attr_reader :account_number
599
-
600
- sig { params(account_number: T::Boolean).void }
601
- attr_writer :account_number
602
-
603
- sig { returns(T.nilable(T::Boolean)) }
604
- attr_reader :account_type
605
-
606
- sig { params(account_type: T::Boolean).void }
607
- attr_writer :account_type
608
-
609
- sig { returns(T.nilable(T::Boolean)) }
610
- attr_reader :institution_name
611
-
612
- sig { params(institution_name: T::Boolean).void }
613
- attr_writer :institution_name
614
-
615
- sig { returns(T.nilable(T::Boolean)) }
616
- attr_reader :routing_number
617
-
618
- sig { params(routing_number: T::Boolean).void }
619
- attr_writer :routing_number
620
-
621
- sig do
622
- params(
623
- account_name: T::Boolean,
624
- account_number: T::Boolean,
625
- account_type: T::Boolean,
626
- institution_name: T::Boolean,
627
- routing_number: T::Boolean
628
- ).returns(T.attached_class)
629
- end
630
- def self.new(
631
- account_name: nil,
632
- account_number: nil,
633
- account_type: nil,
634
- institution_name: nil,
635
- routing_number: nil
636
- )
637
- end
638
-
639
- sig do
640
- override.returns(
641
- {
642
- account_name: T::Boolean,
643
- account_number: T::Boolean,
644
- account_type: T::Boolean,
645
- institution_name: T::Boolean,
646
- routing_number: T::Boolean
647
- }
648
- )
649
- end
650
- def to_hash
651
- end
652
- end
653
-
654
- class Departments < FinchAPI::Internal::Type::BaseModel
655
- OrHash =
656
- T.type_alias do
657
- T.any(
658
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments,
659
- FinchAPI::Internal::AnyHash
660
- )
661
- end
662
-
663
- sig { returns(T.nilable(T::Boolean)) }
664
- attr_reader :name
665
-
666
- sig { params(name: T::Boolean).void }
667
- attr_writer :name
668
-
669
- sig do
670
- returns(
671
- T.nilable(
672
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent
673
- )
674
- )
675
- end
676
- attr_reader :parent
677
-
678
- sig do
679
- params(
680
- parent:
681
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent::OrHash
682
- ).void
683
- end
684
- attr_writer :parent
685
-
686
- sig do
687
- params(
688
- name: T::Boolean,
689
- parent:
690
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent::OrHash
691
- ).returns(T.attached_class)
692
- end
693
- def self.new(name: nil, parent: nil)
694
- end
695
-
696
- sig do
697
- override.returns(
698
- {
699
- name: T::Boolean,
700
- parent:
701
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent
702
- }
703
- )
704
- end
705
- def to_hash
706
- end
707
-
708
- class Parent < FinchAPI::Internal::Type::BaseModel
709
- OrHash =
710
- T.type_alias do
711
- T.any(
712
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent,
713
- FinchAPI::Internal::AnyHash
714
- )
715
- end
716
-
717
- sig { returns(T.nilable(T::Boolean)) }
718
- attr_reader :name
719
-
720
- sig { params(name: T::Boolean).void }
721
- attr_writer :name
722
-
723
- sig { params(name: T::Boolean).returns(T.attached_class) }
724
- def self.new(name: nil)
725
- end
726
-
727
- sig { override.returns({ name: T::Boolean }) }
728
- def to_hash
729
- end
730
- end
731
- end
732
-
733
- class Entity < FinchAPI::Internal::Type::BaseModel
734
- OrHash =
735
- T.type_alias do
736
- T.any(
737
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity,
738
- FinchAPI::Internal::AnyHash
739
- )
740
- end
741
-
742
- sig { returns(T.nilable(T::Boolean)) }
743
- attr_reader :subtype
744
-
745
- sig { params(subtype: T::Boolean).void }
746
- attr_writer :subtype
747
-
748
- sig { returns(T.nilable(T::Boolean)) }
749
- attr_reader :type
750
-
751
- sig { params(type: T::Boolean).void }
752
- attr_writer :type
753
-
754
- sig do
755
- params(subtype: T::Boolean, type: T::Boolean).returns(
756
- T.attached_class
757
- )
758
- end
759
- def self.new(subtype: nil, type: nil)
760
- end
761
-
762
- sig do
763
- override.returns({ subtype: T::Boolean, type: T::Boolean })
764
- end
765
- def to_hash
766
- end
767
- end
768
-
769
- class Locations < FinchAPI::Internal::Type::BaseModel
770
- OrHash =
771
- T.type_alias do
772
- T.any(
773
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations,
774
- FinchAPI::Internal::AnyHash
775
- )
776
- end
777
-
778
- sig { returns(T.nilable(T::Boolean)) }
779
- attr_reader :city
780
-
781
- sig { params(city: T::Boolean).void }
782
- attr_writer :city
783
-
784
- sig { returns(T.nilable(T::Boolean)) }
785
- attr_reader :country
786
-
787
- sig { params(country: T::Boolean).void }
788
- attr_writer :country
789
-
790
- sig { returns(T.nilable(T::Boolean)) }
791
- attr_reader :line1
792
-
793
- sig { params(line1: T::Boolean).void }
794
- attr_writer :line1
795
-
796
- sig { returns(T.nilable(T::Boolean)) }
797
- attr_reader :line2
798
-
799
- sig { params(line2: T::Boolean).void }
800
- attr_writer :line2
801
-
802
- sig { returns(T.nilable(T::Boolean)) }
803
- attr_reader :postal_code
804
-
805
- sig { params(postal_code: T::Boolean).void }
806
- attr_writer :postal_code
807
-
808
- sig { returns(T.nilable(T::Boolean)) }
809
- attr_reader :state
810
-
811
- sig { params(state: T::Boolean).void }
812
- attr_writer :state
813
-
814
- sig do
815
- params(
816
- city: T::Boolean,
817
- country: T::Boolean,
818
- line1: T::Boolean,
819
- line2: T::Boolean,
820
- postal_code: T::Boolean,
821
- state: T::Boolean
822
- ).returns(T.attached_class)
823
- end
824
- def self.new(
825
- city: nil,
826
- country: nil,
827
- line1: nil,
828
- line2: nil,
829
- postal_code: nil,
830
- state: nil
831
- )
832
- end
833
-
834
- sig do
835
- override.returns(
836
- {
837
- city: T::Boolean,
838
- country: T::Boolean,
839
- line1: T::Boolean,
840
- line2: T::Boolean,
841
- postal_code: T::Boolean,
842
- state: T::Boolean
843
- }
844
- )
845
- end
846
- def to_hash
847
- end
848
- end
849
- end
850
-
851
- class Directory < FinchAPI::Internal::Type::BaseModel
852
- OrHash =
853
- T.type_alias do
854
- T.any(
855
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory,
856
- FinchAPI::Internal::AnyHash
857
- )
858
- end
859
-
860
- sig do
861
- returns(
862
- T.nilable(
863
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals
864
- )
865
- )
866
- end
867
- attr_reader :individuals
868
-
869
- sig do
870
- params(
871
- individuals:
872
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::OrHash
873
- ).void
874
- end
875
- attr_writer :individuals
876
-
877
- sig do
878
- returns(
879
- T.nilable(
880
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging
881
- )
882
- )
883
- end
884
- attr_reader :paging
885
-
886
- sig do
887
- params(
888
- paging:
889
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging::OrHash
890
- ).void
891
- end
892
- attr_writer :paging
893
-
894
- sig do
895
- params(
896
- individuals:
897
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::OrHash,
898
- paging:
899
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging::OrHash
900
- ).returns(T.attached_class)
901
- end
902
- def self.new(individuals: nil, paging: nil)
903
- end
904
-
905
- sig do
906
- override.returns(
907
- {
908
- individuals:
909
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals,
910
- paging:
911
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging
912
- }
913
- )
914
- end
915
- def to_hash
916
- end
917
-
918
- class Individuals < FinchAPI::Internal::Type::BaseModel
919
- OrHash =
920
- T.type_alias do
921
- T.any(
922
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals,
923
- FinchAPI::Internal::AnyHash
924
- )
925
- end
926
-
927
- sig { returns(T.nilable(T::Boolean)) }
928
- attr_reader :id
929
-
930
- sig { params(id: T::Boolean).void }
931
- attr_writer :id
932
-
933
- sig { returns(T.nilable(T::Boolean)) }
934
- attr_reader :department
935
-
936
- sig { params(department: T::Boolean).void }
937
- attr_writer :department
938
-
939
- sig { returns(T.nilable(T::Boolean)) }
940
- attr_reader :first_name
941
-
942
- sig { params(first_name: T::Boolean).void }
943
- attr_writer :first_name
944
-
945
- sig { returns(T.nilable(T::Boolean)) }
946
- attr_reader :is_active
947
-
948
- sig { params(is_active: T::Boolean).void }
949
- attr_writer :is_active
950
-
951
- sig { returns(T.nilable(T::Boolean)) }
952
- attr_reader :last_name
953
-
954
- sig { params(last_name: T::Boolean).void }
955
- attr_writer :last_name
956
-
957
- sig do
958
- returns(
959
- T.nilable(
960
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager
961
- )
962
- )
963
- end
964
- attr_reader :manager
965
-
966
- sig do
967
- params(
968
- manager:
969
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager::OrHash
970
- ).void
971
- end
972
- attr_writer :manager
973
-
974
- sig { returns(T.nilable(T::Boolean)) }
975
- attr_reader :middle_name
976
-
977
- sig { params(middle_name: T::Boolean).void }
978
- attr_writer :middle_name
979
-
980
- sig do
981
- params(
982
- id: T::Boolean,
983
- department: T::Boolean,
984
- first_name: T::Boolean,
985
- is_active: T::Boolean,
986
- last_name: T::Boolean,
987
- manager:
988
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager::OrHash,
989
- middle_name: T::Boolean
990
- ).returns(T.attached_class)
991
- end
992
- def self.new(
993
- id: nil,
994
- department: nil,
995
- first_name: nil,
996
- is_active: nil,
997
- last_name: nil,
998
- manager: nil,
999
- middle_name: nil
1000
- )
1001
- end
1002
-
1003
- sig do
1004
- override.returns(
1005
- {
1006
- id: T::Boolean,
1007
- department: T::Boolean,
1008
- first_name: T::Boolean,
1009
- is_active: T::Boolean,
1010
- last_name: T::Boolean,
1011
- manager:
1012
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager,
1013
- middle_name: T::Boolean
1014
- }
1015
- )
1016
- end
1017
- def to_hash
1018
- end
1019
-
1020
- class Manager < FinchAPI::Internal::Type::BaseModel
1021
- OrHash =
1022
- T.type_alias do
1023
- T.any(
1024
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager,
1025
- FinchAPI::Internal::AnyHash
1026
- )
1027
- end
1028
-
1029
- sig { returns(T.nilable(T::Boolean)) }
1030
- attr_reader :id
1031
-
1032
- sig { params(id: T::Boolean).void }
1033
- attr_writer :id
1034
-
1035
- sig { params(id: T::Boolean).returns(T.attached_class) }
1036
- def self.new(id: nil)
1037
- end
1038
-
1039
- sig { override.returns({ id: T::Boolean }) }
1040
- def to_hash
1041
- end
1042
- end
1043
- end
1044
-
1045
- class Paging < FinchAPI::Internal::Type::BaseModel
1046
- OrHash =
1047
- T.type_alias do
1048
- T.any(
1049
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging,
1050
- FinchAPI::Internal::AnyHash
1051
- )
1052
- end
1053
-
1054
- sig { returns(T.nilable(T::Boolean)) }
1055
- attr_reader :count
1056
-
1057
- sig { params(count: T::Boolean).void }
1058
- attr_writer :count
1059
-
1060
- sig { returns(T.nilable(T::Boolean)) }
1061
- attr_reader :offset
1062
-
1063
- sig { params(offset: T::Boolean).void }
1064
- attr_writer :offset
1065
-
1066
- sig do
1067
- params(count: T::Boolean, offset: T::Boolean).returns(
1068
- T.attached_class
1069
- )
1070
- end
1071
- def self.new(count: nil, offset: nil)
1072
- end
1073
-
1074
- sig do
1075
- override.returns({ count: T::Boolean, offset: T::Boolean })
1076
- end
1077
- def to_hash
1078
- end
1079
- end
1080
- end
1081
-
1082
- class Employment < FinchAPI::Internal::Type::BaseModel
1083
- OrHash =
1084
- T.type_alias do
1085
- T.any(
1086
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment,
1087
- FinchAPI::Internal::AnyHash
1088
- )
1089
- end
1090
-
1091
- sig { returns(T.nilable(T::Boolean)) }
1092
- attr_reader :id
1093
-
1094
- sig { params(id: T::Boolean).void }
1095
- attr_writer :id
1096
-
1097
- sig { returns(T.nilable(T::Boolean)) }
1098
- attr_reader :class_code
1099
-
1100
- sig { params(class_code: T::Boolean).void }
1101
- attr_writer :class_code
1102
-
1103
- sig { returns(T.nilable(T::Boolean)) }
1104
- attr_reader :custom_fields
1105
-
1106
- sig { params(custom_fields: T::Boolean).void }
1107
- attr_writer :custom_fields
1108
-
1109
- sig do
1110
- returns(
1111
- T.nilable(
1112
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department
1113
- )
1114
- )
1115
- end
1116
- attr_reader :department
1117
-
1118
- sig do
1119
- params(
1120
- department:
1121
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department::OrHash
1122
- ).void
1123
- end
1124
- attr_writer :department
1125
-
1126
- sig do
1127
- returns(
1128
- T.nilable(
1129
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment
1130
- )
1131
- )
1132
- end
1133
- attr_reader :employment
1134
-
1135
- sig do
1136
- params(
1137
- employment:
1138
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment::OrHash
1139
- ).void
1140
- end
1141
- attr_writer :employment
1142
-
1143
- sig { returns(T.nilable(T::Boolean)) }
1144
- attr_reader :employment_status
1145
-
1146
- sig { params(employment_status: T::Boolean).void }
1147
- attr_writer :employment_status
1148
-
1149
- sig { returns(T.nilable(T::Boolean)) }
1150
- attr_reader :end_date
1151
-
1152
- sig { params(end_date: T::Boolean).void }
1153
- attr_writer :end_date
1154
-
1155
- sig { returns(T.nilable(T::Boolean)) }
1156
- attr_reader :first_name
1157
-
1158
- sig { params(first_name: T::Boolean).void }
1159
- attr_writer :first_name
1160
-
1161
- sig do
1162
- returns(
1163
- T.nilable(
1164
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income
1165
- )
1166
- )
1167
- end
1168
- attr_reader :income
1169
-
1170
- sig do
1171
- params(
1172
- income:
1173
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income::OrHash
1174
- ).void
1175
- end
1176
- attr_writer :income
1177
-
1178
- sig { returns(T.nilable(T::Boolean)) }
1179
- attr_reader :income_history
1180
-
1181
- sig { params(income_history: T::Boolean).void }
1182
- attr_writer :income_history
1183
-
1184
- sig { returns(T.nilable(T::Boolean)) }
1185
- attr_reader :is_active
1186
-
1187
- sig { params(is_active: T::Boolean).void }
1188
- attr_writer :is_active
1189
-
1190
- sig { returns(T.nilable(T::Boolean)) }
1191
- attr_reader :last_name
1192
-
1193
- sig { params(last_name: T::Boolean).void }
1194
- attr_writer :last_name
1195
-
1196
- sig do
1197
- returns(
1198
- T.nilable(
1199
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location
1200
- )
1201
- )
1202
- end
1203
- attr_reader :location
1204
-
1205
- sig do
1206
- params(
1207
- location:
1208
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location::OrHash
1209
- ).void
1210
- end
1211
- attr_writer :location
1212
-
1213
- sig do
1214
- returns(
1215
- T.nilable(
1216
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager
1217
- )
1218
- )
1219
- end
1220
- attr_reader :manager
1221
-
1222
- sig do
1223
- params(
1224
- manager:
1225
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager::OrHash
1226
- ).void
1227
- end
1228
- attr_writer :manager
1229
-
1230
- sig { returns(T.nilable(T::Boolean)) }
1231
- attr_reader :middle_name
1232
-
1233
- sig { params(middle_name: T::Boolean).void }
1234
- attr_writer :middle_name
1235
-
1236
- sig { returns(T.nilable(T::Boolean)) }
1237
- attr_reader :start_date
1238
-
1239
- sig { params(start_date: T::Boolean).void }
1240
- attr_writer :start_date
1241
-
1242
- sig { returns(T.nilable(T::Boolean)) }
1243
- attr_reader :title
1244
-
1245
- sig { params(title: T::Boolean).void }
1246
- attr_writer :title
1247
-
1248
- sig do
1249
- params(
1250
- id: T::Boolean,
1251
- class_code: T::Boolean,
1252
- custom_fields: T::Boolean,
1253
- department:
1254
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department::OrHash,
1255
- employment:
1256
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment::OrHash,
1257
- employment_status: T::Boolean,
1258
- end_date: T::Boolean,
1259
- first_name: T::Boolean,
1260
- income:
1261
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income::OrHash,
1262
- income_history: T::Boolean,
1263
- is_active: T::Boolean,
1264
- last_name: T::Boolean,
1265
- location:
1266
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location::OrHash,
1267
- manager:
1268
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager::OrHash,
1269
- middle_name: T::Boolean,
1270
- start_date: T::Boolean,
1271
- title: T::Boolean
1272
- ).returns(T.attached_class)
1273
- end
1274
- def self.new(
1275
- id: nil,
1276
- class_code: nil,
1277
- custom_fields: nil,
1278
- department: nil,
1279
- employment: nil,
1280
- employment_status: nil,
1281
- end_date: nil,
1282
- first_name: nil,
1283
- income: nil,
1284
- income_history: nil,
1285
- is_active: nil,
1286
- last_name: nil,
1287
- location: nil,
1288
- manager: nil,
1289
- middle_name: nil,
1290
- start_date: nil,
1291
- title: nil
1292
- )
1293
- end
1294
-
1295
- sig do
1296
- override.returns(
1297
- {
1298
- id: T::Boolean,
1299
- class_code: T::Boolean,
1300
- custom_fields: T::Boolean,
1301
- department:
1302
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department,
1303
- employment:
1304
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment,
1305
- employment_status: T::Boolean,
1306
- end_date: T::Boolean,
1307
- first_name: T::Boolean,
1308
- income:
1309
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income,
1310
- income_history: T::Boolean,
1311
- is_active: T::Boolean,
1312
- last_name: T::Boolean,
1313
- location:
1314
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location,
1315
- manager:
1316
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager,
1317
- middle_name: T::Boolean,
1318
- start_date: T::Boolean,
1319
- title: T::Boolean
1320
- }
1321
- )
1322
- end
1323
- def to_hash
1324
- end
1325
-
1326
- class Department < FinchAPI::Internal::Type::BaseModel
1327
- OrHash =
1328
- T.type_alias do
1329
- T.any(
1330
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department,
1331
- FinchAPI::Internal::AnyHash
1332
- )
1333
- end
1334
-
1335
- sig { returns(T.nilable(T::Boolean)) }
1336
- attr_reader :name
1337
-
1338
- sig { params(name: T::Boolean).void }
1339
- attr_writer :name
1340
-
1341
- sig { params(name: T::Boolean).returns(T.attached_class) }
1342
- def self.new(name: nil)
1343
- end
1344
-
1345
- sig { override.returns({ name: T::Boolean }) }
1346
- def to_hash
1347
- end
1348
- end
1349
-
1350
- class Employment < FinchAPI::Internal::Type::BaseModel
1351
- OrHash =
1352
- T.type_alias do
1353
- T.any(
1354
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment,
1355
- FinchAPI::Internal::AnyHash
1356
- )
1357
- end
1358
-
1359
- sig { returns(T.nilable(T::Boolean)) }
1360
- attr_reader :subtype
1361
-
1362
- sig { params(subtype: T::Boolean).void }
1363
- attr_writer :subtype
1364
-
1365
- sig { returns(T.nilable(T::Boolean)) }
1366
- attr_reader :type
1367
-
1368
- sig { params(type: T::Boolean).void }
1369
- attr_writer :type
1370
-
1371
- sig do
1372
- params(subtype: T::Boolean, type: T::Boolean).returns(
1373
- T.attached_class
1374
- )
1375
- end
1376
- def self.new(subtype: nil, type: nil)
1377
- end
1378
-
1379
- sig do
1380
- override.returns({ subtype: T::Boolean, type: T::Boolean })
1381
- end
1382
- def to_hash
1383
- end
1384
- end
1385
-
1386
- class Income < FinchAPI::Internal::Type::BaseModel
1387
- OrHash =
1388
- T.type_alias do
1389
- T.any(
1390
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income,
1391
- FinchAPI::Internal::AnyHash
1392
- )
1393
- end
1394
-
1395
- sig { returns(T.nilable(T::Boolean)) }
1396
- attr_reader :amount
1397
-
1398
- sig { params(amount: T::Boolean).void }
1399
- attr_writer :amount
1400
-
1401
- sig { returns(T.nilable(T::Boolean)) }
1402
- attr_reader :currency
1403
-
1404
- sig { params(currency: T::Boolean).void }
1405
- attr_writer :currency
1406
-
1407
- sig { returns(T.nilable(T::Boolean)) }
1408
- attr_reader :unit
1409
-
1410
- sig { params(unit: T::Boolean).void }
1411
- attr_writer :unit
1412
-
1413
- sig do
1414
- params(
1415
- amount: T::Boolean,
1416
- currency: T::Boolean,
1417
- unit: T::Boolean
1418
- ).returns(T.attached_class)
1419
- end
1420
- def self.new(amount: nil, currency: nil, unit: nil)
1421
- end
1422
-
1423
- sig do
1424
- override.returns(
1425
- { amount: T::Boolean, currency: T::Boolean, unit: T::Boolean }
1426
- )
1427
- end
1428
- def to_hash
1429
- end
1430
- end
1431
-
1432
- class Location < FinchAPI::Internal::Type::BaseModel
1433
- OrHash =
1434
- T.type_alias do
1435
- T.any(
1436
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location,
1437
- FinchAPI::Internal::AnyHash
1438
- )
1439
- end
1440
-
1441
- sig { returns(T.nilable(T::Boolean)) }
1442
- attr_reader :city
1443
-
1444
- sig { params(city: T::Boolean).void }
1445
- attr_writer :city
1446
-
1447
- sig { returns(T.nilable(T::Boolean)) }
1448
- attr_reader :country
1449
-
1450
- sig { params(country: T::Boolean).void }
1451
- attr_writer :country
1452
-
1453
- sig { returns(T.nilable(T::Boolean)) }
1454
- attr_reader :line1
1455
-
1456
- sig { params(line1: T::Boolean).void }
1457
- attr_writer :line1
1458
-
1459
- sig { returns(T.nilable(T::Boolean)) }
1460
- attr_reader :line2
1461
-
1462
- sig { params(line2: T::Boolean).void }
1463
- attr_writer :line2
1464
-
1465
- sig { returns(T.nilable(T::Boolean)) }
1466
- attr_reader :postal_code
1467
-
1468
- sig { params(postal_code: T::Boolean).void }
1469
- attr_writer :postal_code
1470
-
1471
- sig { returns(T.nilable(T::Boolean)) }
1472
- attr_reader :state
1473
-
1474
- sig { params(state: T::Boolean).void }
1475
- attr_writer :state
1476
-
1477
- sig do
1478
- params(
1479
- city: T::Boolean,
1480
- country: T::Boolean,
1481
- line1: T::Boolean,
1482
- line2: T::Boolean,
1483
- postal_code: T::Boolean,
1484
- state: T::Boolean
1485
- ).returns(T.attached_class)
1486
- end
1487
- def self.new(
1488
- city: nil,
1489
- country: nil,
1490
- line1: nil,
1491
- line2: nil,
1492
- postal_code: nil,
1493
- state: nil
1494
- )
1495
- end
1496
-
1497
- sig do
1498
- override.returns(
1499
- {
1500
- city: T::Boolean,
1501
- country: T::Boolean,
1502
- line1: T::Boolean,
1503
- line2: T::Boolean,
1504
- postal_code: T::Boolean,
1505
- state: T::Boolean
1506
- }
1507
- )
1508
- end
1509
- def to_hash
1510
- end
1511
- end
1512
-
1513
- class Manager < FinchAPI::Internal::Type::BaseModel
1514
- OrHash =
1515
- T.type_alias do
1516
- T.any(
1517
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager,
1518
- FinchAPI::Internal::AnyHash
1519
- )
1520
- end
1521
-
1522
- sig { returns(T.nilable(T::Boolean)) }
1523
- attr_reader :id
1524
-
1525
- sig { params(id: T::Boolean).void }
1526
- attr_writer :id
1527
-
1528
- sig { params(id: T::Boolean).returns(T.attached_class) }
1529
- def self.new(id: nil)
1530
- end
1531
-
1532
- sig { override.returns({ id: T::Boolean }) }
1533
- def to_hash
1534
- end
1535
- end
1536
- end
1537
-
1538
- class Individual < FinchAPI::Internal::Type::BaseModel
1539
- OrHash =
1540
- T.type_alias do
1541
- T.any(
1542
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual,
1543
- FinchAPI::Internal::AnyHash
1544
- )
1545
- end
1546
-
1547
- sig { returns(T.nilable(T::Boolean)) }
1548
- attr_reader :id
1549
-
1550
- sig { params(id: T::Boolean).void }
1551
- attr_writer :id
1552
-
1553
- sig { returns(T.nilable(T::Boolean)) }
1554
- attr_reader :dob
1555
-
1556
- sig { params(dob: T::Boolean).void }
1557
- attr_writer :dob
1558
-
1559
- sig do
1560
- returns(
1561
- T.nilable(
1562
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails
1563
- )
1564
- )
1565
- end
1566
- attr_reader :emails
1567
-
1568
- sig do
1569
- params(
1570
- emails:
1571
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails::OrHash
1572
- ).void
1573
- end
1574
- attr_writer :emails
1575
-
1576
- sig { returns(T.nilable(T::Boolean)) }
1577
- attr_reader :encrypted_ssn
1578
-
1579
- sig { params(encrypted_ssn: T::Boolean).void }
1580
- attr_writer :encrypted_ssn
1581
-
1582
- sig { returns(T.nilable(T::Boolean)) }
1583
- attr_reader :ethnicity
1584
-
1585
- sig { params(ethnicity: T::Boolean).void }
1586
- attr_writer :ethnicity
1587
-
1588
- sig { returns(T.nilable(T::Boolean)) }
1589
- attr_reader :first_name
1590
-
1591
- sig { params(first_name: T::Boolean).void }
1592
- attr_writer :first_name
1593
-
1594
- sig { returns(T.nilable(T::Boolean)) }
1595
- attr_reader :gender
1596
-
1597
- sig { params(gender: T::Boolean).void }
1598
- attr_writer :gender
1599
-
1600
- sig { returns(T.nilable(T::Boolean)) }
1601
- attr_reader :last_name
1602
-
1603
- sig { params(last_name: T::Boolean).void }
1604
- attr_writer :last_name
1605
-
1606
- sig { returns(T.nilable(T::Boolean)) }
1607
- attr_reader :middle_name
1608
-
1609
- sig { params(middle_name: T::Boolean).void }
1610
- attr_writer :middle_name
1611
-
1612
- sig do
1613
- returns(
1614
- T.nilable(
1615
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers
1616
- )
1617
- )
1618
- end
1619
- attr_reader :phone_numbers
1620
-
1621
- sig do
1622
- params(
1623
- phone_numbers:
1624
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers::OrHash
1625
- ).void
1626
- end
1627
- attr_writer :phone_numbers
1628
-
1629
- sig { returns(T.nilable(T::Boolean)) }
1630
- attr_reader :preferred_name
1631
-
1632
- sig { params(preferred_name: T::Boolean).void }
1633
- attr_writer :preferred_name
1634
-
1635
- sig do
1636
- returns(
1637
- T.nilable(
1638
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence
1639
- )
1640
- )
1641
- end
1642
- attr_reader :residence
1643
-
1644
- sig do
1645
- params(
1646
- residence:
1647
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence::OrHash
1648
- ).void
1649
- end
1650
- attr_writer :residence
1651
-
1652
- sig { returns(T.nilable(T::Boolean)) }
1653
- attr_reader :ssn
1654
-
1655
- sig { params(ssn: T::Boolean).void }
1656
- attr_writer :ssn
1657
-
1658
- sig do
1659
- params(
1660
- id: T::Boolean,
1661
- dob: T::Boolean,
1662
- emails:
1663
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails::OrHash,
1664
- encrypted_ssn: T::Boolean,
1665
- ethnicity: T::Boolean,
1666
- first_name: T::Boolean,
1667
- gender: T::Boolean,
1668
- last_name: T::Boolean,
1669
- middle_name: T::Boolean,
1670
- phone_numbers:
1671
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers::OrHash,
1672
- preferred_name: T::Boolean,
1673
- residence:
1674
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence::OrHash,
1675
- ssn: T::Boolean
1676
- ).returns(T.attached_class)
1677
- end
1678
- def self.new(
1679
- id: nil,
1680
- dob: nil,
1681
- emails: nil,
1682
- encrypted_ssn: nil,
1683
- ethnicity: nil,
1684
- first_name: nil,
1685
- gender: nil,
1686
- last_name: nil,
1687
- middle_name: nil,
1688
- phone_numbers: nil,
1689
- preferred_name: nil,
1690
- residence: nil,
1691
- ssn: nil
1692
- )
1693
- end
1694
-
1695
- sig do
1696
- override.returns(
1697
- {
1698
- id: T::Boolean,
1699
- dob: T::Boolean,
1700
- emails:
1701
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails,
1702
- encrypted_ssn: T::Boolean,
1703
- ethnicity: T::Boolean,
1704
- first_name: T::Boolean,
1705
- gender: T::Boolean,
1706
- last_name: T::Boolean,
1707
- middle_name: T::Boolean,
1708
- phone_numbers:
1709
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers,
1710
- preferred_name: T::Boolean,
1711
- residence:
1712
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence,
1713
- ssn: T::Boolean
1714
- }
1715
- )
1716
- end
1717
- def to_hash
1718
- end
1719
-
1720
- class Emails < FinchAPI::Internal::Type::BaseModel
1721
- OrHash =
1722
- T.type_alias do
1723
- T.any(
1724
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails,
1725
- FinchAPI::Internal::AnyHash
1726
- )
1727
- end
1728
-
1729
- sig { returns(T.nilable(T::Boolean)) }
1730
- attr_reader :data
1731
-
1732
- sig { params(data: T::Boolean).void }
1733
- attr_writer :data
1734
-
1735
- sig { returns(T.nilable(T::Boolean)) }
1736
- attr_reader :type
1737
-
1738
- sig { params(type: T::Boolean).void }
1739
- attr_writer :type
1740
-
1741
- sig do
1742
- params(data: T::Boolean, type: T::Boolean).returns(
1743
- T.attached_class
1744
- )
1745
- end
1746
- def self.new(data: nil, type: nil)
1747
- end
1748
-
1749
- sig { override.returns({ data: T::Boolean, type: T::Boolean }) }
1750
- def to_hash
1751
- end
1752
- end
1753
-
1754
- class PhoneNumbers < FinchAPI::Internal::Type::BaseModel
1755
- OrHash =
1756
- T.type_alias do
1757
- T.any(
1758
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers,
1759
- FinchAPI::Internal::AnyHash
1760
- )
1761
- end
1762
-
1763
- sig { returns(T.nilable(T::Boolean)) }
1764
- attr_reader :data
1765
-
1766
- sig { params(data: T::Boolean).void }
1767
- attr_writer :data
1768
-
1769
- sig { returns(T.nilable(T::Boolean)) }
1770
- attr_reader :type
1771
-
1772
- sig { params(type: T::Boolean).void }
1773
- attr_writer :type
1774
-
1775
- sig do
1776
- params(data: T::Boolean, type: T::Boolean).returns(
1777
- T.attached_class
1778
- )
1779
- end
1780
- def self.new(data: nil, type: nil)
1781
- end
1782
-
1783
- sig { override.returns({ data: T::Boolean, type: T::Boolean }) }
1784
- def to_hash
1785
- end
1786
- end
1787
-
1788
- class Residence < FinchAPI::Internal::Type::BaseModel
1789
- OrHash =
1790
- T.type_alias do
1791
- T.any(
1792
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence,
1793
- FinchAPI::Internal::AnyHash
1794
- )
1795
- end
1796
-
1797
- sig { returns(T.nilable(T::Boolean)) }
1798
- attr_reader :city
1799
-
1800
- sig { params(city: T::Boolean).void }
1801
- attr_writer :city
1802
-
1803
- sig { returns(T.nilable(T::Boolean)) }
1804
- attr_reader :country
1805
-
1806
- sig { params(country: T::Boolean).void }
1807
- attr_writer :country
1808
-
1809
- sig { returns(T.nilable(T::Boolean)) }
1810
- attr_reader :line1
1811
-
1812
- sig { params(line1: T::Boolean).void }
1813
- attr_writer :line1
1814
-
1815
- sig { returns(T.nilable(T::Boolean)) }
1816
- attr_reader :line2
1817
-
1818
- sig { params(line2: T::Boolean).void }
1819
- attr_writer :line2
1820
-
1821
- sig { returns(T.nilable(T::Boolean)) }
1822
- attr_reader :postal_code
1823
-
1824
- sig { params(postal_code: T::Boolean).void }
1825
- attr_writer :postal_code
1826
-
1827
- sig { returns(T.nilable(T::Boolean)) }
1828
- attr_reader :state
1829
-
1830
- sig { params(state: T::Boolean).void }
1831
- attr_writer :state
1832
-
1833
- sig do
1834
- params(
1835
- city: T::Boolean,
1836
- country: T::Boolean,
1837
- line1: T::Boolean,
1838
- line2: T::Boolean,
1839
- postal_code: T::Boolean,
1840
- state: T::Boolean
1841
- ).returns(T.attached_class)
1842
- end
1843
- def self.new(
1844
- city: nil,
1845
- country: nil,
1846
- line1: nil,
1847
- line2: nil,
1848
- postal_code: nil,
1849
- state: nil
1850
- )
1851
- end
1852
-
1853
- sig do
1854
- override.returns(
1855
- {
1856
- city: T::Boolean,
1857
- country: T::Boolean,
1858
- line1: T::Boolean,
1859
- line2: T::Boolean,
1860
- postal_code: T::Boolean,
1861
- state: T::Boolean
1862
- }
1863
- )
1864
- end
1865
- def to_hash
1866
- end
1867
- end
1868
- end
1869
-
1870
- class PayGroup < FinchAPI::Internal::Type::BaseModel
1871
- OrHash =
1872
- T.type_alias do
1873
- T.any(
1874
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup,
1875
- FinchAPI::Internal::AnyHash
1876
- )
1877
- end
1878
-
1879
- sig { returns(T.nilable(T::Boolean)) }
1880
- attr_reader :id
1881
-
1882
- sig { params(id: T::Boolean).void }
1883
- attr_writer :id
1884
-
1885
- sig { returns(T.nilable(T::Boolean)) }
1886
- attr_reader :individual_ids
1887
-
1888
- sig { params(individual_ids: T::Boolean).void }
1889
- attr_writer :individual_ids
1890
-
1891
- sig { returns(T.nilable(T::Boolean)) }
1892
- attr_reader :name
1893
-
1894
- sig { params(name: T::Boolean).void }
1895
- attr_writer :name
1896
-
1897
- sig { returns(T.nilable(T::Boolean)) }
1898
- attr_reader :pay_frequencies
1899
-
1900
- sig { params(pay_frequencies: T::Boolean).void }
1901
- attr_writer :pay_frequencies
1902
-
1903
- sig do
1904
- params(
1905
- id: T::Boolean,
1906
- individual_ids: T::Boolean,
1907
- name: T::Boolean,
1908
- pay_frequencies: T::Boolean
1909
- ).returns(T.attached_class)
1910
- end
1911
- def self.new(
1912
- id: nil,
1913
- individual_ids: nil,
1914
- name: nil,
1915
- pay_frequencies: nil
1916
- )
1917
- end
1918
-
1919
- sig do
1920
- override.returns(
1921
- {
1922
- id: T::Boolean,
1923
- individual_ids: T::Boolean,
1924
- name: T::Boolean,
1925
- pay_frequencies: T::Boolean
1926
- }
1927
- )
1928
- end
1929
- def to_hash
1930
- end
1931
- end
1932
-
1933
- class PayStatement < FinchAPI::Internal::Type::BaseModel
1934
- OrHash =
1935
- T.type_alias do
1936
- T.any(
1937
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement,
1938
- FinchAPI::Internal::AnyHash
1939
- )
1940
- end
1941
-
1942
- sig do
1943
- returns(
1944
- T.nilable(
1945
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging
1946
- )
1947
- )
1948
- end
1949
- attr_reader :paging
1950
-
1951
- sig do
1952
- params(
1953
- paging:
1954
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging::OrHash
1955
- ).void
1956
- end
1957
- attr_writer :paging
1958
-
1959
- sig do
1960
- returns(
1961
- T.nilable(
1962
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements
1963
- )
1964
- )
1965
- end
1966
- attr_reader :pay_statements
1967
-
1968
- sig do
1969
- params(
1970
- pay_statements:
1971
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::OrHash
1972
- ).void
1973
- end
1974
- attr_writer :pay_statements
1975
-
1976
- sig do
1977
- params(
1978
- paging:
1979
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging::OrHash,
1980
- pay_statements:
1981
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::OrHash
1982
- ).returns(T.attached_class)
1983
- end
1984
- def self.new(paging: nil, pay_statements: nil)
1985
- end
1986
-
1987
- sig do
1988
- override.returns(
1989
- {
1990
- paging:
1991
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging,
1992
- pay_statements:
1993
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements
1994
- }
1995
- )
1996
- end
1997
- def to_hash
1998
- end
1999
-
2000
- class Paging < FinchAPI::Internal::Type::BaseModel
2001
- OrHash =
2002
- T.type_alias do
2003
- T.any(
2004
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging,
2005
- FinchAPI::Internal::AnyHash
2006
- )
2007
- end
2008
-
2009
- sig { returns(T::Boolean) }
2010
- attr_accessor :count
2011
-
2012
- sig { returns(T::Boolean) }
2013
- attr_accessor :offset
2014
-
2015
- sig do
2016
- params(count: T::Boolean, offset: T::Boolean).returns(
2017
- T.attached_class
2018
- )
2019
- end
2020
- def self.new(count:, offset:)
2021
- end
2022
-
2023
- sig do
2024
- override.returns({ count: T::Boolean, offset: T::Boolean })
2025
- end
2026
- def to_hash
2027
- end
2028
- end
2029
-
2030
- class PayStatements < FinchAPI::Internal::Type::BaseModel
2031
- OrHash =
2032
- T.type_alias do
2033
- T.any(
2034
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements,
2035
- FinchAPI::Internal::AnyHash
2036
- )
2037
- end
2038
-
2039
- sig do
2040
- returns(
2041
- T.nilable(
2042
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings
2043
- )
2044
- )
2045
- end
2046
- attr_reader :earnings
2047
-
2048
- sig do
2049
- params(
2050
- earnings:
2051
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings::OrHash
2052
- ).void
2053
- end
2054
- attr_writer :earnings
2055
-
2056
- sig do
2057
- returns(
2058
- T.nilable(
2059
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions
2060
- )
2061
- )
2062
- end
2063
- attr_reader :employee_deductions
2064
-
2065
- sig do
2066
- params(
2067
- employee_deductions:
2068
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions::OrHash
2069
- ).void
2070
- end
2071
- attr_writer :employee_deductions
2072
-
2073
- sig do
2074
- returns(
2075
- T.nilable(
2076
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions
2077
- )
2078
- )
2079
- end
2080
- attr_reader :employer_contributions
2081
-
2082
- sig do
2083
- params(
2084
- employer_contributions:
2085
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions::OrHash
2086
- ).void
2087
- end
2088
- attr_writer :employer_contributions
2089
-
2090
- sig { returns(T.nilable(T::Boolean)) }
2091
- attr_reader :gross_pay
2092
-
2093
- sig { params(gross_pay: T::Boolean).void }
2094
- attr_writer :gross_pay
2095
-
2096
- sig { returns(T.nilable(T::Boolean)) }
2097
- attr_reader :individual_id
2098
-
2099
- sig { params(individual_id: T::Boolean).void }
2100
- attr_writer :individual_id
2101
-
2102
- sig { returns(T.nilable(T::Boolean)) }
2103
- attr_reader :net_pay
2104
-
2105
- sig { params(net_pay: T::Boolean).void }
2106
- attr_writer :net_pay
2107
-
2108
- sig { returns(T.nilable(T::Boolean)) }
2109
- attr_reader :payment_method
2110
-
2111
- sig { params(payment_method: T::Boolean).void }
2112
- attr_writer :payment_method
2113
-
2114
- sig do
2115
- returns(
2116
- T.nilable(
2117
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes
2118
- )
2119
- )
2120
- end
2121
- attr_reader :taxes
2122
-
2123
- sig do
2124
- params(
2125
- taxes:
2126
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes::OrHash
2127
- ).void
2128
- end
2129
- attr_writer :taxes
2130
-
2131
- sig { returns(T.nilable(T::Boolean)) }
2132
- attr_reader :total_hours
2133
-
2134
- sig { params(total_hours: T::Boolean).void }
2135
- attr_writer :total_hours
2136
-
2137
- sig { returns(T.nilable(T::Boolean)) }
2138
- attr_reader :type
2139
-
2140
- sig { params(type: T::Boolean).void }
2141
- attr_writer :type
2142
-
2143
- sig do
2144
- params(
2145
- earnings:
2146
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings::OrHash,
2147
- employee_deductions:
2148
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions::OrHash,
2149
- employer_contributions:
2150
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions::OrHash,
2151
- gross_pay: T::Boolean,
2152
- individual_id: T::Boolean,
2153
- net_pay: T::Boolean,
2154
- payment_method: T::Boolean,
2155
- taxes:
2156
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes::OrHash,
2157
- total_hours: T::Boolean,
2158
- type: T::Boolean
2159
- ).returns(T.attached_class)
2160
- end
2161
- def self.new(
2162
- earnings: nil,
2163
- employee_deductions: nil,
2164
- employer_contributions: nil,
2165
- gross_pay: nil,
2166
- individual_id: nil,
2167
- net_pay: nil,
2168
- payment_method: nil,
2169
- taxes: nil,
2170
- total_hours: nil,
2171
- type: nil
2172
- )
2173
- end
2174
-
2175
- sig do
2176
- override.returns(
2177
- {
2178
- earnings:
2179
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings,
2180
- employee_deductions:
2181
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions,
2182
- employer_contributions:
2183
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions,
2184
- gross_pay: T::Boolean,
2185
- individual_id: T::Boolean,
2186
- net_pay: T::Boolean,
2187
- payment_method: T::Boolean,
2188
- taxes:
2189
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes,
2190
- total_hours: T::Boolean,
2191
- type: T::Boolean
2192
- }
2193
- )
2194
- end
2195
- def to_hash
2196
- end
2197
-
2198
- class Earnings < FinchAPI::Internal::Type::BaseModel
2199
- OrHash =
2200
- T.type_alias do
2201
- T.any(
2202
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings,
2203
- FinchAPI::Internal::AnyHash
2204
- )
2205
- end
2206
-
2207
- sig { returns(T.nilable(T::Boolean)) }
2208
- attr_reader :amount
2209
-
2210
- sig { params(amount: T::Boolean).void }
2211
- attr_writer :amount
2212
-
2213
- sig { returns(T.nilable(T::Boolean)) }
2214
- attr_reader :currency
2215
-
2216
- sig { params(currency: T::Boolean).void }
2217
- attr_writer :currency
2218
-
2219
- sig { returns(T.nilable(T::Boolean)) }
2220
- attr_reader :name
2221
-
2222
- sig { params(name: T::Boolean).void }
2223
- attr_writer :name
2224
-
2225
- sig { returns(T.nilable(T::Boolean)) }
2226
- attr_reader :type
2227
-
2228
- sig { params(type: T::Boolean).void }
2229
- attr_writer :type
2230
-
2231
- sig do
2232
- params(
2233
- amount: T::Boolean,
2234
- currency: T::Boolean,
2235
- name: T::Boolean,
2236
- type: T::Boolean
2237
- ).returns(T.attached_class)
2238
- end
2239
- def self.new(amount: nil, currency: nil, name: nil, type: nil)
2240
- end
2241
-
2242
- sig do
2243
- override.returns(
2244
- {
2245
- amount: T::Boolean,
2246
- currency: T::Boolean,
2247
- name: T::Boolean,
2248
- type: T::Boolean
2249
- }
2250
- )
2251
- end
2252
- def to_hash
2253
- end
2254
- end
2255
-
2256
- class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel
2257
- OrHash =
2258
- T.type_alias do
2259
- T.any(
2260
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions,
2261
- FinchAPI::Internal::AnyHash
2262
- )
2263
- end
2264
-
2265
- sig { returns(T.nilable(T::Boolean)) }
2266
- attr_reader :amount
2267
-
2268
- sig { params(amount: T::Boolean).void }
2269
- attr_writer :amount
2270
-
2271
- sig { returns(T.nilable(T::Boolean)) }
2272
- attr_reader :currency
2273
-
2274
- sig { params(currency: T::Boolean).void }
2275
- attr_writer :currency
2276
-
2277
- sig { returns(T.nilable(T::Boolean)) }
2278
- attr_reader :name
2279
-
2280
- sig { params(name: T::Boolean).void }
2281
- attr_writer :name
2282
-
2283
- sig { returns(T.nilable(T::Boolean)) }
2284
- attr_reader :pre_tax
2285
-
2286
- sig { params(pre_tax: T::Boolean).void }
2287
- attr_writer :pre_tax
2288
-
2289
- sig { returns(T.nilable(T::Boolean)) }
2290
- attr_reader :type
2291
-
2292
- sig { params(type: T::Boolean).void }
2293
- attr_writer :type
2294
-
2295
- sig do
2296
- params(
2297
- amount: T::Boolean,
2298
- currency: T::Boolean,
2299
- name: T::Boolean,
2300
- pre_tax: T::Boolean,
2301
- type: T::Boolean
2302
- ).returns(T.attached_class)
2303
- end
2304
- def self.new(
2305
- amount: nil,
2306
- currency: nil,
2307
- name: nil,
2308
- pre_tax: nil,
2309
- type: nil
2310
- )
2311
- end
2312
-
2313
- sig do
2314
- override.returns(
2315
- {
2316
- amount: T::Boolean,
2317
- currency: T::Boolean,
2318
- name: T::Boolean,
2319
- pre_tax: T::Boolean,
2320
- type: T::Boolean
2321
- }
2322
- )
2323
- end
2324
- def to_hash
2325
- end
2326
- end
2327
-
2328
- class EmployerContributions < FinchAPI::Internal::Type::BaseModel
2329
- OrHash =
2330
- T.type_alias do
2331
- T.any(
2332
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions,
2333
- FinchAPI::Internal::AnyHash
2334
- )
2335
- end
2336
-
2337
- sig { returns(T.nilable(T::Boolean)) }
2338
- attr_reader :amount
2339
-
2340
- sig { params(amount: T::Boolean).void }
2341
- attr_writer :amount
2342
-
2343
- sig { returns(T.nilable(T::Boolean)) }
2344
- attr_reader :currency
2345
-
2346
- sig { params(currency: T::Boolean).void }
2347
- attr_writer :currency
2348
-
2349
- sig { returns(T.nilable(T::Boolean)) }
2350
- attr_reader :name
2351
-
2352
- sig { params(name: T::Boolean).void }
2353
- attr_writer :name
2354
-
2355
- sig do
2356
- params(
2357
- amount: T::Boolean,
2358
- currency: T::Boolean,
2359
- name: T::Boolean
2360
- ).returns(T.attached_class)
2361
- end
2362
- def self.new(amount: nil, currency: nil, name: nil)
2363
- end
2364
-
2365
- sig do
2366
- override.returns(
2367
- {
2368
- amount: T::Boolean,
2369
- currency: T::Boolean,
2370
- name: T::Boolean
2371
- }
2372
- )
2373
- end
2374
- def to_hash
2375
- end
2376
- end
2377
-
2378
- class Taxes < FinchAPI::Internal::Type::BaseModel
2379
- OrHash =
2380
- T.type_alias do
2381
- T.any(
2382
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes,
2383
- FinchAPI::Internal::AnyHash
2384
- )
2385
- end
2386
-
2387
- sig { returns(T.nilable(T::Boolean)) }
2388
- attr_reader :amount
2389
-
2390
- sig { params(amount: T::Boolean).void }
2391
- attr_writer :amount
2392
-
2393
- sig { returns(T.nilable(T::Boolean)) }
2394
- attr_reader :currency
2395
-
2396
- sig { params(currency: T::Boolean).void }
2397
- attr_writer :currency
2398
-
2399
- sig { returns(T.nilable(T::Boolean)) }
2400
- attr_reader :employer
2401
-
2402
- sig { params(employer: T::Boolean).void }
2403
- attr_writer :employer
2404
-
2405
- sig { returns(T.nilable(T::Boolean)) }
2406
- attr_reader :name
2407
-
2408
- sig { params(name: T::Boolean).void }
2409
- attr_writer :name
2410
-
2411
- sig { returns(T.nilable(T::Boolean)) }
2412
- attr_reader :type
2413
-
2414
- sig { params(type: T::Boolean).void }
2415
- attr_writer :type
2416
-
2417
- sig do
2418
- params(
2419
- amount: T::Boolean,
2420
- currency: T::Boolean,
2421
- employer: T::Boolean,
2422
- name: T::Boolean,
2423
- type: T::Boolean
2424
- ).returns(T.attached_class)
2425
- end
2426
- def self.new(
2427
- amount: nil,
2428
- currency: nil,
2429
- employer: nil,
2430
- name: nil,
2431
- type: nil
2432
- )
2433
- end
2434
-
2435
- sig do
2436
- override.returns(
2437
- {
2438
- amount: T::Boolean,
2439
- currency: T::Boolean,
2440
- employer: T::Boolean,
2441
- name: T::Boolean,
2442
- type: T::Boolean
2443
- }
2444
- )
2445
- end
2446
- def to_hash
2447
- end
2448
- end
2449
- end
2450
- end
2451
-
2452
- class Payment < FinchAPI::Internal::Type::BaseModel
2453
- OrHash =
2454
- T.type_alias do
2455
- T.any(
2456
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment,
2457
- FinchAPI::Internal::AnyHash
2458
- )
2459
- end
2460
-
2461
- sig { returns(T.nilable(T::Boolean)) }
2462
- attr_reader :id
2463
-
2464
- sig { params(id: T::Boolean).void }
2465
- attr_writer :id
2466
-
2467
- sig { returns(T.nilable(T::Boolean)) }
2468
- attr_reader :company_debit
2469
-
2470
- sig { params(company_debit: T::Boolean).void }
2471
- attr_writer :company_debit
2472
-
2473
- sig { returns(T.nilable(T::Boolean)) }
2474
- attr_reader :debit_date
2475
-
2476
- sig { params(debit_date: T::Boolean).void }
2477
- attr_writer :debit_date
2478
-
2479
- sig { returns(T.nilable(T::Boolean)) }
2480
- attr_reader :employee_taxes
2481
-
2482
- sig { params(employee_taxes: T::Boolean).void }
2483
- attr_writer :employee_taxes
2484
-
2485
- sig { returns(T.nilable(T::Boolean)) }
2486
- attr_reader :employer_taxes
2487
-
2488
- sig { params(employer_taxes: T::Boolean).void }
2489
- attr_writer :employer_taxes
2490
-
2491
- sig { returns(T.nilable(T::Boolean)) }
2492
- attr_reader :gross_pay
2493
-
2494
- sig { params(gross_pay: T::Boolean).void }
2495
- attr_writer :gross_pay
2496
-
2497
- sig { returns(T.nilable(T::Boolean)) }
2498
- attr_reader :individual_ids
2499
-
2500
- sig { params(individual_ids: T::Boolean).void }
2501
- attr_writer :individual_ids
2502
-
2503
- sig { returns(T.nilable(T::Boolean)) }
2504
- attr_reader :net_pay
2505
-
2506
- sig { params(net_pay: T::Boolean).void }
2507
- attr_writer :net_pay
2508
-
2509
- sig { returns(T.nilable(T::Boolean)) }
2510
- attr_reader :pay_date
2511
-
2512
- sig { params(pay_date: T::Boolean).void }
2513
- attr_writer :pay_date
2514
-
2515
- sig { returns(T.nilable(T::Boolean)) }
2516
- attr_reader :pay_frequencies
2517
-
2518
- sig { params(pay_frequencies: T::Boolean).void }
2519
- attr_writer :pay_frequencies
2520
-
2521
- sig { returns(T.nilable(T::Boolean)) }
2522
- attr_reader :pay_group_ids
2523
-
2524
- sig { params(pay_group_ids: T::Boolean).void }
2525
- attr_writer :pay_group_ids
2526
-
2527
- sig do
2528
- returns(
2529
- T.nilable(
2530
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod
2531
- )
2532
- )
2533
- end
2534
- attr_reader :pay_period
2535
-
2536
- sig do
2537
- params(
2538
- pay_period:
2539
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod::OrHash
2540
- ).void
2541
- end
2542
- attr_writer :pay_period
2543
-
2544
- sig do
2545
- params(
2546
- id: T::Boolean,
2547
- company_debit: T::Boolean,
2548
- debit_date: T::Boolean,
2549
- employee_taxes: T::Boolean,
2550
- employer_taxes: T::Boolean,
2551
- gross_pay: T::Boolean,
2552
- individual_ids: T::Boolean,
2553
- net_pay: T::Boolean,
2554
- pay_date: T::Boolean,
2555
- pay_frequencies: T::Boolean,
2556
- pay_group_ids: T::Boolean,
2557
- pay_period:
2558
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod::OrHash
2559
- ).returns(T.attached_class)
2560
- end
2561
- def self.new(
2562
- id: nil,
2563
- company_debit: nil,
2564
- debit_date: nil,
2565
- employee_taxes: nil,
2566
- employer_taxes: nil,
2567
- gross_pay: nil,
2568
- individual_ids: nil,
2569
- net_pay: nil,
2570
- pay_date: nil,
2571
- pay_frequencies: nil,
2572
- pay_group_ids: nil,
2573
- pay_period: nil
2574
- )
2575
- end
2576
-
2577
- sig do
2578
- override.returns(
2579
- {
2580
- id: T::Boolean,
2581
- company_debit: T::Boolean,
2582
- debit_date: T::Boolean,
2583
- employee_taxes: T::Boolean,
2584
- employer_taxes: T::Boolean,
2585
- gross_pay: T::Boolean,
2586
- individual_ids: T::Boolean,
2587
- net_pay: T::Boolean,
2588
- pay_date: T::Boolean,
2589
- pay_frequencies: T::Boolean,
2590
- pay_group_ids: T::Boolean,
2591
- pay_period:
2592
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod
2593
- }
2594
- )
2595
- end
2596
- def to_hash
2597
- end
2598
-
2599
- class PayPeriod < FinchAPI::Internal::Type::BaseModel
2600
- OrHash =
2601
- T.type_alias do
2602
- T.any(
2603
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod,
2604
- FinchAPI::Internal::AnyHash
2605
- )
2606
- end
2607
-
2608
- sig { returns(T.nilable(T::Boolean)) }
2609
- attr_reader :end_date
2610
-
2611
- sig { params(end_date: T::Boolean).void }
2612
- attr_writer :end_date
2613
-
2614
- sig { returns(T.nilable(T::Boolean)) }
2615
- attr_reader :start_date
2616
-
2617
- sig { params(start_date: T::Boolean).void }
2618
- attr_writer :start_date
2619
-
2620
- sig do
2621
- params(end_date: T::Boolean, start_date: T::Boolean).returns(
2622
- T.attached_class
2623
- )
2624
- end
2625
- def self.new(end_date: nil, start_date: nil)
2626
- end
2627
-
2628
- sig do
2629
- override.returns(
2630
- { end_date: T::Boolean, start_date: T::Boolean }
2631
- )
2632
- end
2633
- def to_hash
2634
- end
2635
- end
2636
- end
2637
- end
2638
-
2639
- # The type of authentication method.
2640
- module Type
2641
- extend FinchAPI::Internal::Type::Enum
2642
-
2643
- TaggedSymbol =
2644
- T.type_alias do
2645
- T.all(Symbol, FinchAPI::Provider::AuthenticationMethod::Type)
2646
- end
2647
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2648
-
2649
- ASSISTED =
237
+ API =
2650
238
  T.let(
2651
- :assisted,
2652
- FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
2653
- )
2654
- CREDENTIAL =
2655
- T.let(
2656
- :credential,
2657
- FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
2658
- )
2659
- API_TOKEN =
2660
- T.let(
2661
- :api_token,
2662
- FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
2663
- )
2664
- API_CREDENTIAL =
2665
- T.let(
2666
- :api_credential,
2667
- FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
2668
- )
2669
- OAUTH =
2670
- T.let(
2671
- :oauth,
239
+ :api,
2672
240
  FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol
2673
241
  )
2674
242