@tryfinch/finch-api 6.26.0 → 6.28.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.
- package/CHANGELOG.md +56 -0
- package/README.md +1 -1
- package/package.json +1 -1
- package/resources/access-tokens.d.ts +8 -0
- package/resources/access-tokens.d.ts.map +1 -1
- package/resources/access-tokens.js +8 -0
- package/resources/access-tokens.js.map +1 -1
- package/resources/access-tokens.mjs +8 -0
- package/resources/access-tokens.mjs.map +1 -1
- package/resources/hris/benefits/benefits.d.ts +73 -0
- package/resources/hris/benefits/benefits.d.ts.map +1 -1
- package/resources/hris/benefits/benefits.js +23 -0
- package/resources/hris/benefits/benefits.js.map +1 -1
- package/resources/hris/benefits/benefits.mjs +23 -0
- package/resources/hris/benefits/benefits.mjs.map +1 -1
- package/resources/hris/benefits/individuals.d.ts +35 -0
- package/resources/hris/benefits/individuals.d.ts.map +1 -1
- package/resources/hris/benefits/individuals.js +8 -0
- package/resources/hris/benefits/individuals.js.map +1 -1
- package/resources/hris/benefits/individuals.mjs +8 -0
- package/resources/hris/benefits/individuals.mjs.map +1 -1
- package/resources/hris/company/company.d.ts +15 -10
- package/resources/hris/company/company.d.ts.map +1 -1
- package/resources/hris/company/company.js +5 -0
- package/resources/hris/company/company.js.map +1 -1
- package/resources/hris/company/company.mjs +5 -0
- package/resources/hris/company/company.mjs.map +1 -1
- package/resources/hris/company/pay-statement-item/pay-statement-item.d.ts +9 -1
- package/resources/hris/company/pay-statement-item/pay-statement-item.d.ts.map +1 -1
- package/resources/hris/company/pay-statement-item/pay-statement-item.js.map +1 -1
- package/resources/hris/company/pay-statement-item/pay-statement-item.mjs.map +1 -1
- package/resources/hris/company/pay-statement-item/rules.d.ts +30 -0
- package/resources/hris/company/pay-statement-item/rules.d.ts.map +1 -1
- package/resources/hris/company/pay-statement-item/rules.js +16 -0
- package/resources/hris/company/pay-statement-item/rules.js.map +1 -1
- package/resources/hris/company/pay-statement-item/rules.mjs +16 -0
- package/resources/hris/company/pay-statement-item/rules.mjs.map +1 -1
- package/resources/hris/directory.d.ts +16 -8
- package/resources/hris/directory.d.ts.map +1 -1
- package/resources/hris/directory.js.map +1 -1
- package/resources/hris/directory.mjs.map +1 -1
- package/resources/hris/documents.d.ts +12 -0
- package/resources/hris/documents.d.ts.map +1 -1
- package/resources/hris/documents.js +7 -0
- package/resources/hris/documents.js.map +1 -1
- package/resources/hris/documents.mjs +7 -0
- package/resources/hris/documents.mjs.map +1 -1
- package/resources/hris/employments.d.ts +122 -103
- package/resources/hris/employments.d.ts.map +1 -1
- package/resources/hris/employments.js +10 -0
- package/resources/hris/employments.js.map +1 -1
- package/resources/hris/employments.mjs +10 -0
- package/resources/hris/employments.mjs.map +1 -1
- package/resources/hris/hris.d.ts +12 -12
- package/resources/hris/hris.d.ts.map +1 -1
- package/resources/hris/individuals.d.ts +73 -56
- package/resources/hris/individuals.d.ts.map +1 -1
- package/resources/hris/individuals.js.map +1 -1
- package/resources/hris/individuals.mjs.map +1 -1
- package/resources/hris/pay-statements.d.ts +16 -0
- package/resources/hris/pay-statements.d.ts.map +1 -1
- package/resources/hris/pay-statements.js +16 -0
- package/resources/hris/pay-statements.js.map +1 -1
- package/resources/hris/pay-statements.mjs +16 -0
- package/resources/hris/pay-statements.mjs.map +1 -1
- package/resources/hris/payments.d.ts +11 -0
- package/resources/hris/payments.d.ts.map +1 -1
- package/resources/hris/payments.js +11 -0
- package/resources/hris/payments.js.map +1 -1
- package/resources/hris/payments.mjs +11 -0
- package/resources/hris/payments.mjs.map +1 -1
- package/resources/request-forwarding.d.ts +10 -0
- package/resources/request-forwarding.d.ts.map +1 -1
- package/resources/request-forwarding.js +10 -0
- package/resources/request-forwarding.js.map +1 -1
- package/resources/request-forwarding.mjs +10 -0
- package/resources/request-forwarding.mjs.map +1 -1
- package/resources/sandbox/company.d.ts +23 -0
- package/resources/sandbox/company.d.ts.map +1 -1
- package/resources/sandbox/company.js +23 -0
- package/resources/sandbox/company.js.map +1 -1
- package/resources/sandbox/company.mjs +23 -0
- package/resources/sandbox/company.mjs.map +1 -1
- package/resources/sandbox/connections/accounts.d.ts +17 -0
- package/resources/sandbox/connections/accounts.d.ts.map +1 -1
- package/resources/sandbox/connections/accounts.js +9 -0
- package/resources/sandbox/connections/accounts.js.map +1 -1
- package/resources/sandbox/connections/accounts.mjs +9 -0
- package/resources/sandbox/connections/accounts.mjs.map +1 -1
- package/resources/sandbox/connections/connections.d.ts +7 -0
- package/resources/sandbox/connections/connections.d.ts.map +1 -1
- package/resources/sandbox/connections/connections.js +7 -0
- package/resources/sandbox/connections/connections.js.map +1 -1
- package/resources/sandbox/connections/connections.mjs +7 -0
- package/resources/sandbox/connections/connections.mjs.map +1 -1
- package/resources/sandbox/directory.d.ts +7 -0
- package/resources/sandbox/directory.d.ts.map +1 -1
- package/resources/sandbox/directory.js.map +1 -1
- package/resources/sandbox/directory.mjs.map +1 -1
- package/resources/sandbox/employment.d.ts +7 -0
- package/resources/sandbox/employment.d.ts.map +1 -1
- package/resources/sandbox/employment.js.map +1 -1
- package/resources/sandbox/employment.mjs.map +1 -1
- package/resources/sandbox/individual.d.ts +7 -0
- package/resources/sandbox/individual.d.ts.map +1 -1
- package/resources/sandbox/individual.js.map +1 -1
- package/resources/sandbox/individual.mjs.map +1 -1
- package/resources/sandbox/jobs/configuration.d.ts +15 -0
- package/resources/sandbox/jobs/configuration.d.ts.map +1 -1
- package/resources/sandbox/jobs/configuration.js +15 -0
- package/resources/sandbox/jobs/configuration.js.map +1 -1
- package/resources/sandbox/jobs/configuration.mjs +15 -0
- package/resources/sandbox/jobs/configuration.mjs.map +1 -1
- package/resources/sandbox/jobs/jobs.d.ts +7 -0
- package/resources/sandbox/jobs/jobs.d.ts.map +1 -1
- package/resources/sandbox/jobs/jobs.js +7 -0
- package/resources/sandbox/jobs/jobs.js.map +1 -1
- package/resources/sandbox/jobs/jobs.mjs +7 -0
- package/resources/sandbox/jobs/jobs.mjs.map +1 -1
- package/resources/sandbox/payment.d.ts +19 -0
- package/resources/sandbox/payment.d.ts.map +1 -1
- package/resources/sandbox/payment.js.map +1 -1
- package/resources/sandbox/payment.mjs.map +1 -1
- package/resources/shared.d.ts +4 -4
- package/resources/shared.d.ts.map +1 -1
- package/src/resources/access-tokens.ts +8 -0
- package/src/resources/hris/benefits/benefits.ts +83 -0
- package/src/resources/hris/benefits/individuals.ts +35 -0
- package/src/resources/hris/company/company.ts +15 -10
- package/src/resources/hris/company/pay-statement-item/pay-statement-item.ts +9 -1
- package/src/resources/hris/company/pay-statement-item/rules.ts +30 -0
- package/src/resources/hris/directory.ts +16 -8
- package/src/resources/hris/documents.ts +12 -0
- package/src/resources/hris/employments.ts +139 -115
- package/src/resources/hris/hris.ts +14 -14
- package/src/resources/hris/individuals.ts +96 -74
- package/src/resources/hris/pay-statements.ts +16 -0
- package/src/resources/hris/payments.ts +11 -0
- package/src/resources/request-forwarding.ts +10 -0
- package/src/resources/sandbox/company.ts +23 -0
- package/src/resources/sandbox/connections/accounts.ts +17 -0
- package/src/resources/sandbox/connections/connections.ts +7 -0
- package/src/resources/sandbox/directory.ts +7 -0
- package/src/resources/sandbox/employment.ts +7 -0
- package/src/resources/sandbox/individual.ts +7 -0
- package/src/resources/sandbox/jobs/configuration.ts +15 -0
- package/src/resources/sandbox/jobs/jobs.ts +7 -0
- package/src/resources/sandbox/payment.ts +19 -0
- package/src/resources/shared.ts +4 -4
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,61 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 6.28.0 (2025-05-06)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v6.27.0...v6.28.0](https://github.com/Finch-API/finch-api-node/compare/v6.27.0...v6.28.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([2154a72](https://github.com/Finch-API/finch-api-node/commit/2154a72f5e0a3f1936cd8b73938d43583777e5b5))
|
|
10
|
+
* **api:** api update ([720fdb4](https://github.com/Finch-API/finch-api-node/commit/720fdb4be78bdb2a2deb6ddee60a4114b88b69ed))
|
|
11
|
+
* **api:** api update ([b6ccf3a](https://github.com/Finch-API/finch-api-node/commit/b6ccf3a9aa7e87e9b40843a1d3a6102ad8e3d26d))
|
|
12
|
+
* **api:** api update ([4d2f27f](https://github.com/Finch-API/finch-api-node/commit/4d2f27f906f5e910a07097577f71764bb8330f1e))
|
|
13
|
+
* **api:** api update ([e97c6e3](https://github.com/Finch-API/finch-api-node/commit/e97c6e3642ac4c676f584bac56c0b7442e6086f5))
|
|
14
|
+
* **api:** api update ([7f91f38](https://github.com/Finch-API/finch-api-node/commit/7f91f38cca55023e56fb20924bd8e38796edb2d0))
|
|
15
|
+
* **api:** api update ([92c0b21](https://github.com/Finch-API/finch-api-node/commit/92c0b210ae40ae63c773e6e84e8b77dbd613b1f7))
|
|
16
|
+
* **api:** api update ([44171ef](https://github.com/Finch-API/finch-api-node/commit/44171ef323d5142cba8f852dec19b51f7a4f289a))
|
|
17
|
+
* **api:** api update ([bdf9bd1](https://github.com/Finch-API/finch-api-node/commit/bdf9bd180f3c03933aaafffe341f3b8aafd430fe))
|
|
18
|
+
* **api:** api update ([dbd517c](https://github.com/Finch-API/finch-api-node/commit/dbd517c6289b8a8e441a3ee3f97d94ec0ddb121c))
|
|
19
|
+
* **api:** api update ([810d43d](https://github.com/Finch-API/finch-api-node/commit/810d43df1cd5fe28074fe93e0a6796beacdc8719))
|
|
20
|
+
* **api:** api update ([3f01647](https://github.com/Finch-API/finch-api-node/commit/3f016471afec2e7f8d1275a008311c1124709078))
|
|
21
|
+
* **api:** api update ([28ab466](https://github.com/Finch-API/finch-api-node/commit/28ab466caaea2be802082f3f093b5648190391ed))
|
|
22
|
+
* **api:** api update ([ac9d102](https://github.com/Finch-API/finch-api-node/commit/ac9d102d86274b970409beef5ba8ed3aa8349302))
|
|
23
|
+
* **api:** api update ([9f3bc94](https://github.com/Finch-API/finch-api-node/commit/9f3bc9480e443f1ac73e880cc31ad02dde588ade))
|
|
24
|
+
* **api:** api update ([8e71317](https://github.com/Finch-API/finch-api-node/commit/8e71317c757ccd55d9d026c19ad96874f09cfb17))
|
|
25
|
+
* **api:** api update ([5858466](https://github.com/Finch-API/finch-api-node/commit/585846655881cb6a8d04d7a60b372ede87adec6a))
|
|
26
|
+
* more gracefully handle $refs and work around schema limitations ([dffc300](https://github.com/Finch-API/finch-api-node/commit/dffc300d8fd56479c9c5b233a0c12881c3370cb7))
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
### Bug Fixes
|
|
30
|
+
|
|
31
|
+
* **mcp:** remove ajv dependency so MCP servers are more compatible with Cloudflare Workers ([7b03a90](https://github.com/Finch-API/finch-api-node/commit/7b03a90abccc5b789c60cac12edc446a96e35464))
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Chores
|
|
35
|
+
|
|
36
|
+
* **ci:** bump node version for release workflows ([579202e](https://github.com/Finch-API/finch-api-node/commit/579202e75c7b9d4ba37a57274279c90cbaddbff3))
|
|
37
|
+
* **internal:** update dependency ([c08d626](https://github.com/Finch-API/finch-api-node/commit/c08d62616cf7c0ccfb6fb04000f8572d28c0ec3b))
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Documentation
|
|
41
|
+
|
|
42
|
+
* add examples to tsdocs ([ffbff85](https://github.com/Finch-API/finch-api-node/commit/ffbff852c8ce9eb25c4ff113508f4e07c4745235))
|
|
43
|
+
* **readme:** fix typo ([958fcf3](https://github.com/Finch-API/finch-api-node/commit/958fcf3b0ce9b3fb4b8246a4c0db4d5168fcf6eb))
|
|
44
|
+
|
|
45
|
+
## 6.27.0 (2025-04-23)
|
|
46
|
+
|
|
47
|
+
Full Changelog: [v6.26.0...v6.27.0](https://github.com/Finch-API/finch-api-node/compare/v6.26.0...v6.27.0)
|
|
48
|
+
|
|
49
|
+
### Features
|
|
50
|
+
|
|
51
|
+
* **api:** api update ([706763f](https://github.com/Finch-API/finch-api-node/commit/706763fbe19b3f0a33ea4f8e4f75b61090bb9e78))
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### Chores
|
|
55
|
+
|
|
56
|
+
* **ci:** only use depot for staging repos ([e55893d](https://github.com/Finch-API/finch-api-node/commit/e55893dcbfbc8db1b2a43f150323eb8a1c55a58b))
|
|
57
|
+
* **ci:** run on more branches and use depot runners ([5eaa92c](https://github.com/Finch-API/finch-api-node/commit/5eaa92c8b77fb0a3074540c1f8f32fe2e9af6cb9))
|
|
58
|
+
|
|
3
59
|
## 6.26.0 (2025-04-22)
|
|
4
60
|
|
|
5
61
|
Full Changelog: [v6.25.1...v6.26.0](https://github.com/Finch-API/finch-api-node/compare/v6.25.1...v6.26.0)
|
package/README.md
CHANGED
package/package.json
CHANGED
|
@@ -3,6 +3,14 @@ import * as Core from "../core.js";
|
|
|
3
3
|
export declare class AccessTokens extends APIResource {
|
|
4
4
|
/**
|
|
5
5
|
* Exchange the authorization code for an access token
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* const createAccessTokenResponse =
|
|
10
|
+
* await client.accessTokens.create({
|
|
11
|
+
* code: '<your_authorization_code>',
|
|
12
|
+
* });
|
|
13
|
+
* ```
|
|
6
14
|
*/
|
|
7
15
|
create(body: AccessTokenCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateAccessTokenResponse>;
|
|
8
16
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"access-tokens.d.ts","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"access-tokens.d.ts","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,MAAM,CACJ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CA0B9C;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,aAAa,GAAG,SAAS,CAAC;IAEtD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,eAAe,EAAE,UAAU,GAAG,OAAO,CAAC;IAEtC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -6,6 +6,14 @@ const resource_1 = require("../resource.js");
|
|
|
6
6
|
class AccessTokens extends resource_1.APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* Exchange the authorization code for an access token
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const createAccessTokenResponse =
|
|
13
|
+
* await client.accessTokens.create({
|
|
14
|
+
* code: '<your_authorization_code>',
|
|
15
|
+
* });
|
|
16
|
+
* ```
|
|
9
17
|
*/
|
|
10
18
|
create(body, options) {
|
|
11
19
|
const clientID = body.client_id || this._client.clientId;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"access-tokens.js","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,YAAa,SAAQ,sBAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"access-tokens.js","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;OAUG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzD,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAC;QACJ,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;QACrE,IAAI,CAAC,YAAY;YACf,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;QACJ,MAAM,oBAAoB,GAAG;YAC3B,GAAG,IAAI;YACP,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,YAAY;SAC5B,CAAC;QACF,MAAM,uBAAuB,GAAG;YAC9B,GAAG,OAAO,EAAE,OAAO;YACnB,aAAa,EAAE,IAAI;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE;YACtC,IAAI,EAAE,oBAAoB;YAC1B,GAAG,OAAO;YACV,OAAO,EAAE,uBAAuB;SACjC,CAAC,CAAC;IACL,CAAC;CACF;AAzCD,oCAyCC"}
|
|
@@ -3,6 +3,14 @@ import { APIResource } from "../resource.mjs";
|
|
|
3
3
|
export class AccessTokens extends APIResource {
|
|
4
4
|
/**
|
|
5
5
|
* Exchange the authorization code for an access token
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* const createAccessTokenResponse =
|
|
10
|
+
* await client.accessTokens.create({
|
|
11
|
+
* code: '<your_authorization_code>',
|
|
12
|
+
* });
|
|
13
|
+
* ```
|
|
6
14
|
*/
|
|
7
15
|
create(body, options) {
|
|
8
16
|
const clientID = body.client_id || this._client.clientId;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"access-tokens.mjs","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"access-tokens.mjs","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzD,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAC;QACJ,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;QACrE,IAAI,CAAC,YAAY;YACf,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;QACJ,MAAM,oBAAoB,GAAG;YAC3B,GAAG,IAAI;YACP,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,YAAY;SAC5B,CAAC;QACF,MAAM,uBAAuB,GAAG;YAC9B,GAAG,OAAO,EAAE,OAAO;YACnB,aAAa,EAAE,IAAI;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE;YACtC,IAAI,EAAE,oBAAoB;YAC1B,GAAG,OAAO;YACV,OAAO,EAAE,uBAAuB;SACjC,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -10,24 +10,59 @@ export declare class Benefits extends APIResource {
|
|
|
10
10
|
/**
|
|
11
11
|
* Creates a new company-wide deduction or contribution. Please use the
|
|
12
12
|
* `/providers` endpoint to view available types for each provider.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const createCompanyBenefitsResponse =
|
|
17
|
+
* await client.hris.benefits.create();
|
|
18
|
+
* ```
|
|
13
19
|
*/
|
|
14
20
|
create(body?: BenefitCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateCompanyBenefitsResponse>;
|
|
15
21
|
create(options?: Core.RequestOptions): Core.APIPromise<CreateCompanyBenefitsResponse>;
|
|
16
22
|
/**
|
|
17
23
|
* Lists deductions and contributions information for a given item
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const companyBenefit = await client.hris.benefits.retrieve(
|
|
28
|
+
* 'benefit_id',
|
|
29
|
+
* );
|
|
30
|
+
* ```
|
|
18
31
|
*/
|
|
19
32
|
retrieve(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<CompanyBenefit>;
|
|
20
33
|
/**
|
|
21
34
|
* Updates an existing company-wide deduction or contribution
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const updateCompanyBenefitResponse =
|
|
39
|
+
* await client.hris.benefits.update('benefit_id');
|
|
40
|
+
* ```
|
|
22
41
|
*/
|
|
23
42
|
update(benefitId: string, body?: BenefitUpdateParams, options?: Core.RequestOptions): Core.APIPromise<UpdateCompanyBenefitResponse>;
|
|
24
43
|
update(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<UpdateCompanyBenefitResponse>;
|
|
25
44
|
/**
|
|
26
45
|
* List all company-wide deductions and contributions.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* // Automatically fetches more pages as needed.
|
|
50
|
+
* for await (const companyBenefit of client.hris.benefits.list()) {
|
|
51
|
+
* // ...
|
|
52
|
+
* }
|
|
53
|
+
* ```
|
|
27
54
|
*/
|
|
28
55
|
list(options?: Core.RequestOptions): Core.PagePromise<CompanyBenefitsSinglePage, CompanyBenefit>;
|
|
29
56
|
/**
|
|
30
57
|
* Get deductions metadata
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* // Automatically fetches more pages as needed.
|
|
62
|
+
* for await (const benefitListSupportedBenefitsResponse of client.hris.benefits.listSupportedBenefits()) {
|
|
63
|
+
* // ...
|
|
64
|
+
* }
|
|
65
|
+
* ```
|
|
31
66
|
*/
|
|
32
67
|
listSupportedBenefits(options?: Core.RequestOptions): Core.PagePromise<BenefitListSupportedBenefitsResponsesSinglePage, BenefitListSupportedBenefitsResponse>;
|
|
33
68
|
}
|
|
@@ -114,6 +149,10 @@ export interface CompanyBenefit {
|
|
|
114
149
|
* The id of the benefit.
|
|
115
150
|
*/
|
|
116
151
|
benefit_id: string;
|
|
152
|
+
/**
|
|
153
|
+
* The company match for this benefit.
|
|
154
|
+
*/
|
|
155
|
+
company_contribution: CompanyBenefit.CompanyContribution | null;
|
|
117
156
|
description: string | null;
|
|
118
157
|
/**
|
|
119
158
|
* The frequency of the benefit deduction/contribution.
|
|
@@ -124,6 +163,21 @@ export interface CompanyBenefit {
|
|
|
124
163
|
*/
|
|
125
164
|
type: BenefitType | null;
|
|
126
165
|
}
|
|
166
|
+
export declare namespace CompanyBenefit {
|
|
167
|
+
/**
|
|
168
|
+
* The company match for this benefit.
|
|
169
|
+
*/
|
|
170
|
+
interface CompanyContribution {
|
|
171
|
+
tiers?: Array<CompanyContribution.Tier>;
|
|
172
|
+
type?: 'match';
|
|
173
|
+
}
|
|
174
|
+
namespace CompanyContribution {
|
|
175
|
+
interface Tier {
|
|
176
|
+
match?: number;
|
|
177
|
+
threshold?: number;
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
127
181
|
export interface CreateCompanyBenefitsResponse {
|
|
128
182
|
/**
|
|
129
183
|
* The id of the benefit.
|
|
@@ -209,6 +263,10 @@ export interface BenefitListSupportedBenefitsResponse {
|
|
|
209
263
|
*/
|
|
210
264
|
export type BenfitContribution = BenefitContribution | null;
|
|
211
265
|
export interface BenefitCreateParams {
|
|
266
|
+
/**
|
|
267
|
+
* The company match for this benefit.
|
|
268
|
+
*/
|
|
269
|
+
company_contribution?: BenefitCreateParams.CompanyContribution | null;
|
|
212
270
|
/**
|
|
213
271
|
* Name of the benefit as it appears in the provider and pay statements. Recommend
|
|
214
272
|
* limiting this to <30 characters due to limitations in specific providers (e.g.
|
|
@@ -224,6 +282,21 @@ export interface BenefitCreateParams {
|
|
|
224
282
|
*/
|
|
225
283
|
type?: BenefitType | null;
|
|
226
284
|
}
|
|
285
|
+
export declare namespace BenefitCreateParams {
|
|
286
|
+
/**
|
|
287
|
+
* The company match for this benefit.
|
|
288
|
+
*/
|
|
289
|
+
interface CompanyContribution {
|
|
290
|
+
tiers?: Array<CompanyContribution.Tier>;
|
|
291
|
+
type?: 'match';
|
|
292
|
+
}
|
|
293
|
+
namespace CompanyContribution {
|
|
294
|
+
interface Tier {
|
|
295
|
+
match?: number;
|
|
296
|
+
threshold?: number;
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
}
|
|
227
300
|
export interface BenefitUpdateParams {
|
|
228
301
|
/**
|
|
229
302
|
* Updated name or description.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefits.d.ts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,iCAAiC,EACjC,iBAAiB,EACjB,4BAA4B,EAC5B,0BAA0B,EAC1B,6BAA6B,EAC7B,oCAAoC,EACpC,4BAA4B,EAC5B,WAAW,EACX,mCAAmC,EACpC,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,qBAAa,QAAS,SAAQ,WAAW;IACvC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IAEvF
|
|
1
|
+
{"version":3,"file":"benefits.d.ts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,iCAAiC,EACjC,iBAAiB,EACjB,4BAA4B,EAC5B,0BAA0B,EAC1B,6BAA6B,EAC7B,oCAAoC,EACpC,4BAA4B,EAC5B,WAAW,EACX,mCAAmC,EACpC,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,qBAAa,QAAS,SAAQ,WAAW;IACvC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IAEvF;;;;;;;;;OASG;IACH,MAAM,CACJ,IAAI,CAAC,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IACjD,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAWrF;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAI3F;;;;;;;;OAQG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAChD,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAYvG;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,cAAc,CAAC;IAIhG;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,+CAA+C,EAAE,oCAAoC,CAAC;CAO3G;AAED,qBAAa,yBAA0B,SAAQ,UAAU,CAAC,cAAc,CAAC;CAAG;AAE5E,qBAAa,+CAAgD,SAAQ,UAAU,CAAC,oCAAoC,CAAC;CAAG;AAExH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,4BAA4B;IAC3C,kBAAkB,CAAC,EAAE,4BAA4B,CAAC,iBAAiB,CAAC;IAEpE,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;CAC9C;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,iBAAiB;QAChC;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAEhE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAE9D;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;QAEzD;;;WAGG;QACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;KACvE;CACF;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,gBAAgB,GAAG,SAAS,GAAG,IAAI,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,WAAW,GACX,WAAW,GACX,MAAM,GACN,WAAW,GACX,KAAK,GACL,UAAU,GACV,cAAc,GACd,aAAa,GACb,aAAa,GACb,SAAS,GACT,UAAU,GACV,aAAa,GACb,oBAAoB,GACpB,YAAY,GACZ,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,gBAAgB,GAChB,IAAI,CAAC;AAET;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE/C,eAAe,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEtD,cAAc,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAErD,kBAAkB,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEzD,WAAW,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAElD,QAAQ,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE/C,OAAO,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE9C,WAAW,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAElD,YAAY,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEnD,WAAW,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAElD,MAAM,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE7C,UAAU,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEjD,CAAC,CAAC,EAAE,MAAM,GAAG,4BAA4B,GAAG,IAAI,GAAG,SAAS,CAAC;CAC9D;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,oBAAoB,EAAE,cAAc,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAEhE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,mBAAmB;QAClC,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,mBAAmB,CAAC;QACnC,UAAiB,IAAI;YACnB,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;IAEjD,mBAAmB,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;CACrD;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAE7C;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;CACvE;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAE7C;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;CACvE;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG,IAAI,CAAC;AAE5D,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAEtE;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,mBAAmB;QAClC,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,mBAAmB,CAAC;QACnC,UAAiB,IAAI;YACnB,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAOD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,yBAAyB,IAAI,yBAAyB,EACtD,+CAA+C,IAAI,+CAA+C,EAClG,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,4BAA4B,IAAI,4BAA4B,EAC5D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -43,6 +43,13 @@ class Benefits extends resource_1.APIResource {
|
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
45
|
* Lists deductions and contributions information for a given item
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* const companyBenefit = await client.hris.benefits.retrieve(
|
|
50
|
+
* 'benefit_id',
|
|
51
|
+
* );
|
|
52
|
+
* ```
|
|
46
53
|
*/
|
|
47
54
|
retrieve(benefitId, options) {
|
|
48
55
|
return this._client.get(`/employer/benefits/${benefitId}`, options);
|
|
@@ -55,12 +62,28 @@ class Benefits extends resource_1.APIResource {
|
|
|
55
62
|
}
|
|
56
63
|
/**
|
|
57
64
|
* List all company-wide deductions and contributions.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* // Automatically fetches more pages as needed.
|
|
69
|
+
* for await (const companyBenefit of client.hris.benefits.list()) {
|
|
70
|
+
* // ...
|
|
71
|
+
* }
|
|
72
|
+
* ```
|
|
58
73
|
*/
|
|
59
74
|
list(options) {
|
|
60
75
|
return this._client.getAPIList('/employer/benefits', CompanyBenefitsSinglePage, options);
|
|
61
76
|
}
|
|
62
77
|
/**
|
|
63
78
|
* Get deductions metadata
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```ts
|
|
82
|
+
* // Automatically fetches more pages as needed.
|
|
83
|
+
* for await (const benefitListSupportedBenefitsResponse of client.hris.benefits.listSupportedBenefits()) {
|
|
84
|
+
* // ...
|
|
85
|
+
* }
|
|
86
|
+
* ```
|
|
64
87
|
*/
|
|
65
88
|
listSupportedBenefits(options) {
|
|
66
89
|
return this._client.getAPIList('/employer/benefits/meta', BenefitListSupportedBenefitsResponsesSinglePage, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefits.js","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAIjD,iEAAgD;AAChD,kDAUuB;AACvB,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"benefits.js","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAIjD,iEAAgD;AAChD,kDAUuB;AACvB,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsGzF,CAAC;IArFC,MAAM,CACJ,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAiBD,MAAM,CACJ,SAAiB,EACjB,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,yBAAyB,EACzB,+CAA+C,EAC/C,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAvGD,4BAuGC;AAED,MAAa,yBAA0B,SAAQ,uBAA0B;CAAG;AAA5E,8DAA4E;AAE5E,MAAa,+CAAgD,SAAQ,uBAAgD;CAAG;AAAxH,0GAAwH;AAgUxH,QAAQ,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;AAC/D,QAAQ,CAAC,+CAA+C,GAAG,+CAA+C,CAAC;AAC3G,QAAQ,CAAC,WAAW,GAAG,yBAAW,CAAC;AACnC,QAAQ,CAAC,4BAA4B,GAAG,0CAA4B,CAAC"}
|
|
@@ -17,6 +17,13 @@ export class Benefits extends APIResource {
|
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
19
|
* Lists deductions and contributions information for a given item
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const companyBenefit = await client.hris.benefits.retrieve(
|
|
24
|
+
* 'benefit_id',
|
|
25
|
+
* );
|
|
26
|
+
* ```
|
|
20
27
|
*/
|
|
21
28
|
retrieve(benefitId, options) {
|
|
22
29
|
return this._client.get(`/employer/benefits/${benefitId}`, options);
|
|
@@ -29,12 +36,28 @@ export class Benefits extends APIResource {
|
|
|
29
36
|
}
|
|
30
37
|
/**
|
|
31
38
|
* List all company-wide deductions and contributions.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* // Automatically fetches more pages as needed.
|
|
43
|
+
* for await (const companyBenefit of client.hris.benefits.list()) {
|
|
44
|
+
* // ...
|
|
45
|
+
* }
|
|
46
|
+
* ```
|
|
32
47
|
*/
|
|
33
48
|
list(options) {
|
|
34
49
|
return this._client.getAPIList('/employer/benefits', CompanyBenefitsSinglePage, options);
|
|
35
50
|
}
|
|
36
51
|
/**
|
|
37
52
|
* Get deductions metadata
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* // Automatically fetches more pages as needed.
|
|
57
|
+
* for await (const benefitListSupportedBenefitsResponse of client.hris.benefits.listSupportedBenefits()) {
|
|
58
|
+
* // ...
|
|
59
|
+
* }
|
|
60
|
+
* ```
|
|
38
61
|
*/
|
|
39
62
|
listSupportedBenefits(options) {
|
|
40
63
|
return this._client.getAPIList('/employer/benefits/meta', BenefitListSupportedBenefitsResponsesSinglePage, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefits.mjs","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,KAAK,cAAc;OACnB,EAGL,4BAA4B,EAK5B,WAAW,GAEZ;OACM,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"benefits.mjs","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,KAAK,cAAc;OACnB,EAGL,4BAA4B,EAK5B,WAAW,GAEZ;OACM,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsGzF,CAAC;IArFC,MAAM,CACJ,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAiBD,MAAM,CACJ,SAAiB,EACjB,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,yBAAyB,EACzB,+CAA+C,EAC/C,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,UAA0B;CAAG;AAE5E,MAAM,OAAO,+CAAgD,SAAQ,UAAgD;CAAG;AAgUxH,QAAQ,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;AAC/D,QAAQ,CAAC,+CAA+C,GAAG,+CAA+C,CAAC;AAC3G,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;AACnC,QAAQ,CAAC,4BAA4B,GAAG,4BAA4B,CAAC"}
|
|
@@ -8,20 +8,55 @@ export declare class Individuals extends APIResource {
|
|
|
8
8
|
* operation. If the employee is already enrolled, the enrollment amounts will be
|
|
9
9
|
* adjusted. Making the same request multiple times will not create new
|
|
10
10
|
* enrollments, but will continue to set the state of the existing enrollment.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const enrolledIndividualBenefitResponse =
|
|
15
|
+
* await client.hris.benefits.individuals.enrollMany(
|
|
16
|
+
* 'benefit_id',
|
|
17
|
+
* [{}],
|
|
18
|
+
* );
|
|
19
|
+
* ```
|
|
11
20
|
*/
|
|
12
21
|
enrollMany(benefitId: string, body?: IndividualEnrollManyParams, options?: Core.RequestOptions): Core.APIPromise<EnrolledIndividualBenefitResponse>;
|
|
13
22
|
enrollMany(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<EnrolledIndividualBenefitResponse>;
|
|
14
23
|
/**
|
|
15
24
|
* Lists individuals currently enrolled in a given deduction.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const response =
|
|
29
|
+
* await client.hris.benefits.individuals.enrolledIds(
|
|
30
|
+
* 'benefit_id',
|
|
31
|
+
* );
|
|
32
|
+
* ```
|
|
16
33
|
*/
|
|
17
34
|
enrolledIds(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<IndividualEnrolledIDsResponse>;
|
|
18
35
|
/**
|
|
19
36
|
* Get enrollment information for the given individuals.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* // Automatically fetches more pages as needed.
|
|
41
|
+
* for await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(
|
|
42
|
+
* 'benefit_id',
|
|
43
|
+
* )) {
|
|
44
|
+
* // ...
|
|
45
|
+
* }
|
|
46
|
+
* ```
|
|
20
47
|
*/
|
|
21
48
|
retrieveManyBenefits(benefitId: string, query?: IndividualRetrieveManyBenefitsParams, options?: Core.RequestOptions): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
|
|
22
49
|
retrieveManyBenefits(benefitId: string, options?: Core.RequestOptions): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
|
|
23
50
|
/**
|
|
24
51
|
* Unenroll individuals from a deduction or contribution
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* const unenrolledIndividualBenefitResponse =
|
|
56
|
+
* await client.hris.benefits.individuals.unenrollMany(
|
|
57
|
+
* 'benefit_id',
|
|
58
|
+
* );
|
|
59
|
+
* ```
|
|
25
60
|
*/
|
|
26
61
|
unenrollMany(benefitId: string, body?: IndividualUnenrollManyParams, options?: Core.RequestOptions): Core.APIPromise<UnenrolledIndividualBenefitResponse>;
|
|
27
62
|
unenrollMany(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<UnenrolledIndividualBenefitResponse>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"individuals.d.ts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/individuals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"individuals.d.ts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/individuals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC;IACrD,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAYrD;;;;;;;;;;OAUG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAIjD;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAClB,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,oCAAoC,EAC5C,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,iBAAiB,CAAC;IACpE,oBAAoB,CAClB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,iBAAiB,CAAC;IAgBpE;;;;;;;;;;OAUG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,4BAA4B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mCAAmC,CAAC;IACvD,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mCAAmC,CAAC;CAWxD;AAED,qBAAa,4BAA6B,SAAQ,UAAU,CAAC,iBAAiB,CAAC;CAAG;AAElF,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B,oBAAoB,CAAC,EAAE,WAAW,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAE9D,kBAAkB,CAAC,EAAE,WAAW,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAE5D;;WAEG;QACH,sBAAsB,CAAC,EAAE,YAAY,GAAG,QAAQ,GAAG,IAAI,CAAC;KACzD;CACF;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC;AAEtF,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,UAAU;QACzB,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC;QAEzC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,aAAa;YAC5B;;;eAGG;YACH,yBAAyB,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC;YAEpD;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,CAAC;YAEnB,oBAAoB,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC;YAEzD;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,kBAAkB,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC;SACtD;QAED,UAAiB,aAAa,CAAC;YAC7B,UAAiB,mBAAmB;gBAClC;;;mBAGG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;aAC5B;YAED,UAAiB,iBAAiB;gBAChC;;;mBAGG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;aAC5B;SACF;KACF;CACF;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,4BAA4B,IAAI,4BAA4B,EAC5D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -14,6 +14,14 @@ class Individuals extends resource_1.APIResource {
|
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* Lists individuals currently enrolled in a given deduction.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```ts
|
|
20
|
+
* const response =
|
|
21
|
+
* await client.hris.benefits.individuals.enrolledIds(
|
|
22
|
+
* 'benefit_id',
|
|
23
|
+
* );
|
|
24
|
+
* ```
|
|
17
25
|
*/
|
|
18
26
|
enrolledIds(benefitId, options) {
|
|
19
27
|
return this._client.get(`/employer/benefits/${benefitId}/enrolled`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"individuals.js","sourceRoot":"","sources":["../../../src/resources/hris/benefits/individuals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAGjD,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;
|
|
1
|
+
{"version":3,"file":"individuals.js","sourceRoot":"","sources":["../../../src/resources/hris/benefits/individuals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAGjD,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAyB1C,UAAU,CACR,SAAiB,EACjB,IAAuD,EACvD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;SACpD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,SAAS,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,SAAiB,EACjB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAwBD,oBAAoB,CAClB,SAAiB,EACjB,QAAoE,EAAE,EACtE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACxD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,sBAAsB,SAAS,cAAc,EAC7C,4BAA4B,EAC5B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAsBD,YAAY,CACV,SAAiB,EACjB,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,SAAS,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAzHD,kCAyHC;AAED,MAAa,4BAA6B,SAAQ,uBAA6B;CAAG;AAAlF,oEAAkF;AAkIlF,WAAW,CAAC,4BAA4B,GAAG,4BAA4B,CAAC"}
|
|
@@ -11,6 +11,14 @@ export class Individuals extends APIResource {
|
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
13
|
* Lists individuals currently enrolled in a given deduction.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const response =
|
|
18
|
+
* await client.hris.benefits.individuals.enrolledIds(
|
|
19
|
+
* 'benefit_id',
|
|
20
|
+
* );
|
|
21
|
+
* ```
|
|
14
22
|
*/
|
|
15
23
|
enrolledIds(benefitId, options) {
|
|
16
24
|
return this._client.get(`/employer/benefits/${benefitId}/enrolled`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"individuals.mjs","sourceRoot":"","sources":["../../../src/resources/hris/benefits/individuals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,WAAY,SAAQ,WAAW;
|
|
1
|
+
{"version":3,"file":"individuals.mjs","sourceRoot":"","sources":["../../../src/resources/hris/benefits/individuals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAyB1C,UAAU,CACR,SAAiB,EACjB,IAAuD,EACvD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;SACpD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,SAAS,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,SAAiB,EACjB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAwBD,oBAAoB,CAClB,SAAiB,EACjB,QAAoE,EAAE,EACtE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACxD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,sBAAsB,SAAS,cAAc,EAC7C,4BAA4B,EAC5B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAsBD,YAAY,CACV,SAAiB,EACjB,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,SAAS,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,UAA6B;CAAG;AAkIlF,WAAW,CAAC,4BAA4B,GAAG,4BAA4B,CAAC"}
|
|
@@ -7,6 +7,11 @@ export declare class CompanyResource extends APIResource {
|
|
|
7
7
|
payStatementItem: PayStatementItemAPI.PayStatementItem;
|
|
8
8
|
/**
|
|
9
9
|
* Read basic company data
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const company = await client.hris.company.retrieve();
|
|
14
|
+
* ```
|
|
10
15
|
*/
|
|
11
16
|
retrieve(options?: Core.RequestOptions): Core.APIPromise<Company>;
|
|
12
17
|
}
|
|
@@ -51,34 +56,34 @@ export declare namespace Company {
|
|
|
51
56
|
/**
|
|
52
57
|
* The name of the bank associated in the payroll/HRIS system.
|
|
53
58
|
*/
|
|
54
|
-
account_name
|
|
59
|
+
account_name: string | null;
|
|
55
60
|
/**
|
|
56
61
|
* 10-12 digit number to specify the bank account
|
|
57
62
|
*/
|
|
58
|
-
account_number
|
|
63
|
+
account_number: string | null;
|
|
59
64
|
/**
|
|
60
65
|
* The type of bank account.
|
|
61
66
|
*/
|
|
62
|
-
account_type
|
|
67
|
+
account_type: 'checking' | 'savings' | null;
|
|
63
68
|
/**
|
|
64
69
|
* Name of the banking institution.
|
|
65
70
|
*/
|
|
66
|
-
institution_name
|
|
71
|
+
institution_name: string | null;
|
|
67
72
|
/**
|
|
68
73
|
* A nine-digit code that's based on the U.S. Bank location where your account was
|
|
69
74
|
* opened.
|
|
70
75
|
*/
|
|
71
|
-
routing_number
|
|
76
|
+
routing_number: string | null;
|
|
72
77
|
}
|
|
73
78
|
interface Department {
|
|
74
79
|
/**
|
|
75
80
|
* The department name.
|
|
76
81
|
*/
|
|
77
|
-
name
|
|
82
|
+
name: string | null;
|
|
78
83
|
/**
|
|
79
84
|
* The parent department, if present.
|
|
80
85
|
*/
|
|
81
|
-
parent
|
|
86
|
+
parent: Department.Parent | null;
|
|
82
87
|
}
|
|
83
88
|
namespace Department {
|
|
84
89
|
/**
|
|
@@ -88,7 +93,7 @@ export declare namespace Company {
|
|
|
88
93
|
/**
|
|
89
94
|
* The parent department's name.
|
|
90
95
|
*/
|
|
91
|
-
name
|
|
96
|
+
name: string | null;
|
|
92
97
|
}
|
|
93
98
|
}
|
|
94
99
|
/**
|
|
@@ -98,11 +103,11 @@ export declare namespace Company {
|
|
|
98
103
|
/**
|
|
99
104
|
* The tax payer subtype of the company.
|
|
100
105
|
*/
|
|
101
|
-
subtype
|
|
106
|
+
subtype: 's_corporation' | 'c_corporation' | 'b_corporation' | null;
|
|
102
107
|
/**
|
|
103
108
|
* The tax payer type of the company.
|
|
104
109
|
*/
|
|
105
|
-
type
|
|
110
|
+
type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null;
|
|
106
111
|
}
|
|
107
112
|
}
|
|
108
113
|
export declare namespace CompanyResource {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"company.d.ts","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,mBAAmB,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EACL,gBAAgB,EAChB,0BAA0B,EAC1B,4BAA4B,EAC5B,iCAAiC,EAClC,MAAM,yCAAyC,CAAC;AAEjD,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IAEF
|
|
1
|
+
{"version":3,"file":"company.d.ts","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,mBAAmB,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EACL,gBAAgB,EAChB,0BAA0B,EAC1B,4BAA4B,EAC5B,iCAAiC,EAClC,MAAM,yCAAyC,CAAC;AAEjD,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IAEF;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;CAGlE;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,OAAO;QACtB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,YAAY,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,UAAU,CAAC;QAC1B;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;SACrB;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,eAAe,GAAG,eAAe,GAAG,eAAe,GAAG,IAAI,CAAC;QAEpE;;WAEG;QACH,IAAI,EACA,KAAK,GACL,IAAI,GACJ,aAAa,GACb,iBAAiB,GACjB,YAAY,GACZ,aAAa,GACb,aAAa,GACb,IAAI,CAAC;KACV;CACF;AAKD,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EAAE,KAAK,OAAO,IAAI,OAAO,EAAE,CAAC;IAEnC,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,iCAAiC,IAAI,iCAAiC,EACtE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
|