@tryfinch/finch-api 9.8.0 → 9.10.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 (90) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/client.d.mts +2 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +2 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs +1 -1
  8. package/client.mjs.map +1 -1
  9. package/package.json +1 -1
  10. package/resources/account.d.mts +40 -1
  11. package/resources/account.d.mts.map +1 -1
  12. package/resources/account.d.ts +40 -1
  13. package/resources/account.d.ts.map +1 -1
  14. package/resources/account.js +29 -0
  15. package/resources/account.js.map +1 -1
  16. package/resources/account.mjs +29 -0
  17. package/resources/account.mjs.map +1 -1
  18. package/resources/hris/benefits/benefits.d.mts +37 -1
  19. package/resources/hris/benefits/benefits.d.mts.map +1 -1
  20. package/resources/hris/benefits/benefits.d.ts +37 -1
  21. package/resources/hris/benefits/benefits.d.ts.map +1 -1
  22. package/resources/hris/benefits/benefits.js +19 -0
  23. package/resources/hris/benefits/benefits.js.map +1 -1
  24. package/resources/hris/benefits/benefits.mjs +19 -0
  25. package/resources/hris/benefits/benefits.mjs.map +1 -1
  26. package/resources/hris/benefits/index.d.mts +1 -1
  27. package/resources/hris/benefits/index.d.mts.map +1 -1
  28. package/resources/hris/benefits/index.d.ts +1 -1
  29. package/resources/hris/benefits/index.d.ts.map +1 -1
  30. package/resources/hris/benefits/index.js.map +1 -1
  31. package/resources/hris/benefits/index.mjs.map +1 -1
  32. package/resources/hris/employments.d.mts +7 -7
  33. package/resources/hris/employments.d.mts.map +1 -1
  34. package/resources/hris/employments.d.ts +7 -7
  35. package/resources/hris/employments.d.ts.map +1 -1
  36. package/resources/hris/hris.d.mts +2 -2
  37. package/resources/hris/hris.d.mts.map +1 -1
  38. package/resources/hris/hris.d.ts +2 -2
  39. package/resources/hris/hris.d.ts.map +1 -1
  40. package/resources/hris/hris.js.map +1 -1
  41. package/resources/hris/hris.mjs.map +1 -1
  42. package/resources/hris/index.d.mts +1 -1
  43. package/resources/hris/index.d.mts.map +1 -1
  44. package/resources/hris/index.d.ts +1 -1
  45. package/resources/hris/index.d.ts.map +1 -1
  46. package/resources/hris/index.js.map +1 -1
  47. package/resources/hris/index.mjs.map +1 -1
  48. package/resources/hris/individuals.d.mts +5 -5
  49. package/resources/hris/individuals.d.mts.map +1 -1
  50. package/resources/hris/individuals.d.ts +5 -5
  51. package/resources/hris/individuals.d.ts.map +1 -1
  52. package/resources/index.d.mts +1 -1
  53. package/resources/index.d.mts.map +1 -1
  54. package/resources/index.d.ts +1 -1
  55. package/resources/index.d.ts.map +1 -1
  56. package/resources/index.js.map +1 -1
  57. package/resources/index.mjs +1 -1
  58. package/resources/index.mjs.map +1 -1
  59. package/resources/sandbox/directory.d.mts +1 -1
  60. package/resources/sandbox/directory.d.mts.map +1 -1
  61. package/resources/sandbox/directory.d.ts +1 -1
  62. package/resources/sandbox/directory.d.ts.map +1 -1
  63. package/resources/sandbox/employment.d.mts +3 -2
  64. package/resources/sandbox/employment.d.mts.map +1 -1
  65. package/resources/sandbox/employment.d.ts +3 -2
  66. package/resources/sandbox/employment.d.ts.map +1 -1
  67. package/resources/sandbox/employment.js +1 -0
  68. package/resources/sandbox/employment.js.map +1 -1
  69. package/resources/sandbox/employment.mjs +1 -0
  70. package/resources/sandbox/employment.mjs.map +1 -1
  71. package/src/client.ts +9 -1
  72. package/src/resources/account.ts +53 -1
  73. package/src/resources/hris/benefits/benefits.ts +56 -0
  74. package/src/resources/hris/benefits/index.ts +2 -0
  75. package/src/resources/hris/employments.ts +7 -7
  76. package/src/resources/hris/hris.ts +4 -0
  77. package/src/resources/hris/index.ts +2 -0
  78. package/src/resources/hris/individuals.ts +5 -5
  79. package/src/resources/index.ts +7 -1
  80. package/src/resources/sandbox/directory.ts +1 -1
  81. package/src/resources/sandbox/employment.ts +3 -2
  82. package/src/version.ts +1 -1
  83. package/version.d.mts +1 -1
  84. package/version.d.mts.map +1 -1
  85. package/version.d.ts +1 -1
  86. package/version.d.ts.map +1 -1
  87. package/version.js +1 -1
  88. package/version.js.map +1 -1
  89. package/version.mjs +1 -1
  90. package/version.mjs.map +1 -1
@@ -55,6 +55,7 @@ import {
55
55
  BenefitFrequency,
56
56
  BenefitListParams,
57
57
  BenefitListSupportedBenefitsParams,
58
+ BenefitRegisterParams,
58
59
  BenefitRetrieveParams,
59
60
  BenefitType,
60
61
  BenefitUpdateParams,
@@ -64,6 +65,7 @@ import {
64
65
  CompanyBenefit,
65
66
  CompanyBenefitsSinglePage,
66
67
  CreateCompanyBenefitsResponse,
68
+ RegisterCompanyBenefitResponse,
67
69
  SupportPerBenefitType,
68
70
  SupportedBenefit,
69
71
  SupportedBenefitsSinglePage,
@@ -244,6 +246,7 @@ export declare namespace HRIS {
244
246
  type BenefitsSupport as BenefitsSupport,
245
247
  type CompanyBenefit as CompanyBenefit,
246
248
  type CreateCompanyBenefitsResponse as CreateCompanyBenefitsResponse,
249
+ type RegisterCompanyBenefitResponse as RegisterCompanyBenefitResponse,
247
250
  type SupportPerBenefitType as SupportPerBenefitType,
248
251
  type SupportedBenefit as SupportedBenefit,
249
252
  type UpdateCompanyBenefitResponse as UpdateCompanyBenefitResponse,
@@ -255,5 +258,6 @@ export declare namespace HRIS {
255
258
  type BenefitUpdateParams as BenefitUpdateParams,
256
259
  type BenefitListParams as BenefitListParams,
257
260
  type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams,
261
+ type BenefitRegisterParams as BenefitRegisterParams,
258
262
  };
259
263
  }
@@ -9,6 +9,7 @@ export {
9
9
  type BenefitsSupport,
10
10
  type CompanyBenefit,
11
11
  type CreateCompanyBenefitsResponse,
12
+ type RegisterCompanyBenefitResponse,
12
13
  type SupportPerBenefitType,
13
14
  type SupportedBenefit,
14
15
  type UpdateCompanyBenefitResponse,
@@ -18,6 +19,7 @@ export {
18
19
  type BenefitUpdateParams,
19
20
  type BenefitListParams,
20
21
  type BenefitListSupportedBenefitsParams,
22
+ type BenefitRegisterParams,
21
23
  type CompanyBenefitsSinglePage,
22
24
  type SupportedBenefitsSinglePage,
23
25
  } from './benefits/index';
@@ -34,10 +34,10 @@ export class Individuals extends APIResource {
34
34
 
35
35
  export type IndividualResponsesPage = ResponsesPage<IndividualResponse>;
36
36
 
37
- export type Individual = Individual.Individual | Individual.BatchError;
37
+ export type Individual = Individual.IndividualResponseBody | Individual.BatchError;
38
38
 
39
39
  export namespace Individual {
40
- export interface Individual {
40
+ export interface IndividualResponseBody {
41
41
  /**
42
42
  * A stable Finch `id` (UUID v4) for an individual in the company.
43
43
  */
@@ -79,7 +79,7 @@ export namespace Individual {
79
79
  */
80
80
  middle_name: string | null;
81
81
 
82
- phone_numbers: Array<Individual.PhoneNumber | null> | null;
82
+ phone_numbers: Array<IndividualResponseBody.PhoneNumber | null> | null;
83
83
 
84
84
  /**
85
85
  * The preferred name of the individual.
@@ -88,7 +88,7 @@ export namespace Individual {
88
88
 
89
89
  residence: HRISAPI.Location | null;
90
90
 
91
- emails?: Array<Individual.Email> | null;
91
+ emails?: Array<IndividualResponseBody.Email> | null;
92
92
 
93
93
  /**
94
94
  * Social Security Number of the individual in **encrypted** format. This field is
@@ -106,7 +106,7 @@ export namespace Individual {
106
106
  ssn?: string | null;
107
107
  }
108
108
 
109
- export namespace Individual {
109
+ export namespace IndividualResponseBody {
110
110
  export interface PhoneNumber {
111
111
  data: string | null;
112
112
 
@@ -2,7 +2,13 @@
2
2
 
3
3
  export * from './shared';
4
4
  export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from './access-tokens';
5
- export { Account, type DisconnectResponse, type Introspection } from './account';
5
+ export {
6
+ Account,
7
+ type DisconnectEntityResponse,
8
+ type DisconnectResponse,
9
+ type Introspection,
10
+ type AccountDisconnectEntityParams,
11
+ } from './account';
6
12
  export { Connect } from './connect/connect';
7
13
  export { HRIS, type Income, type Location, type Money } from './hris/hris';
8
14
  export { Jobs } from './jobs/jobs';
@@ -190,7 +190,7 @@ export namespace DirectoryCreateParams {
190
190
  export interface CustomField {
191
191
  name?: string | null;
192
192
 
193
- value?: unknown;
193
+ value?: string | null | Array<unknown> | null | unknown | number | null | boolean | null;
194
194
  }
195
195
 
196
196
  /**
@@ -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
  */
@@ -137,7 +138,7 @@ export namespace EmploymentUpdateResponse {
137
138
  export interface CustomField {
138
139
  name?: string | null;
139
140
 
140
- value?: unknown;
141
+ value?: string | null | Array<unknown> | null | unknown | number | null | boolean | null;
141
142
  }
142
143
 
143
144
  /**
@@ -279,7 +280,7 @@ export namespace EmploymentUpdateParams {
279
280
  export interface CustomField {
280
281
  name?: string | null;
281
282
 
282
- value?: unknown;
283
+ value?: string | null | Array<unknown> | null | unknown | number | null | boolean | null;
283
284
  }
284
285
 
285
286
  /**
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '9.8.0'; // x-release-please-version
1
+ export const VERSION = '9.10.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "9.8.0";
1
+ export declare const VERSION = "9.10.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.mts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
1
+ {"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "9.8.0";
1
+ export declare const VERSION = "9.10.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
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.8.0'; // x-release-please-version
4
+ exports.VERSION = '9.10.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '9.8.0'; // x-release-please-version
1
+ export const VERSION = '9.10.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map
package/version.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
1
+ {"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}