botshield-sdk 1.3.1 → 1.4.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 +13 -0
- package/README.md +15 -0
- package/client.d.mts +4 -28
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -28
- package/client.d.ts.map +1 -1
- package/client.js +2 -26
- package/client.js.map +1 -1
- package/client.mjs +2 -26
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +1 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -9
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -4
- package/resources/index.mjs.map +1 -1
- package/resources/sdk.d.mts +123 -46
- package/resources/sdk.d.mts.map +1 -1
- package/resources/sdk.d.ts +123 -46
- package/resources/sdk.d.ts.map +1 -1
- package/resources/sdk.js +33 -8
- package/resources/sdk.js.map +1 -1
- package/resources/sdk.mjs +33 -8
- package/resources/sdk.mjs.map +1 -1
- package/resources/verification.d.mts +13 -33
- package/resources/verification.d.mts.map +1 -1
- package/resources/verification.d.ts +13 -33
- package/resources/verification.d.ts.map +1 -1
- package/resources/verification.js +4 -5
- package/resources/verification.js.map +1 -1
- package/resources/verification.mjs +4 -5
- package/resources/verification.mjs.map +1 -1
- package/src/client.ts +14 -54
- package/src/resources/index.ts +6 -8
- package/src/resources/sdk.ts +181 -48
- package/src/resources/verification.ts +19 -37
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/devices.d.mts +0 -21
- package/resources/devices.d.mts.map +0 -1
- package/resources/devices.d.ts +0 -21
- package/resources/devices.d.ts.map +0 -1
- package/resources/devices.js +0 -18
- package/resources/devices.js.map +0 -1
- package/resources/devices.mjs +0 -14
- package/resources/devices.mjs.map +0 -1
- package/resources/organizations.d.mts +0 -21
- package/resources/organizations.d.mts.map +0 -1
- package/resources/organizations.d.ts +0 -21
- package/resources/organizations.d.ts.map +0 -1
- package/resources/organizations.js +0 -18
- package/resources/organizations.js.map +0 -1
- package/resources/organizations.mjs +0 -14
- package/resources/organizations.mjs.map +0 -1
- package/resources/pass.d.mts +0 -21
- package/resources/pass.d.mts.map +0 -1
- package/resources/pass.d.ts +0 -21
- package/resources/pass.d.ts.map +0 -1
- package/resources/pass.js +0 -18
- package/resources/pass.js.map +0 -1
- package/resources/pass.mjs +0 -14
- package/resources/pass.mjs.map +0 -1
- package/resources/users.d.mts +0 -21
- package/resources/users.d.mts.map +0 -1
- package/resources/users.d.ts +0 -21
- package/resources/users.d.ts.map +0 -1
- package/resources/users.js +0 -18
- package/resources/users.js.map +0 -1
- package/resources/users.mjs +0 -14
- package/resources/users.mjs.map +0 -1
- package/src/resources/devices.ts +0 -27
- package/src/resources/organizations.ts +0 -33
- package/src/resources/pass.ts +0 -27
- package/src/resources/users.ts +0 -33
package/resources/index.mjs
CHANGED
|
@@ -1,8 +1,4 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
export { Devices } from "./devices.mjs";
|
|
3
|
-
export { Organizations, } from "./organizations.mjs";
|
|
4
|
-
export { Pass } from "./pass.mjs";
|
|
5
2
|
export { SDK, } from "./sdk.mjs";
|
|
6
|
-
export { Users } from "./users.mjs";
|
|
7
3
|
export { Verification, } from "./verification.mjs";
|
|
8
4
|
//# sourceMappingURL=index.mjs.map
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,GAAG,GAiBJ;OACM,EACL,YAAY,GAKb"}
|
package/resources/sdk.d.mts
CHANGED
|
@@ -2,29 +2,48 @@ import { APIResource } from "../core/resource.mjs";
|
|
|
2
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
3
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
4
|
/**
|
|
5
|
-
* SDK
|
|
5
|
+
* Core SDK operations — session management, verification, token validation, and Signal Pixel scoring
|
|
6
6
|
*/
|
|
7
7
|
export declare class SDK extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Creates a short-lived anchor grant token (5 minutes) from an API token or site
|
|
10
|
+
* key. Use this to get a token before creating verification links.
|
|
10
11
|
*/
|
|
11
12
|
createSession(body: SDKCreateSessionParams, options?: RequestOptions): APIPromise<SDKCreateSessionResponse>;
|
|
12
13
|
/**
|
|
13
|
-
*
|
|
14
|
+
* Creates a verification request with deep link, web URL, and QR code. Requires an
|
|
15
|
+
* anchor grant token from create-session.
|
|
14
16
|
*/
|
|
15
17
|
createVerificationLink(body: SDKCreateVerificationLinkParams, options?: RequestOptions): APIPromise<SDKCreateVerificationLinkResponse>;
|
|
16
18
|
/**
|
|
17
|
-
*
|
|
19
|
+
* Returns enabled integrations (Turnstile, etc.) for a site key. Public config
|
|
20
|
+
* only — secret keys never exposed.
|
|
21
|
+
*/
|
|
22
|
+
getPartnerConfig(query: SDKGetPartnerConfigParams, options?: RequestOptions): APIPromise<SDKGetPartnerConfigResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Revoke an Anchor Grant Window token
|
|
18
25
|
*/
|
|
19
26
|
logout(body: SDKLogoutParams, options?: RequestOptions): APIPromise<SDKLogoutResponse>;
|
|
20
27
|
/**
|
|
21
|
-
* Soft-expires
|
|
22
|
-
*
|
|
23
|
-
* pending verification is blocking a new request.
|
|
28
|
+
* Soft-expires a pending verification for a scope and user. Use when
|
|
29
|
+
* create-verification-link returns 409.
|
|
24
30
|
*/
|
|
25
31
|
revokeVerification(body: SDKRevokeVerificationParams, options?: RequestOptions): APIPromise<SDKRevokeVerificationResponse>;
|
|
26
32
|
/**
|
|
27
|
-
*
|
|
33
|
+
* Stores a behavioral fingerprint score server-side and returns an opaque
|
|
34
|
+
* signal*token (bs_sig*...). The client-side score can be spoofed — the
|
|
35
|
+
* signal_token maps to the real score in BotShield's database.
|
|
36
|
+
*/
|
|
37
|
+
storeSignal(body: SDKStoreSignalParams, options?: RequestOptions): APIPromise<SDKStoreSignalResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Validates a signal_token and returns the real server-side bot score. One-time
|
|
40
|
+
* use, 10-minute expiry. This is the tamper-proof check.
|
|
41
|
+
*/
|
|
42
|
+
validateSignal(body: SDKValidateSignalParams, options?: RequestOptions): APIPromise<SDKValidateSignalResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Validates a signed JWT verification receipt. This is the primary server-side
|
|
45
|
+
* check. Optionally include signal_token for combined confidence scoring with
|
|
46
|
+
* Signal Pixel + Turnstile + passkey results.
|
|
28
47
|
*/
|
|
29
48
|
verifyToken(body: SDKVerifyTokenParams, options?: RequestOptions): APIPromise<SDKVerifyTokenResponse>;
|
|
30
49
|
}
|
|
@@ -36,22 +55,19 @@ export declare namespace SDKCreateSessionResponse {
|
|
|
36
55
|
anchor_grant_expires_at: string;
|
|
37
56
|
anchor_grant_expires_in_seconds: number;
|
|
38
57
|
/**
|
|
39
|
-
* Canonical grant token (Bearer bss\_\*)
|
|
58
|
+
* Canonical grant token (Bearer bss\_\*)
|
|
40
59
|
*/
|
|
41
60
|
anchor_grant_token: string;
|
|
42
61
|
expires_at: string;
|
|
43
62
|
expires_in_seconds: number;
|
|
44
63
|
organization: Data.Organization;
|
|
45
64
|
/**
|
|
46
|
-
* Legacy alias
|
|
65
|
+
* Legacy alias (backward compatibility)
|
|
47
66
|
*/
|
|
48
67
|
session_token: string;
|
|
49
68
|
}
|
|
50
69
|
namespace Data {
|
|
51
70
|
interface Organization {
|
|
52
|
-
/**
|
|
53
|
-
* Clerk Organization ID (partner)
|
|
54
|
-
*/
|
|
55
71
|
id: string;
|
|
56
72
|
environment: string;
|
|
57
73
|
}
|
|
@@ -64,30 +80,37 @@ export declare namespace SDKCreateVerificationLinkResponse {
|
|
|
64
80
|
interface Data {
|
|
65
81
|
deep_link: string;
|
|
66
82
|
expires_at: string;
|
|
67
|
-
organization: Data.Organization;
|
|
68
83
|
qr_code_url: string;
|
|
69
84
|
request_id: string;
|
|
70
85
|
web_url: string;
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
*/
|
|
74
|
-
auth_mode?: 'email' | 'anonymous';
|
|
75
|
-
/**
|
|
76
|
-
* Explicit action scope. Evaluated at action time.
|
|
77
|
-
*/
|
|
86
|
+
auth_mode?: 'linked-account' | 'private';
|
|
87
|
+
organization?: Data.Organization;
|
|
78
88
|
scope?: string;
|
|
79
89
|
sdk_type?: 'signal' | 'presence';
|
|
80
90
|
}
|
|
81
91
|
namespace Data {
|
|
82
92
|
interface Organization {
|
|
83
|
-
id
|
|
93
|
+
id?: string;
|
|
84
94
|
}
|
|
85
95
|
}
|
|
86
96
|
}
|
|
97
|
+
export interface SDKGetPartnerConfigResponse {
|
|
98
|
+
environment?: 'test' | 'live';
|
|
99
|
+
integrations?: {
|
|
100
|
+
[key: string]: SDKGetPartnerConfigResponse.Integrations;
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
export declare namespace SDKGetPartnerConfigResponse {
|
|
104
|
+
interface Integrations {
|
|
105
|
+
config?: unknown;
|
|
106
|
+
enabled?: boolean;
|
|
107
|
+
site_key?: string;
|
|
108
|
+
}
|
|
109
|
+
}
|
|
87
110
|
export interface SDKLogoutResponse {
|
|
88
|
-
success: boolean;
|
|
89
111
|
message?: string;
|
|
90
112
|
revoked_at?: string;
|
|
113
|
+
success?: boolean;
|
|
91
114
|
token_found?: boolean;
|
|
92
115
|
}
|
|
93
116
|
export interface SDKRevokeVerificationResponse {
|
|
@@ -95,22 +118,42 @@ export interface SDKRevokeVerificationResponse {
|
|
|
95
118
|
}
|
|
96
119
|
export declare namespace SDKRevokeVerificationResponse {
|
|
97
120
|
interface Data {
|
|
98
|
-
/**
|
|
99
|
-
* Number of pending verifications that were revoked
|
|
100
|
-
*/
|
|
101
|
-
revoked_count: number;
|
|
102
|
-
success: boolean;
|
|
103
121
|
message?: string;
|
|
122
|
+
revoked_count?: number;
|
|
123
|
+
success?: boolean;
|
|
104
124
|
}
|
|
105
125
|
}
|
|
126
|
+
export interface SDKStoreSignalResponse {
|
|
127
|
+
expires_at?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Opaque tamper-proof token (bs*sig*...)
|
|
130
|
+
*/
|
|
131
|
+
signal_token?: string;
|
|
132
|
+
}
|
|
133
|
+
export interface SDKValidateSignalResponse {
|
|
134
|
+
client_score?: number;
|
|
135
|
+
country?: string;
|
|
136
|
+
created_at?: string;
|
|
137
|
+
edge_score?: number;
|
|
138
|
+
fp_hash?: string;
|
|
139
|
+
reason?: string;
|
|
140
|
+
score?: number;
|
|
141
|
+
site_key?: string;
|
|
142
|
+
valid?: boolean;
|
|
143
|
+
}
|
|
106
144
|
export interface SDKVerifyTokenResponse {
|
|
107
145
|
claims?: SDKVerifyTokenResponse.Claims;
|
|
146
|
+
/**
|
|
147
|
+
* Combined confidence (passkey + signals + integrations)
|
|
148
|
+
*/
|
|
149
|
+
confidence?: number;
|
|
108
150
|
reason?: string;
|
|
151
|
+
signals?: SDKVerifyTokenResponse.Signals;
|
|
109
152
|
valid?: boolean;
|
|
110
153
|
}
|
|
111
154
|
export declare namespace SDKVerifyTokenResponse {
|
|
112
155
|
interface Claims {
|
|
113
|
-
auth_mode?: '
|
|
156
|
+
auth_mode?: 'linked-account' | 'private';
|
|
114
157
|
botshield_user_id?: string;
|
|
115
158
|
expires_at?: number;
|
|
116
159
|
issued_at?: number;
|
|
@@ -121,60 +164,94 @@ export declare namespace SDKVerifyTokenResponse {
|
|
|
121
164
|
user_email?: string;
|
|
122
165
|
verified?: boolean;
|
|
123
166
|
}
|
|
167
|
+
interface Signals {
|
|
168
|
+
/**
|
|
169
|
+
* Signal Pixel score (0-100)
|
|
170
|
+
*/
|
|
171
|
+
botshield_score?: number;
|
|
172
|
+
passkey?: Signals.Passkey;
|
|
173
|
+
turnstile?: Signals.Turnstile;
|
|
174
|
+
}
|
|
175
|
+
namespace Signals {
|
|
176
|
+
interface Passkey {
|
|
177
|
+
verified?: boolean;
|
|
178
|
+
}
|
|
179
|
+
interface Turnstile {
|
|
180
|
+
success?: boolean;
|
|
181
|
+
}
|
|
182
|
+
}
|
|
124
183
|
}
|
|
125
184
|
export interface SDKCreateSessionParams {
|
|
126
185
|
metadata?: {
|
|
127
186
|
[key: string]: unknown;
|
|
128
187
|
};
|
|
188
|
+
/**
|
|
189
|
+
* Your internal user identifier for correlation
|
|
190
|
+
*/
|
|
129
191
|
partner_user_id?: string;
|
|
130
192
|
}
|
|
131
193
|
export interface SDKCreateVerificationLinkParams {
|
|
132
194
|
/**
|
|
133
|
-
* Returning
|
|
134
|
-
* verification to skip onboarding
|
|
195
|
+
* Returning user ID to skip onboarding
|
|
135
196
|
*/
|
|
136
197
|
botshield_user_id?: string;
|
|
137
198
|
metadata?: {
|
|
138
199
|
[key: string]: unknown;
|
|
139
200
|
};
|
|
140
201
|
/**
|
|
141
|
-
*
|
|
202
|
+
* linked-account = OAuth+passkey, private = direct WebAuthn (no PII)
|
|
142
203
|
*/
|
|
143
|
-
mode?: '
|
|
204
|
+
mode?: 'linked-account' | 'private';
|
|
144
205
|
return_url?: string;
|
|
145
206
|
scope?: string;
|
|
146
207
|
sdk_type?: 'signal' | 'presence';
|
|
208
|
+
/**
|
|
209
|
+
* Tamper-proof Signal Pixel token (bs*sig*...) for server-side score correlation
|
|
210
|
+
*/
|
|
211
|
+
signal_token?: string;
|
|
147
212
|
user_email?: string;
|
|
148
213
|
webhook_url?: string;
|
|
149
214
|
}
|
|
215
|
+
export interface SDKGetPartnerConfigParams {
|
|
216
|
+
site_key: string;
|
|
217
|
+
}
|
|
150
218
|
export interface SDKLogoutParams {
|
|
151
219
|
/**
|
|
152
|
-
*
|
|
220
|
+
* The anchor grant token (bss\_\*) to revoke
|
|
153
221
|
*/
|
|
154
222
|
session_token: string;
|
|
155
223
|
}
|
|
156
224
|
export interface SDKRevokeVerificationParams {
|
|
157
|
-
/**
|
|
158
|
-
* The scope/action name to revoke pending verifications for
|
|
159
|
-
*/
|
|
160
225
|
scope: string;
|
|
161
|
-
/**
|
|
162
|
-
* Partner user ID to match. At least one of user_email or partner_user_id is
|
|
163
|
-
* required.
|
|
164
|
-
*/
|
|
165
226
|
partner_user_id?: string;
|
|
166
|
-
/**
|
|
167
|
-
* User email to match. At least one of user_email or partner_user_id is required.
|
|
168
|
-
*/
|
|
169
227
|
user_email?: string;
|
|
170
228
|
}
|
|
229
|
+
export interface SDKStoreSignalParams {
|
|
230
|
+
score: number;
|
|
231
|
+
site_key: string;
|
|
232
|
+
client_score?: number;
|
|
233
|
+
country?: string;
|
|
234
|
+
edge_score?: number;
|
|
235
|
+
fp_hash?: string;
|
|
236
|
+
ip_hash?: string;
|
|
237
|
+
signals?: unknown;
|
|
238
|
+
ua_hash?: string;
|
|
239
|
+
}
|
|
240
|
+
export interface SDKValidateSignalParams {
|
|
241
|
+
signal_token: string;
|
|
242
|
+
verification_event_id?: string;
|
|
243
|
+
}
|
|
171
244
|
export interface SDKVerifyTokenParams {
|
|
172
245
|
/**
|
|
173
|
-
*
|
|
246
|
+
* JWT verification receipt
|
|
174
247
|
*/
|
|
175
248
|
token: string;
|
|
249
|
+
/**
|
|
250
|
+
* Optional Signal Pixel token for combined confidence
|
|
251
|
+
*/
|
|
252
|
+
signal_token?: string;
|
|
176
253
|
}
|
|
177
254
|
export declare namespace SDK {
|
|
178
|
-
export { type SDKCreateSessionResponse as SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse as SDKCreateVerificationLinkResponse, type SDKLogoutResponse as SDKLogoutResponse, type SDKRevokeVerificationResponse as SDKRevokeVerificationResponse, type SDKVerifyTokenResponse as SDKVerifyTokenResponse, type SDKCreateSessionParams as SDKCreateSessionParams, type SDKCreateVerificationLinkParams as SDKCreateVerificationLinkParams, type SDKLogoutParams as SDKLogoutParams, type SDKRevokeVerificationParams as SDKRevokeVerificationParams, type SDKVerifyTokenParams as SDKVerifyTokenParams, };
|
|
255
|
+
export { type SDKCreateSessionResponse as SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse as SDKCreateVerificationLinkResponse, type SDKGetPartnerConfigResponse as SDKGetPartnerConfigResponse, type SDKLogoutResponse as SDKLogoutResponse, type SDKRevokeVerificationResponse as SDKRevokeVerificationResponse, type SDKStoreSignalResponse as SDKStoreSignalResponse, type SDKValidateSignalResponse as SDKValidateSignalResponse, type SDKVerifyTokenResponse as SDKVerifyTokenResponse, type SDKCreateSessionParams as SDKCreateSessionParams, type SDKCreateVerificationLinkParams as SDKCreateVerificationLinkParams, type SDKGetPartnerConfigParams as SDKGetPartnerConfigParams, type SDKLogoutParams as SDKLogoutParams, type SDKRevokeVerificationParams as SDKRevokeVerificationParams, type SDKStoreSignalParams as SDKStoreSignalParams, type SDKValidateSignalParams as SDKValidateSignalParams, type SDKVerifyTokenParams as SDKVerifyTokenParams, };
|
|
179
256
|
}
|
|
180
257
|
//# sourceMappingURL=sdk.d.mts.map
|
package/resources/sdk.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.d.mts","sourceRoot":"","sources":["../src/resources/sdk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC
|
|
1
|
+
{"version":3,"file":"sdk.d.mts","sourceRoot":"","sources":["../src/resources/sdk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;OAGG;IACH,aAAa,CACX,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;OAGG;IACH,sBAAsB,CACpB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;OAGG;IACH,gBAAgB,CACd,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAItF;;;OAGG;IACH,kBAAkB,CAChB,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIrG;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtG;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,uBAAuB,EAAE,MAAM,CAAC;QAEhC,+BAA+B,EAAE,MAAM,CAAC;QAExC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B,UAAU,EAAE,MAAM,CAAC;QAEnB,kBAAkB,EAAE,MAAM,CAAC;QAE3B,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;QAEhC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B,EAAE,EAAE,MAAM,CAAC;YAEX,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,OAAO,EAAE,MAAM,CAAC;QAEhB,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEzC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;QAEjC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;KAClC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,2BAA2B,CAAC,YAAY,CAAA;KAAE,CAAC;CAC5E;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,YAAY;QAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAEzC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEzC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;QAE1B,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC;KAC/B;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,OAAO;YACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;SACpB;QAED,UAAiB,SAAS;YACxB,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAEjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IAErB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
package/resources/sdk.d.ts
CHANGED
|
@@ -2,29 +2,48 @@ import { APIResource } from "../core/resource.js";
|
|
|
2
2
|
import { APIPromise } from "../core/api-promise.js";
|
|
3
3
|
import { RequestOptions } from "../internal/request-options.js";
|
|
4
4
|
/**
|
|
5
|
-
* SDK
|
|
5
|
+
* Core SDK operations — session management, verification, token validation, and Signal Pixel scoring
|
|
6
6
|
*/
|
|
7
7
|
export declare class SDK extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Creates a short-lived anchor grant token (5 minutes) from an API token or site
|
|
10
|
+
* key. Use this to get a token before creating verification links.
|
|
10
11
|
*/
|
|
11
12
|
createSession(body: SDKCreateSessionParams, options?: RequestOptions): APIPromise<SDKCreateSessionResponse>;
|
|
12
13
|
/**
|
|
13
|
-
*
|
|
14
|
+
* Creates a verification request with deep link, web URL, and QR code. Requires an
|
|
15
|
+
* anchor grant token from create-session.
|
|
14
16
|
*/
|
|
15
17
|
createVerificationLink(body: SDKCreateVerificationLinkParams, options?: RequestOptions): APIPromise<SDKCreateVerificationLinkResponse>;
|
|
16
18
|
/**
|
|
17
|
-
*
|
|
19
|
+
* Returns enabled integrations (Turnstile, etc.) for a site key. Public config
|
|
20
|
+
* only — secret keys never exposed.
|
|
21
|
+
*/
|
|
22
|
+
getPartnerConfig(query: SDKGetPartnerConfigParams, options?: RequestOptions): APIPromise<SDKGetPartnerConfigResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Revoke an Anchor Grant Window token
|
|
18
25
|
*/
|
|
19
26
|
logout(body: SDKLogoutParams, options?: RequestOptions): APIPromise<SDKLogoutResponse>;
|
|
20
27
|
/**
|
|
21
|
-
* Soft-expires
|
|
22
|
-
*
|
|
23
|
-
* pending verification is blocking a new request.
|
|
28
|
+
* Soft-expires a pending verification for a scope and user. Use when
|
|
29
|
+
* create-verification-link returns 409.
|
|
24
30
|
*/
|
|
25
31
|
revokeVerification(body: SDKRevokeVerificationParams, options?: RequestOptions): APIPromise<SDKRevokeVerificationResponse>;
|
|
26
32
|
/**
|
|
27
|
-
*
|
|
33
|
+
* Stores a behavioral fingerprint score server-side and returns an opaque
|
|
34
|
+
* signal*token (bs_sig*...). The client-side score can be spoofed — the
|
|
35
|
+
* signal_token maps to the real score in BotShield's database.
|
|
36
|
+
*/
|
|
37
|
+
storeSignal(body: SDKStoreSignalParams, options?: RequestOptions): APIPromise<SDKStoreSignalResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Validates a signal_token and returns the real server-side bot score. One-time
|
|
40
|
+
* use, 10-minute expiry. This is the tamper-proof check.
|
|
41
|
+
*/
|
|
42
|
+
validateSignal(body: SDKValidateSignalParams, options?: RequestOptions): APIPromise<SDKValidateSignalResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Validates a signed JWT verification receipt. This is the primary server-side
|
|
45
|
+
* check. Optionally include signal_token for combined confidence scoring with
|
|
46
|
+
* Signal Pixel + Turnstile + passkey results.
|
|
28
47
|
*/
|
|
29
48
|
verifyToken(body: SDKVerifyTokenParams, options?: RequestOptions): APIPromise<SDKVerifyTokenResponse>;
|
|
30
49
|
}
|
|
@@ -36,22 +55,19 @@ export declare namespace SDKCreateSessionResponse {
|
|
|
36
55
|
anchor_grant_expires_at: string;
|
|
37
56
|
anchor_grant_expires_in_seconds: number;
|
|
38
57
|
/**
|
|
39
|
-
* Canonical grant token (Bearer bss\_\*)
|
|
58
|
+
* Canonical grant token (Bearer bss\_\*)
|
|
40
59
|
*/
|
|
41
60
|
anchor_grant_token: string;
|
|
42
61
|
expires_at: string;
|
|
43
62
|
expires_in_seconds: number;
|
|
44
63
|
organization: Data.Organization;
|
|
45
64
|
/**
|
|
46
|
-
* Legacy alias
|
|
65
|
+
* Legacy alias (backward compatibility)
|
|
47
66
|
*/
|
|
48
67
|
session_token: string;
|
|
49
68
|
}
|
|
50
69
|
namespace Data {
|
|
51
70
|
interface Organization {
|
|
52
|
-
/**
|
|
53
|
-
* Clerk Organization ID (partner)
|
|
54
|
-
*/
|
|
55
71
|
id: string;
|
|
56
72
|
environment: string;
|
|
57
73
|
}
|
|
@@ -64,30 +80,37 @@ export declare namespace SDKCreateVerificationLinkResponse {
|
|
|
64
80
|
interface Data {
|
|
65
81
|
deep_link: string;
|
|
66
82
|
expires_at: string;
|
|
67
|
-
organization: Data.Organization;
|
|
68
83
|
qr_code_url: string;
|
|
69
84
|
request_id: string;
|
|
70
85
|
web_url: string;
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
*/
|
|
74
|
-
auth_mode?: 'email' | 'anonymous';
|
|
75
|
-
/**
|
|
76
|
-
* Explicit action scope. Evaluated at action time.
|
|
77
|
-
*/
|
|
86
|
+
auth_mode?: 'linked-account' | 'private';
|
|
87
|
+
organization?: Data.Organization;
|
|
78
88
|
scope?: string;
|
|
79
89
|
sdk_type?: 'signal' | 'presence';
|
|
80
90
|
}
|
|
81
91
|
namespace Data {
|
|
82
92
|
interface Organization {
|
|
83
|
-
id
|
|
93
|
+
id?: string;
|
|
84
94
|
}
|
|
85
95
|
}
|
|
86
96
|
}
|
|
97
|
+
export interface SDKGetPartnerConfigResponse {
|
|
98
|
+
environment?: 'test' | 'live';
|
|
99
|
+
integrations?: {
|
|
100
|
+
[key: string]: SDKGetPartnerConfigResponse.Integrations;
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
export declare namespace SDKGetPartnerConfigResponse {
|
|
104
|
+
interface Integrations {
|
|
105
|
+
config?: unknown;
|
|
106
|
+
enabled?: boolean;
|
|
107
|
+
site_key?: string;
|
|
108
|
+
}
|
|
109
|
+
}
|
|
87
110
|
export interface SDKLogoutResponse {
|
|
88
|
-
success: boolean;
|
|
89
111
|
message?: string;
|
|
90
112
|
revoked_at?: string;
|
|
113
|
+
success?: boolean;
|
|
91
114
|
token_found?: boolean;
|
|
92
115
|
}
|
|
93
116
|
export interface SDKRevokeVerificationResponse {
|
|
@@ -95,22 +118,42 @@ export interface SDKRevokeVerificationResponse {
|
|
|
95
118
|
}
|
|
96
119
|
export declare namespace SDKRevokeVerificationResponse {
|
|
97
120
|
interface Data {
|
|
98
|
-
/**
|
|
99
|
-
* Number of pending verifications that were revoked
|
|
100
|
-
*/
|
|
101
|
-
revoked_count: number;
|
|
102
|
-
success: boolean;
|
|
103
121
|
message?: string;
|
|
122
|
+
revoked_count?: number;
|
|
123
|
+
success?: boolean;
|
|
104
124
|
}
|
|
105
125
|
}
|
|
126
|
+
export interface SDKStoreSignalResponse {
|
|
127
|
+
expires_at?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Opaque tamper-proof token (bs*sig*...)
|
|
130
|
+
*/
|
|
131
|
+
signal_token?: string;
|
|
132
|
+
}
|
|
133
|
+
export interface SDKValidateSignalResponse {
|
|
134
|
+
client_score?: number;
|
|
135
|
+
country?: string;
|
|
136
|
+
created_at?: string;
|
|
137
|
+
edge_score?: number;
|
|
138
|
+
fp_hash?: string;
|
|
139
|
+
reason?: string;
|
|
140
|
+
score?: number;
|
|
141
|
+
site_key?: string;
|
|
142
|
+
valid?: boolean;
|
|
143
|
+
}
|
|
106
144
|
export interface SDKVerifyTokenResponse {
|
|
107
145
|
claims?: SDKVerifyTokenResponse.Claims;
|
|
146
|
+
/**
|
|
147
|
+
* Combined confidence (passkey + signals + integrations)
|
|
148
|
+
*/
|
|
149
|
+
confidence?: number;
|
|
108
150
|
reason?: string;
|
|
151
|
+
signals?: SDKVerifyTokenResponse.Signals;
|
|
109
152
|
valid?: boolean;
|
|
110
153
|
}
|
|
111
154
|
export declare namespace SDKVerifyTokenResponse {
|
|
112
155
|
interface Claims {
|
|
113
|
-
auth_mode?: '
|
|
156
|
+
auth_mode?: 'linked-account' | 'private';
|
|
114
157
|
botshield_user_id?: string;
|
|
115
158
|
expires_at?: number;
|
|
116
159
|
issued_at?: number;
|
|
@@ -121,60 +164,94 @@ export declare namespace SDKVerifyTokenResponse {
|
|
|
121
164
|
user_email?: string;
|
|
122
165
|
verified?: boolean;
|
|
123
166
|
}
|
|
167
|
+
interface Signals {
|
|
168
|
+
/**
|
|
169
|
+
* Signal Pixel score (0-100)
|
|
170
|
+
*/
|
|
171
|
+
botshield_score?: number;
|
|
172
|
+
passkey?: Signals.Passkey;
|
|
173
|
+
turnstile?: Signals.Turnstile;
|
|
174
|
+
}
|
|
175
|
+
namespace Signals {
|
|
176
|
+
interface Passkey {
|
|
177
|
+
verified?: boolean;
|
|
178
|
+
}
|
|
179
|
+
interface Turnstile {
|
|
180
|
+
success?: boolean;
|
|
181
|
+
}
|
|
182
|
+
}
|
|
124
183
|
}
|
|
125
184
|
export interface SDKCreateSessionParams {
|
|
126
185
|
metadata?: {
|
|
127
186
|
[key: string]: unknown;
|
|
128
187
|
};
|
|
188
|
+
/**
|
|
189
|
+
* Your internal user identifier for correlation
|
|
190
|
+
*/
|
|
129
191
|
partner_user_id?: string;
|
|
130
192
|
}
|
|
131
193
|
export interface SDKCreateVerificationLinkParams {
|
|
132
194
|
/**
|
|
133
|
-
* Returning
|
|
134
|
-
* verification to skip onboarding
|
|
195
|
+
* Returning user ID to skip onboarding
|
|
135
196
|
*/
|
|
136
197
|
botshield_user_id?: string;
|
|
137
198
|
metadata?: {
|
|
138
199
|
[key: string]: unknown;
|
|
139
200
|
};
|
|
140
201
|
/**
|
|
141
|
-
*
|
|
202
|
+
* linked-account = OAuth+passkey, private = direct WebAuthn (no PII)
|
|
142
203
|
*/
|
|
143
|
-
mode?: '
|
|
204
|
+
mode?: 'linked-account' | 'private';
|
|
144
205
|
return_url?: string;
|
|
145
206
|
scope?: string;
|
|
146
207
|
sdk_type?: 'signal' | 'presence';
|
|
208
|
+
/**
|
|
209
|
+
* Tamper-proof Signal Pixel token (bs*sig*...) for server-side score correlation
|
|
210
|
+
*/
|
|
211
|
+
signal_token?: string;
|
|
147
212
|
user_email?: string;
|
|
148
213
|
webhook_url?: string;
|
|
149
214
|
}
|
|
215
|
+
export interface SDKGetPartnerConfigParams {
|
|
216
|
+
site_key: string;
|
|
217
|
+
}
|
|
150
218
|
export interface SDKLogoutParams {
|
|
151
219
|
/**
|
|
152
|
-
*
|
|
220
|
+
* The anchor grant token (bss\_\*) to revoke
|
|
153
221
|
*/
|
|
154
222
|
session_token: string;
|
|
155
223
|
}
|
|
156
224
|
export interface SDKRevokeVerificationParams {
|
|
157
|
-
/**
|
|
158
|
-
* The scope/action name to revoke pending verifications for
|
|
159
|
-
*/
|
|
160
225
|
scope: string;
|
|
161
|
-
/**
|
|
162
|
-
* Partner user ID to match. At least one of user_email or partner_user_id is
|
|
163
|
-
* required.
|
|
164
|
-
*/
|
|
165
226
|
partner_user_id?: string;
|
|
166
|
-
/**
|
|
167
|
-
* User email to match. At least one of user_email or partner_user_id is required.
|
|
168
|
-
*/
|
|
169
227
|
user_email?: string;
|
|
170
228
|
}
|
|
229
|
+
export interface SDKStoreSignalParams {
|
|
230
|
+
score: number;
|
|
231
|
+
site_key: string;
|
|
232
|
+
client_score?: number;
|
|
233
|
+
country?: string;
|
|
234
|
+
edge_score?: number;
|
|
235
|
+
fp_hash?: string;
|
|
236
|
+
ip_hash?: string;
|
|
237
|
+
signals?: unknown;
|
|
238
|
+
ua_hash?: string;
|
|
239
|
+
}
|
|
240
|
+
export interface SDKValidateSignalParams {
|
|
241
|
+
signal_token: string;
|
|
242
|
+
verification_event_id?: string;
|
|
243
|
+
}
|
|
171
244
|
export interface SDKVerifyTokenParams {
|
|
172
245
|
/**
|
|
173
|
-
*
|
|
246
|
+
* JWT verification receipt
|
|
174
247
|
*/
|
|
175
248
|
token: string;
|
|
249
|
+
/**
|
|
250
|
+
* Optional Signal Pixel token for combined confidence
|
|
251
|
+
*/
|
|
252
|
+
signal_token?: string;
|
|
176
253
|
}
|
|
177
254
|
export declare namespace SDK {
|
|
178
|
-
export { type SDKCreateSessionResponse as SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse as SDKCreateVerificationLinkResponse, type SDKLogoutResponse as SDKLogoutResponse, type SDKRevokeVerificationResponse as SDKRevokeVerificationResponse, type SDKVerifyTokenResponse as SDKVerifyTokenResponse, type SDKCreateSessionParams as SDKCreateSessionParams, type SDKCreateVerificationLinkParams as SDKCreateVerificationLinkParams, type SDKLogoutParams as SDKLogoutParams, type SDKRevokeVerificationParams as SDKRevokeVerificationParams, type SDKVerifyTokenParams as SDKVerifyTokenParams, };
|
|
255
|
+
export { type SDKCreateSessionResponse as SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse as SDKCreateVerificationLinkResponse, type SDKGetPartnerConfigResponse as SDKGetPartnerConfigResponse, type SDKLogoutResponse as SDKLogoutResponse, type SDKRevokeVerificationResponse as SDKRevokeVerificationResponse, type SDKStoreSignalResponse as SDKStoreSignalResponse, type SDKValidateSignalResponse as SDKValidateSignalResponse, type SDKVerifyTokenResponse as SDKVerifyTokenResponse, type SDKCreateSessionParams as SDKCreateSessionParams, type SDKCreateVerificationLinkParams as SDKCreateVerificationLinkParams, type SDKGetPartnerConfigParams as SDKGetPartnerConfigParams, type SDKLogoutParams as SDKLogoutParams, type SDKRevokeVerificationParams as SDKRevokeVerificationParams, type SDKStoreSignalParams as SDKStoreSignalParams, type SDKValidateSignalParams as SDKValidateSignalParams, type SDKVerifyTokenParams as SDKVerifyTokenParams, };
|
|
179
256
|
}
|
|
180
257
|
//# sourceMappingURL=sdk.d.ts.map
|
package/resources/sdk.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/resources/sdk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC
|
|
1
|
+
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/resources/sdk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;OAGG;IACH,aAAa,CACX,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;OAGG;IACH,sBAAsB,CACpB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;OAGG;IACH,gBAAgB,CACd,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAItF;;;OAGG;IACH,kBAAkB,CAChB,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIrG;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtG;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,uBAAuB,EAAE,MAAM,CAAC;QAEhC,+BAA+B,EAAE,MAAM,CAAC;QAExC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B,UAAU,EAAE,MAAM,CAAC;QAEnB,kBAAkB,EAAE,MAAM,CAAC;QAE3B,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;QAEhC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B,EAAE,EAAE,MAAM,CAAC;YAEX,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,OAAO,EAAE,MAAM,CAAC;QAEhB,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEzC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;QAEjC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;KAClC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,2BAA2B,CAAC,YAAY,CAAA;KAAE,CAAC;CAC5E;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,YAAY;QAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAEzC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEzC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;QAE1B,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC;KAC/B;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,OAAO;YACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;SACpB;QAED,UAAiB,SAAS;YACxB,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAEjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IAErB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|