@tryfinch/finch-api 1.0.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 (266) hide show
  1. package/.eslintrc.js +10 -0
  2. package/.github/workflows/publish-npm.yml +28 -0
  3. package/.github/workflows/release-doctor.yml +20 -0
  4. package/.github/workflows/release.yml +38 -0
  5. package/.prettierrc +6 -0
  6. package/.release-please-manifest.json +3 -0
  7. package/.stats.yml +1 -0
  8. package/CHANGELOG.md +7 -0
  9. package/LICENSE +201 -0
  10. package/README.md +220 -0
  11. package/api.md +186 -0
  12. package/bin/check-release-environment +25 -0
  13. package/bin/check-test-server +50 -0
  14. package/bin/publish-npm +6 -0
  15. package/build +12 -0
  16. package/check-version.ts +18 -0
  17. package/core.ts +926 -0
  18. package/dist/cjs/check-version.d.ts +2 -0
  19. package/dist/cjs/check-version.d.ts.map +1 -0
  20. package/dist/cjs/check-version.js +23 -0
  21. package/dist/cjs/check-version.js.map +1 -0
  22. package/dist/cjs/core.d.ts +268 -0
  23. package/dist/cjs/core.d.ts.map +1 -0
  24. package/dist/cjs/core.js +994 -0
  25. package/dist/cjs/core.js.map +1 -0
  26. package/dist/cjs/fetch-polyfill.d.ts +6 -0
  27. package/dist/cjs/fetch-polyfill.d.ts.map +1 -0
  28. package/dist/cjs/fetch-polyfill.js +57 -0
  29. package/dist/cjs/fetch-polyfill.js.map +1 -0
  30. package/dist/cjs/index.d.ts +115 -0
  31. package/dist/cjs/index.d.ts.map +1 -0
  32. package/dist/cjs/index.js +198 -0
  33. package/dist/cjs/index.js.map +1 -0
  34. package/dist/cjs/pagination.d.ts +166 -0
  35. package/dist/cjs/pagination.d.ts.map +1 -0
  36. package/dist/cjs/pagination.js +215 -0
  37. package/dist/cjs/pagination.js.map +1 -0
  38. package/dist/cjs/resource.d.ts +12 -0
  39. package/dist/cjs/resource.d.ts.map +1 -0
  40. package/dist/cjs/resource.js +17 -0
  41. package/dist/cjs/resource.js.map +1 -0
  42. package/dist/cjs/resources/account.d.ts +49 -0
  43. package/dist/cjs/resources/account.d.ts.map +1 -0
  44. package/dist/cjs/resources/account.js +23 -0
  45. package/dist/cjs/resources/account.js.map +1 -0
  46. package/dist/cjs/resources/ats/applications.d.ts +31 -0
  47. package/dist/cjs/resources/ats/applications.d.ts.map +1 -0
  48. package/dist/cjs/resources/ats/applications.js +27 -0
  49. package/dist/cjs/resources/ats/applications.js.map +1 -0
  50. package/dist/cjs/resources/ats/ats.d.ts +14 -0
  51. package/dist/cjs/resources/ats/ats.d.ts.map +1 -0
  52. package/dist/cjs/resources/ats/ats.js +22 -0
  53. package/dist/cjs/resources/ats/ats.js.map +1 -0
  54. package/dist/cjs/resources/ats/candidates.d.ts +45 -0
  55. package/dist/cjs/resources/ats/candidates.d.ts.map +1 -0
  56. package/dist/cjs/resources/ats/candidates.js +24 -0
  57. package/dist/cjs/resources/ats/candidates.js.map +1 -0
  58. package/dist/cjs/resources/ats/index.d.ts +6 -0
  59. package/dist/cjs/resources/ats/index.d.ts.map +1 -0
  60. package/dist/cjs/resources/ats/index.js +12 -0
  61. package/dist/cjs/resources/ats/index.js.map +1 -0
  62. package/dist/cjs/resources/ats/jobs.d.ts +42 -0
  63. package/dist/cjs/resources/ats/jobs.d.ts.map +1 -0
  64. package/dist/cjs/resources/ats/jobs.js +23 -0
  65. package/dist/cjs/resources/ats/jobs.js.map +1 -0
  66. package/dist/cjs/resources/ats/offers.d.ts +34 -0
  67. package/dist/cjs/resources/ats/offers.d.ts.map +1 -0
  68. package/dist/cjs/resources/ats/offers.js +23 -0
  69. package/dist/cjs/resources/ats/offers.js.map +1 -0
  70. package/dist/cjs/resources/ats/stages.d.ts +23 -0
  71. package/dist/cjs/resources/ats/stages.d.ts.map +1 -0
  72. package/dist/cjs/resources/ats/stages.js +21 -0
  73. package/dist/cjs/resources/ats/stages.js.map +1 -0
  74. package/dist/cjs/resources/hris/benefits/benefits.d.ts +155 -0
  75. package/dist/cjs/resources/hris/benefits/benefits.d.ts.map +1 -0
  76. package/dist/cjs/resources/hris/benefits/benefits.js +57 -0
  77. package/dist/cjs/resources/hris/benefits/benefits.js.map +1 -0
  78. package/dist/cjs/resources/hris/benefits/index.d.ts +26 -0
  79. package/dist/cjs/resources/hris/benefits/index.d.ts.map +1 -0
  80. package/dist/cjs/resources/hris/benefits/index.js +42 -0
  81. package/dist/cjs/resources/hris/benefits/index.js.map +1 -0
  82. package/dist/cjs/resources/hris/benefits/individuals.d.ts +163 -0
  83. package/dist/cjs/resources/hris/benefits/individuals.d.ts.map +1 -0
  84. package/dist/cjs/resources/hris/benefits/individuals.js +68 -0
  85. package/dist/cjs/resources/hris/benefits/individuals.js.map +1 -0
  86. package/dist/cjs/resources/hris/company.d.ts +104 -0
  87. package/dist/cjs/resources/hris/company.d.ts.map +1 -0
  88. package/dist/cjs/resources/hris/company.js +15 -0
  89. package/dist/cjs/resources/hris/company.js.map +1 -0
  90. package/dist/cjs/resources/hris/directory.d.ts +65 -0
  91. package/dist/cjs/resources/hris/directory.d.ts.map +1 -0
  92. package/dist/cjs/resources/hris/directory.js +21 -0
  93. package/dist/cjs/resources/hris/directory.js.map +1 -0
  94. package/dist/cjs/resources/hris/hris.d.ts +95 -0
  95. package/dist/cjs/resources/hris/hris.d.ts.map +1 -0
  96. package/dist/cjs/resources/hris/hris.js +24 -0
  97. package/dist/cjs/resources/hris/hris.js.map +1 -0
  98. package/dist/cjs/resources/hris/index.d.ts +31 -0
  99. package/dist/cjs/resources/hris/index.d.ts.map +1 -0
  100. package/dist/cjs/resources/hris/index.js +44 -0
  101. package/dist/cjs/resources/hris/index.js.map +1 -0
  102. package/dist/cjs/resources/hris/individuals/employment-data.d.ts +151 -0
  103. package/dist/cjs/resources/hris/individuals/employment-data.d.ts.map +1 -0
  104. package/dist/cjs/resources/hris/individuals/employment-data.js +26 -0
  105. package/dist/cjs/resources/hris/individuals/employment-data.js.map +1 -0
  106. package/dist/cjs/resources/hris/individuals/index.d.ts +13 -0
  107. package/dist/cjs/resources/hris/individuals/index.d.ts.map +1 -0
  108. package/dist/cjs/resources/hris/individuals/index.js +28 -0
  109. package/dist/cjs/resources/hris/individuals/index.js.map +1 -0
  110. package/dist/cjs/resources/hris/individuals/individuals.d.ts +86 -0
  111. package/dist/cjs/resources/hris/individuals/individuals.d.ts.map +1 -0
  112. package/dist/cjs/resources/hris/individuals/individuals.js +28 -0
  113. package/dist/cjs/resources/hris/individuals/individuals.js.map +1 -0
  114. package/dist/cjs/resources/hris/pay-statements.d.ts +201 -0
  115. package/dist/cjs/resources/hris/pay-statements.d.ts.map +1 -0
  116. package/dist/cjs/resources/hris/pay-statements.js +25 -0
  117. package/dist/cjs/resources/hris/pay-statements.js.map +1 -0
  118. package/dist/cjs/resources/hris/payments.d.ts +54 -0
  119. package/dist/cjs/resources/hris/payments.d.ts.map +1 -0
  120. package/dist/cjs/resources/hris/payments.js +18 -0
  121. package/dist/cjs/resources/hris/payments.js.map +1 -0
  122. package/dist/cjs/resources/index.d.ts +5 -0
  123. package/dist/cjs/resources/index.d.ts.map +1 -0
  124. package/dist/cjs/resources/index.js +39 -0
  125. package/dist/cjs/resources/index.js.map +1 -0
  126. package/dist/cjs/resources/providers.d.ts +46 -0
  127. package/dist/cjs/resources/providers.d.ts.map +1 -0
  128. package/dist/cjs/resources/providers.js +18 -0
  129. package/dist/cjs/resources/providers.js.map +1 -0
  130. package/dist/cjs/resources/top-level.d.ts +2 -0
  131. package/dist/cjs/resources/top-level.d.ts.map +1 -0
  132. package/dist/cjs/resources/top-level.js +4 -0
  133. package/dist/cjs/resources/top-level.js.map +1 -0
  134. package/dist/cjs/tests/api-resources/account.test.d.ts +2 -0
  135. package/dist/cjs/tests/api-resources/account.test.d.ts.map +1 -0
  136. package/dist/cjs/tests/api-resources/account.test.js +66 -0
  137. package/dist/cjs/tests/api-resources/account.test.js.map +1 -0
  138. package/dist/cjs/tests/api-resources/ats/applications.test.d.ts +2 -0
  139. package/dist/cjs/tests/api-resources/ats/applications.test.d.ts.map +1 -0
  140. package/dist/cjs/tests/api-resources/ats/applications.test.js +73 -0
  141. package/dist/cjs/tests/api-resources/ats/applications.test.js.map +1 -0
  142. package/dist/cjs/tests/api-resources/ats/candidates.test.d.ts +2 -0
  143. package/dist/cjs/tests/api-resources/ats/candidates.test.d.ts.map +1 -0
  144. package/dist/cjs/tests/api-resources/ats/candidates.test.js +73 -0
  145. package/dist/cjs/tests/api-resources/ats/candidates.test.js.map +1 -0
  146. package/dist/cjs/tests/api-resources/ats/jobs.test.d.ts +2 -0
  147. package/dist/cjs/tests/api-resources/ats/jobs.test.d.ts.map +1 -0
  148. package/dist/cjs/tests/api-resources/ats/jobs.test.js +73 -0
  149. package/dist/cjs/tests/api-resources/ats/jobs.test.js.map +1 -0
  150. package/dist/cjs/tests/api-resources/ats/offers.test.d.ts +2 -0
  151. package/dist/cjs/tests/api-resources/ats/offers.test.d.ts.map +1 -0
  152. package/dist/cjs/tests/api-resources/ats/offers.test.js +73 -0
  153. package/dist/cjs/tests/api-resources/ats/offers.test.js.map +1 -0
  154. package/dist/cjs/tests/api-resources/ats/stages.test.d.ts +2 -0
  155. package/dist/cjs/tests/api-resources/ats/stages.test.d.ts.map +1 -0
  156. package/dist/cjs/tests/api-resources/ats/stages.test.js +55 -0
  157. package/dist/cjs/tests/api-resources/ats/stages.test.js.map +1 -0
  158. package/dist/cjs/tests/api-resources/hris/benefits/benefits.test.d.ts +2 -0
  159. package/dist/cjs/tests/api-resources/hris/benefits/benefits.test.d.ts.map +1 -0
  160. package/dist/cjs/tests/api-resources/hris/benefits/benefits.test.js +116 -0
  161. package/dist/cjs/tests/api-resources/hris/benefits/benefits.test.js.map +1 -0
  162. package/dist/cjs/tests/api-resources/hris/benefits/individuals.test.d.ts +2 -0
  163. package/dist/cjs/tests/api-resources/hris/benefits/individuals.test.d.ts.map +1 -0
  164. package/dist/cjs/tests/api-resources/hris/benefits/individuals.test.js +103 -0
  165. package/dist/cjs/tests/api-resources/hris/benefits/individuals.test.js.map +1 -0
  166. package/dist/cjs/tests/api-resources/hris/company.test.d.ts +2 -0
  167. package/dist/cjs/tests/api-resources/hris/company.test.d.ts.map +1 -0
  168. package/dist/cjs/tests/api-resources/hris/company.test.js +55 -0
  169. package/dist/cjs/tests/api-resources/hris/company.test.js.map +1 -0
  170. package/dist/cjs/tests/api-resources/hris/directory.test.d.ts +2 -0
  171. package/dist/cjs/tests/api-resources/hris/directory.test.d.ts.map +1 -0
  172. package/dist/cjs/tests/api-resources/hris/directory.test.js +62 -0
  173. package/dist/cjs/tests/api-resources/hris/directory.test.js.map +1 -0
  174. package/dist/cjs/tests/api-resources/hris/individuals/employment-data.test.d.ts +2 -0
  175. package/dist/cjs/tests/api-resources/hris/individuals/employment-data.test.d.ts.map +1 -0
  176. package/dist/cjs/tests/api-resources/hris/individuals/employment-data.test.js +56 -0
  177. package/dist/cjs/tests/api-resources/hris/individuals/employment-data.test.js.map +1 -0
  178. package/dist/cjs/tests/api-resources/hris/individuals/individuals.test.d.ts +2 -0
  179. package/dist/cjs/tests/api-resources/hris/individuals/individuals.test.d.ts.map +1 -0
  180. package/dist/cjs/tests/api-resources/hris/individuals/individuals.test.js +68 -0
  181. package/dist/cjs/tests/api-resources/hris/individuals/individuals.test.js.map +1 -0
  182. package/dist/cjs/tests/api-resources/hris/pay-statements.test.d.ts +2 -0
  183. package/dist/cjs/tests/api-resources/hris/pay-statements.test.d.ts.map +1 -0
  184. package/dist/cjs/tests/api-resources/hris/pay-statements.test.js +64 -0
  185. package/dist/cjs/tests/api-resources/hris/pay-statements.test.js.map +1 -0
  186. package/dist/cjs/tests/api-resources/hris/payments.test.d.ts +2 -0
  187. package/dist/cjs/tests/api-resources/hris/payments.test.d.ts.map +1 -0
  188. package/dist/cjs/tests/api-resources/hris/payments.test.js +52 -0
  189. package/dist/cjs/tests/api-resources/hris/payments.test.js.map +1 -0
  190. package/dist/cjs/tests/api-resources/providers.test.d.ts +2 -0
  191. package/dist/cjs/tests/api-resources/providers.test.d.ts.map +1 -0
  192. package/dist/cjs/tests/api-resources/providers.test.js +55 -0
  193. package/dist/cjs/tests/api-resources/providers.test.js.map +1 -0
  194. package/dist/cjs/tests/api-resources/top-level.test.d.ts +2 -0
  195. package/dist/cjs/tests/api-resources/top-level.test.d.ts.map +1 -0
  196. package/dist/cjs/tests/api-resources/top-level.test.js +52 -0
  197. package/dist/cjs/tests/api-resources/top-level.test.js.map +1 -0
  198. package/dist/cjs/tests/form.test.d.ts +2 -0
  199. package/dist/cjs/tests/form.test.d.ts.map +1 -0
  200. package/dist/cjs/tests/form.test.js +61 -0
  201. package/dist/cjs/tests/form.test.js.map +1 -0
  202. package/dist/cjs/tests/index.test.d.ts +2 -0
  203. package/dist/cjs/tests/index.test.d.ts.map +1 -0
  204. package/dist/cjs/tests/index.test.js +34 -0
  205. package/dist/cjs/tests/index.test.js.map +1 -0
  206. package/dist/cjs/tests/responses.test.d.ts +2 -0
  207. package/dist/cjs/tests/responses.test.d.ts.map +1 -0
  208. package/dist/cjs/tests/responses.test.js +60 -0
  209. package/dist/cjs/tests/responses.test.js.map +1 -0
  210. package/dist/cjs/version.d.ts +2 -0
  211. package/dist/cjs/version.d.ts.map +1 -0
  212. package/dist/cjs/version.js +5 -0
  213. package/dist/cjs/version.js.map +1 -0
  214. package/fetch-polyfill.ts +69 -0
  215. package/index.ts +212 -0
  216. package/jest.config.js +8 -0
  217. package/package.json +47 -0
  218. package/pagination.ts +401 -0
  219. package/release-please-config.json +12 -0
  220. package/resource.ts +24 -0
  221. package/resources/account.ts +63 -0
  222. package/resources/ats/applications.ts +55 -0
  223. package/resources/ats/ats.ts +16 -0
  224. package/resources/ats/candidates.ts +74 -0
  225. package/resources/ats/index.ts +7 -0
  226. package/resources/ats/jobs.ts +70 -0
  227. package/resources/ats/offers.ts +57 -0
  228. package/resources/ats/stages.ts +31 -0
  229. package/resources/hris/benefits/benefits.ts +214 -0
  230. package/resources/hris/benefits/index.ts +27 -0
  231. package/resources/hris/benefits/individuals.ts +234 -0
  232. package/resources/hris/company.ts +127 -0
  233. package/resources/hris/directory.ts +87 -0
  234. package/resources/hris/hris.ts +113 -0
  235. package/resources/hris/index.ts +32 -0
  236. package/resources/hris/individuals/employment-data.ts +188 -0
  237. package/resources/hris/individuals/index.ts +14 -0
  238. package/resources/hris/individuals/individuals.ts +128 -0
  239. package/resources/hris/pay-statements.ts +251 -0
  240. package/resources/hris/payments.ts +73 -0
  241. package/resources/index.ts +6 -0
  242. package/resources/providers.ts +59 -0
  243. package/resources/top-level.ts +3 -0
  244. package/tests/api-resources/account.test.ts +29 -0
  245. package/tests/api-resources/ats/applications.test.ts +36 -0
  246. package/tests/api-resources/ats/candidates.test.ts +36 -0
  247. package/tests/api-resources/ats/jobs.test.ts +36 -0
  248. package/tests/api-resources/ats/offers.test.ts +36 -0
  249. package/tests/api-resources/ats/stages.test.ts +18 -0
  250. package/tests/api-resources/hris/benefits/benefits.test.ts +79 -0
  251. package/tests/api-resources/hris/benefits/individuals.test.ts +66 -0
  252. package/tests/api-resources/hris/company.test.ts +18 -0
  253. package/tests/api-resources/hris/directory.test.ts +25 -0
  254. package/tests/api-resources/hris/individuals/employment-data.test.ts +19 -0
  255. package/tests/api-resources/hris/individuals/individuals.test.ts +31 -0
  256. package/tests/api-resources/hris/pay-statements.test.ts +27 -0
  257. package/tests/api-resources/hris/payments.test.ts +15 -0
  258. package/tests/api-resources/providers.test.ts +18 -0
  259. package/tests/api-resources/top-level.test.ts +15 -0
  260. package/tests/form.test.ts +27 -0
  261. package/tests/index.test.ts +34 -0
  262. package/tests/responses.test.ts +25 -0
  263. package/tsconfig.cjs.json +8 -0
  264. package/tsconfig.json +39 -0
  265. package/typings/digest-fetch/index.d.ts +33 -0
  266. package/version.ts +1 -0
@@ -0,0 +1,34 @@
1
+ import * as Core from '../../core';
2
+ import { APIResource } from '../../resource';
3
+ import { OffersPage, OffersPageParams } from '../../pagination';
4
+ export declare class Offers extends APIResource {
5
+ /**
6
+ * Get a single offer from an organization.
7
+ */
8
+ retrieve(offerId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Offer>>;
9
+ /**
10
+ * Get all offers put out by an organization.
11
+ */
12
+ list(query?: OfferListParams, options?: Core.RequestOptions): Core.PagePromise<OffersPage>;
13
+ list(options?: Core.RequestOptions): Core.PagePromise<OffersPage>;
14
+ }
15
+ export interface Offer {
16
+ application_id: string;
17
+ candidate_id: string;
18
+ created_at: string;
19
+ id: string;
20
+ job_id: string;
21
+ status:
22
+ | 'signed'
23
+ | 'rejected'
24
+ | 'draft'
25
+ | 'approval-sent'
26
+ | 'approved'
27
+ | 'sent'
28
+ | 'sent-manually'
29
+ | 'opened'
30
+ | 'archived';
31
+ updated_at: string;
32
+ }
33
+ export interface OfferListParams extends OffersPageParams {}
34
+ //# sourceMappingURL=offers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"offers.d.ts","sourceRoot":"","sources":["../../../../resources/ats/offers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAE5D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAI1F;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;IAC1F,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;CAUlE;AAED,MAAM,WAAW,KAAK;IACpB,cAAc,EAAE,MAAM,CAAC;IAEvB,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;IAEnB,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,EACF,QAAQ,GACR,UAAU,GACV,OAAO,GACP,eAAe,GACf,UAAU,GACV,MAAM,GACN,eAAe,GACf,QAAQ,GACR,UAAU,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;CAAG"}
@@ -0,0 +1,23 @@
1
+ 'use strict';
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+ exports.Offers = void 0;
5
+ const resource_1 = require('../../resource');
6
+ const core_1 = require('../../core');
7
+ const pagination_1 = require('../../pagination');
8
+ class Offers extends resource_1.APIResource {
9
+ /**
10
+ * Get a single offer from an organization.
11
+ */
12
+ retrieve(offerId, options) {
13
+ return this.get(`/ats/offers/${offerId}`, options);
14
+ }
15
+ list(query = {}, options) {
16
+ if ((0, core_1.isRequestOptions)(query)) {
17
+ return this.list({}, query);
18
+ }
19
+ return this.getAPIList('/ats/offers', pagination_1.OffersPage, Object.assign({ query }, options));
20
+ }
21
+ }
22
+ exports.Offers = Offers;
23
+ //# sourceMappingURL=offers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"offers.js","sourceRoot":"","sources":["../../../../resources/ats/offers.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAC1C,6CAA4D;AAE5D,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAOD,IAAI,CACF,QAA+C,EAAE,EACjD,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,UAAU,CAAC,aAAa,EAAE,uBAAU,kBAAI,KAAK,IAAK,OAAO,EAAG,CAAC;IAC3E,CAAC;CACF;AAtBD,wBAsBC"}
@@ -0,0 +1,23 @@
1
+ import * as Core from '../../core';
2
+ import { APIResource } from '../../resource';
3
+ import { SinglePage } from '../../pagination';
4
+ export declare class Stages extends APIResource {
5
+ /**
6
+ * Get all job stages for an organization. Depending on the system, some jobs may
7
+ * have stages specific to that job. Other job stages may apply broadly to all jobs
8
+ * in the system. Use the `job_id` to determine whether a job applies specifically
9
+ * to a job.
10
+ */
11
+ list(options?: Core.RequestOptions): Core.PagePromise<StagesSinglePage>;
12
+ }
13
+ export declare class StagesSinglePage extends SinglePage<Stage> {}
14
+ export interface Stage {
15
+ id?: string;
16
+ /**
17
+ * The job id that this stage applies to, if applicable. Not all systems enumerate
18
+ * stages specific to jobs.
19
+ */
20
+ job_id?: string | null;
21
+ name?: string | null;
22
+ }
23
+ //# sourceMappingURL=stages.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stages.d.ts","sourceRoot":"","sources":["../../../../resources/ats/stages.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC;CAGxE;AAED,qBAAa,gBAAiB,SAAQ,UAAU,CAAC,KAAK,CAAC;CAAG;AAE1D,MAAM,WAAW,KAAK;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB"}
@@ -0,0 +1,21 @@
1
+ 'use strict';
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+ exports.StagesSinglePage = exports.Stages = void 0;
5
+ const resource_1 = require('../../resource');
6
+ const pagination_1 = require('../../pagination');
7
+ class Stages extends resource_1.APIResource {
8
+ /**
9
+ * Get all job stages for an organization. Depending on the system, some jobs may
10
+ * have stages specific to that job. Other job stages may apply broadly to all jobs
11
+ * in the system. Use the `job_id` to determine whether a job applies specifically
12
+ * to a job.
13
+ */
14
+ list(options) {
15
+ return this.getAPIList('/ats/stages', StagesSinglePage, options);
16
+ }
17
+ }
18
+ exports.Stages = Stages;
19
+ class StagesSinglePage extends pagination_1.SinglePage {}
20
+ exports.StagesSinglePage = StagesSinglePage;
21
+ //# sourceMappingURL=stages.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stages.js","sourceRoot":"","sources":["../../../../resources/ats/stages.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,6CAA0C;AAE1C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;OAKG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAVD,wBAUC;AAED,MAAa,gBAAiB,SAAQ,uBAAiB;CAAG;AAA1D,4CAA0D"}
@@ -0,0 +1,155 @@
1
+ import * as Core from '../../../core';
2
+ import { APIResource } from '../../../resource';
3
+ import { Individuals } from './individuals';
4
+ import { SinglePage } from '../../../pagination';
5
+ export declare class Benefits extends APIResource {
6
+ individuals: Individuals;
7
+ /**
8
+ * **Availability: Automated and Assisted Benefits providers**
9
+ *
10
+ * Creates a new company-wide benefit. Please use the `/meta` endpoint to view
11
+ * available types for each provider.
12
+ */
13
+ create(
14
+ body?: BenefitCreateParams,
15
+ options?: Core.RequestOptions,
16
+ ): Promise<Core.APIResponse<CreateCompanyBenefitsResponse>>;
17
+ create(options?: Core.RequestOptions): Promise<Core.APIResponse<CreateCompanyBenefitsResponse>>;
18
+ /**
19
+ * **Availability: Automated Benefits providers only**
20
+ *
21
+ * Lists benefit information for a given benefit
22
+ */
23
+ retrieve(benefitId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<CompanyBenefit>>;
24
+ /**
25
+ * **Availability: Automated and Assisted Benefits providers**
26
+ *
27
+ * Updates an existing company-wide benefit
28
+ */
29
+ update(
30
+ benefitId: string,
31
+ body?: BenefitUpdateParams,
32
+ options?: Core.RequestOptions,
33
+ ): Promise<Core.APIResponse<UpdateCompanyBenefitResponse>>;
34
+ update(
35
+ benefitId: string,
36
+ options?: Core.RequestOptions,
37
+ ): Promise<Core.APIResponse<UpdateCompanyBenefitResponse>>;
38
+ /**
39
+ * **Availability: Automated Benefits providers only**
40
+ *
41
+ * List all company-wide benefits.
42
+ */
43
+ list(options?: Core.RequestOptions): Core.PagePromise<CompanyBenefitsSinglePage>;
44
+ /**
45
+ * **Availability: Automated and Assisted Benefits providers**
46
+ *
47
+ * Lists available types and configurations for the provider associated with the
48
+ * access token.
49
+ */
50
+ listSupportedBenefits(options?: Core.RequestOptions): Core.PagePromise<SupportedBenefitsSinglePage>;
51
+ }
52
+ export declare class CompanyBenefitsSinglePage extends SinglePage<CompanyBenefit> {}
53
+ export declare class SupportedBenefitsSinglePage extends SinglePage<SupportedBenefit> {}
54
+ export type BenefitFrequency = 'one_time' | 'every_paycheck' | null;
55
+ /**
56
+ * Type of benefit.
57
+ */
58
+ export type BenefitType =
59
+ | '401k'
60
+ | '401k_roth'
61
+ | '401k_loan'
62
+ | '403b'
63
+ | '403b_roth'
64
+ | '457'
65
+ | '457_roth'
66
+ | 's125_medical'
67
+ | 's125_dental'
68
+ | 's125_vision'
69
+ | 'hsa_pre'
70
+ | 'hsa_post'
71
+ | 'fsa_medical'
72
+ | 'fsa_dependent_care'
73
+ | 'simple_ira'
74
+ | 'simple'
75
+ | 'commuter'
76
+ | 'custom_post_tax'
77
+ | 'custom_pre_tax'
78
+ | null;
79
+ export interface BenfitContribution {
80
+ /**
81
+ * Contribution amount in cents (if `fixed`) or basis points (if `percent`).
82
+ */
83
+ amount?: number | null;
84
+ /**
85
+ * Contribution type.
86
+ */
87
+ type?: 'fixed' | 'percent' | null;
88
+ }
89
+ export interface CompanyBenefit {
90
+ benefit_id: string;
91
+ company_contribution: BenfitContribution | null;
92
+ description: string | null;
93
+ employee_deduction: BenfitContribution | null;
94
+ frequency: BenefitFrequency | null;
95
+ /**
96
+ * Type of benefit.
97
+ */
98
+ type: BenefitType | null;
99
+ }
100
+ export interface CreateCompanyBenefitsResponse {
101
+ benefit_id: string;
102
+ }
103
+ export interface SupportedBenefit {
104
+ /**
105
+ * Whether the provider supports an annual maximum for this benefit.
106
+ */
107
+ annual_maximum?: boolean | null;
108
+ /**
109
+ * Whether the provider supports catch up for this benefit. This field will only be
110
+ * true for retirement benefits.
111
+ */
112
+ catch_up?: boolean | null;
113
+ /**
114
+ * Supported contribution types. An empty array indicates contributions are not
115
+ * supported.
116
+ */
117
+ company_contribution?: Array<'fixed' | 'percent'> | null;
118
+ description?: string | null;
119
+ /**
120
+ * Supported deduction types. An empty array indicates deductions are not
121
+ * supported.
122
+ */
123
+ employee_deduction?: Array<'fixed' | 'percent'> | null;
124
+ /**
125
+ * The list of frequencies supported by the provider for this benefit
126
+ */
127
+ frequencies?: Array<BenefitFrequency | null>;
128
+ /**
129
+ * Whether the provider supports HSA contribution limits. Empty if this feature is
130
+ * not supported for the benefit. This array only has values for HSA benefits.
131
+ */
132
+ hsa_contribution_limit?: Array<'individual' | 'family'> | null;
133
+ /**
134
+ * Type of benefit.
135
+ */
136
+ type?: BenefitType | null;
137
+ }
138
+ export interface UpdateCompanyBenefitResponse {
139
+ benefit_id: string;
140
+ }
141
+ export interface BenefitCreateParams {
142
+ description?: string;
143
+ frequency?: BenefitFrequency | null;
144
+ /**
145
+ * Type of benefit.
146
+ */
147
+ type?: BenefitType | null;
148
+ }
149
+ export interface BenefitUpdateParams {
150
+ /**
151
+ * Updated name or description.
152
+ */
153
+ description?: string;
154
+ }
155
+ //# sourceMappingURL=benefits.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"benefits.d.ts","sourceRoot":"","sources":["../../../../../resources/hris/benefits/benefits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,QAAS,SAAQ,WAAW;IACvC,WAAW,EAAE,WAAW,CAAgC;IAExD;;;;;OAKG;IACH,MAAM,CACJ,IAAI,CAAC,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAAC;IAC3D,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAAC;IAW/F;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAIrG;;;;OAIG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAAC;IAC1D,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAAC;IAY1D;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,CAAC;IAIhF;;;;;OAKG;IACH,qBAAqB,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,2BAA2B,CAAC;CAGpG;AAED,qBAAa,yBAA0B,SAAQ,UAAU,CAAC,cAAc,CAAC;CAAG;AAE5E,qBAAa,2BAA4B,SAAQ,UAAU,CAAC,gBAAgB,CAAC;CAAG;AAEhF,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,gBAAgB,GAAG,IAAI,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,WAAW,GACX,WAAW,GACX,MAAM,GACN,WAAW,GACX,KAAK,GACL,UAAU,GACV,cAAc,GACd,aAAa,GACb,aAAa,GACb,SAAS,GACT,UAAU,GACV,aAAa,GACb,oBAAoB,GACpB,YAAY,GACZ,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,gBAAgB,GAChB,IAAI,CAAC;AAET,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;IAEnB,oBAAoB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE9C,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;IAEzD,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAE7C;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,4BAA4B;IAC3C,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
@@ -0,0 +1,57 @@
1
+ 'use strict';
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+ exports.SupportedBenefitsSinglePage = exports.CompanyBenefitsSinglePage = exports.Benefits = void 0;
5
+ const resource_1 = require('../../../resource');
6
+ const core_1 = require('../../../core');
7
+ const individuals_1 = require('./individuals');
8
+ const pagination_1 = require('../../../pagination');
9
+ class Benefits extends resource_1.APIResource {
10
+ constructor() {
11
+ super(...arguments);
12
+ this.individuals = new individuals_1.Individuals(this.client);
13
+ }
14
+ create(body = {}, options) {
15
+ if ((0, core_1.isRequestOptions)(body)) {
16
+ return this.create({}, body);
17
+ }
18
+ return this.post('/employer/benefits', Object.assign({ body }, options));
19
+ }
20
+ /**
21
+ * **Availability: Automated Benefits providers only**
22
+ *
23
+ * Lists benefit information for a given benefit
24
+ */
25
+ retrieve(benefitId, options) {
26
+ return this.get(`/employer/benefits/${benefitId}`, options);
27
+ }
28
+ update(benefitId, body = {}, options) {
29
+ if ((0, core_1.isRequestOptions)(body)) {
30
+ return this.update(benefitId, {}, body);
31
+ }
32
+ return this.post(`/employer/benefits/${benefitId}`, Object.assign({ body }, options));
33
+ }
34
+ /**
35
+ * **Availability: Automated Benefits providers only**
36
+ *
37
+ * List all company-wide benefits.
38
+ */
39
+ list(options) {
40
+ return this.getAPIList('/employer/benefits', CompanyBenefitsSinglePage, options);
41
+ }
42
+ /**
43
+ * **Availability: Automated and Assisted Benefits providers**
44
+ *
45
+ * Lists available types and configurations for the provider associated with the
46
+ * access token.
47
+ */
48
+ listSupportedBenefits(options) {
49
+ return this.getAPIList('/employer/benefits/meta', SupportedBenefitsSinglePage, options);
50
+ }
51
+ }
52
+ exports.Benefits = Benefits;
53
+ class CompanyBenefitsSinglePage extends pagination_1.SinglePage {}
54
+ exports.CompanyBenefitsSinglePage = CompanyBenefitsSinglePage;
55
+ class SupportedBenefitsSinglePage extends pagination_1.SinglePage {}
56
+ exports.SupportedBenefitsSinglePage = SupportedBenefitsSinglePage;
57
+ //# sourceMappingURL=benefits.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"benefits.js","sourceRoot":"","sources":["../../../../../resources/hris/benefits/benefits.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAC1C,+CAA4C;AAC5C,6CAA0C;AAE1C,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,gBAAW,GAAgB,IAAI,yBAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IA2E1D,CAAC;IA9DC,MAAM,CACJ,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,kBAAI,IAAI,IAAK,OAAO,EAAG,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAgBD,MAAM,CACJ,SAAiB,EACjB,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,SAAS,EAAE,kBAAI,IAAI,IAAK,OAAO,EAAG,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,OAA6B;QACjD,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;CACF;AA5ED,4BA4EC;AAED,MAAa,yBAA0B,SAAQ,uBAA0B;CAAG;AAA5E,8DAA4E;AAE5E,MAAa,2BAA4B,SAAQ,uBAA4B;CAAG;AAAhF,kEAAgF"}
@@ -0,0 +1,26 @@
1
+ export {
2
+ BenefitFrequency,
3
+ BenefitType,
4
+ BenfitContribution,
5
+ CompanyBenefit,
6
+ CreateCompanyBenefitsResponse,
7
+ SupportedBenefit,
8
+ UpdateCompanyBenefitResponse,
9
+ BenefitCreateParams,
10
+ BenefitUpdateParams,
11
+ CompanyBenefitsSinglePage,
12
+ SupportedBenefitsSinglePage,
13
+ } from './benefits';
14
+ export {
15
+ EnrolledIndividual,
16
+ IndividualBenefit,
17
+ UnenrolledIndividual,
18
+ IndividualEnrolledIDsResponse,
19
+ IndividualEnrollManyParams,
20
+ IndividualRetrieveManyBenefitsParams,
21
+ IndividualUnenrollParams,
22
+ EnrolledIndividualsSinglePage,
23
+ IndividualBenefitsSinglePage,
24
+ UnenrolledIndividualsSinglePage,
25
+ } from './individuals';
26
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../resources/hris/benefits/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,kBAAkB,EAClB,cAAc,EACd,6BAA6B,EAC7B,gBAAgB,EAChB,4BAA4B,EAC5B,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,oBAAoB,EACpB,6BAA6B,EAC7B,0BAA0B,EAC1B,oCAAoC,EACpC,wBAAwB,EACxB,6BAA6B,EAC7B,4BAA4B,EAC5B,+BAA+B,GAChC,MAAM,eAAe,CAAC"}
@@ -0,0 +1,42 @@
1
+ 'use strict';
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+ exports.UnenrolledIndividualsSinglePage =
5
+ exports.IndividualBenefitsSinglePage =
6
+ exports.EnrolledIndividualsSinglePage =
7
+ exports.SupportedBenefitsSinglePage =
8
+ exports.CompanyBenefitsSinglePage =
9
+ void 0;
10
+ var benefits_1 = require('./benefits');
11
+ Object.defineProperty(exports, 'CompanyBenefitsSinglePage', {
12
+ enumerable: true,
13
+ get: function () {
14
+ return benefits_1.CompanyBenefitsSinglePage;
15
+ },
16
+ });
17
+ Object.defineProperty(exports, 'SupportedBenefitsSinglePage', {
18
+ enumerable: true,
19
+ get: function () {
20
+ return benefits_1.SupportedBenefitsSinglePage;
21
+ },
22
+ });
23
+ var individuals_1 = require('./individuals');
24
+ Object.defineProperty(exports, 'EnrolledIndividualsSinglePage', {
25
+ enumerable: true,
26
+ get: function () {
27
+ return individuals_1.EnrolledIndividualsSinglePage;
28
+ },
29
+ });
30
+ Object.defineProperty(exports, 'IndividualBenefitsSinglePage', {
31
+ enumerable: true,
32
+ get: function () {
33
+ return individuals_1.IndividualBenefitsSinglePage;
34
+ },
35
+ });
36
+ Object.defineProperty(exports, 'UnenrolledIndividualsSinglePage', {
37
+ enumerable: true,
38
+ get: function () {
39
+ return individuals_1.UnenrolledIndividualsSinglePage;
40
+ },
41
+ });
42
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../resources/hris/benefits/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,uCAYoB;AAFlB,qHAAA,yBAAyB,OAAA;AACzB,uHAAA,2BAA2B,OAAA;AAE7B,6CAWuB;AAHrB,4HAAA,6BAA6B,OAAA;AAC7B,2HAAA,4BAA4B,OAAA;AAC5B,8HAAA,+BAA+B,OAAA"}
@@ -0,0 +1,163 @@
1
+ import * as Core from '../../../core';
2
+ import { APIResource } from '../../../resource';
3
+ import * as Benefits from '../../../resources/hris/benefits';
4
+ import { SinglePage } from '../../../pagination';
5
+ export declare class Individuals extends APIResource {
6
+ /**
7
+ * **Availability: Automated and Assisted Benefits providers**
8
+ *
9
+ * Enroll an individual into a benefit. If the employee is already enrolled, the
10
+ * enrollment amounts will be adjusted.
11
+ *
12
+ * <!-- theme: warning -->
13
+ *
14
+ * > Making changes to an individual's benefits may have tax consequences based on
15
+ * > IRS regulations. Please consult a tax expert to ensure all changes being made
16
+ * > to the system are compliant with local, state, and federal law.
17
+ */
18
+ enrollMany(
19
+ benefitId: string,
20
+ body: IndividualEnrollManyParams,
21
+ options?: Core.RequestOptions,
22
+ ): Core.PagePromise<EnrolledIndividualsSinglePage>;
23
+ /**
24
+ * **Availability: Automated Benefits providers only**
25
+ *
26
+ * Lists individuals currently enrolled in a given benefit.
27
+ */
28
+ enrolledIds(
29
+ benefitId: string,
30
+ options?: Core.RequestOptions,
31
+ ): Promise<Core.APIResponse<IndividualEnrolledIDsResponse>>;
32
+ /**
33
+ * **Availability: Automated Benefits providers only**
34
+ *
35
+ * Get enrolled benefit information for the given individuals.
36
+ */
37
+ retrieveManyBenefits(
38
+ benefitId: string,
39
+ query?: IndividualRetrieveManyBenefitsParams,
40
+ options?: Core.RequestOptions,
41
+ ): Core.PagePromise<IndividualBenefitsSinglePage>;
42
+ retrieveManyBenefits(
43
+ benefitId: string,
44
+ options?: Core.RequestOptions,
45
+ ): Core.PagePromise<IndividualBenefitsSinglePage>;
46
+ /**
47
+ * **Availability: Automated and Assisted Benefits providers**
48
+ *
49
+ * Unenroll individuals from a benefit
50
+ */
51
+ unenroll(
52
+ benefitId: string,
53
+ body?: IndividualUnenrollParams,
54
+ options?: Core.RequestOptions,
55
+ ): Core.PagePromise<UnenrolledIndividualsSinglePage>;
56
+ unenroll(
57
+ benefitId: string,
58
+ options?: Core.RequestOptions,
59
+ ): Core.PagePromise<UnenrolledIndividualsSinglePage>;
60
+ }
61
+ export declare class EnrolledIndividualsSinglePage extends SinglePage<EnrolledIndividual> {}
62
+ export declare class IndividualBenefitsSinglePage extends SinglePage<IndividualBenefit> {}
63
+ export declare class UnenrolledIndividualsSinglePage extends SinglePage<UnenrolledIndividual> {}
64
+ export interface EnrolledIndividual {
65
+ body?: EnrolledIndividual.Body;
66
+ /**
67
+ * HTTP status code. Either 201 or 200
68
+ */
69
+ code?: 200 | 201 | 404 | 403;
70
+ individual_id?: string;
71
+ }
72
+ export declare namespace EnrolledIndividual {
73
+ interface Body {
74
+ /**
75
+ * A descriptive identifier for the response
76
+ */
77
+ finch_code?: string | null;
78
+ /**
79
+ * Short description in English that provides more information about the response.
80
+ */
81
+ message?: string | null;
82
+ /**
83
+ * Identifier indicating whether the benefit was newly enrolled or updated.
84
+ */
85
+ name?: string | null;
86
+ }
87
+ }
88
+ export interface IndividualBenefit {
89
+ body?: IndividualBenefit.Body;
90
+ code?: number;
91
+ individual_id?: string;
92
+ }
93
+ export declare namespace IndividualBenefit {
94
+ interface Body {
95
+ /**
96
+ * If the benefit supports annual maximum, the amount in cents for this individual.
97
+ */
98
+ annual_maximum?: number | null;
99
+ /**
100
+ * If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
101
+ * for this individual.
102
+ */
103
+ catch_up?: boolean | null;
104
+ company_contribution?: Benefits.BenfitContribution | null;
105
+ employee_deduction?: Benefits.BenfitContribution | null;
106
+ /**
107
+ * Type for HSA contribution limit if the benefit is a HSA.
108
+ */
109
+ hsa_contribution_limit?: 'individual' | 'family' | null;
110
+ }
111
+ }
112
+ export interface UnenrolledIndividual {
113
+ body?: UnenrolledIndividual.Body;
114
+ /**
115
+ * HTTP status code
116
+ */
117
+ code?: number;
118
+ individual_id?: string;
119
+ }
120
+ export declare namespace UnenrolledIndividual {
121
+ interface Body {
122
+ /**
123
+ * A descriptive identifier for the response.
124
+ */
125
+ finch_code?: string | null;
126
+ /**
127
+ * Short description in English that provides more information about the response.
128
+ */
129
+ message?: string | null;
130
+ /**
131
+ * Identifier indicating whether the benefit was newly enrolled or updated.
132
+ */
133
+ name?: string | null;
134
+ }
135
+ }
136
+ export interface IndividualEnrolledIDsResponse {
137
+ benefit_id: string;
138
+ individual_ids: Array<string>;
139
+ }
140
+ export type IndividualEnrollManyParams = Array<IndividualEnrollManyParams.Individual>;
141
+ export declare namespace IndividualEnrollManyParams {
142
+ interface Individual {
143
+ configuration?: unknown;
144
+ /**
145
+ * Finch id (uuidv4) for the individual to enroll
146
+ */
147
+ individual_id?: string;
148
+ }
149
+ }
150
+ export interface IndividualRetrieveManyBenefitsParams {
151
+ /**
152
+ * comma-delimited list of stable Finch uuids for each individual. If empty,
153
+ * defaults to all individuals
154
+ */
155
+ individual_ids?: string;
156
+ }
157
+ export interface IndividualUnenrollParams {
158
+ /**
159
+ * Array of individual_ids to unenroll.
160
+ */
161
+ individual_ids?: Array<string>;
162
+ }
163
+ //# sourceMappingURL=individuals.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"individuals.d.ts","sourceRoot":"","sources":["../../../../../resources/hris/benefits/individuals.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,KAAK,QAAQ,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC;IAQlD;;;;OAIG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAAC;IAI3D;;;;OAIG;IACH,oBAAoB,CAClB,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,oCAAoC,EAC5C,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC;IACjD,oBAAoB,CAClB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC;IAejD;;;;OAIG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,+BAA+B,CAAC;IACpD,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,+BAA+B,CAAC;CAerD;AAED,qBAAa,6BAA8B,SAAQ,UAAU,CAAC,kBAAkB,CAAC;CAAG;AAEpF,qBAAa,4BAA6B,SAAQ,UAAU,CAAC,iBAAiB,CAAC;CAAG;AAElF,qBAAa,+BAAgC,SAAQ,UAAU,CAAC,oBAAoB,CAAC;CAAG;AAExF,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAE7B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B,oBAAoB,CAAC,EAAE,QAAQ,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAE1D,kBAAkB,CAAC,EAAE,QAAQ,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAExD;;WAEG;QACH,sBAAsB,CAAC,EAAE,YAAY,GAAG,QAAQ,GAAG,IAAI,CAAC;KACzD;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC;AAEtF,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,UAAU;QACzB,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC"}
@@ -0,0 +1,68 @@
1
+ 'use strict';
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+ exports.UnenrolledIndividualsSinglePage =
5
+ exports.IndividualBenefitsSinglePage =
6
+ exports.EnrolledIndividualsSinglePage =
7
+ exports.Individuals =
8
+ void 0;
9
+ const resource_1 = require('../../../resource');
10
+ const core_1 = require('../../../core');
11
+ const pagination_1 = require('../../../pagination');
12
+ class Individuals extends resource_1.APIResource {
13
+ /**
14
+ * **Availability: Automated and Assisted Benefits providers**
15
+ *
16
+ * Enroll an individual into a benefit. If the employee is already enrolled, the
17
+ * enrollment amounts will be adjusted.
18
+ *
19
+ * <!-- theme: warning -->
20
+ *
21
+ * > Making changes to an individual's benefits may have tax consequences based on
22
+ * > IRS regulations. Please consult a tax expert to ensure all changes being made
23
+ * > to the system are compliant with local, state, and federal law.
24
+ */
25
+ enrollMany(benefitId, body, options) {
26
+ return this.getAPIList(
27
+ `/employer/benefits/${benefitId}/individuals`,
28
+ EnrolledIndividualsSinglePage,
29
+ Object.assign({ body, method: 'post' }, options),
30
+ );
31
+ }
32
+ /**
33
+ * **Availability: Automated Benefits providers only**
34
+ *
35
+ * Lists individuals currently enrolled in a given benefit.
36
+ */
37
+ enrolledIds(benefitId, options) {
38
+ return this.get(`/employer/benefits/${benefitId}/enrolled`, options);
39
+ }
40
+ retrieveManyBenefits(benefitId, query = {}, options) {
41
+ if ((0, core_1.isRequestOptions)(query)) {
42
+ return this.retrieveManyBenefits(benefitId, {}, query);
43
+ }
44
+ return this.getAPIList(
45
+ `/employer/benefits/${benefitId}/individuals`,
46
+ IndividualBenefitsSinglePage,
47
+ Object.assign({ query }, options),
48
+ );
49
+ }
50
+ unenroll(benefitId, body = {}, options) {
51
+ if ((0, core_1.isRequestOptions)(body)) {
52
+ return this.unenroll(benefitId, {}, body);
53
+ }
54
+ return this.getAPIList(
55
+ `/employer/benefits/${benefitId}/individuals`,
56
+ UnenrolledIndividualsSinglePage,
57
+ Object.assign({ body, method: 'delete' }, options),
58
+ );
59
+ }
60
+ }
61
+ exports.Individuals = Individuals;
62
+ class EnrolledIndividualsSinglePage extends pagination_1.SinglePage {}
63
+ exports.EnrolledIndividualsSinglePage = EnrolledIndividualsSinglePage;
64
+ class IndividualBenefitsSinglePage extends pagination_1.SinglePage {}
65
+ exports.IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
66
+ class UnenrolledIndividualsSinglePage extends pagination_1.SinglePage {}
67
+ exports.UnenrolledIndividualsSinglePage = UnenrolledIndividualsSinglePage;
68
+ //# sourceMappingURL=individuals.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"individuals.js","sourceRoot":"","sources":["../../../../../resources/hris/benefits/individuals.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAE1C,6CAA0C;AAE1C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAiB,EACjB,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,SAAS,cAAc,EAAE,6BAA6B,kBACjG,IAAI,EACJ,MAAM,EAAE,MAAM,IACX,OAAO,EACV,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,SAAiB,EACjB,OAA6B;QAE7B,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAgBD,oBAAoB,CAClB,SAAiB,EACjB,QAAoE,EAAE,EACtE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACxD;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,SAAS,cAAc,EAAE,4BAA4B,kBAChG,KAAK,IACF,OAAO,EACV,CAAC;IACL,CAAC;IAgBD,QAAQ,CACN,SAAiB,EACjB,OAAuD,EAAE,EACzD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC3C;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,SAAS,cAAc,EAAE,+BAA+B,kBACnG,IAAI,EACJ,MAAM,EAAE,QAAQ,IACb,OAAO,EACV,CAAC;IACL,CAAC;CACF;AA7FD,kCA6FC;AAED,MAAa,6BAA8B,SAAQ,uBAA8B;CAAG;AAApF,sEAAoF;AAEpF,MAAa,4BAA6B,SAAQ,uBAA6B;CAAG;AAAlF,oEAAkF;AAElF,MAAa,+BAAgC,SAAQ,uBAAgC;CAAG;AAAxF,0EAAwF"}