@tryfinch/finch-api 5.0.0 → 5.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +51 -0
- package/README.md +61 -21
- package/_shims/MultipartBody.d.ts +9 -0
- package/_shims/MultipartBody.d.ts.map +1 -0
- package/_shims/MultipartBody.js +16 -0
- package/_shims/MultipartBody.js.map +1 -0
- package/_shims/MultipartBody.mjs +12 -0
- package/_shims/MultipartBody.mjs.map +1 -0
- package/_shims/README.md +46 -0
- package/{src/_shims/ReadableStream.node.ts → _shims/auto/runtime-bun.d.ts} +2 -3
- package/_shims/auto/runtime-bun.d.ts.map +1 -0
- package/_shims/auto/runtime-bun.js +21 -0
- package/_shims/auto/runtime-bun.js.map +1 -0
- package/_shims/auto/runtime-bun.mjs +2 -0
- package/_shims/auto/runtime-bun.mjs.map +1 -0
- package/_shims/auto/runtime-node.d.ts +5 -0
- package/_shims/auto/runtime-node.d.ts.map +1 -0
- package/_shims/auto/runtime-node.js +21 -0
- package/_shims/auto/runtime-node.js.map +1 -0
- package/_shims/auto/runtime-node.mjs +2 -0
- package/_shims/auto/runtime-node.mjs.map +1 -0
- package/_shims/auto/runtime.d.ts +5 -0
- package/_shims/auto/runtime.d.ts.map +1 -0
- package/_shims/auto/runtime.js +21 -0
- package/_shims/auto/runtime.js.map +1 -0
- package/_shims/auto/runtime.mjs +2 -0
- package/_shims/auto/runtime.mjs.map +1 -0
- package/_shims/auto/types-node.d.ts +5 -0
- package/_shims/auto/types-node.d.ts.map +1 -0
- package/_shims/auto/types-node.js +21 -0
- package/_shims/auto/types-node.js.map +1 -0
- package/_shims/auto/types-node.mjs +2 -0
- package/_shims/auto/types-node.mjs.map +1 -0
- package/_shims/auto/types.d.ts +99 -0
- package/{src/_shims/ReadableStream.js → _shims/auto/types.js} +0 -2
- package/_shims/{ReadableStream.js → auto/types.mjs} +0 -2
- package/_shims/bun-runtime.d.ts +6 -0
- package/_shims/bun-runtime.d.ts.map +1 -0
- package/_shims/bun-runtime.js +14 -0
- package/_shims/bun-runtime.js.map +1 -0
- package/_shims/bun-runtime.mjs +10 -0
- package/_shims/bun-runtime.mjs.map +1 -0
- package/_shims/index.d.ts +79 -0
- package/_shims/index.js +13 -0
- package/_shims/index.mjs +7 -0
- package/_shims/manual-types.d.ts +12 -0
- package/_shims/manual-types.js +3 -0
- package/_shims/manual-types.mjs +3 -0
- package/_shims/node-runtime.d.ts +3 -0
- package/_shims/node-runtime.d.ts.map +1 -0
- package/_shims/node-runtime.js +87 -0
- package/_shims/node-runtime.js.map +1 -0
- package/_shims/node-runtime.mjs +54 -0
- package/_shims/node-runtime.mjs.map +1 -0
- package/_shims/node-types.d.ts +42 -0
- package/_shims/node-types.js +3 -0
- package/_shims/node-types.mjs +3 -0
- package/_shims/registry.d.ts +35 -0
- package/_shims/registry.d.ts.map +1 -0
- package/_shims/registry.js +39 -0
- package/_shims/registry.js.map +1 -0
- package/_shims/registry.mjs +35 -0
- package/_shims/registry.mjs.map +1 -0
- package/_shims/web-runtime.d.ts +5 -0
- package/_shims/web-runtime.d.ts.map +1 -0
- package/_shims/web-runtime.js +70 -0
- package/_shims/web-runtime.js.map +1 -0
- package/_shims/web-runtime.mjs +63 -0
- package/_shims/web-runtime.mjs.map +1 -0
- package/_shims/web-types.d.ts +82 -0
- package/_shims/web-types.js +3 -0
- package/_shims/web-types.mjs +3 -0
- package/core.d.ts +171 -223
- package/core.d.ts.map +1 -1
- package/core.js +674 -728
- package/core.js.map +1 -1
- package/core.mjs +668 -681
- package/core.mjs.map +1 -1
- package/error.d.ts +29 -31
- package/error.d.ts.map +1 -1
- package/error.js +91 -105
- package/error.js.map +1 -1
- package/error.mjs +88 -90
- package/error.mjs.map +1 -1
- package/index.d.mts +144 -173
- package/index.d.ts +144 -173
- package/index.d.ts.map +1 -1
- package/index.js +144 -195
- package/index.js.map +1 -1
- package/index.mjs +122 -143
- package/index.mjs.map +1 -1
- package/package.json +33 -20
- package/pagination.d.ts +47 -167
- package/pagination.d.ts.map +1 -1
- package/pagination.js +72 -202
- package/pagination.js.map +1 -1
- package/pagination.mjs +68 -187
- package/pagination.mjs.map +1 -1
- package/resource.d.ts +10 -10
- package/resource.js +12 -12
- package/resource.mjs +10 -10
- package/resources/account.d.ts +44 -44
- package/resources/account.js +20 -19
- package/resources/account.mjs +17 -16
- package/resources/hris/benefits/benefits.d.ts +127 -154
- package/resources/hris/benefits/benefits.js +74 -89
- package/resources/hris/benefits/benefits.mjs +50 -48
- package/resources/hris/benefits/index.d.ts +3 -28
- package/resources/hris/benefits/index.js +13 -55
- package/resources/hris/benefits/index.mjs +3 -8
- package/resources/hris/benefits/individuals.d.ts +129 -147
- package/resources/hris/benefits/individuals.js +59 -59
- package/resources/hris/benefits/individuals.mjs +53 -49
- package/resources/hris/company.d.ts +80 -80
- package/resources/hris/company.js +12 -13
- package/resources/hris/company.mjs +9 -8
- package/resources/hris/directory.d.ts +53 -55
- package/resources/hris/directory.js +13 -12
- package/resources/hris/directory.mjs +8 -7
- package/resources/hris/employments.d.ts +124 -126
- package/resources/hris/employments.js +23 -21
- package/resources/hris/employments.mjs +19 -17
- package/resources/hris/hris.d.ts +113 -123
- package/resources/hris/hris.js +54 -71
- package/resources/hris/hris.mjs +32 -32
- package/resources/hris/index.d.ts +9 -41
- package/resources/hris/index.js +26 -110
- package/resources/hris/index.mjs +9 -9
- package/resources/hris/individuals.d.ts +65 -67
- package/resources/hris/individuals.js +19 -17
- package/resources/hris/individuals.mjs +14 -12
- package/resources/hris/pay-statements.d.ts +146 -162
- package/resources/hris/pay-statements.js +22 -20
- package/resources/hris/pay-statements.mjs +18 -16
- package/resources/hris/payments.d.ts +47 -49
- package/resources/hris/payments.js +15 -13
- package/resources/hris/payments.mjs +11 -9
- package/resources/index.d.ts +6 -6
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +13 -38
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +5 -5
- package/resources/index.mjs.map +1 -1
- package/resources/providers.d.ts +43 -42
- package/resources/providers.js +15 -13
- package/resources/providers.mjs +11 -9
- package/resources/top-level.d.ts +1 -1
- package/resources/top-level.js +3 -3
- package/resources/top-level.mjs +1 -1
- package/resources/webhooks.d.ts +22 -0
- package/resources/webhooks.d.ts.map +1 -0
- package/resources/webhooks.js +114 -0
- package/resources/webhooks.js.map +1 -0
- package/resources/webhooks.mjs +110 -0
- package/resources/webhooks.mjs.map +1 -0
- package/shims/node.d.ts +29 -0
- package/shims/node.d.ts.map +1 -0
- package/shims/node.js +31 -0
- package/shims/node.js.map +1 -0
- package/shims/node.mjs +5 -0
- package/shims/node.mjs.map +1 -0
- package/shims/web.d.ts +26 -0
- package/shims/web.d.ts.map +1 -0
- package/shims/web.js +31 -0
- package/shims/web.js.map +1 -0
- package/shims/web.mjs +5 -0
- package/shims/web.mjs.map +1 -0
- package/src/_shims/MultipartBody.ts +9 -0
- package/src/_shims/README.md +46 -0
- package/src/_shims/auto/runtime-bun.ts +4 -0
- package/src/_shims/auto/runtime-node.ts +4 -0
- package/src/_shims/auto/runtime.ts +4 -0
- package/src/_shims/auto/types-node.ts +4 -0
- package/src/_shims/auto/types.d.ts +99 -0
- package/src/_shims/auto/types.js +3 -0
- package/src/_shims/auto/types.mjs +3 -0
- package/src/_shims/bun-runtime.ts +14 -0
- package/src/_shims/index.d.ts +79 -0
- package/src/_shims/index.js +13 -0
- package/src/_shims/index.mjs +7 -0
- package/src/_shims/manual-types.d.ts +12 -0
- package/src/_shims/manual-types.js +3 -0
- package/src/_shims/manual-types.mjs +3 -0
- package/src/_shims/node-runtime.ts +79 -0
- package/src/_shims/node-types.d.ts +42 -0
- package/src/_shims/node-types.js +3 -0
- package/src/_shims/node-types.mjs +3 -0
- package/src/_shims/registry.ts +64 -0
- package/src/_shims/web-runtime.ts +91 -0
- package/src/_shims/web-types.d.ts +82 -0
- package/src/_shims/web-types.js +3 -0
- package/src/_shims/web-types.mjs +3 -0
- package/src/core.ts +38 -17
- package/src/error.ts +4 -4
- package/src/index.ts +12 -21
- package/src/pagination.ts +0 -259
- package/src/resources/account.ts +2 -2
- package/src/resources/hris/benefits/benefits.ts +4 -4
- package/src/resources/hris/benefits/individuals.ts +5 -5
- package/src/resources/hris/company.ts +3 -3
- package/src/resources/hris/directory.ts +4 -4
- package/src/resources/hris/employments.ts +4 -4
- package/src/resources/hris/hris.ts +1 -1
- package/src/resources/hris/individuals.ts +5 -5
- package/src/resources/hris/pay-statements.ts +5 -5
- package/src/resources/hris/payments.ts +4 -4
- package/src/resources/index.ts +1 -1
- package/src/resources/providers.ts +3 -3
- package/src/resources/webhooks.ts +151 -0
- package/src/shims/node.ts +50 -0
- package/src/shims/web.ts +50 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +11 -15
- package/src/version.ts +1 -1
- package/uploads.d.ts +23 -39
- package/uploads.d.ts.map +1 -1
- package/uploads.js +115 -157
- package/uploads.js.map +1 -1
- package/uploads.mjs +111 -133
- package/uploads.mjs.map +1 -1
- package/version.d.ts +2 -2
- package/version.js +4 -4
- package/version.mjs +2 -2
- package/_shims/ReadableStream.d.ts +0 -38
- package/_shims/ReadableStream.mjs +0 -7
- package/_shims/ReadableStream.node.d.ts +0 -6
- package/_shims/ReadableStream.node.d.ts.map +0 -1
- package/_shims/ReadableStream.node.js +0 -14
- package/_shims/ReadableStream.node.js.map +0 -1
- package/_shims/ReadableStream.node.mjs +0 -3
- package/_shims/ReadableStream.node.mjs.map +0 -1
- package/_shims/agent.d.ts +0 -9
- package/_shims/agent.d.ts.map +0 -1
- package/_shims/agent.js +0 -14
- package/_shims/agent.js.map +0 -1
- package/_shims/agent.mjs +0 -10
- package/_shims/agent.mjs.map +0 -1
- package/_shims/agent.node.d.ts +0 -7
- package/_shims/agent.node.d.ts.map +0 -1
- package/_shims/agent.node.js +0 -28
- package/_shims/agent.node.js.map +0 -1
- package/_shims/agent.node.mjs +0 -16
- package/_shims/agent.node.mjs.map +0 -1
- package/_shims/fetch.d.ts +0 -60
- package/_shims/fetch.js +0 -13
- package/_shims/fetch.mjs +0 -15
- package/_shims/fetch.node.d.ts +0 -64
- package/_shims/fetch.node.js +0 -12
- package/_shims/fetch.node.mjs +0 -14
- package/_shims/fileFromPath.d.ts +0 -22
- package/_shims/fileFromPath.d.ts.map +0 -1
- package/_shims/fileFromPath.js +0 -16
- package/_shims/fileFromPath.js.map +0 -1
- package/_shims/fileFromPath.mjs +0 -12
- package/_shims/fileFromPath.mjs.map +0 -1
- package/_shims/fileFromPath.node.d.ts +0 -17
- package/_shims/fileFromPath.node.d.ts.map +0 -1
- package/_shims/fileFromPath.node.js +0 -17
- package/_shims/fileFromPath.node.js.map +0 -1
- package/_shims/fileFromPath.node.mjs +0 -13
- package/_shims/fileFromPath.node.mjs.map +0 -1
- package/_shims/formdata.d.ts +0 -43
- package/_shims/formdata.js +0 -17
- package/_shims/formdata.mjs +0 -20
- package/_shims/formdata.node.d.ts +0 -45
- package/_shims/formdata.node.js +0 -11
- package/_shims/formdata.node.mjs +0 -9
- package/_shims/getMultipartRequestOptions.d.ts +0 -10
- package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
- package/_shims/getMultipartRequestOptions.js +0 -12
- package/_shims/getMultipartRequestOptions.js.map +0 -1
- package/_shims/getMultipartRequestOptions.mjs +0 -8
- package/_shims/getMultipartRequestOptions.mjs.map +0 -1
- package/_shims/getMultipartRequestOptions.node.d.ts +0 -10
- package/_shims/getMultipartRequestOptions.node.d.ts.map +0 -1
- package/_shims/getMultipartRequestOptions.node.js +0 -22
- package/_shims/getMultipartRequestOptions.node.js.map +0 -1
- package/_shims/getMultipartRequestOptions.node.mjs +0 -18
- package/_shims/getMultipartRequestOptions.node.mjs.map +0 -1
- package/_shims/node-readable.d.ts +0 -23
- package/_shims/node-readable.d.ts.map +0 -1
- package/_shims/node-readable.js +0 -11
- package/_shims/node-readable.js.map +0 -1
- package/_shims/node-readable.mjs +0 -7
- package/_shims/node-readable.mjs.map +0 -1
- package/_shims/node-readable.node.d.ts +0 -8
- package/_shims/node-readable.node.d.ts.map +0 -1
- package/_shims/node-readable.node.js +0 -9
- package/_shims/node-readable.node.js.map +0 -1
- package/_shims/node-readable.node.mjs +0 -5
- package/_shims/node-readable.node.mjs.map +0 -1
- package/resources/ats/applications.d.ts +0 -39
- package/resources/ats/applications.d.ts.map +0 -1
- package/resources/ats/applications.js +0 -24
- package/resources/ats/applications.js.map +0 -1
- package/resources/ats/applications.mjs +0 -20
- package/resources/ats/applications.mjs.map +0 -1
- package/resources/ats/ats.d.ts +0 -32
- package/resources/ats/ats.d.ts.map +0 -1
- package/resources/ats/ats.js +0 -71
- package/resources/ats/ats.js.map +0 -1
- package/resources/ats/ats.mjs +0 -27
- package/resources/ats/ats.mjs.map +0 -1
- package/resources/ats/candidates.d.ts +0 -53
- package/resources/ats/candidates.d.ts.map +0 -1
- package/resources/ats/candidates.js +0 -25
- package/resources/ats/candidates.js.map +0 -1
- package/resources/ats/candidates.mjs +0 -21
- package/resources/ats/candidates.mjs.map +0 -1
- package/resources/ats/index.d.ts +0 -7
- package/resources/ats/index.d.ts.map +0 -1
- package/resources/ats/index.js +0 -60
- package/resources/ats/index.js.map +0 -1
- package/resources/ats/index.mjs +0 -8
- package/resources/ats/index.mjs.map +0 -1
- package/resources/ats/jobs.d.ts +0 -47
- package/resources/ats/jobs.d.ts.map +0 -1
- package/resources/ats/jobs.js +0 -24
- package/resources/ats/jobs.js.map +0 -1
- package/resources/ats/jobs.mjs +0 -20
- package/resources/ats/jobs.mjs.map +0 -1
- package/resources/ats/offers.d.ts +0 -39
- package/resources/ats/offers.d.ts.map +0 -1
- package/resources/ats/offers.js +0 -24
- package/resources/ats/offers.js.map +0 -1
- package/resources/ats/offers.mjs +0 -20
- package/resources/ats/offers.mjs.map +0 -1
- package/resources/ats/stages.d.ts +0 -30
- package/resources/ats/stages.d.ts.map +0 -1
- package/resources/ats/stages.js +0 -22
- package/resources/ats/stages.js.map +0 -1
- package/resources/ats/stages.mjs +0 -17
- package/resources/ats/stages.mjs.map +0 -1
- package/src/_shims/ReadableStream.d.ts +0 -38
- package/src/_shims/ReadableStream.mjs +0 -7
- package/src/_shims/agent.node.ts +0 -22
- package/src/_shims/agent.ts +0 -12
- package/src/_shims/fetch.d.ts +0 -60
- package/src/_shims/fetch.deno.ts +0 -23
- package/src/_shims/fetch.js +0 -13
- package/src/_shims/fetch.mjs +0 -15
- package/src/_shims/fetch.node.d.ts +0 -64
- package/src/_shims/fetch.node.js +0 -12
- package/src/_shims/fetch.node.mjs +0 -14
- package/src/_shims/fileFromPath.node.ts +0 -29
- package/src/_shims/fileFromPath.ts +0 -29
- package/src/_shims/formdata.d.ts +0 -43
- package/src/_shims/formdata.deno.ts +0 -16
- package/src/_shims/formdata.js +0 -17
- package/src/_shims/formdata.mjs +0 -20
- package/src/_shims/formdata.node.d.ts +0 -45
- package/src/_shims/formdata.node.js +0 -11
- package/src/_shims/formdata.node.mjs +0 -9
- package/src/_shims/getMultipartRequestOptions.node.ts +0 -25
- package/src/_shims/getMultipartRequestOptions.ts +0 -14
- package/src/_shims/node-readable.node.ts +0 -10
- package/src/_shims/node-readable.ts +0 -30
- package/src/resources/ats/applications.ts +0 -64
- package/src/resources/ats/ats.ts +0 -39
- package/src/resources/ats/candidates.ts +0 -83
- package/src/resources/ats/index.ts +0 -8
- package/src/resources/ats/jobs.ts +0 -76
- package/src/resources/ats/offers.ts +0 -63
- package/src/resources/ats/stages.ts +0 -39
package/index.mjs
CHANGED
|
@@ -1,126 +1,122 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless.
|
|
2
2
|
var _a;
|
|
3
|
-
import * as Core from
|
|
4
|
-
import * as Pagination from
|
|
5
|
-
import * as API from
|
|
6
|
-
import * as Errors from
|
|
7
|
-
import * as Uploads from
|
|
3
|
+
import * as Core from "./core.mjs";
|
|
4
|
+
import * as Pagination from "./pagination.mjs";
|
|
5
|
+
import * as API from "./resources/index.mjs";
|
|
6
|
+
import * as Errors from "./error.mjs";
|
|
7
|
+
import * as Uploads from "./uploads.mjs";
|
|
8
8
|
/** API Client for interfacing with the Finch API. */
|
|
9
9
|
export class Finch extends Core.APIClient {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
this.clientId = clientId;
|
|
53
|
-
this.clientSecret = clientSecret;
|
|
54
|
-
}
|
|
55
|
-
/**
|
|
56
|
-
* Returns an access token for the Finch API given an authorization code. An
|
|
57
|
-
* authorization code can be obtained by visiting the url returned by
|
|
58
|
-
* get_auth_url().
|
|
59
|
-
*/
|
|
60
|
-
getAccessToken(code, { redirectUri }) {
|
|
61
|
-
if (!this.clientId) {
|
|
62
|
-
throw new Error('Expected the clientId to be set in order to call getAccessToken');
|
|
10
|
+
/**
|
|
11
|
+
* API Client for interfacing with the Finch API.
|
|
12
|
+
*
|
|
13
|
+
* @param {string | null} opts.accessToken - The Access Token to send to the API.
|
|
14
|
+
* @param {string} [opts.baseURL] - Override the default base URL for the API.
|
|
15
|
+
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
16
|
+
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
17
|
+
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
18
|
+
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
19
|
+
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
20
|
+
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
21
|
+
* @param {string | null} [opts.clientId]
|
|
22
|
+
* @param {string | null} [opts.clientSecret]
|
|
23
|
+
* @param {string | null} [opts.webhookSecret]
|
|
24
|
+
*/
|
|
25
|
+
constructor(_b) {
|
|
26
|
+
var _c, _d, _e, _f, _g;
|
|
27
|
+
var { accessToken = null, clientId = (_c = Core.readEnv('FINCH_CLIENT_ID')) !== null && _c !== void 0 ? _c : null, clientSecret = (_d = Core.readEnv('FINCH_CLIENT_SECRET')) !== null && _d !== void 0 ? _d : null, webhookSecret = (_e = Core.readEnv('FINCH_WEBHOOK_SECRET')) !== null && _e !== void 0 ? _e : null, ...opts } = _b === void 0 ? {} : _b;
|
|
28
|
+
const options = {
|
|
29
|
+
accessToken,
|
|
30
|
+
clientId,
|
|
31
|
+
clientSecret,
|
|
32
|
+
webhookSecret,
|
|
33
|
+
...opts,
|
|
34
|
+
baseURL: (_f = opts.baseURL) !== null && _f !== void 0 ? _f : `https://api.tryfinch.com`,
|
|
35
|
+
};
|
|
36
|
+
super({
|
|
37
|
+
baseURL: options.baseURL,
|
|
38
|
+
timeout: (_g = options.timeout) !== null && _g !== void 0 ? _g : 60000 /* 1 minute */,
|
|
39
|
+
httpAgent: options.httpAgent,
|
|
40
|
+
maxRetries: options.maxRetries,
|
|
41
|
+
fetch: options.fetch,
|
|
42
|
+
});
|
|
43
|
+
this.hris = new API.HRIS(this);
|
|
44
|
+
this.providers = new API.Providers(this);
|
|
45
|
+
this.account = new API.Account(this);
|
|
46
|
+
this.webhooks = new API.Webhooks(this);
|
|
47
|
+
this._options = options;
|
|
48
|
+
this.accessToken = accessToken;
|
|
49
|
+
this.clientId = clientId;
|
|
50
|
+
this.clientSecret = clientSecret;
|
|
51
|
+
this.webhookSecret = webhookSecret;
|
|
63
52
|
}
|
|
64
|
-
|
|
65
|
-
|
|
53
|
+
/**
|
|
54
|
+
* Returns an access token for the Finch API given an authorization code. An
|
|
55
|
+
* authorization code can be obtained by visiting the url returned by
|
|
56
|
+
* get_auth_url().
|
|
57
|
+
*/
|
|
58
|
+
getAccessToken(code, { redirectUri }) {
|
|
59
|
+
if (!this.clientId) {
|
|
60
|
+
throw new Error('Expected the clientId to be set in order to call getAccessToken');
|
|
61
|
+
}
|
|
62
|
+
if (!this.clientSecret) {
|
|
63
|
+
throw new Error('Expected the clientSecret to be set in order to call getAccessToken');
|
|
64
|
+
}
|
|
65
|
+
return this.post('/auth/token', {
|
|
66
|
+
body: {
|
|
67
|
+
client_id: this.clientId,
|
|
68
|
+
client_secret: this.clientSecret,
|
|
69
|
+
code: code,
|
|
70
|
+
redirect_uri: redirectUri,
|
|
71
|
+
},
|
|
72
|
+
headers: {
|
|
73
|
+
Authorization: null,
|
|
74
|
+
},
|
|
75
|
+
}).then((response) => response.access_token);
|
|
66
76
|
}
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
getAuthURL({ products, redirectUri, sandbox }) {
|
|
85
|
-
if (!this.clientId) {
|
|
86
|
-
throw new Error('Expected the clientId to be set in order to call getAuthUrl');
|
|
77
|
+
/**
|
|
78
|
+
* Returns the authorization url which can be visited in order to obtain an
|
|
79
|
+
* authorization code from Finch. The autorization code can then be exchanged for
|
|
80
|
+
* an access token for the Finch api by calling get_access_token().
|
|
81
|
+
*/
|
|
82
|
+
getAuthURL({ products, redirectUri, sandbox, }) {
|
|
83
|
+
if (!this.clientId) {
|
|
84
|
+
throw new Error('Expected the clientId to be set in order to call getAuthUrl');
|
|
85
|
+
}
|
|
86
|
+
const url = new URL('/authorize', 'https://connect.tryfinch.com/authorize');
|
|
87
|
+
url.search = this.stringifyQuery({
|
|
88
|
+
client_id: this.clientId,
|
|
89
|
+
products: products,
|
|
90
|
+
redirect_uri: redirectUri,
|
|
91
|
+
sandbox: sandbox,
|
|
92
|
+
});
|
|
93
|
+
return url.toString();
|
|
87
94
|
}
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
client_id: this.clientId,
|
|
91
|
-
products: products,
|
|
92
|
-
redirect_uri: redirectUri,
|
|
93
|
-
sandbox: sandbox,
|
|
94
|
-
});
|
|
95
|
-
return url.toString();
|
|
96
|
-
}
|
|
97
|
-
defaultQuery() {
|
|
98
|
-
return this._options.defaultQuery;
|
|
99
|
-
}
|
|
100
|
-
defaultHeaders(opts) {
|
|
101
|
-
return {
|
|
102
|
-
...super.defaultHeaders(opts),
|
|
103
|
-
'Finch-API-Version': '2020-09-17',
|
|
104
|
-
...this._options.defaultHeaders,
|
|
105
|
-
};
|
|
106
|
-
}
|
|
107
|
-
validateHeaders(headers, customHeaders) {
|
|
108
|
-
if (this.accessToken && headers['Authorization']) {
|
|
109
|
-
return;
|
|
95
|
+
defaultQuery() {
|
|
96
|
+
return this._options.defaultQuery;
|
|
110
97
|
}
|
|
111
|
-
|
|
112
|
-
|
|
98
|
+
defaultHeaders(opts) {
|
|
99
|
+
return {
|
|
100
|
+
...super.defaultHeaders(opts),
|
|
101
|
+
'Finch-API-Version': '2020-09-17',
|
|
102
|
+
...this._options.defaultHeaders,
|
|
103
|
+
};
|
|
113
104
|
}
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
105
|
+
validateHeaders(headers, customHeaders) {
|
|
106
|
+
if (this.accessToken && headers['Authorization']) {
|
|
107
|
+
return;
|
|
108
|
+
}
|
|
109
|
+
if (customHeaders['Authorization'] === null) {
|
|
110
|
+
return;
|
|
111
|
+
}
|
|
112
|
+
throw new Error('Could not resolve authentication method. Expected the accessToken to be set. Or for the "Authorization" headers to be explicitly omitted');
|
|
113
|
+
}
|
|
114
|
+
authHeaders(opts) {
|
|
115
|
+
if (this.accessToken == null) {
|
|
116
|
+
return {};
|
|
117
|
+
}
|
|
118
|
+
return { Authorization: `Bearer ${this.accessToken}` };
|
|
121
119
|
}
|
|
122
|
-
return { Authorization: `Bearer ${this.accessToken}` };
|
|
123
|
-
}
|
|
124
120
|
}
|
|
125
121
|
_a = Finch;
|
|
126
122
|
Finch.Finch = _a;
|
|
@@ -136,38 +132,21 @@ Finch.AuthenticationError = Errors.AuthenticationError;
|
|
|
136
132
|
Finch.InternalServerError = Errors.InternalServerError;
|
|
137
133
|
Finch.PermissionDeniedError = Errors.PermissionDeniedError;
|
|
138
134
|
Finch.UnprocessableEntityError = Errors.UnprocessableEntityError;
|
|
139
|
-
export const {
|
|
140
|
-
APIError,
|
|
141
|
-
APIConnectionError,
|
|
142
|
-
APIConnectionTimeoutError,
|
|
143
|
-
APIUserAbortError,
|
|
144
|
-
NotFoundError,
|
|
145
|
-
ConflictError,
|
|
146
|
-
RateLimitError,
|
|
147
|
-
BadRequestError,
|
|
148
|
-
AuthenticationError,
|
|
149
|
-
InternalServerError,
|
|
150
|
-
PermissionDeniedError,
|
|
151
|
-
UnprocessableEntityError,
|
|
152
|
-
} = Errors;
|
|
135
|
+
export const { APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } = Errors;
|
|
153
136
|
export var toFile = Uploads.toFile;
|
|
154
137
|
export var fileFromPath = Uploads.fileFromPath;
|
|
155
138
|
(function (Finch) {
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
Finch.ATS = API.ATS;
|
|
168
|
-
Finch.Providers = API.Providers;
|
|
169
|
-
Finch.ProvidersSinglePage = API.ProvidersSinglePage;
|
|
170
|
-
Finch.Account = API.Account;
|
|
139
|
+
// Helper functions
|
|
140
|
+
Finch.toFile = Uploads.toFile;
|
|
141
|
+
Finch.fileFromPath = Uploads.fileFromPath;
|
|
142
|
+
Finch.SinglePage = Pagination.SinglePage;
|
|
143
|
+
Finch.ResponsesPage = Pagination.ResponsesPage;
|
|
144
|
+
Finch.IndividualsPage = Pagination.IndividualsPage;
|
|
145
|
+
Finch.HRIS = API.HRIS;
|
|
146
|
+
Finch.Providers = API.Providers;
|
|
147
|
+
Finch.ProvidersSinglePage = API.ProvidersSinglePage;
|
|
148
|
+
Finch.Account = API.Account;
|
|
149
|
+
Finch.Webhooks = API.Webhooks;
|
|
171
150
|
})(Finch || (Finch = {}));
|
|
172
151
|
export default Finch;
|
|
173
|
-
//# sourceMappingURL=index.mjs.map
|
|
152
|
+
//# sourceMappingURL=index.mjs.map
|
package/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;;OAE9C,KAAK,IAAI;OACT,KAAK,UAAU;OACf,KAAK,GAAG;OACR,KAAK,MAAM;OAEX,KAAK,OAAO;
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;;OAE9C,KAAK,IAAI;OACT,KAAK,UAAU;OACf,KAAK,GAAG;OACR,KAAK,MAAM;OAEX,KAAK,OAAO;AAqEnB,qDAAqD;AACrD,MAAM,OAAO,KAAM,SAAQ,IAAI,CAAC,SAAS;IAQvC;;;;;;;;;;;;;;OAcG;IACH,YAAY,EAMS;;YANT,EACV,WAAW,GAAG,IAAI,EAClB,QAAQ,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,mCAAI,IAAI,EAClD,YAAY,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,mCAAI,IAAI,EAC1D,aAAa,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,mCAAI,IAAI,EAC5D,GAAG,IAAI,qBACU,EAAE;QACnB,MAAM,OAAO,GAAkB;YAC7B,WAAW;YACX,QAAQ;YACR,YAAY;YACZ,aAAa;YACb,GAAG,IAAI;YACP,OAAO,EAAE,MAAA,IAAI,CAAC,OAAO,mCAAI,0BAA0B;SACpD,CAAC;QAEF,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,MAAA,OAAO,CAAC,OAAO,mCAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QASL,SAAI,GAAa,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,cAAS,GAAkB,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnD,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAX9C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAOD;;;;OAIG;IACH,cAAc,CAAC,IAAY,EAAE,EAAE,WAAW,EAA2B;QACnE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;SACpF;QACD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QACD,OAAO,IAAI,CAAC,IAAI,CAAgD,aAAa,EAAE;YAC7E,IAAI,EAAE;gBACJ,SAAS,EAAE,IAAI,CAAC,QAAQ;gBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;gBAChC,IAAI,EAAE,IAAI;gBACV,YAAY,EAAE,WAAW;aAC1B;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,IAAI;aACpB;SACF,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,WAAW,EACX,OAAO,GAKR;QACC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAChF;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,wCAAwC,CAAC,CAAC;QAC5E,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;YAC/B,SAAS,EAAE,IAAI,CAAC,QAAQ;YACxB,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,WAAW;YACzB,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAEkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,mBAAmB,EAAE,YAAY;YACjC,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,eAAe,CAAC,OAAqB,EAAE,aAA2B;QACnF,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC,EAAE;YAChD,OAAO;SACR;QACD,IAAI,aAAa,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE;YAC3C,OAAO;SACR;QAED,MAAM,IAAI,KAAK,CACb,0IAA0I,CAC3I,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,EAAE;YAC5B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;IACzD,CAAC;;;AAEM,WAAK,GAAG,EAAI,CAAC;AAEb,cAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,wBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,+BAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,uBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,mBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,mBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,oBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,qBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,yBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,yBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,2BAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,8BAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAGpE,MAAM,CAAC,MAAM,EACX,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,GAAG,MAAM,CAAC;AAEX,MAAM,KAAQ,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACtC,MAAM,KAAQ,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAElD,WAAiB,KAAK;IACpB,mBAAmB;IACL,YAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACxB,kBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAIpC,gBAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IAGnC,mBAAa,GAAG,UAAU,CAAC,aAAa,CAAC;IAGzC,qBAAe,GAAG,UAAU,CAAC,eAAe,CAAC;IAI7C,UAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAMhB,eAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAE1B,yBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAE9C,aAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAItB,cAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;AACxC,CAAC,EAhCgB,KAAK,KAAL,KAAK,QAgCrB;AAED,eAAe,KAAK,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tryfinch/finch-api",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.2.0",
|
|
4
4
|
"description": "Client library for the Finch API",
|
|
5
5
|
"author": "Finch <founders@tryfinch.com>",
|
|
6
6
|
"types": "./index.d.ts",
|
|
@@ -9,36 +9,49 @@
|
|
|
9
9
|
"repository": "github:Finch-API/finch-api-node",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"private": false,
|
|
12
|
+
"sideEffects": [
|
|
13
|
+
"./_shims/index.js",
|
|
14
|
+
"./_shims/index.mjs",
|
|
15
|
+
"./shims/node.js",
|
|
16
|
+
"./shims/node.mjs",
|
|
17
|
+
"./shims/web.js",
|
|
18
|
+
"./shims/web.mjs"
|
|
19
|
+
],
|
|
12
20
|
"exports": {
|
|
13
|
-
"./_shims/*": {
|
|
21
|
+
"./_shims/auto/*": {
|
|
14
22
|
"deno": {
|
|
15
|
-
"types": "./_shims/*.d.ts",
|
|
16
|
-
"require": "./_shims/*.js",
|
|
17
|
-
"default": "./_shims/*.mjs"
|
|
23
|
+
"types": "./_shims/auto/*.d.ts",
|
|
24
|
+
"require": "./_shims/auto/*.js",
|
|
25
|
+
"default": "./_shims/auto/*.mjs"
|
|
26
|
+
},
|
|
27
|
+
"bun": {
|
|
28
|
+
"types": "./_shims/auto/*.d.ts",
|
|
29
|
+
"require": "./_shims/auto/*-bun.js",
|
|
30
|
+
"default": "./_shims/auto/*-bun.mjs"
|
|
18
31
|
},
|
|
19
32
|
"browser": {
|
|
20
|
-
"types": "./_shims/*.d.ts",
|
|
21
|
-
"require": "./_shims/*.js",
|
|
22
|
-
"default": "./_shims/*.mjs"
|
|
33
|
+
"types": "./_shims/auto/*.d.ts",
|
|
34
|
+
"require": "./_shims/auto/*.js",
|
|
35
|
+
"default": "./_shims/auto/*.mjs"
|
|
23
36
|
},
|
|
24
37
|
"worker": {
|
|
25
|
-
"types": "./_shims/*.d.ts",
|
|
26
|
-
"require": "./_shims/*.js",
|
|
27
|
-
"default": "./_shims/*.mjs"
|
|
38
|
+
"types": "./_shims/auto/*.d.ts",
|
|
39
|
+
"require": "./_shims/auto/*.js",
|
|
40
|
+
"default": "./_shims/auto/*.mjs"
|
|
28
41
|
},
|
|
29
42
|
"workerd": {
|
|
30
|
-
"types": "./_shims/*.d.ts",
|
|
31
|
-
"require": "./_shims/*.js",
|
|
32
|
-
"default": "./_shims/*.mjs"
|
|
43
|
+
"types": "./_shims/auto/*.d.ts",
|
|
44
|
+
"require": "./_shims/auto/*.js",
|
|
45
|
+
"default": "./_shims/auto/*.mjs"
|
|
33
46
|
},
|
|
34
47
|
"node": {
|
|
35
|
-
"types": "./_shims
|
|
36
|
-
"require": "./_shims
|
|
37
|
-
"default": "./_shims
|
|
48
|
+
"types": "./_shims/auto/*-node.d.ts",
|
|
49
|
+
"require": "./_shims/auto/*-node.js",
|
|
50
|
+
"default": "./_shims/auto/*-node.mjs"
|
|
38
51
|
},
|
|
39
|
-
"types": "./_shims/*.d.ts",
|
|
40
|
-
"require": "./_shims/*.js",
|
|
41
|
-
"default": "./_shims/*.mjs"
|
|
52
|
+
"types": "./_shims/auto/*.d.ts",
|
|
53
|
+
"require": "./_shims/auto/*.js",
|
|
54
|
+
"default": "./_shims/auto/*.mjs"
|
|
42
55
|
},
|
|
43
56
|
".": {
|
|
44
57
|
"require": {
|
package/pagination.d.ts
CHANGED
|
@@ -1,177 +1,57 @@
|
|
|
1
|
-
import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from
|
|
2
|
-
import * as HRIS from
|
|
3
|
-
import * as ATS from './resources/ats/index.js';
|
|
1
|
+
import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from "./core.js";
|
|
2
|
+
import * as HRIS from "./resources/hris/index.js";
|
|
4
3
|
export type SinglePageResponse<Item> = Item[];
|
|
5
4
|
export declare class SinglePage<Item> extends AbstractPage<Item> {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
* This page represents a response that isn't actually paginated at the API level
|
|
16
|
-
* so there will never be any next page params.
|
|
17
|
-
*/
|
|
18
|
-
nextPageParams(): null;
|
|
19
|
-
nextPageInfo(): null;
|
|
5
|
+
items: Array<Item>;
|
|
6
|
+
constructor(client: APIClient, response: Response, body: SinglePageResponse<Item>, options: FinalRequestOptions);
|
|
7
|
+
getPaginatedItems(): Item[];
|
|
8
|
+
/**
|
|
9
|
+
* This page represents a response that isn't actually paginated at the API level
|
|
10
|
+
* so there will never be any next page params.
|
|
11
|
+
*/
|
|
12
|
+
nextPageParams(): null;
|
|
13
|
+
nextPageInfo(): null;
|
|
20
14
|
}
|
|
21
15
|
export interface ResponsesPageResponse<Item> {
|
|
22
|
-
|
|
16
|
+
responses: Array<Item>;
|
|
23
17
|
}
|
|
24
18
|
export declare class ResponsesPage<Item> extends AbstractPage<Item> implements ResponsesPageResponse<Item> {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
* This page represents a response that isn't actually paginated at the API level
|
|
35
|
-
* so there will never be any next page params.
|
|
36
|
-
*/
|
|
37
|
-
nextPageParams(): null;
|
|
38
|
-
nextPageInfo(): null;
|
|
19
|
+
responses: Array<Item>;
|
|
20
|
+
constructor(client: APIClient, response: Response, body: ResponsesPageResponse<Item>, options: FinalRequestOptions);
|
|
21
|
+
getPaginatedItems(): Item[];
|
|
22
|
+
/**
|
|
23
|
+
* This page represents a response that isn't actually paginated at the API level
|
|
24
|
+
* so there will never be any next page params.
|
|
25
|
+
*/
|
|
26
|
+
nextPageParams(): null;
|
|
27
|
+
nextPageInfo(): null;
|
|
39
28
|
}
|
|
40
29
|
export interface IndividualsPageResponse {
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
30
|
+
/**
|
|
31
|
+
* The array of employees.
|
|
32
|
+
*/
|
|
33
|
+
individuals: Array<HRIS.IndividualInDirectory>;
|
|
34
|
+
paging: HRIS.Paging;
|
|
46
35
|
}
|
|
47
36
|
export interface IndividualsPageParams {
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
}
|
|
57
|
-
export declare class IndividualsPage
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
body: IndividualsPageResponse,
|
|
70
|
-
options: FinalRequestOptions,
|
|
71
|
-
);
|
|
72
|
-
getPaginatedItems(): HRIS.IndividualInDirectory[];
|
|
73
|
-
nextPageParams(): Partial<IndividualsPageParams> | null;
|
|
74
|
-
nextPageInfo(): PageInfo | null;
|
|
75
|
-
}
|
|
76
|
-
export interface CandidatesPageResponse {
|
|
77
|
-
candidates: Array<ATS.Candidate>;
|
|
78
|
-
paging: HRIS.Paging;
|
|
79
|
-
}
|
|
80
|
-
export interface CandidatesPageParams {
|
|
81
|
-
/**
|
|
82
|
-
* Number of candidates to return (defaults to all)
|
|
83
|
-
*/
|
|
84
|
-
limit?: number;
|
|
85
|
-
/**
|
|
86
|
-
* Index to start from (defaults to 0)
|
|
87
|
-
*/
|
|
88
|
-
offset?: number;
|
|
89
|
-
}
|
|
90
|
-
export declare class CandidatesPage extends AbstractPage<ATS.Candidate> implements CandidatesPageResponse {
|
|
91
|
-
paging: HRIS.Paging;
|
|
92
|
-
candidates: Array<ATS.Candidate>;
|
|
93
|
-
constructor(
|
|
94
|
-
client: APIClient,
|
|
95
|
-
response: Response,
|
|
96
|
-
body: CandidatesPageResponse,
|
|
97
|
-
options: FinalRequestOptions,
|
|
98
|
-
);
|
|
99
|
-
getPaginatedItems(): ATS.Candidate[];
|
|
100
|
-
nextPageParams(): Partial<CandidatesPageParams> | null;
|
|
101
|
-
nextPageInfo(): PageInfo | null;
|
|
102
|
-
}
|
|
103
|
-
export interface ApplicationsPageResponse {
|
|
104
|
-
applications: Array<ATS.Application>;
|
|
105
|
-
paging: HRIS.Paging;
|
|
106
|
-
}
|
|
107
|
-
export interface ApplicationsPageParams {
|
|
108
|
-
/**
|
|
109
|
-
* Number of applications to return (defaults to all)
|
|
110
|
-
*/
|
|
111
|
-
limit?: number;
|
|
112
|
-
/**
|
|
113
|
-
* Index to start from (defaults to 0)
|
|
114
|
-
*/
|
|
115
|
-
offset?: number;
|
|
116
|
-
}
|
|
117
|
-
export declare class ApplicationsPage
|
|
118
|
-
extends AbstractPage<ATS.Application>
|
|
119
|
-
implements ApplicationsPageResponse
|
|
120
|
-
{
|
|
121
|
-
paging: HRIS.Paging;
|
|
122
|
-
applications: Array<ATS.Application>;
|
|
123
|
-
constructor(
|
|
124
|
-
client: APIClient,
|
|
125
|
-
response: Response,
|
|
126
|
-
body: ApplicationsPageResponse,
|
|
127
|
-
options: FinalRequestOptions,
|
|
128
|
-
);
|
|
129
|
-
getPaginatedItems(): ATS.Application[];
|
|
130
|
-
nextPageParams(): Partial<ApplicationsPageParams> | null;
|
|
131
|
-
nextPageInfo(): PageInfo | null;
|
|
132
|
-
}
|
|
133
|
-
export interface JobsPageResponse {
|
|
134
|
-
jobs: Array<ATS.Job>;
|
|
135
|
-
paging: HRIS.Paging;
|
|
136
|
-
}
|
|
137
|
-
export interface JobsPageParams {
|
|
138
|
-
/**
|
|
139
|
-
* Number of jobs to return (defaults to all)
|
|
140
|
-
*/
|
|
141
|
-
limit?: number;
|
|
142
|
-
/**
|
|
143
|
-
* Index to start from (defaults to 0)
|
|
144
|
-
*/
|
|
145
|
-
offset?: number;
|
|
146
|
-
}
|
|
147
|
-
export declare class JobsPage extends AbstractPage<ATS.Job> implements JobsPageResponse {
|
|
148
|
-
paging: HRIS.Paging;
|
|
149
|
-
jobs: Array<ATS.Job>;
|
|
150
|
-
constructor(client: APIClient, response: Response, body: JobsPageResponse, options: FinalRequestOptions);
|
|
151
|
-
getPaginatedItems(): ATS.Job[];
|
|
152
|
-
nextPageParams(): Partial<JobsPageParams> | null;
|
|
153
|
-
nextPageInfo(): PageInfo | null;
|
|
154
|
-
}
|
|
155
|
-
export interface OffersPageResponse {
|
|
156
|
-
offers: Array<ATS.Offer>;
|
|
157
|
-
paging: HRIS.Paging;
|
|
158
|
-
}
|
|
159
|
-
export interface OffersPageParams {
|
|
160
|
-
/**
|
|
161
|
-
* Number of offers to return (defaults to all)
|
|
162
|
-
*/
|
|
163
|
-
limit?: number;
|
|
164
|
-
/**
|
|
165
|
-
* Index to start from (defaults to 0)
|
|
166
|
-
*/
|
|
167
|
-
offset?: number;
|
|
168
|
-
}
|
|
169
|
-
export declare class OffersPage extends AbstractPage<ATS.Offer> implements OffersPageResponse {
|
|
170
|
-
paging: HRIS.Paging;
|
|
171
|
-
offers: Array<ATS.Offer>;
|
|
172
|
-
constructor(client: APIClient, response: Response, body: OffersPageResponse, options: FinalRequestOptions);
|
|
173
|
-
getPaginatedItems(): ATS.Offer[];
|
|
174
|
-
nextPageParams(): Partial<OffersPageParams> | null;
|
|
175
|
-
nextPageInfo(): PageInfo | null;
|
|
176
|
-
}
|
|
177
|
-
//# sourceMappingURL=pagination.d.ts.map
|
|
37
|
+
/**
|
|
38
|
+
* Number of employees to return (defaults to all)
|
|
39
|
+
*/
|
|
40
|
+
limit?: number;
|
|
41
|
+
/**
|
|
42
|
+
* Index to start from (defaults to 0)
|
|
43
|
+
*/
|
|
44
|
+
offset?: number;
|
|
45
|
+
}
|
|
46
|
+
export declare class IndividualsPage extends AbstractPage<HRIS.IndividualInDirectory> implements IndividualsPageResponse {
|
|
47
|
+
paging: HRIS.Paging;
|
|
48
|
+
/**
|
|
49
|
+
* The array of employees.
|
|
50
|
+
*/
|
|
51
|
+
individuals: Array<HRIS.IndividualInDirectory>;
|
|
52
|
+
constructor(client: APIClient, response: Response, body: IndividualsPageResponse, options: FinalRequestOptions);
|
|
53
|
+
getPaginatedItems(): HRIS.IndividualInDirectory[];
|
|
54
|
+
nextPageParams(): Partial<IndividualsPageParams> | null;
|
|
55
|
+
nextPageInfo(): PageInfo | null;
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=pagination.d.ts.map
|
package/pagination.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAC1F,OAAO,KAAK,IAAI,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAC1F,OAAO,KAAK,IAAI,MAAM,wBAAwB,CAAC;AAE/C,MAAM,MAAM,kBAAkB,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;AAE9C,qBAAa,UAAU,CAAC,IAAI,CAAE,SAAQ,YAAY,CAAC,IAAI,CAAC;IACtD,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAGjB,MAAM,EAAE,SAAS,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,EAC9B,OAAO,EAAE,mBAAmB;IAO9B,iBAAiB,IAAI,IAAI,EAAE;IAK3B;;;OAGG;IACH,cAAc,IAAI,IAAI;IAItB,YAAY,IAAI,IAAI;CAGrB;AAED,MAAM,WAAW,qBAAqB,CAAC,IAAI;IACzC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,qBAAa,aAAa,CAAC,IAAI,CAAE,SAAQ,YAAY,CAAC,IAAI,CAAE,YAAW,qBAAqB,CAAC,IAAI,CAAC;IAChG,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAGrB,MAAM,EAAE,SAAS,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,EACjC,OAAO,EAAE,mBAAmB;IAO9B,iBAAiB,IAAI,IAAI,EAAE;IAK3B;;;OAGG;IACH,cAAc,IAAI,IAAI;IAItB,YAAY,IAAI,IAAI;CAGrB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAE/C,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,eACX,SAAQ,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAC/C,YAAW,uBAAuB;IAElC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;gBAG7C,MAAM,EAAE,SAAS,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,EAAE,mBAAmB;IAQ9B,iBAAiB,IAAI,IAAI,CAAC,qBAAqB,EAAE;IAKjD,cAAc,IAAI,OAAO,CAAC,qBAAqB,CAAC,GAAG,IAAI;IASvD,YAAY,IAAI,QAAQ,GAAG,IAAI;CAgBhC"}
|