@tryfinch/finch-api 6.27.0 → 6.29.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 (208) hide show
  1. package/CHANGELOG.md +65 -0
  2. package/README.md +1 -1
  3. package/package.json +1 -1
  4. package/resources/access-tokens.d.ts +8 -0
  5. package/resources/access-tokens.d.ts.map +1 -1
  6. package/resources/access-tokens.js +8 -0
  7. package/resources/access-tokens.js.map +1 -1
  8. package/resources/access-tokens.mjs +8 -0
  9. package/resources/access-tokens.mjs.map +1 -1
  10. package/resources/hris/benefits/benefits.d.ts +73 -0
  11. package/resources/hris/benefits/benefits.d.ts.map +1 -1
  12. package/resources/hris/benefits/benefits.js +23 -0
  13. package/resources/hris/benefits/benefits.js.map +1 -1
  14. package/resources/hris/benefits/benefits.mjs +23 -0
  15. package/resources/hris/benefits/benefits.mjs.map +1 -1
  16. package/resources/hris/benefits/individuals.d.ts +35 -0
  17. package/resources/hris/benefits/individuals.d.ts.map +1 -1
  18. package/resources/hris/benefits/individuals.js +8 -0
  19. package/resources/hris/benefits/individuals.js.map +1 -1
  20. package/resources/hris/benefits/individuals.mjs +8 -0
  21. package/resources/hris/benefits/individuals.mjs.map +1 -1
  22. package/resources/hris/company/company.d.ts +15 -10
  23. package/resources/hris/company/company.d.ts.map +1 -1
  24. package/resources/hris/company/company.js +5 -0
  25. package/resources/hris/company/company.js.map +1 -1
  26. package/resources/hris/company/company.mjs +5 -0
  27. package/resources/hris/company/company.mjs.map +1 -1
  28. package/resources/hris/company/pay-statement-item/pay-statement-item.d.ts +8 -0
  29. package/resources/hris/company/pay-statement-item/pay-statement-item.d.ts.map +1 -1
  30. package/resources/hris/company/pay-statement-item/pay-statement-item.js.map +1 -1
  31. package/resources/hris/company/pay-statement-item/pay-statement-item.mjs.map +1 -1
  32. package/resources/hris/company/pay-statement-item/rules.d.ts +30 -0
  33. package/resources/hris/company/pay-statement-item/rules.d.ts.map +1 -1
  34. package/resources/hris/company/pay-statement-item/rules.js +16 -0
  35. package/resources/hris/company/pay-statement-item/rules.js.map +1 -1
  36. package/resources/hris/company/pay-statement-item/rules.mjs +16 -0
  37. package/resources/hris/company/pay-statement-item/rules.mjs.map +1 -1
  38. package/resources/hris/directory.d.ts +16 -8
  39. package/resources/hris/directory.d.ts.map +1 -1
  40. package/resources/hris/directory.js.map +1 -1
  41. package/resources/hris/directory.mjs.map +1 -1
  42. package/resources/hris/documents.d.ts +12 -0
  43. package/resources/hris/documents.d.ts.map +1 -1
  44. package/resources/hris/documents.js +7 -0
  45. package/resources/hris/documents.js.map +1 -1
  46. package/resources/hris/documents.mjs +7 -0
  47. package/resources/hris/documents.mjs.map +1 -1
  48. package/resources/hris/employments.d.ts +122 -103
  49. package/resources/hris/employments.d.ts.map +1 -1
  50. package/resources/hris/employments.js +10 -0
  51. package/resources/hris/employments.js.map +1 -1
  52. package/resources/hris/employments.mjs +10 -0
  53. package/resources/hris/employments.mjs.map +1 -1
  54. package/resources/hris/hris.d.ts +12 -12
  55. package/resources/hris/hris.d.ts.map +1 -1
  56. package/resources/hris/individuals.d.ts +73 -56
  57. package/resources/hris/individuals.d.ts.map +1 -1
  58. package/resources/hris/individuals.js.map +1 -1
  59. package/resources/hris/individuals.mjs.map +1 -1
  60. package/resources/hris/pay-statements.d.ts +17 -1
  61. package/resources/hris/pay-statements.d.ts.map +1 -1
  62. package/resources/hris/pay-statements.js +16 -0
  63. package/resources/hris/pay-statements.js.map +1 -1
  64. package/resources/hris/pay-statements.mjs +16 -0
  65. package/resources/hris/pay-statements.mjs.map +1 -1
  66. package/resources/hris/payments.d.ts +11 -0
  67. package/resources/hris/payments.d.ts.map +1 -1
  68. package/resources/hris/payments.js +11 -0
  69. package/resources/hris/payments.js.map +1 -1
  70. package/resources/hris/payments.mjs +11 -0
  71. package/resources/hris/payments.mjs.map +1 -1
  72. package/resources/request-forwarding.d.ts +10 -0
  73. package/resources/request-forwarding.d.ts.map +1 -1
  74. package/resources/request-forwarding.js +10 -0
  75. package/resources/request-forwarding.js.map +1 -1
  76. package/resources/request-forwarding.mjs +10 -0
  77. package/resources/request-forwarding.mjs.map +1 -1
  78. package/resources/sandbox/company.d.ts +23 -0
  79. package/resources/sandbox/company.d.ts.map +1 -1
  80. package/resources/sandbox/company.js +23 -0
  81. package/resources/sandbox/company.js.map +1 -1
  82. package/resources/sandbox/company.mjs +23 -0
  83. package/resources/sandbox/company.mjs.map +1 -1
  84. package/resources/sandbox/connections/accounts.d.ts +17 -0
  85. package/resources/sandbox/connections/accounts.d.ts.map +1 -1
  86. package/resources/sandbox/connections/accounts.js +9 -0
  87. package/resources/sandbox/connections/accounts.js.map +1 -1
  88. package/resources/sandbox/connections/accounts.mjs +9 -0
  89. package/resources/sandbox/connections/accounts.mjs.map +1 -1
  90. package/resources/sandbox/connections/connections.d.ts +7 -0
  91. package/resources/sandbox/connections/connections.d.ts.map +1 -1
  92. package/resources/sandbox/connections/connections.js +7 -0
  93. package/resources/sandbox/connections/connections.js.map +1 -1
  94. package/resources/sandbox/connections/connections.mjs +7 -0
  95. package/resources/sandbox/connections/connections.mjs.map +1 -1
  96. package/resources/sandbox/directory.d.ts +7 -0
  97. package/resources/sandbox/directory.d.ts.map +1 -1
  98. package/resources/sandbox/directory.js.map +1 -1
  99. package/resources/sandbox/directory.mjs.map +1 -1
  100. package/resources/sandbox/employment.d.ts +7 -0
  101. package/resources/sandbox/employment.d.ts.map +1 -1
  102. package/resources/sandbox/employment.js.map +1 -1
  103. package/resources/sandbox/employment.mjs.map +1 -1
  104. package/resources/sandbox/individual.d.ts +7 -0
  105. package/resources/sandbox/individual.d.ts.map +1 -1
  106. package/resources/sandbox/individual.js.map +1 -1
  107. package/resources/sandbox/individual.mjs.map +1 -1
  108. package/resources/sandbox/jobs/configuration.d.ts +15 -0
  109. package/resources/sandbox/jobs/configuration.d.ts.map +1 -1
  110. package/resources/sandbox/jobs/configuration.js +15 -0
  111. package/resources/sandbox/jobs/configuration.js.map +1 -1
  112. package/resources/sandbox/jobs/configuration.mjs +15 -0
  113. package/resources/sandbox/jobs/configuration.mjs.map +1 -1
  114. package/resources/sandbox/jobs/jobs.d.ts +7 -0
  115. package/resources/sandbox/jobs/jobs.d.ts.map +1 -1
  116. package/resources/sandbox/jobs/jobs.js +7 -0
  117. package/resources/sandbox/jobs/jobs.js.map +1 -1
  118. package/resources/sandbox/jobs/jobs.mjs +7 -0
  119. package/resources/sandbox/jobs/jobs.mjs.map +1 -1
  120. package/resources/sandbox/payment.d.ts +20 -1
  121. package/resources/sandbox/payment.d.ts.map +1 -1
  122. package/resources/sandbox/payment.js.map +1 -1
  123. package/resources/sandbox/payment.mjs.map +1 -1
  124. package/resources/shared.d.ts +4 -4
  125. package/resources/shared.d.ts.map +1 -1
  126. package/src/_shims/auto/runtime-bun.ts +1 -1
  127. package/src/_shims/auto/runtime-node.ts +1 -1
  128. package/src/_shims/auto/runtime.ts +1 -1
  129. package/src/_shims/auto/types-node.ts +1 -1
  130. package/src/_shims/bun-runtime.ts +2 -2
  131. package/src/_shims/index.d.ts +3 -3
  132. package/src/_shims/index.mjs +1 -1
  133. package/src/_shims/node-runtime.ts +3 -3
  134. package/src/_shims/registry.ts +1 -1
  135. package/src/_shims/web-runtime.ts +3 -3
  136. package/src/core.ts +5 -5
  137. package/src/error.ts +1 -1
  138. package/src/index.ts +20 -20
  139. package/src/internal/qs/formats.ts +1 -1
  140. package/src/internal/qs/index.ts +3 -3
  141. package/src/internal/qs/stringify.ts +3 -3
  142. package/src/internal/qs/utils.ts +2 -2
  143. package/src/pagination.ts +3 -3
  144. package/src/resource.ts +1 -1
  145. package/src/resources/access-tokens.ts +10 -2
  146. package/src/resources/account.ts +3 -3
  147. package/src/resources/connect/connect.ts +3 -3
  148. package/src/resources/connect/index.ts +2 -2
  149. package/src/resources/connect/sessions.ts +2 -2
  150. package/src/resources/connect.ts +1 -1
  151. package/src/resources/hris/benefits/benefits.ts +91 -8
  152. package/src/resources/hris/benefits/index.ts +2 -2
  153. package/src/resources/hris/benefits/individuals.ts +40 -5
  154. package/src/resources/hris/benefits.ts +1 -1
  155. package/src/resources/hris/company/company.ts +20 -15
  156. package/src/resources/hris/company/index.ts +2 -2
  157. package/src/resources/hris/company/pay-statement-item/index.ts +2 -2
  158. package/src/resources/hris/company/pay-statement-item/pay-statement-item.ts +14 -6
  159. package/src/resources/hris/company/pay-statement-item/rules.ts +34 -4
  160. package/src/resources/hris/company/pay-statement-item.ts +1 -1
  161. package/src/resources/hris/company.ts +1 -1
  162. package/src/resources/hris/directory.ts +20 -12
  163. package/src/resources/hris/documents.ts +16 -4
  164. package/src/resources/hris/employments.ts +143 -119
  165. package/src/resources/hris/hris.ts +31 -31
  166. package/src/resources/hris/index.ts +9 -9
  167. package/src/resources/hris/individuals.ts +101 -79
  168. package/src/resources/hris/pay-statements.ts +23 -7
  169. package/src/resources/hris/payments.ts +15 -4
  170. package/src/resources/hris.ts +1 -1
  171. package/src/resources/index.ts +11 -11
  172. package/src/resources/jobs/automated.ts +3 -3
  173. package/src/resources/jobs/index.ts +3 -3
  174. package/src/resources/jobs/jobs.ts +5 -5
  175. package/src/resources/jobs/manual.ts +2 -2
  176. package/src/resources/jobs.ts +1 -1
  177. package/src/resources/payroll/index.ts +2 -2
  178. package/src/resources/payroll/pay-groups.ts +4 -4
  179. package/src/resources/payroll/payroll.ts +3 -3
  180. package/src/resources/payroll.ts +1 -1
  181. package/src/resources/providers.ts +4 -4
  182. package/src/resources/request-forwarding.ts +12 -2
  183. package/src/resources/sandbox/company.ts +26 -3
  184. package/src/resources/sandbox/connections/accounts.ts +21 -4
  185. package/src/resources/sandbox/connections/connections.ts +11 -4
  186. package/src/resources/sandbox/connections/index.ts +2 -2
  187. package/src/resources/sandbox/connections.ts +1 -1
  188. package/src/resources/sandbox/directory.ts +11 -4
  189. package/src/resources/sandbox/employment.ts +11 -4
  190. package/src/resources/sandbox/index.ts +8 -8
  191. package/src/resources/sandbox/individual.ts +11 -4
  192. package/src/resources/sandbox/jobs/configuration.ts +17 -2
  193. package/src/resources/sandbox/jobs/index.ts +2 -2
  194. package/src/resources/sandbox/jobs/jobs.ts +11 -4
  195. package/src/resources/sandbox/jobs.ts +1 -1
  196. package/src/resources/sandbox/payment.ts +25 -6
  197. package/src/resources/sandbox/sandbox.ts +15 -15
  198. package/src/resources/sandbox.ts +1 -1
  199. package/src/resources/shared.ts +4 -4
  200. package/src/resources/webhooks.ts +4 -4
  201. package/src/resources.ts +1 -1
  202. package/src/shims/node.ts +3 -3
  203. package/src/shims/web.ts +3 -3
  204. package/src/uploads.ts +4 -4
  205. package/src/version.ts +1 -1
  206. package/version.d.ts +1 -1
  207. package/version.js +1 -1
  208. package/version.mjs +1 -1
@@ -35,6 +35,11 @@ class CompanyResource extends resource_1.APIResource {
35
35
  }
36
36
  /**
37
37
  * Read basic company data
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * const company = await client.hris.company.retrieve();
42
+ * ```
38
43
  */
39
44
  retrieve(options) {
40
45
  return this._client.get('/employer/company', options);
@@ -1 +1 @@
1
- {"version":3,"file":"company.js","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAGhD,gGAA+E;AAC/E,mFAKiD;AAEjD,MAAa,eAAgB,SAAQ,sBAAW;IAAhD;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAQJ,CAAC;IANC;;OAEG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AAXD,0CAWC;AA4HD,eAAe,CAAC,gBAAgB,GAAG,qCAAgB,CAAC;AACpD,eAAe,CAAC,iCAAiC,GAAG,sDAAiC,CAAC"}
1
+ {"version":3,"file":"company.js","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAGhD,gGAA+E;AAC/E,mFAKiD;AAEjD,MAAa,eAAgB,SAAQ,sBAAW;IAAhD;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAaJ,CAAC;IAXC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AAhBD,0CAgBC;AA4HD,eAAe,CAAC,gBAAgB,GAAG,qCAAgB,CAAC;AACpD,eAAe,CAAC,iCAAiC,GAAG,sDAAiC,CAAC"}
@@ -9,6 +9,11 @@ export class CompanyResource extends APIResource {
9
9
  }
10
10
  /**
11
11
  * Read basic company data
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const company = await client.hris.company.retrieve();
16
+ * ```
12
17
  */
13
18
  retrieve(options) {
14
19
  return this._client.get('/employer/company', options);
@@ -1 +1 @@
1
- {"version":3,"file":"company.mjs","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,mBAAmB;OACxB,EACL,gBAAgB,EAGhB,iCAAiC,GAClC;AAED,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAAhD;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAQJ,CAAC;IANC;;OAEG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AA4HD,eAAe,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AACpD,eAAe,CAAC,iCAAiC,GAAG,iCAAiC,CAAC"}
1
+ {"version":3,"file":"company.mjs","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,mBAAmB;OACxB,EACL,gBAAgB,EAGhB,iCAAiC,GAClC;AAED,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAAhD;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAaJ,CAAC;IAXC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AA4HD,eAAe,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AACpD,eAAe,CAAC,iCAAiC,GAAG,iCAAiC,CAAC"}
@@ -9,6 +9,14 @@ export declare class PayStatementItem extends APIResource {
9
9
  * **Beta:** this endpoint currently serves employers onboarded after March 4th and
10
10
  * historical support will be added soon Retrieve a list of detailed pay statement
11
11
  * items for the access token's connection account.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * // Automatically fetches more pages as needed.
16
+ * for await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {
17
+ * // ...
18
+ * }
19
+ * ```
12
20
  */
13
21
  list(query?: PayStatementItemListParams, options?: Core.RequestOptions): Core.PagePromise<PayStatementItemListResponsesPage, PayStatementItemListResponse>;
14
22
  list(options?: Core.RequestOptions): Core.PagePromise<PayStatementItemListResponsesPage, PayStatementItemListResponse>;
@@ -1 +1 @@
1
- {"version":3,"file":"pay-statement-item.d.ts","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;OAIG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;IACpF,IAAI,CACF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;CAarF;AAED,qBAAa,iCAAkC,SAAQ,aAAa,CAAC,4BAA4B,CAAC;CAAG;AAErG,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,CAAC,EAAE,4BAA4B,CAAC,UAAU,CAAC;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,qBAAqB,GAAG,wBAAwB,CAAC;IAEnF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAE1C;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,OAAO,GAAG,qBAAqB,GAAG,wBAAwB,CAAC,CAAC;IAE5F;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,iCAAiC,IAAI,iCAAiC,EACtE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,qBAAqB,IAAI,qBAAqB,EAC9C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"pay-statement-item.d.ts","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;IACpF,IAAI,CACF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;CAarF;AAED,qBAAa,iCAAkC,SAAQ,aAAa,CAAC,4BAA4B,CAAC;CAAG;AAErG,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,CAAC,EAAE,4BAA4B,CAAC,UAAU,CAAC;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,qBAAqB,GAAG,wBAAwB,CAAC;IAEnF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAE1C;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,OAAO,GAAG,qBAAqB,GAAG,wBAAwB,CAAC,CAAC;IAE5F;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,iCAAiC,IAAI,iCAAiC,EACtE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,qBAAqB,IAAI,qBAAqB,EAC9C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -1 +1 @@
1
- {"version":3,"file":"pay-statement-item.js","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAEpD,qDAAoC;AACpC,sCASiB;AACjB,0DAAuD;AAEvD,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0B3D,CAAC;IAZC,IAAI,CACF,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,iCAAiC,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA3BD,4CA2BC;AAED,MAAa,iCAAkC,SAAQ,0BAA2C;CAAG;AAArG,8EAAqG;AA+ErG,gBAAgB,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;AACvF,gBAAgB,CAAC,KAAK,GAAG,aAAK,CAAC;AAC/B,gBAAgB,CAAC,qBAAqB,GAAG,6BAAqB,CAAC"}
1
+ {"version":3,"file":"pay-statement-item.js","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAEpD,qDAAoC;AACpC,sCASiB;AACjB,0DAAuD;AAEvD,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkC3D,CAAC;IAZC,IAAI,CACF,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,iCAAiC,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAnCD,4CAmCC;AAED,MAAa,iCAAkC,SAAQ,0BAA2C;CAAG;AAArG,8EAAqG;AA+ErG,gBAAgB,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;AACvF,gBAAgB,CAAC,KAAK,GAAG,aAAK,CAAC;AAC/B,gBAAgB,CAAC,qBAAqB,GAAG,6BAAqB,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"pay-statement-item.mjs","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,QAAQ;OACb,EAKL,qBAAqB,EAGrB,KAAK,GACN;OACM,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0B3D,CAAC;IAZC,IAAI,CACF,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,iCAAiC,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,iCAAkC,SAAQ,aAA2C;CAAG;AA+ErG,gBAAgB,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;AACvF,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;AAC/B,gBAAgB,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
1
+ {"version":3,"file":"pay-statement-item.mjs","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,QAAQ;OACb,EAKL,qBAAqB,EAGrB,KAAK,GACN;OACM,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkC3D,CAAC;IAZC,IAAI,CACF,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,iCAAiC,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,iCAAkC,SAAQ,aAA2C;CAAG;AA+ErG,gBAAgB,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;AACvF,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;AAC/B,gBAAgB,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
@@ -9,23 +9,53 @@ export declare class Rules extends APIResource {
9
9
  * example, pay statement items that meet certain conditions can be labeled as a
10
10
  * pre-tax 401k. This metadata can be retrieved where pay statement item
11
11
  * information is available.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const rule =
16
+ * await client.hris.company.payStatementItem.rules.create();
17
+ * ```
12
18
  */
13
19
  create(body?: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
14
20
  create(options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
15
21
  /**
16
22
  * **Beta:** this endpoint currently serves employers onboarded after March 4th and
17
23
  * historical support will be added soon Update a rule for a pay statement item.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const rule =
28
+ * await client.hris.company.payStatementItem.rules.update(
29
+ * 'rule_id',
30
+ * );
31
+ * ```
18
32
  */
19
33
  update(ruleId: string, body?: RuleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse>;
20
34
  update(ruleId: string, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse>;
21
35
  /**
22
36
  * **Beta:** this endpoint currently serves employers onboarded after March 4th and
23
37
  * historical support will be added soon List all rules of a connection account.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * // Automatically fetches more pages as needed.
42
+ * for await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {
43
+ * // ...
44
+ * }
45
+ * ```
24
46
  */
25
47
  list(options?: Core.RequestOptions): Core.PagePromise<RuleListResponsesPage, RuleListResponse>;
26
48
  /**
27
49
  * **Beta:** this endpoint currently serves employers onboarded after March 4th and
28
50
  * historical support will be added soon Delete a rule for a pay statement item.
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const rule =
55
+ * await client.hris.company.payStatementItem.rules.delete(
56
+ * 'rule_id',
57
+ * );
58
+ * ```
29
59
  */
30
60
  delete(ruleId: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
31
61
  }
@@ -1 +1 @@
1
- {"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACnG,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAW1E;;;OAGG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,gBAAgB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACtC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAY1F;;;OAGG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;IAI9F;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAG3F;AAED,qBAAa,qBAAsB,SAAQ,aAAa,CAAC,gBAAgB,CAAC;CAAG;AAE7E,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAEzC,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAEzC,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;CACpC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,qBAAqB,IAAI,qBAAqB,EAC9C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACnG,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAW1E;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,gBAAgB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACtC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAY1F;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAG3F;AAED,qBAAa,qBAAsB,SAAQ,aAAa,CAAC,gBAAgB,CAAC;CAAG;AAE7E,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAEzC,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAEzC,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;CACpC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,qBAAqB,IAAI,qBAAqB,EAC9C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -21,6 +21,14 @@ class Rules extends resource_1.APIResource {
21
21
  /**
22
22
  * **Beta:** this endpoint currently serves employers onboarded after March 4th and
23
23
  * historical support will be added soon List all rules of a connection account.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * // Automatically fetches more pages as needed.
28
+ * for await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {
29
+ * // ...
30
+ * }
31
+ * ```
24
32
  */
25
33
  list(options) {
26
34
  return this._client.getAPIList('/employer/pay-statement-item/rule', RuleListResponsesPage, options);
@@ -28,6 +36,14 @@ class Rules extends resource_1.APIResource {
28
36
  /**
29
37
  * **Beta:** this endpoint currently serves employers onboarded after March 4th and
30
38
  * historical support will be added soon Delete a rule for a pay statement item.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const rule =
43
+ * await client.hris.company.payStatementItem.rules.delete(
44
+ * 'rule_id',
45
+ * );
46
+ * ```
31
47
  */
32
48
  delete(ruleId, options) {
33
49
  return this._client.delete(`/employer/pay-statement-item/rule/${ruleId}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAEpD,0DAAuD;AAEvD,MAAa,KAAM,SAAQ,sBAAW;IAWpC,MAAM,CACJ,OAA+C,EAAE,EACjD,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,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAYD,MAAM,CACJ,MAAc,EACd,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mCAAmC,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qCAAqC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAzDD,sBAyDC;AAED,MAAa,qBAAsB,SAAQ,0BAA+B;CAAG;AAA7E,sDAA6E;AAyW7E,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
1
+ {"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAEpD,0DAAuD;AAEvD,MAAa,KAAM,SAAQ,sBAAW;IAiBpC,MAAM,CACJ,OAA+C,EAAE,EACjD,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,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAoBD,MAAM,CACJ,MAAc,EACd,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mCAAmC,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qCAAqC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAvFD,sBAuFC;AAED,MAAa,qBAAsB,SAAQ,0BAA+B;CAAG;AAA7E,sDAA6E;AAyW7E,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
@@ -18,6 +18,14 @@ export class Rules extends APIResource {
18
18
  /**
19
19
  * **Beta:** this endpoint currently serves employers onboarded after March 4th and
20
20
  * historical support will be added soon List all rules of a connection account.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * // Automatically fetches more pages as needed.
25
+ * for await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {
26
+ * // ...
27
+ * }
28
+ * ```
21
29
  */
22
30
  list(options) {
23
31
  return this._client.getAPIList('/employer/pay-statement-item/rule', RuleListResponsesPage, options);
@@ -25,6 +33,14 @@ export class Rules extends APIResource {
25
33
  /**
26
34
  * **Beta:** this endpoint currently serves employers onboarded after March 4th and
27
35
  * historical support will be added soon Delete a rule for a pay statement item.
36
+ *
37
+ * @example
38
+ * ```ts
39
+ * const rule =
40
+ * await client.hris.company.payStatementItem.rules.delete(
41
+ * 'rule_id',
42
+ * );
43
+ * ```
28
44
  */
29
45
  delete(ruleId, options) {
30
46
  return this._client.delete(`/employer/pay-statement-item/rule/${ruleId}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"rules.mjs","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,KAAM,SAAQ,WAAW;IAWpC,MAAM,CACJ,OAA+C,EAAE,EACjD,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,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAYD,MAAM,CACJ,MAAc,EACd,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mCAAmC,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qCAAqC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,aAA+B;CAAG;AAyW7E,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
1
+ {"version":3,"file":"rules.mjs","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,KAAM,SAAQ,WAAW;IAiBpC,MAAM,CACJ,OAA+C,EAAE,EACjD,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,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAoBD,MAAM,CACJ,MAAc,EACd,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mCAAmC,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qCAAqC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,aAA+B;CAAG;AAyW7E,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
@@ -4,6 +4,14 @@ import { IndividualsPage, type IndividualsPageParams } from "../../pagination.js
4
4
  export declare class Directory extends APIResource {
5
5
  /**
6
6
  * Read company directory and organization structure
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * // Automatically fetches more pages as needed.
11
+ * for await (const individualInDirectory of client.hris.directory.list()) {
12
+ * // ...
13
+ * }
14
+ * ```
7
15
  */
8
16
  list(query?: DirectoryListParams, options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
9
17
  list(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
@@ -19,31 +27,31 @@ export interface IndividualInDirectory {
19
27
  /**
20
28
  * A stable Finch `id` (UUID v4) for an individual in the company.
21
29
  */
22
- id?: string;
30
+ id: string;
23
31
  /**
24
32
  * The department object.
25
33
  */
26
- department?: IndividualInDirectory.Department | null;
34
+ department: IndividualInDirectory.Department | null;
27
35
  /**
28
36
  * The legal first name of the individual.
29
37
  */
30
- first_name?: string | null;
38
+ first_name: string | null;
31
39
  /**
32
40
  * `true` if the individual is an active employee or contractor at the company.
33
41
  */
34
- is_active?: boolean | null;
42
+ is_active: boolean | null;
35
43
  /**
36
44
  * The legal last name of the individual.
37
45
  */
38
- last_name?: string | null;
46
+ last_name: string | null;
39
47
  /**
40
48
  * The manager object.
41
49
  */
42
- manager?: IndividualInDirectory.Manager | null;
50
+ manager: IndividualInDirectory.Manager | null;
43
51
  /**
44
52
  * The legal middle name of the individual.
45
53
  */
46
- middle_name?: string | null;
54
+ middle_name: string | null;
47
55
  }
48
56
  export declare namespace IndividualInDirectory {
49
57
  /**
@@ -62,7 +70,7 @@ export declare namespace IndividualInDirectory {
62
70
  /**
63
71
  * A stable Finch `id` (UUID v4) for an individual in the company.
64
72
  */
65
- id?: string;
73
+ id: string;
66
74
  }
67
75
  }
68
76
  export interface DirectoryListParams extends IndividualsPageParams {
@@ -1 +1 @@
1
- {"version":3,"file":"directory.d.ts","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAE/E,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAW7F;;OAEG;IACH,eAAe;iBAjBL,mBAAmB,YACjB,KAAK,cAAc,GAC5B,KAAK,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;mBAC5C,KAAK,cAAc,GAAG,KAAK,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;MAcjE;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC,UAAU,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;CAAG;AAErE,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;CAAG;AAEhF,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
1
+ {"version":3,"file":"directory.d.ts","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAE/E,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAW7F;;OAEG;IACH,eAAe;iBAjBL,mBAAmB,YACjB,KAAK,cAAc,GAC5B,KAAK,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;mBAC5C,KAAK,cAAc,GAAG,KAAK,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;MAcjE;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAC,UAAU,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;CAAG;AAErE,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;CAAG;AAEhF,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
@@ -1 +1 @@
1
- {"version":3,"file":"directory.js","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAA+E;AAE/E,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QAmBE;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAdC,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,4BAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CAMF;AAvBD,8BAuBC"}
1
+ {"version":3,"file":"directory.js","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAA+E;AAE/E,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QA2BE;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAdC,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,4BAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CAMF;AA/BD,8BA+BC"}
@@ -1 +1 @@
1
- {"version":3,"file":"directory.mjs","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,eAAe,EAA8B;AAEtD,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QAmBE;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAdC,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CAMF"}
1
+ {"version":3,"file":"directory.mjs","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,eAAe,EAA8B;AAEtD,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QA2BE;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAdC,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CAMF"}
@@ -5,12 +5,24 @@ export declare class Documents extends APIResource {
5
5
  /**
6
6
  * **Beta:** This endpoint is in beta and may change. Retrieve a list of
7
7
  * company-wide documents.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const documents = await client.hris.documents.list();
12
+ * ```
8
13
  */
9
14
  list(query?: DocumentListParams, options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
10
15
  list(options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
11
16
  /**
12
17
  * **Beta:** This endpoint is in beta and may change. Retrieve details of a
13
18
  * specific document by its ID.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const response = await client.hris.documents.retreive(
23
+ * 'document_id',
24
+ * );
25
+ * ```
14
26
  */
15
27
  retreive(documentId: string, options?: Core.RequestOptions): Core.APIPromise<DocumentRetreiveResponse>;
16
28
  }
@@ -1 +1 @@
1
- {"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;OAGG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IACtG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAW1E;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;CAGvG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAE7B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,SAAS,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;QAEpC;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,GAAG,4CAA4C,GAAG,QAAQ,GAAG,IAAI,CAAC;QAE3F;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5C;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,uCAAuC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,aAAa,CAAC,EACV,mBAAmB,GACnB,uDAAuD,GACvD,qCAAqC,GACrC,IAAI,CAAC;QAET;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,uCAAuC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzD;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEnC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvD,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IACtG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAW1E;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;CAGvG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAE7B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,SAAS,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;QAEpC;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,GAAG,4CAA4C,GAAG,QAAQ,GAAG,IAAI,CAAC;QAE3F;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5C;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,uCAAuC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,aAAa,CAAC,EACV,mBAAmB,GACnB,uDAAuD,GACvD,qCAAqC,GACrC,IAAI,CAAC;QAET;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,uCAAuC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzD;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEnC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvD,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -14,6 +14,13 @@ class Documents extends resource_1.APIResource {
14
14
  /**
15
15
  * **Beta:** This endpoint is in beta and may change. Retrieve details of a
16
16
  * specific document by its ID.
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * const response = await client.hris.documents.retreive(
21
+ * 'document_id',
22
+ * );
23
+ * ```
17
24
  */
18
25
  retreive(documentId, options) {
19
26
  return this._client.get(`/employer/documents/${documentId}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,MAAa,SAAU,SAAQ,sBAAW;IAOxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AAxBD,8BAwBC"}
1
+ {"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,MAAa,SAAU,SAAQ,sBAAW;IAYxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AApCD,8BAoCC"}
@@ -11,6 +11,13 @@ export class Documents extends APIResource {
11
11
  /**
12
12
  * **Beta:** This endpoint is in beta and may change. Retrieve details of a
13
13
  * specific document by its ID.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const response = await client.hris.documents.retreive(
18
+ * 'document_id',
19
+ * );
20
+ * ```
14
21
  */
15
22
  retreive(documentId, options) {
16
23
  return this._client.get(`/employer/documents/${documentId}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"documents.mjs","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B,MAAM,OAAO,SAAU,SAAQ,WAAW;IAOxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF"}
1
+ {"version":3,"file":"documents.mjs","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B,MAAM,OAAO,SAAU,SAAQ,WAAW;IAYxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF"}