@veroxm/sdk 0.1.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2398 @@
1
+ export interface paths {
2
+ "/projects/{uuid}/auth/token": {
3
+ parameters: {
4
+ query?: never;
5
+ header?: never;
6
+ path?: never;
7
+ cookie?: never;
8
+ };
9
+ get?: never;
10
+ put?: never;
11
+ /** Sign in with a username (or email) and password */
12
+ post: operations["signIn"];
13
+ delete?: never;
14
+ options?: never;
15
+ head?: never;
16
+ patch?: never;
17
+ trace?: never;
18
+ };
19
+ "/projects/{uuid}/auth/refresh": {
20
+ parameters: {
21
+ query?: never;
22
+ header?: never;
23
+ path?: never;
24
+ cookie?: never;
25
+ };
26
+ get?: never;
27
+ put?: never;
28
+ /** Swap a refresh token for a new session */
29
+ post: operations["refreshSession"];
30
+ delete?: never;
31
+ options?: never;
32
+ head?: never;
33
+ patch?: never;
34
+ trace?: never;
35
+ };
36
+ "/projects/{uuid}/auth/logout": {
37
+ parameters: {
38
+ query?: never;
39
+ header?: never;
40
+ path?: never;
41
+ cookie?: never;
42
+ };
43
+ get?: never;
44
+ put?: never;
45
+ /** Revoke a refresh token (sign out on this device) */
46
+ post: operations["signOut"];
47
+ delete?: never;
48
+ options?: never;
49
+ head?: never;
50
+ patch?: never;
51
+ trace?: never;
52
+ };
53
+ "/projects/{uuid}/auth/signup": {
54
+ parameters: {
55
+ query?: never;
56
+ header?: never;
57
+ path?: never;
58
+ cookie?: never;
59
+ };
60
+ get?: never;
61
+ put?: never;
62
+ /**
63
+ * Create a built-in account
64
+ * @description Signs the person in, or answers `{status: "verification_sent"}` when the project asks for a confirmed email first (or the address is already taken: the answer does not say which).
65
+ */
66
+ post: operations["signUp"];
67
+ delete?: never;
68
+ options?: never;
69
+ head?: never;
70
+ patch?: never;
71
+ trace?: never;
72
+ };
73
+ "/projects/{uuid}/auth/verify": {
74
+ parameters: {
75
+ query?: never;
76
+ header?: never;
77
+ path?: never;
78
+ cookie?: never;
79
+ };
80
+ get?: never;
81
+ put?: never;
82
+ /** Confirm an email address with its code or link token */
83
+ post: operations["verifyEmail"];
84
+ delete?: never;
85
+ options?: never;
86
+ head?: never;
87
+ patch?: never;
88
+ trace?: never;
89
+ };
90
+ "/projects/{uuid}/auth/verify/resend": {
91
+ parameters: {
92
+ query?: never;
93
+ header?: never;
94
+ path?: never;
95
+ cookie?: never;
96
+ };
97
+ get?: never;
98
+ put?: never;
99
+ /** Send the confirmation email again */
100
+ post: operations["resendVerification"];
101
+ delete?: never;
102
+ options?: never;
103
+ head?: never;
104
+ patch?: never;
105
+ trace?: never;
106
+ };
107
+ "/projects/{uuid}/auth/password/forgot": {
108
+ parameters: {
109
+ query?: never;
110
+ header?: never;
111
+ path?: never;
112
+ cookie?: never;
113
+ };
114
+ get?: never;
115
+ put?: never;
116
+ /** Email a password reset code */
117
+ post: operations["requestPasswordReset"];
118
+ delete?: never;
119
+ options?: never;
120
+ head?: never;
121
+ patch?: never;
122
+ trace?: never;
123
+ };
124
+ "/projects/{uuid}/auth/password/reset": {
125
+ parameters: {
126
+ query?: never;
127
+ header?: never;
128
+ path?: never;
129
+ cookie?: never;
130
+ };
131
+ get?: never;
132
+ put?: never;
133
+ /** Set a new password with a reset code or link token */
134
+ post: operations["resetPassword"];
135
+ delete?: never;
136
+ options?: never;
137
+ head?: never;
138
+ patch?: never;
139
+ trace?: never;
140
+ };
141
+ "/projects/{uuid}/auth/invite/accept": {
142
+ parameters: {
143
+ query?: never;
144
+ header?: never;
145
+ path?: never;
146
+ cookie?: never;
147
+ };
148
+ get?: never;
149
+ put?: never;
150
+ /** Accept an invitation and choose a password */
151
+ post: operations["acceptInvite"];
152
+ delete?: never;
153
+ options?: never;
154
+ head?: never;
155
+ patch?: never;
156
+ trace?: never;
157
+ };
158
+ "/projects/{uuid}/auth/me": {
159
+ parameters: {
160
+ query?: never;
161
+ header?: never;
162
+ path?: never;
163
+ cookie?: never;
164
+ };
165
+ /** The signed-in person's account */
166
+ get: operations["getAccount"];
167
+ put?: never;
168
+ post?: never;
169
+ /** Delete your own account */
170
+ delete: operations["deleteAccount"];
171
+ options?: never;
172
+ head?: never;
173
+ /** Change your own name */
174
+ patch: operations["updateAccount"];
175
+ trace?: never;
176
+ };
177
+ "/projects/{uuid}/auth/me/password": {
178
+ parameters: {
179
+ query?: never;
180
+ header?: never;
181
+ path?: never;
182
+ cookie?: never;
183
+ };
184
+ get?: never;
185
+ put?: never;
186
+ /** Change your password (other devices are signed out) */
187
+ post: operations["changePassword"];
188
+ delete?: never;
189
+ options?: never;
190
+ head?: never;
191
+ patch?: never;
192
+ trace?: never;
193
+ };
194
+ "/projects/{uuid}/auth/social": {
195
+ parameters: {
196
+ query?: never;
197
+ header?: never;
198
+ path?: never;
199
+ cookie?: never;
200
+ };
201
+ /** The social sign-in options to show buttons for */
202
+ get: operations["listSocialProviders"];
203
+ put?: never;
204
+ post?: never;
205
+ delete?: never;
206
+ options?: never;
207
+ head?: never;
208
+ patch?: never;
209
+ trace?: never;
210
+ };
211
+ "/projects/{uuid}/auth/social/{provider}/start": {
212
+ parameters: {
213
+ query?: never;
214
+ header?: never;
215
+ path?: never;
216
+ cookie?: never;
217
+ };
218
+ /**
219
+ * Send the person to a provider (open this address in the browser)
220
+ * @description Redirects to the provider. Afterwards VeroXM redirects to `redirect_uri` with `code` (and your `state`); exchange the code at /auth/social/token with the verifier.
221
+ */
222
+ get: operations["startSocialSignIn"];
223
+ put?: never;
224
+ post?: never;
225
+ delete?: never;
226
+ options?: never;
227
+ head?: never;
228
+ patch?: never;
229
+ trace?: never;
230
+ };
231
+ "/projects/{uuid}/auth/social/callback": {
232
+ parameters: {
233
+ query?: never;
234
+ header?: never;
235
+ path?: never;
236
+ cookie?: never;
237
+ };
238
+ /** Where providers send the person back (not called by apps) */
239
+ get: operations["socialCallback"];
240
+ put?: never;
241
+ /** Apple's form-post callback (not called by apps) */
242
+ post: operations["socialCallbackPost"];
243
+ delete?: never;
244
+ options?: never;
245
+ head?: never;
246
+ patch?: never;
247
+ trace?: never;
248
+ };
249
+ "/projects/{uuid}/auth/social/token": {
250
+ parameters: {
251
+ query?: never;
252
+ header?: never;
253
+ path?: never;
254
+ cookie?: never;
255
+ };
256
+ get?: never;
257
+ put?: never;
258
+ /** Exchange the code from a social sign-in for a session */
259
+ post: operations["exchangeSocialCode"];
260
+ delete?: never;
261
+ options?: never;
262
+ head?: never;
263
+ patch?: never;
264
+ trace?: never;
265
+ };
266
+ "/projects/{uuid}/collections/{slug}/content": {
267
+ parameters: {
268
+ query?: never;
269
+ header?: never;
270
+ path?: never;
271
+ cookie?: never;
272
+ };
273
+ /**
274
+ * A collection's entries
275
+ * @description Flags are on when present (`?count`, `?timestamps`). With `count` the answer is a number.
276
+ */
277
+ get: operations["listEntries"];
278
+ put?: never;
279
+ /** Create an entry */
280
+ post: operations["createEntry"];
281
+ delete?: never;
282
+ options?: never;
283
+ head?: never;
284
+ patch?: never;
285
+ trace?: never;
286
+ };
287
+ "/projects/{uuid}/collections/{slug}/content/search": {
288
+ parameters: {
289
+ query?: never;
290
+ header?: never;
291
+ path?: never;
292
+ cookie?: never;
293
+ };
294
+ get?: never;
295
+ put?: never;
296
+ /** Filter, sort and count entries */
297
+ post: operations["searchEntries"];
298
+ delete?: never;
299
+ options?: never;
300
+ head?: never;
301
+ patch?: never;
302
+ trace?: never;
303
+ };
304
+ "/projects/{uuid}/collections/{slug}/content/{id}": {
305
+ parameters: {
306
+ query?: never;
307
+ header?: never;
308
+ path?: never;
309
+ cookie?: never;
310
+ };
311
+ /** One published entry */
312
+ get: operations["getEntry"];
313
+ put?: never;
314
+ post?: never;
315
+ /** Delete an entry */
316
+ delete: operations["deleteEntry"];
317
+ options?: never;
318
+ head?: never;
319
+ /** Change some fields of an entry */
320
+ patch: operations["updateEntry"];
321
+ trace?: never;
322
+ };
323
+ "/projects/{uuid}/media": {
324
+ parameters: {
325
+ query?: never;
326
+ header?: never;
327
+ path?: never;
328
+ cookie?: never;
329
+ };
330
+ /** The media library, a page at a time */
331
+ get: operations["listMedia"];
332
+ put?: never;
333
+ post?: never;
334
+ delete?: never;
335
+ options?: never;
336
+ head?: never;
337
+ patch?: never;
338
+ trace?: never;
339
+ };
340
+ "/projects/{uuid}/media/upload": {
341
+ parameters: {
342
+ query?: never;
343
+ header?: never;
344
+ path?: never;
345
+ cookie?: never;
346
+ };
347
+ get?: never;
348
+ put?: never;
349
+ /** Upload a file (images are thumbnailed) */
350
+ post: operations["uploadMedia"];
351
+ delete?: never;
352
+ options?: never;
353
+ head?: never;
354
+ patch?: never;
355
+ trace?: never;
356
+ };
357
+ "/projects/{uuid}/media/{id}": {
358
+ parameters: {
359
+ query?: never;
360
+ header?: never;
361
+ path?: never;
362
+ cookie?: never;
363
+ };
364
+ get?: never;
365
+ put?: never;
366
+ post?: never;
367
+ /** Delete a file */
368
+ delete: operations["deleteMedia"];
369
+ options?: never;
370
+ head?: never;
371
+ /** Change a file's caption */
372
+ patch: operations["updateMediaCaption"];
373
+ trace?: never;
374
+ };
375
+ "/projects/{uuid}/functions/{name}": {
376
+ parameters: {
377
+ query?: never;
378
+ header?: never;
379
+ path?: never;
380
+ cookie?: never;
381
+ };
382
+ /** Call a function with GET (query values in `request.query`) */
383
+ get: operations["callFunctionGet"];
384
+ put?: never;
385
+ /** Call a function with a JSON body (in `request.body`) */
386
+ post: operations["callFunction"];
387
+ delete?: never;
388
+ options?: never;
389
+ head?: never;
390
+ patch?: never;
391
+ trace?: never;
392
+ };
393
+ "/projects/{uuid}/tasks": {
394
+ parameters: {
395
+ query?: never;
396
+ header?: never;
397
+ path?: never;
398
+ cookie?: never;
399
+ };
400
+ /** Tasks: an end user's own, or all of the project's for a server key */
401
+ get: operations["listTasks"];
402
+ put?: never;
403
+ post?: never;
404
+ delete?: never;
405
+ options?: never;
406
+ head?: never;
407
+ patch?: never;
408
+ trace?: never;
409
+ };
410
+ "/projects/{uuid}/tasks/{taskId}": {
411
+ parameters: {
412
+ query?: never;
413
+ header?: never;
414
+ path?: never;
415
+ cookie?: never;
416
+ };
417
+ /** A task, with the entry's current values */
418
+ get: operations["getTask"];
419
+ put?: never;
420
+ post?: never;
421
+ delete?: never;
422
+ options?: never;
423
+ head?: never;
424
+ patch?: never;
425
+ trace?: never;
426
+ };
427
+ "/projects/{uuid}/tasks/{taskId}/complete": {
428
+ parameters: {
429
+ query?: never;
430
+ header?: never;
431
+ path?: never;
432
+ cookie?: never;
433
+ };
434
+ get?: never;
435
+ put?: never;
436
+ /** Complete a task with one of its outcomes and the form's answers */
437
+ post: operations["completeTask"];
438
+ delete?: never;
439
+ options?: never;
440
+ head?: never;
441
+ patch?: never;
442
+ trace?: never;
443
+ };
444
+ "/projects/{uuid}/processes/{key}/runs": {
445
+ parameters: {
446
+ query?: never;
447
+ header?: never;
448
+ path?: never;
449
+ cookie?: never;
450
+ };
451
+ get?: never;
452
+ put?: never;
453
+ /** Start a process for an entry (server keys) */
454
+ post: operations["startProcess"];
455
+ delete?: never;
456
+ options?: never;
457
+ head?: never;
458
+ patch?: never;
459
+ trace?: never;
460
+ };
461
+ "/projects/{uuid}/process-runs": {
462
+ parameters: {
463
+ query?: never;
464
+ header?: never;
465
+ path?: never;
466
+ cookie?: never;
467
+ };
468
+ /** Recent process runs (server keys) */
469
+ get: operations["listProcessRuns"];
470
+ put?: never;
471
+ post?: never;
472
+ delete?: never;
473
+ options?: never;
474
+ head?: never;
475
+ patch?: never;
476
+ trace?: never;
477
+ };
478
+ "/projects/{uuid}/process-runs/{runId}": {
479
+ parameters: {
480
+ query?: never;
481
+ header?: never;
482
+ path?: never;
483
+ cookie?: never;
484
+ };
485
+ /** A run with its activity (server keys) */
486
+ get: operations["getProcessRun"];
487
+ put?: never;
488
+ post?: never;
489
+ delete?: never;
490
+ options?: never;
491
+ head?: never;
492
+ patch?: never;
493
+ trace?: never;
494
+ };
495
+ "/projects/{uuid}/events": {
496
+ parameters: {
497
+ query?: never;
498
+ header?: never;
499
+ path?: never;
500
+ cookie?: never;
501
+ };
502
+ get?: never;
503
+ put?: never;
504
+ /** Send page views and actions (up to 100 at a time) */
505
+ post: operations["sendEvents"];
506
+ delete?: never;
507
+ options?: never;
508
+ head?: never;
509
+ patch?: never;
510
+ trace?: never;
511
+ };
512
+ "/projects/{uuid}/consent": {
513
+ parameters: {
514
+ query?: never;
515
+ header?: never;
516
+ path?: never;
517
+ cookie?: never;
518
+ };
519
+ get?: never;
520
+ put?: never;
521
+ /** Record a visitor's consent answers */
522
+ post: operations["setConsent"];
523
+ delete?: never;
524
+ options?: never;
525
+ head?: never;
526
+ patch?: never;
527
+ trace?: never;
528
+ };
529
+ "/projects/{uuid}/identify": {
530
+ parameters: {
531
+ query?: never;
532
+ header?: never;
533
+ path?: never;
534
+ cookie?: never;
535
+ };
536
+ get?: never;
537
+ put?: never;
538
+ /** Link a visitor to your user id */
539
+ post: operations["identify"];
540
+ delete?: never;
541
+ options?: never;
542
+ head?: never;
543
+ patch?: never;
544
+ trace?: never;
545
+ };
546
+ "/projects/{uuid}/decide": {
547
+ parameters: {
548
+ query?: never;
549
+ header?: never;
550
+ path?: never;
551
+ cookie?: never;
552
+ };
553
+ /** Which variant of a placement this visitor sees */
554
+ get: operations["decide"];
555
+ put?: never;
556
+ post?: never;
557
+ delete?: never;
558
+ options?: never;
559
+ head?: never;
560
+ patch?: never;
561
+ trace?: never;
562
+ };
563
+ "/projects/{uuid}/recommendations": {
564
+ parameters: {
565
+ query?: never;
566
+ header?: never;
567
+ path?: never;
568
+ cookie?: never;
569
+ };
570
+ /** A collection's entries ranked for this visitor */
571
+ get: operations["recommend"];
572
+ put?: never;
573
+ post?: never;
574
+ delete?: never;
575
+ options?: never;
576
+ head?: never;
577
+ patch?: never;
578
+ trace?: never;
579
+ };
580
+ }
581
+ export type webhooks = Record<string, never>;
582
+ export interface components {
583
+ schemas: {
584
+ Error: {
585
+ /** @description What went wrong, in words for a person. Nest-generated errors (a malformed id) use it for the status name. */
586
+ error?: string | Record<string, never>;
587
+ /** @description A stable code to branch on, when there is one (for example "access_denied", "pkce_required", "function_limit"). */
588
+ code?: string;
589
+ /** @description Validation messages from the API framework. */
590
+ message?: string | string[];
591
+ /** @description Per-field problems, when a form or body has several. */
592
+ errors?: unknown;
593
+ statusCode?: number;
594
+ retryAfterSeconds?: number;
595
+ } & {
596
+ [key: string]: unknown;
597
+ };
598
+ SessionUser: {
599
+ id: number;
600
+ email: string | null;
601
+ name: string | null;
602
+ /** @description The person's end-user roles (used by `role:` access rules). */
603
+ roles: string[];
604
+ emailVerified: boolean;
605
+ };
606
+ Session: {
607
+ /** @description Send as `Authorization: Bearer <accessToken>`. */
608
+ accessToken: string;
609
+ /** @description Single use: each refresh returns a new one. */
610
+ refreshToken: string;
611
+ /** @constant */
612
+ tokenType: "Bearer";
613
+ /** @description Seconds until the access token expires. */
614
+ expiresIn: number;
615
+ abilities: string[];
616
+ user: components["schemas"]["SessionUser"];
617
+ };
618
+ VerificationSent: {
619
+ /** @constant */
620
+ status: "verification_sent";
621
+ };
622
+ Accepted: {
623
+ /** @constant */
624
+ status: "accepted";
625
+ };
626
+ Account: components["schemas"]["SessionUser"] & {
627
+ abilities: string[];
628
+ hasPassword: boolean;
629
+ /** @description "password", a social provider key, or "identity_provider". */
630
+ signInMethods: string[];
631
+ };
632
+ SocialProvider: {
633
+ key: string;
634
+ /** @enum {string} */
635
+ kind: "google" | "microsoft" | "apple" | "oidc";
636
+ name: string;
637
+ };
638
+ SignInRequest: {
639
+ username?: string;
640
+ email?: string;
641
+ password?: string;
642
+ };
643
+ RefreshRequest: {
644
+ refreshToken?: string;
645
+ };
646
+ SignUpRequest: {
647
+ email?: string;
648
+ password?: string;
649
+ name?: string;
650
+ };
651
+ CodeRequest: {
652
+ email?: string;
653
+ /** @description The 6-digit code from the email. */
654
+ code?: string;
655
+ /** @description The link token from the email (instead of email and code). */
656
+ token?: string;
657
+ };
658
+ EmailRequest: {
659
+ email?: string;
660
+ };
661
+ ResetPasswordRequest: components["schemas"]["CodeRequest"] & {
662
+ password?: string;
663
+ };
664
+ AcceptInviteRequest: components["schemas"]["CodeRequest"] & {
665
+ password?: string;
666
+ name?: string;
667
+ };
668
+ UpdateAccountRequest: {
669
+ name?: string | null;
670
+ };
671
+ ChangePasswordRequest: {
672
+ currentPassword?: string;
673
+ newPassword?: string;
674
+ };
675
+ DeleteAccountRequest: {
676
+ /** @description Needed when the account has a password. */
677
+ password?: string;
678
+ };
679
+ SocialTokenRequest: {
680
+ /** @description The one-time code VeroXM sent back to your redirect address. */
681
+ code?: string;
682
+ /** @description The PKCE verifier your app kept. */
683
+ codeVerifier?: string;
684
+ };
685
+ /** @description An entry: its id and the collection's fields, by field name. */
686
+ Entry: {
687
+ id: number;
688
+ locale?: string | null;
689
+ /** Format: date-time */
690
+ published_at?: string;
691
+ /**
692
+ * Format: date-time
693
+ * @description With `timestamps`.
694
+ */
695
+ created_at?: string;
696
+ /**
697
+ * Format: date-time
698
+ * @description With `timestamps`.
699
+ */
700
+ updated_at?: string;
701
+ } & {
702
+ [key: string]: unknown;
703
+ };
704
+ SearchRequest: {
705
+ /** @description Field filters: an array of `{field: value}` clauses (AND), each value a scalar or an operator object such as `{like: "..."}`, `{gte: 1}` or `{in: "a,b"}`. */
706
+ where?: unknown;
707
+ whereRelation?: {
708
+ [key: string]: {
709
+ [key: string]: string;
710
+ };
711
+ };
712
+ /** @description For example "created_at:desc" or "title:asc,created_at:desc". */
713
+ sort?: string;
714
+ /** @description "only_draft" for unpublished entries. */
715
+ state?: string;
716
+ offset?: number;
717
+ limit?: number;
718
+ /** @description Answer with the number of matches instead of a list. */
719
+ count?: boolean;
720
+ /** @description Answer with the first match instead of a list (404 when there is none). */
721
+ first?: boolean;
722
+ /** @description Include created_at and updated_at. */
723
+ timestamps?: boolean;
724
+ /** @description One locale's entries; omitted = the default locale. */
725
+ locale?: string;
726
+ };
727
+ /** @description Field values by name. `draft: true` keeps the entry unpublished; anything else publishes it. */
728
+ EntryWrite: {
729
+ [key: string]: unknown;
730
+ };
731
+ Deleted: {
732
+ message: string;
733
+ };
734
+ FocalPoint: {
735
+ x: number;
736
+ y: number;
737
+ };
738
+ MediaHotspot: {
739
+ id: string;
740
+ x: number;
741
+ y: number;
742
+ label: string;
743
+ url?: string;
744
+ };
745
+ MediaItem: {
746
+ id: number;
747
+ fileName: string;
748
+ fullUrl: string;
749
+ thumbUrl: string | null;
750
+ thumbWebpUrl: string | null;
751
+ fullWebpUrl: string | null;
752
+ caption: string | null;
753
+ tags: string[];
754
+ size: number | null;
755
+ width: number | null;
756
+ height: number | null;
757
+ focalPoint: components["schemas"]["FocalPoint"] | null;
758
+ hotspots: components["schemas"]["MediaHotspot"][];
759
+ };
760
+ MediaPage: {
761
+ data: components["schemas"]["MediaItem"][];
762
+ page: number;
763
+ perPage: number;
764
+ total: number;
765
+ };
766
+ MediaUpload: {
767
+ file: string;
768
+ caption?: string;
769
+ };
770
+ MediaCaption: {
771
+ caption?: string | null;
772
+ };
773
+ MediaDeleted: {
774
+ /** @constant */
775
+ success: true;
776
+ };
777
+ TaskFormField: {
778
+ name: string;
779
+ label: string;
780
+ /** @description text, long_text, number, date, choice or yes_no. */
781
+ type: string;
782
+ required: boolean;
783
+ options?: string[];
784
+ saveTo?: string;
785
+ };
786
+ TaskOutcome: {
787
+ key: string;
788
+ label: string;
789
+ };
790
+ Task: {
791
+ id: number;
792
+ /** @enum {string} */
793
+ kind: "task" | "approval";
794
+ project: {
795
+ id: number;
796
+ name: string;
797
+ };
798
+ process: {
799
+ id: number;
800
+ key: string;
801
+ name: string;
802
+ };
803
+ runId: number;
804
+ entryId: number;
805
+ title: string;
806
+ instructions: string | null;
807
+ /** @description Who it is for, in words. */
808
+ assignee: string;
809
+ form: components["schemas"]["TaskFormField"][];
810
+ outcomes: components["schemas"]["TaskOutcome"][];
811
+ requiredApprovals: number;
812
+ approvals: number;
813
+ /** @enum {string} */
814
+ status: "open" | "done" | "cancelled";
815
+ outcome: string | null;
816
+ /** @description The answers it was completed with. */
817
+ values: {
818
+ [key: string]: unknown;
819
+ } | null;
820
+ comment: string | null;
821
+ /** Format: date-time */
822
+ dueAt: string | null;
823
+ overdue: boolean;
824
+ completedBy: string | null;
825
+ /** Format: date-time */
826
+ completedAt: string | null;
827
+ /** Format: date-time */
828
+ createdAt: string;
829
+ /** @description Whether this caller can complete it now. */
830
+ canAct: boolean;
831
+ };
832
+ TaskDetail: components["schemas"]["Task"] & {
833
+ collection: {
834
+ id: number;
835
+ slug: string;
836
+ name: string;
837
+ } | null;
838
+ /** @description The entry's current values. */
839
+ record: {
840
+ name: string;
841
+ label: string;
842
+ type: string;
843
+ value: unknown;
844
+ }[];
845
+ votes: {
846
+ userId: number;
847
+ decision: string;
848
+ comment: string | null;
849
+ /** Format: date-time */
850
+ createdAt: string;
851
+ }[];
852
+ };
853
+ CompleteTaskRequest: {
854
+ /** @description One of the task's outcome keys. */
855
+ outcome: string;
856
+ /** @description Answers to the task's form, by field name. */
857
+ values?: {
858
+ [key: string]: unknown;
859
+ };
860
+ };
861
+ StartRunRequest: {
862
+ /** @description The entry the process runs for. */
863
+ entryId: number;
864
+ /** @description Values the steps can read as input.*. At most 16 KB. */
865
+ input?: {
866
+ [key: string]: unknown;
867
+ };
868
+ };
869
+ StartedRun: {
870
+ runId: number;
871
+ };
872
+ ProcessRun: {
873
+ id: number;
874
+ process: {
875
+ id: number;
876
+ key: string;
877
+ name: string;
878
+ };
879
+ entryId: number;
880
+ /** @enum {string} */
881
+ status: "active" | "completed" | "exited" | "failed";
882
+ stepIndex: number;
883
+ input: {
884
+ [key: string]: unknown;
885
+ };
886
+ startedBy: string;
887
+ /** Format: date-time */
888
+ startedAt: string;
889
+ /** Format: date-time */
890
+ nextRunAt: string | null;
891
+ /** Format: date-time */
892
+ finishedAt: string | null;
893
+ exitReason: string | null;
894
+ };
895
+ ProcessRunDetail: components["schemas"]["ProcessRun"] & {
896
+ activity: {
897
+ id: number;
898
+ stepIndex: number;
899
+ stepId: string | null;
900
+ stepType: string;
901
+ outcome: string;
902
+ detail: unknown;
903
+ /** Format: date-time */
904
+ createdAt: string;
905
+ }[];
906
+ };
907
+ EventInput: {
908
+ /**
909
+ * Format: uuid
910
+ * @description A UUID, so a retried batch is counted once.
911
+ */
912
+ eventId?: string;
913
+ visitorId: string;
914
+ /** @enum {string} */
915
+ type: "page" | "track";
916
+ name?: string;
917
+ properties?: {
918
+ [key: string]: unknown;
919
+ };
920
+ /** Format: date-time */
921
+ occurredAt?: string;
922
+ };
923
+ EventBatch: {
924
+ events: components["schemas"]["EventInput"][];
925
+ };
926
+ EventsAccepted: {
927
+ accepted: number;
928
+ };
929
+ /** @enum {string} */
930
+ ConsentValue: "granted" | "denied" | "unknown";
931
+ ConsentChoices: {
932
+ analytics?: boolean;
933
+ personalization?: boolean;
934
+ marketing?: boolean;
935
+ };
936
+ ConsentRequest: components["schemas"]["ConsentChoices"] & {
937
+ visitorId: string;
938
+ };
939
+ ConsentState: {
940
+ analytics: components["schemas"]["ConsentValue"];
941
+ personalization: components["schemas"]["ConsentValue"];
942
+ marketing: components["schemas"]["ConsentValue"];
943
+ updatedAt: string | null;
944
+ };
945
+ IdentifyRequest: {
946
+ visitorId: string;
947
+ userId: string;
948
+ traits?: {
949
+ [key: string]: unknown;
950
+ };
951
+ consent?: components["schemas"]["ConsentChoices"];
952
+ };
953
+ ProfileResult: {
954
+ /** @description null when analytics consent is not granted: nothing is stored. */
955
+ profileId: number | null;
956
+ consent: components["schemas"]["ConsentState"];
957
+ };
958
+ Decision: {
959
+ placement: string;
960
+ experienceId: number | null;
961
+ variantId: number | null;
962
+ variant: {
963
+ label: string;
964
+ isControl: boolean;
965
+ } | null;
966
+ /**
967
+ * @description "none" and "holdout": show your default.
968
+ * @enum {string}
969
+ */
970
+ reason: "targeted" | "split" | "journey" | "holdout" | "none";
971
+ /** @description The variant's entry, shaped like the content API's entries; null when there is none. */
972
+ content: unknown;
973
+ /** @description The variant's config (copy, flags); null when it has none. */
974
+ config: unknown;
975
+ };
976
+ Recommendations: {
977
+ /** @enum {string} */
978
+ strategy: "personal" | "popular";
979
+ items: components["schemas"]["Entry"][];
980
+ };
981
+ };
982
+ responses: {
983
+ /** @description The request is not valid */
984
+ E400: {
985
+ headers: {
986
+ [name: string]: unknown;
987
+ };
988
+ content: {
989
+ "application/json": components["schemas"]["Error"];
990
+ };
991
+ };
992
+ /** @description No token, or it is not valid any more */
993
+ E401: {
994
+ headers: {
995
+ [name: string]: unknown;
996
+ };
997
+ content: {
998
+ "application/json": components["schemas"]["Error"];
999
+ };
1000
+ };
1001
+ /** @description The token may not do this */
1002
+ E403: {
1003
+ headers: {
1004
+ [name: string]: unknown;
1005
+ };
1006
+ content: {
1007
+ "application/json": components["schemas"]["Error"];
1008
+ };
1009
+ };
1010
+ /** @description Not found */
1011
+ E404: {
1012
+ headers: {
1013
+ [name: string]: unknown;
1014
+ };
1015
+ content: {
1016
+ "application/json": components["schemas"]["Error"];
1017
+ };
1018
+ };
1019
+ /** @description It conflicts with the current state */
1020
+ E409: {
1021
+ headers: {
1022
+ [name: string]: unknown;
1023
+ };
1024
+ content: {
1025
+ "application/json": components["schemas"]["Error"];
1026
+ };
1027
+ };
1028
+ /** @description Too large */
1029
+ E413: {
1030
+ headers: {
1031
+ [name: string]: unknown;
1032
+ };
1033
+ content: {
1034
+ "application/json": components["schemas"]["Error"];
1035
+ };
1036
+ };
1037
+ /** @description Too many requests; see Retry-After */
1038
+ E429: {
1039
+ headers: {
1040
+ [name: string]: unknown;
1041
+ };
1042
+ content: {
1043
+ "application/json": components["schemas"]["Error"];
1044
+ };
1045
+ };
1046
+ };
1047
+ parameters: never;
1048
+ requestBodies: never;
1049
+ headers: never;
1050
+ pathItems: never;
1051
+ }
1052
+ export type $defs = Record<string, never>;
1053
+ export interface operations {
1054
+ signIn: {
1055
+ parameters: {
1056
+ query?: never;
1057
+ header?: never;
1058
+ path: {
1059
+ /** @description The project's UUID. */
1060
+ uuid: string;
1061
+ };
1062
+ cookie?: never;
1063
+ };
1064
+ requestBody: {
1065
+ content: {
1066
+ "application/json": components["schemas"]["SignInRequest"];
1067
+ };
1068
+ };
1069
+ responses: {
1070
+ /** @description Signed in */
1071
+ 201: {
1072
+ headers: {
1073
+ [name: string]: unknown;
1074
+ };
1075
+ content: {
1076
+ "application/json": components["schemas"]["Session"];
1077
+ };
1078
+ };
1079
+ 400: components["responses"]["E400"];
1080
+ 401: components["responses"]["E401"];
1081
+ 404: components["responses"]["E404"];
1082
+ 429: components["responses"]["E429"];
1083
+ };
1084
+ };
1085
+ refreshSession: {
1086
+ parameters: {
1087
+ query?: never;
1088
+ header?: never;
1089
+ path: {
1090
+ /** @description The project's UUID. */
1091
+ uuid: string;
1092
+ };
1093
+ cookie?: never;
1094
+ };
1095
+ requestBody: {
1096
+ content: {
1097
+ "application/json": components["schemas"]["RefreshRequest"];
1098
+ };
1099
+ };
1100
+ responses: {
1101
+ /** @description A new session */
1102
+ 201: {
1103
+ headers: {
1104
+ [name: string]: unknown;
1105
+ };
1106
+ content: {
1107
+ "application/json": components["schemas"]["Session"];
1108
+ };
1109
+ };
1110
+ 400: components["responses"]["E400"];
1111
+ 401: components["responses"]["E401"];
1112
+ 404: components["responses"]["E404"];
1113
+ };
1114
+ };
1115
+ signOut: {
1116
+ parameters: {
1117
+ query?: never;
1118
+ header?: never;
1119
+ path: {
1120
+ /** @description The project's UUID. */
1121
+ uuid: string;
1122
+ };
1123
+ cookie?: never;
1124
+ };
1125
+ requestBody?: {
1126
+ content: {
1127
+ "application/json": components["schemas"]["RefreshRequest"];
1128
+ };
1129
+ };
1130
+ responses: {
1131
+ /** @description Signed out */
1132
+ 204: {
1133
+ headers: {
1134
+ [name: string]: unknown;
1135
+ };
1136
+ content?: never;
1137
+ };
1138
+ 400: components["responses"]["E400"];
1139
+ 404: components["responses"]["E404"];
1140
+ };
1141
+ };
1142
+ signUp: {
1143
+ parameters: {
1144
+ query?: never;
1145
+ header?: never;
1146
+ path: {
1147
+ /** @description The project's UUID. */
1148
+ uuid: string;
1149
+ };
1150
+ cookie?: never;
1151
+ };
1152
+ requestBody: {
1153
+ content: {
1154
+ "application/json": components["schemas"]["SignUpRequest"];
1155
+ };
1156
+ };
1157
+ responses: {
1158
+ /** @description Signed up */
1159
+ 201: {
1160
+ headers: {
1161
+ [name: string]: unknown;
1162
+ };
1163
+ content: {
1164
+ "application/json": components["schemas"]["Session"] | components["schemas"]["VerificationSent"];
1165
+ };
1166
+ };
1167
+ 400: components["responses"]["E400"];
1168
+ 403: components["responses"]["E403"];
1169
+ 404: components["responses"]["E404"];
1170
+ 409: components["responses"]["E409"];
1171
+ 429: components["responses"]["E429"];
1172
+ };
1173
+ };
1174
+ verifyEmail: {
1175
+ parameters: {
1176
+ query?: never;
1177
+ header?: never;
1178
+ path: {
1179
+ /** @description The project's UUID. */
1180
+ uuid: string;
1181
+ };
1182
+ cookie?: never;
1183
+ };
1184
+ requestBody: {
1185
+ content: {
1186
+ "application/json": components["schemas"]["CodeRequest"];
1187
+ };
1188
+ };
1189
+ responses: {
1190
+ /** @description Confirmed and signed in */
1191
+ 200: {
1192
+ headers: {
1193
+ [name: string]: unknown;
1194
+ };
1195
+ content: {
1196
+ "application/json": components["schemas"]["Session"];
1197
+ };
1198
+ };
1199
+ 400: components["responses"]["E400"];
1200
+ 403: components["responses"]["E403"];
1201
+ 404: components["responses"]["E404"];
1202
+ 429: components["responses"]["E429"];
1203
+ };
1204
+ };
1205
+ resendVerification: {
1206
+ parameters: {
1207
+ query?: never;
1208
+ header?: never;
1209
+ path: {
1210
+ /** @description The project's UUID. */
1211
+ uuid: string;
1212
+ };
1213
+ cookie?: never;
1214
+ };
1215
+ requestBody: {
1216
+ content: {
1217
+ "application/json": components["schemas"]["EmailRequest"];
1218
+ };
1219
+ };
1220
+ responses: {
1221
+ /** @description Sent, if there is such an unconfirmed account */
1222
+ 202: {
1223
+ headers: {
1224
+ [name: string]: unknown;
1225
+ };
1226
+ content: {
1227
+ "application/json": components["schemas"]["Accepted"];
1228
+ };
1229
+ };
1230
+ 400: components["responses"]["E400"];
1231
+ 404: components["responses"]["E404"];
1232
+ 429: components["responses"]["E429"];
1233
+ };
1234
+ };
1235
+ requestPasswordReset: {
1236
+ parameters: {
1237
+ query?: never;
1238
+ header?: never;
1239
+ path: {
1240
+ /** @description The project's UUID. */
1241
+ uuid: string;
1242
+ };
1243
+ cookie?: never;
1244
+ };
1245
+ requestBody: {
1246
+ content: {
1247
+ "application/json": components["schemas"]["EmailRequest"];
1248
+ };
1249
+ };
1250
+ responses: {
1251
+ /** @description Sent, if there is such an account */
1252
+ 202: {
1253
+ headers: {
1254
+ [name: string]: unknown;
1255
+ };
1256
+ content: {
1257
+ "application/json": components["schemas"]["Accepted"];
1258
+ };
1259
+ };
1260
+ 400: components["responses"]["E400"];
1261
+ 404: components["responses"]["E404"];
1262
+ 429: components["responses"]["E429"];
1263
+ };
1264
+ };
1265
+ resetPassword: {
1266
+ parameters: {
1267
+ query?: never;
1268
+ header?: never;
1269
+ path: {
1270
+ /** @description The project's UUID. */
1271
+ uuid: string;
1272
+ };
1273
+ cookie?: never;
1274
+ };
1275
+ requestBody: {
1276
+ content: {
1277
+ "application/json": components["schemas"]["ResetPasswordRequest"];
1278
+ };
1279
+ };
1280
+ responses: {
1281
+ /** @description Password set and signed in */
1282
+ 200: {
1283
+ headers: {
1284
+ [name: string]: unknown;
1285
+ };
1286
+ content: {
1287
+ "application/json": components["schemas"]["Session"];
1288
+ };
1289
+ };
1290
+ 400: components["responses"]["E400"];
1291
+ 403: components["responses"]["E403"];
1292
+ 404: components["responses"]["E404"];
1293
+ 429: components["responses"]["E429"];
1294
+ };
1295
+ };
1296
+ acceptInvite: {
1297
+ parameters: {
1298
+ query?: never;
1299
+ header?: never;
1300
+ path: {
1301
+ /** @description The project's UUID. */
1302
+ uuid: string;
1303
+ };
1304
+ cookie?: never;
1305
+ };
1306
+ requestBody: {
1307
+ content: {
1308
+ "application/json": components["schemas"]["AcceptInviteRequest"];
1309
+ };
1310
+ };
1311
+ responses: {
1312
+ /** @description Account ready and signed in */
1313
+ 200: {
1314
+ headers: {
1315
+ [name: string]: unknown;
1316
+ };
1317
+ content: {
1318
+ "application/json": components["schemas"]["Session"];
1319
+ };
1320
+ };
1321
+ 400: components["responses"]["E400"];
1322
+ 403: components["responses"]["E403"];
1323
+ 404: components["responses"]["E404"];
1324
+ 429: components["responses"]["E429"];
1325
+ };
1326
+ };
1327
+ getAccount: {
1328
+ parameters: {
1329
+ query?: never;
1330
+ header?: never;
1331
+ path: {
1332
+ /** @description The project's UUID. */
1333
+ uuid: string;
1334
+ };
1335
+ cookie?: never;
1336
+ };
1337
+ requestBody?: never;
1338
+ responses: {
1339
+ /** @description OK */
1340
+ 200: {
1341
+ headers: {
1342
+ [name: string]: unknown;
1343
+ };
1344
+ content: {
1345
+ "application/json": components["schemas"]["Account"];
1346
+ };
1347
+ };
1348
+ 401: components["responses"]["E401"];
1349
+ 403: components["responses"]["E403"];
1350
+ 404: components["responses"]["E404"];
1351
+ };
1352
+ };
1353
+ deleteAccount: {
1354
+ parameters: {
1355
+ query?: never;
1356
+ header?: never;
1357
+ path: {
1358
+ /** @description The project's UUID. */
1359
+ uuid: string;
1360
+ };
1361
+ cookie?: never;
1362
+ };
1363
+ requestBody?: {
1364
+ content: {
1365
+ "application/json": components["schemas"]["DeleteAccountRequest"];
1366
+ };
1367
+ };
1368
+ responses: {
1369
+ /** @description Deleted */
1370
+ 200: {
1371
+ headers: {
1372
+ [name: string]: unknown;
1373
+ };
1374
+ content: {
1375
+ "application/json": {
1376
+ /** @constant */
1377
+ deleted: true;
1378
+ };
1379
+ };
1380
+ };
1381
+ 400: components["responses"]["E400"];
1382
+ 401: components["responses"]["E401"];
1383
+ 403: components["responses"]["E403"];
1384
+ 404: components["responses"]["E404"];
1385
+ 429: components["responses"]["E429"];
1386
+ };
1387
+ };
1388
+ updateAccount: {
1389
+ parameters: {
1390
+ query?: never;
1391
+ header?: never;
1392
+ path: {
1393
+ /** @description The project's UUID. */
1394
+ uuid: string;
1395
+ };
1396
+ cookie?: never;
1397
+ };
1398
+ requestBody: {
1399
+ content: {
1400
+ "application/json": components["schemas"]["UpdateAccountRequest"];
1401
+ };
1402
+ };
1403
+ responses: {
1404
+ /** @description OK */
1405
+ 200: {
1406
+ headers: {
1407
+ [name: string]: unknown;
1408
+ };
1409
+ content: {
1410
+ "application/json": components["schemas"]["Account"];
1411
+ };
1412
+ };
1413
+ 400: components["responses"]["E400"];
1414
+ 401: components["responses"]["E401"];
1415
+ 403: components["responses"]["E403"];
1416
+ };
1417
+ };
1418
+ changePassword: {
1419
+ parameters: {
1420
+ query?: never;
1421
+ header?: never;
1422
+ path: {
1423
+ /** @description The project's UUID. */
1424
+ uuid: string;
1425
+ };
1426
+ cookie?: never;
1427
+ };
1428
+ requestBody: {
1429
+ content: {
1430
+ "application/json": components["schemas"]["ChangePasswordRequest"];
1431
+ };
1432
+ };
1433
+ responses: {
1434
+ /** @description Changed; a new session for this device */
1435
+ 200: {
1436
+ headers: {
1437
+ [name: string]: unknown;
1438
+ };
1439
+ content: {
1440
+ "application/json": components["schemas"]["Session"];
1441
+ };
1442
+ };
1443
+ 400: components["responses"]["E400"];
1444
+ 401: components["responses"]["E401"];
1445
+ 403: components["responses"]["E403"];
1446
+ 429: components["responses"]["E429"];
1447
+ };
1448
+ };
1449
+ listSocialProviders: {
1450
+ parameters: {
1451
+ query?: never;
1452
+ header?: never;
1453
+ path: {
1454
+ /** @description The project's UUID. */
1455
+ uuid: string;
1456
+ };
1457
+ cookie?: never;
1458
+ };
1459
+ requestBody?: never;
1460
+ responses: {
1461
+ /** @description OK */
1462
+ 200: {
1463
+ headers: {
1464
+ [name: string]: unknown;
1465
+ };
1466
+ content: {
1467
+ "application/json": components["schemas"]["SocialProvider"][];
1468
+ };
1469
+ };
1470
+ 404: components["responses"]["E404"];
1471
+ };
1472
+ };
1473
+ startSocialSignIn: {
1474
+ parameters: {
1475
+ query: {
1476
+ /** @description One of the project's redirect addresses. */
1477
+ redirect_uri: string;
1478
+ /** @description base64url of the SHA-256 of your PKCE verifier. */
1479
+ code_challenge: string;
1480
+ code_challenge_method?: "S256";
1481
+ /** @description Returned to your redirect address unchanged. */
1482
+ state?: string;
1483
+ };
1484
+ header?: never;
1485
+ path: {
1486
+ /** @description The project's UUID. */
1487
+ uuid: string;
1488
+ /** @description The provider key from /auth/social. */
1489
+ provider: string;
1490
+ };
1491
+ cookie?: never;
1492
+ };
1493
+ requestBody?: never;
1494
+ responses: {
1495
+ /** @description To the provider */
1496
+ 302: {
1497
+ headers: {
1498
+ [name: string]: unknown;
1499
+ };
1500
+ content?: never;
1501
+ };
1502
+ 400: components["responses"]["E400"];
1503
+ 404: components["responses"]["E404"];
1504
+ 429: components["responses"]["E429"];
1505
+ };
1506
+ };
1507
+ socialCallback: {
1508
+ parameters: {
1509
+ query?: never;
1510
+ header?: never;
1511
+ path: {
1512
+ /** @description The project's UUID. */
1513
+ uuid: string;
1514
+ };
1515
+ cookie?: never;
1516
+ };
1517
+ requestBody?: never;
1518
+ responses: {
1519
+ /** @description To the app's redirect address */
1520
+ 302: {
1521
+ headers: {
1522
+ [name: string]: unknown;
1523
+ };
1524
+ content?: never;
1525
+ };
1526
+ /** @description An HTML page saying what went wrong */
1527
+ 400: {
1528
+ headers: {
1529
+ [name: string]: unknown;
1530
+ };
1531
+ content?: never;
1532
+ };
1533
+ };
1534
+ };
1535
+ socialCallbackPost: {
1536
+ parameters: {
1537
+ query?: never;
1538
+ header?: never;
1539
+ path: {
1540
+ /** @description The project's UUID. */
1541
+ uuid: string;
1542
+ };
1543
+ cookie?: never;
1544
+ };
1545
+ requestBody?: never;
1546
+ responses: {
1547
+ /** @description To the app's redirect address */
1548
+ 302: {
1549
+ headers: {
1550
+ [name: string]: unknown;
1551
+ };
1552
+ content?: never;
1553
+ };
1554
+ /** @description An HTML page saying what went wrong */
1555
+ 400: {
1556
+ headers: {
1557
+ [name: string]: unknown;
1558
+ };
1559
+ content?: never;
1560
+ };
1561
+ };
1562
+ };
1563
+ exchangeSocialCode: {
1564
+ parameters: {
1565
+ query?: never;
1566
+ header?: never;
1567
+ path: {
1568
+ /** @description The project's UUID. */
1569
+ uuid: string;
1570
+ };
1571
+ cookie?: never;
1572
+ };
1573
+ requestBody: {
1574
+ content: {
1575
+ "application/json": components["schemas"]["SocialTokenRequest"];
1576
+ };
1577
+ };
1578
+ responses: {
1579
+ /** @description Signed in */
1580
+ 200: {
1581
+ headers: {
1582
+ [name: string]: unknown;
1583
+ };
1584
+ content: {
1585
+ "application/json": components["schemas"]["Session"];
1586
+ };
1587
+ };
1588
+ 400: components["responses"]["E400"];
1589
+ 403: components["responses"]["E403"];
1590
+ 404: components["responses"]["E404"];
1591
+ };
1592
+ };
1593
+ listEntries: {
1594
+ parameters: {
1595
+ query?: {
1596
+ sort?: string;
1597
+ state?: string;
1598
+ offset?: number;
1599
+ limit?: number;
1600
+ count?: string;
1601
+ timestamps?: string;
1602
+ locale?: string;
1603
+ };
1604
+ header?: never;
1605
+ path: {
1606
+ /** @description The project's UUID. */
1607
+ uuid: string;
1608
+ /** @description The collection's slug. */
1609
+ slug: string;
1610
+ };
1611
+ cookie?: never;
1612
+ };
1613
+ requestBody?: never;
1614
+ responses: {
1615
+ /** @description OK */
1616
+ 200: {
1617
+ headers: {
1618
+ [name: string]: unknown;
1619
+ };
1620
+ content: {
1621
+ "application/json": components["schemas"]["Entry"][] | number;
1622
+ };
1623
+ };
1624
+ 400: components["responses"]["E400"];
1625
+ 401: components["responses"]["E401"];
1626
+ 403: components["responses"]["E403"];
1627
+ 404: components["responses"]["E404"];
1628
+ 429: components["responses"]["E429"];
1629
+ };
1630
+ };
1631
+ createEntry: {
1632
+ parameters: {
1633
+ query?: never;
1634
+ header?: never;
1635
+ path: {
1636
+ /** @description The project's UUID. */
1637
+ uuid: string;
1638
+ slug: string;
1639
+ };
1640
+ cookie?: never;
1641
+ };
1642
+ requestBody: {
1643
+ content: {
1644
+ "application/json": components["schemas"]["EntryWrite"];
1645
+ };
1646
+ };
1647
+ responses: {
1648
+ /** @description Created */
1649
+ 201: {
1650
+ headers: {
1651
+ [name: string]: unknown;
1652
+ };
1653
+ content: {
1654
+ "application/json": components["schemas"]["Entry"];
1655
+ };
1656
+ };
1657
+ 400: components["responses"]["E400"];
1658
+ 401: components["responses"]["E401"];
1659
+ 403: components["responses"]["E403"];
1660
+ 404: components["responses"]["E404"];
1661
+ 409: components["responses"]["E409"];
1662
+ 429: components["responses"]["E429"];
1663
+ };
1664
+ };
1665
+ searchEntries: {
1666
+ parameters: {
1667
+ query?: never;
1668
+ header?: never;
1669
+ path: {
1670
+ /** @description The project's UUID. */
1671
+ uuid: string;
1672
+ slug: string;
1673
+ };
1674
+ cookie?: never;
1675
+ };
1676
+ requestBody: {
1677
+ content: {
1678
+ "application/json": components["schemas"]["SearchRequest"];
1679
+ };
1680
+ };
1681
+ responses: {
1682
+ /** @description An array, a number (`count`) or one entry (`first`) */
1683
+ 201: {
1684
+ headers: {
1685
+ [name: string]: unknown;
1686
+ };
1687
+ content: {
1688
+ "application/json": components["schemas"]["Entry"][] | number | components["schemas"]["Entry"];
1689
+ };
1690
+ };
1691
+ 400: components["responses"]["E400"];
1692
+ 401: components["responses"]["E401"];
1693
+ 403: components["responses"]["E403"];
1694
+ 404: components["responses"]["E404"];
1695
+ 429: components["responses"]["E429"];
1696
+ };
1697
+ };
1698
+ getEntry: {
1699
+ parameters: {
1700
+ query?: {
1701
+ timestamps?: string;
1702
+ /** @description Present: answer with the A/B test variant's entry, plus `experiment` and `variant`. */
1703
+ experiment?: string;
1704
+ };
1705
+ header?: never;
1706
+ path: {
1707
+ /** @description The project's UUID. */
1708
+ uuid: string;
1709
+ slug: string;
1710
+ id: number;
1711
+ };
1712
+ cookie?: never;
1713
+ };
1714
+ requestBody?: never;
1715
+ responses: {
1716
+ /** @description OK */
1717
+ 200: {
1718
+ headers: {
1719
+ [name: string]: unknown;
1720
+ };
1721
+ content: {
1722
+ "application/json": components["schemas"]["Entry"];
1723
+ };
1724
+ };
1725
+ 400: components["responses"]["E400"];
1726
+ 401: components["responses"]["E401"];
1727
+ 403: components["responses"]["E403"];
1728
+ 404: components["responses"]["E404"];
1729
+ 429: components["responses"]["E429"];
1730
+ };
1731
+ };
1732
+ deleteEntry: {
1733
+ parameters: {
1734
+ query?: never;
1735
+ header?: never;
1736
+ path: {
1737
+ /** @description The project's UUID. */
1738
+ uuid: string;
1739
+ slug: string;
1740
+ id: number;
1741
+ };
1742
+ cookie?: never;
1743
+ };
1744
+ requestBody?: never;
1745
+ responses: {
1746
+ /** @description Deleted */
1747
+ 200: {
1748
+ headers: {
1749
+ [name: string]: unknown;
1750
+ };
1751
+ content: {
1752
+ "application/json": components["schemas"]["Deleted"];
1753
+ };
1754
+ };
1755
+ 400: components["responses"]["E400"];
1756
+ 401: components["responses"]["E401"];
1757
+ 403: components["responses"]["E403"];
1758
+ 404: components["responses"]["E404"];
1759
+ 429: components["responses"]["E429"];
1760
+ };
1761
+ };
1762
+ updateEntry: {
1763
+ parameters: {
1764
+ query?: never;
1765
+ header?: never;
1766
+ path: {
1767
+ /** @description The project's UUID. */
1768
+ uuid: string;
1769
+ slug: string;
1770
+ id: number;
1771
+ };
1772
+ cookie?: never;
1773
+ };
1774
+ requestBody: {
1775
+ content: {
1776
+ "application/json": components["schemas"]["EntryWrite"];
1777
+ };
1778
+ };
1779
+ responses: {
1780
+ /** @description OK */
1781
+ 200: {
1782
+ headers: {
1783
+ [name: string]: unknown;
1784
+ };
1785
+ content: {
1786
+ "application/json": components["schemas"]["Entry"];
1787
+ };
1788
+ };
1789
+ 400: components["responses"]["E400"];
1790
+ 401: components["responses"]["E401"];
1791
+ 403: components["responses"]["E403"];
1792
+ 404: components["responses"]["E404"];
1793
+ 409: components["responses"]["E409"];
1794
+ 429: components["responses"]["E429"];
1795
+ };
1796
+ };
1797
+ listMedia: {
1798
+ parameters: {
1799
+ query?: {
1800
+ page?: number;
1801
+ search?: string;
1802
+ };
1803
+ header?: never;
1804
+ path: {
1805
+ /** @description The project's UUID. */
1806
+ uuid: string;
1807
+ };
1808
+ cookie?: never;
1809
+ };
1810
+ requestBody?: never;
1811
+ responses: {
1812
+ /** @description OK */
1813
+ 200: {
1814
+ headers: {
1815
+ [name: string]: unknown;
1816
+ };
1817
+ content: {
1818
+ "application/json": components["schemas"]["MediaPage"];
1819
+ };
1820
+ };
1821
+ 401: components["responses"]["E401"];
1822
+ 403: components["responses"]["E403"];
1823
+ 429: components["responses"]["E429"];
1824
+ };
1825
+ };
1826
+ uploadMedia: {
1827
+ parameters: {
1828
+ query?: never;
1829
+ header?: never;
1830
+ path: {
1831
+ /** @description The project's UUID. */
1832
+ uuid: string;
1833
+ };
1834
+ cookie?: never;
1835
+ };
1836
+ requestBody: {
1837
+ content: {
1838
+ "multipart/form-data": components["schemas"]["MediaUpload"];
1839
+ };
1840
+ };
1841
+ responses: {
1842
+ /** @description Uploaded */
1843
+ 201: {
1844
+ headers: {
1845
+ [name: string]: unknown;
1846
+ };
1847
+ content: {
1848
+ "application/json": components["schemas"]["MediaItem"];
1849
+ };
1850
+ };
1851
+ 400: components["responses"]["E400"];
1852
+ 401: components["responses"]["E401"];
1853
+ 403: components["responses"]["E403"];
1854
+ 413: components["responses"]["E413"];
1855
+ 429: components["responses"]["E429"];
1856
+ };
1857
+ };
1858
+ deleteMedia: {
1859
+ parameters: {
1860
+ query?: never;
1861
+ header?: never;
1862
+ path: {
1863
+ /** @description The project's UUID. */
1864
+ uuid: string;
1865
+ id: number;
1866
+ };
1867
+ cookie?: never;
1868
+ };
1869
+ requestBody?: never;
1870
+ responses: {
1871
+ /** @description Deleted */
1872
+ 200: {
1873
+ headers: {
1874
+ [name: string]: unknown;
1875
+ };
1876
+ content: {
1877
+ "application/json": components["schemas"]["MediaDeleted"];
1878
+ };
1879
+ };
1880
+ 401: components["responses"]["E401"];
1881
+ 403: components["responses"]["E403"];
1882
+ 404: components["responses"]["E404"];
1883
+ 429: components["responses"]["E429"];
1884
+ };
1885
+ };
1886
+ updateMediaCaption: {
1887
+ parameters: {
1888
+ query?: never;
1889
+ header?: never;
1890
+ path: {
1891
+ /** @description The project's UUID. */
1892
+ uuid: string;
1893
+ id: number;
1894
+ };
1895
+ cookie?: never;
1896
+ };
1897
+ requestBody: {
1898
+ content: {
1899
+ "application/json": components["schemas"]["MediaCaption"];
1900
+ };
1901
+ };
1902
+ responses: {
1903
+ /** @description OK */
1904
+ 200: {
1905
+ headers: {
1906
+ [name: string]: unknown;
1907
+ };
1908
+ content: {
1909
+ "application/json": components["schemas"]["MediaItem"];
1910
+ };
1911
+ };
1912
+ 400: components["responses"]["E400"];
1913
+ 401: components["responses"]["E401"];
1914
+ 403: components["responses"]["E403"];
1915
+ 404: components["responses"]["E404"];
1916
+ 429: components["responses"]["E429"];
1917
+ };
1918
+ };
1919
+ callFunctionGet: {
1920
+ parameters: {
1921
+ query?: never;
1922
+ header?: never;
1923
+ path: {
1924
+ /** @description The project's UUID. */
1925
+ uuid: string;
1926
+ name: string;
1927
+ };
1928
+ cookie?: never;
1929
+ };
1930
+ requestBody?: never;
1931
+ responses: {
1932
+ /** @description What the function returned: JSON, or text with the type it chose. */
1933
+ 200: {
1934
+ headers: {
1935
+ [name: string]: unknown;
1936
+ };
1937
+ content: {
1938
+ "application/json": unknown;
1939
+ "text/plain": string;
1940
+ };
1941
+ };
1942
+ /** @description The function returned nothing */
1943
+ 204: {
1944
+ headers: {
1945
+ [name: string]: unknown;
1946
+ };
1947
+ content?: never;
1948
+ };
1949
+ 401: components["responses"]["E401"];
1950
+ 403: components["responses"]["E403"];
1951
+ 404: components["responses"]["E404"];
1952
+ 429: components["responses"]["E429"];
1953
+ /** @description The function failed (`code: "function_error"`); the error is in the call log */
1954
+ 500: {
1955
+ headers: {
1956
+ [name: string]: unknown;
1957
+ };
1958
+ content: {
1959
+ "application/json": components["schemas"]["Error"];
1960
+ };
1961
+ };
1962
+ /** @description Functions are off on this deployment (`code: "functions_disabled"`) */
1963
+ 503: {
1964
+ headers: {
1965
+ [name: string]: unknown;
1966
+ };
1967
+ content: {
1968
+ "application/json": components["schemas"]["Error"];
1969
+ };
1970
+ };
1971
+ /** @description The function took too long (`code: "function_timeout"`) */
1972
+ 504: {
1973
+ headers: {
1974
+ [name: string]: unknown;
1975
+ };
1976
+ content: {
1977
+ "application/json": components["schemas"]["Error"];
1978
+ };
1979
+ };
1980
+ };
1981
+ };
1982
+ callFunction: {
1983
+ parameters: {
1984
+ query?: never;
1985
+ header?: never;
1986
+ path: {
1987
+ /** @description The project's UUID. */
1988
+ uuid: string;
1989
+ name: string;
1990
+ };
1991
+ cookie?: never;
1992
+ };
1993
+ requestBody?: {
1994
+ content: {
1995
+ "application/json": unknown;
1996
+ };
1997
+ };
1998
+ responses: {
1999
+ /** @description What the function returned: JSON, or text with the type it chose. */
2000
+ 200: {
2001
+ headers: {
2002
+ [name: string]: unknown;
2003
+ };
2004
+ content: {
2005
+ "application/json": unknown;
2006
+ "text/plain": string;
2007
+ };
2008
+ };
2009
+ /** @description The function returned nothing */
2010
+ 204: {
2011
+ headers: {
2012
+ [name: string]: unknown;
2013
+ };
2014
+ content?: never;
2015
+ };
2016
+ 401: components["responses"]["E401"];
2017
+ 403: components["responses"]["E403"];
2018
+ 404: components["responses"]["E404"];
2019
+ 429: components["responses"]["E429"];
2020
+ /** @description The function failed (`code: "function_error"`); the error is in the call log */
2021
+ 500: {
2022
+ headers: {
2023
+ [name: string]: unknown;
2024
+ };
2025
+ content: {
2026
+ "application/json": components["schemas"]["Error"];
2027
+ };
2028
+ };
2029
+ /** @description Functions are off on this deployment (`code: "functions_disabled"`) */
2030
+ 503: {
2031
+ headers: {
2032
+ [name: string]: unknown;
2033
+ };
2034
+ content: {
2035
+ "application/json": components["schemas"]["Error"];
2036
+ };
2037
+ };
2038
+ /** @description The function took too long (`code: "function_timeout"`) */
2039
+ 504: {
2040
+ headers: {
2041
+ [name: string]: unknown;
2042
+ };
2043
+ content: {
2044
+ "application/json": components["schemas"]["Error"];
2045
+ };
2046
+ };
2047
+ };
2048
+ };
2049
+ listTasks: {
2050
+ parameters: {
2051
+ query?: {
2052
+ /** @description Default: open. */
2053
+ status?: "open" | "done" | "cancelled";
2054
+ entryId?: number;
2055
+ };
2056
+ header?: never;
2057
+ path: {
2058
+ /** @description The project's UUID. */
2059
+ uuid: string;
2060
+ };
2061
+ cookie?: never;
2062
+ };
2063
+ requestBody?: never;
2064
+ responses: {
2065
+ /** @description OK */
2066
+ 200: {
2067
+ headers: {
2068
+ [name: string]: unknown;
2069
+ };
2070
+ content: {
2071
+ "application/json": components["schemas"]["Task"][];
2072
+ };
2073
+ };
2074
+ 401: components["responses"]["E401"];
2075
+ 403: components["responses"]["E403"];
2076
+ 429: components["responses"]["E429"];
2077
+ };
2078
+ };
2079
+ getTask: {
2080
+ parameters: {
2081
+ query?: never;
2082
+ header?: never;
2083
+ path: {
2084
+ /** @description The project's UUID. */
2085
+ uuid: string;
2086
+ taskId: number;
2087
+ };
2088
+ cookie?: never;
2089
+ };
2090
+ requestBody?: never;
2091
+ responses: {
2092
+ /** @description OK */
2093
+ 200: {
2094
+ headers: {
2095
+ [name: string]: unknown;
2096
+ };
2097
+ content: {
2098
+ "application/json": components["schemas"]["TaskDetail"];
2099
+ };
2100
+ };
2101
+ 400: components["responses"]["E400"];
2102
+ 401: components["responses"]["E401"];
2103
+ 403: components["responses"]["E403"];
2104
+ 404: components["responses"]["E404"];
2105
+ 429: components["responses"]["E429"];
2106
+ };
2107
+ };
2108
+ completeTask: {
2109
+ parameters: {
2110
+ query?: never;
2111
+ header?: never;
2112
+ path: {
2113
+ /** @description The project's UUID. */
2114
+ uuid: string;
2115
+ taskId: number;
2116
+ };
2117
+ cookie?: never;
2118
+ };
2119
+ requestBody: {
2120
+ content: {
2121
+ "application/json": components["schemas"]["CompleteTaskRequest"];
2122
+ };
2123
+ };
2124
+ responses: {
2125
+ /** @description Completed */
2126
+ 200: {
2127
+ headers: {
2128
+ [name: string]: unknown;
2129
+ };
2130
+ content: {
2131
+ "application/json": components["schemas"]["TaskDetail"];
2132
+ };
2133
+ };
2134
+ 400: components["responses"]["E400"];
2135
+ 401: components["responses"]["E401"];
2136
+ 403: components["responses"]["E403"];
2137
+ 404: components["responses"]["E404"];
2138
+ 409: components["responses"]["E409"];
2139
+ 429: components["responses"]["E429"];
2140
+ };
2141
+ };
2142
+ startProcess: {
2143
+ parameters: {
2144
+ query?: never;
2145
+ header?: never;
2146
+ path: {
2147
+ /** @description The project's UUID. */
2148
+ uuid: string;
2149
+ /** @description The process's key. */
2150
+ key: string;
2151
+ };
2152
+ cookie?: never;
2153
+ };
2154
+ requestBody: {
2155
+ content: {
2156
+ "application/json": components["schemas"]["StartRunRequest"];
2157
+ };
2158
+ };
2159
+ responses: {
2160
+ /** @description Started */
2161
+ 201: {
2162
+ headers: {
2163
+ [name: string]: unknown;
2164
+ };
2165
+ content: {
2166
+ "application/json": components["schemas"]["StartedRun"];
2167
+ };
2168
+ };
2169
+ 400: components["responses"]["E400"];
2170
+ 401: components["responses"]["E401"];
2171
+ 403: components["responses"]["E403"];
2172
+ 404: components["responses"]["E404"];
2173
+ 409: components["responses"]["E409"];
2174
+ 429: components["responses"]["E429"];
2175
+ };
2176
+ };
2177
+ listProcessRuns: {
2178
+ parameters: {
2179
+ query?: {
2180
+ entryId?: number;
2181
+ /** @description A process's key. */
2182
+ process?: string;
2183
+ status?: "active" | "completed" | "exited" | "failed";
2184
+ };
2185
+ header?: never;
2186
+ path: {
2187
+ /** @description The project's UUID. */
2188
+ uuid: string;
2189
+ };
2190
+ cookie?: never;
2191
+ };
2192
+ requestBody?: never;
2193
+ responses: {
2194
+ /** @description OK */
2195
+ 200: {
2196
+ headers: {
2197
+ [name: string]: unknown;
2198
+ };
2199
+ content: {
2200
+ "application/json": components["schemas"]["ProcessRun"][];
2201
+ };
2202
+ };
2203
+ 401: components["responses"]["E401"];
2204
+ 403: components["responses"]["E403"];
2205
+ 429: components["responses"]["E429"];
2206
+ };
2207
+ };
2208
+ getProcessRun: {
2209
+ parameters: {
2210
+ query?: never;
2211
+ header?: never;
2212
+ path: {
2213
+ /** @description The project's UUID. */
2214
+ uuid: string;
2215
+ runId: number;
2216
+ };
2217
+ cookie?: never;
2218
+ };
2219
+ requestBody?: never;
2220
+ responses: {
2221
+ /** @description OK */
2222
+ 200: {
2223
+ headers: {
2224
+ [name: string]: unknown;
2225
+ };
2226
+ content: {
2227
+ "application/json": components["schemas"]["ProcessRunDetail"];
2228
+ };
2229
+ };
2230
+ 400: components["responses"]["E400"];
2231
+ 401: components["responses"]["E401"];
2232
+ 403: components["responses"]["E403"];
2233
+ 404: components["responses"]["E404"];
2234
+ 429: components["responses"]["E429"];
2235
+ };
2236
+ };
2237
+ sendEvents: {
2238
+ parameters: {
2239
+ query?: never;
2240
+ header?: never;
2241
+ path: {
2242
+ /** @description The project's UUID. */
2243
+ uuid: string;
2244
+ };
2245
+ cookie?: never;
2246
+ };
2247
+ requestBody: {
2248
+ content: {
2249
+ "application/json": components["schemas"]["EventBatch"];
2250
+ };
2251
+ };
2252
+ responses: {
2253
+ /** @description Queued */
2254
+ 202: {
2255
+ headers: {
2256
+ [name: string]: unknown;
2257
+ };
2258
+ content: {
2259
+ "application/json": components["schemas"]["EventsAccepted"];
2260
+ };
2261
+ };
2262
+ 400: components["responses"]["E400"];
2263
+ 401: components["responses"]["E401"];
2264
+ 403: components["responses"]["E403"];
2265
+ 429: components["responses"]["E429"];
2266
+ };
2267
+ };
2268
+ setConsent: {
2269
+ parameters: {
2270
+ query?: never;
2271
+ header?: never;
2272
+ path: {
2273
+ /** @description The project's UUID. */
2274
+ uuid: string;
2275
+ };
2276
+ cookie?: never;
2277
+ };
2278
+ requestBody: {
2279
+ content: {
2280
+ "application/json": components["schemas"]["ConsentRequest"];
2281
+ };
2282
+ };
2283
+ responses: {
2284
+ /** @description OK */
2285
+ 200: {
2286
+ headers: {
2287
+ [name: string]: unknown;
2288
+ };
2289
+ content: {
2290
+ "application/json": components["schemas"]["ProfileResult"];
2291
+ };
2292
+ };
2293
+ 400: components["responses"]["E400"];
2294
+ 401: components["responses"]["E401"];
2295
+ 403: components["responses"]["E403"];
2296
+ 429: components["responses"]["E429"];
2297
+ };
2298
+ };
2299
+ identify: {
2300
+ parameters: {
2301
+ query?: never;
2302
+ header?: never;
2303
+ path: {
2304
+ /** @description The project's UUID. */
2305
+ uuid: string;
2306
+ };
2307
+ cookie?: never;
2308
+ };
2309
+ requestBody: {
2310
+ content: {
2311
+ "application/json": components["schemas"]["IdentifyRequest"];
2312
+ };
2313
+ };
2314
+ responses: {
2315
+ /** @description OK */
2316
+ 200: {
2317
+ headers: {
2318
+ [name: string]: unknown;
2319
+ };
2320
+ content: {
2321
+ "application/json": components["schemas"]["ProfileResult"];
2322
+ };
2323
+ };
2324
+ 400: components["responses"]["E400"];
2325
+ 401: components["responses"]["E401"];
2326
+ 403: components["responses"]["E403"];
2327
+ 429: components["responses"]["E429"];
2328
+ };
2329
+ };
2330
+ decide: {
2331
+ parameters: {
2332
+ query: {
2333
+ /** @description For example "home.hero". */
2334
+ placement: string;
2335
+ visitorId: string;
2336
+ /** @description Server keys: the person in your systems. */
2337
+ userId?: string;
2338
+ /** @description Server keys: the person agreed to personalised content. */
2339
+ consent?: "personalization";
2340
+ };
2341
+ header?: never;
2342
+ path: {
2343
+ /** @description The project's UUID. */
2344
+ uuid: string;
2345
+ };
2346
+ cookie?: never;
2347
+ };
2348
+ requestBody?: never;
2349
+ responses: {
2350
+ /** @description OK */
2351
+ 200: {
2352
+ headers: {
2353
+ [name: string]: unknown;
2354
+ };
2355
+ content: {
2356
+ "application/json": components["schemas"]["Decision"];
2357
+ };
2358
+ };
2359
+ 400: components["responses"]["E400"];
2360
+ 401: components["responses"]["E401"];
2361
+ 403: components["responses"]["E403"];
2362
+ 429: components["responses"]["E429"];
2363
+ };
2364
+ };
2365
+ recommend: {
2366
+ parameters: {
2367
+ query: {
2368
+ collection: string;
2369
+ visitorId: string;
2370
+ limit?: number;
2371
+ /** @description Comma-separated entry ids to leave out. */
2372
+ exclude?: string;
2373
+ };
2374
+ header?: never;
2375
+ path: {
2376
+ /** @description The project's UUID. */
2377
+ uuid: string;
2378
+ };
2379
+ cookie?: never;
2380
+ };
2381
+ requestBody?: never;
2382
+ responses: {
2383
+ /** @description OK */
2384
+ 200: {
2385
+ headers: {
2386
+ [name: string]: unknown;
2387
+ };
2388
+ content: {
2389
+ "application/json": components["schemas"]["Recommendations"];
2390
+ };
2391
+ };
2392
+ 400: components["responses"]["E400"];
2393
+ 401: components["responses"]["E401"];
2394
+ 403: components["responses"]["E403"];
2395
+ 429: components["responses"]["E429"];
2396
+ };
2397
+ };
2398
+ }