finch-api 0.1.0.pre.alpha.41 → 0.1.0.pre.alpha.43

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 (153) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +73 -0
  3. data/README.md +3 -3
  4. data/lib/finch_api/client.rb +22 -4
  5. data/lib/finch_api/internal/transport/base_client.rb +30 -3
  6. data/lib/finch_api/internal/transport/pooled_net_requester.rb +1 -1
  7. data/lib/finch_api/internal/util.rb +54 -8
  8. data/lib/finch_api/models/account_disconnect_entity_params.rb +22 -0
  9. data/lib/finch_api/models/base_webhook_event.rb +9 -1
  10. data/lib/finch_api/models/connect/session_new_params.rb +5 -3
  11. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +5 -3
  12. data/lib/finch_api/models/create_access_token_response.rb +10 -1
  13. data/lib/finch_api/models/disconnect_entity_response.rb +17 -0
  14. data/lib/finch_api/models/hris/benefit_contribution.rb +24 -23
  15. data/lib/finch_api/models/hris/benefit_register_params.rb +47 -0
  16. data/lib/finch_api/models/hris/benefit_retrieve_params.rb +8 -1
  17. data/lib/finch_api/models/hris/benefit_update_params.rb +8 -1
  18. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +63 -59
  19. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +8 -1
  20. data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +8 -1
  21. data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +8 -1
  22. data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +8 -1
  23. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +8 -1
  24. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +8 -1
  25. data/lib/finch_api/models/hris/document_retreive_params.rb +8 -1
  26. data/lib/finch_api/models/hris/employment_data.rb +76 -37
  27. data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
  28. data/lib/finch_api/models/hris/individual.rb +38 -28
  29. data/lib/finch_api/models/hris/individual_response.rb +2 -2
  30. data/lib/finch_api/models/hris/register_company_benefit_response.rb +26 -0
  31. data/lib/finch_api/models/introspection.rb +27 -1
  32. data/lib/finch_api/models/job_completion_event.rb +3 -0
  33. data/lib/finch_api/models/jobs/automated_create_params.rb +53 -29
  34. data/lib/finch_api/models/jobs/automated_retrieve_params.rb +7 -1
  35. data/lib/finch_api/models/jobs/manual_retrieve_params.rb +7 -1
  36. data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +8 -1
  37. data/lib/finch_api/models/sandbox/directory_create_params.rb +55 -4
  38. data/lib/finch_api/models/sandbox/employment_update_params.rb +58 -4
  39. data/lib/finch_api/models/sandbox/employment_update_response.rb +53 -4
  40. data/lib/finch_api/models/sandbox/individual_update_params.rb +8 -1
  41. data/lib/finch_api/models.rb +4 -0
  42. data/lib/finch_api/resources/access_tokens.rb +1 -0
  43. data/lib/finch_api/resources/account.rb +26 -0
  44. data/lib/finch_api/resources/connect/sessions.rb +4 -2
  45. data/lib/finch_api/resources/hris/benefits/individuals.rb +13 -5
  46. data/lib/finch_api/resources/hris/benefits.rb +50 -7
  47. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +14 -6
  48. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +3 -1
  49. data/lib/finch_api/resources/hris/company.rb +3 -1
  50. data/lib/finch_api/resources/hris/directory.rb +3 -1
  51. data/lib/finch_api/resources/hris/documents.rb +6 -2
  52. data/lib/finch_api/resources/hris/employments.rb +4 -2
  53. data/lib/finch_api/resources/hris/individuals.rb +4 -2
  54. data/lib/finch_api/resources/hris/pay_statements.rb +4 -2
  55. data/lib/finch_api/resources/hris/payments.rb +3 -1
  56. data/lib/finch_api/resources/jobs/automated.rb +8 -7
  57. data/lib/finch_api/resources/jobs/manual.rb +1 -0
  58. data/lib/finch_api/resources/payroll/pay_groups.rb +6 -2
  59. data/lib/finch_api/resources/providers.rb +1 -0
  60. data/lib/finch_api/resources/request_forwarding.rb +1 -0
  61. data/lib/finch_api/resources/sandbox/company.rb +1 -0
  62. data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -0
  63. data/lib/finch_api/resources/sandbox/connections.rb +1 -0
  64. data/lib/finch_api/resources/sandbox/directory.rb +1 -0
  65. data/lib/finch_api/resources/sandbox/employment.rb +4 -1
  66. data/lib/finch_api/resources/sandbox/individual.rb +1 -0
  67. data/lib/finch_api/resources/sandbox/jobs/configuration.rb +2 -0
  68. data/lib/finch_api/resources/sandbox/jobs.rb +1 -0
  69. data/lib/finch_api/resources/sandbox/payment.rb +1 -0
  70. data/lib/finch_api/version.rb +1 -1
  71. data/lib/finch_api.rb +4 -0
  72. data/rbi/finch_api/client.rbi +12 -2
  73. data/rbi/finch_api/internal/transport/base_client.rbi +6 -1
  74. data/rbi/finch_api/internal/util.rbi +29 -1
  75. data/rbi/finch_api/models/account_disconnect_entity_params.rbi +46 -0
  76. data/rbi/finch_api/models/base_webhook_event.rbi +18 -3
  77. data/rbi/finch_api/models/connect/session_new_params.rbi +11 -3
  78. data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +11 -3
  79. data/rbi/finch_api/models/create_access_token_response.rbi +13 -3
  80. data/rbi/finch_api/models/disconnect_entity_response.rbi +27 -0
  81. data/rbi/finch_api/models/hris/benefit_contribution.rbi +33 -31
  82. data/rbi/finch_api/models/hris/benefit_register_params.rbi +76 -0
  83. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +6 -0
  84. data/rbi/finch_api/models/hris/benefit_update_params.rbi +6 -0
  85. data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +71 -71
  86. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +6 -0
  87. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +6 -0
  88. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +6 -0
  89. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +6 -0
  90. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +6 -0
  91. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +6 -0
  92. data/rbi/finch_api/models/hris/document_retreive_params.rbi +6 -0
  93. data/rbi/finch_api/models/hris/employment_data.rbi +121 -56
  94. data/rbi/finch_api/models/hris/employment_data_response.rbi +1 -1
  95. data/rbi/finch_api/models/hris/individual.rbi +54 -47
  96. data/rbi/finch_api/models/hris/individual_response.rbi +1 -1
  97. data/rbi/finch_api/models/hris/register_company_benefit_response.rbi +38 -0
  98. data/rbi/finch_api/models/introspection.rbi +66 -3
  99. data/rbi/finch_api/models/job_completion_event.rbi +15 -0
  100. data/rbi/finch_api/models/jobs/automated_create_params.rbi +126 -56
  101. data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +13 -5
  102. data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +13 -5
  103. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +6 -0
  104. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +122 -9
  105. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +128 -9
  106. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +122 -9
  107. data/rbi/finch_api/models/sandbox/individual_update_params.rbi +6 -0
  108. data/rbi/finch_api/models.rbi +5 -0
  109. data/rbi/finch_api/resources/account.rbi +15 -0
  110. data/rbi/finch_api/resources/connect/sessions.rbi +6 -2
  111. data/rbi/finch_api/resources/hris/benefits.rbi +24 -0
  112. data/rbi/finch_api/resources/jobs/automated.rbi +6 -8
  113. data/rbi/finch_api/resources/sandbox/employment.rbi +7 -0
  114. data/sig/finch_api/client.rbs +6 -1
  115. data/sig/finch_api/internal/transport/base_client.rbs +2 -0
  116. data/sig/finch_api/internal/util.rbs +14 -0
  117. data/sig/finch_api/models/account_disconnect_entity_params.rbs +24 -0
  118. data/sig/finch_api/models/base_webhook_event.rbs +14 -3
  119. data/sig/finch_api/models/connect/session_new_params.rbs +2 -0
  120. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +2 -0
  121. data/sig/finch_api/models/create_access_token_response.rbs +8 -3
  122. data/sig/finch_api/models/disconnect_entity_response.rbs +13 -0
  123. data/sig/finch_api/models/hris/benefit_contribution.rbs +28 -28
  124. data/sig/finch_api/models/hris/benefit_register_params.rbs +47 -0
  125. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +5 -1
  126. data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -1
  127. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +62 -62
  128. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +5 -0
  129. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +5 -1
  130. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +9 -1
  131. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +9 -1
  132. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +5 -1
  133. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +9 -1
  134. data/sig/finch_api/models/hris/document_retreive_params.rbs +5 -1
  135. data/sig/finch_api/models/hris/employment_data.rbs +56 -39
  136. data/sig/finch_api/models/hris/individual.rbs +31 -31
  137. data/sig/finch_api/models/hris/register_company_benefit_response.rbs +18 -0
  138. data/sig/finch_api/models/introspection.rbs +44 -3
  139. data/sig/finch_api/models/job_completion_event.rbs +6 -0
  140. data/sig/finch_api/models/jobs/automated_create_params.rbs +47 -22
  141. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +11 -3
  142. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +11 -3
  143. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +5 -1
  144. data/sig/finch_api/models/sandbox/directory_create_params.rbs +40 -5
  145. data/sig/finch_api/models/sandbox/employment_update_params.rbs +45 -5
  146. data/sig/finch_api/models/sandbox/employment_update_response.rbs +40 -5
  147. data/sig/finch_api/models/sandbox/individual_update_params.rbs +5 -0
  148. data/sig/finch_api/models.rbs +4 -0
  149. data/sig/finch_api/resources/account.rbs +5 -0
  150. data/sig/finch_api/resources/hris/benefits.rbs +8 -0
  151. data/sig/finch_api/resources/jobs/automated.rbs +1 -2
  152. data/sig/finch_api/resources/sandbox/employment.rbs +1 -0
  153. metadata +14 -2
@@ -0,0 +1,18 @@
1
+ module FinchAPI
2
+ module Models
3
+ module HRIS
4
+ type register_company_benefit_response =
5
+ { benefit_id: String, job_id: String }
6
+
7
+ class RegisterCompanyBenefitResponse < FinchAPI::Internal::Type::BaseModel
8
+ attr_accessor benefit_id: String
9
+
10
+ attr_accessor job_id: String
11
+
12
+ def initialize: (benefit_id: String, job_id: String) -> void
13
+
14
+ def to_hash: -> { benefit_id: String, job_id: String }
15
+ end
16
+ end
17
+ end
18
+ end
@@ -262,7 +262,13 @@ module FinchAPI
262
262
  end
263
263
  end
264
264
 
265
- type entity = { id: String, name: String?, source_id: String? }
265
+ type entity =
266
+ {
267
+ id: String,
268
+ name: String?,
269
+ source_id: String?,
270
+ status: FinchAPI::Models::Introspection::Entity::status
271
+ }
266
272
 
267
273
  class Entity < FinchAPI::Internal::Type::BaseModel
268
274
  attr_accessor id: String
@@ -271,9 +277,44 @@ module FinchAPI
271
277
 
272
278
  attr_accessor source_id: String?
273
279
 
274
- def initialize: (id: String, name: String?, source_id: String?) -> void
280
+ attr_accessor status: FinchAPI::Models::Introspection::Entity::status
275
281
 
276
- def to_hash: -> { id: String, name: String?, source_id: String? }
282
+ def initialize: (
283
+ id: String,
284
+ name: String?,
285
+ source_id: String?,
286
+ status: FinchAPI::Models::Introspection::Entity::status
287
+ ) -> void
288
+
289
+ def to_hash: -> {
290
+ id: String,
291
+ name: String?,
292
+ source_id: String?,
293
+ status: FinchAPI::Models::Introspection::Entity::status
294
+ }
295
+
296
+ type status =
297
+ :pending
298
+ | :processing
299
+ | :connected
300
+ | :error_no_account_setup
301
+ | :error_permissions
302
+ | :reauth
303
+ | :disconnected
304
+
305
+ module Status
306
+ extend FinchAPI::Internal::Type::Enum
307
+
308
+ PENDING: :pending
309
+ PROCESSING: :processing
310
+ CONNECTED: :connected
311
+ ERROR_NO_ACCOUNT_SETUP: :error_no_account_setup
312
+ ERROR_PERMISSIONS: :error_permissions
313
+ REAUTH: :reauth
314
+ DISCONNECTED: :disconnected
315
+
316
+ def self?.values: -> ::Array[FinchAPI::Models::Introspection::Entity::status]
317
+ end
277
318
  end
278
319
  end
279
320
  end
@@ -48,6 +48,9 @@ module FinchAPI
48
48
  | :"job.benefit_unenroll.completed"
49
49
  | :"job.benefit_update.completed"
50
50
  | :"job.data_sync_all.completed"
51
+ | :"job.w4_form_employee_sync.completed"
52
+ | :"job.initial_data_sync_org.succeeded"
53
+ | :"job.initial_data_sync_payroll.succeeded"
51
54
 
52
55
  module EventType
53
56
  extend FinchAPI::Internal::Type::Enum
@@ -58,6 +61,9 @@ module FinchAPI
58
61
  JOB_BENEFIT_UNENROLL_COMPLETED: :"job.benefit_unenroll.completed"
59
62
  JOB_BENEFIT_UPDATE_COMPLETED: :"job.benefit_update.completed"
60
63
  JOB_DATA_SYNC_ALL_COMPLETED: :"job.data_sync_all.completed"
64
+ JOB_W4_FORM_EMPLOYEE_SYNC_COMPLETED: :"job.w4_form_employee_sync.completed"
65
+ JOB_INITIAL_DATA_SYNC_ORG_SUCCEEDED: :"job.initial_data_sync_org.succeeded"
66
+ JOB_INITIAL_DATA_SYNC_PAYROLL_SUCCEEDED: :"job.initial_data_sync_payroll.succeeded"
61
67
 
62
68
  def self?.values: -> ::Array[FinchAPI::Models::JobCompletionEvent::event_type]
63
69
  end
@@ -2,50 +2,75 @@ module FinchAPI
2
2
  module Models
3
3
  module Jobs
4
4
  type automated_create_params =
5
- {
6
- type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_,
7
- params: FinchAPI::Jobs::AutomatedCreateParams::Params
8
- }
5
+ { body: FinchAPI::Models::Jobs::AutomatedCreateParams::body }
9
6
  & FinchAPI::Internal::Type::request_parameters
10
7
 
11
8
  class AutomatedCreateParams < FinchAPI::Internal::Type::BaseModel
12
9
  extend FinchAPI::Internal::Type::RequestParameters::Converter
13
10
  include FinchAPI::Internal::Type::RequestParameters
14
11
 
15
- attr_accessor type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_
16
-
17
- attr_accessor params: FinchAPI::Jobs::AutomatedCreateParams::Params
12
+ attr_accessor body: FinchAPI::Models::Jobs::AutomatedCreateParams::body
18
13
 
19
14
  def initialize: (
20
- type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_,
21
- params: FinchAPI::Jobs::AutomatedCreateParams::Params,
15
+ body: FinchAPI::Models::Jobs::AutomatedCreateParams::body,
22
16
  ?request_options: FinchAPI::request_opts
23
17
  ) -> void
24
18
 
25
19
  def to_hash: -> {
26
- type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_,
27
- params: FinchAPI::Jobs::AutomatedCreateParams::Params,
20
+ body: FinchAPI::Models::Jobs::AutomatedCreateParams::body,
28
21
  request_options: FinchAPI::RequestOptions
29
22
  }
30
23
 
31
- type type_ = :w4_form_employee_sync
24
+ type body =
25
+ FinchAPI::Jobs::AutomatedCreateParams::Body::DataSyncAll
26
+ | FinchAPI::Jobs::AutomatedCreateParams::Body::W4FormEmployeeSync
32
27
 
33
- module Type
34
- extend FinchAPI::Internal::Type::Enum
28
+ module Body
29
+ extend FinchAPI::Internal::Type::Union
35
30
 
36
- W4_FORM_EMPLOYEE_SYNC: :w4_form_employee_sync
31
+ type data_sync_all = { type: :data_sync_all }
37
32
 
38
- def self?.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::type_]
39
- end
33
+ class DataSyncAll < FinchAPI::Internal::Type::BaseModel
34
+ attr_accessor type: :data_sync_all
35
+
36
+ def initialize: (?type: :data_sync_all) -> void
37
+
38
+ def to_hash: -> { type: :data_sync_all }
39
+ end
40
+
41
+ type w4_form_employee_sync =
42
+ {
43
+ params: FinchAPI::Jobs::AutomatedCreateParams::Body::W4FormEmployeeSync::Params,
44
+ type: :w4_form_employee_sync
45
+ }
46
+
47
+ class W4FormEmployeeSync < FinchAPI::Internal::Type::BaseModel
48
+ attr_accessor params: FinchAPI::Jobs::AutomatedCreateParams::Body::W4FormEmployeeSync::Params
49
+
50
+ attr_accessor type: :w4_form_employee_sync
51
+
52
+ def initialize: (
53
+ params: FinchAPI::Jobs::AutomatedCreateParams::Body::W4FormEmployeeSync::Params,
54
+ ?type: :w4_form_employee_sync
55
+ ) -> void
56
+
57
+ def to_hash: -> {
58
+ params: FinchAPI::Jobs::AutomatedCreateParams::Body::W4FormEmployeeSync::Params,
59
+ type: :w4_form_employee_sync
60
+ }
61
+
62
+ type params = { individual_id: String }
40
63
 
41
- type params = { individual_id: String }
64
+ class Params < FinchAPI::Internal::Type::BaseModel
65
+ attr_accessor individual_id: String
42
66
 
43
- class Params < FinchAPI::Internal::Type::BaseModel
44
- attr_accessor individual_id: String
67
+ def initialize: (individual_id: String) -> void
45
68
 
46
- def initialize: (individual_id: String) -> void
69
+ def to_hash: -> { individual_id: String }
70
+ end
71
+ end
47
72
 
48
- def to_hash: -> { individual_id: String }
73
+ def self?.variants: -> ::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::body]
49
74
  end
50
75
  end
51
76
  end
@@ -2,15 +2,23 @@ module FinchAPI
2
2
  module Models
3
3
  module Jobs
4
4
  type automated_retrieve_params =
5
- { } & FinchAPI::Internal::Type::request_parameters
5
+ { job_id: String } & FinchAPI::Internal::Type::request_parameters
6
6
 
7
7
  class AutomatedRetrieveParams < FinchAPI::Internal::Type::BaseModel
8
8
  extend FinchAPI::Internal::Type::RequestParameters::Converter
9
9
  include FinchAPI::Internal::Type::RequestParameters
10
10
 
11
- def initialize: (?request_options: FinchAPI::request_opts) -> void
11
+ attr_accessor job_id: String
12
12
 
13
- def to_hash: -> { request_options: FinchAPI::RequestOptions }
13
+ def initialize: (
14
+ job_id: String,
15
+ ?request_options: FinchAPI::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ job_id: String,
20
+ request_options: FinchAPI::RequestOptions
21
+ }
14
22
  end
15
23
  end
16
24
  end
@@ -2,15 +2,23 @@ module FinchAPI
2
2
  module Models
3
3
  module Jobs
4
4
  type manual_retrieve_params =
5
- { } & FinchAPI::Internal::Type::request_parameters
5
+ { job_id: String } & FinchAPI::Internal::Type::request_parameters
6
6
 
7
7
  class ManualRetrieveParams < FinchAPI::Internal::Type::BaseModel
8
8
  extend FinchAPI::Internal::Type::RequestParameters::Converter
9
9
  include FinchAPI::Internal::Type::RequestParameters
10
10
 
11
- def initialize: (?request_options: FinchAPI::request_opts) -> void
11
+ attr_accessor job_id: String
12
12
 
13
- def to_hash: -> { request_options: FinchAPI::RequestOptions }
13
+ def initialize: (
14
+ job_id: String,
15
+ ?request_options: FinchAPI::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ job_id: String,
20
+ request_options: FinchAPI::RequestOptions
21
+ }
14
22
  end
15
23
  end
16
24
  end
@@ -2,23 +2,27 @@ module FinchAPI
2
2
  module Models
3
3
  module Payroll
4
4
  type pay_group_retrieve_params =
5
- { entity_ids: ::Array[String] }
5
+ { pay_group_id: String, entity_ids: ::Array[String] }
6
6
  & FinchAPI::Internal::Type::request_parameters
7
7
 
8
8
  class PayGroupRetrieveParams < FinchAPI::Internal::Type::BaseModel
9
9
  extend FinchAPI::Internal::Type::RequestParameters::Converter
10
10
  include FinchAPI::Internal::Type::RequestParameters
11
11
 
12
+ attr_accessor pay_group_id: String
13
+
12
14
  attr_reader entity_ids: ::Array[String]?
13
15
 
14
16
  def entity_ids=: (::Array[String]) -> ::Array[String]
15
17
 
16
18
  def initialize: (
19
+ pay_group_id: String,
17
20
  ?entity_ids: ::Array[String],
18
21
  ?request_options: FinchAPI::request_opts
19
22
  ) -> void
20
23
 
21
24
  def to_hash: -> {
25
+ pay_group_id: String,
22
26
  entity_ids: ::Array[String],
23
27
  request_options: FinchAPI::RequestOptions
24
28
  }
@@ -38,6 +38,7 @@ module FinchAPI
38
38
  end_date: String?,
39
39
  ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?,
40
40
  first_name: String?,
41
+ flsa_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::flsa_status?,
41
42
  gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?,
42
43
  income: FinchAPI::Income?,
43
44
  income_history: ::Array[FinchAPI::Income?]?,
@@ -79,6 +80,8 @@ module FinchAPI
79
80
 
80
81
  attr_accessor first_name: String?
81
82
 
83
+ attr_accessor flsa_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::flsa_status?
84
+
82
85
  attr_accessor gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?
83
86
 
84
87
  attr_accessor income: FinchAPI::Income?
@@ -123,6 +126,7 @@ module FinchAPI
123
126
  ?end_date: String?,
124
127
  ?ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?,
125
128
  ?first_name: String?,
129
+ ?flsa_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::flsa_status?,
126
130
  ?gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?,
127
131
  ?income: FinchAPI::Income?,
128
132
  ?income_history: ::Array[FinchAPI::Income?]?,
@@ -153,6 +157,7 @@ module FinchAPI
153
157
  end_date: String?,
154
158
  ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?,
155
159
  first_name: String?,
160
+ flsa_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::flsa_status?,
156
161
  gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?,
157
162
  income: FinchAPI::Income?,
158
163
  income_history: ::Array[FinchAPI::Income?]?,
@@ -171,18 +176,36 @@ module FinchAPI
171
176
  title: String?
172
177
  }
173
178
 
174
- type custom_field = { name: String?, value: top }
179
+ type custom_field =
180
+ {
181
+ name: String?,
182
+ value: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField::value?
183
+ }
175
184
 
176
185
  class CustomField < FinchAPI::Internal::Type::BaseModel
177
186
  attr_accessor name: String?
178
187
 
179
- attr_reader value: top?
188
+ attr_accessor value: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField::value?
189
+
190
+ def initialize: (
191
+ ?name: String?,
192
+ ?value: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField::value?
193
+ ) -> void
194
+
195
+ def to_hash: -> {
196
+ name: String?,
197
+ value: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField::value?
198
+ }
180
199
 
181
- def value=: (top) -> top
200
+ type value = (String | ::Array[top] | top | Float | bool)?
182
201
 
183
- def initialize: (?name: String?, ?value: top) -> void
202
+ module Value
203
+ extend FinchAPI::Internal::Type::Union
184
204
 
185
- def to_hash: -> { name: String?, value: top }
205
+ def self?.variants: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField::value]
206
+
207
+ UnionMember1Array: FinchAPI::Internal::Type::Converter
208
+ end
186
209
  end
187
210
 
188
211
  type department = { name: String? }
@@ -332,6 +355,18 @@ module FinchAPI
332
355
  def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity]
333
356
  end
334
357
 
358
+ type flsa_status = :exempt | :non_exempt | :unknown
359
+
360
+ module FlsaStatus
361
+ extend FinchAPI::Internal::Type::Enum
362
+
363
+ EXEMPT: :exempt
364
+ NON_EXEMPT: :non_exempt
365
+ UNKNOWN: :unknown
366
+
367
+ def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::flsa_status]
368
+ end
369
+
335
370
  type gender = :female | :male | :other | :decline_to_specify
336
371
 
337
372
  module Gender
@@ -3,6 +3,7 @@ module FinchAPI
3
3
  module Sandbox
4
4
  type employment_update_params =
5
5
  {
6
+ individual_id: String,
6
7
  class_code: String?,
7
8
  custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?,
8
9
  department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?,
@@ -10,6 +11,7 @@ module FinchAPI
10
11
  employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?,
11
12
  end_date: String?,
12
13
  first_name: String?,
14
+ flsa_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::flsa_status?,
13
15
  income: FinchAPI::Income?,
14
16
  income_history: ::Array[FinchAPI::Income?]?,
15
17
  is_active: bool?,
@@ -28,6 +30,8 @@ module FinchAPI
28
30
  extend FinchAPI::Internal::Type::RequestParameters::Converter
29
31
  include FinchAPI::Internal::Type::RequestParameters
30
32
 
33
+ attr_accessor individual_id: String
34
+
31
35
  attr_accessor class_code: String?
32
36
 
33
37
  attr_accessor custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?
@@ -42,6 +46,8 @@ module FinchAPI
42
46
 
43
47
  attr_accessor first_name: String?
44
48
 
49
+ attr_accessor flsa_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::flsa_status?
50
+
45
51
  attr_accessor income: FinchAPI::Income?
46
52
 
47
53
  attr_accessor income_history: ::Array[FinchAPI::Income?]?
@@ -65,6 +71,7 @@ module FinchAPI
65
71
  attr_accessor title: String?
66
72
 
67
73
  def initialize: (
74
+ individual_id: String,
68
75
  ?class_code: String?,
69
76
  ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?,
70
77
  ?department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?,
@@ -72,6 +79,7 @@ module FinchAPI
72
79
  ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?,
73
80
  ?end_date: String?,
74
81
  ?first_name: String?,
82
+ ?flsa_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::flsa_status?,
75
83
  ?income: FinchAPI::Income?,
76
84
  ?income_history: ::Array[FinchAPI::Income?]?,
77
85
  ?is_active: bool?,
@@ -87,6 +95,7 @@ module FinchAPI
87
95
  ) -> void
88
96
 
89
97
  def to_hash: -> {
98
+ individual_id: String,
90
99
  class_code: String?,
91
100
  custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]?,
92
101
  department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?,
@@ -94,6 +103,7 @@ module FinchAPI
94
103
  employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?,
95
104
  end_date: String?,
96
105
  first_name: String?,
106
+ flsa_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::flsa_status?,
97
107
  income: FinchAPI::Income?,
98
108
  income_history: ::Array[FinchAPI::Income?]?,
99
109
  is_active: bool?,
@@ -108,18 +118,36 @@ module FinchAPI
108
118
  request_options: FinchAPI::RequestOptions
109
119
  }
110
120
 
111
- type custom_field = { name: String?, value: top }
121
+ type custom_field =
122
+ {
123
+ name: String?,
124
+ value: FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField::value?
125
+ }
112
126
 
113
127
  class CustomField < FinchAPI::Internal::Type::BaseModel
114
128
  attr_accessor name: String?
115
129
 
116
- attr_reader value: top?
130
+ attr_accessor value: FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField::value?
131
+
132
+ def initialize: (
133
+ ?name: String?,
134
+ ?value: FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField::value?
135
+ ) -> void
136
+
137
+ def to_hash: -> {
138
+ name: String?,
139
+ value: FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField::value?
140
+ }
141
+
142
+ type value = (String | ::Array[top] | top | Float | bool)?
117
143
 
118
- def value=: (top) -> top
144
+ module Value
145
+ extend FinchAPI::Internal::Type::Union
119
146
 
120
- def initialize: (?name: String?, ?value: top) -> void
147
+ def self?.variants: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField::value]
121
148
 
122
- def to_hash: -> { name: String?, value: top }
149
+ UnionMember1Array: FinchAPI::Internal::Type::Converter
150
+ end
123
151
  end
124
152
 
125
153
  type department = { name: String? }
@@ -209,6 +237,18 @@ module FinchAPI
209
237
  def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status]
210
238
  end
211
239
 
240
+ type flsa_status = :exempt | :non_exempt | :unknown
241
+
242
+ module FlsaStatus
243
+ extend FinchAPI::Internal::Type::Enum
244
+
245
+ EXEMPT: :exempt
246
+ NON_EXEMPT: :non_exempt
247
+ UNKNOWN: :unknown
248
+
249
+ def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::flsa_status]
250
+ end
251
+
212
252
  type manager = { id: String }
213
253
 
214
254
  class Manager < FinchAPI::Internal::Type::BaseModel
@@ -11,6 +11,7 @@ module FinchAPI
11
11
  employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?,
12
12
  end_date: String?,
13
13
  first_name: String?,
14
+ flsa_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::flsa_status?,
14
15
  income: FinchAPI::Income?,
15
16
  income_history: ::Array[FinchAPI::Income?]?,
16
17
  is_active: bool?,
@@ -43,6 +44,8 @@ module FinchAPI
43
44
 
44
45
  attr_accessor first_name: String?
45
46
 
47
+ attr_accessor flsa_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::flsa_status?
48
+
46
49
  attr_accessor income: FinchAPI::Income?
47
50
 
48
51
  attr_accessor income_history: ::Array[FinchAPI::Income?]?
@@ -74,6 +77,7 @@ module FinchAPI
74
77
  ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?,
75
78
  ?end_date: String?,
76
79
  ?first_name: String?,
80
+ ?flsa_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::flsa_status?,
77
81
  ?income: FinchAPI::Income?,
78
82
  ?income_history: ::Array[FinchAPI::Income?]?,
79
83
  ?is_active: bool?,
@@ -96,6 +100,7 @@ module FinchAPI
96
100
  employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?,
97
101
  end_date: String?,
98
102
  first_name: String?,
103
+ flsa_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::flsa_status?,
99
104
  income: FinchAPI::Income?,
100
105
  income_history: ::Array[FinchAPI::Income?]?,
101
106
  is_active: bool?,
@@ -109,18 +114,36 @@ module FinchAPI
109
114
  title: String?
110
115
  }
111
116
 
112
- type custom_field = { name: String?, value: top }
117
+ type custom_field =
118
+ {
119
+ name: String?,
120
+ value: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::value?
121
+ }
113
122
 
114
123
  class CustomField < FinchAPI::Internal::Type::BaseModel
115
124
  attr_accessor name: String?
116
125
 
117
- attr_reader value: top?
126
+ attr_accessor value: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::value?
127
+
128
+ def initialize: (
129
+ ?name: String?,
130
+ ?value: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::value?
131
+ ) -> void
132
+
133
+ def to_hash: -> {
134
+ name: String?,
135
+ value: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::value?
136
+ }
118
137
 
119
- def value=: (top) -> top
138
+ type value = (String | ::Array[top] | top | Float | bool)?
120
139
 
121
- def initialize: (?name: String?, ?value: top) -> void
140
+ module Value
141
+ extend FinchAPI::Internal::Type::Union
122
142
 
123
- def to_hash: -> { name: String?, value: top }
143
+ def self?.variants: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::value]
144
+
145
+ UnionMember1Array: FinchAPI::Internal::Type::Converter
146
+ end
124
147
  end
125
148
 
126
149
  type department = { name: String? }
@@ -210,6 +233,18 @@ module FinchAPI
210
233
  def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status]
211
234
  end
212
235
 
236
+ type flsa_status = :exempt | :non_exempt | :unknown
237
+
238
+ module FlsaStatus
239
+ extend FinchAPI::Internal::Type::Enum
240
+
241
+ EXEMPT: :exempt
242
+ NON_EXEMPT: :non_exempt
243
+ UNKNOWN: :unknown
244
+
245
+ def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::flsa_status]
246
+ end
247
+
213
248
  type manager = { id: String }
214
249
 
215
250
  class Manager < FinchAPI::Internal::Type::BaseModel
@@ -3,6 +3,7 @@ module FinchAPI
3
3
  module Sandbox
4
4
  type individual_update_params =
5
5
  {
6
+ individual_id: String,
6
7
  dob: String?,
7
8
  emails: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::Email]?,
8
9
  encrypted_ssn: String?,
@@ -22,6 +23,8 @@ module FinchAPI
22
23
  extend FinchAPI::Internal::Type::RequestParameters::Converter
23
24
  include FinchAPI::Internal::Type::RequestParameters
24
25
 
26
+ attr_accessor individual_id: String
27
+
25
28
  attr_accessor dob: String?
26
29
 
27
30
  attr_accessor emails: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::Email]?
@@ -47,6 +50,7 @@ module FinchAPI
47
50
  attr_accessor ssn: String?
48
51
 
49
52
  def initialize: (
53
+ individual_id: String,
50
54
  ?dob: String?,
51
55
  ?emails: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::Email]?,
52
56
  ?encrypted_ssn: String?,
@@ -63,6 +67,7 @@ module FinchAPI
63
67
  ) -> void
64
68
 
65
69
  def to_hash: -> {
70
+ individual_id: String,
66
71
  dob: String?,
67
72
  emails: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::Email]?,
68
73
  encrypted_ssn: String?,
@@ -1,6 +1,8 @@
1
1
  module FinchAPI
2
2
  class AccessTokenCreateParams = FinchAPI::Models::AccessTokenCreateParams
3
3
 
4
+ class AccountDisconnectEntityParams = FinchAPI::Models::AccountDisconnectEntityParams
5
+
4
6
  class AccountDisconnectParams = FinchAPI::Models::AccountDisconnectParams
5
7
 
6
8
  class AccountIntrospectParams = FinchAPI::Models::AccountIntrospectParams
@@ -19,6 +21,8 @@ module FinchAPI
19
21
 
20
22
  class DirectoryEvent = FinchAPI::Models::DirectoryEvent
21
23
 
24
+ class DisconnectEntityResponse = FinchAPI::Models::DisconnectEntityResponse
25
+
22
26
  class DisconnectResponse = FinchAPI::Models::DisconnectResponse
23
27
 
24
28
  class EmploymentEvent = FinchAPI::Models::EmploymentEvent
@@ -5,6 +5,11 @@ module FinchAPI
5
5
  ?request_options: FinchAPI::request_opts
6
6
  ) -> FinchAPI::DisconnectResponse
7
7
 
8
+ def disconnect_entity: (
9
+ entity_ids: ::Array[String],
10
+ ?request_options: FinchAPI::request_opts
11
+ ) -> FinchAPI::DisconnectEntityResponse
12
+
8
13
  def introspect: (
9
14
  ?request_options: FinchAPI::request_opts
10
15
  ) -> FinchAPI::Introspection
@@ -36,6 +36,14 @@ module FinchAPI
36
36
  ?request_options: FinchAPI::request_opts
37
37
  ) -> FinchAPI::Internal::SinglePage[FinchAPI::HRIS::SupportedBenefit]
38
38
 
39
+ def register: (
40
+ ?entity_ids: ::Array[String],
41
+ ?description: String,
42
+ ?frequency: FinchAPI::Models::HRIS::benefit_frequency?,
43
+ ?type: FinchAPI::Models::HRIS::benefit_type?,
44
+ ?request_options: FinchAPI::request_opts
45
+ ) -> FinchAPI::HRIS::RegisterCompanyBenefitResponse
46
+
39
47
  def initialize: (client: FinchAPI::Client) -> void
40
48
  end
41
49
  end