@tryfinch/finch-api 5.1.0 → 5.3.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 (361) hide show
  1. package/CHANGELOG.md +43 -0
  2. package/README.md +28 -21
  3. package/_shims/MultipartBody.d.ts +9 -0
  4. package/_shims/MultipartBody.d.ts.map +1 -0
  5. package/_shims/MultipartBody.js +16 -0
  6. package/_shims/MultipartBody.js.map +1 -0
  7. package/_shims/MultipartBody.mjs +12 -0
  8. package/_shims/MultipartBody.mjs.map +1 -0
  9. package/_shims/README.md +46 -0
  10. package/{src/_shims/ReadableStream-node.ts → _shims/auto/runtime-bun.d.ts} +2 -3
  11. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  12. package/_shims/auto/runtime-bun.js +21 -0
  13. package/_shims/auto/runtime-bun.js.map +1 -0
  14. package/_shims/auto/runtime-bun.mjs +2 -0
  15. package/_shims/auto/runtime-bun.mjs.map +1 -0
  16. package/_shims/auto/runtime-node.d.ts +5 -0
  17. package/_shims/auto/runtime-node.d.ts.map +1 -0
  18. package/_shims/auto/runtime-node.js +21 -0
  19. package/_shims/auto/runtime-node.js.map +1 -0
  20. package/_shims/auto/runtime-node.mjs +2 -0
  21. package/_shims/auto/runtime-node.mjs.map +1 -0
  22. package/_shims/auto/runtime.d.ts +5 -0
  23. package/_shims/auto/runtime.d.ts.map +1 -0
  24. package/_shims/auto/runtime.js +21 -0
  25. package/_shims/auto/runtime.js.map +1 -0
  26. package/_shims/auto/runtime.mjs +2 -0
  27. package/_shims/auto/runtime.mjs.map +1 -0
  28. package/_shims/auto/types-node.d.ts +5 -0
  29. package/_shims/auto/types-node.d.ts.map +1 -0
  30. package/_shims/auto/types-node.js +21 -0
  31. package/_shims/auto/types-node.js.map +1 -0
  32. package/_shims/auto/types-node.mjs +2 -0
  33. package/_shims/auto/types-node.mjs.map +1 -0
  34. package/_shims/auto/types.d.ts +99 -0
  35. package/_shims/{ReadableStream.js → auto/types.js} +0 -2
  36. package/{src/_shims/ReadableStream.js → _shims/auto/types.mjs} +0 -2
  37. package/_shims/bun-runtime.d.ts +6 -0
  38. package/_shims/bun-runtime.d.ts.map +1 -0
  39. package/_shims/bun-runtime.js +14 -0
  40. package/_shims/bun-runtime.js.map +1 -0
  41. package/_shims/bun-runtime.mjs +10 -0
  42. package/_shims/bun-runtime.mjs.map +1 -0
  43. package/_shims/index.d.ts +79 -0
  44. package/_shims/index.js +13 -0
  45. package/_shims/index.mjs +7 -0
  46. package/_shims/manual-types.d.ts +12 -0
  47. package/_shims/manual-types.js +3 -0
  48. package/_shims/manual-types.mjs +3 -0
  49. package/_shims/node-runtime.d.ts +3 -0
  50. package/_shims/node-runtime.d.ts.map +1 -0
  51. package/_shims/node-runtime.js +87 -0
  52. package/_shims/node-runtime.js.map +1 -0
  53. package/_shims/node-runtime.mjs +54 -0
  54. package/_shims/node-runtime.mjs.map +1 -0
  55. package/_shims/node-types.d.ts +42 -0
  56. package/_shims/node-types.js +3 -0
  57. package/_shims/node-types.mjs +3 -0
  58. package/_shims/registry.d.ts +35 -0
  59. package/_shims/registry.d.ts.map +1 -0
  60. package/_shims/registry.js +39 -0
  61. package/_shims/registry.js.map +1 -0
  62. package/_shims/registry.mjs +35 -0
  63. package/_shims/registry.mjs.map +1 -0
  64. package/_shims/web-runtime.d.ts +5 -0
  65. package/_shims/web-runtime.d.ts.map +1 -0
  66. package/_shims/web-runtime.js +70 -0
  67. package/_shims/web-runtime.js.map +1 -0
  68. package/_shims/web-runtime.mjs +63 -0
  69. package/_shims/web-runtime.mjs.map +1 -0
  70. package/_shims/web-types.d.ts +82 -0
  71. package/_shims/web-types.js +3 -0
  72. package/_shims/web-types.mjs +3 -0
  73. package/core.d.ts +170 -223
  74. package/core.d.ts.map +1 -1
  75. package/core.js +682 -729
  76. package/core.js.map +1 -1
  77. package/core.mjs +676 -680
  78. package/core.mjs.map +1 -1
  79. package/error.d.ts +32 -32
  80. package/error.d.ts.map +1 -1
  81. package/error.js +95 -106
  82. package/error.js.map +1 -1
  83. package/error.mjs +91 -91
  84. package/error.mjs.map +1 -1
  85. package/index.d.mts +145 -178
  86. package/index.d.ts +145 -178
  87. package/index.d.ts.map +1 -1
  88. package/index.js +145 -201
  89. package/index.js.map +1 -1
  90. package/index.mjs +123 -149
  91. package/index.mjs.map +1 -1
  92. package/package.json +31 -23
  93. package/pagination.d.ts +47 -167
  94. package/pagination.d.ts.map +1 -1
  95. package/pagination.js +72 -202
  96. package/pagination.js.map +1 -1
  97. package/pagination.mjs +68 -187
  98. package/pagination.mjs.map +1 -1
  99. package/resource.d.ts +10 -10
  100. package/resource.js +12 -12
  101. package/resource.mjs +10 -10
  102. package/resources/account.d.ts +44 -44
  103. package/resources/account.js +20 -19
  104. package/resources/account.mjs +17 -16
  105. package/resources/hris/benefits/benefits.d.ts +127 -154
  106. package/resources/hris/benefits/benefits.js +74 -89
  107. package/resources/hris/benefits/benefits.mjs +50 -48
  108. package/resources/hris/benefits/index.d.ts +3 -28
  109. package/resources/hris/benefits/index.js +13 -55
  110. package/resources/hris/benefits/index.mjs +3 -8
  111. package/resources/hris/benefits/individuals.d.ts +129 -147
  112. package/resources/hris/benefits/individuals.js +59 -59
  113. package/resources/hris/benefits/individuals.mjs +53 -49
  114. package/resources/hris/company.d.ts +80 -80
  115. package/resources/hris/company.js +12 -13
  116. package/resources/hris/company.mjs +9 -8
  117. package/resources/hris/directory.d.ts +53 -55
  118. package/resources/hris/directory.js +13 -12
  119. package/resources/hris/directory.mjs +8 -7
  120. package/resources/hris/employments.d.ts +124 -126
  121. package/resources/hris/employments.js +23 -21
  122. package/resources/hris/employments.mjs +19 -17
  123. package/resources/hris/hris.d.ts +113 -123
  124. package/resources/hris/hris.js +54 -71
  125. package/resources/hris/hris.mjs +32 -32
  126. package/resources/hris/index.d.ts +9 -41
  127. package/resources/hris/index.js +26 -110
  128. package/resources/hris/index.mjs +9 -9
  129. package/resources/hris/individuals.d.ts +65 -67
  130. package/resources/hris/individuals.js +19 -17
  131. package/resources/hris/individuals.mjs +14 -12
  132. package/resources/hris/pay-statements.d.ts +146 -162
  133. package/resources/hris/pay-statements.js +22 -20
  134. package/resources/hris/pay-statements.mjs +18 -16
  135. package/resources/hris/payments.d.ts +47 -49
  136. package/resources/hris/payments.js +15 -13
  137. package/resources/hris/payments.mjs +11 -9
  138. package/resources/index.d.ts +5 -7
  139. package/resources/index.d.ts.map +1 -1
  140. package/resources/index.js +13 -51
  141. package/resources/index.js.map +1 -1
  142. package/resources/index.mjs +5 -6
  143. package/resources/index.mjs.map +1 -1
  144. package/resources/providers.d.ts +43 -42
  145. package/resources/providers.js +15 -13
  146. package/resources/providers.mjs +11 -9
  147. package/resources/top-level.d.ts +1 -1
  148. package/resources/top-level.js +3 -3
  149. package/resources/top-level.mjs +1 -1
  150. package/resources/webhooks.d.ts +18 -18
  151. package/resources/webhooks.js +103 -107
  152. package/resources/webhooks.mjs +98 -102
  153. package/shims/node.d.ts +29 -0
  154. package/shims/node.d.ts.map +1 -0
  155. package/shims/node.js +31 -0
  156. package/shims/node.js.map +1 -0
  157. package/shims/node.mjs +5 -0
  158. package/shims/node.mjs.map +1 -0
  159. package/shims/web.d.ts +26 -0
  160. package/shims/web.d.ts.map +1 -0
  161. package/shims/web.js +31 -0
  162. package/shims/web.js.map +1 -0
  163. package/shims/web.mjs +5 -0
  164. package/shims/web.mjs.map +1 -0
  165. package/src/_shims/MultipartBody.ts +9 -0
  166. package/src/_shims/README.md +46 -0
  167. package/src/_shims/auto/runtime-bun.ts +4 -0
  168. package/src/_shims/auto/runtime-node.ts +4 -0
  169. package/src/_shims/auto/runtime.ts +4 -0
  170. package/src/_shims/auto/types-node.ts +4 -0
  171. package/src/_shims/auto/types.d.ts +99 -0
  172. package/src/_shims/auto/types.js +3 -0
  173. package/src/_shims/auto/types.mjs +3 -0
  174. package/src/_shims/bun-runtime.ts +14 -0
  175. package/src/_shims/index.d.ts +79 -0
  176. package/src/_shims/index.js +13 -0
  177. package/src/_shims/index.mjs +7 -0
  178. package/src/_shims/manual-types.d.ts +12 -0
  179. package/src/_shims/manual-types.js +3 -0
  180. package/src/_shims/manual-types.mjs +3 -0
  181. package/src/_shims/node-runtime.ts +79 -0
  182. package/src/_shims/node-types.d.ts +42 -0
  183. package/src/_shims/node-types.js +3 -0
  184. package/src/_shims/node-types.mjs +3 -0
  185. package/src/_shims/registry.ts +64 -0
  186. package/src/_shims/web-runtime.ts +91 -0
  187. package/src/_shims/web-types.d.ts +82 -0
  188. package/src/_shims/web-types.js +3 -0
  189. package/src/_shims/web-types.mjs +3 -0
  190. package/src/core.ts +75 -44
  191. package/src/error.ts +6 -4
  192. package/src/index.ts +8 -25
  193. package/src/pagination.ts +2 -261
  194. package/src/resource.ts +1 -1
  195. package/src/resources/account.ts +3 -3
  196. package/src/resources/hris/benefits/benefits.ts +6 -6
  197. package/src/resources/hris/benefits/index.ts +2 -2
  198. package/src/resources/hris/benefits/individuals.ts +6 -6
  199. package/src/resources/hris/company.ts +4 -4
  200. package/src/resources/hris/directory.ts +5 -5
  201. package/src/resources/hris/employments.ts +5 -5
  202. package/src/resources/hris/hris.ts +9 -9
  203. package/src/resources/hris/index.ts +8 -8
  204. package/src/resources/hris/individuals.ts +6 -6
  205. package/src/resources/hris/pay-statements.ts +6 -6
  206. package/src/resources/hris/payments.ts +5 -5
  207. package/src/resources/index.ts +4 -6
  208. package/src/resources/providers.ts +4 -4
  209. package/src/resources/webhooks.ts +2 -2
  210. package/src/shims/node.ts +50 -0
  211. package/src/shims/web.ts +50 -0
  212. package/src/uploads.ts +12 -16
  213. package/src/version.ts +1 -1
  214. package/uploads.d.ts +23 -39
  215. package/uploads.d.ts.map +1 -1
  216. package/uploads.js +115 -157
  217. package/uploads.js.map +1 -1
  218. package/uploads.mjs +111 -133
  219. package/uploads.mjs.map +1 -1
  220. package/version.d.ts +2 -2
  221. package/version.js +4 -4
  222. package/version.mjs +2 -2
  223. package/_shims/ReadableStream-node.d.ts +0 -6
  224. package/_shims/ReadableStream-node.d.ts.map +0 -1
  225. package/_shims/ReadableStream-node.js +0 -14
  226. package/_shims/ReadableStream-node.js.map +0 -1
  227. package/_shims/ReadableStream-node.mjs +0 -3
  228. package/_shims/ReadableStream-node.mjs.map +0 -1
  229. package/_shims/ReadableStream.d.ts +0 -38
  230. package/_shims/ReadableStream.mjs +0 -7
  231. package/_shims/agent-node.d.ts +0 -7
  232. package/_shims/agent-node.d.ts.map +0 -1
  233. package/_shims/agent-node.js +0 -28
  234. package/_shims/agent-node.js.map +0 -1
  235. package/_shims/agent-node.mjs +0 -16
  236. package/_shims/agent-node.mjs.map +0 -1
  237. package/_shims/agent.d.ts +0 -9
  238. package/_shims/agent.d.ts.map +0 -1
  239. package/_shims/agent.js +0 -14
  240. package/_shims/agent.js.map +0 -1
  241. package/_shims/agent.mjs +0 -10
  242. package/_shims/agent.mjs.map +0 -1
  243. package/_shims/fetch-node.d.ts +0 -64
  244. package/_shims/fetch-node.js +0 -12
  245. package/_shims/fetch-node.mjs +0 -14
  246. package/_shims/fetch.d.ts +0 -60
  247. package/_shims/fetch.js +0 -13
  248. package/_shims/fetch.mjs +0 -15
  249. package/_shims/fileFromPath-node.d.ts +0 -17
  250. package/_shims/fileFromPath-node.d.ts.map +0 -1
  251. package/_shims/fileFromPath-node.js +0 -17
  252. package/_shims/fileFromPath-node.js.map +0 -1
  253. package/_shims/fileFromPath-node.mjs +0 -13
  254. package/_shims/fileFromPath-node.mjs.map +0 -1
  255. package/_shims/fileFromPath.d.ts +0 -22
  256. package/_shims/fileFromPath.d.ts.map +0 -1
  257. package/_shims/fileFromPath.js +0 -16
  258. package/_shims/fileFromPath.js.map +0 -1
  259. package/_shims/fileFromPath.mjs +0 -12
  260. package/_shims/fileFromPath.mjs.map +0 -1
  261. package/_shims/form-data-node.d.ts +0 -45
  262. package/_shims/form-data-node.js +0 -11
  263. package/_shims/form-data-node.mjs +0 -9
  264. package/_shims/form-data.d.ts +0 -43
  265. package/_shims/form-data.js +0 -17
  266. package/_shims/form-data.mjs +0 -20
  267. package/_shims/getMultipartRequestOptions-node.d.ts +0 -10
  268. package/_shims/getMultipartRequestOptions-node.d.ts.map +0 -1
  269. package/_shims/getMultipartRequestOptions-node.js +0 -22
  270. package/_shims/getMultipartRequestOptions-node.js.map +0 -1
  271. package/_shims/getMultipartRequestOptions-node.mjs +0 -18
  272. package/_shims/getMultipartRequestOptions-node.mjs.map +0 -1
  273. package/_shims/getMultipartRequestOptions.d.ts +0 -10
  274. package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  275. package/_shims/getMultipartRequestOptions.js +0 -12
  276. package/_shims/getMultipartRequestOptions.js.map +0 -1
  277. package/_shims/getMultipartRequestOptions.mjs +0 -8
  278. package/_shims/getMultipartRequestOptions.mjs.map +0 -1
  279. package/_shims/node-readable-node.d.ts +0 -8
  280. package/_shims/node-readable-node.d.ts.map +0 -1
  281. package/_shims/node-readable-node.js +0 -9
  282. package/_shims/node-readable-node.js.map +0 -1
  283. package/_shims/node-readable-node.mjs +0 -5
  284. package/_shims/node-readable-node.mjs.map +0 -1
  285. package/_shims/node-readable.d.ts +0 -23
  286. package/_shims/node-readable.d.ts.map +0 -1
  287. package/_shims/node-readable.js +0 -11
  288. package/_shims/node-readable.js.map +0 -1
  289. package/_shims/node-readable.mjs +0 -7
  290. package/_shims/node-readable.mjs.map +0 -1
  291. package/resources/ats/applications.d.ts +0 -39
  292. package/resources/ats/applications.d.ts.map +0 -1
  293. package/resources/ats/applications.js +0 -24
  294. package/resources/ats/applications.js.map +0 -1
  295. package/resources/ats/applications.mjs +0 -20
  296. package/resources/ats/applications.mjs.map +0 -1
  297. package/resources/ats/ats.d.ts +0 -32
  298. package/resources/ats/ats.d.ts.map +0 -1
  299. package/resources/ats/ats.js +0 -71
  300. package/resources/ats/ats.js.map +0 -1
  301. package/resources/ats/ats.mjs +0 -27
  302. package/resources/ats/ats.mjs.map +0 -1
  303. package/resources/ats/candidates.d.ts +0 -53
  304. package/resources/ats/candidates.d.ts.map +0 -1
  305. package/resources/ats/candidates.js +0 -25
  306. package/resources/ats/candidates.js.map +0 -1
  307. package/resources/ats/candidates.mjs +0 -21
  308. package/resources/ats/candidates.mjs.map +0 -1
  309. package/resources/ats/index.d.ts +0 -7
  310. package/resources/ats/index.d.ts.map +0 -1
  311. package/resources/ats/index.js +0 -60
  312. package/resources/ats/index.js.map +0 -1
  313. package/resources/ats/index.mjs +0 -8
  314. package/resources/ats/index.mjs.map +0 -1
  315. package/resources/ats/jobs.d.ts +0 -47
  316. package/resources/ats/jobs.d.ts.map +0 -1
  317. package/resources/ats/jobs.js +0 -24
  318. package/resources/ats/jobs.js.map +0 -1
  319. package/resources/ats/jobs.mjs +0 -20
  320. package/resources/ats/jobs.mjs.map +0 -1
  321. package/resources/ats/offers.d.ts +0 -39
  322. package/resources/ats/offers.d.ts.map +0 -1
  323. package/resources/ats/offers.js +0 -24
  324. package/resources/ats/offers.js.map +0 -1
  325. package/resources/ats/offers.mjs +0 -20
  326. package/resources/ats/offers.mjs.map +0 -1
  327. package/resources/ats/stages.d.ts +0 -30
  328. package/resources/ats/stages.d.ts.map +0 -1
  329. package/resources/ats/stages.js +0 -22
  330. package/resources/ats/stages.js.map +0 -1
  331. package/resources/ats/stages.mjs +0 -17
  332. package/resources/ats/stages.mjs.map +0 -1
  333. package/src/_shims/ReadableStream.d.ts +0 -38
  334. package/src/_shims/ReadableStream.mjs +0 -7
  335. package/src/_shims/agent-node.ts +0 -22
  336. package/src/_shims/agent.ts +0 -12
  337. package/src/_shims/fetch-node.d.ts +0 -64
  338. package/src/_shims/fetch-node.js +0 -12
  339. package/src/_shims/fetch-node.mjs +0 -14
  340. package/src/_shims/fetch.d.ts +0 -60
  341. package/src/_shims/fetch.js +0 -13
  342. package/src/_shims/fetch.mjs +0 -15
  343. package/src/_shims/fileFromPath-node.ts +0 -29
  344. package/src/_shims/fileFromPath.ts +0 -29
  345. package/src/_shims/form-data-node.d.ts +0 -45
  346. package/src/_shims/form-data-node.js +0 -11
  347. package/src/_shims/form-data-node.mjs +0 -9
  348. package/src/_shims/form-data.d.ts +0 -43
  349. package/src/_shims/form-data.js +0 -17
  350. package/src/_shims/form-data.mjs +0 -20
  351. package/src/_shims/getMultipartRequestOptions-node.ts +0 -25
  352. package/src/_shims/getMultipartRequestOptions.ts +0 -14
  353. package/src/_shims/node-readable-node.ts +0 -10
  354. package/src/_shims/node-readable.ts +0 -30
  355. package/src/resources/ats/applications.ts +0 -64
  356. package/src/resources/ats/ats.ts +0 -39
  357. package/src/resources/ats/candidates.ts +0 -83
  358. package/src/resources/ats/index.ts +0 -8
  359. package/src/resources/ats/jobs.ts +0 -76
  360. package/src/resources/ats/offers.ts +0 -63
  361. package/src/resources/ats/stages.ts +0 -39
@@ -1,64 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless.
2
-
3
- import * as Core from '../../core.js';
4
- import { APIResource } from '../../resource.js';
5
- import { isRequestOptions } from '../../core.js';
6
- import * as Stages from './stages.js';
7
- import * as API from './index.js';
8
- import { ApplicationsPage, ApplicationsPageParams } from '../../pagination.js';
9
-
10
- export class Applications extends APIResource {
11
- /**
12
- * Gets an application from an organization.
13
- */
14
- retrieve(applicationId: string, options?: Core.RequestOptions): Core.APIPromise<Application> {
15
- return this.get(`/ats/applications/${applicationId}`, options);
16
- }
17
-
18
- /**
19
- * Gets all of an organization's applications.
20
- */
21
- list(
22
- query?: ApplicationListParams,
23
- options?: Core.RequestOptions,
24
- ): Core.PagePromise<ApplicationsPage, Application>;
25
- list(options?: Core.RequestOptions): Core.PagePromise<ApplicationsPage, Application>;
26
- list(
27
- query: ApplicationListParams | Core.RequestOptions = {},
28
- options?: Core.RequestOptions,
29
- ): Core.PagePromise<ApplicationsPage, Application> {
30
- if (isRequestOptions(query)) {
31
- return this.list({}, query);
32
- }
33
- return this.getAPIList('/ats/applications', ApplicationsPage, { query, ...options });
34
- }
35
- }
36
-
37
- export interface Application {
38
- id: string;
39
-
40
- candidate_id: string;
41
-
42
- job_id: string;
43
-
44
- offer_id: string | null;
45
-
46
- rejected_at: string | null;
47
-
48
- rejected_reason: Application.RejectedReason | null;
49
-
50
- stage: Stages.Stage | null;
51
- }
52
-
53
- export namespace Application {
54
- export interface RejectedReason {
55
- text?: string | null;
56
- }
57
- }
58
-
59
- export interface ApplicationListParams extends ApplicationsPageParams {}
60
-
61
- export namespace Applications {
62
- export import Application = API.Application;
63
- export import ApplicationListParams = API.ApplicationListParams;
64
- }
@@ -1,39 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless.
2
-
3
- import { APIResource } from '../../resource.js';
4
- import { Candidates } from './candidates.js';
5
- import { Applications } from './applications.js';
6
- import { Stages } from './stages.js';
7
- import { Jobs } from './jobs.js';
8
- import { Offers } from './offers.js';
9
- import * as API from './index.js';
10
-
11
- export class ATS extends APIResource {
12
- candidates: Candidates = new Candidates(this.client);
13
- applications: Applications = new Applications(this.client);
14
- stages: Stages = new Stages(this.client);
15
- jobs: Jobs = new Jobs(this.client);
16
- offers: Offers = new Offers(this.client);
17
- }
18
-
19
- export namespace ATS {
20
- export import Candidates = API.Candidates;
21
- export import Candidate = API.Candidate;
22
- export import CandidateListParams = API.CandidateListParams;
23
-
24
- export import Applications = API.Applications;
25
- export import Application = API.Application;
26
- export import ApplicationListParams = API.ApplicationListParams;
27
-
28
- export import Stages = API.Stages;
29
- export import Stage = API.Stage;
30
- export import StagesSinglePage = API.StagesSinglePage;
31
-
32
- export import Jobs = API.Jobs;
33
- export import Job = API.Job;
34
- export import JobListParams = API.JobListParams;
35
-
36
- export import Offers = API.Offers;
37
- export import Offer = API.Offer;
38
- export import OfferListParams = API.OfferListParams;
39
- }
@@ -1,83 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless.
2
-
3
- import * as Core from '../../core.js';
4
- import { APIResource } from '../../resource.js';
5
- import { isRequestOptions } from '../../core.js';
6
- import * as API from './index.js';
7
- import { CandidatesPage, CandidatesPageParams } from '../../pagination.js';
8
-
9
- export class Candidates extends APIResource {
10
- /**
11
- * Gets a candidate from an organization. A candidate represents an individual
12
- * associated with one or more applications.
13
- */
14
- retrieve(candidateId: string, options?: Core.RequestOptions): Core.APIPromise<Candidate> {
15
- return this.get(`/ats/candidates/${candidateId}`, options);
16
- }
17
-
18
- /**
19
- * Gets all of an organization's candidates. A candidate represents an individual
20
- * associated with one or more applications.
21
- */
22
- list(
23
- query?: CandidateListParams,
24
- options?: Core.RequestOptions,
25
- ): Core.PagePromise<CandidatesPage, Candidate>;
26
- list(options?: Core.RequestOptions): Core.PagePromise<CandidatesPage, Candidate>;
27
- list(
28
- query: CandidateListParams | Core.RequestOptions = {},
29
- options?: Core.RequestOptions,
30
- ): Core.PagePromise<CandidatesPage, Candidate> {
31
- if (isRequestOptions(query)) {
32
- return this.list({}, query);
33
- }
34
- return this.getAPIList('/ats/candidates', CandidatesPage, { query, ...options });
35
- }
36
- }
37
-
38
- /**
39
- * A candidate represents an individual associated with one or more applications.
40
- */
41
- export interface Candidate {
42
- id: string;
43
-
44
- /**
45
- * Array of Finch uuids corresponding to `application`s for this individual
46
- */
47
- application_ids: Array<string>;
48
-
49
- created_at: string;
50
-
51
- emails: Array<Candidate.Email>;
52
-
53
- first_name: string | null;
54
-
55
- full_name: string | null;
56
-
57
- last_activity_at: string;
58
-
59
- last_name: string | null;
60
-
61
- phone_numbers: Array<Candidate.PhoneNumber>;
62
- }
63
-
64
- export namespace Candidate {
65
- export interface Email {
66
- data?: string | null;
67
-
68
- type?: string | null;
69
- }
70
-
71
- export interface PhoneNumber {
72
- data?: string | null;
73
-
74
- type?: string | null;
75
- }
76
- }
77
-
78
- export interface CandidateListParams extends CandidatesPageParams {}
79
-
80
- export namespace Candidates {
81
- export import Candidate = API.Candidate;
82
- export import CandidateListParams = API.CandidateListParams;
83
- }
@@ -1,8 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless.
2
-
3
- export { ATS } from './ats.js';
4
- export { Application, ApplicationListParams, Applications } from './applications.js';
5
- export { Candidate, CandidateListParams, Candidates } from './candidates.js';
6
- export { Job, JobListParams, Jobs } from './jobs.js';
7
- export { Offer, OfferListParams, Offers } from './offers.js';
8
- export { Stage, StagesSinglePage, Stages } from './stages.js';
@@ -1,76 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless.
2
-
3
- import * as Core from '../../core.js';
4
- import { APIResource } from '../../resource.js';
5
- import { isRequestOptions } from '../../core.js';
6
- import * as API from './index.js';
7
- import { JobsPage, JobsPageParams } from '../../pagination.js';
8
-
9
- export class Jobs extends APIResource {
10
- /**
11
- * Gets a job from an organization.
12
- */
13
- retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<Job> {
14
- return this.get(`/ats/jobs/${jobId}`, options);
15
- }
16
-
17
- /**
18
- * Gets all of an organization's jobs.
19
- */
20
- list(query?: JobListParams, options?: Core.RequestOptions): Core.PagePromise<JobsPage, Job>;
21
- list(options?: Core.RequestOptions): Core.PagePromise<JobsPage, Job>;
22
- list(
23
- query: JobListParams | Core.RequestOptions = {},
24
- options?: Core.RequestOptions,
25
- ): Core.PagePromise<JobsPage, Job> {
26
- if (isRequestOptions(query)) {
27
- return this.list({}, query);
28
- }
29
- return this.getAPIList('/ats/jobs', JobsPage, { query, ...options });
30
- }
31
- }
32
-
33
- export interface Job {
34
- id: string;
35
-
36
- closed_at: string | null;
37
-
38
- created_at: string | null;
39
-
40
- department: Job.Department;
41
-
42
- hiring_team: Job.HiringTeam;
43
-
44
- name: string | null;
45
-
46
- status: 'open' | 'closed' | 'on_hold' | 'draft' | 'archived' | null;
47
- }
48
-
49
- export namespace Job {
50
- export interface Department {
51
- name?: string | null;
52
- }
53
-
54
- export interface HiringTeam {
55
- hiring_managers?: Array<HiringTeam.HiringManager> | null;
56
-
57
- recruiters?: Array<HiringTeam.Recruiter> | null;
58
- }
59
-
60
- export namespace HiringTeam {
61
- export interface HiringManager {
62
- name?: string;
63
- }
64
-
65
- export interface Recruiter {
66
- name?: string;
67
- }
68
- }
69
- }
70
-
71
- export interface JobListParams extends JobsPageParams {}
72
-
73
- export namespace Jobs {
74
- export import Job = API.Job;
75
- export import JobListParams = API.JobListParams;
76
- }
@@ -1,63 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless.
2
-
3
- import * as Core from '../../core.js';
4
- import { APIResource } from '../../resource.js';
5
- import { isRequestOptions } from '../../core.js';
6
- import * as API from './index.js';
7
- import { OffersPage, OffersPageParams } from '../../pagination.js';
8
-
9
- export class Offers extends APIResource {
10
- /**
11
- * Get a single offer from an organization.
12
- */
13
- retrieve(offerId: string, options?: Core.RequestOptions): Core.APIPromise<Offer> {
14
- return this.get(`/ats/offers/${offerId}`, options);
15
- }
16
-
17
- /**
18
- * Get all offers put out by an organization.
19
- */
20
- list(query?: OfferListParams, options?: Core.RequestOptions): Core.PagePromise<OffersPage, Offer>;
21
- list(options?: Core.RequestOptions): Core.PagePromise<OffersPage, Offer>;
22
- list(
23
- query: OfferListParams | Core.RequestOptions = {},
24
- options?: Core.RequestOptions,
25
- ): Core.PagePromise<OffersPage, Offer> {
26
- if (isRequestOptions(query)) {
27
- return this.list({}, query);
28
- }
29
- return this.getAPIList('/ats/offers', OffersPage, { query, ...options });
30
- }
31
- }
32
-
33
- export interface Offer {
34
- id: string;
35
-
36
- application_id: string;
37
-
38
- candidate_id: string;
39
-
40
- created_at: string;
41
-
42
- job_id: string;
43
-
44
- status:
45
- | 'signed'
46
- | 'rejected'
47
- | 'draft'
48
- | 'approval-sent'
49
- | 'approved'
50
- | 'sent'
51
- | 'sent-manually'
52
- | 'opened'
53
- | 'archived';
54
-
55
- updated_at: string;
56
- }
57
-
58
- export interface OfferListParams extends OffersPageParams {}
59
-
60
- export namespace Offers {
61
- export import Offer = API.Offer;
62
- export import OfferListParams = API.OfferListParams;
63
- }
@@ -1,39 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless.
2
-
3
- import * as Core from '../../core.js';
4
- import { APIResource } from '../../resource.js';
5
- import * as API from './index.js';
6
- import { SinglePage } from '../../pagination.js';
7
-
8
- export class Stages extends APIResource {
9
- /**
10
- * Get all job stages for an organization. Depending on the system, some jobs may
11
- * have stages specific to that job. Other job stages may apply broadly to all jobs
12
- * in the system. Use the `job_id` to determine whether a job applies specifically
13
- * to a job.
14
- */
15
- list(options?: Core.RequestOptions): Core.PagePromise<StagesSinglePage, Stage> {
16
- return this.getAPIList('/ats/stages', StagesSinglePage, options);
17
- }
18
- }
19
-
20
- export class StagesSinglePage extends SinglePage<Stage> {}
21
- // alias so we can export it in the namespace
22
- type _StagesSinglePage = StagesSinglePage;
23
-
24
- export interface Stage {
25
- id?: string;
26
-
27
- /**
28
- * The job id that this stage applies to, if applicable. Not all systems enumerate
29
- * stages specific to jobs.
30
- */
31
- job_id?: string | null;
32
-
33
- name?: string | null;
34
- }
35
-
36
- export namespace Stages {
37
- export import Stage = API.Stage;
38
- export type StagesSinglePage = _StagesSinglePage;
39
- }