@checkbox-site/node 0.0.0-stage → 0.1.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/LICENSE +21 -0
- package/README.md +112 -2
- package/dist/client.d.ts +1850 -0
- package/dist/client.js +337 -0
- package/dist/errors.d.ts +89 -0
- package/dist/errors.js +125 -0
- package/dist/generated/operations.d.ts +3341 -0
- package/dist/generated/operations.js +2990 -0
- package/dist/generated/types.d.ts +4436 -0
- package/dist/generated/types.js +57 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +15 -0
- package/dist/resource.d.ts +59 -0
- package/dist/resource.js +63 -0
- package/dist/version.d.ts +2 -0
- package/dist/version.js +2 -0
- package/dist/webhooks.d.ts +40 -0
- package/dist/webhooks.js +129 -0
- package/package.json +57 -4
|
@@ -0,0 +1,3341 @@
|
|
|
1
|
+
import type * as T from './types.ts';
|
|
2
|
+
import { Resource, type ApiListPromise, type RequestOptions } from '../resource.ts';
|
|
3
|
+
/** How to call each operation. Keys are the OpenAPI operationIds (also the MCP tool names). */
|
|
4
|
+
export declare const OPERATIONS: {
|
|
5
|
+
readonly createDeviceAuthorization: {
|
|
6
|
+
readonly operationId: "createDeviceAuthorization";
|
|
7
|
+
readonly namespace: "device";
|
|
8
|
+
readonly method: "authorize";
|
|
9
|
+
readonly httpMethod: "POST";
|
|
10
|
+
readonly path: "/v1/device/authorize";
|
|
11
|
+
readonly pathParams: readonly [];
|
|
12
|
+
readonly queryParams: readonly [];
|
|
13
|
+
readonly body: true;
|
|
14
|
+
readonly idempotent: false;
|
|
15
|
+
readonly auth: false;
|
|
16
|
+
readonly scope: "none";
|
|
17
|
+
readonly response: "json";
|
|
18
|
+
readonly list: false;
|
|
19
|
+
readonly paginated: false;
|
|
20
|
+
readonly summary: "Start a device login (setup_checkbox)";
|
|
21
|
+
};
|
|
22
|
+
readonly createDeviceToken: {
|
|
23
|
+
readonly operationId: "createDeviceToken";
|
|
24
|
+
readonly namespace: "device";
|
|
25
|
+
readonly method: "token";
|
|
26
|
+
readonly httpMethod: "POST";
|
|
27
|
+
readonly path: "/v1/device/token";
|
|
28
|
+
readonly pathParams: readonly [];
|
|
29
|
+
readonly queryParams: readonly [];
|
|
30
|
+
readonly body: true;
|
|
31
|
+
readonly idempotent: false;
|
|
32
|
+
readonly auth: false;
|
|
33
|
+
readonly scope: "none";
|
|
34
|
+
readonly response: "json";
|
|
35
|
+
readonly list: false;
|
|
36
|
+
readonly paginated: false;
|
|
37
|
+
readonly summary: "Poll a device login for its keys";
|
|
38
|
+
};
|
|
39
|
+
readonly createSetupSession: {
|
|
40
|
+
readonly operationId: "createSetupSession";
|
|
41
|
+
readonly namespace: "setupSessions";
|
|
42
|
+
readonly method: "create";
|
|
43
|
+
readonly httpMethod: "POST";
|
|
44
|
+
readonly path: "/v1/setup_sessions";
|
|
45
|
+
readonly pathParams: readonly [];
|
|
46
|
+
readonly queryParams: readonly [];
|
|
47
|
+
readonly body: true;
|
|
48
|
+
readonly idempotent: true;
|
|
49
|
+
readonly auth: true;
|
|
50
|
+
readonly scope: "setup_sessions:write";
|
|
51
|
+
readonly response: "json";
|
|
52
|
+
readonly list: false;
|
|
53
|
+
readonly paginated: false;
|
|
54
|
+
readonly summary: "Start a setup session (agents that already have a key)";
|
|
55
|
+
};
|
|
56
|
+
readonly listSetupSessions: {
|
|
57
|
+
readonly operationId: "listSetupSessions";
|
|
58
|
+
readonly namespace: "setupSessions";
|
|
59
|
+
readonly method: "list";
|
|
60
|
+
readonly httpMethod: "GET";
|
|
61
|
+
readonly path: "/v1/setup_sessions";
|
|
62
|
+
readonly pathParams: readonly [];
|
|
63
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before"];
|
|
64
|
+
readonly body: false;
|
|
65
|
+
readonly idempotent: false;
|
|
66
|
+
readonly auth: true;
|
|
67
|
+
readonly scope: "setup_sessions:read";
|
|
68
|
+
readonly response: "json";
|
|
69
|
+
readonly list: true;
|
|
70
|
+
readonly paginated: true;
|
|
71
|
+
readonly summary: "List setup sessions";
|
|
72
|
+
};
|
|
73
|
+
readonly retrieveSetupSession: {
|
|
74
|
+
readonly operationId: "retrieveSetupSession";
|
|
75
|
+
readonly namespace: "setupSessions";
|
|
76
|
+
readonly method: "retrieve";
|
|
77
|
+
readonly httpMethod: "GET";
|
|
78
|
+
readonly path: "/v1/setup_sessions/{setup_session}";
|
|
79
|
+
readonly pathParams: readonly ["setup_session"];
|
|
80
|
+
readonly queryParams: readonly [];
|
|
81
|
+
readonly body: false;
|
|
82
|
+
readonly idempotent: false;
|
|
83
|
+
readonly auth: true;
|
|
84
|
+
readonly scope: "setup_sessions:read";
|
|
85
|
+
readonly response: "json";
|
|
86
|
+
readonly list: false;
|
|
87
|
+
readonly paginated: false;
|
|
88
|
+
readonly summary: "Retrieve a setup session";
|
|
89
|
+
};
|
|
90
|
+
readonly updateSetupSession: {
|
|
91
|
+
readonly operationId: "updateSetupSession";
|
|
92
|
+
readonly namespace: "setupSessions";
|
|
93
|
+
readonly method: "update";
|
|
94
|
+
readonly httpMethod: "POST";
|
|
95
|
+
readonly path: "/v1/setup_sessions/{setup_session}";
|
|
96
|
+
readonly pathParams: readonly ["setup_session"];
|
|
97
|
+
readonly queryParams: readonly [];
|
|
98
|
+
readonly body: true;
|
|
99
|
+
readonly idempotent: true;
|
|
100
|
+
readonly auth: true;
|
|
101
|
+
readonly scope: "setup_sessions:write";
|
|
102
|
+
readonly response: "json";
|
|
103
|
+
readonly list: false;
|
|
104
|
+
readonly paginated: false;
|
|
105
|
+
readonly summary: "Report what the agent learned or changed";
|
|
106
|
+
};
|
|
107
|
+
readonly verifySetupSession: {
|
|
108
|
+
readonly operationId: "verifySetupSession";
|
|
109
|
+
readonly namespace: "setupSessions";
|
|
110
|
+
readonly method: "verify";
|
|
111
|
+
readonly httpMethod: "POST";
|
|
112
|
+
readonly path: "/v1/setup_sessions/{setup_session}/verify";
|
|
113
|
+
readonly pathParams: readonly ["setup_session"];
|
|
114
|
+
readonly queryParams: readonly [];
|
|
115
|
+
readonly body: false;
|
|
116
|
+
readonly idempotent: true;
|
|
117
|
+
readonly auth: true;
|
|
118
|
+
readonly scope: "setup_sessions:write";
|
|
119
|
+
readonly response: "json";
|
|
120
|
+
readonly list: false;
|
|
121
|
+
readonly paginated: false;
|
|
122
|
+
readonly summary: "Re-check the site now";
|
|
123
|
+
};
|
|
124
|
+
readonly completeSetupSession: {
|
|
125
|
+
readonly operationId: "completeSetupSession";
|
|
126
|
+
readonly namespace: "setupSessions";
|
|
127
|
+
readonly method: "complete";
|
|
128
|
+
readonly httpMethod: "POST";
|
|
129
|
+
readonly path: "/v1/setup_sessions/{setup_session}/complete";
|
|
130
|
+
readonly pathParams: readonly ["setup_session"];
|
|
131
|
+
readonly queryParams: readonly [];
|
|
132
|
+
readonly body: false;
|
|
133
|
+
readonly idempotent: true;
|
|
134
|
+
readonly auth: true;
|
|
135
|
+
readonly scope: "setup_sessions:write";
|
|
136
|
+
readonly response: "json";
|
|
137
|
+
readonly list: false;
|
|
138
|
+
readonly paginated: false;
|
|
139
|
+
readonly summary: "Finish the setup and notify the human";
|
|
140
|
+
};
|
|
141
|
+
readonly retrieveAccount: {
|
|
142
|
+
readonly operationId: "retrieveAccount";
|
|
143
|
+
readonly namespace: "account";
|
|
144
|
+
readonly method: "retrieve";
|
|
145
|
+
readonly httpMethod: "GET";
|
|
146
|
+
readonly path: "/v1/account";
|
|
147
|
+
readonly pathParams: readonly [];
|
|
148
|
+
readonly queryParams: readonly [];
|
|
149
|
+
readonly body: false;
|
|
150
|
+
readonly idempotent: false;
|
|
151
|
+
readonly auth: true;
|
|
152
|
+
readonly scope: "account:read";
|
|
153
|
+
readonly response: "json";
|
|
154
|
+
readonly list: false;
|
|
155
|
+
readonly paginated: false;
|
|
156
|
+
readonly summary: "Retrieve the account";
|
|
157
|
+
};
|
|
158
|
+
readonly updateAccount: {
|
|
159
|
+
readonly operationId: "updateAccount";
|
|
160
|
+
readonly namespace: "account";
|
|
161
|
+
readonly method: "update";
|
|
162
|
+
readonly httpMethod: "POST";
|
|
163
|
+
readonly path: "/v1/account";
|
|
164
|
+
readonly pathParams: readonly [];
|
|
165
|
+
readonly queryParams: readonly [];
|
|
166
|
+
readonly body: true;
|
|
167
|
+
readonly idempotent: true;
|
|
168
|
+
readonly auth: true;
|
|
169
|
+
readonly scope: "account:write";
|
|
170
|
+
readonly response: "json";
|
|
171
|
+
readonly list: false;
|
|
172
|
+
readonly paginated: false;
|
|
173
|
+
readonly summary: "Update the account";
|
|
174
|
+
};
|
|
175
|
+
readonly listSites: {
|
|
176
|
+
readonly operationId: "listSites";
|
|
177
|
+
readonly namespace: "sites";
|
|
178
|
+
readonly method: "list";
|
|
179
|
+
readonly httpMethod: "GET";
|
|
180
|
+
readonly path: "/v1/sites";
|
|
181
|
+
readonly pathParams: readonly [];
|
|
182
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "archived"];
|
|
183
|
+
readonly body: false;
|
|
184
|
+
readonly idempotent: false;
|
|
185
|
+
readonly auth: true;
|
|
186
|
+
readonly scope: "sites:read";
|
|
187
|
+
readonly response: "json";
|
|
188
|
+
readonly list: true;
|
|
189
|
+
readonly paginated: true;
|
|
190
|
+
readonly summary: "List sites";
|
|
191
|
+
};
|
|
192
|
+
readonly createSite: {
|
|
193
|
+
readonly operationId: "createSite";
|
|
194
|
+
readonly namespace: "sites";
|
|
195
|
+
readonly method: "create";
|
|
196
|
+
readonly httpMethod: "POST";
|
|
197
|
+
readonly path: "/v1/sites";
|
|
198
|
+
readonly pathParams: readonly [];
|
|
199
|
+
readonly queryParams: readonly [];
|
|
200
|
+
readonly body: true;
|
|
201
|
+
readonly idempotent: true;
|
|
202
|
+
readonly auth: true;
|
|
203
|
+
readonly scope: "sites:write";
|
|
204
|
+
readonly response: "json";
|
|
205
|
+
readonly list: false;
|
|
206
|
+
readonly paginated: false;
|
|
207
|
+
readonly summary: "Create a site";
|
|
208
|
+
};
|
|
209
|
+
readonly retrieveSite: {
|
|
210
|
+
readonly operationId: "retrieveSite";
|
|
211
|
+
readonly namespace: "sites";
|
|
212
|
+
readonly method: "retrieve";
|
|
213
|
+
readonly httpMethod: "GET";
|
|
214
|
+
readonly path: "/v1/sites/{site}";
|
|
215
|
+
readonly pathParams: readonly ["site"];
|
|
216
|
+
readonly queryParams: readonly ["expand[]"];
|
|
217
|
+
readonly body: false;
|
|
218
|
+
readonly idempotent: false;
|
|
219
|
+
readonly auth: true;
|
|
220
|
+
readonly scope: "sites:read";
|
|
221
|
+
readonly response: "json";
|
|
222
|
+
readonly list: false;
|
|
223
|
+
readonly paginated: false;
|
|
224
|
+
readonly summary: "Retrieve a site";
|
|
225
|
+
};
|
|
226
|
+
readonly updateSite: {
|
|
227
|
+
readonly operationId: "updateSite";
|
|
228
|
+
readonly namespace: "sites";
|
|
229
|
+
readonly method: "update";
|
|
230
|
+
readonly httpMethod: "POST";
|
|
231
|
+
readonly path: "/v1/sites/{site}";
|
|
232
|
+
readonly pathParams: readonly ["site"];
|
|
233
|
+
readonly queryParams: readonly [];
|
|
234
|
+
readonly body: true;
|
|
235
|
+
readonly idempotent: true;
|
|
236
|
+
readonly auth: true;
|
|
237
|
+
readonly scope: "sites:write";
|
|
238
|
+
readonly response: "json";
|
|
239
|
+
readonly list: false;
|
|
240
|
+
readonly paginated: false;
|
|
241
|
+
readonly summary: "Update a site";
|
|
242
|
+
};
|
|
243
|
+
readonly deleteSite: {
|
|
244
|
+
readonly operationId: "deleteSite";
|
|
245
|
+
readonly namespace: "sites";
|
|
246
|
+
readonly method: "del";
|
|
247
|
+
readonly httpMethod: "DELETE";
|
|
248
|
+
readonly path: "/v1/sites/{site}";
|
|
249
|
+
readonly pathParams: readonly ["site"];
|
|
250
|
+
readonly queryParams: readonly [];
|
|
251
|
+
readonly body: false;
|
|
252
|
+
readonly idempotent: false;
|
|
253
|
+
readonly auth: true;
|
|
254
|
+
readonly scope: "sites:write";
|
|
255
|
+
readonly response: "json";
|
|
256
|
+
readonly list: false;
|
|
257
|
+
readonly paginated: false;
|
|
258
|
+
readonly summary: "Archive a site";
|
|
259
|
+
};
|
|
260
|
+
readonly restoreSite: {
|
|
261
|
+
readonly operationId: "restoreSite";
|
|
262
|
+
readonly namespace: "sites";
|
|
263
|
+
readonly method: "restore";
|
|
264
|
+
readonly httpMethod: "POST";
|
|
265
|
+
readonly path: "/v1/sites/{site}/restore";
|
|
266
|
+
readonly pathParams: readonly ["site"];
|
|
267
|
+
readonly queryParams: readonly [];
|
|
268
|
+
readonly body: false;
|
|
269
|
+
readonly idempotent: true;
|
|
270
|
+
readonly auth: true;
|
|
271
|
+
readonly scope: "sites:write";
|
|
272
|
+
readonly response: "json";
|
|
273
|
+
readonly list: false;
|
|
274
|
+
readonly paginated: false;
|
|
275
|
+
readonly summary: "Restore an archived site";
|
|
276
|
+
};
|
|
277
|
+
readonly connectBillingPlatform: {
|
|
278
|
+
readonly operationId: "connectBillingPlatform";
|
|
279
|
+
readonly namespace: "sites";
|
|
280
|
+
readonly method: "connectBillingPlatform";
|
|
281
|
+
readonly httpMethod: "POST";
|
|
282
|
+
readonly path: "/v1/sites/{site}/integrations";
|
|
283
|
+
readonly pathParams: readonly ["site"];
|
|
284
|
+
readonly queryParams: readonly [];
|
|
285
|
+
readonly body: true;
|
|
286
|
+
readonly idempotent: true;
|
|
287
|
+
readonly auth: true;
|
|
288
|
+
readonly scope: "sites:write";
|
|
289
|
+
readonly response: "json";
|
|
290
|
+
readonly list: false;
|
|
291
|
+
readonly paginated: false;
|
|
292
|
+
readonly summary: "Connect a billing platform";
|
|
293
|
+
};
|
|
294
|
+
readonly retrieveDomainVerification: {
|
|
295
|
+
readonly operationId: "retrieveDomainVerification";
|
|
296
|
+
readonly namespace: "domainVerifications";
|
|
297
|
+
readonly method: "retrieve";
|
|
298
|
+
readonly httpMethod: "GET";
|
|
299
|
+
readonly path: "/v1/sites/{site}/domain_verification";
|
|
300
|
+
readonly pathParams: readonly ["site"];
|
|
301
|
+
readonly queryParams: readonly [];
|
|
302
|
+
readonly body: false;
|
|
303
|
+
readonly idempotent: false;
|
|
304
|
+
readonly auth: true;
|
|
305
|
+
readonly scope: "sites:read";
|
|
306
|
+
readonly response: "json";
|
|
307
|
+
readonly list: false;
|
|
308
|
+
readonly paginated: false;
|
|
309
|
+
readonly summary: "Retrieve domain verification";
|
|
310
|
+
};
|
|
311
|
+
readonly createDomainVerification: {
|
|
312
|
+
readonly operationId: "createDomainVerification";
|
|
313
|
+
readonly namespace: "domainVerifications";
|
|
314
|
+
readonly method: "create";
|
|
315
|
+
readonly httpMethod: "POST";
|
|
316
|
+
readonly path: "/v1/sites/{site}/domain_verification";
|
|
317
|
+
readonly pathParams: readonly ["site"];
|
|
318
|
+
readonly queryParams: readonly [];
|
|
319
|
+
readonly body: true;
|
|
320
|
+
readonly idempotent: true;
|
|
321
|
+
readonly auth: true;
|
|
322
|
+
readonly scope: "sites:write";
|
|
323
|
+
readonly response: "json";
|
|
324
|
+
readonly list: false;
|
|
325
|
+
readonly paginated: false;
|
|
326
|
+
readonly summary: "Start domain verification";
|
|
327
|
+
};
|
|
328
|
+
readonly checkDomainVerification: {
|
|
329
|
+
readonly operationId: "checkDomainVerification";
|
|
330
|
+
readonly namespace: "domainVerifications";
|
|
331
|
+
readonly method: "check";
|
|
332
|
+
readonly httpMethod: "POST";
|
|
333
|
+
readonly path: "/v1/sites/{site}/domain_verification/check";
|
|
334
|
+
readonly pathParams: readonly ["site"];
|
|
335
|
+
readonly queryParams: readonly [];
|
|
336
|
+
readonly body: false;
|
|
337
|
+
readonly idempotent: true;
|
|
338
|
+
readonly auth: true;
|
|
339
|
+
readonly scope: "sites:write";
|
|
340
|
+
readonly response: "json";
|
|
341
|
+
readonly list: false;
|
|
342
|
+
readonly paginated: false;
|
|
343
|
+
readonly summary: "Check domain verification now";
|
|
344
|
+
};
|
|
345
|
+
readonly createScan: {
|
|
346
|
+
readonly operationId: "createScan";
|
|
347
|
+
readonly namespace: "scans";
|
|
348
|
+
readonly method: "create";
|
|
349
|
+
readonly httpMethod: "POST";
|
|
350
|
+
readonly path: "/v1/sites/{site}/scans";
|
|
351
|
+
readonly pathParams: readonly ["site"];
|
|
352
|
+
readonly queryParams: readonly [];
|
|
353
|
+
readonly body: true;
|
|
354
|
+
readonly idempotent: true;
|
|
355
|
+
readonly auth: true;
|
|
356
|
+
readonly scope: "scans:write";
|
|
357
|
+
readonly response: "json";
|
|
358
|
+
readonly list: false;
|
|
359
|
+
readonly paginated: false;
|
|
360
|
+
readonly summary: "Run a scan";
|
|
361
|
+
};
|
|
362
|
+
readonly listScans: {
|
|
363
|
+
readonly operationId: "listScans";
|
|
364
|
+
readonly namespace: "scans";
|
|
365
|
+
readonly method: "list";
|
|
366
|
+
readonly httpMethod: "GET";
|
|
367
|
+
readonly path: "/v1/scans";
|
|
368
|
+
readonly pathParams: readonly [];
|
|
369
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site"];
|
|
370
|
+
readonly body: false;
|
|
371
|
+
readonly idempotent: false;
|
|
372
|
+
readonly auth: true;
|
|
373
|
+
readonly scope: "scans:read";
|
|
374
|
+
readonly response: "json";
|
|
375
|
+
readonly list: true;
|
|
376
|
+
readonly paginated: true;
|
|
377
|
+
readonly summary: "List scans";
|
|
378
|
+
};
|
|
379
|
+
readonly retrieveScan: {
|
|
380
|
+
readonly operationId: "retrieveScan";
|
|
381
|
+
readonly namespace: "scans";
|
|
382
|
+
readonly method: "retrieve";
|
|
383
|
+
readonly httpMethod: "GET";
|
|
384
|
+
readonly path: "/v1/scans/{scan}";
|
|
385
|
+
readonly pathParams: readonly ["scan"];
|
|
386
|
+
readonly queryParams: readonly [];
|
|
387
|
+
readonly body: false;
|
|
388
|
+
readonly idempotent: false;
|
|
389
|
+
readonly auth: true;
|
|
390
|
+
readonly scope: "scans:read";
|
|
391
|
+
readonly response: "json";
|
|
392
|
+
readonly list: false;
|
|
393
|
+
readonly paginated: false;
|
|
394
|
+
readonly summary: "Retrieve a scan";
|
|
395
|
+
};
|
|
396
|
+
readonly createEvaluation: {
|
|
397
|
+
readonly operationId: "createEvaluation";
|
|
398
|
+
readonly namespace: "evaluations";
|
|
399
|
+
readonly method: "create";
|
|
400
|
+
readonly httpMethod: "POST";
|
|
401
|
+
readonly path: "/v1/sites/{site}/evaluations";
|
|
402
|
+
readonly pathParams: readonly ["site"];
|
|
403
|
+
readonly queryParams: readonly [];
|
|
404
|
+
readonly body: true;
|
|
405
|
+
readonly idempotent: true;
|
|
406
|
+
readonly auth: true;
|
|
407
|
+
readonly scope: "evaluations:write";
|
|
408
|
+
readonly response: "json";
|
|
409
|
+
readonly list: false;
|
|
410
|
+
readonly paginated: false;
|
|
411
|
+
readonly summary: "Re-evaluate a site now";
|
|
412
|
+
};
|
|
413
|
+
readonly listEvaluations: {
|
|
414
|
+
readonly operationId: "listEvaluations";
|
|
415
|
+
readonly namespace: "evaluations";
|
|
416
|
+
readonly method: "list";
|
|
417
|
+
readonly httpMethod: "GET";
|
|
418
|
+
readonly path: "/v1/evaluations";
|
|
419
|
+
readonly pathParams: readonly [];
|
|
420
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site"];
|
|
421
|
+
readonly body: false;
|
|
422
|
+
readonly idempotent: false;
|
|
423
|
+
readonly auth: true;
|
|
424
|
+
readonly scope: "evaluations:read";
|
|
425
|
+
readonly response: "json";
|
|
426
|
+
readonly list: true;
|
|
427
|
+
readonly paginated: true;
|
|
428
|
+
readonly summary: "List evaluations";
|
|
429
|
+
};
|
|
430
|
+
readonly retrieveEvaluation: {
|
|
431
|
+
readonly operationId: "retrieveEvaluation";
|
|
432
|
+
readonly namespace: "evaluations";
|
|
433
|
+
readonly method: "retrieve";
|
|
434
|
+
readonly httpMethod: "GET";
|
|
435
|
+
readonly path: "/v1/evaluations/{evaluation}";
|
|
436
|
+
readonly pathParams: readonly ["evaluation"];
|
|
437
|
+
readonly queryParams: readonly [];
|
|
438
|
+
readonly body: false;
|
|
439
|
+
readonly idempotent: false;
|
|
440
|
+
readonly auth: true;
|
|
441
|
+
readonly scope: "evaluations:read";
|
|
442
|
+
readonly response: "json";
|
|
443
|
+
readonly list: false;
|
|
444
|
+
readonly paginated: false;
|
|
445
|
+
readonly summary: "Retrieve an evaluation";
|
|
446
|
+
};
|
|
447
|
+
readonly retrieveLatestEvaluation: {
|
|
448
|
+
readonly operationId: "retrieveLatestEvaluation";
|
|
449
|
+
readonly namespace: "evaluations";
|
|
450
|
+
readonly method: "retrieveLatest";
|
|
451
|
+
readonly httpMethod: "GET";
|
|
452
|
+
readonly path: "/v1/sites/{site}/evaluation";
|
|
453
|
+
readonly pathParams: readonly ["site"];
|
|
454
|
+
readonly queryParams: readonly [];
|
|
455
|
+
readonly body: false;
|
|
456
|
+
readonly idempotent: false;
|
|
457
|
+
readonly auth: true;
|
|
458
|
+
readonly scope: "evaluations:read";
|
|
459
|
+
readonly response: "json";
|
|
460
|
+
readonly list: false;
|
|
461
|
+
readonly paginated: false;
|
|
462
|
+
readonly summary: "Get the current verdict of a site";
|
|
463
|
+
};
|
|
464
|
+
readonly listFindings: {
|
|
465
|
+
readonly operationId: "listFindings";
|
|
466
|
+
readonly namespace: "findings";
|
|
467
|
+
readonly method: "list";
|
|
468
|
+
readonly httpMethod: "GET";
|
|
469
|
+
readonly path: "/v1/findings";
|
|
470
|
+
readonly pathParams: readonly [];
|
|
471
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "status", "state"];
|
|
472
|
+
readonly body: false;
|
|
473
|
+
readonly idempotent: false;
|
|
474
|
+
readonly auth: true;
|
|
475
|
+
readonly scope: "findings:read";
|
|
476
|
+
readonly response: "json";
|
|
477
|
+
readonly list: true;
|
|
478
|
+
readonly paginated: true;
|
|
479
|
+
readonly summary: "List findings";
|
|
480
|
+
};
|
|
481
|
+
readonly retrieveFinding: {
|
|
482
|
+
readonly operationId: "retrieveFinding";
|
|
483
|
+
readonly namespace: "findings";
|
|
484
|
+
readonly method: "retrieve";
|
|
485
|
+
readonly httpMethod: "GET";
|
|
486
|
+
readonly path: "/v1/findings/{finding}";
|
|
487
|
+
readonly pathParams: readonly ["finding"];
|
|
488
|
+
readonly queryParams: readonly [];
|
|
489
|
+
readonly body: false;
|
|
490
|
+
readonly idempotent: false;
|
|
491
|
+
readonly auth: true;
|
|
492
|
+
readonly scope: "findings:read";
|
|
493
|
+
readonly response: "json";
|
|
494
|
+
readonly list: false;
|
|
495
|
+
readonly paginated: false;
|
|
496
|
+
readonly summary: "Retrieve a finding";
|
|
497
|
+
};
|
|
498
|
+
readonly updateFinding: {
|
|
499
|
+
readonly operationId: "updateFinding";
|
|
500
|
+
readonly namespace: "findings";
|
|
501
|
+
readonly method: "update";
|
|
502
|
+
readonly httpMethod: "POST";
|
|
503
|
+
readonly path: "/v1/findings/{finding}";
|
|
504
|
+
readonly pathParams: readonly ["finding"];
|
|
505
|
+
readonly queryParams: readonly [];
|
|
506
|
+
readonly body: true;
|
|
507
|
+
readonly idempotent: true;
|
|
508
|
+
readonly auth: true;
|
|
509
|
+
readonly scope: "findings:write";
|
|
510
|
+
readonly response: "json";
|
|
511
|
+
readonly list: false;
|
|
512
|
+
readonly paginated: false;
|
|
513
|
+
readonly summary: "Triage a finding";
|
|
514
|
+
};
|
|
515
|
+
readonly retrieveCompliancePlan: {
|
|
516
|
+
readonly operationId: "retrieveCompliancePlan";
|
|
517
|
+
readonly namespace: "plans";
|
|
518
|
+
readonly method: "retrieve";
|
|
519
|
+
readonly httpMethod: "GET";
|
|
520
|
+
readonly path: "/v1/sites/{site}/plan";
|
|
521
|
+
readonly pathParams: readonly ["site"];
|
|
522
|
+
readonly queryParams: readonly [];
|
|
523
|
+
readonly body: false;
|
|
524
|
+
readonly idempotent: false;
|
|
525
|
+
readonly auth: true;
|
|
526
|
+
readonly scope: "compliance_plans:read";
|
|
527
|
+
readonly response: "json";
|
|
528
|
+
readonly list: false;
|
|
529
|
+
readonly paginated: false;
|
|
530
|
+
readonly summary: "Get the compliance plan for a site";
|
|
531
|
+
};
|
|
532
|
+
readonly retrieveTask: {
|
|
533
|
+
readonly operationId: "retrieveTask";
|
|
534
|
+
readonly namespace: "tasks";
|
|
535
|
+
readonly method: "retrieve";
|
|
536
|
+
readonly httpMethod: "GET";
|
|
537
|
+
readonly path: "/v1/tasks/{task}";
|
|
538
|
+
readonly pathParams: readonly ["task"];
|
|
539
|
+
readonly queryParams: readonly [];
|
|
540
|
+
readonly body: false;
|
|
541
|
+
readonly idempotent: false;
|
|
542
|
+
readonly auth: true;
|
|
543
|
+
readonly scope: "compliance_plans:read";
|
|
544
|
+
readonly response: "json";
|
|
545
|
+
readonly list: false;
|
|
546
|
+
readonly paginated: false;
|
|
547
|
+
readonly summary: "Get one task of a compliance plan";
|
|
548
|
+
};
|
|
549
|
+
readonly updateTask: {
|
|
550
|
+
readonly operationId: "updateTask";
|
|
551
|
+
readonly namespace: "tasks";
|
|
552
|
+
readonly method: "update";
|
|
553
|
+
readonly httpMethod: "POST";
|
|
554
|
+
readonly path: "/v1/tasks/{task}";
|
|
555
|
+
readonly pathParams: readonly ["task"];
|
|
556
|
+
readonly queryParams: readonly [];
|
|
557
|
+
readonly body: true;
|
|
558
|
+
readonly idempotent: true;
|
|
559
|
+
readonly auth: true;
|
|
560
|
+
readonly scope: "compliance_plans:write";
|
|
561
|
+
readonly response: "json";
|
|
562
|
+
readonly list: false;
|
|
563
|
+
readonly paginated: false;
|
|
564
|
+
readonly summary: "Claim, decline or reopen a task";
|
|
565
|
+
};
|
|
566
|
+
readonly answerTask: {
|
|
567
|
+
readonly operationId: "answerTask";
|
|
568
|
+
readonly namespace: "tasks";
|
|
569
|
+
readonly method: "answer";
|
|
570
|
+
readonly httpMethod: "POST";
|
|
571
|
+
readonly path: "/v1/tasks/{task}/answer";
|
|
572
|
+
readonly pathParams: readonly ["task"];
|
|
573
|
+
readonly queryParams: readonly [];
|
|
574
|
+
readonly body: true;
|
|
575
|
+
readonly idempotent: true;
|
|
576
|
+
readonly auth: true;
|
|
577
|
+
readonly scope: "compliance_plans:write";
|
|
578
|
+
readonly response: "json";
|
|
579
|
+
readonly list: false;
|
|
580
|
+
readonly paginated: false;
|
|
581
|
+
readonly summary: "Record the human answer to a manual task";
|
|
582
|
+
};
|
|
583
|
+
readonly verifyTask: {
|
|
584
|
+
readonly operationId: "verifyTask";
|
|
585
|
+
readonly namespace: "tasks";
|
|
586
|
+
readonly method: "verify";
|
|
587
|
+
readonly httpMethod: "POST";
|
|
588
|
+
readonly path: "/v1/tasks/{task}/verify";
|
|
589
|
+
readonly pathParams: readonly ["task"];
|
|
590
|
+
readonly queryParams: readonly ["wait"];
|
|
591
|
+
readonly body: true;
|
|
592
|
+
readonly idempotent: true;
|
|
593
|
+
readonly auth: true;
|
|
594
|
+
readonly scope: "compliance_plans:write";
|
|
595
|
+
readonly response: "json";
|
|
596
|
+
readonly list: false;
|
|
597
|
+
readonly paginated: false;
|
|
598
|
+
readonly summary: "Verify a task after applying its change";
|
|
599
|
+
};
|
|
600
|
+
readonly verifySite: {
|
|
601
|
+
readonly operationId: "verifySite";
|
|
602
|
+
readonly namespace: "sites";
|
|
603
|
+
readonly method: "verify";
|
|
604
|
+
readonly httpMethod: "POST";
|
|
605
|
+
readonly path: "/v1/sites/{site}/verify";
|
|
606
|
+
readonly pathParams: readonly ["site"];
|
|
607
|
+
readonly queryParams: readonly ["wait"];
|
|
608
|
+
readonly body: false;
|
|
609
|
+
readonly idempotent: true;
|
|
610
|
+
readonly auth: true;
|
|
611
|
+
readonly scope: "compliance_plans:write";
|
|
612
|
+
readonly response: "json";
|
|
613
|
+
readonly list: false;
|
|
614
|
+
readonly paginated: false;
|
|
615
|
+
readonly summary: "Re-check the whole site now";
|
|
616
|
+
};
|
|
617
|
+
readonly retrieveVerification: {
|
|
618
|
+
readonly operationId: "retrieveVerification";
|
|
619
|
+
readonly namespace: "verifications";
|
|
620
|
+
readonly method: "retrieve";
|
|
621
|
+
readonly httpMethod: "GET";
|
|
622
|
+
readonly path: "/v1/verifications/{verification}";
|
|
623
|
+
readonly pathParams: readonly ["verification"];
|
|
624
|
+
readonly queryParams: readonly ["wait"];
|
|
625
|
+
readonly body: false;
|
|
626
|
+
readonly idempotent: false;
|
|
627
|
+
readonly auth: true;
|
|
628
|
+
readonly scope: "compliance_plans:read";
|
|
629
|
+
readonly response: "json";
|
|
630
|
+
readonly list: false;
|
|
631
|
+
readonly paginated: false;
|
|
632
|
+
readonly summary: "Get a verification (long-poll with ?wait=30)";
|
|
633
|
+
};
|
|
634
|
+
readonly listVerifications: {
|
|
635
|
+
readonly operationId: "listVerifications";
|
|
636
|
+
readonly namespace: "verifications";
|
|
637
|
+
readonly method: "list";
|
|
638
|
+
readonly httpMethod: "GET";
|
|
639
|
+
readonly path: "/v1/sites/{site}/verifications";
|
|
640
|
+
readonly pathParams: readonly ["site"];
|
|
641
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "task"];
|
|
642
|
+
readonly body: false;
|
|
643
|
+
readonly idempotent: false;
|
|
644
|
+
readonly auth: true;
|
|
645
|
+
readonly scope: "compliance_plans:read";
|
|
646
|
+
readonly response: "json";
|
|
647
|
+
readonly list: true;
|
|
648
|
+
readonly paginated: true;
|
|
649
|
+
readonly summary: "List verifications of a site";
|
|
650
|
+
};
|
|
651
|
+
readonly retrieveFindingFix: {
|
|
652
|
+
readonly operationId: "retrieveFindingFix";
|
|
653
|
+
readonly namespace: "fixes";
|
|
654
|
+
readonly method: "retrieve";
|
|
655
|
+
readonly httpMethod: "GET";
|
|
656
|
+
readonly path: "/v1/findings/{finding}/fix";
|
|
657
|
+
readonly pathParams: readonly ["finding"];
|
|
658
|
+
readonly queryParams: readonly ["plan", "cancel_url", "target"];
|
|
659
|
+
readonly body: false;
|
|
660
|
+
readonly idempotent: false;
|
|
661
|
+
readonly auth: true;
|
|
662
|
+
readonly scope: "fixes:read";
|
|
663
|
+
readonly response: "json";
|
|
664
|
+
readonly list: false;
|
|
665
|
+
readonly paginated: false;
|
|
666
|
+
readonly summary: "Get the fix for a finding";
|
|
667
|
+
};
|
|
668
|
+
readonly listSiteFixes: {
|
|
669
|
+
readonly operationId: "listSiteFixes";
|
|
670
|
+
readonly namespace: "fixes";
|
|
671
|
+
readonly method: "list";
|
|
672
|
+
readonly httpMethod: "GET";
|
|
673
|
+
readonly path: "/v1/sites/{site}/fixes";
|
|
674
|
+
readonly pathParams: readonly ["site"];
|
|
675
|
+
readonly queryParams: readonly ["plan", "cancel_url", "target"];
|
|
676
|
+
readonly body: false;
|
|
677
|
+
readonly idempotent: false;
|
|
678
|
+
readonly auth: true;
|
|
679
|
+
readonly scope: "fixes:read";
|
|
680
|
+
readonly response: "json";
|
|
681
|
+
readonly list: true;
|
|
682
|
+
readonly paginated: false;
|
|
683
|
+
readonly summary: "List fix plans for a site";
|
|
684
|
+
};
|
|
685
|
+
readonly listEvidence: {
|
|
686
|
+
readonly operationId: "listEvidence";
|
|
687
|
+
readonly namespace: "evidence";
|
|
688
|
+
readonly method: "list";
|
|
689
|
+
readonly httpMethod: "GET";
|
|
690
|
+
readonly path: "/v1/evidence";
|
|
691
|
+
readonly pathParams: readonly [];
|
|
692
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "kind"];
|
|
693
|
+
readonly body: false;
|
|
694
|
+
readonly idempotent: false;
|
|
695
|
+
readonly auth: true;
|
|
696
|
+
readonly scope: "evidence:read";
|
|
697
|
+
readonly response: "json";
|
|
698
|
+
readonly list: true;
|
|
699
|
+
readonly paginated: true;
|
|
700
|
+
readonly summary: "List evidence";
|
|
701
|
+
};
|
|
702
|
+
readonly retrieveEvidence: {
|
|
703
|
+
readonly operationId: "retrieveEvidence";
|
|
704
|
+
readonly namespace: "evidence";
|
|
705
|
+
readonly method: "retrieve";
|
|
706
|
+
readonly httpMethod: "GET";
|
|
707
|
+
readonly path: "/v1/evidence/{evidence}";
|
|
708
|
+
readonly pathParams: readonly ["evidence"];
|
|
709
|
+
readonly queryParams: readonly [];
|
|
710
|
+
readonly body: false;
|
|
711
|
+
readonly idempotent: false;
|
|
712
|
+
readonly auth: true;
|
|
713
|
+
readonly scope: "evidence:read";
|
|
714
|
+
readonly response: "json";
|
|
715
|
+
readonly list: false;
|
|
716
|
+
readonly paginated: false;
|
|
717
|
+
readonly summary: "Retrieve evidence metadata";
|
|
718
|
+
};
|
|
719
|
+
readonly downloadEvidenceContent: {
|
|
720
|
+
readonly operationId: "downloadEvidenceContent";
|
|
721
|
+
readonly namespace: "evidence";
|
|
722
|
+
readonly method: "downloadContent";
|
|
723
|
+
readonly httpMethod: "GET";
|
|
724
|
+
readonly path: "/v1/evidence/{evidence}/content";
|
|
725
|
+
readonly pathParams: readonly ["evidence"];
|
|
726
|
+
readonly queryParams: readonly [];
|
|
727
|
+
readonly body: false;
|
|
728
|
+
readonly idempotent: false;
|
|
729
|
+
readonly auth: true;
|
|
730
|
+
readonly scope: "evidence:read";
|
|
731
|
+
readonly response: "binary";
|
|
732
|
+
readonly list: false;
|
|
733
|
+
readonly paginated: false;
|
|
734
|
+
readonly summary: "Download evidence content";
|
|
735
|
+
};
|
|
736
|
+
readonly verifyEvidenceChain: {
|
|
737
|
+
readonly operationId: "verifyEvidenceChain";
|
|
738
|
+
readonly namespace: "evidence";
|
|
739
|
+
readonly method: "verifyChain";
|
|
740
|
+
readonly httpMethod: "POST";
|
|
741
|
+
readonly path: "/v1/sites/{site}/evidence/verify";
|
|
742
|
+
readonly pathParams: readonly ["site"];
|
|
743
|
+
readonly queryParams: readonly [];
|
|
744
|
+
readonly body: true;
|
|
745
|
+
readonly idempotent: false;
|
|
746
|
+
readonly auth: true;
|
|
747
|
+
readonly scope: "evidence:read";
|
|
748
|
+
readonly response: "json";
|
|
749
|
+
readonly list: false;
|
|
750
|
+
readonly paginated: false;
|
|
751
|
+
readonly summary: "Verify the evidence chain";
|
|
752
|
+
};
|
|
753
|
+
readonly listCertificates: {
|
|
754
|
+
readonly operationId: "listCertificates";
|
|
755
|
+
readonly namespace: "certificates";
|
|
756
|
+
readonly method: "list";
|
|
757
|
+
readonly httpMethod: "GET";
|
|
758
|
+
readonly path: "/v1/certificates";
|
|
759
|
+
readonly pathParams: readonly [];
|
|
760
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site"];
|
|
761
|
+
readonly body: false;
|
|
762
|
+
readonly idempotent: false;
|
|
763
|
+
readonly auth: true;
|
|
764
|
+
readonly scope: "certificates:read";
|
|
765
|
+
readonly response: "json";
|
|
766
|
+
readonly list: true;
|
|
767
|
+
readonly paginated: true;
|
|
768
|
+
readonly summary: "List certificates";
|
|
769
|
+
};
|
|
770
|
+
readonly retrieveCertificate: {
|
|
771
|
+
readonly operationId: "retrieveCertificate";
|
|
772
|
+
readonly namespace: "certificates";
|
|
773
|
+
readonly method: "retrieve";
|
|
774
|
+
readonly httpMethod: "GET";
|
|
775
|
+
readonly path: "/v1/certificates/{certificate}";
|
|
776
|
+
readonly pathParams: readonly ["certificate"];
|
|
777
|
+
readonly queryParams: readonly [];
|
|
778
|
+
readonly body: false;
|
|
779
|
+
readonly idempotent: false;
|
|
780
|
+
readonly auth: true;
|
|
781
|
+
readonly scope: "certificates:read";
|
|
782
|
+
readonly response: "json";
|
|
783
|
+
readonly list: false;
|
|
784
|
+
readonly paginated: false;
|
|
785
|
+
readonly summary: "Retrieve a certificate";
|
|
786
|
+
};
|
|
787
|
+
readonly createCertificate: {
|
|
788
|
+
readonly operationId: "createCertificate";
|
|
789
|
+
readonly namespace: "certificates";
|
|
790
|
+
readonly method: "create";
|
|
791
|
+
readonly httpMethod: "POST";
|
|
792
|
+
readonly path: "/v1/sites/{site}/certificates";
|
|
793
|
+
readonly pathParams: readonly ["site"];
|
|
794
|
+
readonly queryParams: readonly [];
|
|
795
|
+
readonly body: true;
|
|
796
|
+
readonly idempotent: true;
|
|
797
|
+
readonly auth: true;
|
|
798
|
+
readonly scope: "certificates:write";
|
|
799
|
+
readonly response: "json";
|
|
800
|
+
readonly list: false;
|
|
801
|
+
readonly paginated: false;
|
|
802
|
+
readonly summary: "Issue a certificate";
|
|
803
|
+
};
|
|
804
|
+
readonly revokeCertificate: {
|
|
805
|
+
readonly operationId: "revokeCertificate";
|
|
806
|
+
readonly namespace: "certificates";
|
|
807
|
+
readonly method: "revoke";
|
|
808
|
+
readonly httpMethod: "POST";
|
|
809
|
+
readonly path: "/v1/certificates/{certificate}/revoke";
|
|
810
|
+
readonly pathParams: readonly ["certificate"];
|
|
811
|
+
readonly queryParams: readonly [];
|
|
812
|
+
readonly body: true;
|
|
813
|
+
readonly idempotent: true;
|
|
814
|
+
readonly auth: true;
|
|
815
|
+
readonly scope: "certificates:write";
|
|
816
|
+
readonly response: "json";
|
|
817
|
+
readonly list: false;
|
|
818
|
+
readonly paginated: false;
|
|
819
|
+
readonly summary: "Revoke a certificate";
|
|
820
|
+
};
|
|
821
|
+
readonly retrieveNoticeSettings: {
|
|
822
|
+
readonly operationId: "retrieveNoticeSettings";
|
|
823
|
+
readonly namespace: "noticeSettings";
|
|
824
|
+
readonly method: "retrieve";
|
|
825
|
+
readonly httpMethod: "GET";
|
|
826
|
+
readonly path: "/v1/sites/{site}/notice_settings";
|
|
827
|
+
readonly pathParams: readonly ["site"];
|
|
828
|
+
readonly queryParams: readonly [];
|
|
829
|
+
readonly body: false;
|
|
830
|
+
readonly idempotent: false;
|
|
831
|
+
readonly auth: true;
|
|
832
|
+
readonly scope: "notices:read";
|
|
833
|
+
readonly response: "json";
|
|
834
|
+
readonly list: false;
|
|
835
|
+
readonly paginated: false;
|
|
836
|
+
readonly summary: "Retrieve notice settings";
|
|
837
|
+
};
|
|
838
|
+
readonly updateNoticeSettings: {
|
|
839
|
+
readonly operationId: "updateNoticeSettings";
|
|
840
|
+
readonly namespace: "noticeSettings";
|
|
841
|
+
readonly method: "update";
|
|
842
|
+
readonly httpMethod: "POST";
|
|
843
|
+
readonly path: "/v1/sites/{site}/notice_settings";
|
|
844
|
+
readonly pathParams: readonly ["site"];
|
|
845
|
+
readonly queryParams: readonly [];
|
|
846
|
+
readonly body: true;
|
|
847
|
+
readonly idempotent: true;
|
|
848
|
+
readonly auth: true;
|
|
849
|
+
readonly scope: "notices:write";
|
|
850
|
+
readonly response: "json";
|
|
851
|
+
readonly list: false;
|
|
852
|
+
readonly paginated: false;
|
|
853
|
+
readonly summary: "Update notice settings";
|
|
854
|
+
};
|
|
855
|
+
readonly listDueNotices: {
|
|
856
|
+
readonly operationId: "listDueNotices";
|
|
857
|
+
readonly namespace: "notices";
|
|
858
|
+
readonly method: "listDue";
|
|
859
|
+
readonly httpMethod: "GET";
|
|
860
|
+
readonly path: "/v1/notices/due";
|
|
861
|
+
readonly pathParams: readonly [];
|
|
862
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "status", "kind", "subscription"];
|
|
863
|
+
readonly body: false;
|
|
864
|
+
readonly idempotent: false;
|
|
865
|
+
readonly auth: true;
|
|
866
|
+
readonly scope: "notices:read";
|
|
867
|
+
readonly response: "json";
|
|
868
|
+
readonly list: true;
|
|
869
|
+
readonly paginated: true;
|
|
870
|
+
readonly summary: "List due notices";
|
|
871
|
+
};
|
|
872
|
+
readonly listNoticeTemplates: {
|
|
873
|
+
readonly operationId: "listNoticeTemplates";
|
|
874
|
+
readonly namespace: "notices";
|
|
875
|
+
readonly method: "listTemplates";
|
|
876
|
+
readonly httpMethod: "GET";
|
|
877
|
+
readonly path: "/v1/notices/templates";
|
|
878
|
+
readonly pathParams: readonly [];
|
|
879
|
+
readonly queryParams: readonly ["site"];
|
|
880
|
+
readonly body: false;
|
|
881
|
+
readonly idempotent: false;
|
|
882
|
+
readonly auth: true;
|
|
883
|
+
readonly scope: "notices:read";
|
|
884
|
+
readonly response: "json";
|
|
885
|
+
readonly list: true;
|
|
886
|
+
readonly paginated: false;
|
|
887
|
+
readonly summary: "List notice email templates";
|
|
888
|
+
};
|
|
889
|
+
readonly checkNoticeTemplate: {
|
|
890
|
+
readonly operationId: "checkNoticeTemplate";
|
|
891
|
+
readonly namespace: "notices";
|
|
892
|
+
readonly method: "checkTemplate";
|
|
893
|
+
readonly httpMethod: "POST";
|
|
894
|
+
readonly path: "/v1/notices/templates/check";
|
|
895
|
+
readonly pathParams: readonly [];
|
|
896
|
+
readonly queryParams: readonly [];
|
|
897
|
+
readonly body: true;
|
|
898
|
+
readonly idempotent: false;
|
|
899
|
+
readonly auth: true;
|
|
900
|
+
readonly scope: "notices:read";
|
|
901
|
+
readonly response: "json";
|
|
902
|
+
readonly list: false;
|
|
903
|
+
readonly paginated: false;
|
|
904
|
+
readonly summary: "Check a notice email template";
|
|
905
|
+
};
|
|
906
|
+
readonly retrieveDueNotice: {
|
|
907
|
+
readonly operationId: "retrieveDueNotice";
|
|
908
|
+
readonly namespace: "notices";
|
|
909
|
+
readonly method: "retrieve";
|
|
910
|
+
readonly httpMethod: "GET";
|
|
911
|
+
readonly path: "/v1/notices/{notice}";
|
|
912
|
+
readonly pathParams: readonly ["notice"];
|
|
913
|
+
readonly queryParams: readonly [];
|
|
914
|
+
readonly body: false;
|
|
915
|
+
readonly idempotent: false;
|
|
916
|
+
readonly auth: true;
|
|
917
|
+
readonly scope: "notices:read";
|
|
918
|
+
readonly response: "json";
|
|
919
|
+
readonly list: false;
|
|
920
|
+
readonly paginated: false;
|
|
921
|
+
readonly summary: "Retrieve a due notice";
|
|
922
|
+
};
|
|
923
|
+
readonly markNoticeSent: {
|
|
924
|
+
readonly operationId: "markNoticeSent";
|
|
925
|
+
readonly namespace: "notices";
|
|
926
|
+
readonly method: "markSent";
|
|
927
|
+
readonly httpMethod: "POST";
|
|
928
|
+
readonly path: "/v1/notices/{notice}/sent";
|
|
929
|
+
readonly pathParams: readonly ["notice"];
|
|
930
|
+
readonly queryParams: readonly [];
|
|
931
|
+
readonly body: true;
|
|
932
|
+
readonly idempotent: true;
|
|
933
|
+
readonly auth: true;
|
|
934
|
+
readonly scope: "notices:write";
|
|
935
|
+
readonly response: "json";
|
|
936
|
+
readonly list: false;
|
|
937
|
+
readonly paginated: false;
|
|
938
|
+
readonly summary: "Mark a due notice as sent";
|
|
939
|
+
};
|
|
940
|
+
readonly markNoticeMissed: {
|
|
941
|
+
readonly operationId: "markNoticeMissed";
|
|
942
|
+
readonly namespace: "notices";
|
|
943
|
+
readonly method: "markMissed";
|
|
944
|
+
readonly httpMethod: "POST";
|
|
945
|
+
readonly path: "/v1/notices/{notice}/missed";
|
|
946
|
+
readonly pathParams: readonly ["notice"];
|
|
947
|
+
readonly queryParams: readonly [];
|
|
948
|
+
readonly body: true;
|
|
949
|
+
readonly idempotent: true;
|
|
950
|
+
readonly auth: true;
|
|
951
|
+
readonly scope: "notices:write";
|
|
952
|
+
readonly response: "json";
|
|
953
|
+
readonly list: false;
|
|
954
|
+
readonly paginated: false;
|
|
955
|
+
readonly summary: "Record a due notice as missed";
|
|
956
|
+
};
|
|
957
|
+
readonly listLawUpdates: {
|
|
958
|
+
readonly operationId: "listLawUpdates";
|
|
959
|
+
readonly namespace: "lawUpdates";
|
|
960
|
+
readonly method: "list";
|
|
961
|
+
readonly httpMethod: "GET";
|
|
962
|
+
readonly path: "/v1/law_updates";
|
|
963
|
+
readonly pathParams: readonly [];
|
|
964
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "since"];
|
|
965
|
+
readonly body: false;
|
|
966
|
+
readonly idempotent: false;
|
|
967
|
+
readonly auth: true;
|
|
968
|
+
readonly scope: "law_updates:read";
|
|
969
|
+
readonly response: "json";
|
|
970
|
+
readonly list: true;
|
|
971
|
+
readonly paginated: true;
|
|
972
|
+
readonly summary: "List law updates";
|
|
973
|
+
};
|
|
974
|
+
readonly retrieveLawUpdate: {
|
|
975
|
+
readonly operationId: "retrieveLawUpdate";
|
|
976
|
+
readonly namespace: "lawUpdates";
|
|
977
|
+
readonly method: "retrieve";
|
|
978
|
+
readonly httpMethod: "GET";
|
|
979
|
+
readonly path: "/v1/law_updates/{law_update}";
|
|
980
|
+
readonly pathParams: readonly ["law_update"];
|
|
981
|
+
readonly queryParams: readonly [];
|
|
982
|
+
readonly body: false;
|
|
983
|
+
readonly idempotent: false;
|
|
984
|
+
readonly auth: true;
|
|
985
|
+
readonly scope: "law_updates:read";
|
|
986
|
+
readonly response: "json";
|
|
987
|
+
readonly list: false;
|
|
988
|
+
readonly paginated: false;
|
|
989
|
+
readonly summary: "Retrieve a law update";
|
|
990
|
+
};
|
|
991
|
+
readonly checkDisclosure: {
|
|
992
|
+
readonly operationId: "checkDisclosure";
|
|
993
|
+
readonly namespace: "checks";
|
|
994
|
+
readonly method: "disclosure";
|
|
995
|
+
readonly httpMethod: "POST";
|
|
996
|
+
readonly path: "/v1/checks/disclosure";
|
|
997
|
+
readonly pathParams: readonly [];
|
|
998
|
+
readonly queryParams: readonly [];
|
|
999
|
+
readonly body: true;
|
|
1000
|
+
readonly idempotent: false;
|
|
1001
|
+
readonly auth: true;
|
|
1002
|
+
readonly scope: "checks:read";
|
|
1003
|
+
readonly response: "json";
|
|
1004
|
+
readonly list: false;
|
|
1005
|
+
readonly paginated: false;
|
|
1006
|
+
readonly summary: "Check checkout disclosure text";
|
|
1007
|
+
};
|
|
1008
|
+
readonly checkStripeCheckoutSession: {
|
|
1009
|
+
readonly operationId: "checkStripeCheckoutSession";
|
|
1010
|
+
readonly namespace: "checks";
|
|
1011
|
+
readonly method: "stripeCheckoutSession";
|
|
1012
|
+
readonly httpMethod: "POST";
|
|
1013
|
+
readonly path: "/v1/checks/stripe_checkout_session";
|
|
1014
|
+
readonly pathParams: readonly [];
|
|
1015
|
+
readonly queryParams: readonly [];
|
|
1016
|
+
readonly body: true;
|
|
1017
|
+
readonly idempotent: false;
|
|
1018
|
+
readonly auth: true;
|
|
1019
|
+
readonly scope: "checks:read";
|
|
1020
|
+
readonly response: "json";
|
|
1021
|
+
readonly list: false;
|
|
1022
|
+
readonly paginated: false;
|
|
1023
|
+
readonly summary: "Check Stripe Checkout Session params";
|
|
1024
|
+
};
|
|
1025
|
+
readonly checkStripePaymentLink: {
|
|
1026
|
+
readonly operationId: "checkStripePaymentLink";
|
|
1027
|
+
readonly namespace: "checks";
|
|
1028
|
+
readonly method: "stripePaymentLink";
|
|
1029
|
+
readonly httpMethod: "POST";
|
|
1030
|
+
readonly path: "/v1/checks/stripe_payment_link";
|
|
1031
|
+
readonly pathParams: readonly [];
|
|
1032
|
+
readonly queryParams: readonly [];
|
|
1033
|
+
readonly body: true;
|
|
1034
|
+
readonly idempotent: false;
|
|
1035
|
+
readonly auth: true;
|
|
1036
|
+
readonly scope: "checks:read";
|
|
1037
|
+
readonly response: "json";
|
|
1038
|
+
readonly list: false;
|
|
1039
|
+
readonly paginated: false;
|
|
1040
|
+
readonly summary: "Check Stripe Payment Link params";
|
|
1041
|
+
};
|
|
1042
|
+
readonly checkEmail: {
|
|
1043
|
+
readonly operationId: "checkEmail";
|
|
1044
|
+
readonly namespace: "checks";
|
|
1045
|
+
readonly method: "email";
|
|
1046
|
+
readonly httpMethod: "POST";
|
|
1047
|
+
readonly path: "/v1/checks/email";
|
|
1048
|
+
readonly pathParams: readonly [];
|
|
1049
|
+
readonly queryParams: readonly [];
|
|
1050
|
+
readonly body: true;
|
|
1051
|
+
readonly idempotent: false;
|
|
1052
|
+
readonly auth: true;
|
|
1053
|
+
readonly scope: "checks:read";
|
|
1054
|
+
readonly response: "json";
|
|
1055
|
+
readonly list: false;
|
|
1056
|
+
readonly paginated: false;
|
|
1057
|
+
readonly summary: "Check a subscription lifecycle email";
|
|
1058
|
+
};
|
|
1059
|
+
readonly checkPage: {
|
|
1060
|
+
readonly operationId: "checkPage";
|
|
1061
|
+
readonly namespace: "checks";
|
|
1062
|
+
readonly method: "page";
|
|
1063
|
+
readonly httpMethod: "POST";
|
|
1064
|
+
readonly path: "/v1/checks/page";
|
|
1065
|
+
readonly pathParams: readonly [];
|
|
1066
|
+
readonly queryParams: readonly [];
|
|
1067
|
+
readonly body: true;
|
|
1068
|
+
readonly idempotent: false;
|
|
1069
|
+
readonly auth: true;
|
|
1070
|
+
readonly scope: "checks:read";
|
|
1071
|
+
readonly response: "json";
|
|
1072
|
+
readonly list: false;
|
|
1073
|
+
readonly paginated: false;
|
|
1074
|
+
readonly summary: "Check a checkout page (HTML or URL)";
|
|
1075
|
+
};
|
|
1076
|
+
readonly checkNoticeSchedule: {
|
|
1077
|
+
readonly operationId: "checkNoticeSchedule";
|
|
1078
|
+
readonly namespace: "checks";
|
|
1079
|
+
readonly method: "noticeSchedule";
|
|
1080
|
+
readonly httpMethod: "POST";
|
|
1081
|
+
readonly path: "/v1/checks/notice_schedule";
|
|
1082
|
+
readonly pathParams: readonly [];
|
|
1083
|
+
readonly queryParams: readonly [];
|
|
1084
|
+
readonly body: true;
|
|
1085
|
+
readonly idempotent: false;
|
|
1086
|
+
readonly auth: true;
|
|
1087
|
+
readonly scope: "checks:read";
|
|
1088
|
+
readonly response: "json";
|
|
1089
|
+
readonly list: false;
|
|
1090
|
+
readonly paginated: false;
|
|
1091
|
+
readonly summary: "Get the dates each required notice must be sent";
|
|
1092
|
+
};
|
|
1093
|
+
readonly getElementsBundle: {
|
|
1094
|
+
readonly operationId: "getElementsBundle";
|
|
1095
|
+
readonly namespace: "elements";
|
|
1096
|
+
readonly method: "retrieveBundle";
|
|
1097
|
+
readonly httpMethod: "GET";
|
|
1098
|
+
readonly path: "/v1/elements.js";
|
|
1099
|
+
readonly pathParams: readonly [];
|
|
1100
|
+
readonly queryParams: readonly [];
|
|
1101
|
+
readonly body: false;
|
|
1102
|
+
readonly idempotent: false;
|
|
1103
|
+
readonly auth: false;
|
|
1104
|
+
readonly scope: "none";
|
|
1105
|
+
readonly response: "text";
|
|
1106
|
+
readonly list: false;
|
|
1107
|
+
readonly paginated: false;
|
|
1108
|
+
readonly summary: "Load the Elements browser bundle";
|
|
1109
|
+
};
|
|
1110
|
+
readonly getElementsManifest: {
|
|
1111
|
+
readonly operationId: "getElementsManifest";
|
|
1112
|
+
readonly namespace: "elements";
|
|
1113
|
+
readonly method: "retrieveManifest";
|
|
1114
|
+
readonly httpMethod: "GET";
|
|
1115
|
+
readonly path: "/v1/elements/manifest.json";
|
|
1116
|
+
readonly pathParams: readonly [];
|
|
1117
|
+
readonly queryParams: readonly [];
|
|
1118
|
+
readonly body: false;
|
|
1119
|
+
readonly idempotent: false;
|
|
1120
|
+
readonly auth: false;
|
|
1121
|
+
readonly scope: "none";
|
|
1122
|
+
readonly response: "json";
|
|
1123
|
+
readonly list: false;
|
|
1124
|
+
readonly paginated: false;
|
|
1125
|
+
readonly summary: "List Elements bundle versions and SRI hashes";
|
|
1126
|
+
};
|
|
1127
|
+
readonly getElementsBundleVersion: {
|
|
1128
|
+
readonly operationId: "getElementsBundleVersion";
|
|
1129
|
+
readonly namespace: "elements";
|
|
1130
|
+
readonly method: "retrieveBundleVersion";
|
|
1131
|
+
readonly httpMethod: "GET";
|
|
1132
|
+
readonly path: "/v1/elements/{version}/elements.js";
|
|
1133
|
+
readonly pathParams: readonly ["version"];
|
|
1134
|
+
readonly queryParams: readonly [];
|
|
1135
|
+
readonly body: false;
|
|
1136
|
+
readonly idempotent: false;
|
|
1137
|
+
readonly auth: false;
|
|
1138
|
+
readonly scope: "none";
|
|
1139
|
+
readonly response: "text";
|
|
1140
|
+
readonly list: false;
|
|
1141
|
+
readonly paginated: false;
|
|
1142
|
+
readonly summary: "Load a pinned Elements bundle version";
|
|
1143
|
+
};
|
|
1144
|
+
readonly createDisclosure: {
|
|
1145
|
+
readonly operationId: "createDisclosure";
|
|
1146
|
+
readonly namespace: "disclosures";
|
|
1147
|
+
readonly method: "create";
|
|
1148
|
+
readonly httpMethod: "POST";
|
|
1149
|
+
readonly path: "/v1/disclosures";
|
|
1150
|
+
readonly pathParams: readonly [];
|
|
1151
|
+
readonly queryParams: readonly [];
|
|
1152
|
+
readonly body: true;
|
|
1153
|
+
readonly idempotent: true;
|
|
1154
|
+
readonly auth: true;
|
|
1155
|
+
readonly scope: "consents:write";
|
|
1156
|
+
readonly response: "json";
|
|
1157
|
+
readonly list: false;
|
|
1158
|
+
readonly paginated: false;
|
|
1159
|
+
readonly summary: "Create a locked disclosure for a site";
|
|
1160
|
+
};
|
|
1161
|
+
readonly retrieveDisclosure: {
|
|
1162
|
+
readonly operationId: "retrieveDisclosure";
|
|
1163
|
+
readonly namespace: "disclosures";
|
|
1164
|
+
readonly method: "retrieve";
|
|
1165
|
+
readonly httpMethod: "GET";
|
|
1166
|
+
readonly path: "/v1/disclosures/{disclosure}";
|
|
1167
|
+
readonly pathParams: readonly ["disclosure"];
|
|
1168
|
+
readonly queryParams: readonly [];
|
|
1169
|
+
readonly body: false;
|
|
1170
|
+
readonly idempotent: false;
|
|
1171
|
+
readonly auth: true;
|
|
1172
|
+
readonly scope: "publishable";
|
|
1173
|
+
readonly response: "json";
|
|
1174
|
+
readonly list: false;
|
|
1175
|
+
readonly paginated: false;
|
|
1176
|
+
readonly summary: "Retrieve a disclosure";
|
|
1177
|
+
};
|
|
1178
|
+
readonly createConsent: {
|
|
1179
|
+
readonly operationId: "createConsent";
|
|
1180
|
+
readonly namespace: "consents";
|
|
1181
|
+
readonly method: "create";
|
|
1182
|
+
readonly httpMethod: "POST";
|
|
1183
|
+
readonly path: "/v1/consents";
|
|
1184
|
+
readonly pathParams: readonly [];
|
|
1185
|
+
readonly queryParams: readonly [];
|
|
1186
|
+
readonly body: true;
|
|
1187
|
+
readonly idempotent: true;
|
|
1188
|
+
readonly auth: true;
|
|
1189
|
+
readonly scope: "publishable";
|
|
1190
|
+
readonly response: "json";
|
|
1191
|
+
readonly list: false;
|
|
1192
|
+
readonly paginated: false;
|
|
1193
|
+
readonly summary: "Record a consent";
|
|
1194
|
+
};
|
|
1195
|
+
readonly listConsents: {
|
|
1196
|
+
readonly operationId: "listConsents";
|
|
1197
|
+
readonly namespace: "consents";
|
|
1198
|
+
readonly method: "list";
|
|
1199
|
+
readonly httpMethod: "GET";
|
|
1200
|
+
readonly path: "/v1/consents";
|
|
1201
|
+
readonly pathParams: readonly [];
|
|
1202
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "customer_reference", "disclosure", "created_gte", "created_lte"];
|
|
1203
|
+
readonly body: false;
|
|
1204
|
+
readonly idempotent: false;
|
|
1205
|
+
readonly auth: true;
|
|
1206
|
+
readonly scope: "consents:read";
|
|
1207
|
+
readonly response: "json";
|
|
1208
|
+
readonly list: true;
|
|
1209
|
+
readonly paginated: true;
|
|
1210
|
+
readonly summary: "List consents";
|
|
1211
|
+
};
|
|
1212
|
+
readonly retrieveConsent: {
|
|
1213
|
+
readonly operationId: "retrieveConsent";
|
|
1214
|
+
readonly namespace: "consents";
|
|
1215
|
+
readonly method: "retrieve";
|
|
1216
|
+
readonly httpMethod: "GET";
|
|
1217
|
+
readonly path: "/v1/consents/{consent}";
|
|
1218
|
+
readonly pathParams: readonly ["consent"];
|
|
1219
|
+
readonly queryParams: readonly [];
|
|
1220
|
+
readonly body: false;
|
|
1221
|
+
readonly idempotent: false;
|
|
1222
|
+
readonly auth: true;
|
|
1223
|
+
readonly scope: "consents:read";
|
|
1224
|
+
readonly response: "json";
|
|
1225
|
+
readonly list: false;
|
|
1226
|
+
readonly paginated: false;
|
|
1227
|
+
readonly summary: "Retrieve a consent";
|
|
1228
|
+
};
|
|
1229
|
+
readonly updateConsent: {
|
|
1230
|
+
readonly operationId: "updateConsent";
|
|
1231
|
+
readonly namespace: "consents";
|
|
1232
|
+
readonly method: "update";
|
|
1233
|
+
readonly httpMethod: "POST";
|
|
1234
|
+
readonly path: "/v1/consents/{consent}";
|
|
1235
|
+
readonly pathParams: readonly ["consent"];
|
|
1236
|
+
readonly queryParams: readonly [];
|
|
1237
|
+
readonly body: true;
|
|
1238
|
+
readonly idempotent: true;
|
|
1239
|
+
readonly auth: true;
|
|
1240
|
+
readonly scope: "consents:write";
|
|
1241
|
+
readonly response: "json";
|
|
1242
|
+
readonly list: false;
|
|
1243
|
+
readonly paginated: false;
|
|
1244
|
+
readonly summary: "Attach a customer reference to a consent";
|
|
1245
|
+
};
|
|
1246
|
+
readonly createReceiptToken: {
|
|
1247
|
+
readonly operationId: "createReceiptToken";
|
|
1248
|
+
readonly namespace: "receiptTokens";
|
|
1249
|
+
readonly method: "create";
|
|
1250
|
+
readonly httpMethod: "POST";
|
|
1251
|
+
readonly path: "/v1/receipt_tokens";
|
|
1252
|
+
readonly pathParams: readonly [];
|
|
1253
|
+
readonly queryParams: readonly [];
|
|
1254
|
+
readonly body: true;
|
|
1255
|
+
readonly idempotent: true;
|
|
1256
|
+
readonly auth: true;
|
|
1257
|
+
readonly scope: "receipts:write";
|
|
1258
|
+
readonly response: "json";
|
|
1259
|
+
readonly list: false;
|
|
1260
|
+
readonly paginated: false;
|
|
1261
|
+
readonly summary: "Mint a capture token for a checkout";
|
|
1262
|
+
};
|
|
1263
|
+
readonly createReceipt: {
|
|
1264
|
+
readonly operationId: "createReceipt";
|
|
1265
|
+
readonly namespace: "receipts";
|
|
1266
|
+
readonly method: "create";
|
|
1267
|
+
readonly httpMethod: "POST";
|
|
1268
|
+
readonly path: "/v1/receipts";
|
|
1269
|
+
readonly pathParams: readonly [];
|
|
1270
|
+
readonly queryParams: readonly [];
|
|
1271
|
+
readonly body: true;
|
|
1272
|
+
readonly idempotent: true;
|
|
1273
|
+
readonly auth: true;
|
|
1274
|
+
readonly scope: "publishable";
|
|
1275
|
+
readonly response: "json";
|
|
1276
|
+
readonly list: false;
|
|
1277
|
+
readonly paginated: false;
|
|
1278
|
+
readonly summary: "Record a consent receipt";
|
|
1279
|
+
};
|
|
1280
|
+
readonly listReceipts: {
|
|
1281
|
+
readonly operationId: "listReceipts";
|
|
1282
|
+
readonly namespace: "receipts";
|
|
1283
|
+
readonly method: "list";
|
|
1284
|
+
readonly httpMethod: "GET";
|
|
1285
|
+
readonly path: "/v1/receipts";
|
|
1286
|
+
readonly pathParams: readonly [];
|
|
1287
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "customer_reference", "checkout_session", "email", "source", "binding", "created_gte", "created_lte"];
|
|
1288
|
+
readonly body: false;
|
|
1289
|
+
readonly idempotent: false;
|
|
1290
|
+
readonly auth: true;
|
|
1291
|
+
readonly scope: "receipts:read";
|
|
1292
|
+
readonly response: "json";
|
|
1293
|
+
readonly list: true;
|
|
1294
|
+
readonly paginated: true;
|
|
1295
|
+
readonly summary: "List consent receipts";
|
|
1296
|
+
};
|
|
1297
|
+
readonly eraseReceipts: {
|
|
1298
|
+
readonly operationId: "eraseReceipts";
|
|
1299
|
+
readonly namespace: "receipts";
|
|
1300
|
+
readonly method: "erase";
|
|
1301
|
+
readonly httpMethod: "POST";
|
|
1302
|
+
readonly path: "/v1/receipts/erase";
|
|
1303
|
+
readonly pathParams: readonly [];
|
|
1304
|
+
readonly queryParams: readonly [];
|
|
1305
|
+
readonly body: true;
|
|
1306
|
+
readonly idempotent: true;
|
|
1307
|
+
readonly auth: true;
|
|
1308
|
+
readonly scope: "receipts:write";
|
|
1309
|
+
readonly response: "json";
|
|
1310
|
+
readonly list: false;
|
|
1311
|
+
readonly paginated: false;
|
|
1312
|
+
readonly summary: "Erase a subscriber's receipts";
|
|
1313
|
+
};
|
|
1314
|
+
readonly retrieveReceipt: {
|
|
1315
|
+
readonly operationId: "retrieveReceipt";
|
|
1316
|
+
readonly namespace: "receipts";
|
|
1317
|
+
readonly method: "retrieve";
|
|
1318
|
+
readonly httpMethod: "GET";
|
|
1319
|
+
readonly path: "/v1/receipts/{receipt}";
|
|
1320
|
+
readonly pathParams: readonly ["receipt"];
|
|
1321
|
+
readonly queryParams: readonly [];
|
|
1322
|
+
readonly body: false;
|
|
1323
|
+
readonly idempotent: false;
|
|
1324
|
+
readonly auth: true;
|
|
1325
|
+
readonly scope: "receipts:read";
|
|
1326
|
+
readonly response: "json";
|
|
1327
|
+
readonly list: false;
|
|
1328
|
+
readonly paginated: false;
|
|
1329
|
+
readonly summary: "Retrieve a consent receipt";
|
|
1330
|
+
};
|
|
1331
|
+
readonly renderReceipt: {
|
|
1332
|
+
readonly operationId: "renderReceipt";
|
|
1333
|
+
readonly namespace: "receipts";
|
|
1334
|
+
readonly method: "render";
|
|
1335
|
+
readonly httpMethod: "GET";
|
|
1336
|
+
readonly path: "/v1/receipts/{receipt}/render.png";
|
|
1337
|
+
readonly pathParams: readonly ["receipt"];
|
|
1338
|
+
readonly queryParams: readonly [];
|
|
1339
|
+
readonly body: false;
|
|
1340
|
+
readonly idempotent: false;
|
|
1341
|
+
readonly auth: true;
|
|
1342
|
+
readonly scope: "receipts:read";
|
|
1343
|
+
readonly response: "binary";
|
|
1344
|
+
readonly list: false;
|
|
1345
|
+
readonly paginated: false;
|
|
1346
|
+
readonly summary: "Render a receipt as an image";
|
|
1347
|
+
};
|
|
1348
|
+
readonly verifyReceipt: {
|
|
1349
|
+
readonly operationId: "verifyReceipt";
|
|
1350
|
+
readonly namespace: "receipts";
|
|
1351
|
+
readonly method: "verify";
|
|
1352
|
+
readonly httpMethod: "GET";
|
|
1353
|
+
readonly path: "/v1/receipts/{receipt}/verify";
|
|
1354
|
+
readonly pathParams: readonly ["receipt"];
|
|
1355
|
+
readonly queryParams: readonly [];
|
|
1356
|
+
readonly body: false;
|
|
1357
|
+
readonly idempotent: false;
|
|
1358
|
+
readonly auth: true;
|
|
1359
|
+
readonly scope: "receipts:read";
|
|
1360
|
+
readonly response: "json";
|
|
1361
|
+
readonly list: false;
|
|
1362
|
+
readonly paginated: false;
|
|
1363
|
+
readonly summary: "Verify a receipt's integrity";
|
|
1364
|
+
};
|
|
1365
|
+
readonly exportReceipt: {
|
|
1366
|
+
readonly operationId: "exportReceipt";
|
|
1367
|
+
readonly namespace: "receipts";
|
|
1368
|
+
readonly method: "export";
|
|
1369
|
+
readonly httpMethod: "GET";
|
|
1370
|
+
readonly path: "/v1/receipts/{receipt}/export";
|
|
1371
|
+
readonly pathParams: readonly ["receipt"];
|
|
1372
|
+
readonly queryParams: readonly [];
|
|
1373
|
+
readonly body: false;
|
|
1374
|
+
readonly idempotent: false;
|
|
1375
|
+
readonly auth: true;
|
|
1376
|
+
readonly scope: "receipts:read";
|
|
1377
|
+
readonly response: "binary";
|
|
1378
|
+
readonly list: false;
|
|
1379
|
+
readonly paginated: false;
|
|
1380
|
+
readonly summary: "Download a self-verifying receipt bundle";
|
|
1381
|
+
};
|
|
1382
|
+
readonly retrieveReceiptSettings: {
|
|
1383
|
+
readonly operationId: "retrieveReceiptSettings";
|
|
1384
|
+
readonly namespace: "receiptSettings";
|
|
1385
|
+
readonly method: "retrieve";
|
|
1386
|
+
readonly httpMethod: "GET";
|
|
1387
|
+
readonly path: "/v1/receipt_settings";
|
|
1388
|
+
readonly pathParams: readonly [];
|
|
1389
|
+
readonly queryParams: readonly [];
|
|
1390
|
+
readonly body: false;
|
|
1391
|
+
readonly idempotent: false;
|
|
1392
|
+
readonly auth: true;
|
|
1393
|
+
readonly scope: "receipts:read";
|
|
1394
|
+
readonly response: "json";
|
|
1395
|
+
readonly list: false;
|
|
1396
|
+
readonly paginated: false;
|
|
1397
|
+
readonly summary: "Retrieve receipt settings";
|
|
1398
|
+
};
|
|
1399
|
+
readonly updateReceiptSettings: {
|
|
1400
|
+
readonly operationId: "updateReceiptSettings";
|
|
1401
|
+
readonly namespace: "receiptSettings";
|
|
1402
|
+
readonly method: "update";
|
|
1403
|
+
readonly httpMethod: "POST";
|
|
1404
|
+
readonly path: "/v1/receipt_settings";
|
|
1405
|
+
readonly pathParams: readonly [];
|
|
1406
|
+
readonly queryParams: readonly [];
|
|
1407
|
+
readonly body: true;
|
|
1408
|
+
readonly idempotent: true;
|
|
1409
|
+
readonly auth: true;
|
|
1410
|
+
readonly scope: "receipts:write";
|
|
1411
|
+
readonly response: "json";
|
|
1412
|
+
readonly list: false;
|
|
1413
|
+
readonly paginated: false;
|
|
1414
|
+
readonly summary: "Update receipt settings";
|
|
1415
|
+
};
|
|
1416
|
+
readonly createTestCredential: {
|
|
1417
|
+
readonly operationId: "createTestCredential";
|
|
1418
|
+
readonly namespace: "testCredentials";
|
|
1419
|
+
readonly method: "create";
|
|
1420
|
+
readonly httpMethod: "POST";
|
|
1421
|
+
readonly path: "/v1/sites/{site}/test_credentials";
|
|
1422
|
+
readonly pathParams: readonly ["site"];
|
|
1423
|
+
readonly queryParams: readonly [];
|
|
1424
|
+
readonly body: true;
|
|
1425
|
+
readonly idempotent: true;
|
|
1426
|
+
readonly auth: true;
|
|
1427
|
+
readonly scope: "test_runs:write";
|
|
1428
|
+
readonly response: "json";
|
|
1429
|
+
readonly list: false;
|
|
1430
|
+
readonly paginated: false;
|
|
1431
|
+
readonly summary: "Store a billing test-mode key";
|
|
1432
|
+
};
|
|
1433
|
+
readonly listTestCredentials: {
|
|
1434
|
+
readonly operationId: "listTestCredentials";
|
|
1435
|
+
readonly namespace: "testCredentials";
|
|
1436
|
+
readonly method: "list";
|
|
1437
|
+
readonly httpMethod: "GET";
|
|
1438
|
+
readonly path: "/v1/sites/{site}/test_credentials";
|
|
1439
|
+
readonly pathParams: readonly ["site"];
|
|
1440
|
+
readonly queryParams: readonly [];
|
|
1441
|
+
readonly body: false;
|
|
1442
|
+
readonly idempotent: false;
|
|
1443
|
+
readonly auth: true;
|
|
1444
|
+
readonly scope: "test_runs:read";
|
|
1445
|
+
readonly response: "json";
|
|
1446
|
+
readonly list: true;
|
|
1447
|
+
readonly paginated: false;
|
|
1448
|
+
readonly summary: "List billing test-mode keys of a site";
|
|
1449
|
+
};
|
|
1450
|
+
readonly deleteTestCredential: {
|
|
1451
|
+
readonly operationId: "deleteTestCredential";
|
|
1452
|
+
readonly namespace: "testCredentials";
|
|
1453
|
+
readonly method: "del";
|
|
1454
|
+
readonly httpMethod: "DELETE";
|
|
1455
|
+
readonly path: "/v1/sites/{site}/test_credentials/{test_credential}";
|
|
1456
|
+
readonly pathParams: readonly ["site", "test_credential"];
|
|
1457
|
+
readonly queryParams: readonly [];
|
|
1458
|
+
readonly body: false;
|
|
1459
|
+
readonly idempotent: false;
|
|
1460
|
+
readonly auth: true;
|
|
1461
|
+
readonly scope: "test_runs:write";
|
|
1462
|
+
readonly response: "json";
|
|
1463
|
+
readonly list: false;
|
|
1464
|
+
readonly paginated: false;
|
|
1465
|
+
readonly summary: "Delete a billing test-mode key";
|
|
1466
|
+
};
|
|
1467
|
+
readonly createStripeCheckoutConfig: {
|
|
1468
|
+
readonly operationId: "createStripeCheckoutConfig";
|
|
1469
|
+
readonly namespace: "stripeCheckoutConfigs";
|
|
1470
|
+
readonly method: "create";
|
|
1471
|
+
readonly httpMethod: "POST";
|
|
1472
|
+
readonly path: "/v1/sites/{site}/stripe_checkout_configs";
|
|
1473
|
+
readonly pathParams: readonly ["site"];
|
|
1474
|
+
readonly queryParams: readonly [];
|
|
1475
|
+
readonly body: true;
|
|
1476
|
+
readonly idempotent: true;
|
|
1477
|
+
readonly auth: true;
|
|
1478
|
+
readonly scope: "test_runs:write";
|
|
1479
|
+
readonly response: "json";
|
|
1480
|
+
readonly list: false;
|
|
1481
|
+
readonly paginated: false;
|
|
1482
|
+
readonly summary: "Register the Checkout Session params your code uses";
|
|
1483
|
+
};
|
|
1484
|
+
readonly listStripeCheckoutConfigs: {
|
|
1485
|
+
readonly operationId: "listStripeCheckoutConfigs";
|
|
1486
|
+
readonly namespace: "stripeCheckoutConfigs";
|
|
1487
|
+
readonly method: "list";
|
|
1488
|
+
readonly httpMethod: "GET";
|
|
1489
|
+
readonly path: "/v1/sites/{site}/stripe_checkout_configs";
|
|
1490
|
+
readonly pathParams: readonly ["site"];
|
|
1491
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before"];
|
|
1492
|
+
readonly body: false;
|
|
1493
|
+
readonly idempotent: false;
|
|
1494
|
+
readonly auth: true;
|
|
1495
|
+
readonly scope: "test_runs:read";
|
|
1496
|
+
readonly response: "json";
|
|
1497
|
+
readonly list: true;
|
|
1498
|
+
readonly paginated: true;
|
|
1499
|
+
readonly summary: "List registered checkout configs";
|
|
1500
|
+
};
|
|
1501
|
+
readonly retrieveStripeCheckoutConfig: {
|
|
1502
|
+
readonly operationId: "retrieveStripeCheckoutConfig";
|
|
1503
|
+
readonly namespace: "stripeCheckoutConfigs";
|
|
1504
|
+
readonly method: "retrieve";
|
|
1505
|
+
readonly httpMethod: "GET";
|
|
1506
|
+
readonly path: "/v1/stripe_checkout_configs/{stripe_checkout_config}";
|
|
1507
|
+
readonly pathParams: readonly ["stripe_checkout_config"];
|
|
1508
|
+
readonly queryParams: readonly [];
|
|
1509
|
+
readonly body: false;
|
|
1510
|
+
readonly idempotent: false;
|
|
1511
|
+
readonly auth: true;
|
|
1512
|
+
readonly scope: "test_runs:read";
|
|
1513
|
+
readonly response: "json";
|
|
1514
|
+
readonly list: false;
|
|
1515
|
+
readonly paginated: false;
|
|
1516
|
+
readonly summary: "Retrieve a registered checkout config";
|
|
1517
|
+
};
|
|
1518
|
+
readonly deleteStripeCheckoutConfig: {
|
|
1519
|
+
readonly operationId: "deleteStripeCheckoutConfig";
|
|
1520
|
+
readonly namespace: "stripeCheckoutConfigs";
|
|
1521
|
+
readonly method: "del";
|
|
1522
|
+
readonly httpMethod: "DELETE";
|
|
1523
|
+
readonly path: "/v1/stripe_checkout_configs/{stripe_checkout_config}";
|
|
1524
|
+
readonly pathParams: readonly ["stripe_checkout_config"];
|
|
1525
|
+
readonly queryParams: readonly [];
|
|
1526
|
+
readonly body: false;
|
|
1527
|
+
readonly idempotent: false;
|
|
1528
|
+
readonly auth: true;
|
|
1529
|
+
readonly scope: "test_runs:write";
|
|
1530
|
+
readonly response: "json";
|
|
1531
|
+
readonly list: false;
|
|
1532
|
+
readonly paginated: false;
|
|
1533
|
+
readonly summary: "Delete a registered checkout config";
|
|
1534
|
+
};
|
|
1535
|
+
readonly createTestRun: {
|
|
1536
|
+
readonly operationId: "createTestRun";
|
|
1537
|
+
readonly namespace: "testRuns";
|
|
1538
|
+
readonly method: "create";
|
|
1539
|
+
readonly httpMethod: "POST";
|
|
1540
|
+
readonly path: "/v1/sites/{site}/test_runs";
|
|
1541
|
+
readonly pathParams: readonly ["site"];
|
|
1542
|
+
readonly queryParams: readonly [];
|
|
1543
|
+
readonly body: true;
|
|
1544
|
+
readonly idempotent: true;
|
|
1545
|
+
readonly auth: true;
|
|
1546
|
+
readonly scope: "test_runs:write";
|
|
1547
|
+
readonly response: "json";
|
|
1548
|
+
readonly list: false;
|
|
1549
|
+
readonly paginated: false;
|
|
1550
|
+
readonly summary: "Start a lifecycle test run";
|
|
1551
|
+
};
|
|
1552
|
+
readonly listTestRuns: {
|
|
1553
|
+
readonly operationId: "listTestRuns";
|
|
1554
|
+
readonly namespace: "testRuns";
|
|
1555
|
+
readonly method: "list";
|
|
1556
|
+
readonly httpMethod: "GET";
|
|
1557
|
+
readonly path: "/v1/sites/{site}/test_runs";
|
|
1558
|
+
readonly pathParams: readonly ["site"];
|
|
1559
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before"];
|
|
1560
|
+
readonly body: false;
|
|
1561
|
+
readonly idempotent: false;
|
|
1562
|
+
readonly auth: true;
|
|
1563
|
+
readonly scope: "test_runs:read";
|
|
1564
|
+
readonly response: "json";
|
|
1565
|
+
readonly list: true;
|
|
1566
|
+
readonly paginated: true;
|
|
1567
|
+
readonly summary: "List test runs of a site";
|
|
1568
|
+
};
|
|
1569
|
+
readonly retrieveTestRun: {
|
|
1570
|
+
readonly operationId: "retrieveTestRun";
|
|
1571
|
+
readonly namespace: "testRuns";
|
|
1572
|
+
readonly method: "retrieve";
|
|
1573
|
+
readonly httpMethod: "GET";
|
|
1574
|
+
readonly path: "/v1/test_runs/{test_run}";
|
|
1575
|
+
readonly pathParams: readonly ["test_run"];
|
|
1576
|
+
readonly queryParams: readonly [];
|
|
1577
|
+
readonly body: false;
|
|
1578
|
+
readonly idempotent: false;
|
|
1579
|
+
readonly auth: true;
|
|
1580
|
+
readonly scope: "test_runs:read";
|
|
1581
|
+
readonly response: "json";
|
|
1582
|
+
readonly list: false;
|
|
1583
|
+
readonly paginated: false;
|
|
1584
|
+
readonly summary: "Retrieve a test run";
|
|
1585
|
+
};
|
|
1586
|
+
readonly cancelTestRun: {
|
|
1587
|
+
readonly operationId: "cancelTestRun";
|
|
1588
|
+
readonly namespace: "testRuns";
|
|
1589
|
+
readonly method: "cancel";
|
|
1590
|
+
readonly httpMethod: "POST";
|
|
1591
|
+
readonly path: "/v1/test_runs/{test_run}/cancel";
|
|
1592
|
+
readonly pathParams: readonly ["test_run"];
|
|
1593
|
+
readonly queryParams: readonly [];
|
|
1594
|
+
readonly body: false;
|
|
1595
|
+
readonly idempotent: true;
|
|
1596
|
+
readonly auth: true;
|
|
1597
|
+
readonly scope: "test_runs:write";
|
|
1598
|
+
readonly response: "json";
|
|
1599
|
+
readonly list: false;
|
|
1600
|
+
readonly paginated: false;
|
|
1601
|
+
readonly summary: "Cancel a test run";
|
|
1602
|
+
};
|
|
1603
|
+
readonly createWebhookEndpoint: {
|
|
1604
|
+
readonly operationId: "createWebhookEndpoint";
|
|
1605
|
+
readonly namespace: "webhookEndpoints";
|
|
1606
|
+
readonly method: "create";
|
|
1607
|
+
readonly httpMethod: "POST";
|
|
1608
|
+
readonly path: "/v1/webhook_endpoints";
|
|
1609
|
+
readonly pathParams: readonly [];
|
|
1610
|
+
readonly queryParams: readonly [];
|
|
1611
|
+
readonly body: true;
|
|
1612
|
+
readonly idempotent: true;
|
|
1613
|
+
readonly auth: true;
|
|
1614
|
+
readonly scope: "webhook_endpoints:write";
|
|
1615
|
+
readonly response: "json";
|
|
1616
|
+
readonly list: false;
|
|
1617
|
+
readonly paginated: false;
|
|
1618
|
+
readonly summary: "Create a webhook endpoint";
|
|
1619
|
+
};
|
|
1620
|
+
readonly listWebhookEndpoints: {
|
|
1621
|
+
readonly operationId: "listWebhookEndpoints";
|
|
1622
|
+
readonly namespace: "webhookEndpoints";
|
|
1623
|
+
readonly method: "list";
|
|
1624
|
+
readonly httpMethod: "GET";
|
|
1625
|
+
readonly path: "/v1/webhook_endpoints";
|
|
1626
|
+
readonly pathParams: readonly [];
|
|
1627
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before"];
|
|
1628
|
+
readonly body: false;
|
|
1629
|
+
readonly idempotent: false;
|
|
1630
|
+
readonly auth: true;
|
|
1631
|
+
readonly scope: "webhook_endpoints:read";
|
|
1632
|
+
readonly response: "json";
|
|
1633
|
+
readonly list: true;
|
|
1634
|
+
readonly paginated: true;
|
|
1635
|
+
readonly summary: "List webhook endpoints";
|
|
1636
|
+
};
|
|
1637
|
+
readonly retrieveWebhookEndpoint: {
|
|
1638
|
+
readonly operationId: "retrieveWebhookEndpoint";
|
|
1639
|
+
readonly namespace: "webhookEndpoints";
|
|
1640
|
+
readonly method: "retrieve";
|
|
1641
|
+
readonly httpMethod: "GET";
|
|
1642
|
+
readonly path: "/v1/webhook_endpoints/{webhook_endpoint}";
|
|
1643
|
+
readonly pathParams: readonly ["webhook_endpoint"];
|
|
1644
|
+
readonly queryParams: readonly [];
|
|
1645
|
+
readonly body: false;
|
|
1646
|
+
readonly idempotent: false;
|
|
1647
|
+
readonly auth: true;
|
|
1648
|
+
readonly scope: "webhook_endpoints:read";
|
|
1649
|
+
readonly response: "json";
|
|
1650
|
+
readonly list: false;
|
|
1651
|
+
readonly paginated: false;
|
|
1652
|
+
readonly summary: "Retrieve a webhook endpoint";
|
|
1653
|
+
};
|
|
1654
|
+
readonly updateWebhookEndpoint: {
|
|
1655
|
+
readonly operationId: "updateWebhookEndpoint";
|
|
1656
|
+
readonly namespace: "webhookEndpoints";
|
|
1657
|
+
readonly method: "update";
|
|
1658
|
+
readonly httpMethod: "POST";
|
|
1659
|
+
readonly path: "/v1/webhook_endpoints/{webhook_endpoint}";
|
|
1660
|
+
readonly pathParams: readonly ["webhook_endpoint"];
|
|
1661
|
+
readonly queryParams: readonly [];
|
|
1662
|
+
readonly body: true;
|
|
1663
|
+
readonly idempotent: true;
|
|
1664
|
+
readonly auth: true;
|
|
1665
|
+
readonly scope: "webhook_endpoints:write";
|
|
1666
|
+
readonly response: "json";
|
|
1667
|
+
readonly list: false;
|
|
1668
|
+
readonly paginated: false;
|
|
1669
|
+
readonly summary: "Update a webhook endpoint";
|
|
1670
|
+
};
|
|
1671
|
+
readonly deleteWebhookEndpoint: {
|
|
1672
|
+
readonly operationId: "deleteWebhookEndpoint";
|
|
1673
|
+
readonly namespace: "webhookEndpoints";
|
|
1674
|
+
readonly method: "del";
|
|
1675
|
+
readonly httpMethod: "DELETE";
|
|
1676
|
+
readonly path: "/v1/webhook_endpoints/{webhook_endpoint}";
|
|
1677
|
+
readonly pathParams: readonly ["webhook_endpoint"];
|
|
1678
|
+
readonly queryParams: readonly [];
|
|
1679
|
+
readonly body: false;
|
|
1680
|
+
readonly idempotent: false;
|
|
1681
|
+
readonly auth: true;
|
|
1682
|
+
readonly scope: "webhook_endpoints:write";
|
|
1683
|
+
readonly response: "json";
|
|
1684
|
+
readonly list: false;
|
|
1685
|
+
readonly paginated: false;
|
|
1686
|
+
readonly summary: "Delete a webhook endpoint";
|
|
1687
|
+
};
|
|
1688
|
+
readonly rollWebhookEndpointSecret: {
|
|
1689
|
+
readonly operationId: "rollWebhookEndpointSecret";
|
|
1690
|
+
readonly namespace: "webhookEndpoints";
|
|
1691
|
+
readonly method: "rollSecret";
|
|
1692
|
+
readonly httpMethod: "POST";
|
|
1693
|
+
readonly path: "/v1/webhook_endpoints/{webhook_endpoint}/roll_secret";
|
|
1694
|
+
readonly pathParams: readonly ["webhook_endpoint"];
|
|
1695
|
+
readonly queryParams: readonly [];
|
|
1696
|
+
readonly body: true;
|
|
1697
|
+
readonly idempotent: true;
|
|
1698
|
+
readonly auth: true;
|
|
1699
|
+
readonly scope: "webhook_endpoints:write";
|
|
1700
|
+
readonly response: "json";
|
|
1701
|
+
readonly list: false;
|
|
1702
|
+
readonly paginated: false;
|
|
1703
|
+
readonly summary: "Roll a webhook signing secret";
|
|
1704
|
+
};
|
|
1705
|
+
readonly listEvents: {
|
|
1706
|
+
readonly operationId: "listEvents";
|
|
1707
|
+
readonly namespace: "events";
|
|
1708
|
+
readonly method: "list";
|
|
1709
|
+
readonly httpMethod: "GET";
|
|
1710
|
+
readonly path: "/v1/events";
|
|
1711
|
+
readonly pathParams: readonly [];
|
|
1712
|
+
readonly queryParams: readonly ["limit", "starting_after", "ending_before", "type", "created_gte", "created_lte"];
|
|
1713
|
+
readonly body: false;
|
|
1714
|
+
readonly idempotent: false;
|
|
1715
|
+
readonly auth: true;
|
|
1716
|
+
readonly scope: "events:read";
|
|
1717
|
+
readonly response: "json";
|
|
1718
|
+
readonly list: true;
|
|
1719
|
+
readonly paginated: true;
|
|
1720
|
+
readonly summary: "List events";
|
|
1721
|
+
};
|
|
1722
|
+
readonly retrieveEvent: {
|
|
1723
|
+
readonly operationId: "retrieveEvent";
|
|
1724
|
+
readonly namespace: "events";
|
|
1725
|
+
readonly method: "retrieve";
|
|
1726
|
+
readonly httpMethod: "GET";
|
|
1727
|
+
readonly path: "/v1/events/{event}";
|
|
1728
|
+
readonly pathParams: readonly ["event"];
|
|
1729
|
+
readonly queryParams: readonly [];
|
|
1730
|
+
readonly body: false;
|
|
1731
|
+
readonly idempotent: false;
|
|
1732
|
+
readonly auth: true;
|
|
1733
|
+
readonly scope: "events:read";
|
|
1734
|
+
readonly response: "json";
|
|
1735
|
+
readonly list: false;
|
|
1736
|
+
readonly paginated: false;
|
|
1737
|
+
readonly summary: "Retrieve an event";
|
|
1738
|
+
};
|
|
1739
|
+
readonly createFeedback: {
|
|
1740
|
+
readonly operationId: "createFeedback";
|
|
1741
|
+
readonly namespace: "feedbacks";
|
|
1742
|
+
readonly method: "create";
|
|
1743
|
+
readonly httpMethod: "POST";
|
|
1744
|
+
readonly path: "/v1/feedback";
|
|
1745
|
+
readonly pathParams: readonly [];
|
|
1746
|
+
readonly queryParams: readonly [];
|
|
1747
|
+
readonly body: true;
|
|
1748
|
+
readonly idempotent: true;
|
|
1749
|
+
readonly auth: true;
|
|
1750
|
+
readonly scope: "account:read";
|
|
1751
|
+
readonly response: "json";
|
|
1752
|
+
readonly list: false;
|
|
1753
|
+
readonly paginated: false;
|
|
1754
|
+
readonly summary: "Send feedback";
|
|
1755
|
+
};
|
|
1756
|
+
};
|
|
1757
|
+
export interface OperationSpec {
|
|
1758
|
+
operationId: string;
|
|
1759
|
+
namespace: string;
|
|
1760
|
+
method: string;
|
|
1761
|
+
httpMethod: 'GET' | 'POST' | 'DELETE';
|
|
1762
|
+
path: string;
|
|
1763
|
+
pathParams: readonly string[];
|
|
1764
|
+
queryParams: readonly string[];
|
|
1765
|
+
body: boolean;
|
|
1766
|
+
idempotent: boolean;
|
|
1767
|
+
auth: boolean;
|
|
1768
|
+
scope: string;
|
|
1769
|
+
response: 'json' | 'binary' | 'text';
|
|
1770
|
+
list: boolean;
|
|
1771
|
+
paginated: boolean;
|
|
1772
|
+
summary: string;
|
|
1773
|
+
}
|
|
1774
|
+
export type OperationId = keyof typeof OPERATIONS;
|
|
1775
|
+
/** Argument and result types per operation, for `checkbox.call(operationId, args)` (path params + params, flat). */
|
|
1776
|
+
export interface OperationTypes {
|
|
1777
|
+
createDeviceAuthorization: {
|
|
1778
|
+
args: T.DeviceAuthorizationParams;
|
|
1779
|
+
response: T.DeviceAuthorization;
|
|
1780
|
+
};
|
|
1781
|
+
createDeviceToken: {
|
|
1782
|
+
args: T.CreateDeviceTokenParams;
|
|
1783
|
+
response: T.DeviceToken;
|
|
1784
|
+
};
|
|
1785
|
+
createSetupSession: {
|
|
1786
|
+
args: T.SetupSessionUpdate;
|
|
1787
|
+
response: T.SetupSession;
|
|
1788
|
+
};
|
|
1789
|
+
listSetupSessions: {
|
|
1790
|
+
args: T.ListSetupSessionsParams;
|
|
1791
|
+
response: T.SetupSessionList;
|
|
1792
|
+
};
|
|
1793
|
+
retrieveSetupSession: {
|
|
1794
|
+
args: {
|
|
1795
|
+
setup_session: string;
|
|
1796
|
+
};
|
|
1797
|
+
response: T.SetupSession;
|
|
1798
|
+
};
|
|
1799
|
+
updateSetupSession: {
|
|
1800
|
+
args: {
|
|
1801
|
+
setup_session: string;
|
|
1802
|
+
} & T.SetupSessionUpdate;
|
|
1803
|
+
response: T.SetupSession;
|
|
1804
|
+
};
|
|
1805
|
+
verifySetupSession: {
|
|
1806
|
+
args: {
|
|
1807
|
+
setup_session: string;
|
|
1808
|
+
};
|
|
1809
|
+
response: T.SetupVerification;
|
|
1810
|
+
};
|
|
1811
|
+
completeSetupSession: {
|
|
1812
|
+
args: {
|
|
1813
|
+
setup_session: string;
|
|
1814
|
+
};
|
|
1815
|
+
response: T.SetupSession;
|
|
1816
|
+
};
|
|
1817
|
+
retrieveAccount: {
|
|
1818
|
+
args: Record<string, never>;
|
|
1819
|
+
response: T.Account;
|
|
1820
|
+
};
|
|
1821
|
+
updateAccount: {
|
|
1822
|
+
args: T.UpdateAccountParams;
|
|
1823
|
+
response: T.Account;
|
|
1824
|
+
};
|
|
1825
|
+
listSites: {
|
|
1826
|
+
args: T.ListSitesParams;
|
|
1827
|
+
response: T.SiteList;
|
|
1828
|
+
};
|
|
1829
|
+
createSite: {
|
|
1830
|
+
args: T.CreateSiteParams;
|
|
1831
|
+
response: T.Site;
|
|
1832
|
+
};
|
|
1833
|
+
retrieveSite: {
|
|
1834
|
+
args: {
|
|
1835
|
+
site: string;
|
|
1836
|
+
} & T.RetrieveSiteParams;
|
|
1837
|
+
response: T.Site;
|
|
1838
|
+
};
|
|
1839
|
+
updateSite: {
|
|
1840
|
+
args: {
|
|
1841
|
+
site: string;
|
|
1842
|
+
} & T.UpdateSiteParams;
|
|
1843
|
+
response: T.Site;
|
|
1844
|
+
};
|
|
1845
|
+
deleteSite: {
|
|
1846
|
+
args: {
|
|
1847
|
+
site: string;
|
|
1848
|
+
};
|
|
1849
|
+
response: T.Site;
|
|
1850
|
+
};
|
|
1851
|
+
restoreSite: {
|
|
1852
|
+
args: {
|
|
1853
|
+
site: string;
|
|
1854
|
+
};
|
|
1855
|
+
response: T.Site;
|
|
1856
|
+
};
|
|
1857
|
+
connectBillingPlatform: {
|
|
1858
|
+
args: {
|
|
1859
|
+
site: string;
|
|
1860
|
+
} & T.ConnectBillingPlatformParams;
|
|
1861
|
+
response: T.Integration;
|
|
1862
|
+
};
|
|
1863
|
+
retrieveDomainVerification: {
|
|
1864
|
+
args: {
|
|
1865
|
+
site: string;
|
|
1866
|
+
};
|
|
1867
|
+
response: T.DomainVerification;
|
|
1868
|
+
};
|
|
1869
|
+
createDomainVerification: {
|
|
1870
|
+
args: {
|
|
1871
|
+
site: string;
|
|
1872
|
+
} & T.CreateDomainVerificationParams;
|
|
1873
|
+
response: T.DomainVerification;
|
|
1874
|
+
};
|
|
1875
|
+
checkDomainVerification: {
|
|
1876
|
+
args: {
|
|
1877
|
+
site: string;
|
|
1878
|
+
};
|
|
1879
|
+
response: T.DomainVerification;
|
|
1880
|
+
};
|
|
1881
|
+
createScan: {
|
|
1882
|
+
args: {
|
|
1883
|
+
site: string;
|
|
1884
|
+
} & T.CreateScanParams;
|
|
1885
|
+
response: T.Scan;
|
|
1886
|
+
};
|
|
1887
|
+
listScans: {
|
|
1888
|
+
args: T.ListScansParams;
|
|
1889
|
+
response: T.ScanList;
|
|
1890
|
+
};
|
|
1891
|
+
retrieveScan: {
|
|
1892
|
+
args: {
|
|
1893
|
+
scan: string;
|
|
1894
|
+
};
|
|
1895
|
+
response: T.Scan;
|
|
1896
|
+
};
|
|
1897
|
+
createEvaluation: {
|
|
1898
|
+
args: {
|
|
1899
|
+
site: string;
|
|
1900
|
+
} & T.CreateEvaluationParams;
|
|
1901
|
+
response: T.Evaluation;
|
|
1902
|
+
};
|
|
1903
|
+
listEvaluations: {
|
|
1904
|
+
args: T.ListEvaluationsParams;
|
|
1905
|
+
response: T.EvaluationList;
|
|
1906
|
+
};
|
|
1907
|
+
retrieveEvaluation: {
|
|
1908
|
+
args: {
|
|
1909
|
+
evaluation: string;
|
|
1910
|
+
};
|
|
1911
|
+
response: T.Evaluation;
|
|
1912
|
+
};
|
|
1913
|
+
retrieveLatestEvaluation: {
|
|
1914
|
+
args: {
|
|
1915
|
+
site: string;
|
|
1916
|
+
};
|
|
1917
|
+
response: T.Evaluation;
|
|
1918
|
+
};
|
|
1919
|
+
listFindings: {
|
|
1920
|
+
args: T.ListFindingsParams;
|
|
1921
|
+
response: T.FindingList;
|
|
1922
|
+
};
|
|
1923
|
+
retrieveFinding: {
|
|
1924
|
+
args: {
|
|
1925
|
+
finding: string;
|
|
1926
|
+
};
|
|
1927
|
+
response: T.Finding;
|
|
1928
|
+
};
|
|
1929
|
+
updateFinding: {
|
|
1930
|
+
args: {
|
|
1931
|
+
finding: string;
|
|
1932
|
+
} & T.UpdateFindingParams;
|
|
1933
|
+
response: T.Finding;
|
|
1934
|
+
};
|
|
1935
|
+
retrieveCompliancePlan: {
|
|
1936
|
+
args: {
|
|
1937
|
+
site: string;
|
|
1938
|
+
};
|
|
1939
|
+
response: T.CompliancePlan;
|
|
1940
|
+
};
|
|
1941
|
+
retrieveTask: {
|
|
1942
|
+
args: {
|
|
1943
|
+
task: string;
|
|
1944
|
+
};
|
|
1945
|
+
response: T.Task;
|
|
1946
|
+
};
|
|
1947
|
+
updateTask: {
|
|
1948
|
+
args: {
|
|
1949
|
+
task: string;
|
|
1950
|
+
} & T.UpdateTaskParams;
|
|
1951
|
+
response: T.Task;
|
|
1952
|
+
};
|
|
1953
|
+
answerTask: {
|
|
1954
|
+
args: {
|
|
1955
|
+
task: string;
|
|
1956
|
+
} & T.AnswerTaskParams;
|
|
1957
|
+
response: T.Task;
|
|
1958
|
+
};
|
|
1959
|
+
verifyTask: {
|
|
1960
|
+
args: {
|
|
1961
|
+
task: string;
|
|
1962
|
+
} & T.VerifyTaskRequestParams;
|
|
1963
|
+
response: T.Verification;
|
|
1964
|
+
};
|
|
1965
|
+
verifySite: {
|
|
1966
|
+
args: {
|
|
1967
|
+
site: string;
|
|
1968
|
+
} & T.VerifySiteParams;
|
|
1969
|
+
response: T.Verification;
|
|
1970
|
+
};
|
|
1971
|
+
retrieveVerification: {
|
|
1972
|
+
args: {
|
|
1973
|
+
verification: string;
|
|
1974
|
+
} & T.RetrieveVerificationParams;
|
|
1975
|
+
response: T.Verification;
|
|
1976
|
+
};
|
|
1977
|
+
listVerifications: {
|
|
1978
|
+
args: {
|
|
1979
|
+
site: string;
|
|
1980
|
+
} & T.ListVerificationsParams;
|
|
1981
|
+
response: T.VerificationList;
|
|
1982
|
+
};
|
|
1983
|
+
retrieveFindingFix: {
|
|
1984
|
+
args: {
|
|
1985
|
+
finding: string;
|
|
1986
|
+
} & T.RetrieveFindingFixParams;
|
|
1987
|
+
response: T.Fix;
|
|
1988
|
+
};
|
|
1989
|
+
listSiteFixes: {
|
|
1990
|
+
args: {
|
|
1991
|
+
site: string;
|
|
1992
|
+
} & T.ListSiteFixesParams;
|
|
1993
|
+
response: T.FixList;
|
|
1994
|
+
};
|
|
1995
|
+
listEvidence: {
|
|
1996
|
+
args: T.ListEvidenceParams;
|
|
1997
|
+
response: T.EvidenceList;
|
|
1998
|
+
};
|
|
1999
|
+
retrieveEvidence: {
|
|
2000
|
+
args: {
|
|
2001
|
+
evidence: string;
|
|
2002
|
+
};
|
|
2003
|
+
response: T.Evidence;
|
|
2004
|
+
};
|
|
2005
|
+
downloadEvidenceContent: {
|
|
2006
|
+
args: {
|
|
2007
|
+
evidence: string;
|
|
2008
|
+
};
|
|
2009
|
+
response: T.CheckboxFile;
|
|
2010
|
+
};
|
|
2011
|
+
verifyEvidenceChain: {
|
|
2012
|
+
args: {
|
|
2013
|
+
site: string;
|
|
2014
|
+
} & T.VerifyEvidenceChainParams;
|
|
2015
|
+
response: T.EvidenceChainVerification;
|
|
2016
|
+
};
|
|
2017
|
+
listCertificates: {
|
|
2018
|
+
args: T.ListCertificatesParams;
|
|
2019
|
+
response: T.CertificateList;
|
|
2020
|
+
};
|
|
2021
|
+
retrieveCertificate: {
|
|
2022
|
+
args: {
|
|
2023
|
+
certificate: string;
|
|
2024
|
+
};
|
|
2025
|
+
response: T.Certificate;
|
|
2026
|
+
};
|
|
2027
|
+
createCertificate: {
|
|
2028
|
+
args: {
|
|
2029
|
+
site: string;
|
|
2030
|
+
} & T.CreateCertificateParams;
|
|
2031
|
+
response: T.Certificate;
|
|
2032
|
+
};
|
|
2033
|
+
revokeCertificate: {
|
|
2034
|
+
args: {
|
|
2035
|
+
certificate: string;
|
|
2036
|
+
} & T.RevokeCertificateParams;
|
|
2037
|
+
response: T.Certificate;
|
|
2038
|
+
};
|
|
2039
|
+
retrieveNoticeSettings: {
|
|
2040
|
+
args: {
|
|
2041
|
+
site: string;
|
|
2042
|
+
};
|
|
2043
|
+
response: T.NoticeSettings;
|
|
2044
|
+
};
|
|
2045
|
+
updateNoticeSettings: {
|
|
2046
|
+
args: {
|
|
2047
|
+
site: string;
|
|
2048
|
+
} & T.UpdateNoticeSettingsParams;
|
|
2049
|
+
response: T.NoticeSettings;
|
|
2050
|
+
};
|
|
2051
|
+
listDueNotices: {
|
|
2052
|
+
args: T.ListDueNoticesParams;
|
|
2053
|
+
response: T.DueNoticeList;
|
|
2054
|
+
};
|
|
2055
|
+
listNoticeTemplates: {
|
|
2056
|
+
args: T.ListNoticeTemplatesParams;
|
|
2057
|
+
response: T.NoticeTemplateList;
|
|
2058
|
+
};
|
|
2059
|
+
checkNoticeTemplate: {
|
|
2060
|
+
args: T.CheckNoticeTemplateParams;
|
|
2061
|
+
response: T.NoticeTemplateCheck;
|
|
2062
|
+
};
|
|
2063
|
+
retrieveDueNotice: {
|
|
2064
|
+
args: {
|
|
2065
|
+
notice: string;
|
|
2066
|
+
};
|
|
2067
|
+
response: T.DueNotice;
|
|
2068
|
+
};
|
|
2069
|
+
markNoticeSent: {
|
|
2070
|
+
args: {
|
|
2071
|
+
notice: string;
|
|
2072
|
+
} & T.MarkNoticeSentParams;
|
|
2073
|
+
response: T.DueNotice;
|
|
2074
|
+
};
|
|
2075
|
+
markNoticeMissed: {
|
|
2076
|
+
args: {
|
|
2077
|
+
notice: string;
|
|
2078
|
+
} & T.MarkNoticeMissedParams;
|
|
2079
|
+
response: T.DueNotice;
|
|
2080
|
+
};
|
|
2081
|
+
listLawUpdates: {
|
|
2082
|
+
args: T.ListLawUpdatesParams;
|
|
2083
|
+
response: T.LawUpdateList;
|
|
2084
|
+
};
|
|
2085
|
+
retrieveLawUpdate: {
|
|
2086
|
+
args: {
|
|
2087
|
+
law_update: string;
|
|
2088
|
+
};
|
|
2089
|
+
response: T.LawUpdate;
|
|
2090
|
+
};
|
|
2091
|
+
checkDisclosure: {
|
|
2092
|
+
args: T.DisclosureCheckParams;
|
|
2093
|
+
response: T.DisclosureCheckResult;
|
|
2094
|
+
};
|
|
2095
|
+
checkStripeCheckoutSession: {
|
|
2096
|
+
args: T.StripeCheckParams;
|
|
2097
|
+
response: T.StripeCheckoutSessionCheckResult;
|
|
2098
|
+
};
|
|
2099
|
+
checkStripePaymentLink: {
|
|
2100
|
+
args: T.StripeCheckParams;
|
|
2101
|
+
response: T.StripePaymentLinkCheckResult;
|
|
2102
|
+
};
|
|
2103
|
+
checkEmail: {
|
|
2104
|
+
args: T.EmailCheckParams;
|
|
2105
|
+
response: T.EmailCheckResult;
|
|
2106
|
+
};
|
|
2107
|
+
checkPage: {
|
|
2108
|
+
args: T.PageCheckParams;
|
|
2109
|
+
response: T.PageCheckResult;
|
|
2110
|
+
};
|
|
2111
|
+
checkNoticeSchedule: {
|
|
2112
|
+
args: T.NoticeScheduleParams;
|
|
2113
|
+
response: T.NoticeScheduleResult;
|
|
2114
|
+
};
|
|
2115
|
+
getElementsBundle: {
|
|
2116
|
+
args: Record<string, never>;
|
|
2117
|
+
response: string;
|
|
2118
|
+
};
|
|
2119
|
+
getElementsManifest: {
|
|
2120
|
+
args: Record<string, never>;
|
|
2121
|
+
response: T.ElementsManifest;
|
|
2122
|
+
};
|
|
2123
|
+
getElementsBundleVersion: {
|
|
2124
|
+
args: {
|
|
2125
|
+
version: string;
|
|
2126
|
+
};
|
|
2127
|
+
response: string;
|
|
2128
|
+
};
|
|
2129
|
+
createDisclosure: {
|
|
2130
|
+
args: T.DisclosureCreateParams;
|
|
2131
|
+
response: T.Disclosure;
|
|
2132
|
+
};
|
|
2133
|
+
retrieveDisclosure: {
|
|
2134
|
+
args: {
|
|
2135
|
+
disclosure: string;
|
|
2136
|
+
};
|
|
2137
|
+
response: T.Disclosure;
|
|
2138
|
+
};
|
|
2139
|
+
createConsent: {
|
|
2140
|
+
args: T.ConsentCreateParams;
|
|
2141
|
+
response: T.Consent;
|
|
2142
|
+
};
|
|
2143
|
+
listConsents: {
|
|
2144
|
+
args: T.ListConsentsParams;
|
|
2145
|
+
response: T.ConsentList;
|
|
2146
|
+
};
|
|
2147
|
+
retrieveConsent: {
|
|
2148
|
+
args: {
|
|
2149
|
+
consent: string;
|
|
2150
|
+
};
|
|
2151
|
+
response: T.Consent;
|
|
2152
|
+
};
|
|
2153
|
+
updateConsent: {
|
|
2154
|
+
args: {
|
|
2155
|
+
consent: string;
|
|
2156
|
+
} & T.ConsentUpdateParams;
|
|
2157
|
+
response: T.Consent;
|
|
2158
|
+
};
|
|
2159
|
+
createReceiptToken: {
|
|
2160
|
+
args: T.ReceiptTokenCreateParams;
|
|
2161
|
+
response: T.ReceiptToken;
|
|
2162
|
+
};
|
|
2163
|
+
createReceipt: {
|
|
2164
|
+
args: T.ReceiptCreateParams;
|
|
2165
|
+
response: T.Receipt;
|
|
2166
|
+
};
|
|
2167
|
+
listReceipts: {
|
|
2168
|
+
args: T.ListReceiptsParams;
|
|
2169
|
+
response: T.ReceiptList;
|
|
2170
|
+
};
|
|
2171
|
+
eraseReceipts: {
|
|
2172
|
+
args: T.ReceiptErasureParams;
|
|
2173
|
+
response: T.ReceiptErasure;
|
|
2174
|
+
};
|
|
2175
|
+
retrieveReceipt: {
|
|
2176
|
+
args: {
|
|
2177
|
+
receipt: string;
|
|
2178
|
+
};
|
|
2179
|
+
response: T.Receipt;
|
|
2180
|
+
};
|
|
2181
|
+
renderReceipt: {
|
|
2182
|
+
args: {
|
|
2183
|
+
receipt: string;
|
|
2184
|
+
};
|
|
2185
|
+
response: T.CheckboxFile;
|
|
2186
|
+
};
|
|
2187
|
+
verifyReceipt: {
|
|
2188
|
+
args: {
|
|
2189
|
+
receipt: string;
|
|
2190
|
+
};
|
|
2191
|
+
response: T.ReceiptVerification;
|
|
2192
|
+
};
|
|
2193
|
+
exportReceipt: {
|
|
2194
|
+
args: {
|
|
2195
|
+
receipt: string;
|
|
2196
|
+
};
|
|
2197
|
+
response: T.CheckboxFile;
|
|
2198
|
+
};
|
|
2199
|
+
retrieveReceiptSettings: {
|
|
2200
|
+
args: Record<string, never>;
|
|
2201
|
+
response: T.ReceiptSettings;
|
|
2202
|
+
};
|
|
2203
|
+
updateReceiptSettings: {
|
|
2204
|
+
args: T.ReceiptSettingsUpdateParams;
|
|
2205
|
+
response: T.ReceiptSettings;
|
|
2206
|
+
};
|
|
2207
|
+
createTestCredential: {
|
|
2208
|
+
args: {
|
|
2209
|
+
site: string;
|
|
2210
|
+
} & T.CreateTestCredentialParams;
|
|
2211
|
+
response: T.TestCredential;
|
|
2212
|
+
};
|
|
2213
|
+
listTestCredentials: {
|
|
2214
|
+
args: {
|
|
2215
|
+
site: string;
|
|
2216
|
+
};
|
|
2217
|
+
response: T.TestCredentialList;
|
|
2218
|
+
};
|
|
2219
|
+
deleteTestCredential: {
|
|
2220
|
+
args: {
|
|
2221
|
+
site: string;
|
|
2222
|
+
test_credential: string;
|
|
2223
|
+
};
|
|
2224
|
+
response: T.DeletedTestCredential;
|
|
2225
|
+
};
|
|
2226
|
+
createStripeCheckoutConfig: {
|
|
2227
|
+
args: {
|
|
2228
|
+
site: string;
|
|
2229
|
+
} & T.CreateStripeCheckoutConfigParams;
|
|
2230
|
+
response: T.StripeCheckoutConfig;
|
|
2231
|
+
};
|
|
2232
|
+
listStripeCheckoutConfigs: {
|
|
2233
|
+
args: {
|
|
2234
|
+
site: string;
|
|
2235
|
+
} & T.ListStripeCheckoutConfigsParams;
|
|
2236
|
+
response: T.StripeCheckoutConfigList;
|
|
2237
|
+
};
|
|
2238
|
+
retrieveStripeCheckoutConfig: {
|
|
2239
|
+
args: {
|
|
2240
|
+
stripe_checkout_config: string;
|
|
2241
|
+
};
|
|
2242
|
+
response: T.StripeCheckoutConfig;
|
|
2243
|
+
};
|
|
2244
|
+
deleteStripeCheckoutConfig: {
|
|
2245
|
+
args: {
|
|
2246
|
+
stripe_checkout_config: string;
|
|
2247
|
+
};
|
|
2248
|
+
response: T.DeletedStripeCheckoutConfig;
|
|
2249
|
+
};
|
|
2250
|
+
createTestRun: {
|
|
2251
|
+
args: {
|
|
2252
|
+
site: string;
|
|
2253
|
+
} & T.CreateTestRunParams;
|
|
2254
|
+
response: T.TestRun;
|
|
2255
|
+
};
|
|
2256
|
+
listTestRuns: {
|
|
2257
|
+
args: {
|
|
2258
|
+
site: string;
|
|
2259
|
+
} & T.ListTestRunsParams;
|
|
2260
|
+
response: T.TestRunList;
|
|
2261
|
+
};
|
|
2262
|
+
retrieveTestRun: {
|
|
2263
|
+
args: {
|
|
2264
|
+
test_run: string;
|
|
2265
|
+
};
|
|
2266
|
+
response: T.TestRun;
|
|
2267
|
+
};
|
|
2268
|
+
cancelTestRun: {
|
|
2269
|
+
args: {
|
|
2270
|
+
test_run: string;
|
|
2271
|
+
};
|
|
2272
|
+
response: T.TestRun;
|
|
2273
|
+
};
|
|
2274
|
+
createWebhookEndpoint: {
|
|
2275
|
+
args: T.CreateWebhookEndpointParams;
|
|
2276
|
+
response: T.WebhookEndpoint;
|
|
2277
|
+
};
|
|
2278
|
+
listWebhookEndpoints: {
|
|
2279
|
+
args: T.ListWebhookEndpointsParams;
|
|
2280
|
+
response: T.WebhookEndpointList;
|
|
2281
|
+
};
|
|
2282
|
+
retrieveWebhookEndpoint: {
|
|
2283
|
+
args: {
|
|
2284
|
+
webhook_endpoint: string;
|
|
2285
|
+
};
|
|
2286
|
+
response: T.WebhookEndpoint;
|
|
2287
|
+
};
|
|
2288
|
+
updateWebhookEndpoint: {
|
|
2289
|
+
args: {
|
|
2290
|
+
webhook_endpoint: string;
|
|
2291
|
+
} & T.UpdateWebhookEndpointParams;
|
|
2292
|
+
response: T.WebhookEndpoint;
|
|
2293
|
+
};
|
|
2294
|
+
deleteWebhookEndpoint: {
|
|
2295
|
+
args: {
|
|
2296
|
+
webhook_endpoint: string;
|
|
2297
|
+
};
|
|
2298
|
+
response: T.DeletedWebhookEndpoint;
|
|
2299
|
+
};
|
|
2300
|
+
rollWebhookEndpointSecret: {
|
|
2301
|
+
args: {
|
|
2302
|
+
webhook_endpoint: string;
|
|
2303
|
+
} & T.RollWebhookEndpointSecretParams;
|
|
2304
|
+
response: T.WebhookEndpoint;
|
|
2305
|
+
};
|
|
2306
|
+
listEvents: {
|
|
2307
|
+
args: T.ListEventsParams;
|
|
2308
|
+
response: T.EventList;
|
|
2309
|
+
};
|
|
2310
|
+
retrieveEvent: {
|
|
2311
|
+
args: {
|
|
2312
|
+
event: string;
|
|
2313
|
+
};
|
|
2314
|
+
response: T.Event;
|
|
2315
|
+
};
|
|
2316
|
+
createFeedback: {
|
|
2317
|
+
args: T.FeedbackParams;
|
|
2318
|
+
response: T.Feedback;
|
|
2319
|
+
};
|
|
2320
|
+
}
|
|
2321
|
+
/** `checkbox.device` */
|
|
2322
|
+
export declare class DeviceResource extends Resource {
|
|
2323
|
+
/**
|
|
2324
|
+
* Start a device login (setup_checkbox).
|
|
2325
|
+
*
|
|
2326
|
+
* Public (no API key). Returns a device_code (keep it private), a user_code and verification_uri_complete. Show the human ONE line ("Open <verification_uri_complete> and click Approve"), open it in their browser when possible, then poll createDeviceToken every `interval` seconds. New users sign up on that page with an email link or GitHub / Google; nothing is created until they click Approve.
|
|
2327
|
+
*
|
|
2328
|
+
* @see POST /v1/device/authorize (operation `createDeviceAuthorization`, scope `none`)
|
|
2329
|
+
*/
|
|
2330
|
+
authorize(params?: T.DeviceAuthorizationParams, options?: RequestOptions): Promise<T.DeviceAuthorization>;
|
|
2331
|
+
/**
|
|
2332
|
+
* Poll a device login for its keys.
|
|
2333
|
+
*
|
|
2334
|
+
* Public (no API key). Poll every `interval` seconds with the device_code. Errors (stable codes): authorization_pending (keep polling), slow_down (add 5 s), access_denied (the human clicked Deny: stop), expired_token (start again). On approval returns the keys exactly once, the setup session and the next action.
|
|
2335
|
+
*
|
|
2336
|
+
* @see POST /v1/device/token (operation `createDeviceToken`, scope `none`)
|
|
2337
|
+
*/
|
|
2338
|
+
token(params: T.CreateDeviceTokenParams, options?: RequestOptions): Promise<T.DeviceToken>;
|
|
2339
|
+
}
|
|
2340
|
+
/** `checkbox.setupSessions` */
|
|
2341
|
+
export declare class SetupSessionsResource extends Resource {
|
|
2342
|
+
/**
|
|
2343
|
+
* Start a setup session (agents that already have a key).
|
|
2344
|
+
*
|
|
2345
|
+
* For agents that already hold a secret key (no device login): starts a setup session for a project with the same fields as updateSetupSession. `checkbox init` creates the session during the device login instead.
|
|
2346
|
+
*
|
|
2347
|
+
* @see POST /v1/setup_sessions (operation `createSetupSession`, scope `setup_sessions:write`)
|
|
2348
|
+
*/
|
|
2349
|
+
create(params?: T.SetupSessionUpdate, options?: RequestOptions): Promise<T.SetupSession>;
|
|
2350
|
+
/**
|
|
2351
|
+
* List setup sessions.
|
|
2352
|
+
*
|
|
2353
|
+
* Setup sessions of the account, newest first. Test keys see the sessions created in test mode (device login, test keys); live keys see all.
|
|
2354
|
+
*
|
|
2355
|
+
* @see GET /v1/setup_sessions (operation `listSetupSessions`, scope `setup_sessions:read`)
|
|
2356
|
+
*/
|
|
2357
|
+
list(params?: T.ListSetupSessionsParams, options?: RequestOptions): ApiListPromise<T.SetupSession>;
|
|
2358
|
+
/**
|
|
2359
|
+
* Retrieve a setup session.
|
|
2360
|
+
*
|
|
2361
|
+
* The setup checklist with one next_action. Agents: do next_action, then call verifySetupSession; stop when next_action.type is "done".
|
|
2362
|
+
*
|
|
2363
|
+
* @param setupSession Unique identifier of the setup session (setup_…).
|
|
2364
|
+
* @see GET /v1/setup_sessions/{setup_session} (operation `retrieveSetupSession`, scope `setup_sessions:read`)
|
|
2365
|
+
*/
|
|
2366
|
+
retrieve(setupSession: string, options?: RequestOptions): Promise<T.SetupSession>;
|
|
2367
|
+
/**
|
|
2368
|
+
* Report what the agent learned or changed.
|
|
2369
|
+
*
|
|
2370
|
+
* Reports project facts and business URLs: site_url (creates the test-mode site), checkout_url, terms_url / refund_url / cancellation_url / privacy_url (fetched now, stored as evidence and checked against the law), plans, where checkout code lives, snippet_installed_in, env_written. Returns the updated checklist.
|
|
2371
|
+
*
|
|
2372
|
+
* @param setupSession Unique identifier of the setup session (setup_…).
|
|
2373
|
+
* @see POST /v1/setup_sessions/{setup_session} (operation `updateSetupSession`, scope `setup_sessions:write`)
|
|
2374
|
+
*/
|
|
2375
|
+
update(setupSession: string, params?: T.SetupSessionUpdate, options?: RequestOptions): Promise<T.SetupSession>;
|
|
2376
|
+
/**
|
|
2377
|
+
* Re-check the site now.
|
|
2378
|
+
*
|
|
2379
|
+
* Loads the site (is the snippet live? which policy links does it have?), re-fetches the Terms and policies, re-evaluates compliance and queues the first synthetic-shopper scan. Call it after every change the agent made (and after deploying). Returns what was seen plus the updated session.
|
|
2380
|
+
*
|
|
2381
|
+
* @param setupSession Unique identifier of the setup session (setup_…).
|
|
2382
|
+
* @see POST /v1/setup_sessions/{setup_session}/verify (operation `verifySetupSession`, scope `setup_sessions:write`)
|
|
2383
|
+
*/
|
|
2384
|
+
verify(setupSession: string, options?: RequestOptions): Promise<T.SetupVerification>;
|
|
2385
|
+
/**
|
|
2386
|
+
* Finish the setup and notify the human.
|
|
2387
|
+
*
|
|
2388
|
+
* Marks the setup finished and emails the person who approved it a summary ("<agent> set up Checkbox for <domain>") with what was created, what is still open and a review link. Idempotent: the email is sent once. Checks keep running afterwards.
|
|
2389
|
+
*
|
|
2390
|
+
* @param setupSession Unique identifier of the setup session (setup_…).
|
|
2391
|
+
* @see POST /v1/setup_sessions/{setup_session}/complete (operation `completeSetupSession`, scope `setup_sessions:write`)
|
|
2392
|
+
*/
|
|
2393
|
+
complete(setupSession: string, options?: RequestOptions): Promise<T.SetupSession>;
|
|
2394
|
+
}
|
|
2395
|
+
/** `checkbox.account` */
|
|
2396
|
+
export declare class AccountResource extends Resource {
|
|
2397
|
+
/**
|
|
2398
|
+
* Retrieve the account.
|
|
2399
|
+
*
|
|
2400
|
+
* Returns the account behind the key: test or live mode, whether live mode is activated, fair-use limits, the publishable key, and `next_action`. Call this first to check a key.
|
|
2401
|
+
*
|
|
2402
|
+
* @see GET /v1/account (operation `retrieveAccount`, scope `account:read`)
|
|
2403
|
+
*/
|
|
2404
|
+
retrieve(options?: RequestOptions): Promise<T.Account>;
|
|
2405
|
+
/**
|
|
2406
|
+
* Update the account.
|
|
2407
|
+
*
|
|
2408
|
+
* Pins the account to an API version (requests without a Checkbox-Version header use it). Known versions: 2026-10-30.
|
|
2409
|
+
*
|
|
2410
|
+
* @see POST /v1/account (operation `updateAccount`, scope `account:write`)
|
|
2411
|
+
*/
|
|
2412
|
+
update(params?: T.UpdateAccountParams, options?: RequestOptions): Promise<T.Account>;
|
|
2413
|
+
}
|
|
2414
|
+
/** `checkbox.sites` */
|
|
2415
|
+
export declare class SitesResource extends Resource {
|
|
2416
|
+
/**
|
|
2417
|
+
* List sites.
|
|
2418
|
+
*
|
|
2419
|
+
* Returns the sites of the account in the current mode, newest first. Archived sites are included only with archived=true.
|
|
2420
|
+
*
|
|
2421
|
+
* @see GET /v1/sites (operation `listSites`, scope `sites:read`)
|
|
2422
|
+
*/
|
|
2423
|
+
list(params?: T.ListSitesParams, options?: RequestOptions): ApiListPromise<T.Site>;
|
|
2424
|
+
/**
|
|
2425
|
+
* Create a site.
|
|
2426
|
+
*
|
|
2427
|
+
* Registers a subscription business. Only `url` is required; Checkbox derives the name and uses the URL as the checkout entry page. The response includes `install` (snippet tag, inbound email, platform webhook URLs). Next: install the snippet, then run createScan (or let `checkbox init` do both). In live mode before activation, monitoring is held until a domain is verified; in test mode, monitoring of a host that is not localhost or a domain the account verified is held the same way, and on-demand scans of such hosts are limited to a few a day.
|
|
2428
|
+
*
|
|
2429
|
+
* @see POST /v1/sites (operation `createSite`, scope `sites:write`)
|
|
2430
|
+
*/
|
|
2431
|
+
create(params: T.CreateSiteParams, options?: RequestOptions): Promise<T.Site>;
|
|
2432
|
+
/**
|
|
2433
|
+
* Retrieve a site.
|
|
2434
|
+
*
|
|
2435
|
+
* Returns a site with its latest compliance verdict (score, insurable) and install details.
|
|
2436
|
+
*
|
|
2437
|
+
* @param site Unique identifier of the site (site_…).
|
|
2438
|
+
* @see GET /v1/sites/{site} (operation `retrieveSite`, scope `sites:read`)
|
|
2439
|
+
*/
|
|
2440
|
+
retrieve(site: string, params?: T.RetrieveSiteParams, options?: RequestOptions): Promise<T.Site>;
|
|
2441
|
+
/**
|
|
2442
|
+
* Update a site.
|
|
2443
|
+
*
|
|
2444
|
+
* Updates the given fields; omitted fields keep their values. Changing `url` to another domain forgets the domain verification and ends the active certificate.
|
|
2445
|
+
*
|
|
2446
|
+
* @param site Unique identifier of the site (site_…).
|
|
2447
|
+
* @see POST /v1/sites/{site} (operation `updateSite`, scope `sites:write`)
|
|
2448
|
+
*/
|
|
2449
|
+
update(site: string, params?: T.UpdateSiteParams, options?: RequestOptions): Promise<T.Site>;
|
|
2450
|
+
/**
|
|
2451
|
+
* Archive a site.
|
|
2452
|
+
*
|
|
2453
|
+
* Archives (soft-deletes) the site: monitoring stops and it disappears from lists, but evidence and findings are retained for the warranty. Undo with restoreSite.
|
|
2454
|
+
*
|
|
2455
|
+
* @param site Unique identifier of the site (site_…).
|
|
2456
|
+
* @see DELETE /v1/sites/{site} (operation `deleteSite`, scope `sites:write`)
|
|
2457
|
+
*/
|
|
2458
|
+
del(site: string, options?: RequestOptions): Promise<T.Site>;
|
|
2459
|
+
/** Alias of `del()`. */
|
|
2460
|
+
delete(site: string, options?: RequestOptions): Promise<T.Site>;
|
|
2461
|
+
/**
|
|
2462
|
+
* Restore an archived site.
|
|
2463
|
+
*
|
|
2464
|
+
* Un-archives a site (counts against the fair-use site limit again).
|
|
2465
|
+
*
|
|
2466
|
+
* @param site Unique identifier of the site (site_…).
|
|
2467
|
+
* @see POST /v1/sites/{site}/restore (operation `restoreSite`, scope `sites:write`)
|
|
2468
|
+
*/
|
|
2469
|
+
restore(site: string, options?: RequestOptions): Promise<T.Site>;
|
|
2470
|
+
/**
|
|
2471
|
+
* Connect a billing platform.
|
|
2472
|
+
*
|
|
2473
|
+
* Connects the site's billing platform with read-only credentials (a Stripe restricted key, a Recharge token or a Shopify Admin API token), so Checkbox reads the customer-portal and reminder settings. Works for test-mode sites too (use an rk_test_ key). The credentials are validated by reading the settings once and stored encrypted. Pilot fix: this used to be possible only in the dashboard, which could not open test-mode sites.
|
|
2474
|
+
*
|
|
2475
|
+
* @param site Unique identifier of the site (site_…).
|
|
2476
|
+
* @see POST /v1/sites/{site}/integrations (operation `connectBillingPlatform`, scope `sites:write`)
|
|
2477
|
+
*/
|
|
2478
|
+
connectBillingPlatform(site: string, params: T.ConnectBillingPlatformParams, options?: RequestOptions): Promise<T.Integration>;
|
|
2479
|
+
/**
|
|
2480
|
+
* Re-check the whole site now.
|
|
2481
|
+
*
|
|
2482
|
+
* Re-fetches the registered policies, pre-checks the checkout, re-evaluates and queues a scan. Use it for the first check after setup, or after applying several tasks. Pass ?wait=30 to long-poll; then get the plan (retrieveCompliancePlan).
|
|
2483
|
+
*
|
|
2484
|
+
* @param site Unique identifier of the site (site_…).
|
|
2485
|
+
* @see POST /v1/sites/{site}/verify (operation `verifySite`, scope `compliance_plans:write`)
|
|
2486
|
+
*/
|
|
2487
|
+
verify(site: string, params?: T.VerifySiteParams, options?: RequestOptions): Promise<T.Verification>;
|
|
2488
|
+
}
|
|
2489
|
+
/** `checkbox.domainVerifications` */
|
|
2490
|
+
export declare class DomainVerificationsResource extends Resource {
|
|
2491
|
+
/**
|
|
2492
|
+
* Retrieve domain verification.
|
|
2493
|
+
*
|
|
2494
|
+
* Status of the site domain verification, with the DNS record / file to publish.
|
|
2495
|
+
*
|
|
2496
|
+
* @param site Unique identifier of the site (site_…).
|
|
2497
|
+
* @see GET /v1/sites/{site}/domain_verification (operation `retrieveDomainVerification`, scope `sites:read`)
|
|
2498
|
+
*/
|
|
2499
|
+
retrieve(site: string, options?: RequestOptions): Promise<T.DomainVerification>;
|
|
2500
|
+
/**
|
|
2501
|
+
* Start domain verification.
|
|
2502
|
+
*
|
|
2503
|
+
* Starts verification of the site domain and returns a DNS TXT record and a /.well-known file; publishing either proves control. Then call checkDomainVerification. Verifying a live-mode site activates live mode for the account (instant, self-serve).
|
|
2504
|
+
*
|
|
2505
|
+
* @param site Unique identifier of the site (site_…).
|
|
2506
|
+
* @see POST /v1/sites/{site}/domain_verification (operation `createDomainVerification`, scope `sites:write`)
|
|
2507
|
+
*/
|
|
2508
|
+
create(site: string, params?: T.CreateDomainVerificationParams, options?: RequestOptions): Promise<T.DomainVerification>;
|
|
2509
|
+
/**
|
|
2510
|
+
* Check domain verification now.
|
|
2511
|
+
*
|
|
2512
|
+
* Looks for the DNS TXT record and the /.well-known file now. On success in live mode, the account is activated and held monitoring starts.
|
|
2513
|
+
*
|
|
2514
|
+
* @param site Unique identifier of the site (site_…).
|
|
2515
|
+
* @see POST /v1/sites/{site}/domain_verification/check (operation `checkDomainVerification`, scope `sites:write`)
|
|
2516
|
+
*/
|
|
2517
|
+
check(site: string, options?: RequestOptions): Promise<T.DomainVerification>;
|
|
2518
|
+
}
|
|
2519
|
+
/** `checkbox.scans` */
|
|
2520
|
+
export declare class ScansResource extends Resource {
|
|
2521
|
+
/**
|
|
2522
|
+
* Run a scan.
|
|
2523
|
+
*
|
|
2524
|
+
* Queues a synthetic-shopper scan of the site. Poll retrieveScan (or wait for the scan.completed webhook); a scan takes 1-3 minutes. When it completes, the evaluation and findings are updated. In live mode the account must be activated.
|
|
2525
|
+
*
|
|
2526
|
+
* @param site Unique identifier of the site (site_…).
|
|
2527
|
+
* @see POST /v1/sites/{site}/scans (operation `createScan`, scope `scans:write`, live mode needs an activated account)
|
|
2528
|
+
*/
|
|
2529
|
+
create(site: string, params?: T.CreateScanParams, options?: RequestOptions): Promise<T.Scan>;
|
|
2530
|
+
/**
|
|
2531
|
+
* List scans.
|
|
2532
|
+
*
|
|
2533
|
+
* Scans newest first, optionally for one site.
|
|
2534
|
+
*
|
|
2535
|
+
* @see GET /v1/scans (operation `listScans`, scope `scans:read`)
|
|
2536
|
+
*/
|
|
2537
|
+
list(params?: T.ListScansParams, options?: RequestOptions): ApiListPromise<T.Scan>;
|
|
2538
|
+
/**
|
|
2539
|
+
* Retrieve a scan.
|
|
2540
|
+
*
|
|
2541
|
+
* Returns a scan. When status is completed, `evaluation` names the verdict (retrieveEvaluation).
|
|
2542
|
+
*
|
|
2543
|
+
* @param scan Unique identifier of the scan (scan_…).
|
|
2544
|
+
* @see GET /v1/scans/{scan} (operation `retrieveScan`, scope `scans:read`)
|
|
2545
|
+
*/
|
|
2546
|
+
retrieve(scan: string, options?: RequestOptions): Promise<T.Scan>;
|
|
2547
|
+
}
|
|
2548
|
+
/** `checkbox.evaluations` */
|
|
2549
|
+
export declare class EvaluationsResource extends Resource {
|
|
2550
|
+
/**
|
|
2551
|
+
* Re-evaluate a site now.
|
|
2552
|
+
*
|
|
2553
|
+
* Re-runs the legal rules against the evidence already collected (no new scan) and returns the verdict synchronously. Use after changing site facts, or to get a verdict right after evidence arrived.
|
|
2554
|
+
*
|
|
2555
|
+
* @param site Unique identifier of the site (site_…).
|
|
2556
|
+
* @see POST /v1/sites/{site}/evaluations (operation `createEvaluation`, scope `evaluations:write`)
|
|
2557
|
+
*/
|
|
2558
|
+
create(site: string, params?: T.CreateEvaluationParams, options?: RequestOptions): Promise<T.Evaluation>;
|
|
2559
|
+
/**
|
|
2560
|
+
* List evaluations.
|
|
2561
|
+
*
|
|
2562
|
+
* Verdicts newest first (score history), optionally for one site.
|
|
2563
|
+
*
|
|
2564
|
+
* @see GET /v1/evaluations (operation `listEvaluations`, scope `evaluations:read`)
|
|
2565
|
+
*/
|
|
2566
|
+
list(params?: T.ListEvaluationsParams, options?: RequestOptions): ApiListPromise<T.Evaluation>;
|
|
2567
|
+
/**
|
|
2568
|
+
* Retrieve an evaluation.
|
|
2569
|
+
*
|
|
2570
|
+
* Returns one verdict with all checks and the insurability blockers.
|
|
2571
|
+
*
|
|
2572
|
+
* @param evaluation Unique identifier of the evaluation (eval_…).
|
|
2573
|
+
* @see GET /v1/evaluations/{evaluation} (operation `retrieveEvaluation`, scope `evaluations:read`)
|
|
2574
|
+
*/
|
|
2575
|
+
retrieve(evaluation: string, options?: RequestOptions): Promise<T.Evaluation>;
|
|
2576
|
+
/**
|
|
2577
|
+
* Get the current verdict of a site.
|
|
2578
|
+
*
|
|
2579
|
+
* The latest evaluation of the site: is it compliant (score) and insurable, and what blocks it. 404 resource_missing with next_action createScan when the site was never evaluated.
|
|
2580
|
+
*
|
|
2581
|
+
* @param site Unique identifier of the site (site_…).
|
|
2582
|
+
* @see GET /v1/sites/{site}/evaluation (operation `retrieveLatestEvaluation`, scope `evaluations:read`)
|
|
2583
|
+
*/
|
|
2584
|
+
retrieveLatest(site: string, options?: RequestOptions): Promise<T.Evaluation>;
|
|
2585
|
+
}
|
|
2586
|
+
/** `checkbox.findings` */
|
|
2587
|
+
export declare class FindingsResource extends Resource {
|
|
2588
|
+
/**
|
|
2589
|
+
* List findings.
|
|
2590
|
+
*
|
|
2591
|
+
* Findings ordered by urgency (failing first, then by severity). Filter by site, status (fail, needs_review, pass, not_applicable) and state (open, acknowledged, resolved, accepted_risk). Fix the open `fail` findings to become compliant.
|
|
2592
|
+
*
|
|
2593
|
+
* @see GET /v1/findings (operation `listFindings`, scope `findings:read`)
|
|
2594
|
+
*/
|
|
2595
|
+
list(params?: T.ListFindingsParams, options?: RequestOptions): ApiListPromise<T.Finding>;
|
|
2596
|
+
/**
|
|
2597
|
+
* Retrieve a finding.
|
|
2598
|
+
*
|
|
2599
|
+
* One finding with its legal requirements (citations), evidence references and remediation.
|
|
2600
|
+
*
|
|
2601
|
+
* @param finding Unique identifier of the finding (fnd_…).
|
|
2602
|
+
* @see GET /v1/findings/{finding} (operation `retrieveFinding`, scope `findings:read`)
|
|
2603
|
+
*/
|
|
2604
|
+
retrieve(finding: string, options?: RequestOptions): Promise<T.Finding>;
|
|
2605
|
+
/**
|
|
2606
|
+
* Triage a finding.
|
|
2607
|
+
*
|
|
2608
|
+
* Sets the triage state (open, acknowledged, accepted_risk, resolved) and an optional note. Triage does not change the check result; fixing the issue and re-scanning does.
|
|
2609
|
+
*
|
|
2610
|
+
* @param finding Unique identifier of the finding (fnd_…).
|
|
2611
|
+
* @see POST /v1/findings/{finding} (operation `updateFinding`, scope `findings:write`)
|
|
2612
|
+
*/
|
|
2613
|
+
update(finding: string, params: T.UpdateFindingParams, options?: RequestOptions): Promise<T.Finding>;
|
|
2614
|
+
}
|
|
2615
|
+
/** `checkbox.plans` */
|
|
2616
|
+
export declare class PlansResource extends Resource {
|
|
2617
|
+
/**
|
|
2618
|
+
* Get the compliance plan for a site.
|
|
2619
|
+
*
|
|
2620
|
+
* Ordered tasks that make the site compliant, recomputed from its latest evaluation: each with the requirement and citation, where to change (file / URL / selector / Stripe object), the exact change (unified-diff template with machine-applicable edits, copy, or Stripe params) and how to verify it. Do plan.next_action: apply the first open task, call verifyTask, repeat until status is compliant. Tasks with status manual hold a question for the human (answerTask); they never block the others.
|
|
2621
|
+
*
|
|
2622
|
+
* @param site Unique identifier of the site (site_…).
|
|
2623
|
+
* @see GET /v1/sites/{site}/plan (operation `retrieveCompliancePlan`, scope `compliance_plans:read`)
|
|
2624
|
+
*/
|
|
2625
|
+
retrieve(site: string, options?: RequestOptions): Promise<T.CompliancePlan>;
|
|
2626
|
+
}
|
|
2627
|
+
/** `checkbox.tasks` */
|
|
2628
|
+
export declare class TasksResource extends Resource {
|
|
2629
|
+
/**
|
|
2630
|
+
* Get one task of a compliance plan.
|
|
2631
|
+
*
|
|
2632
|
+
* The task as in the current plan (recomputed): the change to apply, how to verify, its last verification and next_action.
|
|
2633
|
+
*
|
|
2634
|
+
* @param task Unique identifier of the task (task_…).
|
|
2635
|
+
* @see GET /v1/tasks/{task} (operation `retrieveTask`, scope `compliance_plans:read`)
|
|
2636
|
+
*/
|
|
2637
|
+
retrieve(task: string, options?: RequestOptions): Promise<T.Task>;
|
|
2638
|
+
/**
|
|
2639
|
+
* Claim, decline or reopen a task.
|
|
2640
|
+
*
|
|
2641
|
+
* status in_progress claims the task (shown to other agents and the dashboard); wont_fix declines it with a reason (the merchant's decision, recorded; a declined critical or high task keeps the plan blocked); open clears the decision. Applying a change does not need this call: call verifyTask.
|
|
2642
|
+
*
|
|
2643
|
+
* @param task Unique identifier of the task (task_…).
|
|
2644
|
+
* @see POST /v1/tasks/{task} (operation `updateTask`, scope `compliance_plans:write`)
|
|
2645
|
+
*/
|
|
2646
|
+
update(task: string, params: T.UpdateTaskParams, options?: RequestOptions): Promise<T.Task>;
|
|
2647
|
+
/**
|
|
2648
|
+
* Record the human answer to a manual task.
|
|
2649
|
+
*
|
|
2650
|
+
* For tasks with status manual: record the human's answer to task.question (ask them; never answer on their behalf). Answers that assert a legal fact (yes, confirmed) are stored as a proposal and return next_action.type "ask_human_to_confirm" with a link the human opens while signed in to Checkbox; only their confirmation writes the attestation, sets the site fact and re-evaluates. no / needs_change turn the task into a change for the agent; done (after a dashboard-only step) re-checks at once. Every answer is stored in the evidence vault.
|
|
2651
|
+
*
|
|
2652
|
+
* @param task Unique identifier of the task (task_…).
|
|
2653
|
+
* @see POST /v1/tasks/{task}/answer (operation `answerTask`, scope `compliance_plans:write`)
|
|
2654
|
+
*/
|
|
2655
|
+
answer(task: string, params: T.AnswerTaskParams, options?: RequestOptions): Promise<T.Task>;
|
|
2656
|
+
/**
|
|
2657
|
+
* Verify a task after applying its change.
|
|
2658
|
+
*
|
|
2659
|
+
* Runs the fastest re-check that can confirm the task (static fetch of the live checkout or the html you send, the Stripe params you send, the email copy you send, a re-fetch of the Terms) and queues the confirming observation (a scan, a billing-platform sync, the next email). A failing pre-check fails the verification at once with a diff. Pass ?wait=30 to long-poll; otherwise poll retrieveVerification or wait for the task.verified webhook. Then follow next_action.
|
|
2660
|
+
*
|
|
2661
|
+
* @param task Unique identifier of the task (task_…).
|
|
2662
|
+
* @see POST /v1/tasks/{task}/verify (operation `verifyTask`, scope `compliance_plans:write`)
|
|
2663
|
+
*/
|
|
2664
|
+
verify(task: string, params?: T.VerifyTaskRequestParams, options?: RequestOptions): Promise<T.Verification>;
|
|
2665
|
+
}
|
|
2666
|
+
/** `checkbox.verifications` */
|
|
2667
|
+
export declare class VerificationsResource extends Resource {
|
|
2668
|
+
/**
|
|
2669
|
+
* Get a verification (long-poll with ?wait=30).
|
|
2670
|
+
*
|
|
2671
|
+
* The verification's status (pending, passed, failed), expected vs observed per check, the diff and next_action. ?wait=N (≤ 30) holds the request until it resolves or N seconds pass.
|
|
2672
|
+
*
|
|
2673
|
+
* @param verification Unique identifier of the verification (ver_…).
|
|
2674
|
+
* @see GET /v1/verifications/{verification} (operation `retrieveVerification`, scope `compliance_plans:read`)
|
|
2675
|
+
*/
|
|
2676
|
+
retrieve(verification: string, params?: T.RetrieveVerificationParams, options?: RequestOptions): Promise<T.Verification>;
|
|
2677
|
+
/**
|
|
2678
|
+
* List verifications of a site.
|
|
2679
|
+
*
|
|
2680
|
+
* Verifications newest first (optionally for one task).
|
|
2681
|
+
*
|
|
2682
|
+
* @param site Unique identifier of the site (site_…).
|
|
2683
|
+
* @see GET /v1/sites/{site}/verifications (operation `listVerifications`, scope `compliance_plans:read`)
|
|
2684
|
+
*/
|
|
2685
|
+
list(site: string, params?: T.ListVerificationsParams, options?: RequestOptions): ApiListPromise<T.Verification>;
|
|
2686
|
+
}
|
|
2687
|
+
/** `checkbox.fixes` */
|
|
2688
|
+
export declare class FixesResource extends Resource {
|
|
2689
|
+
/**
|
|
2690
|
+
* Get the fix for a finding.
|
|
2691
|
+
*
|
|
2692
|
+
* The concrete change that makes the finding pass: verified disclosure text and code for the detected platform, or the generic remediation. Apply it, then re-scan (createScan) or re-evaluate.
|
|
2693
|
+
*
|
|
2694
|
+
* @param finding Unique identifier of the finding (fnd_…).
|
|
2695
|
+
* @see GET /v1/findings/{finding}/fix (operation `retrieveFindingFix`, scope `fixes:read`)
|
|
2696
|
+
*/
|
|
2697
|
+
retrieve(finding: string, params?: T.RetrieveFindingFixParams, options?: RequestOptions): Promise<T.Fix>;
|
|
2698
|
+
/**
|
|
2699
|
+
* List fix plans for a site.
|
|
2700
|
+
*
|
|
2701
|
+
* Site-level fix plans: the sign-up disclosure fix and the cancellation fix (hosted cancellation page), each with the checks it covers.
|
|
2702
|
+
*
|
|
2703
|
+
* @param site Unique identifier of the site (site_…).
|
|
2704
|
+
* @see GET /v1/sites/{site}/fixes (operation `listSiteFixes`, scope `fixes:read`)
|
|
2705
|
+
*/
|
|
2706
|
+
list(site: string, params?: T.ListSiteFixesParams, options?: RequestOptions): Promise<T.FixList>;
|
|
2707
|
+
}
|
|
2708
|
+
/** `checkbox.evidence` */
|
|
2709
|
+
export declare class EvidenceResource extends Resource {
|
|
2710
|
+
/**
|
|
2711
|
+
* List evidence.
|
|
2712
|
+
*
|
|
2713
|
+
* Evidence records of a site, newest first. Use downloadEvidenceContent for the raw bytes.
|
|
2714
|
+
*
|
|
2715
|
+
* @see GET /v1/evidence (operation `listEvidence`, scope `evidence:read`)
|
|
2716
|
+
*/
|
|
2717
|
+
list(params: T.ListEvidenceParams, options?: RequestOptions): ApiListPromise<T.Evidence>;
|
|
2718
|
+
/**
|
|
2719
|
+
* Retrieve evidence metadata.
|
|
2720
|
+
*
|
|
2721
|
+
* One evidence record (hashes, metadata, content URL).
|
|
2722
|
+
*
|
|
2723
|
+
* @param evidence Unique identifier of the evidence (ev_…).
|
|
2724
|
+
* @see GET /v1/evidence/{evidence} (operation `retrieveEvidence`, scope `evidence:read`)
|
|
2725
|
+
*/
|
|
2726
|
+
retrieve(evidence: string, options?: RequestOptions): Promise<T.Evidence>;
|
|
2727
|
+
/**
|
|
2728
|
+
* Download evidence content.
|
|
2729
|
+
*
|
|
2730
|
+
* The raw stored bytes (screenshot, HTML, raw email…). The X-Evidence-Sha256 header carries the hash to check.
|
|
2731
|
+
*
|
|
2732
|
+
* @param evidence Unique identifier of the evidence (ev_…).
|
|
2733
|
+
* @see GET /v1/evidence/{evidence}/content (operation `downloadEvidenceContent`, scope `evidence:read`)
|
|
2734
|
+
*/
|
|
2735
|
+
downloadContent(evidence: string, options?: RequestOptions): Promise<T.CheckboxFile>;
|
|
2736
|
+
/**
|
|
2737
|
+
* Verify the evidence chain.
|
|
2738
|
+
*
|
|
2739
|
+
* Re-reads and re-hashes every evidence record of the site and checks the hash chain and signed anchors.
|
|
2740
|
+
*
|
|
2741
|
+
* @param site Unique identifier of the site (site_…).
|
|
2742
|
+
* @see POST /v1/sites/{site}/evidence/verify (operation `verifyEvidenceChain`, scope `evidence:read`)
|
|
2743
|
+
*/
|
|
2744
|
+
verifyChain(site: string, params?: T.VerifyEvidenceChainParams, options?: RequestOptions): Promise<T.EvidenceChainVerification>;
|
|
2745
|
+
}
|
|
2746
|
+
/** `checkbox.certificates` */
|
|
2747
|
+
export declare class CertificatesResource extends Resource {
|
|
2748
|
+
/**
|
|
2749
|
+
* List certificates.
|
|
2750
|
+
*
|
|
2751
|
+
* Certificates newest first, optionally for one site.
|
|
2752
|
+
*
|
|
2753
|
+
* @see GET /v1/certificates (operation `listCertificates`, scope `certificates:read`)
|
|
2754
|
+
*/
|
|
2755
|
+
list(params?: T.ListCertificatesParams, options?: RequestOptions): ApiListPromise<T.Certificate>;
|
|
2756
|
+
/**
|
|
2757
|
+
* Retrieve a certificate.
|
|
2758
|
+
*
|
|
2759
|
+
* One certificate with its verification URL and badge embed code.
|
|
2760
|
+
*
|
|
2761
|
+
* @param certificate Unique identifier of the certificate (cert_…).
|
|
2762
|
+
* @see GET /v1/certificates/{certificate} (operation `retrieveCertificate`, scope `certificates:read`)
|
|
2763
|
+
*/
|
|
2764
|
+
retrieve(certificate: string, options?: RequestOptions): Promise<T.Certificate>;
|
|
2765
|
+
/**
|
|
2766
|
+
* Issue a certificate.
|
|
2767
|
+
*
|
|
2768
|
+
* Issues a signed monitoring certificate once the site has been insurable for the required streak of days with a verified domain and fresh scans. Otherwise fails with resource_conflict and next_action describing what is missing.
|
|
2769
|
+
*
|
|
2770
|
+
* @param site Unique identifier of the site (site_…).
|
|
2771
|
+
* @see POST /v1/sites/{site}/certificates (operation `createCertificate`, scope `certificates:write`, live mode needs an activated account)
|
|
2772
|
+
*/
|
|
2773
|
+
create(site: string, params?: T.CreateCertificateParams, options?: RequestOptions): Promise<T.Certificate>;
|
|
2774
|
+
/**
|
|
2775
|
+
* Revoke a certificate.
|
|
2776
|
+
*
|
|
2777
|
+
* Revokes an active certificate. The reason stays private; the verification page shows "revoked by merchant".
|
|
2778
|
+
*
|
|
2779
|
+
* @param certificate Unique identifier of the certificate (cert_…).
|
|
2780
|
+
* @see POST /v1/certificates/{certificate}/revoke (operation `revokeCertificate`, scope `certificates:write`)
|
|
2781
|
+
*/
|
|
2782
|
+
revoke(certificate: string, params: T.RevokeCertificateParams, options?: RequestOptions): Promise<T.Certificate>;
|
|
2783
|
+
}
|
|
2784
|
+
/** `checkbox.noticeSettings` */
|
|
2785
|
+
export declare class NoticeSettingsResource extends Resource {
|
|
2786
|
+
/**
|
|
2787
|
+
* Retrieve notice settings.
|
|
2788
|
+
*
|
|
2789
|
+
* Who sends the site's required emails (mode), the BCC address, which notices Checkbox sends in checkbox mode, and what to do next (next_action).
|
|
2790
|
+
*
|
|
2791
|
+
* @param site Unique identifier of the site (site_…).
|
|
2792
|
+
* @see GET /v1/sites/{site}/notice_settings (operation `retrieveNoticeSettings`, scope `notices:read`)
|
|
2793
|
+
*/
|
|
2794
|
+
retrieve(site: string, options?: RequestOptions): Promise<T.NoticeSettings>;
|
|
2795
|
+
/**
|
|
2796
|
+
* Update notice settings.
|
|
2797
|
+
*
|
|
2798
|
+
* Chooses who sends the required emails (mode: merchant = you send them and Checkbox tracks them, the default; checkbox = Checkbox sends them), and sets branding, cancel_url and the confirmed cancellation policy. In checkbox mode, turning a notice on (enabled_kinds) requires cancel_url, a confirmed policy, a connected Stripe or Recharge account and a sending address; otherwise resource_conflict explains what is missing.
|
|
2799
|
+
*
|
|
2800
|
+
* @param site Unique identifier of the site (site_…).
|
|
2801
|
+
* @see POST /v1/sites/{site}/notice_settings (operation `updateNoticeSettings`, scope `notices:write`, live mode needs an activated account)
|
|
2802
|
+
*/
|
|
2803
|
+
update(site: string, params?: T.UpdateNoticeSettingsParams, options?: RequestOptions): Promise<T.NoticeSettings>;
|
|
2804
|
+
}
|
|
2805
|
+
/** `checkbox.notices` */
|
|
2806
|
+
export declare class NoticesResource extends Resource {
|
|
2807
|
+
/**
|
|
2808
|
+
* List due notices.
|
|
2809
|
+
*
|
|
2810
|
+
* The legally required emails you owe subscribers (sites in "You send" mode, the default): kind, the subscriber (billing-platform ids), the legal window for the subscriber's state, the recommended send date, the copy-ready email and the BCC address. Default: everything not yet sent (upcoming, due, overdue), soonest first. Live keys list live subscribers' notices, test keys test-mode ones. Send each one on its send_date (inside its window), then call markNoticeSent (or BCC the notice's bcc address). Subscribe to the notice.due webhook to get each one on its send date.
|
|
2811
|
+
*
|
|
2812
|
+
* @see GET /v1/notices/due (operation `listDueNotices`, scope `notices:read`)
|
|
2813
|
+
*/
|
|
2814
|
+
listDue(params?: T.ListDueNoticesParams, options?: RequestOptions): ApiListPromise<T.DueNotice>;
|
|
2815
|
+
/**
|
|
2816
|
+
* List notice email templates.
|
|
2817
|
+
*
|
|
2818
|
+
* Copy-ready HTML + text templates for every required notice (acknowledgment with and without a trial, trial ending, renewal, yearly terms, price change, cancellation confirmation), with {{merge_fields}}. Each passes the preflight email check for its kind when filled. Pass ?site= to get each kind's BCC address too. Adapt one, then call checkNoticeTemplate.
|
|
2819
|
+
*
|
|
2820
|
+
* @see GET /v1/notices/templates (operation `listNoticeTemplates`, scope `notices:read`)
|
|
2821
|
+
*/
|
|
2822
|
+
listTemplates(params?: T.ListNoticeTemplatesParams, options?: RequestOptions): Promise<T.NoticeTemplateList>;
|
|
2823
|
+
/**
|
|
2824
|
+
* Check a notice email template.
|
|
2825
|
+
*
|
|
2826
|
+
* Checks your own version of a notice email: Checkbox fills the merge fields with the site's plan, brand and cancel URL (sample dates), then runs the preflight email check for the kind across the site's jurisdictions. Stateless. Fix what fails (or start from listNoticeTemplates) and check again until verdict is pass.
|
|
2827
|
+
*
|
|
2828
|
+
* @see POST /v1/notices/templates/check (operation `checkNoticeTemplate`, scope `notices:read`)
|
|
2829
|
+
*/
|
|
2830
|
+
checkTemplate(params: T.CheckNoticeTemplateParams, options?: RequestOptions): Promise<T.NoticeTemplateCheck>;
|
|
2831
|
+
/**
|
|
2832
|
+
* Retrieve a due notice.
|
|
2833
|
+
*
|
|
2834
|
+
* One notice you owe a subscriber, with its window, recommended send date, copy-ready email, BCC address and send status.
|
|
2835
|
+
*
|
|
2836
|
+
* @param notice Unique identifier of the due notice (ntd_…).
|
|
2837
|
+
* @see GET /v1/notices/{notice} (operation `retrieveDueNotice`, scope `notices:read`)
|
|
2838
|
+
*/
|
|
2839
|
+
retrieve(notice: string, options?: RequestOptions): Promise<T.DueNotice>;
|
|
2840
|
+
/**
|
|
2841
|
+
* Mark a due notice as sent.
|
|
2842
|
+
*
|
|
2843
|
+
* Records that you sent this notice (optionally with your email provider's message id). Idempotent: a notice already marked sent is returned unchanged. A send before window_start is refused (it does not satisfy the law: send again inside the window). An overdue notice marked sent stops failing its check and is recorded as late; a sent_at earlier than when it became overdue is refused (only the BCC copy can prove an in-window send). Canceled and missed notices cannot be marked. BCC'ing the notice's bcc address does the same with the email itself as evidence.
|
|
2844
|
+
*
|
|
2845
|
+
* @param notice Unique identifier of the due notice (ntd_…).
|
|
2846
|
+
* @see POST /v1/notices/{notice}/sent (operation `markNoticeSent`, scope `notices:write`)
|
|
2847
|
+
*/
|
|
2848
|
+
markSent(notice: string, params?: T.MarkNoticeSentParams, options?: RequestOptions): Promise<T.DueNotice>;
|
|
2849
|
+
/**
|
|
2850
|
+
* Record a due notice as missed.
|
|
2851
|
+
*
|
|
2852
|
+
* Records that an overdue notice was not sent and will not be (for example, the subscriber already left). Nothing is attested as sent: the notice moves to missed and stops failing its compliance check, and the record stays in the history. Only overdue notices can be recorded as missed. Idempotent.
|
|
2853
|
+
*
|
|
2854
|
+
* @param notice Unique identifier of the due notice (ntd_…).
|
|
2855
|
+
* @see POST /v1/notices/{notice}/missed (operation `markNoticeMissed`, scope `notices:write`)
|
|
2856
|
+
*/
|
|
2857
|
+
markMissed(notice: string, params?: T.MarkNoticeMissedParams, options?: RequestOptions): Promise<T.DueNotice>;
|
|
2858
|
+
}
|
|
2859
|
+
/** `checkbox.lawUpdates` */
|
|
2860
|
+
export declare class LawUpdatesResource extends Resource {
|
|
2861
|
+
/**
|
|
2862
|
+
* List law updates.
|
|
2863
|
+
*
|
|
2864
|
+
* Law changes newest first, each with its effect on this account's sites.
|
|
2865
|
+
*
|
|
2866
|
+
* @see GET /v1/law_updates (operation `listLawUpdates`, scope `law_updates:read`)
|
|
2867
|
+
*/
|
|
2868
|
+
list(params?: T.ListLawUpdatesParams, options?: RequestOptions): ApiListPromise<T.LawUpdate>;
|
|
2869
|
+
/**
|
|
2870
|
+
* Retrieve a law update.
|
|
2871
|
+
*
|
|
2872
|
+
* One law change with its effect on this account's sites.
|
|
2873
|
+
*
|
|
2874
|
+
* @param lawUpdate Unique identifier of the law update (law_…).
|
|
2875
|
+
* @see GET /v1/law_updates/{law_update} (operation `retrieveLawUpdate`, scope `law_updates:read`)
|
|
2876
|
+
*/
|
|
2877
|
+
retrieve(lawUpdate: string, options?: RequestOptions): Promise<T.LawUpdate>;
|
|
2878
|
+
}
|
|
2879
|
+
/** `checkbox.checks` */
|
|
2880
|
+
export declare class ChecksResource extends Resource {
|
|
2881
|
+
/**
|
|
2882
|
+
* Check checkout disclosure text.
|
|
2883
|
+
*
|
|
2884
|
+
* Checks the automatic-renewal disclosure you are about to show next to a subscribe button: what it says (renewal until canceled, price, frequency, trial, term, how to cancel), where it sits (above the button, same page) and how it looks (size, contrast, set off), and the consent checkbox (present, not pre-checked). Returns the verdict per check and per legal requirement, plus `replacement`: compliant text and drop-in HTML generated from your price/interval/trial/cancel_url and verified by the engine. Call it whenever you write or change checkout copy. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
|
|
2885
|
+
*
|
|
2886
|
+
* @see POST /v1/checks/disclosure (operation `checkDisclosure`, scope `checks:read`)
|
|
2887
|
+
*/
|
|
2888
|
+
disclosure(params: T.DisclosureCheckParams, options?: RequestOptions): Promise<T.DisclosureCheckResult>;
|
|
2889
|
+
/**
|
|
2890
|
+
* Check Stripe Checkout Session params.
|
|
2891
|
+
*
|
|
2892
|
+
* Pass exactly the object your code gives stripe.checkout.sessions.create (plus merchant.merchant_name and merchant.cancel_url, and merchant.price/interval when line_items use a Price id). Checkbox models the Stripe-hosted page those params render and returns findings plus `correction`: a JSON Patch (RFC 6902) and the full corrected params (custom_text.submit with the renewal terms, consent_collection.terms_of_service = "required", custom_text.terms_of_service_acceptance as the consent label), verified by the engine. Stripe's own small grey styling keeps "clear and conspicuous" at needs_review on any Stripe-hosted page; also show the terms on your page before redirecting. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
|
|
2893
|
+
*
|
|
2894
|
+
* @see POST /v1/checks/stripe_checkout_session (operation `checkStripeCheckoutSession`, scope `checks:read`)
|
|
2895
|
+
*/
|
|
2896
|
+
stripeCheckoutSession(params: T.StripeCheckParams, options?: RequestOptions): Promise<T.StripeCheckoutSessionCheckResult>;
|
|
2897
|
+
/**
|
|
2898
|
+
* Check Stripe Payment Link params.
|
|
2899
|
+
*
|
|
2900
|
+
* Like checkStripeCheckoutSession, for stripe.paymentLinks.create params or a retrieved Payment Link object. For an existing link (params.id) the correction also gives update_params for stripe.paymentLinks.update (same URL); Stripe cannot add a consent checkbox to an existing link, so needs_new_link_for_consent says when a new link (corrected_params) is required. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
|
|
2901
|
+
*
|
|
2902
|
+
* @see POST /v1/checks/stripe_payment_link (operation `checkStripePaymentLink`, scope `checks:read`)
|
|
2903
|
+
*/
|
|
2904
|
+
stripePaymentLink(params: T.StripeCheckParams, options?: RequestOptions): Promise<T.StripePaymentLinkCheckResult>;
|
|
2905
|
+
/**
|
|
2906
|
+
* Check a subscription lifecycle email.
|
|
2907
|
+
*
|
|
2908
|
+
* Checks the content of an acknowledgment (welcome) email, trial-ending reminder, renewal reminder, price-change notice, yearly terms reminder or cancellation confirmation against the requirements for that notice (renewal terms, amount, frequency, how to cancel, trial cancellation). The email is modelled as sent on time, so the verdict is about content; get send dates from checkNoticeSchedule. Returns `required_by` (requirements that make the email mandatory for this plan) and a compliant `template` with {{merge_tags}}, verified by the engine. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
|
|
2909
|
+
*
|
|
2910
|
+
* @see POST /v1/checks/email (operation `checkEmail`, scope `checks:read`)
|
|
2911
|
+
*/
|
|
2912
|
+
email(params: T.EmailCheckParams, options?: RequestOptions): Promise<T.EmailCheckResult>;
|
|
2913
|
+
/**
|
|
2914
|
+
* Check a checkout page (HTML or URL).
|
|
2915
|
+
*
|
|
2916
|
+
* Reads a checkout page's HTML (send the rendered HTML of client-side apps) with Checkbox's static extractor — purchase buttons, terms blocks, consent checkboxes, terms links — and runs the sign-up checks on it. Without a browser, placement and conspicuousness are estimates: a passing estimate is reported as needs_review (with static_estimate), never as pass; install the snippet or run a scan after deploying for rendered measurements. `url` (instead of html) fetches a public page and needs a live-mode key on an activated account. Pass terms to compare the disclosed price with your real one and get a verified replacement. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
|
|
2917
|
+
*
|
|
2918
|
+
* @see POST /v1/checks/page (operation `checkPage`, scope `checks:read`)
|
|
2919
|
+
*/
|
|
2920
|
+
page(params?: T.PageCheckParams, options?: RequestOptions): Promise<T.PageCheckResult>;
|
|
2921
|
+
/**
|
|
2922
|
+
* Get the dates each required notice must be sent.
|
|
2923
|
+
*
|
|
2924
|
+
* For a subscription plan (price, interval, trial) and where you sell, returns every legally required notice — acknowledgment, trial-ending reminder, renewal reminders, yearly terms reminder, price-change notice — with the recommended send time and the compliant window (opens / closes), the jurisdictions each send satisfies and the citations. Uses the same timing as Checkbox Notices: per-state windows intersected, or the fewest sends that cover conflicting windows. Stateless. Check each email's content with checkEmail, or let Checkbox Notices send them.
|
|
2925
|
+
*
|
|
2926
|
+
* @see POST /v1/checks/notice_schedule (operation `checkNoticeSchedule`, scope `checks:read`)
|
|
2927
|
+
*/
|
|
2928
|
+
noticeSchedule(params: T.NoticeScheduleParams, options?: RequestOptions): Promise<T.NoticeScheduleResult>;
|
|
2929
|
+
}
|
|
2930
|
+
/** `checkbox.elements` */
|
|
2931
|
+
export declare class ElementsResource extends Resource {
|
|
2932
|
+
/**
|
|
2933
|
+
* Load the Elements browser bundle.
|
|
2934
|
+
*
|
|
2935
|
+
* The current elements.js (registers <checkbox-disclosure>). For production pin a version with SRI: use the script_tag from getElementsManifest or createDisclosure.
|
|
2936
|
+
*
|
|
2937
|
+
* @see GET /v1/elements.js (operation `getElementsBundle`, scope `none`)
|
|
2938
|
+
*/
|
|
2939
|
+
retrieveBundle(options?: RequestOptions): Promise<string>;
|
|
2940
|
+
/**
|
|
2941
|
+
* List Elements bundle versions and SRI hashes.
|
|
2942
|
+
*
|
|
2943
|
+
* Released elements.js versions with their immutable URLs and Subresource Integrity hashes, plus a ready-to-paste script tag for the latest one.
|
|
2944
|
+
*
|
|
2945
|
+
* @see GET /v1/elements/manifest.json (operation `getElementsManifest`, scope `none`)
|
|
2946
|
+
*/
|
|
2947
|
+
retrieveManifest(options?: RequestOptions): Promise<T.ElementsManifest>;
|
|
2948
|
+
/**
|
|
2949
|
+
* Load a pinned Elements bundle version.
|
|
2950
|
+
*
|
|
2951
|
+
* An immutable elements.js release (cached for a year). Its integrity hash is in getElementsManifest.
|
|
2952
|
+
*
|
|
2953
|
+
* @param versionId Semver, e.g. 1.0.0.
|
|
2954
|
+
* @see GET /v1/elements/{version}/elements.js (operation `getElementsBundleVersion`, scope `none`)
|
|
2955
|
+
*/
|
|
2956
|
+
retrieveBundleVersion(versionId: string, options?: RequestOptions): Promise<string>;
|
|
2957
|
+
}
|
|
2958
|
+
/** `checkbox.disclosures` */
|
|
2959
|
+
export declare class DisclosuresResource extends Resource {
|
|
2960
|
+
/**
|
|
2961
|
+
* Create a locked disclosure for a site.
|
|
2962
|
+
*
|
|
2963
|
+
* Generates the locked automatic-renewal disclosure and consent label for the site's terms (from the billing connection, the given terms, or both), verifies with the rules engine that the element passes the sign-up checks on your checkout, and returns the markup to paste above your pay button. Next: put script_tag in <head> and element_html directly above the pay button, then call listConsents after a test sign-up.
|
|
2964
|
+
*
|
|
2965
|
+
* @see POST /v1/disclosures (operation `createDisclosure`, scope `consents:write`)
|
|
2966
|
+
*/
|
|
2967
|
+
create(params: T.DisclosureCreateParams, options?: RequestOptions): Promise<T.Disclosure>;
|
|
2968
|
+
/**
|
|
2969
|
+
* Retrieve a disclosure.
|
|
2970
|
+
*
|
|
2971
|
+
* The locked disclosure text, consent label and terms. Works with the publishable key from the site's own pages (this is how <checkbox-disclosure disclosure="disc_…"> loads its text).
|
|
2972
|
+
*
|
|
2973
|
+
* @param disclosure Unique identifier of the disclosure (disc_…).
|
|
2974
|
+
* @see GET /v1/disclosures/{disclosure} (operation `retrieveDisclosure`, scope `publishable`)
|
|
2975
|
+
*/
|
|
2976
|
+
retrieve(disclosure: string, options?: RequestOptions): Promise<T.Disclosure>;
|
|
2977
|
+
}
|
|
2978
|
+
/** `checkbox.consents` */
|
|
2979
|
+
export declare class ConsentsResource extends Resource {
|
|
2980
|
+
/**
|
|
2981
|
+
* Record a consent.
|
|
2982
|
+
*
|
|
2983
|
+
* Records that a subscriber ticked the consent checkbox for the exact disclosure shown: stored with the text, its hashes, the terms, the page, a hash of the user agent and your customer reference, written to the site's hash-chained evidence vault, and fed to the compliance evaluation as corroborating evidence. <checkbox-disclosure> calls this with the publishable key (Origin-checked); servers may call it with a secret key and site. Next: attach the returned cons_… id to the subscription (metadata.checkbox_consent) or call updateConsent.
|
|
2984
|
+
*
|
|
2985
|
+
* @see POST /v1/consents (operation `createConsent`, scope `publishable`)
|
|
2986
|
+
*/
|
|
2987
|
+
create(params: T.ConsentCreateParams, options?: RequestOptions): Promise<T.Consent>;
|
|
2988
|
+
/**
|
|
2989
|
+
* List consents.
|
|
2990
|
+
*
|
|
2991
|
+
* Consents, newest first. Filter by site, customer_reference (e.g. find the consent behind a disputed Stripe subscription), disclosure or creation time.
|
|
2992
|
+
*
|
|
2993
|
+
* @see GET /v1/consents (operation `listConsents`, scope `consents:read`)
|
|
2994
|
+
*/
|
|
2995
|
+
list(params?: T.ListConsentsParams, options?: RequestOptions): ApiListPromise<T.Consent>;
|
|
2996
|
+
/**
|
|
2997
|
+
* Retrieve a consent.
|
|
2998
|
+
*
|
|
2999
|
+
* A consent record: what the subscriber saw and agreed to, when, where, and its evidence record. Use it to answer a chargeback or a regulator: the evidence id verifies against the site's hash chain (verifyEvidenceChain) and downloads with downloadEvidenceContent.
|
|
3000
|
+
*
|
|
3001
|
+
* @param consent Unique identifier of the consent (cons_…).
|
|
3002
|
+
* @see GET /v1/consents/{consent} (operation `retrieveConsent`, scope `consents:read`)
|
|
3003
|
+
*/
|
|
3004
|
+
retrieve(consent: string, options?: RequestOptions): Promise<T.Consent>;
|
|
3005
|
+
/**
|
|
3006
|
+
* Attach a customer reference to a consent.
|
|
3007
|
+
*
|
|
3008
|
+
* Sets customer_reference once (e.g. the Stripe subscription id created after the consent) and merges metadata. A different reference on a consent that already has one answers 409 consent_reference_locked. The change is appended to the evidence chain.
|
|
3009
|
+
*
|
|
3010
|
+
* @param consent Unique identifier of the consent (cons_…).
|
|
3011
|
+
* @see POST /v1/consents/{consent} (operation `updateConsent`, scope `consents:write`)
|
|
3012
|
+
*/
|
|
3013
|
+
update(consent: string, params?: T.ConsentUpdateParams, options?: RequestOptions): Promise<T.Consent>;
|
|
3014
|
+
}
|
|
3015
|
+
/** `checkbox.receiptTokens` */
|
|
3016
|
+
export declare class ReceiptTokensResource extends Resource {
|
|
3017
|
+
/**
|
|
3018
|
+
* Mint a capture token for a checkout.
|
|
3019
|
+
*
|
|
3020
|
+
* Call from your server when you render a checkout page: returns a short-lived token (rct_…) to put into the page (data-receipt-token on the disclosure or form, or receipt-token on <checkbox-disclosure>). Receipts that present it are "bound" to this checkout and carry your customer_reference; receipts without one are accepted but flagged "unbound". For Stripe-hosted checkouts also set metadata.checkbox_receipt_token=<id> on the Checkout Session (or pass checkout_session here).
|
|
3021
|
+
*
|
|
3022
|
+
* @see POST /v1/receipt_tokens (operation `createReceiptToken`, scope `receipts:write`)
|
|
3023
|
+
*/
|
|
3024
|
+
create(params: T.ReceiptTokenCreateParams, options?: RequestOptions): Promise<T.ReceiptToken>;
|
|
3025
|
+
}
|
|
3026
|
+
/** `checkbox.receipts` */
|
|
3027
|
+
export declare class ReceiptsResource extends Resource {
|
|
3028
|
+
/**
|
|
3029
|
+
* Record a consent receipt.
|
|
3030
|
+
*
|
|
3031
|
+
* Records one receipt from the structured snapshot the browser captured at submit (the /r.js snippet add-on calls this with the publishable key, Origin-checked; servers may call it with a secret key and site). The snapshot is validated strictly and re-sanitized. Next: retrieveReceipt / renderReceipt to see it, verifyReceipt to check its integrity.
|
|
3032
|
+
*
|
|
3033
|
+
* @see POST /v1/receipts (operation `createReceipt`, scope `publishable`)
|
|
3034
|
+
*/
|
|
3035
|
+
create(params: T.ReceiptCreateParams, options?: RequestOptions): Promise<T.Receipt>;
|
|
3036
|
+
/**
|
|
3037
|
+
* List consent receipts.
|
|
3038
|
+
*
|
|
3039
|
+
* Receipts newest first. Filter by site, customer_reference (find the receipt behind a disputed subscription), checkout_session, email (hashed before the lookup), source, binding or creation time.
|
|
3040
|
+
*
|
|
3041
|
+
* @see GET /v1/receipts (operation `listReceipts`, scope `receipts:read`)
|
|
3042
|
+
*/
|
|
3043
|
+
list(params?: T.ListReceiptsParams, options?: RequestOptions): ApiListPromise<T.Receipt>;
|
|
3044
|
+
/**
|
|
3045
|
+
* Erase a subscriber's receipts.
|
|
3046
|
+
*
|
|
3047
|
+
* For a subscriber's deletion request: deletes every receipt that matches customer_reference, email (hashed before the lookup) or checkout_session (optionally only for one site). The signed copy in the write-once evidence vault is kept but holds only a salted commitment to the subscriber's identifiers; erasing destroys the salt, so it can no longer be tied to the person. Pending attorney review.
|
|
3048
|
+
*
|
|
3049
|
+
* @see POST /v1/receipts/erase (operation `eraseReceipts`, scope `receipts:write`)
|
|
3050
|
+
*/
|
|
3051
|
+
erase(params?: T.ReceiptErasureParams, options?: RequestOptions): Promise<T.ReceiptErasure>;
|
|
3052
|
+
/**
|
|
3053
|
+
* Retrieve a consent receipt.
|
|
3054
|
+
*
|
|
3055
|
+
* What one subscriber saw and agreed to at checkout: disclosure text and presentation, checkbox state and label, button label, page, time, binding, flags and integrity data. renderReceipt shows it as an image; exportReceipt downloads a self-verifying bundle.
|
|
3056
|
+
*
|
|
3057
|
+
* @param receipt Unique identifier of the receipt (rcpt_…).
|
|
3058
|
+
* @see GET /v1/receipts/{receipt} (operation `retrieveReceipt`, scope `receipts:read`)
|
|
3059
|
+
*/
|
|
3060
|
+
retrieve(receipt: string, options?: RequestOptions): Promise<T.Receipt>;
|
|
3061
|
+
/**
|
|
3062
|
+
* Render a receipt as an image.
|
|
3063
|
+
*
|
|
3064
|
+
* A PNG of "what the subscriber saw", rendered on demand in an isolated Chromium (no network, scripts disabled) from the sanitized snapshot — a reconstruction, labeled as such, not a screenshot taken from the browser.
|
|
3065
|
+
*
|
|
3066
|
+
* @param receipt Unique identifier of the receipt (rcpt_…).
|
|
3067
|
+
* @see GET /v1/receipts/{receipt}/render.png (operation `renderReceipt`, scope `receipts:read`)
|
|
3068
|
+
*/
|
|
3069
|
+
render(receipt: string, options?: RequestOptions): Promise<T.CheckboxFile>;
|
|
3070
|
+
/**
|
|
3071
|
+
* Verify a receipt's integrity.
|
|
3072
|
+
*
|
|
3073
|
+
* Re-hashes the stored receipt, checks Checkbox's Ed25519 signature over its hash and chain position, and verifies the site's evidence chain. For a check that does not rely on Checkbox, download exportReceipt and run its verify.mjs.
|
|
3074
|
+
*
|
|
3075
|
+
* @param receipt Unique identifier of the receipt (rcpt_…).
|
|
3076
|
+
* @see GET /v1/receipts/{receipt}/verify (operation `verifyReceipt`, scope `receipts:read`)
|
|
3077
|
+
*/
|
|
3078
|
+
verify(receipt: string, options?: RequestOptions): Promise<T.ReceiptVerification>;
|
|
3079
|
+
/**
|
|
3080
|
+
* Download a self-verifying receipt bundle.
|
|
3081
|
+
*
|
|
3082
|
+
* ZIP for a lawyer, insurer or court expert: manifest.json (the receipt's evidence record with its chain links) + manifest.sig.json, the canonical receipt JSON under records/, receipt.sig.json (Checkbox's signature over the receipt hash), receipt.png and render.html (the reconstruction), README.md and verify.mjs (zero-dependency offline verifier: node verify.mjs --keys checkbox-keys.json).
|
|
3083
|
+
*
|
|
3084
|
+
* @param receipt Unique identifier of the receipt (rcpt_…).
|
|
3085
|
+
* @see GET /v1/receipts/{receipt}/export (operation `exportReceipt`, scope `receipts:read`)
|
|
3086
|
+
*/
|
|
3087
|
+
export(receipt: string, options?: RequestOptions): Promise<T.CheckboxFile>;
|
|
3088
|
+
}
|
|
3089
|
+
/** `checkbox.receiptSettings` */
|
|
3090
|
+
export declare class ReceiptSettingsResource extends Resource {
|
|
3091
|
+
/**
|
|
3092
|
+
* Retrieve receipt settings.
|
|
3093
|
+
*
|
|
3094
|
+
* Whether consent receipts are collected for this account (in this mode) and how long they are kept.
|
|
3095
|
+
*
|
|
3096
|
+
* @see GET /v1/receipt_settings (operation `retrieveReceiptSettings`, scope `receipts:read`)
|
|
3097
|
+
*/
|
|
3098
|
+
retrieve(options?: RequestOptions): Promise<T.ReceiptSettings>;
|
|
3099
|
+
/**
|
|
3100
|
+
* Update receipt settings.
|
|
3101
|
+
*
|
|
3102
|
+
* Turn receipts on or off and set the retention in days (default 1461 = 4 years, the California UCL limitation period; pending attorney review). A new retention applies to receipts recorded afterwards.
|
|
3103
|
+
*
|
|
3104
|
+
* @see POST /v1/receipt_settings (operation `updateReceiptSettings`, scope `receipts:write`)
|
|
3105
|
+
*/
|
|
3106
|
+
update(params?: T.ReceiptSettingsUpdateParams, options?: RequestOptions): Promise<T.ReceiptSettings>;
|
|
3107
|
+
}
|
|
3108
|
+
/** `checkbox.testCredentials` */
|
|
3109
|
+
export declare class TestCredentialsResource extends Resource {
|
|
3110
|
+
/**
|
|
3111
|
+
* Store a billing test-mode key.
|
|
3112
|
+
*
|
|
3113
|
+
* Stores the site's Stripe TEST-mode key (rk_test_… preferred) used by test runs, after checking it with Stripe. Live keys are refused (test_key_not_test_mode). Least privilege: Write on Customers, Checkout Sessions, Subscriptions, Test clocks and Customer portal; Read on Prices, Products and Billing portal configuration. Replaces an existing key. Next: createTestRun.
|
|
3114
|
+
*
|
|
3115
|
+
* @param site Unique identifier of the site (site_…).
|
|
3116
|
+
* @see POST /v1/sites/{site}/test_credentials (operation `createTestCredential`, scope `test_runs:write`)
|
|
3117
|
+
*/
|
|
3118
|
+
create(site: string, params: T.CreateTestCredentialParams, options?: RequestOptions): Promise<T.TestCredential>;
|
|
3119
|
+
/**
|
|
3120
|
+
* List billing test-mode keys of a site.
|
|
3121
|
+
*
|
|
3122
|
+
* The site's stored test-mode keys (hints only).
|
|
3123
|
+
*
|
|
3124
|
+
* @param site Unique identifier of the site (site_…).
|
|
3125
|
+
* @see GET /v1/sites/{site}/test_credentials (operation `listTestCredentials`, scope `test_runs:read`)
|
|
3126
|
+
*/
|
|
3127
|
+
list(site: string, options?: RequestOptions): Promise<T.TestCredentialList>;
|
|
3128
|
+
/**
|
|
3129
|
+
* Delete a billing test-mode key.
|
|
3130
|
+
*
|
|
3131
|
+
* Deletes the stored key. Running test runs fail at their next Stripe call.
|
|
3132
|
+
*
|
|
3133
|
+
* @param site Unique identifier of the site (site_…).
|
|
3134
|
+
* @param testCredential Unique identifier of the test credential (tcred_…).
|
|
3135
|
+
* @see DELETE /v1/sites/{site}/test_credentials/{test_credential} (operation `deleteTestCredential`, scope `test_runs:write`)
|
|
3136
|
+
*/
|
|
3137
|
+
del(site: string, testCredential: string, options?: RequestOptions): Promise<T.DeletedTestCredential>;
|
|
3138
|
+
/** Alias of `del()`. */
|
|
3139
|
+
delete(site: string, testCredential: string, options?: RequestOptions): Promise<T.DeletedTestCredential>;
|
|
3140
|
+
}
|
|
3141
|
+
/** `checkbox.stripeCheckoutConfigs` */
|
|
3142
|
+
export declare class StripeCheckoutConfigsResource extends Resource {
|
|
3143
|
+
/**
|
|
3144
|
+
* Register the Checkout Session params your code uses.
|
|
3145
|
+
*
|
|
3146
|
+
* Registers exactly the object your code passes to stripe.checkout.sessions.create (customer, URLs and secrets are not needed and are ignored). Test runs mirror it into Stripe test mode; when it matches your latest live checkout, the scanned test page counts as an observation of your live checkout. Re-register after changing your checkout code, then call createTestRun.
|
|
3147
|
+
*
|
|
3148
|
+
* @param site Unique identifier of the site (site_…).
|
|
3149
|
+
* @see POST /v1/sites/{site}/stripe_checkout_configs (operation `createStripeCheckoutConfig`, scope `test_runs:write`)
|
|
3150
|
+
*/
|
|
3151
|
+
create(site: string, params: T.CreateStripeCheckoutConfigParams, options?: RequestOptions): Promise<T.StripeCheckoutConfig>;
|
|
3152
|
+
/**
|
|
3153
|
+
* List registered checkout configs.
|
|
3154
|
+
*
|
|
3155
|
+
* Registered Checkout Session configs of the site, newest first (test runs mirror the newest by default).
|
|
3156
|
+
*
|
|
3157
|
+
* @param site Unique identifier of the site (site_…).
|
|
3158
|
+
* @see GET /v1/sites/{site}/stripe_checkout_configs (operation `listStripeCheckoutConfigs`, scope `test_runs:read`)
|
|
3159
|
+
*/
|
|
3160
|
+
list(site: string, params?: T.ListStripeCheckoutConfigsParams, options?: RequestOptions): ApiListPromise<T.StripeCheckoutConfig>;
|
|
3161
|
+
/**
|
|
3162
|
+
* Retrieve a registered checkout config.
|
|
3163
|
+
*
|
|
3164
|
+
* One registered Checkout Session config.
|
|
3165
|
+
*
|
|
3166
|
+
* @param stripeCheckoutConfig Unique identifier of the stripe checkout config (scc_…).
|
|
3167
|
+
* @see GET /v1/stripe_checkout_configs/{stripe_checkout_config} (operation `retrieveStripeCheckoutConfig`, scope `test_runs:read`)
|
|
3168
|
+
*/
|
|
3169
|
+
retrieve(stripeCheckoutConfig: string, options?: RequestOptions): Promise<T.StripeCheckoutConfig>;
|
|
3170
|
+
/**
|
|
3171
|
+
* Delete a registered checkout config.
|
|
3172
|
+
*
|
|
3173
|
+
* Deletes the config; later runs mirror the next newest one (or your live checkout).
|
|
3174
|
+
*
|
|
3175
|
+
* @param stripeCheckoutConfig Unique identifier of the stripe checkout config (scc_…).
|
|
3176
|
+
* @see DELETE /v1/stripe_checkout_configs/{stripe_checkout_config} (operation `deleteStripeCheckoutConfig`, scope `test_runs:write`)
|
|
3177
|
+
*/
|
|
3178
|
+
del(stripeCheckoutConfig: string, options?: RequestOptions): Promise<T.DeletedStripeCheckoutConfig>;
|
|
3179
|
+
/** Alias of `del()`. */
|
|
3180
|
+
delete(stripeCheckoutConfig: string, options?: RequestOptions): Promise<T.DeletedStripeCheckoutConfig>;
|
|
3181
|
+
}
|
|
3182
|
+
/** `checkbox.testRuns` */
|
|
3183
|
+
export declare class TestRunsResource extends Resource {
|
|
3184
|
+
/**
|
|
3185
|
+
* Start a lifecycle test run.
|
|
3186
|
+
*
|
|
3187
|
+
* Starts a synthetic test subscription in TEST mode and returns it queued. Stripe runs mirror your checkout into a test-mode Checkout Session, subscribe a test customer (card 4242) whose email is a Checkbox inbox, wait for your acknowledgment, advance a test clock through every legal notice window before trial end and renewal, cancel online in the customer portal and wait for the confirmation; then delete the test clock. Takes about 5-20 minutes: poll retrieveTestRun (next_action says when) or listen for test_run.completed. Each step reports observations, check results and agent-readable fixes; apply them and run again to verify.
|
|
3188
|
+
*
|
|
3189
|
+
* @param site Unique identifier of the site (site_…).
|
|
3190
|
+
* @see POST /v1/sites/{site}/test_runs (operation `createTestRun`, scope `test_runs:write`, live mode needs an activated account)
|
|
3191
|
+
*/
|
|
3192
|
+
create(site: string, params?: T.CreateTestRunParams, options?: RequestOptions): Promise<T.TestRun>;
|
|
3193
|
+
/**
|
|
3194
|
+
* List test runs of a site.
|
|
3195
|
+
*
|
|
3196
|
+
* Test runs of the site, newest first.
|
|
3197
|
+
*
|
|
3198
|
+
* @param site Unique identifier of the site (site_…).
|
|
3199
|
+
* @see GET /v1/sites/{site}/test_runs (operation `listTestRuns`, scope `test_runs:read`)
|
|
3200
|
+
*/
|
|
3201
|
+
list(site: string, params?: T.ListTestRunsParams, options?: RequestOptions): ApiListPromise<T.TestRun>;
|
|
3202
|
+
/**
|
|
3203
|
+
* Retrieve a test run.
|
|
3204
|
+
*
|
|
3205
|
+
* The run with every step's status, observations, check results and fixes. While it runs, next_action.type is "wait"; when it finished, next_action says what to fix (apply_fixes / review_warnings) or "none".
|
|
3206
|
+
*
|
|
3207
|
+
* @param testRun Unique identifier of the test run (run_…).
|
|
3208
|
+
* @see GET /v1/test_runs/{test_run} (operation `retrieveTestRun`, scope `test_runs:read`)
|
|
3209
|
+
*/
|
|
3210
|
+
retrieve(testRun: string, options?: RequestOptions): Promise<T.TestRun>;
|
|
3211
|
+
/**
|
|
3212
|
+
* Cancel a test run.
|
|
3213
|
+
*
|
|
3214
|
+
* Stops a queued or running test run; the worker deletes its Stripe test clock (and with it the test customer and subscription). Finished runs cannot be canceled (resource_conflict).
|
|
3215
|
+
*
|
|
3216
|
+
* @param testRun Unique identifier of the test run (run_…).
|
|
3217
|
+
* @see POST /v1/test_runs/{test_run}/cancel (operation `cancelTestRun`, scope `test_runs:write`)
|
|
3218
|
+
*/
|
|
3219
|
+
cancel(testRun: string, options?: RequestOptions): Promise<T.TestRun>;
|
|
3220
|
+
}
|
|
3221
|
+
/** `checkbox.webhookEndpoints` */
|
|
3222
|
+
export declare class WebhookEndpointsResource extends Resource {
|
|
3223
|
+
/**
|
|
3224
|
+
* Create a webhook endpoint.
|
|
3225
|
+
*
|
|
3226
|
+
* Registers an HTTPS endpoint for the given event types. The response contains the signing `secret` (only now). Respond 2xx quickly; do slow work asynchronously.
|
|
3227
|
+
*
|
|
3228
|
+
* @see POST /v1/webhook_endpoints (operation `createWebhookEndpoint`, scope `webhook_endpoints:write`)
|
|
3229
|
+
*/
|
|
3230
|
+
create(params: T.CreateWebhookEndpointParams, options?: RequestOptions): Promise<T.WebhookEndpoint>;
|
|
3231
|
+
/**
|
|
3232
|
+
* List webhook endpoints.
|
|
3233
|
+
*
|
|
3234
|
+
* Webhook endpoints of this mode, newest first.
|
|
3235
|
+
*
|
|
3236
|
+
* @see GET /v1/webhook_endpoints (operation `listWebhookEndpoints`, scope `webhook_endpoints:read`)
|
|
3237
|
+
*/
|
|
3238
|
+
list(params?: T.ListWebhookEndpointsParams, options?: RequestOptions): ApiListPromise<T.WebhookEndpoint>;
|
|
3239
|
+
/**
|
|
3240
|
+
* Retrieve a webhook endpoint.
|
|
3241
|
+
*
|
|
3242
|
+
* One webhook endpoint (without its secret).
|
|
3243
|
+
*
|
|
3244
|
+
* @param webhookEndpoint Unique identifier of the webhook endpoint (we_…).
|
|
3245
|
+
* @see GET /v1/webhook_endpoints/{webhook_endpoint} (operation `retrieveWebhookEndpoint`, scope `webhook_endpoints:read`)
|
|
3246
|
+
*/
|
|
3247
|
+
retrieve(webhookEndpoint: string, options?: RequestOptions): Promise<T.WebhookEndpoint>;
|
|
3248
|
+
/**
|
|
3249
|
+
* Update a webhook endpoint.
|
|
3250
|
+
*
|
|
3251
|
+
* Changes the URL, event types, description, metadata, or disables / re-enables the endpoint.
|
|
3252
|
+
*
|
|
3253
|
+
* @param webhookEndpoint Unique identifier of the webhook endpoint (we_…).
|
|
3254
|
+
* @see POST /v1/webhook_endpoints/{webhook_endpoint} (operation `updateWebhookEndpoint`, scope `webhook_endpoints:write`)
|
|
3255
|
+
*/
|
|
3256
|
+
update(webhookEndpoint: string, params?: T.UpdateWebhookEndpointParams, options?: RequestOptions): Promise<T.WebhookEndpoint>;
|
|
3257
|
+
/**
|
|
3258
|
+
* Delete a webhook endpoint.
|
|
3259
|
+
*
|
|
3260
|
+
* Deletes the endpoint; pending deliveries to it are dropped.
|
|
3261
|
+
*
|
|
3262
|
+
* @param webhookEndpoint Unique identifier of the webhook endpoint (we_…).
|
|
3263
|
+
* @see DELETE /v1/webhook_endpoints/{webhook_endpoint} (operation `deleteWebhookEndpoint`, scope `webhook_endpoints:write`)
|
|
3264
|
+
*/
|
|
3265
|
+
del(webhookEndpoint: string, options?: RequestOptions): Promise<T.DeletedWebhookEndpoint>;
|
|
3266
|
+
/** Alias of `del()`. */
|
|
3267
|
+
delete(webhookEndpoint: string, options?: RequestOptions): Promise<T.DeletedWebhookEndpoint>;
|
|
3268
|
+
/**
|
|
3269
|
+
* Roll a webhook signing secret.
|
|
3270
|
+
*
|
|
3271
|
+
* Replaces the signing secret immediately and returns the new one (only now).
|
|
3272
|
+
*
|
|
3273
|
+
* @param webhookEndpoint Unique identifier of the webhook endpoint (we_…).
|
|
3274
|
+
* @see POST /v1/webhook_endpoints/{webhook_endpoint}/roll_secret (operation `rollWebhookEndpointSecret`, scope `webhook_endpoints:write`)
|
|
3275
|
+
*/
|
|
3276
|
+
rollSecret(webhookEndpoint: string, params?: T.RollWebhookEndpointSecretParams, options?: RequestOptions): Promise<T.WebhookEndpoint>;
|
|
3277
|
+
}
|
|
3278
|
+
/** `checkbox.events` */
|
|
3279
|
+
export declare class EventsResource extends Resource {
|
|
3280
|
+
/**
|
|
3281
|
+
* List events.
|
|
3282
|
+
*
|
|
3283
|
+
* Events newest first. Poll with ending_before=<newest id you have> to get only new events (an alternative to webhooks).
|
|
3284
|
+
*
|
|
3285
|
+
* @see GET /v1/events (operation `listEvents`, scope `events:read`)
|
|
3286
|
+
*/
|
|
3287
|
+
list(params?: T.ListEventsParams, options?: RequestOptions): ApiListPromise<T.Event>;
|
|
3288
|
+
/**
|
|
3289
|
+
* Retrieve an event.
|
|
3290
|
+
*
|
|
3291
|
+
* One event with its payload (data.object) and the number of webhook deliveries still pending.
|
|
3292
|
+
*
|
|
3293
|
+
* @param event Unique identifier of the event (evt_…).
|
|
3294
|
+
* @see GET /v1/events/{event} (operation `retrieveEvent`, scope `events:read`)
|
|
3295
|
+
*/
|
|
3296
|
+
retrieve(event: string, options?: RequestOptions): Promise<T.Event>;
|
|
3297
|
+
}
|
|
3298
|
+
/** `checkbox.feedbacks` */
|
|
3299
|
+
export declare class FeedbacksResource extends Resource {
|
|
3300
|
+
/**
|
|
3301
|
+
* Send feedback.
|
|
3302
|
+
*
|
|
3303
|
+
* Report a problem or a missing feature in Checkbox. Include what you tried, what happened and what you expected, and the site / request id when there is one. The Checkbox team reads every message. Rate limited to 20 per key per hour.
|
|
3304
|
+
*
|
|
3305
|
+
* @see POST /v1/feedback (operation `createFeedback`, scope `account:read`)
|
|
3306
|
+
*/
|
|
3307
|
+
create(params: T.FeedbackParams, options?: RequestOptions): Promise<T.Feedback>;
|
|
3308
|
+
}
|
|
3309
|
+
/** Resource namespaces of the client. */
|
|
3310
|
+
export declare const RESOURCES: {
|
|
3311
|
+
readonly device: typeof DeviceResource;
|
|
3312
|
+
readonly setupSessions: typeof SetupSessionsResource;
|
|
3313
|
+
readonly account: typeof AccountResource;
|
|
3314
|
+
readonly sites: typeof SitesResource;
|
|
3315
|
+
readonly domainVerifications: typeof DomainVerificationsResource;
|
|
3316
|
+
readonly scans: typeof ScansResource;
|
|
3317
|
+
readonly evaluations: typeof EvaluationsResource;
|
|
3318
|
+
readonly findings: typeof FindingsResource;
|
|
3319
|
+
readonly plans: typeof PlansResource;
|
|
3320
|
+
readonly tasks: typeof TasksResource;
|
|
3321
|
+
readonly verifications: typeof VerificationsResource;
|
|
3322
|
+
readonly fixes: typeof FixesResource;
|
|
3323
|
+
readonly evidence: typeof EvidenceResource;
|
|
3324
|
+
readonly certificates: typeof CertificatesResource;
|
|
3325
|
+
readonly noticeSettings: typeof NoticeSettingsResource;
|
|
3326
|
+
readonly notices: typeof NoticesResource;
|
|
3327
|
+
readonly lawUpdates: typeof LawUpdatesResource;
|
|
3328
|
+
readonly checks: typeof ChecksResource;
|
|
3329
|
+
readonly elements: typeof ElementsResource;
|
|
3330
|
+
readonly disclosures: typeof DisclosuresResource;
|
|
3331
|
+
readonly consents: typeof ConsentsResource;
|
|
3332
|
+
readonly receiptTokens: typeof ReceiptTokensResource;
|
|
3333
|
+
readonly receipts: typeof ReceiptsResource;
|
|
3334
|
+
readonly receiptSettings: typeof ReceiptSettingsResource;
|
|
3335
|
+
readonly testCredentials: typeof TestCredentialsResource;
|
|
3336
|
+
readonly stripeCheckoutConfigs: typeof StripeCheckoutConfigsResource;
|
|
3337
|
+
readonly testRuns: typeof TestRunsResource;
|
|
3338
|
+
readonly webhookEndpoints: typeof WebhookEndpointsResource;
|
|
3339
|
+
readonly events: typeof EventsResource;
|
|
3340
|
+
readonly feedbacks: typeof FeedbacksResource;
|
|
3341
|
+
};
|