finch-api 0.1.0.pre.alpha.25 → 0.1.0.pre.alpha.27

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 (59) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -0
  3. data/README.md +1 -1
  4. data/lib/finch_api/client.rb +3 -1
  5. data/lib/finch_api/internal/transport/pooled_net_requester.rb +1 -9
  6. data/lib/finch_api/internal/type/array_of.rb +1 -0
  7. data/lib/finch_api/internal/type/base_model.rb +4 -9
  8. data/lib/finch_api/internal/type/converter.rb +27 -0
  9. data/lib/finch_api/internal/type/hash_of.rb +1 -0
  10. data/lib/finch_api/internal/type/union.rb +9 -7
  11. data/lib/finch_api/internal/util.rb +1 -1
  12. data/lib/finch_api/models/account_update_event.rb +28 -84
  13. data/lib/finch_api/models/disconnect_response.rb +2 -2
  14. data/lib/finch_api/models/hris/benefit_create_params.rb +1 -3
  15. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +6 -18
  16. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +3 -10
  17. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +1 -3
  18. data/lib/finch_api/models/hris/company_benefit.rb +1 -3
  19. data/lib/finch_api/models/hris/document_list_params.rb +1 -4
  20. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +1 -3
  21. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +1 -3
  22. data/lib/finch_api/models/hris/pay_statement.rb +1 -4
  23. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +1 -3
  24. data/lib/finch_api/models/jobs/automated_async_job.rb +1 -1
  25. data/lib/finch_api/models/jobs/automated_list_params.rb +14 -1
  26. data/lib/finch_api/models/jobs/automated_retrieve_params.rb +14 -1
  27. data/lib/finch_api/models/jobs/manual_async_job.rb +5 -3
  28. data/lib/finch_api/models/jobs/manual_retrieve_params.rb +14 -1
  29. data/lib/finch_api/models/provider.rb +19 -68
  30. data/lib/finch_api/models/request_forwarding_forward_response.rb +10 -10
  31. data/lib/finch_api/models/sandbox/connection_create_params.rb +1 -4
  32. data/lib/finch_api/models/sandbox/directory_create_params.rb +1 -4
  33. data/lib/finch_api/models/sandbox/payment_create_params.rb +7 -22
  34. data/lib/finch_api/resources/jobs/automated.rb +16 -3
  35. data/lib/finch_api/resources/jobs/manual.rb +10 -2
  36. data/lib/finch_api/resources/request_forwarding.rb +2 -2
  37. data/lib/finch_api/version.rb +1 -1
  38. data/rbi/finch_api/errors.rbi +2 -2
  39. data/rbi/finch_api/internal/type/converter.rbi +54 -0
  40. data/rbi/finch_api/internal/type/union.rbi +9 -2
  41. data/rbi/finch_api/models/disconnect_response.rbi +2 -2
  42. data/rbi/finch_api/models/jobs/automated_async_job.rbi +2 -2
  43. data/rbi/finch_api/models/jobs/automated_list_params.rbi +15 -0
  44. data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +25 -5
  45. data/rbi/finch_api/models/jobs/manual_async_job.rbi +3 -3
  46. data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +25 -5
  47. data/rbi/finch_api/models/request_forwarding_forward_response.rbi +14 -14
  48. data/rbi/finch_api/resources/jobs/automated.rbi +14 -1
  49. data/rbi/finch_api/resources/jobs/manual.rbi +9 -1
  50. data/rbi/finch_api/resources/request_forwarding.rbi +2 -2
  51. data/sig/finch_api/internal/type/converter.rbs +17 -0
  52. data/sig/finch_api/internal/type/union.rbs +2 -2
  53. data/sig/finch_api/models/jobs/automated_list_params.rbs +7 -1
  54. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +13 -3
  55. data/sig/finch_api/models/jobs/manual_async_job.rbs +4 -4
  56. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +13 -3
  57. data/sig/finch_api/resources/jobs/automated.rbs +2 -0
  58. data/sig/finch_api/resources/jobs/manual.rbs +1 -0
  59. metadata +2 -2
@@ -15,9 +15,7 @@ module FinchAPI
15
15
  #
16
16
  # @return [Array<Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category>, nil]
17
17
  optional :categories,
18
- -> {
19
- FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Company::PayStatementItemListParams::Category]
20
- }
18
+ -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Company::PayStatementItemListParams::Category] }
21
19
 
22
20
  # @!attribute end_date
23
21
  # The end date to retrieve pay statement items by via their last seen pay date in
@@ -51,9 +51,7 @@ module FinchAPI
51
51
  #
52
52
  # @return [Array<FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier>]
53
53
  required :tiers,
54
- -> {
55
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier]
56
- }
54
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier] }
57
55
 
58
56
  # @!attribute type
59
57
  #
@@ -32,10 +32,7 @@ module FinchAPI
32
32
  # types
33
33
  #
34
34
  # @return [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>, nil]
35
- optional :types,
36
- -> {
37
- FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::DocumentListParams::Type]
38
- }
35
+ optional :types, -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::DocumentListParams::Type] }
39
36
 
40
37
  # @!method initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {})
41
38
  # Some parameter documentations has been truncated, see
@@ -13,9 +13,7 @@ module FinchAPI
13
13
  #
14
14
  # @return [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>]
15
15
  required :requests,
16
- -> {
17
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
18
- }
16
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request] }
19
17
 
20
18
  # @!method initialize(requests:, request_options: {})
21
19
  # @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
@@ -17,9 +17,7 @@ module FinchAPI
17
17
  #
18
18
  # @return [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>, nil]
19
19
  optional :requests,
20
- -> {
21
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
22
- }
20
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] }
23
21
 
24
22
  # @!method initialize(options: nil, requests: nil, request_options: {})
25
23
  # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
@@ -334,10 +334,7 @@ module FinchAPI
334
334
  # @!attribute metadata
335
335
  #
336
336
  # @return [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata]
337
- required :metadata,
338
- -> {
339
- FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
340
- }
337
+ required :metadata, -> { FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata }
341
338
 
342
339
  # @!method initialize(metadata:)
343
340
  # @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata]
@@ -13,9 +13,7 @@ module FinchAPI
13
13
  #
14
14
  # @return [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>]
15
15
  required :requests,
16
- -> {
17
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
18
- }
16
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request] }
19
17
 
20
18
  # @!method initialize(requests:, request_options: {})
21
19
  # @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
@@ -40,7 +40,7 @@ module FinchAPI
40
40
  # @!attribute scheduled_at
41
41
  # The datetime a job is scheduled to be run. For scheduled jobs, this datetime can
42
42
  # be in the future if the job has not yet been enqueued. For ad-hoc jobs, this
43
- # field will be null.
43
+ # field will be null.
44
44
  #
45
45
  # @return [Time, nil]
46
46
  required :scheduled_at, Time, nil?: true
@@ -8,6 +8,14 @@ module FinchAPI
8
8
  extend FinchAPI::Internal::Type::RequestParameters::Converter
9
9
  include FinchAPI::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute entity_id
12
+ # The entity ID to use when authenticating with a multi-account token. Required
13
+ # when using a multi-account token to specify which entity's data to access.
14
+ # Example: `123e4567-e89b-12d3-a456-426614174000`
15
+ #
16
+ # @return [String, nil]
17
+ optional :entity_id, String
18
+
11
19
  # @!attribute limit
12
20
  # Number of items to return
13
21
  #
@@ -20,7 +28,12 @@ module FinchAPI
20
28
  # @return [Integer, nil]
21
29
  optional :offset, Integer
22
30
 
23
- # @!method initialize(limit: nil, offset: nil, request_options: {})
31
+ # @!method initialize(entity_id: nil, limit: nil, offset: nil, request_options: {})
32
+ # Some parameter documentations has been truncated, see
33
+ # {FinchAPI::Models::Jobs::AutomatedListParams} for more details.
34
+ #
35
+ # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
36
+ #
24
37
  # @param limit [Integer] Number of items to return
25
38
  #
26
39
  # @param offset [Integer] Index to start from (defaults to 0)
@@ -8,7 +8,20 @@ module FinchAPI
8
8
  extend FinchAPI::Internal::Type::RequestParameters::Converter
9
9
  include FinchAPI::Internal::Type::RequestParameters
10
10
 
11
- # @!method initialize(request_options: {})
11
+ # @!attribute entity_id
12
+ # The entity ID to use when authenticating with a multi-account token. Required
13
+ # when using a multi-account token to specify which entity's data to access.
14
+ # Example: `123e4567-e89b-12d3-a456-426614174000`
15
+ #
16
+ # @return [String, nil]
17
+ optional :entity_id, String
18
+
19
+ # @!method initialize(entity_id: nil, request_options: {})
20
+ # Some parameter documentations has been truncated, see
21
+ # {FinchAPI::Models::Jobs::AutomatedRetrieveParams} for more details.
22
+ #
23
+ # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
24
+ #
12
25
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
13
26
  end
14
27
  end
@@ -8,8 +8,10 @@ module FinchAPI
8
8
  # @!attribute body
9
9
  # Specific information about the job, such as individual statuses for batch jobs.
10
10
  #
11
- # @return [Array<Object>, nil]
12
- required :body, FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown], nil?: true
11
+ # @return [Array<Object, nil>, nil]
12
+ required :body,
13
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown, nil?: true],
14
+ nil?: true
13
15
 
14
16
  # @!attribute job_id
15
17
  #
@@ -22,7 +24,7 @@ module FinchAPI
22
24
  required :status, enum: -> { FinchAPI::Jobs::ManualAsyncJob::Status }
23
25
 
24
26
  # @!method initialize(body:, job_id:, status:)
25
- # @param body [Array<Object>, nil] Specific information about the job, such as individual statuses for batch jobs.
27
+ # @param body [Array<Object, nil>, nil] Specific information about the job, such as individual statuses for batch jobs.
26
28
  #
27
29
  # @param job_id [String]
28
30
  #
@@ -8,7 +8,20 @@ module FinchAPI
8
8
  extend FinchAPI::Internal::Type::RequestParameters::Converter
9
9
  include FinchAPI::Internal::Type::RequestParameters
10
10
 
11
- # @!method initialize(request_options: {})
11
+ # @!attribute entity_id
12
+ # The entity ID to use when authenticating with a multi-account token. Required
13
+ # when using a multi-account token to specify which entity's data to access.
14
+ # Example: `123e4567-e89b-12d3-a456-426614174000`
15
+ #
16
+ # @return [String, nil]
17
+ optional :entity_id, String
18
+
19
+ # @!method initialize(entity_id: nil, request_options: {})
20
+ # Some parameter documentations has been truncated, see
21
+ # {FinchAPI::Models::Jobs::ManualRetrieveParams} for more details.
22
+ #
23
+ # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
24
+ #
12
25
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
13
26
  end
14
27
  end
@@ -155,10 +155,7 @@ module FinchAPI
155
155
  # @!attribute pay_statement
156
156
  #
157
157
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, nil]
158
- optional :pay_statement,
159
- -> {
160
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement
161
- }
158
+ optional :pay_statement, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement }
162
159
 
163
160
  # @!attribute payment
164
161
  #
@@ -186,10 +183,7 @@ module FinchAPI
186
183
  # @!attribute accounts
187
184
  #
188
185
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, nil]
189
- optional :accounts,
190
- -> {
191
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts
192
- }
186
+ optional :accounts, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts }
193
187
 
194
188
  # @!attribute departments
195
189
  #
@@ -205,10 +199,7 @@ module FinchAPI
205
199
  # @!attribute entity
206
200
  #
207
201
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, nil]
208
- optional :entity,
209
- -> {
210
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity
211
- }
202
+ optional :entity, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity }
212
203
 
213
204
  # @!attribute legal_name
214
205
  #
@@ -218,10 +209,7 @@ module FinchAPI
218
209
  # @!attribute locations
219
210
  #
220
211
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, nil]
221
- optional :locations,
222
- -> {
223
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations
224
- }
212
+ optional :locations, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations }
225
213
 
226
214
  # @!attribute primary_email
227
215
  #
@@ -290,9 +278,7 @@ module FinchAPI
290
278
  #
291
279
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil]
292
280
  optional :parent,
293
- -> {
294
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent
295
- }
281
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent }
296
282
 
297
283
  # @!method initialize(name: nil, parent: nil)
298
284
  # @param name [Boolean]
@@ -380,10 +366,7 @@ module FinchAPI
380
366
  # @!attribute paging
381
367
  #
382
368
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, nil]
383
- optional :paging,
384
- -> {
385
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging
386
- }
369
+ optional :paging, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging }
387
370
 
388
371
  # @!method initialize(individuals: nil, paging: nil)
389
372
  # @param individuals [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals]
@@ -420,9 +403,7 @@ module FinchAPI
420
403
  #
421
404
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil]
422
405
  optional :manager,
423
- -> {
424
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager
425
- }
406
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager }
426
407
 
427
408
  # @!attribute middle_name
428
409
  #
@@ -515,10 +496,7 @@ module FinchAPI
515
496
  # @!attribute income
516
497
  #
517
498
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, nil]
518
- optional :income,
519
- -> {
520
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income
521
- }
499
+ optional :income, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income }
522
500
 
523
501
  # @!attribute income_history
524
502
  #
@@ -538,18 +516,12 @@ module FinchAPI
538
516
  # @!attribute location
539
517
  #
540
518
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, nil]
541
- optional :location,
542
- -> {
543
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location
544
- }
519
+ optional :location, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location }
545
520
 
546
521
  # @!attribute manager
547
522
  #
548
523
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
549
- optional :manager,
550
- -> {
551
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager
552
- }
524
+ optional :manager, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager }
553
525
 
554
526
  # @!attribute middle_name
555
527
  #
@@ -704,10 +676,7 @@ module FinchAPI
704
676
  # @!attribute emails
705
677
  #
706
678
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, nil]
707
- optional :emails,
708
- -> {
709
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails
710
- }
679
+ optional :emails, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails }
711
680
 
712
681
  # @!attribute encrypted_ssn
713
682
  #
@@ -743,9 +712,7 @@ module FinchAPI
743
712
  #
744
713
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil]
745
714
  optional :phone_numbers,
746
- -> {
747
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers
748
- }
715
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers }
749
716
 
750
717
  # @!attribute preferred_name
751
718
  #
@@ -888,18 +855,13 @@ module FinchAPI
888
855
  # @!attribute paging
889
856
  #
890
857
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil]
891
- optional :paging,
892
- -> {
893
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging
894
- }
858
+ optional :paging, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging }
895
859
 
896
860
  # @!attribute pay_statements
897
861
  #
898
862
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil]
899
863
  optional :pay_statements,
900
- -> {
901
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements
902
- }
864
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements }
903
865
 
904
866
  # @!method initialize(paging: nil, pay_statements: nil)
905
867
  # @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging]
@@ -928,25 +890,19 @@ module FinchAPI
928
890
  #
929
891
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil]
930
892
  optional :earnings,
931
- -> {
932
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings
933
- }
893
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings }
934
894
 
935
895
  # @!attribute employee_deductions
936
896
  #
937
897
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil]
938
898
  optional :employee_deductions,
939
- -> {
940
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions
941
- }
899
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions }
942
900
 
943
901
  # @!attribute employer_contributions
944
902
  #
945
903
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil]
946
904
  optional :employer_contributions,
947
- -> {
948
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions
949
- }
905
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions }
950
906
 
951
907
  # @!attribute gross_pay
952
908
  #
@@ -972,9 +928,7 @@ module FinchAPI
972
928
  #
973
929
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil]
974
930
  optional :taxes,
975
- -> {
976
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes
977
- }
931
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes }
978
932
 
979
933
  # @!attribute total_hours
980
934
  #
@@ -1182,10 +1136,7 @@ module FinchAPI
1182
1136
  # @!attribute pay_period
1183
1137
  #
1184
1138
  # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil]
1185
- optional :pay_period,
1186
- -> {
1187
- FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod
1188
- }
1139
+ optional :pay_period, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod }
1189
1140
 
1190
1141
  # @!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)
1191
1142
  # @param id [Boolean]
@@ -5,16 +5,16 @@ module FinchAPI
5
5
  # @see FinchAPI::Resources::RequestForwarding#forward
6
6
  class RequestForwardingForwardResponse < FinchAPI::Internal::Type::BaseModel
7
7
  # @!attribute data
8
- # A string representation of the HTTP response body of the forwarded requests
9
- # response received from the underlying integrations API. This field may be null
10
- # in the case where the upstream systems response is empty.
8
+ # A string representation of the HTTP response body of the forwarded request's
9
+ # response received from the underlying integration's API. This field may be null
10
+ # in the case where the upstream system's response is empty.
11
11
  #
12
12
  # @return [String, nil]
13
13
  required :data, String, nil?: true
14
14
 
15
15
  # @!attribute headers
16
- # The HTTP headers of the forwarded requests response, exactly as received from
17
- # the underlying integrations API.
16
+ # The HTTP headers of the forwarded request's response, exactly as received from
17
+ # the underlying integration's API.
18
18
  #
19
19
  # @return [Object, nil]
20
20
  required :headers, FinchAPI::Internal::Type::Unknown, nil?: true
@@ -27,8 +27,8 @@ module FinchAPI
27
27
  required :request, -> { FinchAPI::Models::RequestForwardingForwardResponse::Request }
28
28
 
29
29
  # @!attribute status_code
30
- # The HTTP status code of the forwarded requests response, exactly received from
31
- # the underlying integrations API. This value will be returned as an integer.
30
+ # The HTTP status code of the forwarded request's response, exactly received from
31
+ # the underlying integration's API. This value will be returned as an integer.
32
32
  #
33
33
  # @return [Integer]
34
34
  required :status_code, Integer, api_name: :statusCode
@@ -37,13 +37,13 @@ module FinchAPI
37
37
  # Some parameter documentations has been truncated, see
38
38
  # {FinchAPI::Models::RequestForwardingForwardResponse} for more details.
39
39
  #
40
- # @param data [String, nil] A string representation of the HTTP response body of the forwarded requests res
40
+ # @param data [String, nil] A string representation of the HTTP response body of the forwarded request's res
41
41
  #
42
- # @param headers [Object, nil] The HTTP headers of the forwarded requests response, exactly as received from t
42
+ # @param headers [Object, nil] The HTTP headers of the forwarded request's response, exactly as received from t
43
43
  #
44
44
  # @param request [FinchAPI::Models::RequestForwardingForwardResponse::Request] An object containing details of your original forwarded request, for your ease o
45
45
  #
46
- # @param status_code [Integer] The HTTP status code of the forwarded requests response, exactly received from
46
+ # @param status_code [Integer] The HTTP status code of the forwarded request's response, exactly received from
47
47
 
48
48
  # @see FinchAPI::Models::RequestForwardingForwardResponse#request
49
49
  class Request < FinchAPI::Internal::Type::BaseModel
@@ -17,10 +17,7 @@ module FinchAPI
17
17
  # @!attribute authentication_type
18
18
  #
19
19
  # @return [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType, nil]
20
- optional :authentication_type,
21
- enum: -> {
22
- FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType
23
- }
20
+ optional :authentication_type, enum: -> { FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType }
24
21
 
25
22
  # @!attribute employee_size
26
23
  # Optional: the size of the employer to be created with this connection. Defaults
@@ -13,10 +13,7 @@ module FinchAPI
13
13
  # `/employment` endpoints. All fields are optional.
14
14
  #
15
15
  # @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body>, nil]
16
- optional :body,
17
- -> {
18
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body]
19
- }
16
+ optional :body, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body] }
20
17
 
21
18
  # @!method initialize(body: nil, request_options: {})
22
19
  # Some parameter documentations has been truncated, see
@@ -18,9 +18,7 @@ module FinchAPI
18
18
  #
19
19
  # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>, nil]
20
20
  optional :pay_statements,
21
- -> {
22
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement]
23
- }
21
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement] }
24
22
 
25
23
  # @!attribute start_date
26
24
  #
@@ -46,25 +44,19 @@ module FinchAPI
46
44
  #
47
45
  # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning>, nil]
48
46
  optional :earnings,
49
- -> {
50
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning]
51
- }
47
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning] }
52
48
 
53
49
  # @!attribute employee_deductions
54
50
  #
55
51
  # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction>, nil]
56
52
  optional :employee_deductions,
57
- -> {
58
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction]
59
- }
53
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction] }
60
54
 
61
55
  # @!attribute employer_contributions
62
56
  #
63
57
  # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution>, nil]
64
58
  optional :employer_contributions,
65
- -> {
66
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution]
67
- }
59
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution] }
68
60
 
69
61
  # @!attribute gross_pay
70
62
  #
@@ -87,9 +79,7 @@ module FinchAPI
87
79
  #
88
80
  # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax>, nil]
89
81
  optional :taxes,
90
- -> {
91
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax]
92
- }
82
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax] }
93
83
 
94
84
  # @!attribute total_hours
95
85
  #
@@ -182,10 +172,7 @@ module FinchAPI
182
172
  # @!attribute type
183
173
  #
184
174
  # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type, nil]
185
- optional :type,
186
- enum: -> {
187
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type
188
- }
175
+ optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type }
189
176
 
190
177
  # @!method initialize(amount: nil, name: nil, pre_tax: nil, type: nil)
191
178
  # @param amount [Integer]
@@ -237,9 +224,7 @@ module FinchAPI
237
224
  #
238
225
  # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type, nil]
239
226
  optional :type,
240
- enum: -> {
241
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type
242
- }
227
+ enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type }
243
228
 
244
229
  # @!method initialize(amount: nil, name: nil, type: nil)
245
230
  # @param amount [Integer]
@@ -41,30 +41,43 @@ module FinchAPI
41
41
  )
42
42
  end
43
43
 
44
+ # Some parameter documentations has been truncated, see
45
+ # {FinchAPI::Models::Jobs::AutomatedRetrieveParams} for more details.
46
+ #
44
47
  # Get an automated job by `job_id`.
45
48
  #
46
- # @overload retrieve(job_id, request_options: {})
49
+ # @overload retrieve(job_id, entity_id: nil, request_options: {})
47
50
  #
48
51
  # @param job_id [String]
52
+ #
53
+ # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
54
+ #
49
55
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
50
56
  #
51
57
  # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob]
52
58
  #
53
59
  # @see FinchAPI::Models::Jobs::AutomatedRetrieveParams
54
60
  def retrieve(job_id, params = {})
61
+ parsed, options = FinchAPI::Jobs::AutomatedRetrieveParams.dump_request(params)
55
62
  @client.request(
56
63
  method: :get,
57
64
  path: ["jobs/automated/%1$s", job_id],
65
+ query: parsed,
58
66
  model: FinchAPI::Jobs::AutomatedAsyncJob,
59
- options: params[:request_options]
67
+ options: options
60
68
  )
61
69
  end
62
70
 
71
+ # Some parameter documentations has been truncated, see
72
+ # {FinchAPI::Models::Jobs::AutomatedListParams} for more details.
73
+ #
63
74
  # Get all automated jobs. Automated jobs are completed by a machine. By default,
64
75
  # jobs are sorted in descending order by submission time. For scheduled jobs such
65
76
  # as data syncs, only the next scheduled job is shown.
66
77
  #
67
- # @overload list(limit: nil, offset: nil, request_options: {})
78
+ # @overload list(entity_id: nil, limit: nil, offset: nil, request_options: {})
79
+ #
80
+ # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
68
81
  #
69
82
  # @param limit [Integer] Number of items to return
70
83
  #
@@ -4,23 +4,31 @@ module FinchAPI
4
4
  module Resources
5
5
  class Jobs
6
6
  class Manual
7
+ # Some parameter documentations has been truncated, see
8
+ # {FinchAPI::Models::Jobs::ManualRetrieveParams} for more details.
9
+ #
7
10
  # Get a manual job by `job_id`. Manual jobs are completed by a human and include
8
11
  # Assisted Benefits jobs.
9
12
  #
10
- # @overload retrieve(job_id, request_options: {})
13
+ # @overload retrieve(job_id, entity_id: nil, request_options: {})
11
14
  #
12
15
  # @param job_id [String]
16
+ #
17
+ # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
18
+ #
13
19
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
14
20
  #
15
21
  # @return [FinchAPI::Models::Jobs::ManualAsyncJob]
16
22
  #
17
23
  # @see FinchAPI::Models::Jobs::ManualRetrieveParams
18
24
  def retrieve(job_id, params = {})
25
+ parsed, options = FinchAPI::Jobs::ManualRetrieveParams.dump_request(params)
19
26
  @client.request(
20
27
  method: :get,
21
28
  path: ["jobs/manual/%1$s", job_id],
29
+ query: parsed,
22
30
  model: FinchAPI::Jobs::ManualAsyncJob,
23
- options: params[:request_options]
31
+ options: options
24
32
  )
25
33
  end
26
34
 
@@ -7,8 +7,8 @@ module FinchAPI
7
7
  # {FinchAPI::Models::RequestForwardingForwardParams} for more details.
8
8
  #
9
9
  # The Forward API allows you to make direct requests to an employment system. If
10
- # Finchs unified API doesnt have a data model that cleanly fits your needs, then
11
- # Forward allows you to push or pull data models directly against an integrations
10
+ # Finch's unified API doesn't have a data model that cleanly fits your needs, then
11
+ # Forward allows you to push or pull data models directly against an integration's
12
12
  # API.
13
13
  #
14
14
  # @overload forward(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module FinchAPI
4
- VERSION = "0.1.0.pre.alpha.25"
4
+ VERSION = "0.1.0.pre.alpha.27"
5
5
  end