@kanorio/sdk 0.0.0-stage → 1.0.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 +66 -2
- package/dist/customer-oauth.d.ts +86 -0
- package/dist/customer-oauth.js +112 -0
- package/dist/customer.d.ts +176 -0
- package/dist/customer.js +116 -0
- package/dist/delivery.d.ts +35 -0
- package/dist/delivery.js +49 -0
- package/dist/edge.d.ts +104 -0
- package/dist/edge.js +287 -0
- package/dist/forms.d.ts +123 -0
- package/dist/forms.js +130 -0
- package/dist/generated/customer.d.ts +3157 -0
- package/dist/generated/delivery.d.ts +2380 -0
- package/dist/generated/management.d.ts +38248 -0
- package/dist/http.d.ts +73 -0
- package/dist/http.js +162 -0
- package/dist/index.d.ts +16 -0
- package/dist/index.js +17 -0
- package/dist/locales.d.ts +80 -0
- package/dist/locales.js +81 -0
- package/dist/management.d.ts +19 -0
- package/dist/management.js +22 -0
- package/dist/paginate.d.ts +18 -0
- package/dist/paginate.js +27 -0
- package/dist/preview.d.ts +40 -0
- package/dist/preview.js +131 -0
- package/dist/protection.d.ts +74 -0
- package/dist/protection.js +68 -0
- package/dist/revalidate.d.ts +84 -0
- package/dist/revalidate.js +143 -0
- package/dist/seo.d.ts +120 -0
- package/dist/seo.js +125 -0
- package/dist/server-key.d.ts +71 -0
- package/dist/server-key.js +103 -0
- package/dist/shared/api/delivery/cache-tags.d.ts +142 -0
- package/dist/shared/api/delivery/cache-tags.js +212 -0
- package/dist/shared/api/server-key.d.ts +86 -0
- package/dist/shared/api/server-key.js +252 -0
- package/dist/shared/business-registry/attribution.d.ts +14 -0
- package/dist/shared/business-registry/attribution.js +28 -0
- package/dist/shared/business-registry/define.d.ts +3 -0
- package/dist/shared/business-registry/define.js +4 -0
- package/dist/shared/business-registry/formats/eu-vat.d.ts +2 -0
- package/dist/shared/business-registry/formats/eu-vat.js +54 -0
- package/dist/shared/business-registry/formats/hk-br.d.ts +5 -0
- package/dist/shared/business-registry/formats/hk-br.js +23 -0
- package/dist/shared/business-registry/formats/jp-trn.d.ts +6 -0
- package/dist/shared/business-registry/formats/jp-trn.js +23 -0
- package/dist/shared/business-registry/formats/kr-brn.d.ts +6 -0
- package/dist/shared/business-registry/formats/kr-brn.js +30 -0
- package/dist/shared/business-registry/formats/my.d.ts +7 -0
- package/dist/shared/business-registry/formats/my.js +32 -0
- package/dist/shared/business-registry/formats/sg-uen.d.ts +1 -0
- package/dist/shared/business-registry/formats/sg-uen.js +21 -0
- package/dist/shared/business-registry/formats/tw-vat.d.ts +10 -0
- package/dist/shared/business-registry/formats/tw-vat.js +32 -0
- package/dist/shared/business-registry/index.d.ts +9 -0
- package/dist/shared/business-registry/index.js +10 -0
- package/dist/shared/business-registry/lookup-wire.d.ts +33 -0
- package/dist/shared/business-registry/lookup-wire.js +8 -0
- package/dist/shared/business-registry/normalize.d.ts +7 -0
- package/dist/shared/business-registry/normalize.js +12 -0
- package/dist/shared/business-registry/registry.d.ts +26 -0
- package/dist/shared/business-registry/registry.js +67 -0
- package/dist/shared/business-registry/types.d.ts +60 -0
- package/dist/shared/business-registry/types.js +10 -0
- package/dist/shared/localization/locale-path.d.ts +38 -0
- package/dist/shared/localization/locale-path.js +76 -0
- package/dist/shared/localization/request-locale.d.ts +42 -0
- package/dist/shared/localization/request-locale.js +61 -0
- package/dist/shared/seo/alternates.d.ts +61 -0
- package/dist/shared/seo/alternates.js +71 -0
- package/dist/shared/types/forms-logic.d.ts +96 -0
- package/dist/shared/types/forms-logic.js +209 -0
- package/dist/shared/types/number-input.d.ts +5 -0
- package/dist/shared/types/number-input.js +16 -0
- package/dist/shared/utils/redirect-matching.d.ts +67 -0
- package/dist/shared/utils/redirect-matching.js +148 -0
- package/dist/tax-id.d.ts +7 -0
- package/dist/tax-id.js +6 -0
- package/dist/typed.d.ts +85 -0
- package/dist/typed.js +28 -0
- package/package.json +86 -3
|
@@ -0,0 +1,3157 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/openapi.json": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/** This OpenAPI document */
|
|
15
|
+
get: operations["customer_openapi"];
|
|
16
|
+
put?: never;
|
|
17
|
+
post?: never;
|
|
18
|
+
delete?: never;
|
|
19
|
+
options?: never;
|
|
20
|
+
head?: never;
|
|
21
|
+
patch?: never;
|
|
22
|
+
trace?: never;
|
|
23
|
+
};
|
|
24
|
+
"/auth/protection": {
|
|
25
|
+
parameters: {
|
|
26
|
+
query?: never;
|
|
27
|
+
header?: never;
|
|
28
|
+
path?: never;
|
|
29
|
+
cookie?: never;
|
|
30
|
+
};
|
|
31
|
+
/** Get the bot check to pass before requesting a login code */
|
|
32
|
+
get: operations["customer_auth_protection"];
|
|
33
|
+
put?: never;
|
|
34
|
+
post?: never;
|
|
35
|
+
delete?: never;
|
|
36
|
+
options?: never;
|
|
37
|
+
head?: never;
|
|
38
|
+
patch?: never;
|
|
39
|
+
trace?: never;
|
|
40
|
+
};
|
|
41
|
+
"/auth/challenge": {
|
|
42
|
+
parameters: {
|
|
43
|
+
query?: never;
|
|
44
|
+
header?: never;
|
|
45
|
+
path?: never;
|
|
46
|
+
cookie?: never;
|
|
47
|
+
};
|
|
48
|
+
get?: never;
|
|
49
|
+
put?: never;
|
|
50
|
+
/** Request a login code / magic link by email */
|
|
51
|
+
post: operations["customer_auth_challenge"];
|
|
52
|
+
delete?: never;
|
|
53
|
+
options?: never;
|
|
54
|
+
head?: never;
|
|
55
|
+
patch?: never;
|
|
56
|
+
trace?: never;
|
|
57
|
+
};
|
|
58
|
+
"/auth/verify": {
|
|
59
|
+
parameters: {
|
|
60
|
+
query?: never;
|
|
61
|
+
header?: never;
|
|
62
|
+
path?: never;
|
|
63
|
+
cookie?: never;
|
|
64
|
+
};
|
|
65
|
+
get?: never;
|
|
66
|
+
put?: never;
|
|
67
|
+
/** Exchange a code, magic-link token or social sign-in handoff ticket for a Bearer session */
|
|
68
|
+
post: operations["customer_auth_verify"];
|
|
69
|
+
delete?: never;
|
|
70
|
+
options?: never;
|
|
71
|
+
head?: never;
|
|
72
|
+
patch?: never;
|
|
73
|
+
trace?: never;
|
|
74
|
+
};
|
|
75
|
+
"/auth/oauth/start": {
|
|
76
|
+
parameters: {
|
|
77
|
+
query?: never;
|
|
78
|
+
header?: never;
|
|
79
|
+
path?: never;
|
|
80
|
+
cookie?: never;
|
|
81
|
+
};
|
|
82
|
+
get?: never;
|
|
83
|
+
put?: never;
|
|
84
|
+
/** Start a social sign-in (Google) and get the provider URL to redirect to */
|
|
85
|
+
post: operations["customer_auth_oauth_start"];
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
92
|
+
"/auth/oauth2/token": {
|
|
93
|
+
parameters: {
|
|
94
|
+
query?: never;
|
|
95
|
+
header?: never;
|
|
96
|
+
path?: never;
|
|
97
|
+
cookie?: never;
|
|
98
|
+
};
|
|
99
|
+
get?: never;
|
|
100
|
+
put?: never;
|
|
101
|
+
/**
|
|
102
|
+
* Exchange an authorization code from the hosted sign-in page, or rotate a refresh token
|
|
103
|
+
* @description OAuth 2.1 token endpoint for the hosted sign-in page. Send the customer to `{siteUrl}/account/login?client_id={siteId}&redirect_uri=...&code_challenge=...&code_challenge_method=S256&state=...`; after signing in they come back to `redirect_uri` with `?code&state`. Exchange the code here with the PKCE `code_verifier` (public client, no secret). `redirect_uri` must be https and its origin must be listed under Site settings › Developer › Allowed origins. Refresh tokens rotate on every use; reusing an old one revokes the whole session.
|
|
104
|
+
*/
|
|
105
|
+
post: operations["customer_auth_oauth2_token"];
|
|
106
|
+
delete?: never;
|
|
107
|
+
options?: never;
|
|
108
|
+
head?: never;
|
|
109
|
+
patch?: never;
|
|
110
|
+
trace?: never;
|
|
111
|
+
};
|
|
112
|
+
"/auth/oauth2/revoke": {
|
|
113
|
+
parameters: {
|
|
114
|
+
query?: never;
|
|
115
|
+
header?: never;
|
|
116
|
+
path?: never;
|
|
117
|
+
cookie?: never;
|
|
118
|
+
};
|
|
119
|
+
get?: never;
|
|
120
|
+
put?: never;
|
|
121
|
+
/**
|
|
122
|
+
* Revoke a customer access token or refresh token
|
|
123
|
+
* @description RFC 7009. Revoking either token ends the whole session. Always returns 200, even for unknown tokens.
|
|
124
|
+
*/
|
|
125
|
+
post: operations["customer_auth_oauth2_revoke"];
|
|
126
|
+
delete?: never;
|
|
127
|
+
options?: never;
|
|
128
|
+
head?: never;
|
|
129
|
+
patch?: never;
|
|
130
|
+
trace?: never;
|
|
131
|
+
};
|
|
132
|
+
"/auth/passkey/options": {
|
|
133
|
+
parameters: {
|
|
134
|
+
query?: never;
|
|
135
|
+
header?: never;
|
|
136
|
+
path?: never;
|
|
137
|
+
cookie?: never;
|
|
138
|
+
};
|
|
139
|
+
get?: never;
|
|
140
|
+
put?: never;
|
|
141
|
+
/** Get WebAuthn request options to sign in with a passkey */
|
|
142
|
+
post: operations["customer_auth_passkey_options"];
|
|
143
|
+
delete?: never;
|
|
144
|
+
options?: never;
|
|
145
|
+
head?: never;
|
|
146
|
+
patch?: never;
|
|
147
|
+
trace?: never;
|
|
148
|
+
};
|
|
149
|
+
"/auth/passkey/verify": {
|
|
150
|
+
parameters: {
|
|
151
|
+
query?: never;
|
|
152
|
+
header?: never;
|
|
153
|
+
path?: never;
|
|
154
|
+
cookie?: never;
|
|
155
|
+
};
|
|
156
|
+
get?: never;
|
|
157
|
+
put?: never;
|
|
158
|
+
/** Verify a passkey assertion and get a Bearer session */
|
|
159
|
+
post: operations["customer_auth_passkey_verify"];
|
|
160
|
+
delete?: never;
|
|
161
|
+
options?: never;
|
|
162
|
+
head?: never;
|
|
163
|
+
patch?: never;
|
|
164
|
+
trace?: never;
|
|
165
|
+
};
|
|
166
|
+
"/passkeys": {
|
|
167
|
+
parameters: {
|
|
168
|
+
query?: never;
|
|
169
|
+
header?: never;
|
|
170
|
+
path?: never;
|
|
171
|
+
cookie?: never;
|
|
172
|
+
};
|
|
173
|
+
/** List the customer's passkeys */
|
|
174
|
+
get: operations["customer_passkeys_list"];
|
|
175
|
+
put?: never;
|
|
176
|
+
post?: never;
|
|
177
|
+
delete?: never;
|
|
178
|
+
options?: never;
|
|
179
|
+
head?: never;
|
|
180
|
+
patch?: never;
|
|
181
|
+
trace?: never;
|
|
182
|
+
};
|
|
183
|
+
"/passkeys/register/options": {
|
|
184
|
+
parameters: {
|
|
185
|
+
query?: never;
|
|
186
|
+
header?: never;
|
|
187
|
+
path?: never;
|
|
188
|
+
cookie?: never;
|
|
189
|
+
};
|
|
190
|
+
get?: never;
|
|
191
|
+
put?: never;
|
|
192
|
+
/** Get WebAuthn creation options to add a passkey */
|
|
193
|
+
post: operations["customer_passkeys_register_options"];
|
|
194
|
+
delete?: never;
|
|
195
|
+
options?: never;
|
|
196
|
+
head?: never;
|
|
197
|
+
patch?: never;
|
|
198
|
+
trace?: never;
|
|
199
|
+
};
|
|
200
|
+
"/passkeys/register": {
|
|
201
|
+
parameters: {
|
|
202
|
+
query?: never;
|
|
203
|
+
header?: never;
|
|
204
|
+
path?: never;
|
|
205
|
+
cookie?: never;
|
|
206
|
+
};
|
|
207
|
+
get?: never;
|
|
208
|
+
put?: never;
|
|
209
|
+
/** Verify a WebAuthn registration and save the passkey */
|
|
210
|
+
post: operations["customer_passkeys_register"];
|
|
211
|
+
delete?: never;
|
|
212
|
+
options?: never;
|
|
213
|
+
head?: never;
|
|
214
|
+
patch?: never;
|
|
215
|
+
trace?: never;
|
|
216
|
+
};
|
|
217
|
+
"/passkeys/{id}": {
|
|
218
|
+
parameters: {
|
|
219
|
+
query?: never;
|
|
220
|
+
header?: never;
|
|
221
|
+
path?: never;
|
|
222
|
+
cookie?: never;
|
|
223
|
+
};
|
|
224
|
+
get?: never;
|
|
225
|
+
put?: never;
|
|
226
|
+
post?: never;
|
|
227
|
+
/** Remove one of the customer's passkeys */
|
|
228
|
+
delete: operations["customer_passkeys_delete"];
|
|
229
|
+
options?: never;
|
|
230
|
+
head?: never;
|
|
231
|
+
patch?: never;
|
|
232
|
+
trace?: never;
|
|
233
|
+
};
|
|
234
|
+
"/data": {
|
|
235
|
+
parameters: {
|
|
236
|
+
query?: never;
|
|
237
|
+
header?: never;
|
|
238
|
+
path?: never;
|
|
239
|
+
cookie?: never;
|
|
240
|
+
};
|
|
241
|
+
/**
|
|
242
|
+
* Download everything the site holds about the signed-in customer
|
|
243
|
+
* @description One JSON document for a data subject access request: profile, identities, addresses, tax IDs, consent and its log, groups, access grants, timeline, order summaries, form submissions and message summaries. The same document the site owner can download from the back office.
|
|
244
|
+
*/
|
|
245
|
+
get: operations["customer_data_export"];
|
|
246
|
+
put?: never;
|
|
247
|
+
post?: never;
|
|
248
|
+
delete?: never;
|
|
249
|
+
options?: never;
|
|
250
|
+
head?: never;
|
|
251
|
+
patch?: never;
|
|
252
|
+
trace?: never;
|
|
253
|
+
};
|
|
254
|
+
"/erasure": {
|
|
255
|
+
parameters: {
|
|
256
|
+
query?: never;
|
|
257
|
+
header?: never;
|
|
258
|
+
path?: never;
|
|
259
|
+
cookie?: never;
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* Account deletion status
|
|
263
|
+
* @description Whether the account was already anonymized and whether a deletion request is scheduled (customers can cancel it until it runs).
|
|
264
|
+
*/
|
|
265
|
+
get: operations["customer_erasure_get"];
|
|
266
|
+
put?: never;
|
|
267
|
+
/**
|
|
268
|
+
* Request account deletion (runs after a 7-day grace period)
|
|
269
|
+
* @description Schedules anonymization 7 days from now. Until then the customer can cancel with DELETE /erasure and the site owner can cancel from the back office. When it runs, identities, name, addresses, tax IDs, passkeys, sessions, form submissions, notes and metadata are removed and sign-in is blocked; orders, invoices and consent evidence (without IP or user agent) remain because the site owner must keep financial records.
|
|
270
|
+
*/
|
|
271
|
+
post: operations["customer_erasure_request"];
|
|
272
|
+
/** Cancel a scheduled account deletion */
|
|
273
|
+
delete: operations["customer_erasure_cancel"];
|
|
274
|
+
options?: never;
|
|
275
|
+
head?: never;
|
|
276
|
+
patch?: never;
|
|
277
|
+
trace?: never;
|
|
278
|
+
};
|
|
279
|
+
"/me": {
|
|
280
|
+
parameters: {
|
|
281
|
+
query?: never;
|
|
282
|
+
header?: never;
|
|
283
|
+
path?: never;
|
|
284
|
+
cookie?: never;
|
|
285
|
+
};
|
|
286
|
+
/** Current contact and sessions */
|
|
287
|
+
get: operations["customer_me"];
|
|
288
|
+
put?: never;
|
|
289
|
+
post?: never;
|
|
290
|
+
delete?: never;
|
|
291
|
+
options?: never;
|
|
292
|
+
head?: never;
|
|
293
|
+
/**
|
|
294
|
+
* Update the customer's name and preferences
|
|
295
|
+
* @description Name, default e-invoice preference (where the site issues e-invoices) and player preferences. Email is changed through /email-change; tax IDs through /tax-identities.
|
|
296
|
+
*/
|
|
297
|
+
patch: operations["customer_me_update"];
|
|
298
|
+
trace?: never;
|
|
299
|
+
};
|
|
300
|
+
"/email-change": {
|
|
301
|
+
parameters: {
|
|
302
|
+
query?: never;
|
|
303
|
+
header?: never;
|
|
304
|
+
path?: never;
|
|
305
|
+
cookie?: never;
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* Pending email change
|
|
309
|
+
* @description The new address a verification code was sent to, if a change is in progress.
|
|
310
|
+
*/
|
|
311
|
+
get: operations["customer_email_change_get"];
|
|
312
|
+
put?: never;
|
|
313
|
+
/**
|
|
314
|
+
* Start changing the account email
|
|
315
|
+
* @description Sends a 6-digit verification code to the new address. The customer stays signed in. Fails with EMAIL_IN_USE when another customer of the site already uses the address (accounts are not merged). Limited to 5 requests per hour per customer; a new request replaces the previous code.
|
|
316
|
+
*/
|
|
317
|
+
post: operations["customer_email_change_start"];
|
|
318
|
+
delete?: never;
|
|
319
|
+
options?: never;
|
|
320
|
+
head?: never;
|
|
321
|
+
patch?: never;
|
|
322
|
+
trace?: never;
|
|
323
|
+
};
|
|
324
|
+
"/email-change/verify": {
|
|
325
|
+
parameters: {
|
|
326
|
+
query?: never;
|
|
327
|
+
header?: never;
|
|
328
|
+
path?: never;
|
|
329
|
+
cookie?: never;
|
|
330
|
+
};
|
|
331
|
+
get?: never;
|
|
332
|
+
put?: never;
|
|
333
|
+
/**
|
|
334
|
+
* Confirm the new email with the code
|
|
335
|
+
* @description Replaces the account email and its sign-in identity. Existing sessions stay valid. Five wrong attempts invalidate the code.
|
|
336
|
+
*/
|
|
337
|
+
post: operations["customer_email_change_verify"];
|
|
338
|
+
delete?: never;
|
|
339
|
+
options?: never;
|
|
340
|
+
head?: never;
|
|
341
|
+
patch?: never;
|
|
342
|
+
trace?: never;
|
|
343
|
+
};
|
|
344
|
+
"/addresses": {
|
|
345
|
+
parameters: {
|
|
346
|
+
query?: never;
|
|
347
|
+
header?: never;
|
|
348
|
+
path?: never;
|
|
349
|
+
cookie?: never;
|
|
350
|
+
};
|
|
351
|
+
/**
|
|
352
|
+
* List saved addresses
|
|
353
|
+
* @description Shipping and billing addresses in the customer's address book. Each kind has one default.
|
|
354
|
+
*/
|
|
355
|
+
get: operations["customer_addresses_list"];
|
|
356
|
+
put?: never;
|
|
357
|
+
/**
|
|
358
|
+
* Add an address
|
|
359
|
+
* @description Fields and required parts follow the country's postal format (the same registry the checkout and form address fields use). An address identical to an existing one of the same kind returns that one instead of creating a duplicate. The first address of a kind becomes the default.
|
|
360
|
+
*/
|
|
361
|
+
post: operations["customer_addresses_create"];
|
|
362
|
+
delete?: never;
|
|
363
|
+
options?: never;
|
|
364
|
+
head?: never;
|
|
365
|
+
patch?: never;
|
|
366
|
+
trace?: never;
|
|
367
|
+
};
|
|
368
|
+
"/addresses/{id}": {
|
|
369
|
+
parameters: {
|
|
370
|
+
query?: never;
|
|
371
|
+
header?: never;
|
|
372
|
+
path?: never;
|
|
373
|
+
cookie?: never;
|
|
374
|
+
};
|
|
375
|
+
get?: never;
|
|
376
|
+
put?: never;
|
|
377
|
+
post?: never;
|
|
378
|
+
/**
|
|
379
|
+
* Remove an address
|
|
380
|
+
* @description When the default of a kind is removed, the most recently added address of that kind becomes the default.
|
|
381
|
+
*/
|
|
382
|
+
delete: operations["customer_addresses_delete"];
|
|
383
|
+
options?: never;
|
|
384
|
+
head?: never;
|
|
385
|
+
/**
|
|
386
|
+
* Replace an address
|
|
387
|
+
* @description The whole address is replaced. When the result equals another saved address of the same kind, the two are merged into that one.
|
|
388
|
+
*/
|
|
389
|
+
patch: operations["customer_addresses_update"];
|
|
390
|
+
trace?: never;
|
|
391
|
+
};
|
|
392
|
+
"/addresses/{id}/default": {
|
|
393
|
+
parameters: {
|
|
394
|
+
query?: never;
|
|
395
|
+
header?: never;
|
|
396
|
+
path?: never;
|
|
397
|
+
cookie?: never;
|
|
398
|
+
};
|
|
399
|
+
get?: never;
|
|
400
|
+
put?: never;
|
|
401
|
+
/** Make an address the default of its kind */
|
|
402
|
+
post: operations["customer_addresses_set_default"];
|
|
403
|
+
delete?: never;
|
|
404
|
+
options?: never;
|
|
405
|
+
head?: never;
|
|
406
|
+
patch?: never;
|
|
407
|
+
trace?: never;
|
|
408
|
+
};
|
|
409
|
+
"/tax-identities": {
|
|
410
|
+
parameters: {
|
|
411
|
+
query?: never;
|
|
412
|
+
header?: never;
|
|
413
|
+
path?: never;
|
|
414
|
+
cookie?: never;
|
|
415
|
+
};
|
|
416
|
+
/**
|
|
417
|
+
* List the customer's tax IDs
|
|
418
|
+
* @description One per country and type, with the verification status against the public registry where one exists.
|
|
419
|
+
*/
|
|
420
|
+
get: operations["customer_tax_identities_list"];
|
|
421
|
+
/**
|
|
422
|
+
* Add or update a tax ID
|
|
423
|
+
* @description Keyed by country and type (type defaults to the country's first registered type). Format and checksum follow the shared business-registry rules; a changed number is re-verified asynchronously. Verification results are informational and never block checkout.
|
|
424
|
+
*/
|
|
425
|
+
put: operations["customer_tax_identities_upsert"];
|
|
426
|
+
post?: never;
|
|
427
|
+
delete?: never;
|
|
428
|
+
options?: never;
|
|
429
|
+
head?: never;
|
|
430
|
+
patch?: never;
|
|
431
|
+
trace?: never;
|
|
432
|
+
};
|
|
433
|
+
"/tax-identities/{id}": {
|
|
434
|
+
parameters: {
|
|
435
|
+
query?: never;
|
|
436
|
+
header?: never;
|
|
437
|
+
path?: never;
|
|
438
|
+
cookie?: never;
|
|
439
|
+
};
|
|
440
|
+
get?: never;
|
|
441
|
+
put?: never;
|
|
442
|
+
post?: never;
|
|
443
|
+
/** Remove a tax ID */
|
|
444
|
+
delete: operations["customer_tax_identities_delete"];
|
|
445
|
+
options?: never;
|
|
446
|
+
head?: never;
|
|
447
|
+
patch?: never;
|
|
448
|
+
trace?: never;
|
|
449
|
+
};
|
|
450
|
+
"/consents": {
|
|
451
|
+
parameters: {
|
|
452
|
+
query?: never;
|
|
453
|
+
header?: never;
|
|
454
|
+
path?: never;
|
|
455
|
+
cookie?: never;
|
|
456
|
+
};
|
|
457
|
+
/**
|
|
458
|
+
* Marketing preferences per channel
|
|
459
|
+
* @description Channels the customer can be reached on (email, SMS, LINE, WhatsApp) with the current marketing status. Bounced or complained channels are locked.
|
|
460
|
+
*/
|
|
461
|
+
get: operations["customer_consents_list"];
|
|
462
|
+
put?: never;
|
|
463
|
+
post?: never;
|
|
464
|
+
delete?: never;
|
|
465
|
+
options?: never;
|
|
466
|
+
head?: never;
|
|
467
|
+
/**
|
|
468
|
+
* Subscribe or unsubscribe one channel
|
|
469
|
+
* @description Recorded as a first-party consent change (source LOGIN) with IP and user agent as evidence; a previously unsubscribed customer can re-subscribe here.
|
|
470
|
+
*/
|
|
471
|
+
patch: operations["customer_consents_update"];
|
|
472
|
+
trace?: never;
|
|
473
|
+
};
|
|
474
|
+
"/session": {
|
|
475
|
+
parameters: {
|
|
476
|
+
query?: never;
|
|
477
|
+
header?: never;
|
|
478
|
+
path?: never;
|
|
479
|
+
cookie?: never;
|
|
480
|
+
};
|
|
481
|
+
get?: never;
|
|
482
|
+
put?: never;
|
|
483
|
+
post?: never;
|
|
484
|
+
/** Revoke sessions */
|
|
485
|
+
delete: operations["customer_session_revoke"];
|
|
486
|
+
options?: never;
|
|
487
|
+
head?: never;
|
|
488
|
+
patch?: never;
|
|
489
|
+
trace?: never;
|
|
490
|
+
};
|
|
491
|
+
"/deliverables": {
|
|
492
|
+
parameters: {
|
|
493
|
+
query?: never;
|
|
494
|
+
header?: never;
|
|
495
|
+
path?: never;
|
|
496
|
+
cookie?: never;
|
|
497
|
+
};
|
|
498
|
+
/** Deliverables the customer has access to */
|
|
499
|
+
get: operations["customer_deliverables_list"];
|
|
500
|
+
put?: never;
|
|
501
|
+
post?: never;
|
|
502
|
+
delete?: never;
|
|
503
|
+
options?: never;
|
|
504
|
+
head?: never;
|
|
505
|
+
patch?: never;
|
|
506
|
+
trace?: never;
|
|
507
|
+
};
|
|
508
|
+
"/deliverables/{deliverableId}": {
|
|
509
|
+
parameters: {
|
|
510
|
+
query?: never;
|
|
511
|
+
header?: never;
|
|
512
|
+
path?: never;
|
|
513
|
+
cookie?: never;
|
|
514
|
+
};
|
|
515
|
+
/** Deliverable tree with per-unit access and progress */
|
|
516
|
+
get: operations["customer_deliverables_get"];
|
|
517
|
+
put?: never;
|
|
518
|
+
post?: never;
|
|
519
|
+
delete?: never;
|
|
520
|
+
options?: never;
|
|
521
|
+
head?: never;
|
|
522
|
+
patch?: never;
|
|
523
|
+
trace?: never;
|
|
524
|
+
};
|
|
525
|
+
"/deliverables/{deliverableId}/progress": {
|
|
526
|
+
parameters: {
|
|
527
|
+
query?: never;
|
|
528
|
+
header?: never;
|
|
529
|
+
path?: never;
|
|
530
|
+
cookie?: never;
|
|
531
|
+
};
|
|
532
|
+
/** Progress summary for a deliverable */
|
|
533
|
+
get: operations["customer_deliverables_progress"];
|
|
534
|
+
put?: never;
|
|
535
|
+
post?: never;
|
|
536
|
+
delete?: never;
|
|
537
|
+
options?: never;
|
|
538
|
+
head?: never;
|
|
539
|
+
patch?: never;
|
|
540
|
+
trace?: never;
|
|
541
|
+
};
|
|
542
|
+
"/units/{id}/open": {
|
|
543
|
+
parameters: {
|
|
544
|
+
query?: never;
|
|
545
|
+
header?: never;
|
|
546
|
+
path?: never;
|
|
547
|
+
cookie?: never;
|
|
548
|
+
};
|
|
549
|
+
get?: never;
|
|
550
|
+
put?: never;
|
|
551
|
+
/** Get a short-lived URL to read or download a unit, or one of its attachments */
|
|
552
|
+
post: operations["customer_units_open"];
|
|
553
|
+
delete?: never;
|
|
554
|
+
options?: never;
|
|
555
|
+
head?: never;
|
|
556
|
+
patch?: never;
|
|
557
|
+
trace?: never;
|
|
558
|
+
};
|
|
559
|
+
"/units/{id}/transcript": {
|
|
560
|
+
parameters: {
|
|
561
|
+
query?: never;
|
|
562
|
+
header?: never;
|
|
563
|
+
path?: never;
|
|
564
|
+
cookie?: never;
|
|
565
|
+
};
|
|
566
|
+
/** Get the transcript of a video or audio unit (same tracks as the captions renditions) */
|
|
567
|
+
get: operations["customer_units_transcript"];
|
|
568
|
+
put?: never;
|
|
569
|
+
post?: never;
|
|
570
|
+
delete?: never;
|
|
571
|
+
options?: never;
|
|
572
|
+
head?: never;
|
|
573
|
+
patch?: never;
|
|
574
|
+
trace?: never;
|
|
575
|
+
};
|
|
576
|
+
"/units/{id}/quiz": {
|
|
577
|
+
parameters: {
|
|
578
|
+
query?: never;
|
|
579
|
+
header?: never;
|
|
580
|
+
path?: never;
|
|
581
|
+
cookie?: never;
|
|
582
|
+
};
|
|
583
|
+
get?: never;
|
|
584
|
+
put?: never;
|
|
585
|
+
/** Submit quiz answers (server grades; passing a graded quiz, or any submission of a practice quiz, marks the unit complete) */
|
|
586
|
+
post: operations["customer_units_quiz_submit"];
|
|
587
|
+
delete?: never;
|
|
588
|
+
options?: never;
|
|
589
|
+
head?: never;
|
|
590
|
+
patch?: never;
|
|
591
|
+
trace?: never;
|
|
592
|
+
};
|
|
593
|
+
"/deliverables/{deliverableId}/certificate": {
|
|
594
|
+
parameters: {
|
|
595
|
+
query?: never;
|
|
596
|
+
header?: never;
|
|
597
|
+
path?: never;
|
|
598
|
+
cookie?: never;
|
|
599
|
+
};
|
|
600
|
+
/** Short-lived download URL for the completion certificate (issued once the deliverable is completed and certificates are enabled) */
|
|
601
|
+
get: operations["customer_deliverables_certificate"];
|
|
602
|
+
put?: never;
|
|
603
|
+
post?: never;
|
|
604
|
+
delete?: never;
|
|
605
|
+
options?: never;
|
|
606
|
+
head?: never;
|
|
607
|
+
patch?: never;
|
|
608
|
+
trace?: never;
|
|
609
|
+
};
|
|
610
|
+
"/progress": {
|
|
611
|
+
parameters: {
|
|
612
|
+
query?: never;
|
|
613
|
+
header?: never;
|
|
614
|
+
path?: never;
|
|
615
|
+
cookie?: never;
|
|
616
|
+
};
|
|
617
|
+
get?: never;
|
|
618
|
+
put?: never;
|
|
619
|
+
/** Report playback/reading progress (server decides completion) */
|
|
620
|
+
post: operations["customer_progress_report"];
|
|
621
|
+
delete?: never;
|
|
622
|
+
options?: never;
|
|
623
|
+
head?: never;
|
|
624
|
+
patch?: never;
|
|
625
|
+
trace?: never;
|
|
626
|
+
};
|
|
627
|
+
"/access/{id}": {
|
|
628
|
+
parameters: {
|
|
629
|
+
query?: never;
|
|
630
|
+
header?: never;
|
|
631
|
+
path?: never;
|
|
632
|
+
cookie?: never;
|
|
633
|
+
};
|
|
634
|
+
/** Check access to a deliverable (id or key) or a unit (`type=unit`) */
|
|
635
|
+
get: operations["customer_access_check"];
|
|
636
|
+
put?: never;
|
|
637
|
+
post?: never;
|
|
638
|
+
delete?: never;
|
|
639
|
+
options?: never;
|
|
640
|
+
head?: never;
|
|
641
|
+
patch?: never;
|
|
642
|
+
trace?: never;
|
|
643
|
+
};
|
|
644
|
+
"/orders": {
|
|
645
|
+
parameters: {
|
|
646
|
+
query?: never;
|
|
647
|
+
header?: never;
|
|
648
|
+
path?: never;
|
|
649
|
+
cookie?: never;
|
|
650
|
+
};
|
|
651
|
+
/** The customer's orders */
|
|
652
|
+
get: operations["customer_orders_list"];
|
|
653
|
+
put?: never;
|
|
654
|
+
post?: never;
|
|
655
|
+
delete?: never;
|
|
656
|
+
options?: never;
|
|
657
|
+
head?: never;
|
|
658
|
+
patch?: never;
|
|
659
|
+
trace?: never;
|
|
660
|
+
};
|
|
661
|
+
"/orders/{id}": {
|
|
662
|
+
parameters: {
|
|
663
|
+
query?: never;
|
|
664
|
+
header?: never;
|
|
665
|
+
path?: never;
|
|
666
|
+
cookie?: never;
|
|
667
|
+
};
|
|
668
|
+
/**
|
|
669
|
+
* One order as the order status view (add `receipt=1` for the receipt payload)
|
|
670
|
+
* @description Returns the same OrderStatus shape the hosted order status page renders (`viewer: "customer"`): state, order number and financial status, items (with refunded quantities), totals (with refunded amount), payment, fulfillment with shipments, invoice, refunds and `receiptAvailable`. Build one order page from it; the purchase page a signed link opens is the same shape with `viewer: "signed_link"` or `"expired_link"`.
|
|
671
|
+
*/
|
|
672
|
+
get: operations["customer_orders_get"];
|
|
673
|
+
put?: never;
|
|
674
|
+
post?: never;
|
|
675
|
+
delete?: never;
|
|
676
|
+
options?: never;
|
|
677
|
+
head?: never;
|
|
678
|
+
patch?: never;
|
|
679
|
+
trace?: never;
|
|
680
|
+
};
|
|
681
|
+
"/reviews": {
|
|
682
|
+
parameters: {
|
|
683
|
+
query?: never;
|
|
684
|
+
header?: never;
|
|
685
|
+
path?: never;
|
|
686
|
+
cookie?: never;
|
|
687
|
+
};
|
|
688
|
+
/**
|
|
689
|
+
* The customer's own reviews on the given order lines
|
|
690
|
+
* @description Returns a map keyed by order line id. Order lines without a review from this customer are omitted. Use it to decide whether to show a “write a review” or “edit your review” button.
|
|
691
|
+
*/
|
|
692
|
+
get: operations["customer_reviews_status"];
|
|
693
|
+
put?: never;
|
|
694
|
+
/**
|
|
695
|
+
* Submit a review for a paid order line
|
|
696
|
+
* @description Eligibility is checked by the store: the order line must belong to this customer and be paid (digital products also need a live entitlement). The review starts as PENDING until the store approves it. One review per order line.
|
|
697
|
+
*/
|
|
698
|
+
post: operations["customer_reviews_submit"];
|
|
699
|
+
delete?: never;
|
|
700
|
+
options?: never;
|
|
701
|
+
head?: never;
|
|
702
|
+
/**
|
|
703
|
+
* Edit the customer's own review
|
|
704
|
+
* @description Only reviews written by this customer can be edited. An edited review goes back to PENDING and is re-moderated by the store.
|
|
705
|
+
*/
|
|
706
|
+
patch: operations["customer_reviews_update"];
|
|
707
|
+
trace?: never;
|
|
708
|
+
};
|
|
709
|
+
}
|
|
710
|
+
export type webhooks = Record<string, never>;
|
|
711
|
+
export interface components {
|
|
712
|
+
schemas: {
|
|
713
|
+
ErrorEnvelope: {
|
|
714
|
+
error: {
|
|
715
|
+
code: components["schemas"]["ErrorCode"];
|
|
716
|
+
/** @description English, one sentence. */
|
|
717
|
+
message: string;
|
|
718
|
+
/** @description Structured details for the code (e.g. retryAfter, availableAt, issues). */
|
|
719
|
+
details?: unknown;
|
|
720
|
+
};
|
|
721
|
+
};
|
|
722
|
+
/** @enum {string} */
|
|
723
|
+
ErrorCode: "ACCOUNT_BLOCKED" | "ADDRESS_INVALID" | "ADDRESS_LIMIT_REACHED" | "ALREADY_ANONYMIZED" | "ALREADY_REGISTERED" | "ALREADY_REVIEWED" | "ATTACHMENT_NOT_FOUND" | "BAD_HOST" | "BOT_PROTECTION_FAILED" | "CERTIFICATE_DISABLED" | "CHALLENGE_EXPIRED" | "CODE_EXPIRED" | "CONSENT_LOCKED" | "DELIVERABLE_NOT_FOUND" | "DOWNLOAD_NOT_ALLOWED" | "EMAIL_IN_USE" | "EMAIL_NOT_VERIFIED" | "ERASURE_ALREADY_REQUESTED" | "ERASURE_NOT_PENDING" | "EXPIRED" | "FILE_NOT_PROTECTED" | "FORBIDDEN" | "INVALID_CLIENT" | "INVALID_CODE" | "INVALID_CURSOR" | "INVALID_EMAIL" | "INVALID_GRANT" | "INVALID_LIMIT" | "INVALID_REQUEST" | "INVALID_TAX_ID" | "LIMIT_REACHED" | "LOCKED" | "METHOD_DISABLED" | "METHOD_NOT_ALLOWED" | "NOT_A_QUIZ" | "NOT_FOUND" | "NOT_RELEASED" | "NO_ATTEMPTS_LEFT" | "NO_FILE" | "NO_RECEIPT" | "NO_TRANSCRIPT" | "ORDER_NOT_FOUND" | "QUIZ_NOT_READY" | "RATE_LIMITED" | "REVIEWS_DISABLED" | "SAME_EMAIL" | "SEND_FAILED" | "SERVICE_UNAVAILABLE" | "SHARED_SENDER_PAUSED" | "SIGN_FAILED" | "SITE_NOT_FOUND" | "TOO_MANY_ATTEMPTS" | "UNAUTHENTICATED" | "UNAUTHORIZED" | "UNIT_NOT_FOUND" | "UNSUPPORTED_COUNTRY" | "UNSUPPORTED_GRANT_TYPE" | "UPSTREAM_UNAVAILABLE" | "VALIDATION" | "VERIFY_FAILED" | "WEBSITE_NOT_FOUND";
|
|
724
|
+
/** @enum {string} */
|
|
725
|
+
ReviewStatus: "PENDING" | "APPROVED" | "REJECTED";
|
|
726
|
+
ReviewSubmitInput: {
|
|
727
|
+
/** @description Order line id from GET /orders/{id}. */
|
|
728
|
+
orderItemId: string;
|
|
729
|
+
rating: number;
|
|
730
|
+
content?: string | null;
|
|
731
|
+
};
|
|
732
|
+
ReviewUpdateInput: {
|
|
733
|
+
reviewId: string;
|
|
734
|
+
rating: number;
|
|
735
|
+
content?: string | null;
|
|
736
|
+
};
|
|
737
|
+
ReviewWriteResponse: {
|
|
738
|
+
reviewId?: string;
|
|
739
|
+
status: components["schemas"]["ReviewStatus"];
|
|
740
|
+
};
|
|
741
|
+
ChallengeInput: {
|
|
742
|
+
/** Format: email */
|
|
743
|
+
email: string;
|
|
744
|
+
locale?: string;
|
|
745
|
+
returnTo?: string;
|
|
746
|
+
/** @description Honeypot. Send an empty string; any value marks the request as automated. */
|
|
747
|
+
_hp?: string;
|
|
748
|
+
/** @description Second honeypot. Send an empty string. */
|
|
749
|
+
_wp?: string;
|
|
750
|
+
/** @description Third honeypot. Send an empty string. */
|
|
751
|
+
_co?: string;
|
|
752
|
+
/** @description When the form was rendered, in Unix milliseconds. */
|
|
753
|
+
_ts?: number;
|
|
754
|
+
/** @description Built-in bot check: the solved ALTCHA payload for the challenge (provider kanorio). */
|
|
755
|
+
_tk?: string;
|
|
756
|
+
/** @description What the built-in challenge was issued for: the form id, or customer-login:{siteId}. */
|
|
757
|
+
_ctx?: string;
|
|
758
|
+
/** @description Third-party bot check: the token from the provider's widget (provider turnstile, recaptcha or hcaptcha). */
|
|
759
|
+
captchaToken?: string;
|
|
760
|
+
} & {
|
|
761
|
+
[key: string]: unknown;
|
|
762
|
+
};
|
|
763
|
+
Oauth2TokenInput: {
|
|
764
|
+
/** @constant */
|
|
765
|
+
grant_type: "authorization_code";
|
|
766
|
+
code: string;
|
|
767
|
+
/** @description The PKCE verifier whose S256 hash was sent as code_challenge. */
|
|
768
|
+
code_verifier: string;
|
|
769
|
+
/** @description Must equal the redirect_uri used on the sign-in page. */
|
|
770
|
+
redirect_uri: string;
|
|
771
|
+
/** @description The site id. */
|
|
772
|
+
client_id: string;
|
|
773
|
+
} | {
|
|
774
|
+
/** @constant */
|
|
775
|
+
grant_type: "refresh_token";
|
|
776
|
+
refresh_token: string;
|
|
777
|
+
client_id: string;
|
|
778
|
+
};
|
|
779
|
+
Oauth2TokenResponse: {
|
|
780
|
+
/** @description A `knr_cat_` customer token; the same credential email-code sign-in returns. */
|
|
781
|
+
access_token: string;
|
|
782
|
+
/** @constant */
|
|
783
|
+
token_type: "Bearer";
|
|
784
|
+
/** @description Seconds until the access token expires (the site's session length). */
|
|
785
|
+
expires_in: number;
|
|
786
|
+
/** Format: date-time */
|
|
787
|
+
expires_at: string;
|
|
788
|
+
/** @description A `knr_crt_` token valid for 90 days; single use, a new one is returned on every refresh. */
|
|
789
|
+
refresh_token: string;
|
|
790
|
+
refresh_token_expires_in: number;
|
|
791
|
+
contactId: string;
|
|
792
|
+
};
|
|
793
|
+
Oauth2RevokeInput: {
|
|
794
|
+
/** @description An access token (`knr_cat_`) or refresh token (`knr_crt_`). */
|
|
795
|
+
token: string;
|
|
796
|
+
/** @enum {string} */
|
|
797
|
+
token_type_hint?: "access_token" | "refresh_token";
|
|
798
|
+
};
|
|
799
|
+
VerifyInput: {
|
|
800
|
+
/** @constant */
|
|
801
|
+
method: "code";
|
|
802
|
+
email: string;
|
|
803
|
+
code: string;
|
|
804
|
+
} | {
|
|
805
|
+
/** @constant */
|
|
806
|
+
method: "link";
|
|
807
|
+
token: string;
|
|
808
|
+
} | {
|
|
809
|
+
/** @constant */
|
|
810
|
+
method: "handoff";
|
|
811
|
+
token: string;
|
|
812
|
+
};
|
|
813
|
+
OauthStartInput: {
|
|
814
|
+
/**
|
|
815
|
+
* @description A social sign-in method the site has enabled (see `customerAccess.methods` on the site).
|
|
816
|
+
* @enum {string}
|
|
817
|
+
*/
|
|
818
|
+
method: "google";
|
|
819
|
+
/** @description Same-site path to return to after sign-in. */
|
|
820
|
+
returnTo?: string;
|
|
821
|
+
locale?: string;
|
|
822
|
+
/** @description Origin of the page that hosts the sign-in UI. Must be one of the site's allowed origins; the handoff ticket is sent back there. */
|
|
823
|
+
baseUrl?: string;
|
|
824
|
+
};
|
|
825
|
+
OauthStartResponse: {
|
|
826
|
+
/** @description Redirect the browser here. The provider sends it back to your page with `?handoff=` to exchange at `/auth/verify`. */
|
|
827
|
+
url: string;
|
|
828
|
+
};
|
|
829
|
+
PasskeyOptionsInput: {
|
|
830
|
+
/** @description Origin the WebAuthn ceremony runs on. Only `localhost` origins are honoured; production always uses the site's primary domain. */
|
|
831
|
+
origin?: string;
|
|
832
|
+
};
|
|
833
|
+
PasskeyAuthOptionsResponse: {
|
|
834
|
+
/** @description `PublicKeyCredentialRequestOptionsJSON` for `navigator.credentials.get()`. */
|
|
835
|
+
options: Record<string, never>;
|
|
836
|
+
challengeId: string;
|
|
837
|
+
};
|
|
838
|
+
PasskeyVerifyInput: {
|
|
839
|
+
challengeId: string;
|
|
840
|
+
/** @description `AuthenticationResponseJSON` from the browser. */
|
|
841
|
+
response: Record<string, never>;
|
|
842
|
+
returnTo?: string;
|
|
843
|
+
locale?: string;
|
|
844
|
+
};
|
|
845
|
+
PasskeyRegisterOptionsResponse: {
|
|
846
|
+
/** @description `PublicKeyCredentialCreationOptionsJSON` for `navigator.credentials.create()`. */
|
|
847
|
+
options: Record<string, never>;
|
|
848
|
+
};
|
|
849
|
+
PasskeyRegisterInput: {
|
|
850
|
+
/** @description `RegistrationResponseJSON` from the browser. */
|
|
851
|
+
response: Record<string, never>;
|
|
852
|
+
/** @description Label shown to the customer; defaults to the device and browser. */
|
|
853
|
+
name?: string;
|
|
854
|
+
};
|
|
855
|
+
Passkey: {
|
|
856
|
+
id: string;
|
|
857
|
+
name: string;
|
|
858
|
+
backedUp: boolean;
|
|
859
|
+
/** Format: date-time */
|
|
860
|
+
createdAt: string;
|
|
861
|
+
/** Format: date-time */
|
|
862
|
+
lastUsedAt: string | null;
|
|
863
|
+
/** @description Bound to a previous primary domain; no longer usable on this site. */
|
|
864
|
+
stale: boolean;
|
|
865
|
+
};
|
|
866
|
+
PasskeyListResponse: {
|
|
867
|
+
passkeys: components["schemas"]["Passkey"][];
|
|
868
|
+
};
|
|
869
|
+
PasskeyRegisterResponse: {
|
|
870
|
+
passkey: components["schemas"]["Passkey"];
|
|
871
|
+
};
|
|
872
|
+
VerifyResponse: {
|
|
873
|
+
sessionToken: string;
|
|
874
|
+
/** @constant */
|
|
875
|
+
tokenType: "Bearer";
|
|
876
|
+
/** @constant */
|
|
877
|
+
channel: "bearer";
|
|
878
|
+
/** Format: date-time */
|
|
879
|
+
expiresAt: string;
|
|
880
|
+
contactId: string;
|
|
881
|
+
returnTo?: string | null;
|
|
882
|
+
};
|
|
883
|
+
CustomerProfileUpdateInput: {
|
|
884
|
+
name?: string | null;
|
|
885
|
+
/** @description Default e-invoice preference in the site's country format (for example Taiwan: invoiceType, carrierType, carrierId, donationCode). Tax ID, company title and address are not part of it; use taxIdentity. */
|
|
886
|
+
invoicePreference?: {
|
|
887
|
+
[key: string]: unknown;
|
|
888
|
+
} | null;
|
|
889
|
+
/** @description Company invoice: the tax ID to issue to (saved to /tax-identities as well). */
|
|
890
|
+
taxIdentity?: components["schemas"]["TaxIdentityInput"] | null;
|
|
891
|
+
playerPreferences?: {
|
|
892
|
+
captions?: {
|
|
893
|
+
locale?: string | null;
|
|
894
|
+
};
|
|
895
|
+
} | null;
|
|
896
|
+
};
|
|
897
|
+
CustomerProfileResponse: {
|
|
898
|
+
contact: components["schemas"]["CustomerContact"];
|
|
899
|
+
};
|
|
900
|
+
EmailChangeStartInput: {
|
|
901
|
+
/**
|
|
902
|
+
* Format: email
|
|
903
|
+
* @description The new address; the code is sent there.
|
|
904
|
+
*/
|
|
905
|
+
email: string;
|
|
906
|
+
/** @description Locale for the verification email; defaults to the customer's locale. */
|
|
907
|
+
locale?: string;
|
|
908
|
+
};
|
|
909
|
+
EmailChangeVerifyInput: {
|
|
910
|
+
code: string;
|
|
911
|
+
};
|
|
912
|
+
EmailChangePending: {
|
|
913
|
+
/** @description The new address the code was sent to. */
|
|
914
|
+
email: string;
|
|
915
|
+
/** Format: date-time */
|
|
916
|
+
expiresAt: string;
|
|
917
|
+
};
|
|
918
|
+
EmailChangePendingResponse: {
|
|
919
|
+
pending: components["schemas"]["EmailChangePending"] | null;
|
|
920
|
+
};
|
|
921
|
+
CustomerAddressInput: {
|
|
922
|
+
/** @description ISO 3166-1 alpha-2; decides which parts are required. */
|
|
923
|
+
countryCode: string;
|
|
924
|
+
recipientName: string;
|
|
925
|
+
/** @description E.164, or a national number of the address country. */
|
|
926
|
+
phone?: string | null;
|
|
927
|
+
addressLine1: string;
|
|
928
|
+
addressLine2?: string | null;
|
|
929
|
+
/** @description City / district. */
|
|
930
|
+
locality?: string | null;
|
|
931
|
+
/** @description State / province / prefecture. */
|
|
932
|
+
region?: string | null;
|
|
933
|
+
postalCode?: string | null;
|
|
934
|
+
};
|
|
935
|
+
CustomerAddress: {
|
|
936
|
+
id: string;
|
|
937
|
+
/** @enum {string} */
|
|
938
|
+
kind: "SHIPPING" | "BILLING";
|
|
939
|
+
countryCode: string;
|
|
940
|
+
recipientName: string;
|
|
941
|
+
phone: string | null;
|
|
942
|
+
addressLine1: string;
|
|
943
|
+
addressLine2: string | null;
|
|
944
|
+
locality: string | null;
|
|
945
|
+
region: string | null;
|
|
946
|
+
postalCode: string | null;
|
|
947
|
+
/** @description The default address of its kind. */
|
|
948
|
+
isDefault: boolean;
|
|
949
|
+
/** Format: date-time */
|
|
950
|
+
createdAt: string;
|
|
951
|
+
};
|
|
952
|
+
CustomerAddressCreateInput: {
|
|
953
|
+
/**
|
|
954
|
+
* @default SHIPPING
|
|
955
|
+
* @enum {string}
|
|
956
|
+
*/
|
|
957
|
+
kind: "SHIPPING" | "BILLING";
|
|
958
|
+
address: components["schemas"]["CustomerAddressInput"];
|
|
959
|
+
setDefault?: boolean;
|
|
960
|
+
};
|
|
961
|
+
CustomerAddressUpdateInput: {
|
|
962
|
+
address: components["schemas"]["CustomerAddressInput"];
|
|
963
|
+
};
|
|
964
|
+
CustomerAddressResponse: {
|
|
965
|
+
address: components["schemas"]["CustomerAddress"];
|
|
966
|
+
created?: boolean;
|
|
967
|
+
};
|
|
968
|
+
CustomerAddressListResponse: {
|
|
969
|
+
addresses: components["schemas"]["CustomerAddress"][];
|
|
970
|
+
};
|
|
971
|
+
TaxIdentityInput: {
|
|
972
|
+
/** @description ISO 3166-1 alpha-2. */
|
|
973
|
+
country: string;
|
|
974
|
+
/** @description Tax ID type (for example tw_vat, jp_trn, eu_vat); defaults to the country's first registered type. */
|
|
975
|
+
type?: string | null;
|
|
976
|
+
value: string;
|
|
977
|
+
/** @description Registered name for invoices. */
|
|
978
|
+
name?: string | null;
|
|
979
|
+
/** @description Registered address for invoices. */
|
|
980
|
+
address?: string | null;
|
|
981
|
+
};
|
|
982
|
+
TaxIdentity: {
|
|
983
|
+
id: string;
|
|
984
|
+
country: string;
|
|
985
|
+
type: string;
|
|
986
|
+
/** @description As entered. */
|
|
987
|
+
value: string;
|
|
988
|
+
normalized: string;
|
|
989
|
+
/**
|
|
990
|
+
* @description Verification against the public registry; informational only.
|
|
991
|
+
* @enum {string}
|
|
992
|
+
*/
|
|
993
|
+
status: "PENDING" | "VALID_FORMAT" | "VERIFIED" | "NOT_FOUND" | "UNAVAILABLE" | "INVALID_FORMAT";
|
|
994
|
+
name: string | null;
|
|
995
|
+
address: string | null;
|
|
996
|
+
/** @description Name recorded by the registry when VERIFIED. */
|
|
997
|
+
registryName: string | null;
|
|
998
|
+
registryStatus: string | null;
|
|
999
|
+
/** @description Open-data attribution to show next to registry data. */
|
|
1000
|
+
attribution: {
|
|
1001
|
+
provider?: string;
|
|
1002
|
+
providerEn?: string;
|
|
1003
|
+
dataDate?: string;
|
|
1004
|
+
} | null;
|
|
1005
|
+
};
|
|
1006
|
+
TaxIdentityResponse: {
|
|
1007
|
+
taxIdentity: components["schemas"]["TaxIdentity"];
|
|
1008
|
+
created?: boolean;
|
|
1009
|
+
};
|
|
1010
|
+
TaxIdentityListResponse: {
|
|
1011
|
+
taxIdentities: components["schemas"]["TaxIdentity"][];
|
|
1012
|
+
};
|
|
1013
|
+
Consent: {
|
|
1014
|
+
/** @enum {string} */
|
|
1015
|
+
channel: "EMAIL" | "SMS" | "LINE" | "WHATSAPP";
|
|
1016
|
+
/** @enum {string} */
|
|
1017
|
+
status: "NEVER_SUBSCRIBED" | "PENDING" | "SUBSCRIBED" | "UNSUBSCRIBED" | "BOUNCED" | "COMPLAINED";
|
|
1018
|
+
/** @description False when the channel bounced or was reported as spam. */
|
|
1019
|
+
changeable: boolean;
|
|
1020
|
+
/** Format: date-time */
|
|
1021
|
+
updatedAt: string | null;
|
|
1022
|
+
};
|
|
1023
|
+
ConsentUpdateInput: {
|
|
1024
|
+
/** @enum {string} */
|
|
1025
|
+
channel: "EMAIL" | "SMS" | "LINE" | "WHATSAPP";
|
|
1026
|
+
subscribed: boolean;
|
|
1027
|
+
};
|
|
1028
|
+
ConsentResponse: {
|
|
1029
|
+
consent: components["schemas"]["Consent"];
|
|
1030
|
+
};
|
|
1031
|
+
ConsentListResponse: {
|
|
1032
|
+
consents: components["schemas"]["Consent"][];
|
|
1033
|
+
};
|
|
1034
|
+
ErasureRequest: {
|
|
1035
|
+
id: string;
|
|
1036
|
+
contactId: string;
|
|
1037
|
+
/** @enum {string} */
|
|
1038
|
+
requestedBy: "CUSTOMER" | "OWNER" | "AGENT";
|
|
1039
|
+
/** @enum {string} */
|
|
1040
|
+
status: "REQUESTED" | "CANCELED" | "COMPLETED" | "FAILED";
|
|
1041
|
+
/**
|
|
1042
|
+
* Format: date-time
|
|
1043
|
+
* @description When anonymization runs (7 days after a customer's request).
|
|
1044
|
+
*/
|
|
1045
|
+
executeAt: string;
|
|
1046
|
+
/** Format: date-time */
|
|
1047
|
+
canceledAt: string | null;
|
|
1048
|
+
/** Format: date-time */
|
|
1049
|
+
completedAt: string | null;
|
|
1050
|
+
failureReason: string | null;
|
|
1051
|
+
/** Format: date-time */
|
|
1052
|
+
createdAt: string;
|
|
1053
|
+
};
|
|
1054
|
+
ErasureState: {
|
|
1055
|
+
/**
|
|
1056
|
+
* Format: date-time
|
|
1057
|
+
* @description Set once the account was anonymized.
|
|
1058
|
+
*/
|
|
1059
|
+
anonymizedAt: string | null;
|
|
1060
|
+
/** @description The scheduled request, or null. */
|
|
1061
|
+
pending: components["schemas"]["ErasureRequest"] | null;
|
|
1062
|
+
};
|
|
1063
|
+
ErasureRequestResponse: {
|
|
1064
|
+
request: components["schemas"]["ErasureRequest"];
|
|
1065
|
+
};
|
|
1066
|
+
CustomerDataExportResponse: {
|
|
1067
|
+
/** @description The export document. Top-level keys: exportedAt, website, contact, identities, addresses, taxIdentities, consents, consentLogs, groups, entitlements, events, orders, formSubmissions, messages. */
|
|
1068
|
+
data: {
|
|
1069
|
+
[key: string]: unknown;
|
|
1070
|
+
};
|
|
1071
|
+
};
|
|
1072
|
+
CustomerContact: {
|
|
1073
|
+
id: string;
|
|
1074
|
+
email: string;
|
|
1075
|
+
name?: string | null;
|
|
1076
|
+
} & {
|
|
1077
|
+
[key: string]: unknown;
|
|
1078
|
+
};
|
|
1079
|
+
MeResponse: {
|
|
1080
|
+
/** @description Customer account sections for this customer, in menu order: which ones this site shows and whether the customer has data there. Use it to build the account navigation; `landing` is the first visible section. */
|
|
1081
|
+
sections: {
|
|
1082
|
+
/** @enum {string} */
|
|
1083
|
+
id: "orders" | "content" | "account";
|
|
1084
|
+
visible: boolean;
|
|
1085
|
+
hasData: boolean;
|
|
1086
|
+
}[];
|
|
1087
|
+
/** @description Path of the first visible section on the hosted customer account (for example `/account/orders`). */
|
|
1088
|
+
landing: string;
|
|
1089
|
+
contact: components["schemas"]["CustomerContact"];
|
|
1090
|
+
sessions: {
|
|
1091
|
+
[key: string]: unknown;
|
|
1092
|
+
}[];
|
|
1093
|
+
};
|
|
1094
|
+
/**
|
|
1095
|
+
* @description prerequisite: blocked by the course's require-in-order rule; access.lockedByUnitId is the unit to finish first.
|
|
1096
|
+
* @enum {string}
|
|
1097
|
+
*/
|
|
1098
|
+
UnitAccessReason: "entitlement" | "preview" | "none" | "not_released" | "expired" | "hidden" | "prerequisite";
|
|
1099
|
+
/** @enum {string} */
|
|
1100
|
+
UnitProgressStatus: "not_started" | "in-progress" | "completed";
|
|
1101
|
+
ProgressSummary: {
|
|
1102
|
+
percent: number;
|
|
1103
|
+
/** @description Completion snapshot: set the first time the completion rule is met and never reverts, even if units are added later. */
|
|
1104
|
+
completed: boolean;
|
|
1105
|
+
/** Format: date-time */
|
|
1106
|
+
completedAt?: string | null;
|
|
1107
|
+
/** @description The customer has opened at least one unit (only on the deliverables list). */
|
|
1108
|
+
started?: boolean;
|
|
1109
|
+
/** @description Wall-clock seconds of media playback across the deliverable (only on the deliverables list). */
|
|
1110
|
+
watchedSeconds?: number;
|
|
1111
|
+
/**
|
|
1112
|
+
* Format: date-time
|
|
1113
|
+
* @description Latest media playback (only on the deliverables list).
|
|
1114
|
+
*/
|
|
1115
|
+
lastPlayedAt?: string | null;
|
|
1116
|
+
} | null;
|
|
1117
|
+
CustomerDeliverableSummary: {
|
|
1118
|
+
/** @description The unit to continue with: the first unit in reading order that is not completed and can be opened now. null when everything is completed, or access has not started or has expired. */
|
|
1119
|
+
nextUnit?: {
|
|
1120
|
+
id: string;
|
|
1121
|
+
title: string | null;
|
|
1122
|
+
} | null;
|
|
1123
|
+
/** @description Multilingual sites only: the locale actually served (the requested locale when a translation exists, otherwise the primary locale). */
|
|
1124
|
+
resolvedLocale?: string;
|
|
1125
|
+
id: string;
|
|
1126
|
+
title: string;
|
|
1127
|
+
description: string | null;
|
|
1128
|
+
/** @enum {string} */
|
|
1129
|
+
structure: "COURSE" | "DOWNLOAD";
|
|
1130
|
+
coverAssetId: string | null;
|
|
1131
|
+
/** @description Cover image of the deliverable (null when unset or the image is in the trash). */
|
|
1132
|
+
cover?: {
|
|
1133
|
+
url: string;
|
|
1134
|
+
width: number | null;
|
|
1135
|
+
height: number | null;
|
|
1136
|
+
alt: string | null;
|
|
1137
|
+
/** @description 16px WebP data URL */
|
|
1138
|
+
placeholder: string | null;
|
|
1139
|
+
} | null;
|
|
1140
|
+
/** Format: date-time */
|
|
1141
|
+
grantedAt: string;
|
|
1142
|
+
/** Format: date-time */
|
|
1143
|
+
expiresAt: string | null;
|
|
1144
|
+
expired: boolean;
|
|
1145
|
+
/** Format: date-time */
|
|
1146
|
+
availableFrom: string | null;
|
|
1147
|
+
sources: string[];
|
|
1148
|
+
unitCount: number;
|
|
1149
|
+
progress: components["schemas"]["ProgressSummary"];
|
|
1150
|
+
};
|
|
1151
|
+
CustomerUnitView: {
|
|
1152
|
+
id: string;
|
|
1153
|
+
parentId: string | null;
|
|
1154
|
+
order: number;
|
|
1155
|
+
kind: string;
|
|
1156
|
+
title: string | null;
|
|
1157
|
+
description: string | null;
|
|
1158
|
+
isPreview: boolean;
|
|
1159
|
+
allowDownload: boolean;
|
|
1160
|
+
/** @description false = bonus unit: not counted in percent/completion and never locked by the require-in-order rule. */
|
|
1161
|
+
countsTowardCompletion?: boolean;
|
|
1162
|
+
/** @description Units after this one stay locked until it is completed. */
|
|
1163
|
+
isPrerequisite?: boolean;
|
|
1164
|
+
hasFile: boolean;
|
|
1165
|
+
/** @description Extra files the learner can download (handouts, templates), in the order the site owner arranged them. Empty when the unit is not accessible. Get a download URL with POST /units/{id}/open and attachmentId. */
|
|
1166
|
+
attachments?: {
|
|
1167
|
+
/** @description Pass as attachmentId to POST /units/{id}/open. */
|
|
1168
|
+
id: string;
|
|
1169
|
+
fileName: string;
|
|
1170
|
+
mimeType: string | null;
|
|
1171
|
+
bytes: number | null;
|
|
1172
|
+
}[];
|
|
1173
|
+
embed: {
|
|
1174
|
+
provider: string;
|
|
1175
|
+
id: string;
|
|
1176
|
+
} | null;
|
|
1177
|
+
body: unknown;
|
|
1178
|
+
duration: number | null;
|
|
1179
|
+
pageCount: number | null;
|
|
1180
|
+
mimeType: string | null;
|
|
1181
|
+
access: {
|
|
1182
|
+
granted: boolean;
|
|
1183
|
+
reason: components["schemas"]["UnitAccessReason"];
|
|
1184
|
+
/** Format: date-time */
|
|
1185
|
+
availableAt: string | null;
|
|
1186
|
+
/** @description When reason is prerequisite: the unit the learner must complete first. */
|
|
1187
|
+
lockedByUnitId?: string | null;
|
|
1188
|
+
};
|
|
1189
|
+
progress: components["schemas"]["UnitProgressStatus"];
|
|
1190
|
+
/** @description Furthest position reached (seconds); drives progress */
|
|
1191
|
+
positionSeconds: number;
|
|
1192
|
+
/** @description Where the learner last stopped (seconds); resume from here. Absent on older servers. */
|
|
1193
|
+
lastPosition?: number;
|
|
1194
|
+
/** @description Share of the media actually watched (union of played ranges), 0-100; null when there is no duration or nothing watched yet */
|
|
1195
|
+
coveredPercent?: number | null;
|
|
1196
|
+
quiz?: components["schemas"]["CustomerQuizSummary"];
|
|
1197
|
+
};
|
|
1198
|
+
CustomerDeliverableTree: {
|
|
1199
|
+
/** @description Multilingual sites only: the locale actually served (the requested locale when a translation exists, otherwise the primary locale). */
|
|
1200
|
+
resolvedLocale?: string;
|
|
1201
|
+
id: string;
|
|
1202
|
+
title: string;
|
|
1203
|
+
description: string | null;
|
|
1204
|
+
/** @enum {string} */
|
|
1205
|
+
structure: "COURSE" | "DOWNLOAD";
|
|
1206
|
+
coverAssetId: string | null;
|
|
1207
|
+
/** @description Cover image of the deliverable (null when unset or the image is in the trash). */
|
|
1208
|
+
cover?: {
|
|
1209
|
+
url: string;
|
|
1210
|
+
width: number | null;
|
|
1211
|
+
height: number | null;
|
|
1212
|
+
alt: string | null;
|
|
1213
|
+
/** @description 16px WebP data URL */
|
|
1214
|
+
placeholder: string | null;
|
|
1215
|
+
} | null;
|
|
1216
|
+
/** @description Authors/instructors in the owner's order (shared site author list). Older servers omit it. */
|
|
1217
|
+
authors?: {
|
|
1218
|
+
id: string;
|
|
1219
|
+
name: string;
|
|
1220
|
+
/** @description Job title or credential, e.g. Head Chef */
|
|
1221
|
+
title: string | null;
|
|
1222
|
+
/** @description Displayable image URL */
|
|
1223
|
+
avatar: string | null;
|
|
1224
|
+
bio: string | null;
|
|
1225
|
+
url: string | null;
|
|
1226
|
+
}[];
|
|
1227
|
+
settings: {
|
|
1228
|
+
[key: string]: unknown;
|
|
1229
|
+
};
|
|
1230
|
+
units: components["schemas"]["CustomerUnitView"][];
|
|
1231
|
+
progress: components["schemas"]["ProgressSummary"];
|
|
1232
|
+
certificate?: {
|
|
1233
|
+
enabled: boolean;
|
|
1234
|
+
serial: string | null;
|
|
1235
|
+
/** Format: date-time */
|
|
1236
|
+
issuedAt: string | null;
|
|
1237
|
+
} | null;
|
|
1238
|
+
};
|
|
1239
|
+
DeliverableProgressResponse: {
|
|
1240
|
+
units: {
|
|
1241
|
+
[key: string]: components["schemas"]["UnitProgressStatus"];
|
|
1242
|
+
};
|
|
1243
|
+
positions: {
|
|
1244
|
+
[key: string]: number;
|
|
1245
|
+
};
|
|
1246
|
+
percent: number;
|
|
1247
|
+
completed: boolean;
|
|
1248
|
+
/** Format: date-time */
|
|
1249
|
+
completedAt?: string | null;
|
|
1250
|
+
};
|
|
1251
|
+
OpenUnitRendition: {
|
|
1252
|
+
/** @enum {string} */
|
|
1253
|
+
kind: "original" | "mp4" | "hls" | "poster" | "thumbnails" | "captions" | "chapters";
|
|
1254
|
+
/** Format: uri */
|
|
1255
|
+
url: string;
|
|
1256
|
+
mimeType: string;
|
|
1257
|
+
/** @description captions only: BCP 47 language tag of the subtitle track. */
|
|
1258
|
+
locale?: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* @description captions only: ai = generated by Kanorio, upload = subtitle file uploaded by the site owner, translation = machine-translated from another track by Kanorio (edited = the site owner corrected it).
|
|
1261
|
+
* @enum {string}
|
|
1262
|
+
*/
|
|
1263
|
+
source?: "ai" | "upload" | "translation";
|
|
1264
|
+
/** @description captions only: the site owner corrected the text. */
|
|
1265
|
+
edited?: boolean;
|
|
1266
|
+
width?: number;
|
|
1267
|
+
height?: number;
|
|
1268
|
+
bytes?: number;
|
|
1269
|
+
};
|
|
1270
|
+
OpenUnitResponse: {
|
|
1271
|
+
/** @enum {string} */
|
|
1272
|
+
mode: "read" | "download";
|
|
1273
|
+
/**
|
|
1274
|
+
* Format: uri
|
|
1275
|
+
* @description Signed URL of the original file (download, or playback when there is no streaming version).
|
|
1276
|
+
*/
|
|
1277
|
+
url: string;
|
|
1278
|
+
/** @description Seconds. Videos: 1.5 × duration + 10 minutes, between 15 minutes and 4 hours; other files: 600. */
|
|
1279
|
+
expiresIn: number;
|
|
1280
|
+
title: string | null;
|
|
1281
|
+
fileName: string;
|
|
1282
|
+
mimeType: string | null;
|
|
1283
|
+
allowDownload: boolean;
|
|
1284
|
+
/** @description Playback sources: original, plus hls (adaptive-streaming master manifest on a signed path, play this one when present), thumbnails (progress-bar storyboard VTT) and poster for transcoded videos, and captions (one WebVTT track per language with locale, source and edited; keep them off until the viewer turns on CC). Same validity as expiresIn. */
|
|
1285
|
+
renditions?: components["schemas"]["OpenUnitRendition"][];
|
|
1286
|
+
/** Format: uri */
|
|
1287
|
+
poster?: string | null;
|
|
1288
|
+
/** Format: uri */
|
|
1289
|
+
thumbnails?: string | null;
|
|
1290
|
+
/**
|
|
1291
|
+
* @description partial: only the lowest quality is in the manifest yet; ready: all qualities.
|
|
1292
|
+
* @enum {string}
|
|
1293
|
+
*/
|
|
1294
|
+
streaming?: "none" | "partial" | "ready";
|
|
1295
|
+
};
|
|
1296
|
+
UnitTranscriptResponse: {
|
|
1297
|
+
unitId: string;
|
|
1298
|
+
/** @description BCP 47 language tag of the returned track. */
|
|
1299
|
+
locale: string;
|
|
1300
|
+
/**
|
|
1301
|
+
* @description ai = generated by Kanorio, upload = subtitle file uploaded by the site owner, translation = machine-translated from another track.
|
|
1302
|
+
* @enum {string}
|
|
1303
|
+
*/
|
|
1304
|
+
source: "ai" | "upload" | "translation";
|
|
1305
|
+
/** @description The site owner corrected the text. */
|
|
1306
|
+
edited: boolean;
|
|
1307
|
+
/** @description Sentences in order with start and end times in seconds. */
|
|
1308
|
+
segments: {
|
|
1309
|
+
s: number;
|
|
1310
|
+
e: number;
|
|
1311
|
+
t: string;
|
|
1312
|
+
}[];
|
|
1313
|
+
/** @description Every track available for this unit (same set as the captions renditions of units.open); request another with ?locale=. */
|
|
1314
|
+
tracks: {
|
|
1315
|
+
locale: string;
|
|
1316
|
+
/** @enum {string} */
|
|
1317
|
+
source: "ai" | "upload" | "translation";
|
|
1318
|
+
edited: boolean;
|
|
1319
|
+
}[];
|
|
1320
|
+
};
|
|
1321
|
+
ProgressReportInput: {
|
|
1322
|
+
unitId: string;
|
|
1323
|
+
reports: {
|
|
1324
|
+
/** @description Furthest position reached (seconds). Clients that only send this still resume and complete (by position ratio). */
|
|
1325
|
+
positionSeconds?: number;
|
|
1326
|
+
durationSeconds?: number;
|
|
1327
|
+
/** @description Manual 'mark complete' for non-media units; ignored for quiz units. */
|
|
1328
|
+
completed?: boolean;
|
|
1329
|
+
/** @description Non-media unit opened: records the first open and sets the unit to in-progress; does not complete it. */
|
|
1330
|
+
opened?: boolean;
|
|
1331
|
+
/** @description Browser-generated id of this viewing session; send the same value on every report of the session. Required for playback records (segments, play count, watch time). */
|
|
1332
|
+
sessionId?: string;
|
|
1333
|
+
/** @description Ranges played since the previous report as [from, to] or [from, to, speed] in media seconds. Completion uses the union of all ranges, so skipping ahead does not count. */
|
|
1334
|
+
segments?: number[][];
|
|
1335
|
+
startupMs?: number;
|
|
1336
|
+
stallCount?: number;
|
|
1337
|
+
stallMs?: number;
|
|
1338
|
+
/** @description Current rendition height (px). */
|
|
1339
|
+
rendition?: number;
|
|
1340
|
+
/** @description Seek destinations (seconds) since the previous report. */
|
|
1341
|
+
seekTargets?: number[];
|
|
1342
|
+
/** @enum {string} */
|
|
1343
|
+
device?: "desktop" | "mobile" | "tablet";
|
|
1344
|
+
}[];
|
|
1345
|
+
/** @description Heartbeat: when this report does not complete the unit the server skips deliverable-level completion and returns deliverable: null. */
|
|
1346
|
+
lite?: boolean;
|
|
1347
|
+
};
|
|
1348
|
+
ProgressReportResponse: {
|
|
1349
|
+
unit: components["schemas"]["UnitProgressStatus"];
|
|
1350
|
+
/** @description Media units: share of the file watched after this report (union of watched ranges / duration, 0-100); null without a duration or range data. */
|
|
1351
|
+
unitCoveredPercent?: number | null;
|
|
1352
|
+
/** @description null on lite heartbeats that did not complete the unit */
|
|
1353
|
+
deliverable: {
|
|
1354
|
+
id: string;
|
|
1355
|
+
percent: number;
|
|
1356
|
+
completed: boolean;
|
|
1357
|
+
/** Format: date-time */
|
|
1358
|
+
completedAt?: string | null;
|
|
1359
|
+
} | null;
|
|
1360
|
+
deliverableJustCompleted: boolean;
|
|
1361
|
+
};
|
|
1362
|
+
CustomerQuizSummary: {
|
|
1363
|
+
/**
|
|
1364
|
+
* @description graded: passing the quiz completes the unit; practice: any submission completes it, no passing score or attempt limit, answers always revealed
|
|
1365
|
+
* @enum {string}
|
|
1366
|
+
*/
|
|
1367
|
+
mode?: "graded" | "practice";
|
|
1368
|
+
/** @description Ignored for practice quizzes */
|
|
1369
|
+
passingPercent: number;
|
|
1370
|
+
/** @description Attempts allowed including any extra attempts granted by the site; null = unlimited */
|
|
1371
|
+
maxAttempts: number | null;
|
|
1372
|
+
attemptsUsed: number;
|
|
1373
|
+
bestScore: number | null;
|
|
1374
|
+
passed: boolean;
|
|
1375
|
+
canRetry: boolean;
|
|
1376
|
+
} | null;
|
|
1377
|
+
QuizSubmitInput: {
|
|
1378
|
+
/** @description question id → chosen option ids for choice questions; a single-element array with the typed answer for short_text and numeric questions */
|
|
1379
|
+
answers: {
|
|
1380
|
+
[key: string]: string[];
|
|
1381
|
+
};
|
|
1382
|
+
};
|
|
1383
|
+
QuizSubmitResponse: {
|
|
1384
|
+
/** @enum {string} */
|
|
1385
|
+
mode?: "graded" | "practice";
|
|
1386
|
+
score: number;
|
|
1387
|
+
correct: number;
|
|
1388
|
+
total: number;
|
|
1389
|
+
passed: boolean;
|
|
1390
|
+
perQuestion: {
|
|
1391
|
+
[key: string]: boolean;
|
|
1392
|
+
};
|
|
1393
|
+
attemptsUsed: number;
|
|
1394
|
+
maxAttempts: number | null;
|
|
1395
|
+
canRetry: boolean;
|
|
1396
|
+
reveal: {
|
|
1397
|
+
questions: {
|
|
1398
|
+
id: string;
|
|
1399
|
+
/** @description Empty for short_text and numeric questions */
|
|
1400
|
+
correctOptionIds: string[];
|
|
1401
|
+
/** @description Accepted answers of short_text and numeric questions; empty for choice questions */
|
|
1402
|
+
acceptedAnswers?: string[];
|
|
1403
|
+
explanation: string | null;
|
|
1404
|
+
}[];
|
|
1405
|
+
} | null;
|
|
1406
|
+
unit: components["schemas"]["UnitProgressStatus"];
|
|
1407
|
+
deliverable: {
|
|
1408
|
+
id: string;
|
|
1409
|
+
percent: number;
|
|
1410
|
+
completed: boolean;
|
|
1411
|
+
/** Format: date-time */
|
|
1412
|
+
completedAt?: string | null;
|
|
1413
|
+
};
|
|
1414
|
+
deliverableJustCompleted: boolean;
|
|
1415
|
+
};
|
|
1416
|
+
CertificateResponse: {
|
|
1417
|
+
certificate: {
|
|
1418
|
+
serial: string;
|
|
1419
|
+
/** Format: date-time */
|
|
1420
|
+
issuedAt: string;
|
|
1421
|
+
/** @description Signed PDF URL, valid for expiresIn seconds */
|
|
1422
|
+
url: string;
|
|
1423
|
+
expiresIn: number;
|
|
1424
|
+
};
|
|
1425
|
+
};
|
|
1426
|
+
Money: {
|
|
1427
|
+
/** @description Minor units. */
|
|
1428
|
+
amount: number;
|
|
1429
|
+
/** @description Upper-case ISO 4217. */
|
|
1430
|
+
currency: string;
|
|
1431
|
+
};
|
|
1432
|
+
/** @description One order as the order status page shows it. The same shape serves the purchase page (signed link), the expired link and the customer's account; `viewer` says which, and `redacted` lists what an expired link no longer carries. Amounts are minor units, times are ISO 8601, addresses are structured; nothing in it can trigger an action. */
|
|
1433
|
+
OrderStatus: {
|
|
1434
|
+
/**
|
|
1435
|
+
* @description signed_link: a valid signed link (3 weeks). expired_link: the signature is valid but older than 3 weeks; sensitive fields are removed. customer: the signed-in owner (GET /orders/{id}).
|
|
1436
|
+
* @enum {string}
|
|
1437
|
+
*/
|
|
1438
|
+
viewer: "signed_link" | "expired_link" | "customer";
|
|
1439
|
+
/** @description What an expired link no longer carries; empty otherwise. */
|
|
1440
|
+
redacted: ("tracking" | "payment" | "addresses" | "shipping_method" | "buyer" | "invoice" | "claim")[];
|
|
1441
|
+
/**
|
|
1442
|
+
* @description The checkout outcome: paid (order placed), awaiting_payment (offline payment instructions issued), processing (confirming), failed, expired.
|
|
1443
|
+
* @enum {string}
|
|
1444
|
+
*/
|
|
1445
|
+
state: "paid" | "awaiting_payment" | "processing" | "failed" | "expired";
|
|
1446
|
+
/**
|
|
1447
|
+
* Format: date-time
|
|
1448
|
+
* @description When the signed link stops showing the full order (signed_link only).
|
|
1449
|
+
*/
|
|
1450
|
+
expiresAt?: string;
|
|
1451
|
+
/** @description The order id, once an order exists. */
|
|
1452
|
+
orderId?: string;
|
|
1453
|
+
/** Format: date-time */
|
|
1454
|
+
createdAt: string;
|
|
1455
|
+
store: {
|
|
1456
|
+
name: string;
|
|
1457
|
+
country: string | null;
|
|
1458
|
+
/** @description IANA. */
|
|
1459
|
+
timezone?: string;
|
|
1460
|
+
contactEmail?: string;
|
|
1461
|
+
};
|
|
1462
|
+
order?: {
|
|
1463
|
+
number?: number;
|
|
1464
|
+
/** Format: date-time */
|
|
1465
|
+
placedAt: string;
|
|
1466
|
+
/** @description Financial status: UNPAID, PAID, PARTIALLY_REFUNDED, REFUNDED, DISPUTED, PAYMENT_REVERSED or CANCELLED. `state` describes the checkout; refunds show here. */
|
|
1467
|
+
status?: string;
|
|
1468
|
+
};
|
|
1469
|
+
buyer: {
|
|
1470
|
+
/** @description Masked (w***@example.com) on an expired link. */
|
|
1471
|
+
email: string;
|
|
1472
|
+
name?: string;
|
|
1473
|
+
};
|
|
1474
|
+
items: {
|
|
1475
|
+
productId?: string;
|
|
1476
|
+
tierId?: string;
|
|
1477
|
+
name: string;
|
|
1478
|
+
tierName?: string;
|
|
1479
|
+
quantity: number;
|
|
1480
|
+
unitPrice: components["schemas"]["Money"];
|
|
1481
|
+
/** @description After the discount allocated to this line. */
|
|
1482
|
+
lineAmount: components["schemas"]["Money"];
|
|
1483
|
+
/** Format: uri */
|
|
1484
|
+
image?: string;
|
|
1485
|
+
/** @description DIGITAL, PHYSICAL or SERVICE. */
|
|
1486
|
+
type: string;
|
|
1487
|
+
refundedQuantity?: number;
|
|
1488
|
+
/** @description Digital access was revoked after a refund. */
|
|
1489
|
+
accessRevoked?: boolean;
|
|
1490
|
+
}[];
|
|
1491
|
+
totals: {
|
|
1492
|
+
subtotal: components["schemas"]["Money"];
|
|
1493
|
+
discount?: {
|
|
1494
|
+
code?: string;
|
|
1495
|
+
} & components["schemas"]["Money"];
|
|
1496
|
+
shipping?: components["schemas"]["Money"];
|
|
1497
|
+
taxLines?: {
|
|
1498
|
+
label: string;
|
|
1499
|
+
amount: components["schemas"]["Money"];
|
|
1500
|
+
}[];
|
|
1501
|
+
total: components["schemas"]["Money"];
|
|
1502
|
+
/** @description Total refunded so far, shipping included. */
|
|
1503
|
+
refunded?: components["schemas"]["Money"];
|
|
1504
|
+
};
|
|
1505
|
+
payment: {
|
|
1506
|
+
/** @description card, apple_pay, google_pay, samsung_pay, atm, cvs, line_pay, jko_pay, bnpl, cod, icash_pay, aftee, bank_account, free or unknown (also unknown on an expired link). */
|
|
1507
|
+
methodType: string;
|
|
1508
|
+
providerLabel?: string;
|
|
1509
|
+
/** @description Offline payment instructions, discriminated by `kind`: virtual_account, cvs_code or generic. */
|
|
1510
|
+
instructions?: {
|
|
1511
|
+
[key: string]: unknown;
|
|
1512
|
+
};
|
|
1513
|
+
thirdPartyNotices: ("payment_success" | "payment_instructions" | "refund")[];
|
|
1514
|
+
};
|
|
1515
|
+
/** @description shipping: methodId, methodLabelKey/methodLabel, recipient, address, pickupPoint, shipments[] (status, trackingNo, trackingUrl, carrierLabelKey, estimatedDeliveryAt, actionDeadline). digital: claimUrl (empty on an expired link). */
|
|
1516
|
+
fulfillment: {
|
|
1517
|
+
/** @enum {string} */
|
|
1518
|
+
kind: "shipping" | "digital" | "none";
|
|
1519
|
+
} & {
|
|
1520
|
+
[key: string]: unknown;
|
|
1521
|
+
};
|
|
1522
|
+
/** @description Tax document preference (by country) and the issued document; absent when none or on an expired link. */
|
|
1523
|
+
invoice?: {
|
|
1524
|
+
[key: string]: unknown;
|
|
1525
|
+
};
|
|
1526
|
+
legalNotices: {
|
|
1527
|
+
kind: string;
|
|
1528
|
+
textKey?: string;
|
|
1529
|
+
/** Format: uri */
|
|
1530
|
+
url?: string;
|
|
1531
|
+
}[];
|
|
1532
|
+
/**
|
|
1533
|
+
* Format: uri
|
|
1534
|
+
* @description Checkout again after a failed or expired checkout (signed link only).
|
|
1535
|
+
*/
|
|
1536
|
+
retryUrl?: string;
|
|
1537
|
+
/** @description Refund history (customer only). */
|
|
1538
|
+
refunds?: {
|
|
1539
|
+
amount: components["schemas"]["Money"];
|
|
1540
|
+
shippingAmount?: components["schemas"]["Money"];
|
|
1541
|
+
/** @description DUPLICATE, REQUESTED_BY_CUSTOMER, FRAUDULENT or OTHER. */
|
|
1542
|
+
reason?: string;
|
|
1543
|
+
/** Format: date-time */
|
|
1544
|
+
at: string;
|
|
1545
|
+
}[];
|
|
1546
|
+
/** @description The payment provider can issue a receipt (customer only); fetch its URL with GET /orders/{id}?receipt=1. */
|
|
1547
|
+
receiptAvailable?: boolean;
|
|
1548
|
+
};
|
|
1549
|
+
AccessResponse: {
|
|
1550
|
+
granted: boolean;
|
|
1551
|
+
reason: components["schemas"]["UnitAccessReason"];
|
|
1552
|
+
/** Format: date-time */
|
|
1553
|
+
availableAt: string | null;
|
|
1554
|
+
};
|
|
1555
|
+
};
|
|
1556
|
+
responses: {
|
|
1557
|
+
/** @description Error (400) */
|
|
1558
|
+
Error400: {
|
|
1559
|
+
headers: {
|
|
1560
|
+
[name: string]: unknown;
|
|
1561
|
+
};
|
|
1562
|
+
content: {
|
|
1563
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1564
|
+
};
|
|
1565
|
+
};
|
|
1566
|
+
/** @description Error (401) */
|
|
1567
|
+
Error401: {
|
|
1568
|
+
headers: {
|
|
1569
|
+
[name: string]: unknown;
|
|
1570
|
+
};
|
|
1571
|
+
content: {
|
|
1572
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1573
|
+
};
|
|
1574
|
+
};
|
|
1575
|
+
/** @description Error (403) */
|
|
1576
|
+
Error403: {
|
|
1577
|
+
headers: {
|
|
1578
|
+
[name: string]: unknown;
|
|
1579
|
+
};
|
|
1580
|
+
content: {
|
|
1581
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1582
|
+
};
|
|
1583
|
+
};
|
|
1584
|
+
/** @description Error (404) */
|
|
1585
|
+
Error404: {
|
|
1586
|
+
headers: {
|
|
1587
|
+
[name: string]: unknown;
|
|
1588
|
+
};
|
|
1589
|
+
content: {
|
|
1590
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1591
|
+
};
|
|
1592
|
+
};
|
|
1593
|
+
/** @description Error (405) */
|
|
1594
|
+
Error405: {
|
|
1595
|
+
headers: {
|
|
1596
|
+
[name: string]: unknown;
|
|
1597
|
+
};
|
|
1598
|
+
content: {
|
|
1599
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1600
|
+
};
|
|
1601
|
+
};
|
|
1602
|
+
/** @description Error (409) */
|
|
1603
|
+
Error409: {
|
|
1604
|
+
headers: {
|
|
1605
|
+
[name: string]: unknown;
|
|
1606
|
+
};
|
|
1607
|
+
content: {
|
|
1608
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1609
|
+
};
|
|
1610
|
+
};
|
|
1611
|
+
/** @description Error (413) */
|
|
1612
|
+
Error413: {
|
|
1613
|
+
headers: {
|
|
1614
|
+
[name: string]: unknown;
|
|
1615
|
+
};
|
|
1616
|
+
content: {
|
|
1617
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
/** @description Error (422) */
|
|
1621
|
+
Error422: {
|
|
1622
|
+
headers: {
|
|
1623
|
+
[name: string]: unknown;
|
|
1624
|
+
};
|
|
1625
|
+
content: {
|
|
1626
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1627
|
+
};
|
|
1628
|
+
};
|
|
1629
|
+
/** @description Error (429) */
|
|
1630
|
+
Error429: {
|
|
1631
|
+
headers: {
|
|
1632
|
+
[name: string]: unknown;
|
|
1633
|
+
};
|
|
1634
|
+
content: {
|
|
1635
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1636
|
+
};
|
|
1637
|
+
};
|
|
1638
|
+
/** @description Error (502) */
|
|
1639
|
+
Error502: {
|
|
1640
|
+
headers: {
|
|
1641
|
+
[name: string]: unknown;
|
|
1642
|
+
};
|
|
1643
|
+
content: {
|
|
1644
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1645
|
+
};
|
|
1646
|
+
};
|
|
1647
|
+
/** @description Error (503) */
|
|
1648
|
+
Error503: {
|
|
1649
|
+
headers: {
|
|
1650
|
+
[name: string]: unknown;
|
|
1651
|
+
};
|
|
1652
|
+
content: {
|
|
1653
|
+
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
1654
|
+
};
|
|
1655
|
+
};
|
|
1656
|
+
};
|
|
1657
|
+
parameters: never;
|
|
1658
|
+
requestBodies: never;
|
|
1659
|
+
headers: never;
|
|
1660
|
+
pathItems: never;
|
|
1661
|
+
}
|
|
1662
|
+
export type $defs = Record<string, never>;
|
|
1663
|
+
export interface operations {
|
|
1664
|
+
customer_openapi: {
|
|
1665
|
+
parameters: {
|
|
1666
|
+
query?: never;
|
|
1667
|
+
header?: never;
|
|
1668
|
+
path?: never;
|
|
1669
|
+
cookie?: never;
|
|
1670
|
+
};
|
|
1671
|
+
requestBody?: never;
|
|
1672
|
+
responses: {
|
|
1673
|
+
/** @description OpenAPI 3.1 document of the Customer API, with servers set to this site. */
|
|
1674
|
+
200: {
|
|
1675
|
+
headers: {
|
|
1676
|
+
[name: string]: unknown;
|
|
1677
|
+
};
|
|
1678
|
+
content: {
|
|
1679
|
+
"application/json": Record<string, never>;
|
|
1680
|
+
};
|
|
1681
|
+
};
|
|
1682
|
+
400: components["responses"]["Error400"];
|
|
1683
|
+
404: components["responses"]["Error404"];
|
|
1684
|
+
405: components["responses"]["Error405"];
|
|
1685
|
+
429: components["responses"]["Error429"];
|
|
1686
|
+
503: components["responses"]["Error503"];
|
|
1687
|
+
};
|
|
1688
|
+
};
|
|
1689
|
+
customer_auth_protection: {
|
|
1690
|
+
parameters: {
|
|
1691
|
+
query?: never;
|
|
1692
|
+
header?: never;
|
|
1693
|
+
path?: never;
|
|
1694
|
+
cookie?: never;
|
|
1695
|
+
};
|
|
1696
|
+
requestBody?: never;
|
|
1697
|
+
responses: {
|
|
1698
|
+
/** @description Built-in proof-of-work challenge, or the site's third-party widget settings */
|
|
1699
|
+
200: {
|
|
1700
|
+
headers: {
|
|
1701
|
+
[name: string]: unknown;
|
|
1702
|
+
};
|
|
1703
|
+
content: {
|
|
1704
|
+
"application/json": {
|
|
1705
|
+
/** @enum {string} */
|
|
1706
|
+
provider: "kanorio" | "turnstile" | "recaptcha" | "hcaptcha";
|
|
1707
|
+
/** @enum {string} */
|
|
1708
|
+
entry: "forms" | "customer_login";
|
|
1709
|
+
/** @description Built-in proof-of-work challenge (provider kanorio only). */
|
|
1710
|
+
altcha?: {
|
|
1711
|
+
algorithm: string;
|
|
1712
|
+
challenge: string;
|
|
1713
|
+
maxnumber?: number;
|
|
1714
|
+
salt: string;
|
|
1715
|
+
signature: string;
|
|
1716
|
+
};
|
|
1717
|
+
/** @description Widget site key (third-party providers). */
|
|
1718
|
+
siteKey?: string;
|
|
1719
|
+
/** @description Pass this as the widget action; the server checks it. */
|
|
1720
|
+
action?: string;
|
|
1721
|
+
/** @description Turnstile cData to pass to the widget; null for other providers. */
|
|
1722
|
+
cData?: string | null;
|
|
1723
|
+
/** @enum {string|null} */
|
|
1724
|
+
recaptchaVersion?: "v2" | "v3" | null;
|
|
1725
|
+
/** @description When true, show the check to the visitor instead of running it silently (the site is seeing unusual sign-in volume). */
|
|
1726
|
+
visible?: boolean;
|
|
1727
|
+
/** @description Forms with a third-party provider only: send this as _tk (with _ctx set to the form id) when requesting file upload tickets. The widget token is single-use, so it is checked on submit instead. */
|
|
1728
|
+
uploadToken?: string;
|
|
1729
|
+
};
|
|
1730
|
+
};
|
|
1731
|
+
};
|
|
1732
|
+
400: components["responses"]["Error400"];
|
|
1733
|
+
404: components["responses"]["Error404"];
|
|
1734
|
+
405: components["responses"]["Error405"];
|
|
1735
|
+
429: components["responses"]["Error429"];
|
|
1736
|
+
503: components["responses"]["Error503"];
|
|
1737
|
+
};
|
|
1738
|
+
};
|
|
1739
|
+
customer_auth_challenge: {
|
|
1740
|
+
parameters: {
|
|
1741
|
+
query?: never;
|
|
1742
|
+
header?: never;
|
|
1743
|
+
path?: never;
|
|
1744
|
+
cookie?: never;
|
|
1745
|
+
};
|
|
1746
|
+
requestBody: {
|
|
1747
|
+
content: {
|
|
1748
|
+
"application/json": components["schemas"]["ChallengeInput"];
|
|
1749
|
+
};
|
|
1750
|
+
};
|
|
1751
|
+
responses: {
|
|
1752
|
+
/** @description Accepted (does not reveal whether an email was sent) */
|
|
1753
|
+
200: {
|
|
1754
|
+
headers: {
|
|
1755
|
+
[name: string]: unknown;
|
|
1756
|
+
};
|
|
1757
|
+
content: {
|
|
1758
|
+
"application/json": Record<string, never>;
|
|
1759
|
+
};
|
|
1760
|
+
};
|
|
1761
|
+
400: components["responses"]["Error400"];
|
|
1762
|
+
401: components["responses"]["Error401"];
|
|
1763
|
+
403: components["responses"]["Error403"];
|
|
1764
|
+
404: components["responses"]["Error404"];
|
|
1765
|
+
405: components["responses"]["Error405"];
|
|
1766
|
+
429: components["responses"]["Error429"];
|
|
1767
|
+
503: components["responses"]["Error503"];
|
|
1768
|
+
};
|
|
1769
|
+
};
|
|
1770
|
+
customer_auth_verify: {
|
|
1771
|
+
parameters: {
|
|
1772
|
+
query?: never;
|
|
1773
|
+
header?: never;
|
|
1774
|
+
path?: never;
|
|
1775
|
+
cookie?: never;
|
|
1776
|
+
};
|
|
1777
|
+
requestBody: {
|
|
1778
|
+
content: {
|
|
1779
|
+
"application/json": components["schemas"]["VerifyInput"];
|
|
1780
|
+
};
|
|
1781
|
+
};
|
|
1782
|
+
responses: {
|
|
1783
|
+
/** @description Session */
|
|
1784
|
+
200: {
|
|
1785
|
+
headers: {
|
|
1786
|
+
[name: string]: unknown;
|
|
1787
|
+
};
|
|
1788
|
+
content: {
|
|
1789
|
+
"application/json": components["schemas"]["VerifyResponse"];
|
|
1790
|
+
};
|
|
1791
|
+
};
|
|
1792
|
+
400: components["responses"]["Error400"];
|
|
1793
|
+
401: components["responses"]["Error401"];
|
|
1794
|
+
403: components["responses"]["Error403"];
|
|
1795
|
+
404: components["responses"]["Error404"];
|
|
1796
|
+
405: components["responses"]["Error405"];
|
|
1797
|
+
422: components["responses"]["Error422"];
|
|
1798
|
+
429: components["responses"]["Error429"];
|
|
1799
|
+
503: components["responses"]["Error503"];
|
|
1800
|
+
};
|
|
1801
|
+
};
|
|
1802
|
+
customer_auth_oauth_start: {
|
|
1803
|
+
parameters: {
|
|
1804
|
+
query?: never;
|
|
1805
|
+
header?: never;
|
|
1806
|
+
path?: never;
|
|
1807
|
+
cookie?: never;
|
|
1808
|
+
};
|
|
1809
|
+
requestBody: {
|
|
1810
|
+
content: {
|
|
1811
|
+
"application/json": components["schemas"]["OauthStartInput"];
|
|
1812
|
+
};
|
|
1813
|
+
};
|
|
1814
|
+
responses: {
|
|
1815
|
+
/** @description Provider authorization URL */
|
|
1816
|
+
200: {
|
|
1817
|
+
headers: {
|
|
1818
|
+
[name: string]: unknown;
|
|
1819
|
+
};
|
|
1820
|
+
content: {
|
|
1821
|
+
"application/json": components["schemas"]["OauthStartResponse"];
|
|
1822
|
+
};
|
|
1823
|
+
};
|
|
1824
|
+
400: components["responses"]["Error400"];
|
|
1825
|
+
401: components["responses"]["Error401"];
|
|
1826
|
+
403: components["responses"]["Error403"];
|
|
1827
|
+
404: components["responses"]["Error404"];
|
|
1828
|
+
405: components["responses"]["Error405"];
|
|
1829
|
+
422: components["responses"]["Error422"];
|
|
1830
|
+
429: components["responses"]["Error429"];
|
|
1831
|
+
503: components["responses"]["Error503"];
|
|
1832
|
+
};
|
|
1833
|
+
};
|
|
1834
|
+
customer_auth_oauth2_token: {
|
|
1835
|
+
parameters: {
|
|
1836
|
+
query?: never;
|
|
1837
|
+
header?: never;
|
|
1838
|
+
path?: never;
|
|
1839
|
+
cookie?: never;
|
|
1840
|
+
};
|
|
1841
|
+
requestBody: {
|
|
1842
|
+
content: {
|
|
1843
|
+
"application/json": components["schemas"]["Oauth2TokenInput"];
|
|
1844
|
+
};
|
|
1845
|
+
};
|
|
1846
|
+
responses: {
|
|
1847
|
+
/** @description Token */
|
|
1848
|
+
200: {
|
|
1849
|
+
headers: {
|
|
1850
|
+
[name: string]: unknown;
|
|
1851
|
+
};
|
|
1852
|
+
content: {
|
|
1853
|
+
"application/json": components["schemas"]["Oauth2TokenResponse"];
|
|
1854
|
+
};
|
|
1855
|
+
};
|
|
1856
|
+
400: components["responses"]["Error400"];
|
|
1857
|
+
401: components["responses"]["Error401"];
|
|
1858
|
+
403: components["responses"]["Error403"];
|
|
1859
|
+
404: components["responses"]["Error404"];
|
|
1860
|
+
405: components["responses"]["Error405"];
|
|
1861
|
+
422: components["responses"]["Error422"];
|
|
1862
|
+
429: components["responses"]["Error429"];
|
|
1863
|
+
503: components["responses"]["Error503"];
|
|
1864
|
+
};
|
|
1865
|
+
};
|
|
1866
|
+
customer_auth_oauth2_revoke: {
|
|
1867
|
+
parameters: {
|
|
1868
|
+
query?: never;
|
|
1869
|
+
header?: never;
|
|
1870
|
+
path?: never;
|
|
1871
|
+
cookie?: never;
|
|
1872
|
+
};
|
|
1873
|
+
requestBody: {
|
|
1874
|
+
content: {
|
|
1875
|
+
"application/json": components["schemas"]["Oauth2RevokeInput"];
|
|
1876
|
+
};
|
|
1877
|
+
};
|
|
1878
|
+
responses: {
|
|
1879
|
+
/** @description Revoked */
|
|
1880
|
+
200: {
|
|
1881
|
+
headers: {
|
|
1882
|
+
[name: string]: unknown;
|
|
1883
|
+
};
|
|
1884
|
+
content: {
|
|
1885
|
+
"application/json": Record<string, never>;
|
|
1886
|
+
};
|
|
1887
|
+
};
|
|
1888
|
+
400: components["responses"]["Error400"];
|
|
1889
|
+
401: components["responses"]["Error401"];
|
|
1890
|
+
403: components["responses"]["Error403"];
|
|
1891
|
+
404: components["responses"]["Error404"];
|
|
1892
|
+
405: components["responses"]["Error405"];
|
|
1893
|
+
429: components["responses"]["Error429"];
|
|
1894
|
+
503: components["responses"]["Error503"];
|
|
1895
|
+
};
|
|
1896
|
+
};
|
|
1897
|
+
customer_auth_passkey_options: {
|
|
1898
|
+
parameters: {
|
|
1899
|
+
query?: never;
|
|
1900
|
+
header?: never;
|
|
1901
|
+
path?: never;
|
|
1902
|
+
cookie?: never;
|
|
1903
|
+
};
|
|
1904
|
+
requestBody: {
|
|
1905
|
+
content: {
|
|
1906
|
+
"application/json": components["schemas"]["PasskeyOptionsInput"];
|
|
1907
|
+
};
|
|
1908
|
+
};
|
|
1909
|
+
responses: {
|
|
1910
|
+
/** @description WebAuthn request options and the challenge id to send back */
|
|
1911
|
+
200: {
|
|
1912
|
+
headers: {
|
|
1913
|
+
[name: string]: unknown;
|
|
1914
|
+
};
|
|
1915
|
+
content: {
|
|
1916
|
+
"application/json": components["schemas"]["PasskeyAuthOptionsResponse"];
|
|
1917
|
+
};
|
|
1918
|
+
};
|
|
1919
|
+
400: components["responses"]["Error400"];
|
|
1920
|
+
401: components["responses"]["Error401"];
|
|
1921
|
+
403: components["responses"]["Error403"];
|
|
1922
|
+
404: components["responses"]["Error404"];
|
|
1923
|
+
405: components["responses"]["Error405"];
|
|
1924
|
+
422: components["responses"]["Error422"];
|
|
1925
|
+
429: components["responses"]["Error429"];
|
|
1926
|
+
503: components["responses"]["Error503"];
|
|
1927
|
+
};
|
|
1928
|
+
};
|
|
1929
|
+
customer_auth_passkey_verify: {
|
|
1930
|
+
parameters: {
|
|
1931
|
+
query?: never;
|
|
1932
|
+
header?: never;
|
|
1933
|
+
path?: never;
|
|
1934
|
+
cookie?: never;
|
|
1935
|
+
};
|
|
1936
|
+
requestBody: {
|
|
1937
|
+
content: {
|
|
1938
|
+
"application/json": components["schemas"]["PasskeyVerifyInput"];
|
|
1939
|
+
};
|
|
1940
|
+
};
|
|
1941
|
+
responses: {
|
|
1942
|
+
/** @description Session */
|
|
1943
|
+
200: {
|
|
1944
|
+
headers: {
|
|
1945
|
+
[name: string]: unknown;
|
|
1946
|
+
};
|
|
1947
|
+
content: {
|
|
1948
|
+
"application/json": components["schemas"]["VerifyResponse"];
|
|
1949
|
+
};
|
|
1950
|
+
};
|
|
1951
|
+
400: components["responses"]["Error400"];
|
|
1952
|
+
401: components["responses"]["Error401"];
|
|
1953
|
+
403: components["responses"]["Error403"];
|
|
1954
|
+
404: components["responses"]["Error404"];
|
|
1955
|
+
405: components["responses"]["Error405"];
|
|
1956
|
+
422: components["responses"]["Error422"];
|
|
1957
|
+
429: components["responses"]["Error429"];
|
|
1958
|
+
503: components["responses"]["Error503"];
|
|
1959
|
+
};
|
|
1960
|
+
};
|
|
1961
|
+
customer_passkeys_list: {
|
|
1962
|
+
parameters: {
|
|
1963
|
+
query?: never;
|
|
1964
|
+
header?: never;
|
|
1965
|
+
path?: never;
|
|
1966
|
+
cookie?: never;
|
|
1967
|
+
};
|
|
1968
|
+
requestBody?: never;
|
|
1969
|
+
responses: {
|
|
1970
|
+
/** @description OK */
|
|
1971
|
+
200: {
|
|
1972
|
+
headers: {
|
|
1973
|
+
[name: string]: unknown;
|
|
1974
|
+
};
|
|
1975
|
+
content: {
|
|
1976
|
+
"application/json": components["schemas"]["PasskeyListResponse"];
|
|
1977
|
+
};
|
|
1978
|
+
};
|
|
1979
|
+
400: components["responses"]["Error400"];
|
|
1980
|
+
401: components["responses"]["Error401"];
|
|
1981
|
+
404: components["responses"]["Error404"];
|
|
1982
|
+
405: components["responses"]["Error405"];
|
|
1983
|
+
429: components["responses"]["Error429"];
|
|
1984
|
+
503: components["responses"]["Error503"];
|
|
1985
|
+
};
|
|
1986
|
+
};
|
|
1987
|
+
customer_passkeys_register_options: {
|
|
1988
|
+
parameters: {
|
|
1989
|
+
query?: never;
|
|
1990
|
+
header?: never;
|
|
1991
|
+
path?: never;
|
|
1992
|
+
cookie?: never;
|
|
1993
|
+
};
|
|
1994
|
+
requestBody: {
|
|
1995
|
+
content: {
|
|
1996
|
+
"application/json": components["schemas"]["PasskeyOptionsInput"];
|
|
1997
|
+
};
|
|
1998
|
+
};
|
|
1999
|
+
responses: {
|
|
2000
|
+
/** @description WebAuthn creation options */
|
|
2001
|
+
200: {
|
|
2002
|
+
headers: {
|
|
2003
|
+
[name: string]: unknown;
|
|
2004
|
+
};
|
|
2005
|
+
content: {
|
|
2006
|
+
"application/json": components["schemas"]["PasskeyRegisterOptionsResponse"];
|
|
2007
|
+
};
|
|
2008
|
+
};
|
|
2009
|
+
400: components["responses"]["Error400"];
|
|
2010
|
+
401: components["responses"]["Error401"];
|
|
2011
|
+
403: components["responses"]["Error403"];
|
|
2012
|
+
404: components["responses"]["Error404"];
|
|
2013
|
+
405: components["responses"]["Error405"];
|
|
2014
|
+
422: components["responses"]["Error422"];
|
|
2015
|
+
429: components["responses"]["Error429"];
|
|
2016
|
+
503: components["responses"]["Error503"];
|
|
2017
|
+
};
|
|
2018
|
+
};
|
|
2019
|
+
customer_passkeys_register: {
|
|
2020
|
+
parameters: {
|
|
2021
|
+
query?: never;
|
|
2022
|
+
header?: never;
|
|
2023
|
+
path?: never;
|
|
2024
|
+
cookie?: never;
|
|
2025
|
+
};
|
|
2026
|
+
requestBody: {
|
|
2027
|
+
content: {
|
|
2028
|
+
"application/json": components["schemas"]["PasskeyRegisterInput"];
|
|
2029
|
+
};
|
|
2030
|
+
};
|
|
2031
|
+
responses: {
|
|
2032
|
+
/** @description The new passkey */
|
|
2033
|
+
200: {
|
|
2034
|
+
headers: {
|
|
2035
|
+
[name: string]: unknown;
|
|
2036
|
+
};
|
|
2037
|
+
content: {
|
|
2038
|
+
"application/json": components["schemas"]["PasskeyRegisterResponse"];
|
|
2039
|
+
};
|
|
2040
|
+
};
|
|
2041
|
+
400: components["responses"]["Error400"];
|
|
2042
|
+
401: components["responses"]["Error401"];
|
|
2043
|
+
403: components["responses"]["Error403"];
|
|
2044
|
+
404: components["responses"]["Error404"];
|
|
2045
|
+
405: components["responses"]["Error405"];
|
|
2046
|
+
422: components["responses"]["Error422"];
|
|
2047
|
+
429: components["responses"]["Error429"];
|
|
2048
|
+
503: components["responses"]["Error503"];
|
|
2049
|
+
};
|
|
2050
|
+
};
|
|
2051
|
+
customer_passkeys_delete: {
|
|
2052
|
+
parameters: {
|
|
2053
|
+
query?: never;
|
|
2054
|
+
header?: never;
|
|
2055
|
+
path: {
|
|
2056
|
+
id: string;
|
|
2057
|
+
};
|
|
2058
|
+
cookie?: never;
|
|
2059
|
+
};
|
|
2060
|
+
requestBody?: never;
|
|
2061
|
+
responses: {
|
|
2062
|
+
/** @description Removed */
|
|
2063
|
+
200: {
|
|
2064
|
+
headers: {
|
|
2065
|
+
[name: string]: unknown;
|
|
2066
|
+
};
|
|
2067
|
+
content: {
|
|
2068
|
+
"application/json": Record<string, never>;
|
|
2069
|
+
};
|
|
2070
|
+
};
|
|
2071
|
+
400: components["responses"]["Error400"];
|
|
2072
|
+
401: components["responses"]["Error401"];
|
|
2073
|
+
403: components["responses"]["Error403"];
|
|
2074
|
+
404: components["responses"]["Error404"];
|
|
2075
|
+
405: components["responses"]["Error405"];
|
|
2076
|
+
429: components["responses"]["Error429"];
|
|
2077
|
+
503: components["responses"]["Error503"];
|
|
2078
|
+
};
|
|
2079
|
+
};
|
|
2080
|
+
customer_data_export: {
|
|
2081
|
+
parameters: {
|
|
2082
|
+
query?: never;
|
|
2083
|
+
header?: never;
|
|
2084
|
+
path?: never;
|
|
2085
|
+
cookie?: never;
|
|
2086
|
+
};
|
|
2087
|
+
requestBody?: never;
|
|
2088
|
+
responses: {
|
|
2089
|
+
/** @description OK */
|
|
2090
|
+
200: {
|
|
2091
|
+
headers: {
|
|
2092
|
+
[name: string]: unknown;
|
|
2093
|
+
};
|
|
2094
|
+
content: {
|
|
2095
|
+
"application/json": components["schemas"]["CustomerDataExportResponse"];
|
|
2096
|
+
};
|
|
2097
|
+
};
|
|
2098
|
+
400: components["responses"]["Error400"];
|
|
2099
|
+
401: components["responses"]["Error401"];
|
|
2100
|
+
404: components["responses"]["Error404"];
|
|
2101
|
+
405: components["responses"]["Error405"];
|
|
2102
|
+
429: components["responses"]["Error429"];
|
|
2103
|
+
503: components["responses"]["Error503"];
|
|
2104
|
+
};
|
|
2105
|
+
};
|
|
2106
|
+
customer_erasure_get: {
|
|
2107
|
+
parameters: {
|
|
2108
|
+
query?: never;
|
|
2109
|
+
header?: never;
|
|
2110
|
+
path?: never;
|
|
2111
|
+
cookie?: never;
|
|
2112
|
+
};
|
|
2113
|
+
requestBody?: never;
|
|
2114
|
+
responses: {
|
|
2115
|
+
/** @description OK */
|
|
2116
|
+
200: {
|
|
2117
|
+
headers: {
|
|
2118
|
+
[name: string]: unknown;
|
|
2119
|
+
};
|
|
2120
|
+
content: {
|
|
2121
|
+
"application/json": components["schemas"]["ErasureState"];
|
|
2122
|
+
};
|
|
2123
|
+
};
|
|
2124
|
+
400: components["responses"]["Error400"];
|
|
2125
|
+
401: components["responses"]["Error401"];
|
|
2126
|
+
404: components["responses"]["Error404"];
|
|
2127
|
+
405: components["responses"]["Error405"];
|
|
2128
|
+
429: components["responses"]["Error429"];
|
|
2129
|
+
503: components["responses"]["Error503"];
|
|
2130
|
+
};
|
|
2131
|
+
};
|
|
2132
|
+
customer_erasure_request: {
|
|
2133
|
+
parameters: {
|
|
2134
|
+
query?: never;
|
|
2135
|
+
header?: never;
|
|
2136
|
+
path?: never;
|
|
2137
|
+
cookie?: never;
|
|
2138
|
+
};
|
|
2139
|
+
requestBody?: never;
|
|
2140
|
+
responses: {
|
|
2141
|
+
/** @description Scheduled */
|
|
2142
|
+
200: {
|
|
2143
|
+
headers: {
|
|
2144
|
+
[name: string]: unknown;
|
|
2145
|
+
};
|
|
2146
|
+
content: {
|
|
2147
|
+
"application/json": components["schemas"]["ErasureRequestResponse"];
|
|
2148
|
+
};
|
|
2149
|
+
};
|
|
2150
|
+
400: components["responses"]["Error400"];
|
|
2151
|
+
401: components["responses"]["Error401"];
|
|
2152
|
+
403: components["responses"]["Error403"];
|
|
2153
|
+
404: components["responses"]["Error404"];
|
|
2154
|
+
405: components["responses"]["Error405"];
|
|
2155
|
+
409: components["responses"]["Error409"];
|
|
2156
|
+
429: components["responses"]["Error429"];
|
|
2157
|
+
503: components["responses"]["Error503"];
|
|
2158
|
+
};
|
|
2159
|
+
};
|
|
2160
|
+
customer_erasure_cancel: {
|
|
2161
|
+
parameters: {
|
|
2162
|
+
query?: never;
|
|
2163
|
+
header?: never;
|
|
2164
|
+
path?: never;
|
|
2165
|
+
cookie?: never;
|
|
2166
|
+
};
|
|
2167
|
+
requestBody?: never;
|
|
2168
|
+
responses: {
|
|
2169
|
+
/** @description Canceled */
|
|
2170
|
+
200: {
|
|
2171
|
+
headers: {
|
|
2172
|
+
[name: string]: unknown;
|
|
2173
|
+
};
|
|
2174
|
+
content: {
|
|
2175
|
+
"application/json": components["schemas"]["ErasureRequestResponse"];
|
|
2176
|
+
};
|
|
2177
|
+
};
|
|
2178
|
+
400: components["responses"]["Error400"];
|
|
2179
|
+
401: components["responses"]["Error401"];
|
|
2180
|
+
403: components["responses"]["Error403"];
|
|
2181
|
+
404: components["responses"]["Error404"];
|
|
2182
|
+
405: components["responses"]["Error405"];
|
|
2183
|
+
409: components["responses"]["Error409"];
|
|
2184
|
+
429: components["responses"]["Error429"];
|
|
2185
|
+
503: components["responses"]["Error503"];
|
|
2186
|
+
};
|
|
2187
|
+
};
|
|
2188
|
+
customer_me: {
|
|
2189
|
+
parameters: {
|
|
2190
|
+
query?: never;
|
|
2191
|
+
header?: never;
|
|
2192
|
+
path?: never;
|
|
2193
|
+
cookie?: never;
|
|
2194
|
+
};
|
|
2195
|
+
requestBody?: never;
|
|
2196
|
+
responses: {
|
|
2197
|
+
/** @description OK */
|
|
2198
|
+
200: {
|
|
2199
|
+
headers: {
|
|
2200
|
+
[name: string]: unknown;
|
|
2201
|
+
};
|
|
2202
|
+
content: {
|
|
2203
|
+
"application/json": components["schemas"]["MeResponse"];
|
|
2204
|
+
};
|
|
2205
|
+
};
|
|
2206
|
+
400: components["responses"]["Error400"];
|
|
2207
|
+
401: components["responses"]["Error401"];
|
|
2208
|
+
404: components["responses"]["Error404"];
|
|
2209
|
+
405: components["responses"]["Error405"];
|
|
2210
|
+
429: components["responses"]["Error429"];
|
|
2211
|
+
503: components["responses"]["Error503"];
|
|
2212
|
+
};
|
|
2213
|
+
};
|
|
2214
|
+
customer_me_update: {
|
|
2215
|
+
parameters: {
|
|
2216
|
+
query?: never;
|
|
2217
|
+
header?: never;
|
|
2218
|
+
path?: never;
|
|
2219
|
+
cookie?: never;
|
|
2220
|
+
};
|
|
2221
|
+
requestBody: {
|
|
2222
|
+
content: {
|
|
2223
|
+
"application/json": components["schemas"]["CustomerProfileUpdateInput"];
|
|
2224
|
+
};
|
|
2225
|
+
};
|
|
2226
|
+
responses: {
|
|
2227
|
+
/** @description Updated contact */
|
|
2228
|
+
200: {
|
|
2229
|
+
headers: {
|
|
2230
|
+
[name: string]: unknown;
|
|
2231
|
+
};
|
|
2232
|
+
content: {
|
|
2233
|
+
"application/json": components["schemas"]["CustomerProfileResponse"];
|
|
2234
|
+
};
|
|
2235
|
+
};
|
|
2236
|
+
400: components["responses"]["Error400"];
|
|
2237
|
+
401: components["responses"]["Error401"];
|
|
2238
|
+
403: components["responses"]["Error403"];
|
|
2239
|
+
404: components["responses"]["Error404"];
|
|
2240
|
+
405: components["responses"]["Error405"];
|
|
2241
|
+
429: components["responses"]["Error429"];
|
|
2242
|
+
503: components["responses"]["Error503"];
|
|
2243
|
+
};
|
|
2244
|
+
};
|
|
2245
|
+
customer_email_change_get: {
|
|
2246
|
+
parameters: {
|
|
2247
|
+
query?: never;
|
|
2248
|
+
header?: never;
|
|
2249
|
+
path?: never;
|
|
2250
|
+
cookie?: never;
|
|
2251
|
+
};
|
|
2252
|
+
requestBody?: never;
|
|
2253
|
+
responses: {
|
|
2254
|
+
/** @description OK */
|
|
2255
|
+
200: {
|
|
2256
|
+
headers: {
|
|
2257
|
+
[name: string]: unknown;
|
|
2258
|
+
};
|
|
2259
|
+
content: {
|
|
2260
|
+
"application/json": components["schemas"]["EmailChangePendingResponse"];
|
|
2261
|
+
};
|
|
2262
|
+
};
|
|
2263
|
+
400: components["responses"]["Error400"];
|
|
2264
|
+
401: components["responses"]["Error401"];
|
|
2265
|
+
404: components["responses"]["Error404"];
|
|
2266
|
+
405: components["responses"]["Error405"];
|
|
2267
|
+
429: components["responses"]["Error429"];
|
|
2268
|
+
503: components["responses"]["Error503"];
|
|
2269
|
+
};
|
|
2270
|
+
};
|
|
2271
|
+
customer_email_change_start: {
|
|
2272
|
+
parameters: {
|
|
2273
|
+
query?: never;
|
|
2274
|
+
header?: never;
|
|
2275
|
+
path?: never;
|
|
2276
|
+
cookie?: never;
|
|
2277
|
+
};
|
|
2278
|
+
requestBody: {
|
|
2279
|
+
content: {
|
|
2280
|
+
"application/json": components["schemas"]["EmailChangeStartInput"];
|
|
2281
|
+
};
|
|
2282
|
+
};
|
|
2283
|
+
responses: {
|
|
2284
|
+
/** @description Code sent */
|
|
2285
|
+
200: {
|
|
2286
|
+
headers: {
|
|
2287
|
+
[name: string]: unknown;
|
|
2288
|
+
};
|
|
2289
|
+
content: {
|
|
2290
|
+
"application/json": components["schemas"]["EmailChangePendingResponse"];
|
|
2291
|
+
};
|
|
2292
|
+
};
|
|
2293
|
+
400: components["responses"]["Error400"];
|
|
2294
|
+
401: components["responses"]["Error401"];
|
|
2295
|
+
403: components["responses"]["Error403"];
|
|
2296
|
+
404: components["responses"]["Error404"];
|
|
2297
|
+
405: components["responses"]["Error405"];
|
|
2298
|
+
409: components["responses"]["Error409"];
|
|
2299
|
+
429: components["responses"]["Error429"];
|
|
2300
|
+
502: components["responses"]["Error502"];
|
|
2301
|
+
503: components["responses"]["Error503"];
|
|
2302
|
+
};
|
|
2303
|
+
};
|
|
2304
|
+
customer_email_change_verify: {
|
|
2305
|
+
parameters: {
|
|
2306
|
+
query?: never;
|
|
2307
|
+
header?: never;
|
|
2308
|
+
path?: never;
|
|
2309
|
+
cookie?: never;
|
|
2310
|
+
};
|
|
2311
|
+
requestBody: {
|
|
2312
|
+
content: {
|
|
2313
|
+
"application/json": components["schemas"]["EmailChangeVerifyInput"];
|
|
2314
|
+
};
|
|
2315
|
+
};
|
|
2316
|
+
responses: {
|
|
2317
|
+
/** @description Email changed */
|
|
2318
|
+
200: {
|
|
2319
|
+
headers: {
|
|
2320
|
+
[name: string]: unknown;
|
|
2321
|
+
};
|
|
2322
|
+
content: {
|
|
2323
|
+
"application/json": {
|
|
2324
|
+
email: string;
|
|
2325
|
+
};
|
|
2326
|
+
};
|
|
2327
|
+
};
|
|
2328
|
+
400: components["responses"]["Error400"];
|
|
2329
|
+
401: components["responses"]["Error401"];
|
|
2330
|
+
403: components["responses"]["Error403"];
|
|
2331
|
+
404: components["responses"]["Error404"];
|
|
2332
|
+
405: components["responses"]["Error405"];
|
|
2333
|
+
409: components["responses"]["Error409"];
|
|
2334
|
+
429: components["responses"]["Error429"];
|
|
2335
|
+
503: components["responses"]["Error503"];
|
|
2336
|
+
};
|
|
2337
|
+
};
|
|
2338
|
+
customer_addresses_list: {
|
|
2339
|
+
parameters: {
|
|
2340
|
+
query?: never;
|
|
2341
|
+
header?: never;
|
|
2342
|
+
path?: never;
|
|
2343
|
+
cookie?: never;
|
|
2344
|
+
};
|
|
2345
|
+
requestBody?: never;
|
|
2346
|
+
responses: {
|
|
2347
|
+
/** @description OK */
|
|
2348
|
+
200: {
|
|
2349
|
+
headers: {
|
|
2350
|
+
[name: string]: unknown;
|
|
2351
|
+
};
|
|
2352
|
+
content: {
|
|
2353
|
+
"application/json": components["schemas"]["CustomerAddressListResponse"];
|
|
2354
|
+
};
|
|
2355
|
+
};
|
|
2356
|
+
400: components["responses"]["Error400"];
|
|
2357
|
+
401: components["responses"]["Error401"];
|
|
2358
|
+
404: components["responses"]["Error404"];
|
|
2359
|
+
405: components["responses"]["Error405"];
|
|
2360
|
+
429: components["responses"]["Error429"];
|
|
2361
|
+
503: components["responses"]["Error503"];
|
|
2362
|
+
};
|
|
2363
|
+
};
|
|
2364
|
+
customer_addresses_create: {
|
|
2365
|
+
parameters: {
|
|
2366
|
+
query?: never;
|
|
2367
|
+
header?: never;
|
|
2368
|
+
path?: never;
|
|
2369
|
+
cookie?: never;
|
|
2370
|
+
};
|
|
2371
|
+
requestBody: {
|
|
2372
|
+
content: {
|
|
2373
|
+
"application/json": components["schemas"]["CustomerAddressCreateInput"];
|
|
2374
|
+
};
|
|
2375
|
+
};
|
|
2376
|
+
responses: {
|
|
2377
|
+
/** @description Existing identical address */
|
|
2378
|
+
200: {
|
|
2379
|
+
headers: {
|
|
2380
|
+
[name: string]: unknown;
|
|
2381
|
+
};
|
|
2382
|
+
content: {
|
|
2383
|
+
"application/json": components["schemas"]["CustomerAddressResponse"];
|
|
2384
|
+
};
|
|
2385
|
+
};
|
|
2386
|
+
/** @description Created */
|
|
2387
|
+
201: {
|
|
2388
|
+
headers: {
|
|
2389
|
+
[name: string]: unknown;
|
|
2390
|
+
};
|
|
2391
|
+
content: {
|
|
2392
|
+
"application/json": components["schemas"]["CustomerAddressResponse"];
|
|
2393
|
+
};
|
|
2394
|
+
};
|
|
2395
|
+
400: components["responses"]["Error400"];
|
|
2396
|
+
401: components["responses"]["Error401"];
|
|
2397
|
+
403: components["responses"]["Error403"];
|
|
2398
|
+
404: components["responses"]["Error404"];
|
|
2399
|
+
405: components["responses"]["Error405"];
|
|
2400
|
+
429: components["responses"]["Error429"];
|
|
2401
|
+
503: components["responses"]["Error503"];
|
|
2402
|
+
};
|
|
2403
|
+
};
|
|
2404
|
+
customer_addresses_delete: {
|
|
2405
|
+
parameters: {
|
|
2406
|
+
query?: never;
|
|
2407
|
+
header?: never;
|
|
2408
|
+
path: {
|
|
2409
|
+
id: string;
|
|
2410
|
+
};
|
|
2411
|
+
cookie?: never;
|
|
2412
|
+
};
|
|
2413
|
+
requestBody?: never;
|
|
2414
|
+
responses: {
|
|
2415
|
+
/** @description Removed */
|
|
2416
|
+
200: {
|
|
2417
|
+
headers: {
|
|
2418
|
+
[name: string]: unknown;
|
|
2419
|
+
};
|
|
2420
|
+
content: {
|
|
2421
|
+
"application/json": Record<string, never>;
|
|
2422
|
+
};
|
|
2423
|
+
};
|
|
2424
|
+
400: components["responses"]["Error400"];
|
|
2425
|
+
401: components["responses"]["Error401"];
|
|
2426
|
+
403: components["responses"]["Error403"];
|
|
2427
|
+
404: components["responses"]["Error404"];
|
|
2428
|
+
405: components["responses"]["Error405"];
|
|
2429
|
+
429: components["responses"]["Error429"];
|
|
2430
|
+
503: components["responses"]["Error503"];
|
|
2431
|
+
};
|
|
2432
|
+
};
|
|
2433
|
+
customer_addresses_update: {
|
|
2434
|
+
parameters: {
|
|
2435
|
+
query?: never;
|
|
2436
|
+
header?: never;
|
|
2437
|
+
path: {
|
|
2438
|
+
id: string;
|
|
2439
|
+
};
|
|
2440
|
+
cookie?: never;
|
|
2441
|
+
};
|
|
2442
|
+
requestBody: {
|
|
2443
|
+
content: {
|
|
2444
|
+
"application/json": components["schemas"]["CustomerAddressUpdateInput"];
|
|
2445
|
+
};
|
|
2446
|
+
};
|
|
2447
|
+
responses: {
|
|
2448
|
+
/** @description Updated */
|
|
2449
|
+
200: {
|
|
2450
|
+
headers: {
|
|
2451
|
+
[name: string]: unknown;
|
|
2452
|
+
};
|
|
2453
|
+
content: {
|
|
2454
|
+
"application/json": components["schemas"]["CustomerAddressResponse"];
|
|
2455
|
+
};
|
|
2456
|
+
};
|
|
2457
|
+
400: components["responses"]["Error400"];
|
|
2458
|
+
401: components["responses"]["Error401"];
|
|
2459
|
+
403: components["responses"]["Error403"];
|
|
2460
|
+
404: components["responses"]["Error404"];
|
|
2461
|
+
405: components["responses"]["Error405"];
|
|
2462
|
+
429: components["responses"]["Error429"];
|
|
2463
|
+
503: components["responses"]["Error503"];
|
|
2464
|
+
};
|
|
2465
|
+
};
|
|
2466
|
+
customer_addresses_set_default: {
|
|
2467
|
+
parameters: {
|
|
2468
|
+
query?: never;
|
|
2469
|
+
header?: never;
|
|
2470
|
+
path: {
|
|
2471
|
+
id: string;
|
|
2472
|
+
};
|
|
2473
|
+
cookie?: never;
|
|
2474
|
+
};
|
|
2475
|
+
requestBody?: never;
|
|
2476
|
+
responses: {
|
|
2477
|
+
/** @description Updated */
|
|
2478
|
+
200: {
|
|
2479
|
+
headers: {
|
|
2480
|
+
[name: string]: unknown;
|
|
2481
|
+
};
|
|
2482
|
+
content: {
|
|
2483
|
+
"application/json": components["schemas"]["CustomerAddressResponse"];
|
|
2484
|
+
};
|
|
2485
|
+
};
|
|
2486
|
+
400: components["responses"]["Error400"];
|
|
2487
|
+
401: components["responses"]["Error401"];
|
|
2488
|
+
403: components["responses"]["Error403"];
|
|
2489
|
+
404: components["responses"]["Error404"];
|
|
2490
|
+
405: components["responses"]["Error405"];
|
|
2491
|
+
429: components["responses"]["Error429"];
|
|
2492
|
+
503: components["responses"]["Error503"];
|
|
2493
|
+
};
|
|
2494
|
+
};
|
|
2495
|
+
customer_tax_identities_list: {
|
|
2496
|
+
parameters: {
|
|
2497
|
+
query?: never;
|
|
2498
|
+
header?: never;
|
|
2499
|
+
path?: never;
|
|
2500
|
+
cookie?: never;
|
|
2501
|
+
};
|
|
2502
|
+
requestBody?: never;
|
|
2503
|
+
responses: {
|
|
2504
|
+
/** @description OK */
|
|
2505
|
+
200: {
|
|
2506
|
+
headers: {
|
|
2507
|
+
[name: string]: unknown;
|
|
2508
|
+
};
|
|
2509
|
+
content: {
|
|
2510
|
+
"application/json": components["schemas"]["TaxIdentityListResponse"];
|
|
2511
|
+
};
|
|
2512
|
+
};
|
|
2513
|
+
400: components["responses"]["Error400"];
|
|
2514
|
+
401: components["responses"]["Error401"];
|
|
2515
|
+
404: components["responses"]["Error404"];
|
|
2516
|
+
405: components["responses"]["Error405"];
|
|
2517
|
+
429: components["responses"]["Error429"];
|
|
2518
|
+
503: components["responses"]["Error503"];
|
|
2519
|
+
};
|
|
2520
|
+
};
|
|
2521
|
+
customer_tax_identities_upsert: {
|
|
2522
|
+
parameters: {
|
|
2523
|
+
query?: never;
|
|
2524
|
+
header?: never;
|
|
2525
|
+
path?: never;
|
|
2526
|
+
cookie?: never;
|
|
2527
|
+
};
|
|
2528
|
+
requestBody: {
|
|
2529
|
+
content: {
|
|
2530
|
+
"application/json": components["schemas"]["TaxIdentityInput"];
|
|
2531
|
+
};
|
|
2532
|
+
};
|
|
2533
|
+
responses: {
|
|
2534
|
+
/** @description Updated */
|
|
2535
|
+
200: {
|
|
2536
|
+
headers: {
|
|
2537
|
+
[name: string]: unknown;
|
|
2538
|
+
};
|
|
2539
|
+
content: {
|
|
2540
|
+
"application/json": components["schemas"]["TaxIdentityResponse"];
|
|
2541
|
+
};
|
|
2542
|
+
};
|
|
2543
|
+
/** @description Created */
|
|
2544
|
+
201: {
|
|
2545
|
+
headers: {
|
|
2546
|
+
[name: string]: unknown;
|
|
2547
|
+
};
|
|
2548
|
+
content: {
|
|
2549
|
+
"application/json": components["schemas"]["TaxIdentityResponse"];
|
|
2550
|
+
};
|
|
2551
|
+
};
|
|
2552
|
+
400: components["responses"]["Error400"];
|
|
2553
|
+
401: components["responses"]["Error401"];
|
|
2554
|
+
403: components["responses"]["Error403"];
|
|
2555
|
+
404: components["responses"]["Error404"];
|
|
2556
|
+
405: components["responses"]["Error405"];
|
|
2557
|
+
429: components["responses"]["Error429"];
|
|
2558
|
+
503: components["responses"]["Error503"];
|
|
2559
|
+
};
|
|
2560
|
+
};
|
|
2561
|
+
customer_tax_identities_delete: {
|
|
2562
|
+
parameters: {
|
|
2563
|
+
query?: never;
|
|
2564
|
+
header?: never;
|
|
2565
|
+
path: {
|
|
2566
|
+
id: string;
|
|
2567
|
+
};
|
|
2568
|
+
cookie?: never;
|
|
2569
|
+
};
|
|
2570
|
+
requestBody?: never;
|
|
2571
|
+
responses: {
|
|
2572
|
+
/** @description Removed */
|
|
2573
|
+
200: {
|
|
2574
|
+
headers: {
|
|
2575
|
+
[name: string]: unknown;
|
|
2576
|
+
};
|
|
2577
|
+
content: {
|
|
2578
|
+
"application/json": Record<string, never>;
|
|
2579
|
+
};
|
|
2580
|
+
};
|
|
2581
|
+
400: components["responses"]["Error400"];
|
|
2582
|
+
401: components["responses"]["Error401"];
|
|
2583
|
+
403: components["responses"]["Error403"];
|
|
2584
|
+
404: components["responses"]["Error404"];
|
|
2585
|
+
405: components["responses"]["Error405"];
|
|
2586
|
+
429: components["responses"]["Error429"];
|
|
2587
|
+
503: components["responses"]["Error503"];
|
|
2588
|
+
};
|
|
2589
|
+
};
|
|
2590
|
+
customer_consents_list: {
|
|
2591
|
+
parameters: {
|
|
2592
|
+
query?: never;
|
|
2593
|
+
header?: never;
|
|
2594
|
+
path?: never;
|
|
2595
|
+
cookie?: never;
|
|
2596
|
+
};
|
|
2597
|
+
requestBody?: never;
|
|
2598
|
+
responses: {
|
|
2599
|
+
/** @description OK */
|
|
2600
|
+
200: {
|
|
2601
|
+
headers: {
|
|
2602
|
+
[name: string]: unknown;
|
|
2603
|
+
};
|
|
2604
|
+
content: {
|
|
2605
|
+
"application/json": components["schemas"]["ConsentListResponse"];
|
|
2606
|
+
};
|
|
2607
|
+
};
|
|
2608
|
+
400: components["responses"]["Error400"];
|
|
2609
|
+
401: components["responses"]["Error401"];
|
|
2610
|
+
404: components["responses"]["Error404"];
|
|
2611
|
+
405: components["responses"]["Error405"];
|
|
2612
|
+
429: components["responses"]["Error429"];
|
|
2613
|
+
503: components["responses"]["Error503"];
|
|
2614
|
+
};
|
|
2615
|
+
};
|
|
2616
|
+
customer_consents_update: {
|
|
2617
|
+
parameters: {
|
|
2618
|
+
query?: never;
|
|
2619
|
+
header?: never;
|
|
2620
|
+
path?: never;
|
|
2621
|
+
cookie?: never;
|
|
2622
|
+
};
|
|
2623
|
+
requestBody: {
|
|
2624
|
+
content: {
|
|
2625
|
+
"application/json": components["schemas"]["ConsentUpdateInput"];
|
|
2626
|
+
};
|
|
2627
|
+
};
|
|
2628
|
+
responses: {
|
|
2629
|
+
/** @description Updated */
|
|
2630
|
+
200: {
|
|
2631
|
+
headers: {
|
|
2632
|
+
[name: string]: unknown;
|
|
2633
|
+
};
|
|
2634
|
+
content: {
|
|
2635
|
+
"application/json": components["schemas"]["ConsentResponse"];
|
|
2636
|
+
};
|
|
2637
|
+
};
|
|
2638
|
+
400: components["responses"]["Error400"];
|
|
2639
|
+
401: components["responses"]["Error401"];
|
|
2640
|
+
403: components["responses"]["Error403"];
|
|
2641
|
+
404: components["responses"]["Error404"];
|
|
2642
|
+
405: components["responses"]["Error405"];
|
|
2643
|
+
409: components["responses"]["Error409"];
|
|
2644
|
+
429: components["responses"]["Error429"];
|
|
2645
|
+
503: components["responses"]["Error503"];
|
|
2646
|
+
};
|
|
2647
|
+
};
|
|
2648
|
+
customer_session_revoke: {
|
|
2649
|
+
parameters: {
|
|
2650
|
+
query?: {
|
|
2651
|
+
mode?: "current" | "device" | "others" | "all";
|
|
2652
|
+
sessionId?: string;
|
|
2653
|
+
};
|
|
2654
|
+
header?: never;
|
|
2655
|
+
path?: never;
|
|
2656
|
+
cookie?: never;
|
|
2657
|
+
};
|
|
2658
|
+
requestBody?: never;
|
|
2659
|
+
responses: {
|
|
2660
|
+
/** @description OK */
|
|
2661
|
+
200: {
|
|
2662
|
+
headers: {
|
|
2663
|
+
[name: string]: unknown;
|
|
2664
|
+
};
|
|
2665
|
+
content: {
|
|
2666
|
+
"application/json": {
|
|
2667
|
+
revokedCount: number;
|
|
2668
|
+
};
|
|
2669
|
+
};
|
|
2670
|
+
};
|
|
2671
|
+
400: components["responses"]["Error400"];
|
|
2672
|
+
401: components["responses"]["Error401"];
|
|
2673
|
+
403: components["responses"]["Error403"];
|
|
2674
|
+
404: components["responses"]["Error404"];
|
|
2675
|
+
405: components["responses"]["Error405"];
|
|
2676
|
+
429: components["responses"]["Error429"];
|
|
2677
|
+
503: components["responses"]["Error503"];
|
|
2678
|
+
};
|
|
2679
|
+
};
|
|
2680
|
+
customer_deliverables_list: {
|
|
2681
|
+
parameters: {
|
|
2682
|
+
query?: {
|
|
2683
|
+
/** @description Maximum number of items to return, 1-100. Defaults to 20. */
|
|
2684
|
+
limit?: number;
|
|
2685
|
+
/** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
|
|
2686
|
+
cursor?: string;
|
|
2687
|
+
/** @description Locale code (any letter case) or URL prefix of a live locale. Omitted: the customer's own locale (Contact.locale, set by their last checkout, sign-in or form submission), falling back to the site's primary locale. Titles and descriptions without a translation fall back to the primary locale. */
|
|
2688
|
+
locale?: string;
|
|
2689
|
+
};
|
|
2690
|
+
header?: never;
|
|
2691
|
+
path?: never;
|
|
2692
|
+
cookie?: never;
|
|
2693
|
+
};
|
|
2694
|
+
requestBody?: never;
|
|
2695
|
+
responses: {
|
|
2696
|
+
/** @description OK */
|
|
2697
|
+
200: {
|
|
2698
|
+
headers: {
|
|
2699
|
+
[name: string]: unknown;
|
|
2700
|
+
};
|
|
2701
|
+
content: {
|
|
2702
|
+
"application/json": {
|
|
2703
|
+
data: components["schemas"]["CustomerDeliverableSummary"][];
|
|
2704
|
+
/** @description True when another page exists; pass nextCursor to fetch it. */
|
|
2705
|
+
hasMore: boolean;
|
|
2706
|
+
/** @description Cursor for the next page, or null on the last page. */
|
|
2707
|
+
nextCursor: string | null;
|
|
2708
|
+
};
|
|
2709
|
+
};
|
|
2710
|
+
};
|
|
2711
|
+
400: components["responses"]["Error400"];
|
|
2712
|
+
401: components["responses"]["Error401"];
|
|
2713
|
+
404: components["responses"]["Error404"];
|
|
2714
|
+
405: components["responses"]["Error405"];
|
|
2715
|
+
429: components["responses"]["Error429"];
|
|
2716
|
+
503: components["responses"]["Error503"];
|
|
2717
|
+
};
|
|
2718
|
+
};
|
|
2719
|
+
customer_deliverables_get: {
|
|
2720
|
+
parameters: {
|
|
2721
|
+
query?: {
|
|
2722
|
+
/** @description Locale code (any letter case) or URL prefix of a live locale. Omitted: the customer's own locale (Contact.locale, set by their last checkout, sign-in or form submission), falling back to the site's primary locale. Titles and descriptions without a translation fall back to the primary locale. */
|
|
2723
|
+
locale?: string;
|
|
2724
|
+
};
|
|
2725
|
+
header?: never;
|
|
2726
|
+
path: {
|
|
2727
|
+
deliverableId: string;
|
|
2728
|
+
};
|
|
2729
|
+
cookie?: never;
|
|
2730
|
+
};
|
|
2731
|
+
requestBody?: never;
|
|
2732
|
+
responses: {
|
|
2733
|
+
/** @description OK */
|
|
2734
|
+
200: {
|
|
2735
|
+
headers: {
|
|
2736
|
+
[name: string]: unknown;
|
|
2737
|
+
};
|
|
2738
|
+
content: {
|
|
2739
|
+
"application/json": {
|
|
2740
|
+
deliverable: components["schemas"]["CustomerDeliverableTree"];
|
|
2741
|
+
};
|
|
2742
|
+
};
|
|
2743
|
+
};
|
|
2744
|
+
400: components["responses"]["Error400"];
|
|
2745
|
+
401: components["responses"]["Error401"];
|
|
2746
|
+
404: components["responses"]["Error404"];
|
|
2747
|
+
405: components["responses"]["Error405"];
|
|
2748
|
+
429: components["responses"]["Error429"];
|
|
2749
|
+
503: components["responses"]["Error503"];
|
|
2750
|
+
};
|
|
2751
|
+
};
|
|
2752
|
+
customer_deliverables_progress: {
|
|
2753
|
+
parameters: {
|
|
2754
|
+
query?: never;
|
|
2755
|
+
header?: never;
|
|
2756
|
+
path: {
|
|
2757
|
+
deliverableId: string;
|
|
2758
|
+
};
|
|
2759
|
+
cookie?: never;
|
|
2760
|
+
};
|
|
2761
|
+
requestBody?: never;
|
|
2762
|
+
responses: {
|
|
2763
|
+
/** @description OK */
|
|
2764
|
+
200: {
|
|
2765
|
+
headers: {
|
|
2766
|
+
[name: string]: unknown;
|
|
2767
|
+
};
|
|
2768
|
+
content: {
|
|
2769
|
+
"application/json": components["schemas"]["DeliverableProgressResponse"];
|
|
2770
|
+
};
|
|
2771
|
+
};
|
|
2772
|
+
400: components["responses"]["Error400"];
|
|
2773
|
+
401: components["responses"]["Error401"];
|
|
2774
|
+
404: components["responses"]["Error404"];
|
|
2775
|
+
405: components["responses"]["Error405"];
|
|
2776
|
+
429: components["responses"]["Error429"];
|
|
2777
|
+
503: components["responses"]["Error503"];
|
|
2778
|
+
};
|
|
2779
|
+
};
|
|
2780
|
+
customer_units_open: {
|
|
2781
|
+
parameters: {
|
|
2782
|
+
query?: {
|
|
2783
|
+
/** @description Locale code (any letter case) or URL prefix of a live locale. Omitted: the customer's own locale (Contact.locale, set by their last checkout, sign-in or form submission), falling back to the site's primary locale. The unit title in the response follows it. */
|
|
2784
|
+
locale?: string;
|
|
2785
|
+
};
|
|
2786
|
+
header?: never;
|
|
2787
|
+
path: {
|
|
2788
|
+
id: string;
|
|
2789
|
+
};
|
|
2790
|
+
cookie?: never;
|
|
2791
|
+
};
|
|
2792
|
+
requestBody?: {
|
|
2793
|
+
content: {
|
|
2794
|
+
"application/json": {
|
|
2795
|
+
/**
|
|
2796
|
+
* @default read
|
|
2797
|
+
* @enum {string}
|
|
2798
|
+
*/
|
|
2799
|
+
mode?: "read" | "download";
|
|
2800
|
+
/** @description An id from the unit's attachments. Returns a download URL for that attachment instead of the unit's main file; mode is ignored and allowDownload does not apply. */
|
|
2801
|
+
attachmentId?: string;
|
|
2802
|
+
};
|
|
2803
|
+
};
|
|
2804
|
+
};
|
|
2805
|
+
responses: {
|
|
2806
|
+
/** @description Signed URL */
|
|
2807
|
+
200: {
|
|
2808
|
+
headers: {
|
|
2809
|
+
[name: string]: unknown;
|
|
2810
|
+
};
|
|
2811
|
+
content: {
|
|
2812
|
+
"application/json": components["schemas"]["OpenUnitResponse"];
|
|
2813
|
+
};
|
|
2814
|
+
};
|
|
2815
|
+
400: components["responses"]["Error400"];
|
|
2816
|
+
401: components["responses"]["Error401"];
|
|
2817
|
+
403: components["responses"]["Error403"];
|
|
2818
|
+
404: components["responses"]["Error404"];
|
|
2819
|
+
405: components["responses"]["Error405"];
|
|
2820
|
+
409: components["responses"]["Error409"];
|
|
2821
|
+
429: components["responses"]["Error429"];
|
|
2822
|
+
503: components["responses"]["Error503"];
|
|
2823
|
+
};
|
|
2824
|
+
};
|
|
2825
|
+
customer_units_transcript: {
|
|
2826
|
+
parameters: {
|
|
2827
|
+
query?: {
|
|
2828
|
+
/** @description Which track to return: exact locale first, then the same language (zh-Hant matches zh-Hant-TW); when nothing matches, the original (generated or uploaded) track. Omitted: the customer's own locale. */
|
|
2829
|
+
locale?: string;
|
|
2830
|
+
};
|
|
2831
|
+
header?: never;
|
|
2832
|
+
path: {
|
|
2833
|
+
id: string;
|
|
2834
|
+
};
|
|
2835
|
+
cookie?: never;
|
|
2836
|
+
};
|
|
2837
|
+
requestBody?: never;
|
|
2838
|
+
responses: {
|
|
2839
|
+
/** @description Transcript */
|
|
2840
|
+
200: {
|
|
2841
|
+
headers: {
|
|
2842
|
+
[name: string]: unknown;
|
|
2843
|
+
};
|
|
2844
|
+
content: {
|
|
2845
|
+
"application/json": components["schemas"]["UnitTranscriptResponse"];
|
|
2846
|
+
};
|
|
2847
|
+
};
|
|
2848
|
+
400: components["responses"]["Error400"];
|
|
2849
|
+
401: components["responses"]["Error401"];
|
|
2850
|
+
403: components["responses"]["Error403"];
|
|
2851
|
+
404: components["responses"]["Error404"];
|
|
2852
|
+
405: components["responses"]["Error405"];
|
|
2853
|
+
422: components["responses"]["Error422"];
|
|
2854
|
+
429: components["responses"]["Error429"];
|
|
2855
|
+
503: components["responses"]["Error503"];
|
|
2856
|
+
};
|
|
2857
|
+
};
|
|
2858
|
+
customer_units_quiz_submit: {
|
|
2859
|
+
parameters: {
|
|
2860
|
+
query?: never;
|
|
2861
|
+
header?: never;
|
|
2862
|
+
path: {
|
|
2863
|
+
id: string;
|
|
2864
|
+
};
|
|
2865
|
+
cookie?: never;
|
|
2866
|
+
};
|
|
2867
|
+
requestBody: {
|
|
2868
|
+
content: {
|
|
2869
|
+
"application/json": components["schemas"]["QuizSubmitInput"];
|
|
2870
|
+
};
|
|
2871
|
+
};
|
|
2872
|
+
responses: {
|
|
2873
|
+
/** @description Graded */
|
|
2874
|
+
200: {
|
|
2875
|
+
headers: {
|
|
2876
|
+
[name: string]: unknown;
|
|
2877
|
+
};
|
|
2878
|
+
content: {
|
|
2879
|
+
"application/json": components["schemas"]["QuizSubmitResponse"];
|
|
2880
|
+
};
|
|
2881
|
+
};
|
|
2882
|
+
400: components["responses"]["Error400"];
|
|
2883
|
+
401: components["responses"]["Error401"];
|
|
2884
|
+
403: components["responses"]["Error403"];
|
|
2885
|
+
404: components["responses"]["Error404"];
|
|
2886
|
+
405: components["responses"]["Error405"];
|
|
2887
|
+
409: components["responses"]["Error409"];
|
|
2888
|
+
429: components["responses"]["Error429"];
|
|
2889
|
+
503: components["responses"]["Error503"];
|
|
2890
|
+
};
|
|
2891
|
+
};
|
|
2892
|
+
customer_deliverables_certificate: {
|
|
2893
|
+
parameters: {
|
|
2894
|
+
query?: never;
|
|
2895
|
+
header?: never;
|
|
2896
|
+
path: {
|
|
2897
|
+
deliverableId: string;
|
|
2898
|
+
};
|
|
2899
|
+
cookie?: never;
|
|
2900
|
+
};
|
|
2901
|
+
requestBody?: never;
|
|
2902
|
+
responses: {
|
|
2903
|
+
/** @description Certificate */
|
|
2904
|
+
200: {
|
|
2905
|
+
headers: {
|
|
2906
|
+
[name: string]: unknown;
|
|
2907
|
+
};
|
|
2908
|
+
content: {
|
|
2909
|
+
"application/json": components["schemas"]["CertificateResponse"];
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2912
|
+
400: components["responses"]["Error400"];
|
|
2913
|
+
401: components["responses"]["Error401"];
|
|
2914
|
+
403: components["responses"]["Error403"];
|
|
2915
|
+
404: components["responses"]["Error404"];
|
|
2916
|
+
405: components["responses"]["Error405"];
|
|
2917
|
+
429: components["responses"]["Error429"];
|
|
2918
|
+
503: components["responses"]["Error503"];
|
|
2919
|
+
};
|
|
2920
|
+
};
|
|
2921
|
+
customer_progress_report: {
|
|
2922
|
+
parameters: {
|
|
2923
|
+
query?: never;
|
|
2924
|
+
header?: never;
|
|
2925
|
+
path?: never;
|
|
2926
|
+
cookie?: never;
|
|
2927
|
+
};
|
|
2928
|
+
requestBody: {
|
|
2929
|
+
content: {
|
|
2930
|
+
"application/json": components["schemas"]["ProgressReportInput"];
|
|
2931
|
+
};
|
|
2932
|
+
};
|
|
2933
|
+
responses: {
|
|
2934
|
+
/** @description OK */
|
|
2935
|
+
200: {
|
|
2936
|
+
headers: {
|
|
2937
|
+
[name: string]: unknown;
|
|
2938
|
+
};
|
|
2939
|
+
content: {
|
|
2940
|
+
"application/json": components["schemas"]["ProgressReportResponse"];
|
|
2941
|
+
};
|
|
2942
|
+
};
|
|
2943
|
+
400: components["responses"]["Error400"];
|
|
2944
|
+
401: components["responses"]["Error401"];
|
|
2945
|
+
403: components["responses"]["Error403"];
|
|
2946
|
+
404: components["responses"]["Error404"];
|
|
2947
|
+
405: components["responses"]["Error405"];
|
|
2948
|
+
429: components["responses"]["Error429"];
|
|
2949
|
+
503: components["responses"]["Error503"];
|
|
2950
|
+
};
|
|
2951
|
+
};
|
|
2952
|
+
customer_access_check: {
|
|
2953
|
+
parameters: {
|
|
2954
|
+
query?: {
|
|
2955
|
+
type?: "deliverable" | "unit";
|
|
2956
|
+
};
|
|
2957
|
+
header?: never;
|
|
2958
|
+
path: {
|
|
2959
|
+
id: string;
|
|
2960
|
+
};
|
|
2961
|
+
cookie?: never;
|
|
2962
|
+
};
|
|
2963
|
+
requestBody?: never;
|
|
2964
|
+
responses: {
|
|
2965
|
+
/** @description OK */
|
|
2966
|
+
200: {
|
|
2967
|
+
headers: {
|
|
2968
|
+
[name: string]: unknown;
|
|
2969
|
+
};
|
|
2970
|
+
content: {
|
|
2971
|
+
"application/json": components["schemas"]["AccessResponse"];
|
|
2972
|
+
};
|
|
2973
|
+
};
|
|
2974
|
+
400: components["responses"]["Error400"];
|
|
2975
|
+
401: components["responses"]["Error401"];
|
|
2976
|
+
404: components["responses"]["Error404"];
|
|
2977
|
+
405: components["responses"]["Error405"];
|
|
2978
|
+
429: components["responses"]["Error429"];
|
|
2979
|
+
503: components["responses"]["Error503"];
|
|
2980
|
+
};
|
|
2981
|
+
};
|
|
2982
|
+
customer_orders_list: {
|
|
2983
|
+
parameters: {
|
|
2984
|
+
query?: {
|
|
2985
|
+
/** @description Maximum number of items to return, 1-100. Defaults to 20. */
|
|
2986
|
+
limit?: number;
|
|
2987
|
+
/** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
|
|
2988
|
+
cursor?: string;
|
|
2989
|
+
/** @description Locale code (any letter case) or URL prefix of a live locale. Omitted: the customer's own locale (Contact.locale, set by their last checkout, sign-in or form submission), falling back to the site's primary locale. Titles and descriptions without a translation fall back to the primary locale. */
|
|
2990
|
+
locale?: string;
|
|
2991
|
+
};
|
|
2992
|
+
header?: never;
|
|
2993
|
+
path?: never;
|
|
2994
|
+
cookie?: never;
|
|
2995
|
+
};
|
|
2996
|
+
requestBody?: never;
|
|
2997
|
+
responses: {
|
|
2998
|
+
/** @description OK */
|
|
2999
|
+
200: {
|
|
3000
|
+
headers: {
|
|
3001
|
+
[name: string]: unknown;
|
|
3002
|
+
};
|
|
3003
|
+
content: {
|
|
3004
|
+
"application/json": {
|
|
3005
|
+
data: {
|
|
3006
|
+
[key: string]: unknown;
|
|
3007
|
+
}[];
|
|
3008
|
+
/** @description True when another page exists; pass nextCursor to fetch it. */
|
|
3009
|
+
hasMore: boolean;
|
|
3010
|
+
/** @description Cursor for the next page, or null on the last page. */
|
|
3011
|
+
nextCursor: string | null;
|
|
3012
|
+
};
|
|
3013
|
+
};
|
|
3014
|
+
};
|
|
3015
|
+
400: components["responses"]["Error400"];
|
|
3016
|
+
401: components["responses"]["Error401"];
|
|
3017
|
+
404: components["responses"]["Error404"];
|
|
3018
|
+
405: components["responses"]["Error405"];
|
|
3019
|
+
429: components["responses"]["Error429"];
|
|
3020
|
+
503: components["responses"]["Error503"];
|
|
3021
|
+
};
|
|
3022
|
+
};
|
|
3023
|
+
customer_orders_get: {
|
|
3024
|
+
parameters: {
|
|
3025
|
+
query?: {
|
|
3026
|
+
receipt?: "1";
|
|
3027
|
+
/** @description Locale code (any letter case) or URL prefix of a live locale. Omitted: the customer's own locale (Contact.locale, set by their last checkout, sign-in or form submission), falling back to the site's primary locale. Titles and descriptions without a translation fall back to the primary locale. */
|
|
3028
|
+
locale?: string;
|
|
3029
|
+
};
|
|
3030
|
+
header?: never;
|
|
3031
|
+
path: {
|
|
3032
|
+
id: string;
|
|
3033
|
+
};
|
|
3034
|
+
cookie?: never;
|
|
3035
|
+
};
|
|
3036
|
+
requestBody?: never;
|
|
3037
|
+
responses: {
|
|
3038
|
+
/** @description OK */
|
|
3039
|
+
200: {
|
|
3040
|
+
headers: {
|
|
3041
|
+
[name: string]: unknown;
|
|
3042
|
+
};
|
|
3043
|
+
content: {
|
|
3044
|
+
"application/json": {
|
|
3045
|
+
order?: components["schemas"]["OrderStatus"];
|
|
3046
|
+
} & {
|
|
3047
|
+
[key: string]: unknown;
|
|
3048
|
+
};
|
|
3049
|
+
};
|
|
3050
|
+
};
|
|
3051
|
+
400: components["responses"]["Error400"];
|
|
3052
|
+
401: components["responses"]["Error401"];
|
|
3053
|
+
404: components["responses"]["Error404"];
|
|
3054
|
+
405: components["responses"]["Error405"];
|
|
3055
|
+
429: components["responses"]["Error429"];
|
|
3056
|
+
503: components["responses"]["Error503"];
|
|
3057
|
+
};
|
|
3058
|
+
};
|
|
3059
|
+
customer_reviews_status: {
|
|
3060
|
+
parameters: {
|
|
3061
|
+
query: {
|
|
3062
|
+
/** @description Comma-separated order line ids (max 100). */
|
|
3063
|
+
orderItemIds: string;
|
|
3064
|
+
};
|
|
3065
|
+
header?: never;
|
|
3066
|
+
path?: never;
|
|
3067
|
+
cookie?: never;
|
|
3068
|
+
};
|
|
3069
|
+
requestBody?: never;
|
|
3070
|
+
responses: {
|
|
3071
|
+
/** @description OK. Status of every requested order item in one page (hasMore is always false). */
|
|
3072
|
+
200: {
|
|
3073
|
+
headers: {
|
|
3074
|
+
[name: string]: unknown;
|
|
3075
|
+
};
|
|
3076
|
+
content: {
|
|
3077
|
+
"application/json": {
|
|
3078
|
+
data: components["schemas"]["ReviewStatus"][];
|
|
3079
|
+
/** @description True when another page exists; pass nextCursor to fetch it. */
|
|
3080
|
+
hasMore: boolean;
|
|
3081
|
+
/** @description Cursor for the next page, or null on the last page. */
|
|
3082
|
+
nextCursor: string | null;
|
|
3083
|
+
};
|
|
3084
|
+
};
|
|
3085
|
+
};
|
|
3086
|
+
400: components["responses"]["Error400"];
|
|
3087
|
+
401: components["responses"]["Error401"];
|
|
3088
|
+
404: components["responses"]["Error404"];
|
|
3089
|
+
405: components["responses"]["Error405"];
|
|
3090
|
+
429: components["responses"]["Error429"];
|
|
3091
|
+
503: components["responses"]["Error503"];
|
|
3092
|
+
};
|
|
3093
|
+
};
|
|
3094
|
+
customer_reviews_submit: {
|
|
3095
|
+
parameters: {
|
|
3096
|
+
query?: never;
|
|
3097
|
+
header?: never;
|
|
3098
|
+
path?: never;
|
|
3099
|
+
cookie?: never;
|
|
3100
|
+
};
|
|
3101
|
+
requestBody: {
|
|
3102
|
+
content: {
|
|
3103
|
+
"application/json": components["schemas"]["ReviewSubmitInput"];
|
|
3104
|
+
};
|
|
3105
|
+
};
|
|
3106
|
+
responses: {
|
|
3107
|
+
/** @description Created */
|
|
3108
|
+
200: {
|
|
3109
|
+
headers: {
|
|
3110
|
+
[name: string]: unknown;
|
|
3111
|
+
};
|
|
3112
|
+
content: {
|
|
3113
|
+
"application/json": components["schemas"]["ReviewWriteResponse"];
|
|
3114
|
+
};
|
|
3115
|
+
};
|
|
3116
|
+
400: components["responses"]["Error400"];
|
|
3117
|
+
401: components["responses"]["Error401"];
|
|
3118
|
+
403: components["responses"]["Error403"];
|
|
3119
|
+
404: components["responses"]["Error404"];
|
|
3120
|
+
405: components["responses"]["Error405"];
|
|
3121
|
+
409: components["responses"]["Error409"];
|
|
3122
|
+
429: components["responses"]["Error429"];
|
|
3123
|
+
503: components["responses"]["Error503"];
|
|
3124
|
+
};
|
|
3125
|
+
};
|
|
3126
|
+
customer_reviews_update: {
|
|
3127
|
+
parameters: {
|
|
3128
|
+
query?: never;
|
|
3129
|
+
header?: never;
|
|
3130
|
+
path?: never;
|
|
3131
|
+
cookie?: never;
|
|
3132
|
+
};
|
|
3133
|
+
requestBody: {
|
|
3134
|
+
content: {
|
|
3135
|
+
"application/json": components["schemas"]["ReviewUpdateInput"];
|
|
3136
|
+
};
|
|
3137
|
+
};
|
|
3138
|
+
responses: {
|
|
3139
|
+
/** @description OK */
|
|
3140
|
+
200: {
|
|
3141
|
+
headers: {
|
|
3142
|
+
[name: string]: unknown;
|
|
3143
|
+
};
|
|
3144
|
+
content: {
|
|
3145
|
+
"application/json": components["schemas"]["ReviewWriteResponse"];
|
|
3146
|
+
};
|
|
3147
|
+
};
|
|
3148
|
+
400: components["responses"]["Error400"];
|
|
3149
|
+
401: components["responses"]["Error401"];
|
|
3150
|
+
403: components["responses"]["Error403"];
|
|
3151
|
+
404: components["responses"]["Error404"];
|
|
3152
|
+
405: components["responses"]["Error405"];
|
|
3153
|
+
429: components["responses"]["Error429"];
|
|
3154
|
+
503: components["responses"]["Error503"];
|
|
3155
|
+
};
|
|
3156
|
+
};
|
|
3157
|
+
}
|