finch-api 0.1.0.pre.alpha.59 → 0.1.0.pre.alpha.61
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +25 -0
- data/README.md +1 -1
- data/lib/finch_api/models/access_token_create_params.rb +8 -2
- data/lib/finch_api/models/account_update_event.rb +328 -8
- data/lib/finch_api/models/connect/session_new_params.rb +4 -2
- data/lib/finch_api/models/connect/session_reauthenticate_params.rb +4 -2
- data/lib/finch_api/models/hris/benefit_create_params.rb +3 -1
- data/lib/finch_api/models/hris/benefit_list_params.rb +3 -1
- data/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb +3 -1
- data/lib/finch_api/models/hris/benefit_register_params.rb +3 -1
- data/lib/finch_api/models/hris/benefit_retrieve_params.rb +3 -1
- data/lib/finch_api/models/hris/benefit_update_params.rb +3 -1
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +3 -1
- data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +3 -1
- data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +3 -1
- data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +3 -1
- data/lib/finch_api/models/hris/company_retrieve_params.rb +3 -1
- data/lib/finch_api/models/hris/directory_list_individuals_params.rb +3 -1
- data/lib/finch_api/models/hris/directory_list_params.rb +3 -1
- data/lib/finch_api/models/hris/document_list_params.rb +3 -1
- data/lib/finch_api/models/hris/document_retreive_params.rb +3 -1
- data/lib/finch_api/models/hris/employment_data.rb +11 -1
- data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +3 -1
- data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +3 -1
- data/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb +3 -1
- data/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb +3 -1
- data/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb +3 -1
- data/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb +3 -1
- data/lib/finch_api/models/hris/pay_statement_item_list_params.rb +3 -1
- data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +3 -1
- data/lib/finch_api/models/hris/payment_list_params.rb +3 -1
- data/lib/finch_api/models/payroll/pay_group_list_params.rb +3 -1
- data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +3 -1
- data/lib/finch_api/models/provider.rb +1371 -4
- data/lib/finch_api/models/provider_list_response.rb +1387 -4
- data/lib/finch_api/models/sandbox/directory_create_params.rb +11 -1
- data/lib/finch_api/models/sandbox/employment_update_params.rb +11 -1
- data/lib/finch_api/models/sandbox/employment_update_response.rb +11 -1
- data/lib/finch_api/resources/access_tokens.rb +4 -1
- data/lib/finch_api/resources/connect/sessions.rb +2 -2
- data/lib/finch_api/resources/sandbox/employment.rb +3 -1
- data/lib/finch_api/version.rb +1 -1
- data/rbi/finch_api/models/access_token_create_params.rbi +8 -2
- data/rbi/finch_api/models/account_update_event.rbi +738 -15
- data/rbi/finch_api/models/connect/session_new_params.rbi +6 -2
- data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefit_create_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefit_list_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefit_register_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefit_update_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +6 -2
- data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +6 -2
- data/rbi/finch_api/models/hris/company_retrieve_params.rbi +6 -2
- data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +6 -2
- data/rbi/finch_api/models/hris/directory_list_params.rbi +6 -2
- data/rbi/finch_api/models/hris/document_list_params.rbi +6 -2
- data/rbi/finch_api/models/hris/document_retreive_params.rbi +6 -2
- data/rbi/finch_api/models/hris/employment_data.rbi +12 -0
- data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +6 -2
- data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +6 -2
- data/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi +6 -2
- data/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi +6 -2
- data/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi +6 -2
- data/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi +6 -2
- data/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi +6 -2
- data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +6 -2
- data/rbi/finch_api/models/hris/payment_list_params.rbi +6 -2
- data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +6 -2
- data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +6 -2
- data/rbi/finch_api/models/provider.rbi +3137 -6
- data/rbi/finch_api/models/provider_list_response.rbi +3139 -6
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +12 -0
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +12 -0
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +12 -0
- data/rbi/finch_api/resources/access_tokens.rbi +4 -1
- data/rbi/finch_api/resources/connect/sessions.rbi +6 -2
- data/rbi/finch_api/resources/hris/benefits/individuals.rbi +12 -4
- data/rbi/finch_api/resources/hris/benefits.rbi +18 -6
- data/rbi/finch_api/resources/hris/company.rbi +3 -1
- data/rbi/finch_api/resources/hris/directory.rbi +3 -1
- data/rbi/finch_api/resources/hris/documents.rbi +6 -2
- data/rbi/finch_api/resources/hris/employments.rbi +3 -1
- data/rbi/finch_api/resources/hris/individuals.rbi +3 -1
- data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi +12 -4
- data/rbi/finch_api/resources/hris/pay_statement_item.rbi +3 -1
- data/rbi/finch_api/resources/hris/pay_statements.rbi +3 -1
- data/rbi/finch_api/resources/hris/payments.rbi +3 -1
- data/rbi/finch_api/resources/payroll/pay_groups.rbi +6 -2
- data/rbi/finch_api/resources/sandbox/employment.rbi +5 -0
- data/sig/finch_api/models/account_update_event.rbs +405 -17
- data/sig/finch_api/models/hris/employment_data.rbs +5 -0
- data/sig/finch_api/models/provider.rbs +1722 -6
- data/sig/finch_api/models/provider_list_response.rbs +1722 -6
- data/sig/finch_api/models/sandbox/directory_create_params.rbs +5 -0
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +5 -0
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +5 -0
- data/sig/finch_api/resources/sandbox/employment.rbs +1 -0
- metadata +2 -2
|
@@ -108,18 +108,19 @@ module FinchAPI
|
|
|
108
108
|
FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
|
|
109
109
|
|
|
110
110
|
# @!attribute supported_fields
|
|
111
|
-
# The supported fields
|
|
111
|
+
# The supported data fields returned by our HR, payroll, and benefits endpoints
|
|
112
112
|
#
|
|
113
|
-
# @return [
|
|
113
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields, nil]
|
|
114
114
|
optional :supported_fields,
|
|
115
|
-
FinchAPI::
|
|
115
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields },
|
|
116
|
+
nil?: true
|
|
116
117
|
|
|
117
118
|
# @!method initialize(type:, benefits_support: nil, supported_fields: nil)
|
|
118
119
|
# @param type [Symbol, FinchAPI::Models::ProviderListResponse::AuthenticationMethod::Type] The type of authentication method
|
|
119
120
|
#
|
|
120
121
|
# @param benefits_support [Hash{Symbol=>Object, nil}] The supported benefit types and their configurations
|
|
121
122
|
#
|
|
122
|
-
# @param supported_fields [
|
|
123
|
+
# @param supported_fields [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR, payroll, and benefits endpoints
|
|
123
124
|
|
|
124
125
|
# The type of authentication method
|
|
125
126
|
#
|
|
@@ -137,6 +138,1388 @@ module FinchAPI
|
|
|
137
138
|
# @!method self.values
|
|
138
139
|
# @return [Array<Symbol>]
|
|
139
140
|
end
|
|
141
|
+
|
|
142
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod#supported_fields
|
|
143
|
+
class SupportedFields < FinchAPI::Internal::Type::BaseModel
|
|
144
|
+
# @!attribute company
|
|
145
|
+
#
|
|
146
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company, nil]
|
|
147
|
+
optional :company,
|
|
148
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company }
|
|
149
|
+
|
|
150
|
+
# @!attribute directory
|
|
151
|
+
#
|
|
152
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory, nil]
|
|
153
|
+
optional :directory,
|
|
154
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory }
|
|
155
|
+
|
|
156
|
+
# @!attribute employment
|
|
157
|
+
#
|
|
158
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment, nil]
|
|
159
|
+
optional :employment,
|
|
160
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment }
|
|
161
|
+
|
|
162
|
+
# @!attribute individual
|
|
163
|
+
#
|
|
164
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual, nil]
|
|
165
|
+
optional :individual,
|
|
166
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual }
|
|
167
|
+
|
|
168
|
+
# @!attribute pay_group
|
|
169
|
+
#
|
|
170
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayGroup, nil]
|
|
171
|
+
optional :pay_group,
|
|
172
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayGroup }
|
|
173
|
+
|
|
174
|
+
# @!attribute pay_statement
|
|
175
|
+
#
|
|
176
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement, nil]
|
|
177
|
+
optional :pay_statement,
|
|
178
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement }
|
|
179
|
+
|
|
180
|
+
# @!attribute payment
|
|
181
|
+
#
|
|
182
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Payment, nil]
|
|
183
|
+
optional :payment,
|
|
184
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Payment }
|
|
185
|
+
|
|
186
|
+
# @!attribute plan_dependents
|
|
187
|
+
#
|
|
188
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents, nil]
|
|
189
|
+
optional :plan_dependents,
|
|
190
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents }
|
|
191
|
+
|
|
192
|
+
# @!attribute plan_enrollments
|
|
193
|
+
#
|
|
194
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments, nil]
|
|
195
|
+
optional :plan_enrollments,
|
|
196
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments }
|
|
197
|
+
|
|
198
|
+
# @!attribute plans
|
|
199
|
+
#
|
|
200
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Plans, nil]
|
|
201
|
+
optional :plans,
|
|
202
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Plans }
|
|
203
|
+
|
|
204
|
+
# @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil, plan_dependents: nil, plan_enrollments: nil, plans: nil)
|
|
205
|
+
# The supported data fields returned by our HR, payroll, and benefits endpoints
|
|
206
|
+
#
|
|
207
|
+
# @param company [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company]
|
|
208
|
+
# @param directory [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory]
|
|
209
|
+
# @param employment [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment]
|
|
210
|
+
# @param individual [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual]
|
|
211
|
+
# @param pay_group [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayGroup]
|
|
212
|
+
# @param pay_statement [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement]
|
|
213
|
+
# @param payment [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Payment]
|
|
214
|
+
# @param plan_dependents [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents]
|
|
215
|
+
# @param plan_enrollments [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments]
|
|
216
|
+
# @param plans [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Plans]
|
|
217
|
+
|
|
218
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#company
|
|
219
|
+
class Company < FinchAPI::Internal::Type::BaseModel
|
|
220
|
+
# @!attribute id
|
|
221
|
+
#
|
|
222
|
+
# @return [Boolean, nil]
|
|
223
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
224
|
+
|
|
225
|
+
# @!attribute accounts
|
|
226
|
+
#
|
|
227
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Accounts, nil]
|
|
228
|
+
optional :accounts,
|
|
229
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Accounts }
|
|
230
|
+
|
|
231
|
+
# @!attribute departments
|
|
232
|
+
#
|
|
233
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Departments, nil]
|
|
234
|
+
optional :departments,
|
|
235
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Departments }
|
|
236
|
+
|
|
237
|
+
# @!attribute ein
|
|
238
|
+
#
|
|
239
|
+
# @return [Boolean, nil]
|
|
240
|
+
optional :ein, FinchAPI::Internal::Type::Boolean
|
|
241
|
+
|
|
242
|
+
# @!attribute entity
|
|
243
|
+
#
|
|
244
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Entity, nil]
|
|
245
|
+
optional :entity,
|
|
246
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Entity }
|
|
247
|
+
|
|
248
|
+
# @!attribute legal_name
|
|
249
|
+
#
|
|
250
|
+
# @return [Boolean, nil]
|
|
251
|
+
optional :legal_name, FinchAPI::Internal::Type::Boolean
|
|
252
|
+
|
|
253
|
+
# @!attribute locations
|
|
254
|
+
#
|
|
255
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Locations, nil]
|
|
256
|
+
optional :locations,
|
|
257
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Locations }
|
|
258
|
+
|
|
259
|
+
# @!attribute primary_email
|
|
260
|
+
#
|
|
261
|
+
# @return [Boolean, nil]
|
|
262
|
+
optional :primary_email, FinchAPI::Internal::Type::Boolean
|
|
263
|
+
|
|
264
|
+
# @!attribute primary_phone_number
|
|
265
|
+
#
|
|
266
|
+
# @return [Boolean, nil]
|
|
267
|
+
optional :primary_phone_number, FinchAPI::Internal::Type::Boolean
|
|
268
|
+
|
|
269
|
+
# @!method initialize(id: nil, accounts: nil, departments: nil, ein: nil, entity: nil, legal_name: nil, locations: nil, primary_email: nil, primary_phone_number: nil)
|
|
270
|
+
# @param id [Boolean]
|
|
271
|
+
# @param accounts [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Accounts]
|
|
272
|
+
# @param departments [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Departments]
|
|
273
|
+
# @param ein [Boolean]
|
|
274
|
+
# @param entity [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Entity]
|
|
275
|
+
# @param legal_name [Boolean]
|
|
276
|
+
# @param locations [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Locations]
|
|
277
|
+
# @param primary_email [Boolean]
|
|
278
|
+
# @param primary_phone_number [Boolean]
|
|
279
|
+
|
|
280
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company#accounts
|
|
281
|
+
class Accounts < FinchAPI::Internal::Type::BaseModel
|
|
282
|
+
# @!attribute account_name
|
|
283
|
+
#
|
|
284
|
+
# @return [Boolean, nil]
|
|
285
|
+
optional :account_name, FinchAPI::Internal::Type::Boolean
|
|
286
|
+
|
|
287
|
+
# @!attribute account_number
|
|
288
|
+
#
|
|
289
|
+
# @return [Boolean, nil]
|
|
290
|
+
optional :account_number, FinchAPI::Internal::Type::Boolean
|
|
291
|
+
|
|
292
|
+
# @!attribute account_type
|
|
293
|
+
#
|
|
294
|
+
# @return [Boolean, nil]
|
|
295
|
+
optional :account_type, FinchAPI::Internal::Type::Boolean
|
|
296
|
+
|
|
297
|
+
# @!attribute institution_name
|
|
298
|
+
#
|
|
299
|
+
# @return [Boolean, nil]
|
|
300
|
+
optional :institution_name, FinchAPI::Internal::Type::Boolean
|
|
301
|
+
|
|
302
|
+
# @!attribute routing_number
|
|
303
|
+
#
|
|
304
|
+
# @return [Boolean, nil]
|
|
305
|
+
optional :routing_number, FinchAPI::Internal::Type::Boolean
|
|
306
|
+
|
|
307
|
+
# @!method initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil)
|
|
308
|
+
# @param account_name [Boolean]
|
|
309
|
+
# @param account_number [Boolean]
|
|
310
|
+
# @param account_type [Boolean]
|
|
311
|
+
# @param institution_name [Boolean]
|
|
312
|
+
# @param routing_number [Boolean]
|
|
313
|
+
end
|
|
314
|
+
|
|
315
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company#departments
|
|
316
|
+
class Departments < FinchAPI::Internal::Type::BaseModel
|
|
317
|
+
# @!attribute name
|
|
318
|
+
#
|
|
319
|
+
# @return [Boolean, nil]
|
|
320
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
321
|
+
|
|
322
|
+
# @!attribute parent
|
|
323
|
+
#
|
|
324
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil]
|
|
325
|
+
optional :parent,
|
|
326
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Departments::Parent }
|
|
327
|
+
|
|
328
|
+
# @!method initialize(name: nil, parent: nil)
|
|
329
|
+
# @param name [Boolean]
|
|
330
|
+
# @param parent [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Departments::Parent]
|
|
331
|
+
|
|
332
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company::Departments#parent
|
|
333
|
+
class Parent < FinchAPI::Internal::Type::BaseModel
|
|
334
|
+
# @!attribute name
|
|
335
|
+
#
|
|
336
|
+
# @return [Boolean, nil]
|
|
337
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
338
|
+
|
|
339
|
+
# @!method initialize(name: nil)
|
|
340
|
+
# @param name [Boolean]
|
|
341
|
+
end
|
|
342
|
+
end
|
|
343
|
+
|
|
344
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company#entity
|
|
345
|
+
class Entity < FinchAPI::Internal::Type::BaseModel
|
|
346
|
+
# @!attribute subtype
|
|
347
|
+
#
|
|
348
|
+
# @return [Boolean, nil]
|
|
349
|
+
optional :subtype, FinchAPI::Internal::Type::Boolean
|
|
350
|
+
|
|
351
|
+
# @!attribute type
|
|
352
|
+
#
|
|
353
|
+
# @return [Boolean, nil]
|
|
354
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
355
|
+
|
|
356
|
+
# @!method initialize(subtype: nil, type: nil)
|
|
357
|
+
# @param subtype [Boolean]
|
|
358
|
+
# @param type [Boolean]
|
|
359
|
+
end
|
|
360
|
+
|
|
361
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Company#locations
|
|
362
|
+
class Locations < FinchAPI::Internal::Type::BaseModel
|
|
363
|
+
# @!attribute city
|
|
364
|
+
#
|
|
365
|
+
# @return [Boolean, nil]
|
|
366
|
+
optional :city, FinchAPI::Internal::Type::Boolean
|
|
367
|
+
|
|
368
|
+
# @!attribute country
|
|
369
|
+
#
|
|
370
|
+
# @return [Boolean, nil]
|
|
371
|
+
optional :country, FinchAPI::Internal::Type::Boolean
|
|
372
|
+
|
|
373
|
+
# @!attribute line1
|
|
374
|
+
#
|
|
375
|
+
# @return [Boolean, nil]
|
|
376
|
+
optional :line1, FinchAPI::Internal::Type::Boolean
|
|
377
|
+
|
|
378
|
+
# @!attribute line2
|
|
379
|
+
#
|
|
380
|
+
# @return [Boolean, nil]
|
|
381
|
+
optional :line2, FinchAPI::Internal::Type::Boolean
|
|
382
|
+
|
|
383
|
+
# @!attribute postal_code
|
|
384
|
+
#
|
|
385
|
+
# @return [Boolean, nil]
|
|
386
|
+
optional :postal_code, FinchAPI::Internal::Type::Boolean
|
|
387
|
+
|
|
388
|
+
# @!attribute state
|
|
389
|
+
#
|
|
390
|
+
# @return [Boolean, nil]
|
|
391
|
+
optional :state, FinchAPI::Internal::Type::Boolean
|
|
392
|
+
|
|
393
|
+
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
|
394
|
+
# @param city [Boolean]
|
|
395
|
+
# @param country [Boolean]
|
|
396
|
+
# @param line1 [Boolean]
|
|
397
|
+
# @param line2 [Boolean]
|
|
398
|
+
# @param postal_code [Boolean]
|
|
399
|
+
# @param state [Boolean]
|
|
400
|
+
end
|
|
401
|
+
end
|
|
402
|
+
|
|
403
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#directory
|
|
404
|
+
class Directory < FinchAPI::Internal::Type::BaseModel
|
|
405
|
+
# @!attribute individuals
|
|
406
|
+
#
|
|
407
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Individuals, nil]
|
|
408
|
+
optional :individuals,
|
|
409
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Individuals }
|
|
410
|
+
|
|
411
|
+
# @!attribute paging
|
|
412
|
+
#
|
|
413
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Paging, nil]
|
|
414
|
+
optional :paging,
|
|
415
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Paging }
|
|
416
|
+
|
|
417
|
+
# @!method initialize(individuals: nil, paging: nil)
|
|
418
|
+
# @param individuals [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Individuals]
|
|
419
|
+
# @param paging [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Paging]
|
|
420
|
+
|
|
421
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory#individuals
|
|
422
|
+
class Individuals < FinchAPI::Internal::Type::BaseModel
|
|
423
|
+
# @!attribute id
|
|
424
|
+
#
|
|
425
|
+
# @return [Boolean, nil]
|
|
426
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
427
|
+
|
|
428
|
+
# @!attribute department
|
|
429
|
+
#
|
|
430
|
+
# @return [Boolean, nil]
|
|
431
|
+
optional :department, FinchAPI::Internal::Type::Boolean, nil?: true
|
|
432
|
+
|
|
433
|
+
# @!attribute first_name
|
|
434
|
+
#
|
|
435
|
+
# @return [Boolean, nil]
|
|
436
|
+
optional :first_name, FinchAPI::Internal::Type::Boolean
|
|
437
|
+
|
|
438
|
+
# @!attribute is_active
|
|
439
|
+
#
|
|
440
|
+
# @return [Boolean, nil]
|
|
441
|
+
optional :is_active, FinchAPI::Internal::Type::Boolean
|
|
442
|
+
|
|
443
|
+
# @!attribute last_name
|
|
444
|
+
#
|
|
445
|
+
# @return [Boolean, nil]
|
|
446
|
+
optional :last_name, FinchAPI::Internal::Type::Boolean
|
|
447
|
+
|
|
448
|
+
# @!attribute manager
|
|
449
|
+
#
|
|
450
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil]
|
|
451
|
+
optional :manager,
|
|
452
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager }
|
|
453
|
+
|
|
454
|
+
# @!attribute middle_name
|
|
455
|
+
#
|
|
456
|
+
# @return [Boolean, nil]
|
|
457
|
+
optional :middle_name, FinchAPI::Internal::Type::Boolean
|
|
458
|
+
|
|
459
|
+
# @!method initialize(id: nil, department: nil, first_name: nil, is_active: nil, last_name: nil, manager: nil, middle_name: nil)
|
|
460
|
+
# @param id [Boolean]
|
|
461
|
+
# @param department [Boolean, nil]
|
|
462
|
+
# @param first_name [Boolean]
|
|
463
|
+
# @param is_active [Boolean]
|
|
464
|
+
# @param last_name [Boolean]
|
|
465
|
+
# @param manager [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager]
|
|
466
|
+
# @param middle_name [Boolean]
|
|
467
|
+
|
|
468
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory::Individuals#manager
|
|
469
|
+
class Manager < FinchAPI::Internal::Type::BaseModel
|
|
470
|
+
# @!attribute id
|
|
471
|
+
#
|
|
472
|
+
# @return [Boolean, nil]
|
|
473
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
474
|
+
|
|
475
|
+
# @!method initialize(id: nil)
|
|
476
|
+
# @param id [Boolean]
|
|
477
|
+
end
|
|
478
|
+
end
|
|
479
|
+
|
|
480
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Directory#paging
|
|
481
|
+
class Paging < FinchAPI::Internal::Type::BaseModel
|
|
482
|
+
# @!attribute count
|
|
483
|
+
#
|
|
484
|
+
# @return [Boolean, nil]
|
|
485
|
+
optional :count, FinchAPI::Internal::Type::Boolean
|
|
486
|
+
|
|
487
|
+
# @!attribute offset
|
|
488
|
+
#
|
|
489
|
+
# @return [Boolean, nil]
|
|
490
|
+
optional :offset, FinchAPI::Internal::Type::Boolean
|
|
491
|
+
|
|
492
|
+
# @!method initialize(count: nil, offset: nil)
|
|
493
|
+
# @param count [Boolean]
|
|
494
|
+
# @param offset [Boolean]
|
|
495
|
+
end
|
|
496
|
+
end
|
|
497
|
+
|
|
498
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#employment
|
|
499
|
+
class Employment < FinchAPI::Internal::Type::BaseModel
|
|
500
|
+
# @!attribute id
|
|
501
|
+
#
|
|
502
|
+
# @return [Boolean, nil]
|
|
503
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
504
|
+
|
|
505
|
+
# @!attribute class_code
|
|
506
|
+
#
|
|
507
|
+
# @return [Boolean, nil]
|
|
508
|
+
optional :class_code, FinchAPI::Internal::Type::Boolean
|
|
509
|
+
|
|
510
|
+
# @!attribute custom_fields
|
|
511
|
+
#
|
|
512
|
+
# @return [Boolean, nil]
|
|
513
|
+
optional :custom_fields, FinchAPI::Internal::Type::Boolean
|
|
514
|
+
|
|
515
|
+
# @!attribute department
|
|
516
|
+
#
|
|
517
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Department, nil]
|
|
518
|
+
optional :department,
|
|
519
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Department }
|
|
520
|
+
|
|
521
|
+
# @!attribute employment
|
|
522
|
+
#
|
|
523
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Employment, nil]
|
|
524
|
+
optional :employment,
|
|
525
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Employment }
|
|
526
|
+
|
|
527
|
+
# @!attribute employment_status
|
|
528
|
+
#
|
|
529
|
+
# @return [Boolean, nil]
|
|
530
|
+
optional :employment_status, FinchAPI::Internal::Type::Boolean
|
|
531
|
+
|
|
532
|
+
# @!attribute end_date
|
|
533
|
+
#
|
|
534
|
+
# @return [Boolean, nil]
|
|
535
|
+
optional :end_date, FinchAPI::Internal::Type::Boolean
|
|
536
|
+
|
|
537
|
+
# @!attribute first_name
|
|
538
|
+
#
|
|
539
|
+
# @return [Boolean, nil]
|
|
540
|
+
optional :first_name, FinchAPI::Internal::Type::Boolean
|
|
541
|
+
|
|
542
|
+
# @!attribute income
|
|
543
|
+
#
|
|
544
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Income, nil]
|
|
545
|
+
optional :income,
|
|
546
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Income }
|
|
547
|
+
|
|
548
|
+
# @!attribute income_history
|
|
549
|
+
#
|
|
550
|
+
# @return [Boolean, nil]
|
|
551
|
+
optional :income_history, FinchAPI::Internal::Type::Boolean
|
|
552
|
+
|
|
553
|
+
# @!attribute is_active
|
|
554
|
+
#
|
|
555
|
+
# @return [Boolean, nil]
|
|
556
|
+
optional :is_active, FinchAPI::Internal::Type::Boolean
|
|
557
|
+
|
|
558
|
+
# @!attribute last_name
|
|
559
|
+
#
|
|
560
|
+
# @return [Boolean, nil]
|
|
561
|
+
optional :last_name, FinchAPI::Internal::Type::Boolean
|
|
562
|
+
|
|
563
|
+
# @!attribute location
|
|
564
|
+
#
|
|
565
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Location, nil]
|
|
566
|
+
optional :location,
|
|
567
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Location }
|
|
568
|
+
|
|
569
|
+
# @!attribute manager
|
|
570
|
+
#
|
|
571
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
|
|
572
|
+
optional :manager,
|
|
573
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Manager },
|
|
574
|
+
nil?: true
|
|
575
|
+
|
|
576
|
+
# @!attribute middle_name
|
|
577
|
+
#
|
|
578
|
+
# @return [Boolean, nil]
|
|
579
|
+
optional :middle_name, FinchAPI::Internal::Type::Boolean
|
|
580
|
+
|
|
581
|
+
# @!attribute start_date
|
|
582
|
+
#
|
|
583
|
+
# @return [Boolean, nil]
|
|
584
|
+
optional :start_date, FinchAPI::Internal::Type::Boolean
|
|
585
|
+
|
|
586
|
+
# @!attribute title
|
|
587
|
+
#
|
|
588
|
+
# @return [Boolean, nil]
|
|
589
|
+
optional :title, FinchAPI::Internal::Type::Boolean
|
|
590
|
+
|
|
591
|
+
# @!method initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, location: nil, manager: nil, middle_name: nil, start_date: nil, title: nil)
|
|
592
|
+
# @param id [Boolean]
|
|
593
|
+
# @param class_code [Boolean]
|
|
594
|
+
# @param custom_fields [Boolean]
|
|
595
|
+
# @param department [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Department]
|
|
596
|
+
# @param employment [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Employment]
|
|
597
|
+
# @param employment_status [Boolean]
|
|
598
|
+
# @param end_date [Boolean]
|
|
599
|
+
# @param first_name [Boolean]
|
|
600
|
+
# @param income [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Income]
|
|
601
|
+
# @param income_history [Boolean]
|
|
602
|
+
# @param is_active [Boolean]
|
|
603
|
+
# @param last_name [Boolean]
|
|
604
|
+
# @param location [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Location]
|
|
605
|
+
# @param manager [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
|
|
606
|
+
# @param middle_name [Boolean]
|
|
607
|
+
# @param start_date [Boolean]
|
|
608
|
+
# @param title [Boolean]
|
|
609
|
+
|
|
610
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment#department
|
|
611
|
+
class Department < FinchAPI::Internal::Type::BaseModel
|
|
612
|
+
# @!attribute name
|
|
613
|
+
#
|
|
614
|
+
# @return [Boolean, nil]
|
|
615
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
616
|
+
|
|
617
|
+
# @!method initialize(name: nil)
|
|
618
|
+
# @param name [Boolean]
|
|
619
|
+
end
|
|
620
|
+
|
|
621
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment#employment
|
|
622
|
+
class Employment < FinchAPI::Internal::Type::BaseModel
|
|
623
|
+
# @!attribute subtype
|
|
624
|
+
#
|
|
625
|
+
# @return [Boolean, nil]
|
|
626
|
+
optional :subtype, FinchAPI::Internal::Type::Boolean
|
|
627
|
+
|
|
628
|
+
# @!attribute type
|
|
629
|
+
#
|
|
630
|
+
# @return [Boolean, nil]
|
|
631
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
632
|
+
|
|
633
|
+
# @!method initialize(subtype: nil, type: nil)
|
|
634
|
+
# @param subtype [Boolean]
|
|
635
|
+
# @param type [Boolean]
|
|
636
|
+
end
|
|
637
|
+
|
|
638
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment#income
|
|
639
|
+
class Income < FinchAPI::Internal::Type::BaseModel
|
|
640
|
+
# @!attribute amount
|
|
641
|
+
#
|
|
642
|
+
# @return [Boolean, nil]
|
|
643
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
644
|
+
|
|
645
|
+
# @!attribute currency
|
|
646
|
+
#
|
|
647
|
+
# @return [Boolean, nil]
|
|
648
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
649
|
+
|
|
650
|
+
# @!attribute unit
|
|
651
|
+
#
|
|
652
|
+
# @return [Boolean, nil]
|
|
653
|
+
optional :unit, FinchAPI::Internal::Type::Boolean
|
|
654
|
+
|
|
655
|
+
# @!method initialize(amount: nil, currency: nil, unit: nil)
|
|
656
|
+
# @param amount [Boolean]
|
|
657
|
+
# @param currency [Boolean]
|
|
658
|
+
# @param unit [Boolean]
|
|
659
|
+
end
|
|
660
|
+
|
|
661
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment#location
|
|
662
|
+
class Location < FinchAPI::Internal::Type::BaseModel
|
|
663
|
+
# @!attribute city
|
|
664
|
+
#
|
|
665
|
+
# @return [Boolean, nil]
|
|
666
|
+
optional :city, FinchAPI::Internal::Type::Boolean
|
|
667
|
+
|
|
668
|
+
# @!attribute country
|
|
669
|
+
#
|
|
670
|
+
# @return [Boolean, nil]
|
|
671
|
+
optional :country, FinchAPI::Internal::Type::Boolean
|
|
672
|
+
|
|
673
|
+
# @!attribute line1
|
|
674
|
+
#
|
|
675
|
+
# @return [Boolean, nil]
|
|
676
|
+
optional :line1, FinchAPI::Internal::Type::Boolean
|
|
677
|
+
|
|
678
|
+
# @!attribute line2
|
|
679
|
+
#
|
|
680
|
+
# @return [Boolean, nil]
|
|
681
|
+
optional :line2, FinchAPI::Internal::Type::Boolean
|
|
682
|
+
|
|
683
|
+
# @!attribute postal_code
|
|
684
|
+
#
|
|
685
|
+
# @return [Boolean, nil]
|
|
686
|
+
optional :postal_code, FinchAPI::Internal::Type::Boolean
|
|
687
|
+
|
|
688
|
+
# @!attribute state
|
|
689
|
+
#
|
|
690
|
+
# @return [Boolean, nil]
|
|
691
|
+
optional :state, FinchAPI::Internal::Type::Boolean
|
|
692
|
+
|
|
693
|
+
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
|
694
|
+
# @param city [Boolean]
|
|
695
|
+
# @param country [Boolean]
|
|
696
|
+
# @param line1 [Boolean]
|
|
697
|
+
# @param line2 [Boolean]
|
|
698
|
+
# @param postal_code [Boolean]
|
|
699
|
+
# @param state [Boolean]
|
|
700
|
+
end
|
|
701
|
+
|
|
702
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Employment#manager
|
|
703
|
+
class Manager < FinchAPI::Internal::Type::BaseModel
|
|
704
|
+
# @!attribute id
|
|
705
|
+
#
|
|
706
|
+
# @return [Boolean, nil]
|
|
707
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
708
|
+
|
|
709
|
+
# @!method initialize(id: nil)
|
|
710
|
+
# @param id [Boolean]
|
|
711
|
+
end
|
|
712
|
+
end
|
|
713
|
+
|
|
714
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#individual
|
|
715
|
+
class Individual < FinchAPI::Internal::Type::BaseModel
|
|
716
|
+
# @!attribute id
|
|
717
|
+
#
|
|
718
|
+
# @return [Boolean, nil]
|
|
719
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
720
|
+
|
|
721
|
+
# @!attribute dob
|
|
722
|
+
#
|
|
723
|
+
# @return [Boolean, nil]
|
|
724
|
+
optional :dob, FinchAPI::Internal::Type::Boolean
|
|
725
|
+
|
|
726
|
+
# @!attribute emails
|
|
727
|
+
#
|
|
728
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::Emails, nil]
|
|
729
|
+
optional :emails,
|
|
730
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::Emails }
|
|
731
|
+
|
|
732
|
+
# @!attribute encrypted_ssn
|
|
733
|
+
#
|
|
734
|
+
# @return [Boolean, nil]
|
|
735
|
+
optional :encrypted_ssn, FinchAPI::Internal::Type::Boolean
|
|
736
|
+
|
|
737
|
+
# @!attribute ethnicity
|
|
738
|
+
#
|
|
739
|
+
# @return [Boolean, nil]
|
|
740
|
+
optional :ethnicity, FinchAPI::Internal::Type::Boolean
|
|
741
|
+
|
|
742
|
+
# @!attribute first_name
|
|
743
|
+
#
|
|
744
|
+
# @return [Boolean, nil]
|
|
745
|
+
optional :first_name, FinchAPI::Internal::Type::Boolean
|
|
746
|
+
|
|
747
|
+
# @!attribute gender
|
|
748
|
+
#
|
|
749
|
+
# @return [Boolean, nil]
|
|
750
|
+
optional :gender, FinchAPI::Internal::Type::Boolean
|
|
751
|
+
|
|
752
|
+
# @!attribute last_name
|
|
753
|
+
#
|
|
754
|
+
# @return [Boolean, nil]
|
|
755
|
+
optional :last_name, FinchAPI::Internal::Type::Boolean
|
|
756
|
+
|
|
757
|
+
# @!attribute middle_name
|
|
758
|
+
#
|
|
759
|
+
# @return [Boolean, nil]
|
|
760
|
+
optional :middle_name, FinchAPI::Internal::Type::Boolean
|
|
761
|
+
|
|
762
|
+
# @!attribute phone_numbers
|
|
763
|
+
#
|
|
764
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil]
|
|
765
|
+
optional :phone_numbers,
|
|
766
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers }
|
|
767
|
+
|
|
768
|
+
# @!attribute preferred_name
|
|
769
|
+
#
|
|
770
|
+
# @return [Boolean, nil]
|
|
771
|
+
optional :preferred_name, FinchAPI::Internal::Type::Boolean
|
|
772
|
+
|
|
773
|
+
# @!attribute residence
|
|
774
|
+
#
|
|
775
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::Residence, nil]
|
|
776
|
+
optional :residence,
|
|
777
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::Residence }
|
|
778
|
+
|
|
779
|
+
# @!attribute ssn
|
|
780
|
+
#
|
|
781
|
+
# @return [Boolean, nil]
|
|
782
|
+
optional :ssn, FinchAPI::Internal::Type::Boolean
|
|
783
|
+
|
|
784
|
+
# @!method initialize(id: nil, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil)
|
|
785
|
+
# @param id [Boolean]
|
|
786
|
+
# @param dob [Boolean]
|
|
787
|
+
# @param emails [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::Emails]
|
|
788
|
+
# @param encrypted_ssn [Boolean]
|
|
789
|
+
# @param ethnicity [Boolean]
|
|
790
|
+
# @param first_name [Boolean]
|
|
791
|
+
# @param gender [Boolean]
|
|
792
|
+
# @param last_name [Boolean]
|
|
793
|
+
# @param middle_name [Boolean]
|
|
794
|
+
# @param phone_numbers [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers]
|
|
795
|
+
# @param preferred_name [Boolean]
|
|
796
|
+
# @param residence [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual::Residence]
|
|
797
|
+
# @param ssn [Boolean]
|
|
798
|
+
|
|
799
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual#emails
|
|
800
|
+
class Emails < FinchAPI::Internal::Type::BaseModel
|
|
801
|
+
# @!attribute data
|
|
802
|
+
#
|
|
803
|
+
# @return [Boolean, nil]
|
|
804
|
+
optional :data, FinchAPI::Internal::Type::Boolean
|
|
805
|
+
|
|
806
|
+
# @!attribute type
|
|
807
|
+
#
|
|
808
|
+
# @return [Boolean, nil]
|
|
809
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
810
|
+
|
|
811
|
+
# @!method initialize(data: nil, type: nil)
|
|
812
|
+
# @param data [Boolean]
|
|
813
|
+
# @param type [Boolean]
|
|
814
|
+
end
|
|
815
|
+
|
|
816
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual#phone_numbers
|
|
817
|
+
class PhoneNumbers < FinchAPI::Internal::Type::BaseModel
|
|
818
|
+
# @!attribute data
|
|
819
|
+
#
|
|
820
|
+
# @return [Boolean, nil]
|
|
821
|
+
optional :data, FinchAPI::Internal::Type::Boolean
|
|
822
|
+
|
|
823
|
+
# @!attribute type
|
|
824
|
+
#
|
|
825
|
+
# @return [Boolean, nil]
|
|
826
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
827
|
+
|
|
828
|
+
# @!method initialize(data: nil, type: nil)
|
|
829
|
+
# @param data [Boolean]
|
|
830
|
+
# @param type [Boolean]
|
|
831
|
+
end
|
|
832
|
+
|
|
833
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Individual#residence
|
|
834
|
+
class Residence < FinchAPI::Internal::Type::BaseModel
|
|
835
|
+
# @!attribute city
|
|
836
|
+
#
|
|
837
|
+
# @return [Boolean, nil]
|
|
838
|
+
optional :city, FinchAPI::Internal::Type::Boolean
|
|
839
|
+
|
|
840
|
+
# @!attribute country
|
|
841
|
+
#
|
|
842
|
+
# @return [Boolean, nil]
|
|
843
|
+
optional :country, FinchAPI::Internal::Type::Boolean
|
|
844
|
+
|
|
845
|
+
# @!attribute line1
|
|
846
|
+
#
|
|
847
|
+
# @return [Boolean, nil]
|
|
848
|
+
optional :line1, FinchAPI::Internal::Type::Boolean
|
|
849
|
+
|
|
850
|
+
# @!attribute line2
|
|
851
|
+
#
|
|
852
|
+
# @return [Boolean, nil]
|
|
853
|
+
optional :line2, FinchAPI::Internal::Type::Boolean
|
|
854
|
+
|
|
855
|
+
# @!attribute postal_code
|
|
856
|
+
#
|
|
857
|
+
# @return [Boolean, nil]
|
|
858
|
+
optional :postal_code, FinchAPI::Internal::Type::Boolean
|
|
859
|
+
|
|
860
|
+
# @!attribute state
|
|
861
|
+
#
|
|
862
|
+
# @return [Boolean, nil]
|
|
863
|
+
optional :state, FinchAPI::Internal::Type::Boolean
|
|
864
|
+
|
|
865
|
+
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
|
866
|
+
# @param city [Boolean]
|
|
867
|
+
# @param country [Boolean]
|
|
868
|
+
# @param line1 [Boolean]
|
|
869
|
+
# @param line2 [Boolean]
|
|
870
|
+
# @param postal_code [Boolean]
|
|
871
|
+
# @param state [Boolean]
|
|
872
|
+
end
|
|
873
|
+
end
|
|
874
|
+
|
|
875
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#pay_group
|
|
876
|
+
class PayGroup < FinchAPI::Internal::Type::BaseModel
|
|
877
|
+
# @!attribute id
|
|
878
|
+
#
|
|
879
|
+
# @return [Boolean, nil]
|
|
880
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
881
|
+
|
|
882
|
+
# @!attribute individual_ids
|
|
883
|
+
#
|
|
884
|
+
# @return [Boolean, nil]
|
|
885
|
+
optional :individual_ids, FinchAPI::Internal::Type::Boolean
|
|
886
|
+
|
|
887
|
+
# @!attribute name
|
|
888
|
+
#
|
|
889
|
+
# @return [Boolean, nil]
|
|
890
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
891
|
+
|
|
892
|
+
# @!attribute pay_frequencies
|
|
893
|
+
#
|
|
894
|
+
# @return [Boolean, nil]
|
|
895
|
+
optional :pay_frequencies, FinchAPI::Internal::Type::Boolean
|
|
896
|
+
|
|
897
|
+
# @!method initialize(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil)
|
|
898
|
+
# @param id [Boolean]
|
|
899
|
+
# @param individual_ids [Boolean]
|
|
900
|
+
# @param name [Boolean]
|
|
901
|
+
# @param pay_frequencies [Boolean]
|
|
902
|
+
end
|
|
903
|
+
|
|
904
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#pay_statement
|
|
905
|
+
class PayStatement < FinchAPI::Internal::Type::BaseModel
|
|
906
|
+
# @!attribute paging
|
|
907
|
+
#
|
|
908
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil]
|
|
909
|
+
optional :paging,
|
|
910
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::Paging }
|
|
911
|
+
|
|
912
|
+
# @!attribute pay_statements
|
|
913
|
+
#
|
|
914
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil]
|
|
915
|
+
optional :pay_statements,
|
|
916
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements }
|
|
917
|
+
|
|
918
|
+
# @!method initialize(paging: nil, pay_statements: nil)
|
|
919
|
+
# @param paging [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::Paging]
|
|
920
|
+
# @param pay_statements [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements]
|
|
921
|
+
|
|
922
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement#paging
|
|
923
|
+
class Paging < FinchAPI::Internal::Type::BaseModel
|
|
924
|
+
# @!attribute count
|
|
925
|
+
#
|
|
926
|
+
# @return [Boolean]
|
|
927
|
+
required :count, FinchAPI::Internal::Type::Boolean
|
|
928
|
+
|
|
929
|
+
# @!attribute offset
|
|
930
|
+
#
|
|
931
|
+
# @return [Boolean]
|
|
932
|
+
required :offset, FinchAPI::Internal::Type::Boolean
|
|
933
|
+
|
|
934
|
+
# @!method initialize(count:, offset:)
|
|
935
|
+
# @param count [Boolean]
|
|
936
|
+
# @param offset [Boolean]
|
|
937
|
+
end
|
|
938
|
+
|
|
939
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement#pay_statements
|
|
940
|
+
class PayStatements < FinchAPI::Internal::Type::BaseModel
|
|
941
|
+
# @!attribute earnings
|
|
942
|
+
#
|
|
943
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil]
|
|
944
|
+
optional :earnings,
|
|
945
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings }
|
|
946
|
+
|
|
947
|
+
# @!attribute employee_deductions
|
|
948
|
+
#
|
|
949
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil]
|
|
950
|
+
optional :employee_deductions,
|
|
951
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions }
|
|
952
|
+
|
|
953
|
+
# @!attribute employer_contributions
|
|
954
|
+
#
|
|
955
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil]
|
|
956
|
+
optional :employer_contributions,
|
|
957
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions }
|
|
958
|
+
|
|
959
|
+
# @!attribute gross_pay
|
|
960
|
+
#
|
|
961
|
+
# @return [Boolean, nil]
|
|
962
|
+
optional :gross_pay, FinchAPI::Internal::Type::Boolean
|
|
963
|
+
|
|
964
|
+
# @!attribute individual_id
|
|
965
|
+
#
|
|
966
|
+
# @return [Boolean, nil]
|
|
967
|
+
optional :individual_id, FinchAPI::Internal::Type::Boolean
|
|
968
|
+
|
|
969
|
+
# @!attribute net_pay
|
|
970
|
+
#
|
|
971
|
+
# @return [Boolean, nil]
|
|
972
|
+
optional :net_pay, FinchAPI::Internal::Type::Boolean
|
|
973
|
+
|
|
974
|
+
# @!attribute payment_method
|
|
975
|
+
#
|
|
976
|
+
# @return [Boolean, nil]
|
|
977
|
+
optional :payment_method, FinchAPI::Internal::Type::Boolean
|
|
978
|
+
|
|
979
|
+
# @!attribute taxes
|
|
980
|
+
#
|
|
981
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil]
|
|
982
|
+
optional :taxes,
|
|
983
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes }
|
|
984
|
+
|
|
985
|
+
# @!attribute total_hours
|
|
986
|
+
#
|
|
987
|
+
# @return [Boolean, nil]
|
|
988
|
+
optional :total_hours, FinchAPI::Internal::Type::Boolean
|
|
989
|
+
|
|
990
|
+
# @!attribute type
|
|
991
|
+
#
|
|
992
|
+
# @return [Boolean, nil]
|
|
993
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
994
|
+
|
|
995
|
+
# @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
|
|
996
|
+
# @param earnings [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings]
|
|
997
|
+
# @param employee_deductions [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions]
|
|
998
|
+
# @param employer_contributions [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions]
|
|
999
|
+
# @param gross_pay [Boolean]
|
|
1000
|
+
# @param individual_id [Boolean]
|
|
1001
|
+
# @param net_pay [Boolean]
|
|
1002
|
+
# @param payment_method [Boolean]
|
|
1003
|
+
# @param taxes [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes]
|
|
1004
|
+
# @param total_hours [Boolean]
|
|
1005
|
+
# @param type [Boolean]
|
|
1006
|
+
|
|
1007
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings
|
|
1008
|
+
class Earnings < FinchAPI::Internal::Type::BaseModel
|
|
1009
|
+
# @!attribute amount
|
|
1010
|
+
#
|
|
1011
|
+
# @return [Boolean, nil]
|
|
1012
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1013
|
+
|
|
1014
|
+
# @!attribute currency
|
|
1015
|
+
#
|
|
1016
|
+
# @return [Boolean, nil]
|
|
1017
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1018
|
+
|
|
1019
|
+
# @!attribute name
|
|
1020
|
+
#
|
|
1021
|
+
# @return [Boolean, nil]
|
|
1022
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1023
|
+
|
|
1024
|
+
# @!attribute type
|
|
1025
|
+
#
|
|
1026
|
+
# @return [Boolean, nil]
|
|
1027
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1028
|
+
|
|
1029
|
+
# @!method initialize(amount: nil, currency: nil, name: nil, type: nil)
|
|
1030
|
+
# @param amount [Boolean]
|
|
1031
|
+
# @param currency [Boolean]
|
|
1032
|
+
# @param name [Boolean]
|
|
1033
|
+
# @param type [Boolean]
|
|
1034
|
+
end
|
|
1035
|
+
|
|
1036
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions
|
|
1037
|
+
class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel
|
|
1038
|
+
# @!attribute amount
|
|
1039
|
+
#
|
|
1040
|
+
# @return [Boolean, nil]
|
|
1041
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1042
|
+
|
|
1043
|
+
# @!attribute currency
|
|
1044
|
+
#
|
|
1045
|
+
# @return [Boolean, nil]
|
|
1046
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1047
|
+
|
|
1048
|
+
# @!attribute name
|
|
1049
|
+
#
|
|
1050
|
+
# @return [Boolean, nil]
|
|
1051
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1052
|
+
|
|
1053
|
+
# @!attribute pre_tax
|
|
1054
|
+
#
|
|
1055
|
+
# @return [Boolean, nil]
|
|
1056
|
+
optional :pre_tax, FinchAPI::Internal::Type::Boolean
|
|
1057
|
+
|
|
1058
|
+
# @!attribute type
|
|
1059
|
+
#
|
|
1060
|
+
# @return [Boolean, nil]
|
|
1061
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1062
|
+
|
|
1063
|
+
# @!method initialize(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
|
|
1064
|
+
# @param amount [Boolean]
|
|
1065
|
+
# @param currency [Boolean]
|
|
1066
|
+
# @param name [Boolean]
|
|
1067
|
+
# @param pre_tax [Boolean]
|
|
1068
|
+
# @param type [Boolean]
|
|
1069
|
+
end
|
|
1070
|
+
|
|
1071
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions
|
|
1072
|
+
class EmployerContributions < FinchAPI::Internal::Type::BaseModel
|
|
1073
|
+
# @!attribute amount
|
|
1074
|
+
#
|
|
1075
|
+
# @return [Boolean, nil]
|
|
1076
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1077
|
+
|
|
1078
|
+
# @!attribute currency
|
|
1079
|
+
#
|
|
1080
|
+
# @return [Boolean, nil]
|
|
1081
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1082
|
+
|
|
1083
|
+
# @!attribute name
|
|
1084
|
+
#
|
|
1085
|
+
# @return [Boolean, nil]
|
|
1086
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1087
|
+
|
|
1088
|
+
# @!method initialize(amount: nil, currency: nil, name: nil)
|
|
1089
|
+
# @param amount [Boolean]
|
|
1090
|
+
# @param currency [Boolean]
|
|
1091
|
+
# @param name [Boolean]
|
|
1092
|
+
end
|
|
1093
|
+
|
|
1094
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes
|
|
1095
|
+
class Taxes < FinchAPI::Internal::Type::BaseModel
|
|
1096
|
+
# @!attribute amount
|
|
1097
|
+
#
|
|
1098
|
+
# @return [Boolean, nil]
|
|
1099
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1100
|
+
|
|
1101
|
+
# @!attribute currency
|
|
1102
|
+
#
|
|
1103
|
+
# @return [Boolean, nil]
|
|
1104
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1105
|
+
|
|
1106
|
+
# @!attribute employer
|
|
1107
|
+
#
|
|
1108
|
+
# @return [Boolean, nil]
|
|
1109
|
+
optional :employer, FinchAPI::Internal::Type::Boolean
|
|
1110
|
+
|
|
1111
|
+
# @!attribute name
|
|
1112
|
+
#
|
|
1113
|
+
# @return [Boolean, nil]
|
|
1114
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1115
|
+
|
|
1116
|
+
# @!attribute type
|
|
1117
|
+
#
|
|
1118
|
+
# @return [Boolean, nil]
|
|
1119
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1120
|
+
|
|
1121
|
+
# @!method initialize(amount: nil, currency: nil, employer: nil, name: nil, type: nil)
|
|
1122
|
+
# @param amount [Boolean]
|
|
1123
|
+
# @param currency [Boolean]
|
|
1124
|
+
# @param employer [Boolean]
|
|
1125
|
+
# @param name [Boolean]
|
|
1126
|
+
# @param type [Boolean]
|
|
1127
|
+
end
|
|
1128
|
+
end
|
|
1129
|
+
end
|
|
1130
|
+
|
|
1131
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#payment
|
|
1132
|
+
class Payment < FinchAPI::Internal::Type::BaseModel
|
|
1133
|
+
# @!attribute id
|
|
1134
|
+
#
|
|
1135
|
+
# @return [Boolean, nil]
|
|
1136
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1137
|
+
|
|
1138
|
+
# @!attribute company_debit
|
|
1139
|
+
#
|
|
1140
|
+
# @return [Boolean, nil]
|
|
1141
|
+
optional :company_debit, FinchAPI::Internal::Type::Boolean
|
|
1142
|
+
|
|
1143
|
+
# @!attribute debit_date
|
|
1144
|
+
#
|
|
1145
|
+
# @return [Boolean, nil]
|
|
1146
|
+
optional :debit_date, FinchAPI::Internal::Type::Boolean
|
|
1147
|
+
|
|
1148
|
+
# @!attribute employee_taxes
|
|
1149
|
+
#
|
|
1150
|
+
# @return [Boolean, nil]
|
|
1151
|
+
optional :employee_taxes, FinchAPI::Internal::Type::Boolean
|
|
1152
|
+
|
|
1153
|
+
# @!attribute employer_taxes
|
|
1154
|
+
#
|
|
1155
|
+
# @return [Boolean, nil]
|
|
1156
|
+
optional :employer_taxes, FinchAPI::Internal::Type::Boolean
|
|
1157
|
+
|
|
1158
|
+
# @!attribute gross_pay
|
|
1159
|
+
#
|
|
1160
|
+
# @return [Boolean, nil]
|
|
1161
|
+
optional :gross_pay, FinchAPI::Internal::Type::Boolean
|
|
1162
|
+
|
|
1163
|
+
# @!attribute individual_ids
|
|
1164
|
+
#
|
|
1165
|
+
# @return [Boolean, nil]
|
|
1166
|
+
optional :individual_ids, FinchAPI::Internal::Type::Boolean
|
|
1167
|
+
|
|
1168
|
+
# @!attribute net_pay
|
|
1169
|
+
#
|
|
1170
|
+
# @return [Boolean, nil]
|
|
1171
|
+
optional :net_pay, FinchAPI::Internal::Type::Boolean
|
|
1172
|
+
|
|
1173
|
+
# @!attribute pay_date
|
|
1174
|
+
#
|
|
1175
|
+
# @return [Boolean, nil]
|
|
1176
|
+
optional :pay_date, FinchAPI::Internal::Type::Boolean
|
|
1177
|
+
|
|
1178
|
+
# @!attribute pay_frequencies
|
|
1179
|
+
#
|
|
1180
|
+
# @return [Boolean, nil]
|
|
1181
|
+
optional :pay_frequencies, FinchAPI::Internal::Type::Boolean
|
|
1182
|
+
|
|
1183
|
+
# @!attribute pay_group_ids
|
|
1184
|
+
#
|
|
1185
|
+
# @return [Boolean, nil]
|
|
1186
|
+
optional :pay_group_ids, FinchAPI::Internal::Type::Boolean
|
|
1187
|
+
|
|
1188
|
+
# @!attribute pay_period
|
|
1189
|
+
#
|
|
1190
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil]
|
|
1191
|
+
optional :pay_period,
|
|
1192
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Payment::PayPeriod }
|
|
1193
|
+
|
|
1194
|
+
# @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil)
|
|
1195
|
+
# @param id [Boolean]
|
|
1196
|
+
# @param company_debit [Boolean]
|
|
1197
|
+
# @param debit_date [Boolean]
|
|
1198
|
+
# @param employee_taxes [Boolean]
|
|
1199
|
+
# @param employer_taxes [Boolean]
|
|
1200
|
+
# @param gross_pay [Boolean]
|
|
1201
|
+
# @param individual_ids [Boolean]
|
|
1202
|
+
# @param net_pay [Boolean]
|
|
1203
|
+
# @param pay_date [Boolean]
|
|
1204
|
+
# @param pay_frequencies [Boolean]
|
|
1205
|
+
# @param pay_group_ids [Boolean]
|
|
1206
|
+
# @param pay_period [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Payment::PayPeriod]
|
|
1207
|
+
|
|
1208
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Payment#pay_period
|
|
1209
|
+
class PayPeriod < FinchAPI::Internal::Type::BaseModel
|
|
1210
|
+
# @!attribute end_date
|
|
1211
|
+
#
|
|
1212
|
+
# @return [Boolean, nil]
|
|
1213
|
+
optional :end_date, FinchAPI::Internal::Type::Boolean
|
|
1214
|
+
|
|
1215
|
+
# @!attribute start_date
|
|
1216
|
+
#
|
|
1217
|
+
# @return [Boolean, nil]
|
|
1218
|
+
optional :start_date, FinchAPI::Internal::Type::Boolean
|
|
1219
|
+
|
|
1220
|
+
# @!method initialize(end_date: nil, start_date: nil)
|
|
1221
|
+
# @param end_date [Boolean]
|
|
1222
|
+
# @param start_date [Boolean]
|
|
1223
|
+
end
|
|
1224
|
+
end
|
|
1225
|
+
|
|
1226
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#plan_dependents
|
|
1227
|
+
class PlanDependents < FinchAPI::Internal::Type::BaseModel
|
|
1228
|
+
# @!attribute coverage
|
|
1229
|
+
#
|
|
1230
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents::Coverage, nil]
|
|
1231
|
+
optional :coverage,
|
|
1232
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents::Coverage }
|
|
1233
|
+
|
|
1234
|
+
# @!attribute date_of_birth
|
|
1235
|
+
#
|
|
1236
|
+
# @return [Boolean, nil]
|
|
1237
|
+
optional :date_of_birth, FinchAPI::Internal::Type::Boolean
|
|
1238
|
+
|
|
1239
|
+
# @!attribute dependent_id
|
|
1240
|
+
#
|
|
1241
|
+
# @return [Boolean, nil]
|
|
1242
|
+
optional :dependent_id, FinchAPI::Internal::Type::Boolean
|
|
1243
|
+
|
|
1244
|
+
# @!attribute first_name
|
|
1245
|
+
#
|
|
1246
|
+
# @return [Boolean, nil]
|
|
1247
|
+
optional :first_name, FinchAPI::Internal::Type::Boolean
|
|
1248
|
+
|
|
1249
|
+
# @!attribute gender
|
|
1250
|
+
#
|
|
1251
|
+
# @return [Boolean, nil]
|
|
1252
|
+
optional :gender, FinchAPI::Internal::Type::Boolean
|
|
1253
|
+
|
|
1254
|
+
# @!attribute last_name
|
|
1255
|
+
#
|
|
1256
|
+
# @return [Boolean, nil]
|
|
1257
|
+
optional :last_name, FinchAPI::Internal::Type::Boolean
|
|
1258
|
+
|
|
1259
|
+
# @!attribute middle_name
|
|
1260
|
+
#
|
|
1261
|
+
# @return [Boolean, nil]
|
|
1262
|
+
optional :middle_name, FinchAPI::Internal::Type::Boolean
|
|
1263
|
+
|
|
1264
|
+
# @!attribute ssn
|
|
1265
|
+
#
|
|
1266
|
+
# @return [Boolean, nil]
|
|
1267
|
+
optional :ssn, FinchAPI::Internal::Type::Boolean
|
|
1268
|
+
|
|
1269
|
+
# @!method initialize(coverage: nil, date_of_birth: nil, dependent_id: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, ssn: nil)
|
|
1270
|
+
# @param coverage [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents::Coverage]
|
|
1271
|
+
# @param date_of_birth [Boolean]
|
|
1272
|
+
# @param dependent_id [Boolean]
|
|
1273
|
+
# @param first_name [Boolean]
|
|
1274
|
+
# @param gender [Boolean]
|
|
1275
|
+
# @param last_name [Boolean]
|
|
1276
|
+
# @param middle_name [Boolean]
|
|
1277
|
+
# @param ssn [Boolean]
|
|
1278
|
+
|
|
1279
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents#coverage
|
|
1280
|
+
class Coverage < FinchAPI::Internal::Type::BaseModel
|
|
1281
|
+
# @!attribute enrollments
|
|
1282
|
+
#
|
|
1283
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments, nil]
|
|
1284
|
+
optional :enrollments,
|
|
1285
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments }
|
|
1286
|
+
|
|
1287
|
+
# @!attribute individual_id
|
|
1288
|
+
#
|
|
1289
|
+
# @return [Boolean, nil]
|
|
1290
|
+
optional :individual_id, FinchAPI::Internal::Type::Boolean
|
|
1291
|
+
|
|
1292
|
+
# @!attribute relationship_to_individual
|
|
1293
|
+
#
|
|
1294
|
+
# @return [Boolean, nil]
|
|
1295
|
+
optional :relationship_to_individual, FinchAPI::Internal::Type::Boolean
|
|
1296
|
+
|
|
1297
|
+
# @!method initialize(enrollments: nil, individual_id: nil, relationship_to_individual: nil)
|
|
1298
|
+
# @param enrollments [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments]
|
|
1299
|
+
# @param individual_id [Boolean]
|
|
1300
|
+
# @param relationship_to_individual [Boolean]
|
|
1301
|
+
|
|
1302
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanDependents::Coverage#enrollments
|
|
1303
|
+
class Enrollments < FinchAPI::Internal::Type::BaseModel
|
|
1304
|
+
# @!attribute id
|
|
1305
|
+
#
|
|
1306
|
+
# @return [Boolean, nil]
|
|
1307
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1308
|
+
|
|
1309
|
+
# @!attribute type
|
|
1310
|
+
#
|
|
1311
|
+
# @return [Boolean, nil]
|
|
1312
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1313
|
+
|
|
1314
|
+
# @!method initialize(id: nil, type: nil)
|
|
1315
|
+
# @param id [Boolean]
|
|
1316
|
+
# @param type [Boolean]
|
|
1317
|
+
end
|
|
1318
|
+
end
|
|
1319
|
+
end
|
|
1320
|
+
|
|
1321
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#plan_enrollments
|
|
1322
|
+
class PlanEnrollments < FinchAPI::Internal::Type::BaseModel
|
|
1323
|
+
# @!attribute id
|
|
1324
|
+
#
|
|
1325
|
+
# @return [Boolean, nil]
|
|
1326
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1327
|
+
|
|
1328
|
+
# @!attribute contributions
|
|
1329
|
+
#
|
|
1330
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions, nil]
|
|
1331
|
+
optional :contributions,
|
|
1332
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions }
|
|
1333
|
+
|
|
1334
|
+
# @!attribute coverage_end_date
|
|
1335
|
+
#
|
|
1336
|
+
# @return [Boolean, nil]
|
|
1337
|
+
optional :coverage_end_date, FinchAPI::Internal::Type::Boolean
|
|
1338
|
+
|
|
1339
|
+
# @!attribute coverage_start_date
|
|
1340
|
+
#
|
|
1341
|
+
# @return [Boolean, nil]
|
|
1342
|
+
optional :coverage_start_date, FinchAPI::Internal::Type::Boolean
|
|
1343
|
+
|
|
1344
|
+
# @!attribute coverage_tier
|
|
1345
|
+
#
|
|
1346
|
+
# @return [Boolean, nil]
|
|
1347
|
+
optional :coverage_tier, FinchAPI::Internal::Type::Boolean
|
|
1348
|
+
|
|
1349
|
+
# @!attribute dependent_ids
|
|
1350
|
+
#
|
|
1351
|
+
# @return [Boolean, nil]
|
|
1352
|
+
optional :dependent_ids, FinchAPI::Internal::Type::Boolean
|
|
1353
|
+
|
|
1354
|
+
# @!attribute individual_id
|
|
1355
|
+
#
|
|
1356
|
+
# @return [Boolean, nil]
|
|
1357
|
+
optional :individual_id, FinchAPI::Internal::Type::Boolean
|
|
1358
|
+
|
|
1359
|
+
# @!attribute plan_id
|
|
1360
|
+
#
|
|
1361
|
+
# @return [Boolean, nil]
|
|
1362
|
+
optional :plan_id, FinchAPI::Internal::Type::Boolean
|
|
1363
|
+
|
|
1364
|
+
# @!attribute status
|
|
1365
|
+
#
|
|
1366
|
+
# @return [Boolean, nil]
|
|
1367
|
+
optional :status, FinchAPI::Internal::Type::Boolean
|
|
1368
|
+
|
|
1369
|
+
# @!method initialize(id: nil, contributions: nil, coverage_end_date: nil, coverage_start_date: nil, coverage_tier: nil, dependent_ids: nil, individual_id: nil, plan_id: nil, status: nil)
|
|
1370
|
+
# @param id [Boolean]
|
|
1371
|
+
# @param contributions [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions]
|
|
1372
|
+
# @param coverage_end_date [Boolean]
|
|
1373
|
+
# @param coverage_start_date [Boolean]
|
|
1374
|
+
# @param coverage_tier [Boolean]
|
|
1375
|
+
# @param dependent_ids [Boolean]
|
|
1376
|
+
# @param individual_id [Boolean]
|
|
1377
|
+
# @param plan_id [Boolean]
|
|
1378
|
+
# @param status [Boolean]
|
|
1379
|
+
|
|
1380
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments#contributions
|
|
1381
|
+
class Contributions < FinchAPI::Internal::Type::BaseModel
|
|
1382
|
+
# @!attribute employee_contribution
|
|
1383
|
+
#
|
|
1384
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution, nil]
|
|
1385
|
+
optional :employee_contribution,
|
|
1386
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution }
|
|
1387
|
+
|
|
1388
|
+
# @!attribute employer_contribution
|
|
1389
|
+
#
|
|
1390
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution, nil]
|
|
1391
|
+
optional :employer_contribution,
|
|
1392
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution }
|
|
1393
|
+
|
|
1394
|
+
# @!attribute frequency
|
|
1395
|
+
#
|
|
1396
|
+
# @return [Boolean, nil]
|
|
1397
|
+
optional :frequency, FinchAPI::Internal::Type::Boolean
|
|
1398
|
+
|
|
1399
|
+
# @!method initialize(employee_contribution: nil, employer_contribution: nil, frequency: nil)
|
|
1400
|
+
# @param employee_contribution [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution]
|
|
1401
|
+
# @param employer_contribution [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution]
|
|
1402
|
+
# @param frequency [Boolean]
|
|
1403
|
+
|
|
1404
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions#employee_contribution
|
|
1405
|
+
class EmployeeContribution < FinchAPI::Internal::Type::BaseModel
|
|
1406
|
+
# @!attribute amount
|
|
1407
|
+
#
|
|
1408
|
+
# @return [Boolean, nil]
|
|
1409
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1410
|
+
|
|
1411
|
+
# @!attribute currency
|
|
1412
|
+
#
|
|
1413
|
+
# @return [Boolean, nil]
|
|
1414
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1415
|
+
|
|
1416
|
+
# @!method initialize(amount: nil, currency: nil)
|
|
1417
|
+
# @param amount [Boolean]
|
|
1418
|
+
# @param currency [Boolean]
|
|
1419
|
+
end
|
|
1420
|
+
|
|
1421
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions#employer_contribution
|
|
1422
|
+
class EmployerContribution < FinchAPI::Internal::Type::BaseModel
|
|
1423
|
+
# @!attribute amount
|
|
1424
|
+
#
|
|
1425
|
+
# @return [Boolean, nil]
|
|
1426
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1427
|
+
|
|
1428
|
+
# @!attribute currency
|
|
1429
|
+
#
|
|
1430
|
+
# @return [Boolean, nil]
|
|
1431
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1432
|
+
|
|
1433
|
+
# @!method initialize(amount: nil, currency: nil)
|
|
1434
|
+
# @param amount [Boolean]
|
|
1435
|
+
# @param currency [Boolean]
|
|
1436
|
+
end
|
|
1437
|
+
end
|
|
1438
|
+
end
|
|
1439
|
+
|
|
1440
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields#plans
|
|
1441
|
+
class Plans < FinchAPI::Internal::Type::BaseModel
|
|
1442
|
+
# @!attribute id
|
|
1443
|
+
#
|
|
1444
|
+
# @return [Boolean, nil]
|
|
1445
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1446
|
+
|
|
1447
|
+
# @!attribute carrier
|
|
1448
|
+
#
|
|
1449
|
+
# @return [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Plans::Carrier, nil]
|
|
1450
|
+
optional :carrier,
|
|
1451
|
+
-> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Plans::Carrier }
|
|
1452
|
+
|
|
1453
|
+
# @!attribute coverage_tiers
|
|
1454
|
+
#
|
|
1455
|
+
# @return [Boolean, nil]
|
|
1456
|
+
optional :coverage_tiers, FinchAPI::Internal::Type::Boolean
|
|
1457
|
+
|
|
1458
|
+
# @!attribute deduction_codes
|
|
1459
|
+
#
|
|
1460
|
+
# @return [Boolean, nil]
|
|
1461
|
+
optional :deduction_codes, FinchAPI::Internal::Type::Boolean
|
|
1462
|
+
|
|
1463
|
+
# @!attribute description
|
|
1464
|
+
#
|
|
1465
|
+
# @return [Boolean, nil]
|
|
1466
|
+
optional :description, FinchAPI::Internal::Type::Boolean
|
|
1467
|
+
|
|
1468
|
+
# @!attribute end_date
|
|
1469
|
+
#
|
|
1470
|
+
# @return [Boolean, nil]
|
|
1471
|
+
optional :end_date, FinchAPI::Internal::Type::Boolean
|
|
1472
|
+
|
|
1473
|
+
# @!attribute name
|
|
1474
|
+
#
|
|
1475
|
+
# @return [Boolean, nil]
|
|
1476
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1477
|
+
|
|
1478
|
+
# @!attribute network_type
|
|
1479
|
+
#
|
|
1480
|
+
# @return [Boolean, nil]
|
|
1481
|
+
optional :network_type, FinchAPI::Internal::Type::Boolean
|
|
1482
|
+
|
|
1483
|
+
# @!attribute start_date
|
|
1484
|
+
#
|
|
1485
|
+
# @return [Boolean, nil]
|
|
1486
|
+
optional :start_date, FinchAPI::Internal::Type::Boolean
|
|
1487
|
+
|
|
1488
|
+
# @!attribute type
|
|
1489
|
+
#
|
|
1490
|
+
# @return [Boolean, nil]
|
|
1491
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1492
|
+
|
|
1493
|
+
# @!method initialize(id: nil, carrier: nil, coverage_tiers: nil, deduction_codes: nil, description: nil, end_date: nil, name: nil, network_type: nil, start_date: nil, type: nil)
|
|
1494
|
+
# @param id [Boolean]
|
|
1495
|
+
# @param carrier [FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Plans::Carrier]
|
|
1496
|
+
# @param coverage_tiers [Boolean]
|
|
1497
|
+
# @param deduction_codes [Boolean]
|
|
1498
|
+
# @param description [Boolean]
|
|
1499
|
+
# @param end_date [Boolean]
|
|
1500
|
+
# @param name [Boolean]
|
|
1501
|
+
# @param network_type [Boolean]
|
|
1502
|
+
# @param start_date [Boolean]
|
|
1503
|
+
# @param type [Boolean]
|
|
1504
|
+
|
|
1505
|
+
# @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod::SupportedFields::Plans#carrier
|
|
1506
|
+
class Carrier < FinchAPI::Internal::Type::BaseModel
|
|
1507
|
+
# @!attribute id
|
|
1508
|
+
#
|
|
1509
|
+
# @return [Boolean, nil]
|
|
1510
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1511
|
+
|
|
1512
|
+
# @!attribute name
|
|
1513
|
+
#
|
|
1514
|
+
# @return [Boolean, nil]
|
|
1515
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1516
|
+
|
|
1517
|
+
# @!method initialize(id: nil, name: nil)
|
|
1518
|
+
# @param id [Boolean]
|
|
1519
|
+
# @param name [Boolean]
|
|
1520
|
+
end
|
|
1521
|
+
end
|
|
1522
|
+
end
|
|
140
1523
|
end
|
|
141
1524
|
end
|
|
142
1525
|
end
|