@tryfinch/finch-api 6.27.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.
Files changed (153) hide show
  1. package/CHANGELOG.md +42 -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 +16 -0
  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 +19 -0
  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/resources/access-tokens.ts +8 -0
  127. package/src/resources/hris/benefits/benefits.ts +83 -0
  128. package/src/resources/hris/benefits/individuals.ts +35 -0
  129. package/src/resources/hris/company/company.ts +15 -10
  130. package/src/resources/hris/company/pay-statement-item/pay-statement-item.ts +8 -0
  131. package/src/resources/hris/company/pay-statement-item/rules.ts +30 -0
  132. package/src/resources/hris/directory.ts +16 -8
  133. package/src/resources/hris/documents.ts +12 -0
  134. package/src/resources/hris/employments.ts +139 -115
  135. package/src/resources/hris/hris.ts +14 -14
  136. package/src/resources/hris/individuals.ts +96 -74
  137. package/src/resources/hris/pay-statements.ts +16 -0
  138. package/src/resources/hris/payments.ts +11 -0
  139. package/src/resources/request-forwarding.ts +10 -0
  140. package/src/resources/sandbox/company.ts +23 -0
  141. package/src/resources/sandbox/connections/accounts.ts +17 -0
  142. package/src/resources/sandbox/connections/connections.ts +7 -0
  143. package/src/resources/sandbox/directory.ts +7 -0
  144. package/src/resources/sandbox/employment.ts +7 -0
  145. package/src/resources/sandbox/individual.ts +7 -0
  146. package/src/resources/sandbox/jobs/configuration.ts +15 -0
  147. package/src/resources/sandbox/jobs/jobs.ts +7 -0
  148. package/src/resources/sandbox/payment.ts +19 -0
  149. package/src/resources/shared.ts +4 -4
  150. package/src/version.ts +1 -1
  151. package/version.d.ts +1 -1
  152. package/version.js +1 -1
  153. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"employments.d.ts","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,YAAY,CACV,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,sBAAsB,CAAC;CAOzE;AAED,qBAAa,2BAA4B,SAAQ,aAAa,CAAC,sBAAsB,CAAC;CAAG;AAEzF,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,CAAC,EACd,QAAQ,GACR,UAAU,GACV,OAAO,GACP,YAAY,GACZ,SAAS,GACT,SAAS,GACT,YAAY,GACZ,IAAI,CAAC;IAET,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;QAEtG;;WAEG;QACH,IAAI,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;KACzC;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;CACvD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,OAAO;QACtB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"employments.d.ts","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,sBAAsB,CAAC;CAOzE;AAED,qBAAa,2BAA4B,SAAQ,aAAa,CAAC,sBAAsB,CAAC;CAAG;AAEzF,MAAM,MAAM,cAAc,GAAG,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,UAAU,CAAC;AAErF,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,aAAa,EAAE,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,UAAU,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI,CAAC;QAE3C;;;WAGG;QACH,iBAAiB,EACb,QAAQ,GACR,UAAU,GACV,OAAO,GACP,YAAY,GACZ,SAAS,GACT,SAAS,GACT,YAAY,GACZ,IAAI,CAAC;QAET,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAErC;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;WAIG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,WAAW;YAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;SACrE;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;SACrB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;;eAGG;YACH,OAAO,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;YAErG;;eAEG;YACH,IAAI,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;SACxC;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;SACZ;KACF;IAED,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,cAAc,CAAC;IAErB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;CACvD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,OAAO;QACtB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -7,6 +7,16 @@ const pagination_1 = require("../../pagination.js");
7
7
  class Employments extends resource_1.APIResource {
8
8
  /**
9
9
  * Read individual employment and income data
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * // Automatically fetches more pages as needed.
14
+ * for await (const employmentDataResponse of client.hris.employments.retrieveMany(
15
+ * { requests: [{ individual_id: 'individual_id' }] },
16
+ * )) {
17
+ * // ...
18
+ * }
19
+ * ```
10
20
  */
11
21
  retrieveMany(body, options) {
12
22
  return this._client.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
@@ -1 +1 @@
1
- {"version":3,"file":"employments.js","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,oDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;OAEG;IACH,YAAY,CACV,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,2BAA2B,EAAE;YAClF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAdD,kCAcC;AAED,MAAa,2BAA4B,SAAQ,0BAAqC;CAAG;AAAzF,kEAAyF;AAiLzF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
1
+ {"version":3,"file":"employments.js","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,oDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,2BAA2B,EAAE;YAClF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,kCAwBC;AAED,MAAa,2BAA4B,SAAQ,0BAAqC;CAAG;AAAzF,kEAAyF;AA+LzF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
@@ -4,6 +4,16 @@ import { ResponsesPage } from "../../pagination.mjs";
4
4
  export class Employments extends APIResource {
5
5
  /**
6
6
  * Read individual employment and income data
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * // Automatically fetches more pages as needed.
11
+ * for await (const employmentDataResponse of client.hris.employments.retrieveMany(
12
+ * { requests: [{ individual_id: 'individual_id' }] },
13
+ * )) {
14
+ * // ...
15
+ * }
16
+ * ```
7
17
  */
8
18
  retrieveMany(body, options) {
9
19
  return this._client.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
@@ -1 +1 @@
1
- {"version":3,"file":"employments.mjs","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,YAAY,CACV,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,2BAA2B,EAAE;YAClF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,aAAqC;CAAG;AAiLzF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
1
+ {"version":3,"file":"employments.mjs","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,2BAA2B,EAAE;YAClF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,aAAqC;CAAG;AA+LzF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
@@ -34,48 +34,48 @@ export interface Income {
34
34
  /**
35
35
  * The income amount in cents.
36
36
  */
37
- amount?: number | null;
37
+ amount: number | null;
38
38
  /**
39
39
  * The currency code.
40
40
  */
41
- currency?: string | null;
41
+ currency: string | null;
42
42
  /**
43
43
  * The date the income amount went into effect.
44
44
  */
45
- effective_date?: string | null;
45
+ effective_date: string | null;
46
46
  /**
47
47
  * The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
48
48
  * `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
49
49
  */
50
- unit?: 'yearly' | 'quarterly' | 'monthly' | 'semi_monthly' | 'bi_weekly' | 'weekly' | 'daily' | 'hourly' | 'fixed' | null;
50
+ unit: 'yearly' | 'quarterly' | 'monthly' | 'semi_monthly' | 'bi_weekly' | 'weekly' | 'daily' | 'hourly' | 'fixed' | null;
51
51
  }
52
52
  export interface Location {
53
53
  /**
54
54
  * City, district, suburb, town, or village.
55
55
  */
56
- city?: string | null;
56
+ city: string | null;
57
57
  /**
58
58
  * The 2-letter ISO 3166 country code.
59
59
  */
60
- country?: string | null;
60
+ country: string | null;
61
61
  /**
62
62
  * Street address or PO box.
63
63
  */
64
- line1?: string | null;
64
+ line1: string | null;
65
65
  /**
66
66
  * Apartment, suite, unit, or building.
67
67
  */
68
- line2?: string | null;
69
- name?: string | null;
68
+ line2: string | null;
70
69
  /**
71
70
  * The postal code or zip code.
72
71
  */
73
- postal_code?: string | null;
74
- source_id?: string | null;
72
+ postal_code: string | null;
75
73
  /**
76
74
  * The state code.
77
75
  */
78
- state?: string | null;
76
+ state: string | null;
77
+ name?: string | null;
78
+ source_id?: string | null;
79
79
  }
80
80
  export interface Money {
81
81
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"hris.d.ts","sourceRoot":"","sources":["../../src/resources/hris/hris.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,SAAS,EACT,8BAA8B,EAC9B,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,wBAAwB,EACxB,SAAS,EACT,MAAM,EACN,MAAM,EACP,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,2BAA2B,EAC3B,4BAA4B,EAC5B,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,8BAA8B,EAC9B,aAAa,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACtF,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,oCAAoC,EACpC,+CAA+C,EAC/C,WAAW,EACX,mBAAmB,EACnB,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EACzB,6BAA6B,EAC7B,qBAAqB,EACrB,gBAAgB,EAChB,4BAA4B,EAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE7D,qBAAa,IAAK,SAAQ,WAAW;IACnC,OAAO,EAAE,UAAU,CAAC,eAAe,CAAgD;IACnF,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;CACzE;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EACD,QAAQ,GACR,WAAW,GACX,SAAS,GACT,cAAc,GACd,WAAW,GACX,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,OAAO,GACP,IAAI,CAAC;CACV;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAiBD,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,CAAC;IAEjF,OAAO,EAAE,eAAe,IAAI,eAAe,EAAE,KAAK,OAAO,IAAI,OAAO,EAAE,CAAC;IAEvE,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,kBAAkB,IAAI,kBAAkB,EACxC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,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;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,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;CACH"}
1
+ {"version":3,"file":"hris.d.ts","sourceRoot":"","sources":["../../src/resources/hris/hris.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,SAAS,EACT,8BAA8B,EAC9B,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,wBAAwB,EACxB,SAAS,EACT,MAAM,EACN,MAAM,EACP,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,2BAA2B,EAC3B,4BAA4B,EAC5B,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,8BAA8B,EAC9B,aAAa,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACtF,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,oCAAoC,EACpC,+CAA+C,EAC/C,WAAW,EACX,mBAAmB,EACnB,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EACzB,6BAA6B,EAC7B,qBAAqB,EACrB,gBAAgB,EAChB,4BAA4B,EAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE7D,qBAAa,IAAK,SAAQ,WAAW;IACnC,OAAO,EAAE,UAAU,CAAC,eAAe,CAAgD;IACnF,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;CACzE;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EACA,QAAQ,GACR,WAAW,GACX,SAAS,GACT,cAAc,GACd,WAAW,GACX,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,OAAO,GACP,IAAI,CAAC;CACV;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAiBD,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,CAAC;IAEjF,OAAO,EAAE,eAAe,IAAI,eAAe,EAAE,KAAK,OAAO,IAAI,OAAO,EAAE,CAAC;IAEvE,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,kBAAkB,IAAI,kBAAkB,EACxC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,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;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,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;CACH"}
@@ -5,73 +5,90 @@ import { ResponsesPage } from "../../pagination.js";
5
5
  export declare class Individuals extends APIResource {
6
6
  /**
7
7
  * Read individual data, excluding income and employment data
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * // Automatically fetches more pages as needed.
12
+ * for await (const individualResponse of client.hris.individuals.retrieveMany()) {
13
+ * // ...
14
+ * }
15
+ * ```
8
16
  */
9
17
  retrieveMany(body?: IndividualRetrieveManyParams, options?: Core.RequestOptions): Core.PagePromise<IndividualResponsesPage, IndividualResponse>;
10
18
  retrieveMany(options?: Core.RequestOptions): Core.PagePromise<IndividualResponsesPage, IndividualResponse>;
11
19
  }
12
20
  export declare class IndividualResponsesPage extends ResponsesPage<IndividualResponse> {
13
21
  }
14
- export interface Individual {
15
- /**
16
- * A stable Finch `id` (UUID v4) for an individual in the company.
17
- */
18
- id?: string;
19
- dob?: string | null;
20
- emails?: Array<Individual.Email> | null;
21
- /**
22
- * Social Security Number of the individual in **encrypted** format. This field is
23
- * only available with the `ssn` scope enabled and the
24
- * `options: { include: ['ssn'] }` param set in the body.
25
- */
26
- encrypted_ssn?: string | null;
27
- /**
28
- * The EEOC-defined ethnicity of the individual.
29
- */
30
- ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null;
31
- /**
32
- * The legal first name of the individual.
33
- */
34
- first_name?: string | null;
35
- /**
36
- * The gender of the individual.
37
- */
38
- gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
39
- /**
40
- * The legal last name of the individual.
41
- */
42
- last_name?: string | null;
43
- /**
44
- * The legal middle name of the individual.
45
- */
46
- middle_name?: string | null;
47
- phone_numbers?: Array<Individual.PhoneNumber | null> | null;
48
- /**
49
- * The preferred name of the individual.
50
- */
51
- preferred_name?: string | null;
52
- residence?: HRISAPI.Location | null;
53
- /**
54
- * Social Security Number of the individual. This field is only available with the
55
- * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
56
- * body.
57
- * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
58
- */
59
- ssn?: string | null;
60
- }
22
+ export type Individual = Individual.UnionMember0 | Individual.BatchError;
61
23
  export declare namespace Individual {
62
- interface Email {
63
- data?: string;
64
- type?: 'work' | 'personal' | null;
24
+ interface UnionMember0 {
25
+ /**
26
+ * A stable Finch `id` (UUID v4) for an individual in the company.
27
+ */
28
+ id: string;
29
+ dob: string | null;
30
+ /**
31
+ * The EEOC-defined ethnicity of the individual.
32
+ */
33
+ ethnicity: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null;
34
+ /**
35
+ * The legal first name of the individual.
36
+ */
37
+ first_name: string | null;
38
+ /**
39
+ * The gender of the individual.
40
+ */
41
+ gender: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
42
+ /**
43
+ * The legal last name of the individual.
44
+ */
45
+ last_name: string | null;
46
+ /**
47
+ * The legal middle name of the individual.
48
+ */
49
+ middle_name: string | null;
50
+ phone_numbers: Array<UnionMember0.PhoneNumber | null> | null;
51
+ /**
52
+ * The preferred name of the individual.
53
+ */
54
+ preferred_name: string | null;
55
+ residence: HRISAPI.Location | null;
56
+ emails?: Array<UnionMember0.Email> | null;
57
+ /**
58
+ * Social Security Number of the individual in **encrypted** format. This field is
59
+ * only available with the `ssn` scope enabled and the
60
+ * `options: { include: ['ssn'] }` param set in the body.
61
+ */
62
+ encrypted_ssn?: string | null;
63
+ /**
64
+ * Social Security Number of the individual. This field is only available with the
65
+ * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
66
+ * body.
67
+ * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
68
+ */
69
+ ssn?: string | null;
70
+ }
71
+ namespace UnionMember0 {
72
+ interface PhoneNumber {
73
+ data: string | null;
74
+ type: 'work' | 'personal' | null;
75
+ }
76
+ interface Email {
77
+ data: string;
78
+ type: 'work' | 'personal' | null;
79
+ }
65
80
  }
66
- interface PhoneNumber {
67
- data?: string | null;
68
- type?: 'work' | 'personal' | null;
81
+ interface BatchError {
82
+ code: number;
83
+ message: string;
84
+ name: string;
85
+ finch_code?: string;
69
86
  }
70
87
  }
71
88
  export interface IndividualResponse {
72
- body?: Individual;
73
- code?: number;
74
- individual_id?: string;
89
+ body: Individual;
90
+ code: number;
91
+ individual_id: string;
75
92
  }
76
93
  export interface IndividualRetrieveManyParams {
77
94
  options?: IndividualRetrieveManyParams.Options | null;
@@ -1 +1 @@
1
- {"version":3,"file":"individuals.d.ts","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,YAAY,CACV,IAAI,CAAC,EAAE,4BAA4B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAChE,YAAY,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;CAc3G;AAED,qBAAa,uBAAwB,SAAQ,aAAa,CAAC,kBAAkB,CAAC;CAAG;AAEjF,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EACN,OAAO,GACP,OAAO,GACP,2BAA2B,GAC3B,qCAAqC,GACrC,kCAAkC,GAClC,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,IAAI,CAAC;IAET;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,SAAS,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,KAAK;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;KACnC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD,QAAQ,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;CACxD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,OAAO;QACtB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;IAED,UAAiB,OAAO;QACtB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"individuals.d.ts","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAAI,CAAC,EAAE,4BAA4B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAChE,YAAY,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;CAc3G;AAED,qBAAa,uBAAwB,SAAQ,aAAa,CAAC,kBAAkB,CAAC;CAAG;AAEjF,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC;AAEzE,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,SAAS,EACL,OAAO,GACP,OAAO,GACP,2BAA2B,GAC3B,qCAAqC,GACrC,kCAAkC,GAClC,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,IAAI,CAAC;QAET;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;QAElE;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,aAAa,EAAE,KAAK,CAAC,YAAY,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAE7D;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B,SAAS,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEnC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAE1C;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;;;WAKG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,WAAW;YAC1B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;SAClC;QAED,UAAiB,KAAK;YACpB,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;SAClC;KACF;IAED,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,UAAU,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD,QAAQ,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;CACxD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,OAAO;QACtB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;IAED,UAAiB,OAAO;QACtB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -1 +1 @@
1
- {"version":3,"file":"individuals.js","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,oDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAS1C,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,uBAAuB,EAAE;YAC9E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAtBD,kCAsBC;AAED,MAAa,uBAAwB,SAAQ,0BAAiC;CAAG;AAAjF,0DAAiF;AA6GjF,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,CAAC"}
1
+ {"version":3,"file":"individuals.js","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,oDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAiB1C,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,uBAAuB,EAAE;YAC9E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA9BD,kCA8BC;AAED,MAAa,uBAAwB,SAAQ,0BAAiC;CAAG;AAAjF,0DAAiF;AA2HjF,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"individuals.mjs","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAS1C,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,uBAAuB,EAAE;YAC9E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,aAAiC;CAAG;AA6GjF,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,CAAC"}
1
+ {"version":3,"file":"individuals.mjs","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAiB1C,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,uBAAuB,EAAE;YAC9E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,aAAiC;CAAG;AA2HjF,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,CAAC"}
@@ -10,6 +10,22 @@ export declare class PayStatements extends APIResource {
10
10
  *
11
11
  * Deduction and contribution types are supported by the payroll systems that
12
12
  * supports Benefits.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * // Automatically fetches more pages as needed.
17
+ * for await (const payStatementResponse of client.hris.payStatements.retrieveMany(
18
+ * {
19
+ * requests: [
20
+ * {
21
+ * payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
22
+ * },
23
+ * ],
24
+ * },
25
+ * )) {
26
+ * // ...
27
+ * }
28
+ * ```
13
29
  */
14
30
  retrieveMany(body: PayStatementRetrieveManyParams, options?: Core.RequestOptions): Core.PagePromise<PayStatementResponsesPage, PayStatementResponse>;
15
31
  }
@@ -1 +1 @@
1
- {"version":3,"file":"pay-statements.d.ts","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;OAKG;IACH,YAAY,CACV,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;CAOrE;AAED,qBAAa,yBAA0B,SAAQ,aAAa,CAAC,oBAAoB,CAAC;CAAG;AAErF,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1E,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhF,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,IAAI,CAAC;CAC5E;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EACD,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;KACV;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,wBAAwB,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;CACzD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
1
+ {"version":3,"file":"pay-statements.d.ts","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;CAOrE;AAED,qBAAa,yBAA0B,SAAQ,aAAa,CAAC,oBAAoB,CAAC;CAAG;AAErF,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1E,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhF,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,IAAI,CAAC;CAC5E;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EACD,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;KACV;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,wBAAwB,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;CACzD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
@@ -10,6 +10,22 @@ class PayStatements extends resource_1.APIResource {
10
10
  *
11
11
  * Deduction and contribution types are supported by the payroll systems that
12
12
  * supports Benefits.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * // Automatically fetches more pages as needed.
17
+ * for await (const payStatementResponse of client.hris.payStatements.retrieveMany(
18
+ * {
19
+ * requests: [
20
+ * {
21
+ * payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
22
+ * },
23
+ * ],
24
+ * },
25
+ * )) {
26
+ * // ...
27
+ * }
28
+ * ```
13
29
  */
14
30
  retrieveMany(body, options) {
15
31
  return this._client.getAPIList('/employer/pay-statement', PayStatementResponsesPage, {
@@ -1 +1 @@
1
- {"version":3,"file":"pay-statements.js","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAK7C,oDAAiD;AAEjD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;OAKG;IACH,YAAY,CACV,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,yBAAyB,EAAE;YACnF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAjBD,sCAiBC;AAED,MAAa,yBAA0B,SAAQ,0BAAmC;CAAG;AAArF,8DAAqF;AA4RrF,aAAa,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}
1
+ {"version":3,"file":"pay-statements.js","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAK7C,oDAAiD;AAEjD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,yBAAyB,EAAE;YACnF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAjCD,sCAiCC;AAED,MAAa,yBAA0B,SAAQ,0BAAmC;CAAG;AAArF,8DAAqF;AA4RrF,aAAa,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}
@@ -7,6 +7,22 @@ export class PayStatements extends APIResource {
7
7
  *
8
8
  * Deduction and contribution types are supported by the payroll systems that
9
9
  * supports Benefits.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * // Automatically fetches more pages as needed.
14
+ * for await (const payStatementResponse of client.hris.payStatements.retrieveMany(
15
+ * {
16
+ * requests: [
17
+ * {
18
+ * payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
19
+ * },
20
+ * ],
21
+ * },
22
+ * )) {
23
+ * // ...
24
+ * }
25
+ * ```
10
26
  */
11
27
  retrieveMany(body, options) {
12
28
  return this._client.getAPIList('/employer/pay-statement', PayStatementResponsesPage, {
@@ -1 +1 @@
1
- {"version":3,"file":"pay-statements.mjs","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;OAKG;IACH,YAAY,CACV,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,yBAAyB,EAAE;YACnF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,aAAmC;CAAG;AA4RrF,aAAa,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}
1
+ {"version":3,"file":"pay-statements.mjs","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,yBAAyB,EAAE;YACnF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,aAAmC;CAAG;AA4RrF,aAAa,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}
@@ -5,6 +5,17 @@ import { SinglePage } from "../../pagination.js";
5
5
  export declare class Payments extends APIResource {
6
6
  /**
7
7
  * Read payroll and contractor related payments by the company.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * // Automatically fetches more pages as needed.
12
+ * for await (const payment of client.hris.payments.list({
13
+ * end_date: '2021-01-01',
14
+ * start_date: '2021-01-01',
15
+ * })) {
16
+ * // ...
17
+ * }
18
+ * ```
8
19
  */
9
20
  list(query: PaymentListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentsSinglePage, Payment>;
10
21
  }
@@ -1 +1 @@
1
- {"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/resources/hris/payments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,OAAO,CAAC;CAGjD;AAED,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,OAAO,CAAC;CAAG;AAE9D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,aAAa,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAErC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,cAAc,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC,cAAc,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CACnB,UAAU,GACV,eAAe,GACf,WAAW,GACX,SAAS,GACT,cAAc,GACd,WAAW,GACX,QAAQ,GACR,OAAO,GACP,OAAO,CACV,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,SAAS;QACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,kBAAkB,IAAI,kBAAkB,EACxC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
1
+ {"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/resources/hris/payments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,OAAO,CAAC;CAGjD;AAED,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,OAAO,CAAC;CAAG;AAE9D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,aAAa,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAErC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,cAAc,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC,cAAc,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CACnB,UAAU,GACV,eAAe,GACf,WAAW,GACX,SAAS,GACT,cAAc,GACd,WAAW,GACX,QAAQ,GACR,OAAO,GACP,OAAO,CACV,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,SAAS;QACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,kBAAkB,IAAI,kBAAkB,EACxC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
@@ -7,6 +7,17 @@ const pagination_1 = require("../../pagination.js");
7
7
  class Payments extends resource_1.APIResource {
8
8
  /**
9
9
  * Read payroll and contractor related payments by the company.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * // Automatically fetches more pages as needed.
14
+ * for await (const payment of client.hris.payments.list({
15
+ * end_date: '2021-01-01',
16
+ * start_date: '2021-01-01',
17
+ * })) {
18
+ * // ...
19
+ * }
20
+ * ```
10
21
  */
11
22
  list(query, options) {
12
23
  return this._client.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"payments.js","sourceRoot":"","sources":["../../src/resources/hris/payments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,IAAI,CACF,KAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF;AAVD,4BAUC;AAED,MAAa,kBAAmB,SAAQ,uBAAmB;CAAG;AAA9D,gDAA8D;AA8E9D,QAAQ,CAAC,kBAAkB,GAAG,kBAAkB,CAAC"}
1
+ {"version":3,"file":"payments.js","sourceRoot":"","sources":["../../src/resources/hris/payments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF;AArBD,4BAqBC;AAED,MAAa,kBAAmB,SAAQ,uBAAmB;CAAG;AAA9D,gDAA8D;AA8E9D,QAAQ,CAAC,kBAAkB,GAAG,kBAAkB,CAAC"}
@@ -4,6 +4,17 @@ import { SinglePage } from "../../pagination.mjs";
4
4
  export class Payments extends APIResource {
5
5
  /**
6
6
  * Read payroll and contractor related payments by the company.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * // Automatically fetches more pages as needed.
11
+ * for await (const payment of client.hris.payments.list({
12
+ * end_date: '2021-01-01',
13
+ * start_date: '2021-01-01',
14
+ * })) {
15
+ * // ...
16
+ * }
17
+ * ```
7
18
  */
8
19
  list(query, options) {
9
20
  return this._client.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"payments.mjs","sourceRoot":"","sources":["../../src/resources/hris/payments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CACF,KAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,UAAmB;CAAG;AA8E9D,QAAQ,CAAC,kBAAkB,GAAG,kBAAkB,CAAC"}
1
+ {"version":3,"file":"payments.mjs","sourceRoot":"","sources":["../../src/resources/hris/payments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,UAAmB;CAAG;AA8E9D,QAAQ,CAAC,kBAAkB,GAAG,kBAAkB,CAAC"}
@@ -6,6 +6,16 @@ export declare class RequestForwarding extends APIResource {
6
6
  * Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
7
7
  * Forward allows you to push or pull data models directly against an integration’s
8
8
  * API.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response = await client.requestForwarding.forward({
13
+ * method: 'POST',
14
+ * route: '/people/search',
15
+ * headers: { 'content-type': 'application/json' },
16
+ * params: { showInactive: true, humanReadable: true },
17
+ * });
18
+ * ```
9
19
  */
10
20
  forward(body: RequestForwardingForwardParams, options?: Core.RequestOptions): Core.APIPromise<RequestForwardingForwardResponse>;
11
21
  }
@@ -1 +1 @@
1
- {"version":3,"file":"request-forwarding.d.ts","sourceRoot":"","sources":["../src/resources/request-forwarding.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;;;;OAKG;IACH,OAAO,CACL,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;CAGrD;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,OAAO,EAAE,gCAAgC,CAAC,OAAO,CAAC;IAElD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;;OAGG;IACH,UAAiB,OAAO;QACtB;;;;WAIG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;;WAGG;QACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
1
+ {"version":3,"file":"request-forwarding.d.ts","sourceRoot":"","sources":["../src/resources/request-forwarding.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;CAGrD;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,OAAO,EAAE,gCAAgC,CAAC,OAAO,CAAC;IAElD;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;;OAGG;IACH,UAAiB,OAAO;QACtB;;;;WAIG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;;WAGG;QACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
@@ -9,6 +9,16 @@ class RequestForwarding extends resource_1.APIResource {
9
9
  * Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
10
10
  * Forward allows you to push or pull data models directly against an integration’s
11
11
  * API.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const response = await client.requestForwarding.forward({
16
+ * method: 'POST',
17
+ * route: '/people/search',
18
+ * headers: { 'content-type': 'application/json' },
19
+ * params: { showInactive: true, humanReadable: true },
20
+ * });
21
+ * ```
12
22
  */
13
23
  forward(body, options) {
14
24
  return this._client.post('/forward', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"request-forwarding.js","sourceRoot":"","sources":["../src/resources/request-forwarding.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD;;;;;OAKG;IACH,OAAO,CACL,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AAbD,8CAaC"}
1
+ {"version":3,"file":"request-forwarding.js","sourceRoot":"","sources":["../src/resources/request-forwarding.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AAvBD,8CAuBC"}
@@ -6,6 +6,16 @@ export class RequestForwarding extends APIResource {
6
6
  * Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
7
7
  * Forward allows you to push or pull data models directly against an integration’s
8
8
  * API.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response = await client.requestForwarding.forward({
13
+ * method: 'POST',
14
+ * route: '/people/search',
15
+ * headers: { 'content-type': 'application/json' },
16
+ * params: { showInactive: true, humanReadable: true },
17
+ * });
18
+ * ```
9
19
  */
10
20
  forward(body, options) {
11
21
  return this._client.post('/forward', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"request-forwarding.mjs","sourceRoot":"","sources":["../src/resources/request-forwarding.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;;;;OAKG;IACH,OAAO,CACL,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF"}
1
+ {"version":3,"file":"request-forwarding.mjs","sourceRoot":"","sources":["../src/resources/request-forwarding.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF"}
@@ -4,6 +4,29 @@ import * as HRISAPI from "../hris/hris.js";
4
4
  export declare class Company extends APIResource {
5
5
  /**
6
6
  * Update a sandbox company's data
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const company = await client.sandbox.company.update({
11
+ * accounts: [{}],
12
+ * departments: [{}],
13
+ * ein: 'ein',
14
+ * entity: {},
15
+ * legal_name: 'legal_name',
16
+ * locations: [
17
+ * {
18
+ * city: 'city',
19
+ * country: 'country',
20
+ * line1: 'line1',
21
+ * line2: 'line2',
22
+ * postal_code: 'postal_code',
23
+ * state: 'state',
24
+ * },
25
+ * ],
26
+ * primary_email: 'dev@stainless.com',
27
+ * primary_phone_number: 'primary_phone_number',
28
+ * });
29
+ * ```
7
30
  */
8
31
  update(body: CompanyUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CompanyUpdateResponse>;
9
32
  }