@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.
- package/CHANGELOG.md +43 -0
- package/README.md +28 -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/_shims/{ReadableStream.js → auto/types.js} +0 -2
- package/{src/_shims/ReadableStream.js → _shims/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 +170 -223
- package/core.d.ts.map +1 -1
- package/core.js +682 -729
- package/core.js.map +1 -1
- package/core.mjs +676 -680
- package/core.mjs.map +1 -1
- package/error.d.ts +32 -32
- package/error.d.ts.map +1 -1
- package/error.js +95 -106
- package/error.js.map +1 -1
- package/error.mjs +91 -91
- package/error.mjs.map +1 -1
- package/index.d.mts +145 -178
- package/index.d.ts +145 -178
- package/index.d.ts.map +1 -1
- package/index.js +145 -201
- package/index.js.map +1 -1
- package/index.mjs +123 -149
- package/index.mjs.map +1 -1
- package/package.json +31 -23
- 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 +5 -7
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +13 -51
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +5 -6
- 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 +18 -18
- package/resources/webhooks.js +103 -107
- package/resources/webhooks.mjs +98 -102
- 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 +75 -44
- package/src/error.ts +6 -4
- package/src/index.ts +8 -25
- package/src/pagination.ts +2 -261
- package/src/resource.ts +1 -1
- package/src/resources/account.ts +3 -3
- package/src/resources/hris/benefits/benefits.ts +6 -6
- package/src/resources/hris/benefits/index.ts +2 -2
- package/src/resources/hris/benefits/individuals.ts +6 -6
- package/src/resources/hris/company.ts +4 -4
- package/src/resources/hris/directory.ts +5 -5
- package/src/resources/hris/employments.ts +5 -5
- package/src/resources/hris/hris.ts +9 -9
- package/src/resources/hris/index.ts +8 -8
- package/src/resources/hris/individuals.ts +6 -6
- package/src/resources/hris/pay-statements.ts +6 -6
- package/src/resources/hris/payments.ts +5 -5
- package/src/resources/index.ts +4 -6
- package/src/resources/providers.ts +4 -4
- package/src/resources/webhooks.ts +2 -2
- package/src/shims/node.ts +50 -0
- package/src/shims/web.ts +50 -0
- package/src/uploads.ts +12 -16
- 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-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/ReadableStream.d.ts +0 -38
- package/_shims/ReadableStream.mjs +0 -7
- 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/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/fetch-node.d.ts +0 -64
- package/_shims/fetch-node.js +0 -12
- package/_shims/fetch-node.mjs +0 -14
- package/_shims/fetch.d.ts +0 -60
- package/_shims/fetch.js +0 -13
- package/_shims/fetch.mjs +0 -15
- 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/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/form-data-node.d.ts +0 -45
- package/_shims/form-data-node.js +0 -11
- package/_shims/form-data-node.mjs +0 -9
- package/_shims/form-data.d.ts +0 -43
- package/_shims/form-data.js +0 -17
- package/_shims/form-data.mjs +0 -20
- 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/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/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/_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/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-node.d.ts +0 -64
- package/src/_shims/fetch-node.js +0 -12
- package/src/_shims/fetch-node.mjs +0 -14
- package/src/_shims/fetch.d.ts +0 -60
- package/src/_shims/fetch.js +0 -13
- package/src/_shims/fetch.mjs +0 -15
- package/src/_shims/fileFromPath-node.ts +0 -29
- package/src/_shims/fileFromPath.ts +0 -29
- package/src/_shims/form-data-node.d.ts +0 -45
- package/src/_shims/form-data-node.js +0 -11
- package/src/_shims/form-data-node.mjs +0 -9
- package/src/_shims/form-data.d.ts +0 -43
- package/src/_shims/form-data.js +0 -17
- package/src/_shims/form-data.mjs +0 -20
- 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.d.ts
CHANGED
|
@@ -1,188 +1,155 @@
|
|
|
1
|
-
import * as Core from
|
|
2
|
-
import * as Pagination from
|
|
3
|
-
import * as API from
|
|
4
|
-
import * as Errors from
|
|
5
|
-
import type
|
|
6
|
-
import * as Uploads from
|
|
1
|
+
import * as Core from "./core.js";
|
|
2
|
+
import * as Pagination from "./pagination.js";
|
|
3
|
+
import * as API from "./resources/index.js";
|
|
4
|
+
import * as Errors from "./error.js";
|
|
5
|
+
import { type Agent } from "./_shims/index.js";
|
|
6
|
+
import * as Uploads from "./uploads.js";
|
|
7
7
|
export interface ClientOptions {
|
|
8
|
-
|
|
9
|
-
|
|
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
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
8
|
+
/**
|
|
9
|
+
* Set it to null if you want to send unauthenticated requests.
|
|
10
|
+
*/
|
|
11
|
+
accessToken?: string | null;
|
|
12
|
+
/**
|
|
13
|
+
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
14
|
+
*/
|
|
15
|
+
baseURL?: string;
|
|
16
|
+
/**
|
|
17
|
+
* The maximum amount of time (in milliseconds) that the client should wait for a response
|
|
18
|
+
* from the server before timing out a single request.
|
|
19
|
+
*
|
|
20
|
+
* Note that request timeouts are retried by default, so in a worst-case scenario you may wait
|
|
21
|
+
* much longer than this timeout before the promise succeeds or fails.
|
|
22
|
+
*/
|
|
23
|
+
timeout?: number;
|
|
24
|
+
/**
|
|
25
|
+
* An HTTP agent used to manage HTTP(S) connections.
|
|
26
|
+
*
|
|
27
|
+
* If not provided, an agent will be constructed by default in the Node.js environment,
|
|
28
|
+
* otherwise no agent is used.
|
|
29
|
+
*/
|
|
30
|
+
httpAgent?: Agent;
|
|
31
|
+
/**
|
|
32
|
+
* Specify a custom `fetch` function implementation.
|
|
33
|
+
*
|
|
34
|
+
* If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
|
|
35
|
+
* defined globally.
|
|
36
|
+
*/
|
|
37
|
+
fetch?: Core.Fetch | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* The maximum number of times that the client will retry a request in case of a
|
|
40
|
+
* temporary failure, like a network error or a 5XX error from the server.
|
|
41
|
+
*
|
|
42
|
+
* @default 2
|
|
43
|
+
*/
|
|
44
|
+
maxRetries?: number;
|
|
45
|
+
/**
|
|
46
|
+
* Default headers to include with every request to the API.
|
|
47
|
+
*
|
|
48
|
+
* These can be removed in individual requests by explicitly setting the
|
|
49
|
+
* header to `undefined` or `null` in request options.
|
|
50
|
+
*/
|
|
51
|
+
defaultHeaders?: Core.Headers;
|
|
52
|
+
/**
|
|
53
|
+
* Default query parameters to include with every request to the API.
|
|
54
|
+
*
|
|
55
|
+
* These can be removed in individual requests by explicitly setting the
|
|
56
|
+
* param to `undefined` in request options.
|
|
57
|
+
*/
|
|
58
|
+
defaultQuery?: Core.DefaultQuery;
|
|
59
|
+
clientId?: string | null;
|
|
60
|
+
clientSecret?: string | null;
|
|
61
|
+
webhookSecret?: string | null;
|
|
62
62
|
}
|
|
63
63
|
/** API Client for interfacing with the Finch API. */
|
|
64
64
|
export declare class Finch extends Core.APIClient {
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
static APIUserAbortError: typeof Errors.APIUserAbortError;
|
|
127
|
-
static NotFoundError: typeof Errors.NotFoundError;
|
|
128
|
-
static ConflictError: typeof Errors.ConflictError;
|
|
129
|
-
static RateLimitError: typeof Errors.RateLimitError;
|
|
130
|
-
static BadRequestError: typeof Errors.BadRequestError;
|
|
131
|
-
static AuthenticationError: typeof Errors.AuthenticationError;
|
|
132
|
-
static InternalServerError: typeof Errors.InternalServerError;
|
|
133
|
-
static PermissionDeniedError: typeof Errors.PermissionDeniedError;
|
|
134
|
-
static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
|
|
65
|
+
accessToken: string | null;
|
|
66
|
+
clientId?: string | null;
|
|
67
|
+
clientSecret?: string | null;
|
|
68
|
+
webhookSecret?: string | null;
|
|
69
|
+
private _options;
|
|
70
|
+
/**
|
|
71
|
+
* API Client for interfacing with the Finch API.
|
|
72
|
+
*
|
|
73
|
+
* @param {string | null} opts.accessToken - The Access Token to send to the API.
|
|
74
|
+
* @param {string} [opts.baseURL] - Override the default base URL for the API.
|
|
75
|
+
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
76
|
+
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
77
|
+
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
78
|
+
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
79
|
+
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
80
|
+
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
81
|
+
* @param {string | null} [opts.clientId]
|
|
82
|
+
* @param {string | null} [opts.clientSecret]
|
|
83
|
+
* @param {string | null} [opts.webhookSecret]
|
|
84
|
+
*/
|
|
85
|
+
constructor({ accessToken, clientId, clientSecret, webhookSecret, ...opts }?: ClientOptions);
|
|
86
|
+
hris: API.HRIS;
|
|
87
|
+
providers: API.Providers;
|
|
88
|
+
account: API.Account;
|
|
89
|
+
webhooks: API.Webhooks;
|
|
90
|
+
/**
|
|
91
|
+
* Returns an access token for the Finch API given an authorization code. An
|
|
92
|
+
* authorization code can be obtained by visiting the url returned by
|
|
93
|
+
* get_auth_url().
|
|
94
|
+
*/
|
|
95
|
+
getAccessToken(code: string, { redirectUri }: {
|
|
96
|
+
redirectUri: string;
|
|
97
|
+
}): Promise<string>;
|
|
98
|
+
/**
|
|
99
|
+
* Returns the authorization url which can be visited in order to obtain an
|
|
100
|
+
* authorization code from Finch. The autorization code can then be exchanged for
|
|
101
|
+
* an access token for the Finch api by calling get_access_token().
|
|
102
|
+
*/
|
|
103
|
+
getAuthURL({ products, redirectUri, sandbox, }: {
|
|
104
|
+
products: string;
|
|
105
|
+
redirectUri: string;
|
|
106
|
+
sandbox: boolean;
|
|
107
|
+
}): string;
|
|
108
|
+
protected defaultQuery(): Core.DefaultQuery | undefined;
|
|
109
|
+
protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
110
|
+
protected validateHeaders(headers: Core.Headers, customHeaders: Core.Headers): void;
|
|
111
|
+
protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
112
|
+
static Finch: typeof Finch;
|
|
113
|
+
static FinchError: typeof Errors.FinchError;
|
|
114
|
+
static APIError: typeof Errors.APIError;
|
|
115
|
+
static APIConnectionError: typeof Errors.APIConnectionError;
|
|
116
|
+
static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
|
|
117
|
+
static APIUserAbortError: typeof Errors.APIUserAbortError;
|
|
118
|
+
static NotFoundError: typeof Errors.NotFoundError;
|
|
119
|
+
static ConflictError: typeof Errors.ConflictError;
|
|
120
|
+
static RateLimitError: typeof Errors.RateLimitError;
|
|
121
|
+
static BadRequestError: typeof Errors.BadRequestError;
|
|
122
|
+
static AuthenticationError: typeof Errors.AuthenticationError;
|
|
123
|
+
static InternalServerError: typeof Errors.InternalServerError;
|
|
124
|
+
static PermissionDeniedError: typeof Errors.PermissionDeniedError;
|
|
125
|
+
static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
|
|
135
126
|
}
|
|
136
|
-
export declare const APIError: typeof Errors.APIError,
|
|
137
|
-
APIConnectionError: typeof Errors.APIConnectionError,
|
|
138
|
-
APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError,
|
|
139
|
-
APIUserAbortError: typeof Errors.APIUserAbortError,
|
|
140
|
-
NotFoundError: typeof Errors.NotFoundError,
|
|
141
|
-
ConflictError: typeof Errors.ConflictError,
|
|
142
|
-
RateLimitError: typeof Errors.RateLimitError,
|
|
143
|
-
BadRequestError: typeof Errors.BadRequestError,
|
|
144
|
-
AuthenticationError: typeof Errors.AuthenticationError,
|
|
145
|
-
InternalServerError: typeof Errors.InternalServerError,
|
|
146
|
-
PermissionDeniedError: typeof Errors.PermissionDeniedError,
|
|
147
|
-
UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
|
|
127
|
+
export declare const FinchError: typeof Errors.FinchError, APIError: typeof Errors.APIError, APIConnectionError: typeof Errors.APIConnectionError, APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError, APIUserAbortError: typeof Errors.APIUserAbortError, NotFoundError: typeof Errors.NotFoundError, ConflictError: typeof Errors.ConflictError, RateLimitError: typeof Errors.RateLimitError, BadRequestError: typeof Errors.BadRequestError, AuthenticationError: typeof Errors.AuthenticationError, InternalServerError: typeof Errors.InternalServerError, PermissionDeniedError: typeof Errors.PermissionDeniedError, UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
|
|
148
128
|
export import toFile = Uploads.toFile;
|
|
149
129
|
export import fileFromPath = Uploads.fileFromPath;
|
|
150
130
|
export declare namespace Finch {
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
export import HRIS = API.HRIS;
|
|
174
|
-
export import Income = API.Income;
|
|
175
|
-
export import Location = API.Location;
|
|
176
|
-
export import Money = API.Money;
|
|
177
|
-
export import Paging = API.Paging;
|
|
178
|
-
export import ATS = API.ATS;
|
|
179
|
-
export import Providers = API.Providers;
|
|
180
|
-
export import Provider = API.Provider;
|
|
181
|
-
export import ProvidersSinglePage = API.ProvidersSinglePage;
|
|
182
|
-
export import Account = API.Account;
|
|
183
|
-
export import DisconnectResponse = API.DisconnectResponse;
|
|
184
|
-
export import Introspection = API.Introspection;
|
|
185
|
-
export import Webhooks = API.Webhooks;
|
|
131
|
+
export import toFile = Uploads.toFile;
|
|
132
|
+
export import fileFromPath = Uploads.fileFromPath;
|
|
133
|
+
export import RequestOptions = Core.RequestOptions;
|
|
134
|
+
export import SinglePage = Pagination.SinglePage;
|
|
135
|
+
export import SinglePageResponse = Pagination.SinglePageResponse;
|
|
136
|
+
export import ResponsesPage = Pagination.ResponsesPage;
|
|
137
|
+
export import ResponsesPageResponse = Pagination.ResponsesPageResponse;
|
|
138
|
+
export import IndividualsPage = Pagination.IndividualsPage;
|
|
139
|
+
export import IndividualsPageParams = Pagination.IndividualsPageParams;
|
|
140
|
+
export import IndividualsPageResponse = Pagination.IndividualsPageResponse;
|
|
141
|
+
export import HRIS = API.HRIS;
|
|
142
|
+
export import Income = API.Income;
|
|
143
|
+
export import Location = API.Location;
|
|
144
|
+
export import Money = API.Money;
|
|
145
|
+
export import Paging = API.Paging;
|
|
146
|
+
export import Providers = API.Providers;
|
|
147
|
+
export import Provider = API.Provider;
|
|
148
|
+
export import ProvidersSinglePage = API.ProvidersSinglePage;
|
|
149
|
+
export import Account = API.Account;
|
|
150
|
+
export import DisconnectResponse = API.DisconnectResponse;
|
|
151
|
+
export import Introspection = API.Introspection;
|
|
152
|
+
export import Webhooks = API.Webhooks;
|
|
186
153
|
}
|
|
187
154
|
export default Finch;
|
|
188
|
-
//# sourceMappingURL=index.d.ts.map
|
|
155
|
+
//# sourceMappingURL=index.d.ts.map
|
package/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;IAElB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;IAEjC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,qDAAqD;AACrD,qBAAa,KAAM,SAAQ,IAAI,CAAC,SAAS;IACvC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;;;OAcG;gBACS,EACV,WAAkB,EAClB,QAAkD,EAClD,YAA0D,EAC1D,aAA4D,EAC5D,GAAG,IAAI,EACR,GAAE,aAAkB;IAyBrB,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,SAAS,EAAE,GAAG,CAAC,SAAS,CAA2B;IACnD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAEhD;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBvF;;;;OAIG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,WAAW,EACX,OAAO,GACR,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,GAAG,MAAM;cAcS,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAQ5D,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO;cAalE,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAO5E,MAAM,CAAC,KAAK,eAAQ;IAEpB,MAAM,CAAC,UAAU,2BAAqB;IACtC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;CACnE;AAED,eAAO,MACL,UAAU,4BACV,QAAQ,0BACR,kBAAkB,oCAClB,yBAAyB,2CACzB,iBAAiB,mCACjB,aAAa,+BACb,aAAa,+BACb,cAAc,gCACd,eAAe,iCACf,mBAAmB,qCACnB,mBAAmB,qCACnB,qBAAqB,uCACrB,wBAAwB,wCAChB,CAAC;AAEX,MAAM,QAAQ,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACtC,MAAM,QAAQ,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAElD,yBAAiB,KAAK,CAAC;IAErB,MAAM,QAAQ,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACtC,MAAM,QAAQ,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAElD,MAAM,QAAQ,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEnD,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,MAAM,QAAQ,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAEjE,MAAM,QAAQ,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;IACvD,MAAM,QAAQ,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAEvE,MAAM,QAAQ,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC;IAC3D,MAAM,QAAQ,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;IACvE,MAAM,QAAQ,uBAAuB,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAE3E,MAAM,QAAQ,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC9B,MAAM,QAAQ,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAClC,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAElC,MAAM,QAAQ,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACxC,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAE5D,MAAM,QAAQ,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IACpC,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAEhD,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;CACvC;AAED,eAAe,KAAK,CAAC"}
|