@tryfinch/finch-api 9.0.0 → 9.9.0

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 (111) hide show
  1. package/CHANGELOG.md +227 -0
  2. package/README.md +2 -2
  3. package/client.d.mts +4 -3
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +4 -3
  6. package/client.d.ts.map +1 -1
  7. package/client.js +37 -10
  8. package/client.js.map +1 -1
  9. package/client.mjs +37 -10
  10. package/client.mjs.map +1 -1
  11. package/internal/parse.d.mts.map +1 -1
  12. package/internal/parse.d.ts.map +1 -1
  13. package/internal/parse.js +5 -0
  14. package/internal/parse.js.map +1 -1
  15. package/internal/parse.mjs +5 -0
  16. package/internal/parse.mjs.map +1 -1
  17. package/internal/tslib.js +17 -17
  18. package/internal/types.d.mts +6 -6
  19. package/internal/types.d.mts.map +1 -1
  20. package/internal/types.d.ts +6 -6
  21. package/internal/types.d.ts.map +1 -1
  22. package/internal/utils/env.js +2 -2
  23. package/internal/utils/env.js.map +1 -1
  24. package/internal/utils/env.mjs +2 -2
  25. package/internal/utils/env.mjs.map +1 -1
  26. package/internal/utils/log.d.mts.map +1 -1
  27. package/internal/utils/log.d.ts.map +1 -1
  28. package/internal/utils/log.js +2 -0
  29. package/internal/utils/log.js.map +1 -1
  30. package/internal/utils/log.mjs +2 -0
  31. package/internal/utils/log.mjs.map +1 -1
  32. package/internal/utils/query.d.mts +2 -0
  33. package/internal/utils/query.d.mts.map +1 -0
  34. package/internal/utils/query.d.ts +2 -0
  35. package/internal/utils/query.d.ts.map +1 -0
  36. package/internal/utils/query.js +10 -0
  37. package/internal/utils/query.js.map +1 -0
  38. package/internal/utils/query.mjs +6 -0
  39. package/internal/utils/query.mjs.map +1 -0
  40. package/internal/utils.d.mts +1 -0
  41. package/internal/utils.d.ts +1 -0
  42. package/internal/utils.js +1 -0
  43. package/internal/utils.js.map +1 -1
  44. package/internal/utils.mjs +1 -0
  45. package/package.json +12 -1
  46. package/resources/access-tokens.d.mts +5 -0
  47. package/resources/access-tokens.d.mts.map +1 -1
  48. package/resources/access-tokens.d.ts +5 -0
  49. package/resources/access-tokens.d.ts.map +1 -1
  50. package/resources/account.d.mts +4 -0
  51. package/resources/account.d.mts.map +1 -1
  52. package/resources/account.d.ts +4 -0
  53. package/resources/account.d.ts.map +1 -1
  54. package/resources/connect/sessions.d.mts +6 -2
  55. package/resources/connect/sessions.d.mts.map +1 -1
  56. package/resources/connect/sessions.d.ts +6 -2
  57. package/resources/connect/sessions.d.ts.map +1 -1
  58. package/resources/hris/benefits/benefits.d.mts +6 -6
  59. package/resources/hris/benefits/benefits.d.mts.map +1 -1
  60. package/resources/hris/benefits/benefits.d.ts +6 -6
  61. package/resources/hris/benefits/benefits.d.ts.map +1 -1
  62. package/resources/hris/benefits/individuals.d.mts +12 -12
  63. package/resources/hris/benefits/individuals.d.mts.map +1 -1
  64. package/resources/hris/benefits/individuals.d.ts +12 -12
  65. package/resources/hris/benefits/individuals.d.ts.map +1 -1
  66. package/resources/hris/employments.d.mts +12 -7
  67. package/resources/hris/employments.d.mts.map +1 -1
  68. package/resources/hris/employments.d.ts +12 -7
  69. package/resources/hris/employments.d.ts.map +1 -1
  70. package/resources/hris/individuals.d.mts +5 -5
  71. package/resources/hris/individuals.d.mts.map +1 -1
  72. package/resources/hris/individuals.d.ts +5 -5
  73. package/resources/hris/individuals.d.ts.map +1 -1
  74. package/resources/sandbox/directory.d.mts +6 -1
  75. package/resources/sandbox/directory.d.mts.map +1 -1
  76. package/resources/sandbox/directory.d.ts +6 -1
  77. package/resources/sandbox/directory.d.ts.map +1 -1
  78. package/resources/sandbox/employment.d.mts +13 -2
  79. package/resources/sandbox/employment.d.mts.map +1 -1
  80. package/resources/sandbox/employment.d.ts +13 -2
  81. package/resources/sandbox/employment.d.ts.map +1 -1
  82. package/resources/sandbox/employment.js +1 -0
  83. package/resources/sandbox/employment.js.map +1 -1
  84. package/resources/sandbox/employment.mjs +1 -0
  85. package/resources/sandbox/employment.mjs.map +1 -1
  86. package/resources/webhooks.d.mts +5 -1
  87. package/resources/webhooks.d.mts.map +1 -1
  88. package/resources/webhooks.d.ts +5 -1
  89. package/resources/webhooks.d.ts.map +1 -1
  90. package/src/client.ts +48 -15
  91. package/src/internal/parse.ts +6 -0
  92. package/src/internal/types.ts +6 -8
  93. package/src/internal/utils/env.ts +2 -2
  94. package/src/internal/utils/log.ts +2 -0
  95. package/src/internal/utils/query.ts +7 -0
  96. package/src/internal/utils.ts +1 -0
  97. package/src/resources/access-tokens.ts +6 -0
  98. package/src/resources/account.ts +12 -0
  99. package/src/resources/connect/sessions.ts +6 -2
  100. package/src/resources/hris/benefits/benefits.ts +8 -8
  101. package/src/resources/hris/benefits/individuals.ts +17 -14
  102. package/src/resources/hris/employments.ts +13 -7
  103. package/src/resources/hris/individuals.ts +5 -5
  104. package/src/resources/sandbox/directory.ts +7 -1
  105. package/src/resources/sandbox/employment.ts +15 -2
  106. package/src/resources/webhooks.ts +9 -1
  107. package/src/version.ts +1 -1
  108. package/version.d.mts +1 -1
  109. package/version.d.ts +1 -1
  110. package/version.js +1 -1
  111. package/version.mjs +1 -1
@@ -14,6 +14,7 @@ export class Employment extends APIResource {
14
14
  * ```ts
15
15
  * const employment = await client.sandbox.employment.update(
16
16
  * 'individual_id',
17
+ * { start_date: '3/4/2020' },
17
18
  * );
18
19
  * ```
19
20
  */
@@ -78,6 +79,12 @@ export interface EmploymentUpdateResponse {
78
79
  */
79
80
  first_name?: string | null;
80
81
 
82
+ /**
83
+ * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
84
+ * `unknown`.
85
+ */
86
+ flsa_status?: 'exempt' | 'non_exempt' | 'unknown' | null;
87
+
81
88
  /**
82
89
  * The employee's income as reported by the provider. This may not always be
83
90
  * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
@@ -131,7 +138,7 @@ export namespace EmploymentUpdateResponse {
131
138
  export interface CustomField {
132
139
  name?: string | null;
133
140
 
134
- value?: unknown;
141
+ value?: string | null | Array<unknown> | null | unknown | number | null | boolean | null;
135
142
  }
136
143
 
137
144
  /**
@@ -214,6 +221,12 @@ export interface EmploymentUpdateParams {
214
221
  */
215
222
  first_name?: string | null;
216
223
 
224
+ /**
225
+ * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
226
+ * `unknown`.
227
+ */
228
+ flsa_status?: 'exempt' | 'non_exempt' | 'unknown' | null;
229
+
217
230
  /**
218
231
  * The employee's income as reported by the provider. This may not always be
219
232
  * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
@@ -267,7 +280,7 @@ export namespace EmploymentUpdateParams {
267
280
  export interface CustomField {
268
281
  name?: string | null;
269
282
 
270
- value?: unknown;
283
+ value?: string | null | Array<unknown> | null | unknown | number | null | boolean | null;
271
284
  }
272
285
 
273
286
  /**
@@ -576,6 +576,11 @@ export interface BaseWebhookEvent {
576
576
  * Unique Finch ID of the connection associated with the webhook event.
577
577
  */
578
578
  connection_id?: string;
579
+
580
+ /**
581
+ * Unique Finch id of the entity for which data has been updated.
582
+ */
583
+ entity_id?: string;
579
584
  }
580
585
 
581
586
  export interface CompanyEvent extends BaseWebhookEvent {
@@ -638,7 +643,10 @@ export interface JobCompletionEvent extends BaseWebhookEvent {
638
643
  | 'job.benefit_register.completed'
639
644
  | 'job.benefit_unenroll.completed'
640
645
  | 'job.benefit_update.completed'
641
- | 'job.data_sync_all.completed';
646
+ | 'job.data_sync_all.completed'
647
+ | 'job.w4_form_employee_sync.completed'
648
+ | 'job.initial_data_sync_org.succeeded'
649
+ | 'job.initial_data_sync_payroll.succeeded';
642
650
  }
643
651
 
644
652
  export namespace JobCompletionEvent {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '9.0.0'; // x-release-please-version
1
+ export const VERSION = '9.9.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "9.0.0";
1
+ export declare const VERSION = "9.9.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "9.0.0";
1
+ export declare const VERSION = "9.9.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '9.0.0'; // x-release-please-version
4
+ exports.VERSION = '9.9.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '9.0.0'; // x-release-please-version
1
+ export const VERSION = '9.9.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map