vercel-api-js 0.22.1 → 0.23.1

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/dist/index.d.cts CHANGED
@@ -63,7 +63,2136 @@ type EdgeConfigToken = {
63
63
  /**
64
64
  * Array of events generated by the User.
65
65
  */
66
- type UserEvent = Record<string, any>;
66
+ type UserEvent = {
67
+ /**
68
+ * The unique identifier of the Event.
69
+ *
70
+ * @example uev_bfmMjiMnXfnPbT97dGdpJbCN
71
+ */
72
+ id: string;
73
+ /**
74
+ * The human-readable text of the Event.
75
+ *
76
+ * @example You logged in via GitHub
77
+ */
78
+ text: string;
79
+ /**
80
+ * A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links.
81
+ */
82
+ entities: {
83
+ /**
84
+ * The type of entity.
85
+ *
86
+ * @example author
87
+ */
88
+ type: 'author' | 'bitbucket_login' | 'bold' | 'deployment_host' | 'dns_record' | 'edge-config' | 'env_var_name' | 'flag' | 'flags-segment' | 'flags-settings' | 'git_link' | 'github_login' | 'gitlab_login' | 'hook_name' | 'integration' | 'link' | 'project_name' | 'scaling_rules' | 'store' | 'system' | 'target';
89
+ /**
90
+ * The index of where the entity begins within the `text` (inclusive).
91
+ *
92
+ * @example 0
93
+ */
94
+ start: number;
95
+ /**
96
+ * The index of where the entity ends within the `text` (non-inclusive).
97
+ *
98
+ * @example 3
99
+ */
100
+ end: number;
101
+ }[];
102
+ /**
103
+ * Timestamp (in milliseconds) of when the event was generated.
104
+ *
105
+ * @example 1632859321020
106
+ */
107
+ createdAt: number;
108
+ /**
109
+ * Metadata for the User who generated the event.
110
+ */
111
+ user?: {
112
+ avatar: string;
113
+ email: string;
114
+ slug?: string;
115
+ uid: string;
116
+ username: string;
117
+ };
118
+ /**
119
+ * The unique identifier of the User who generated the event.
120
+ *
121
+ * @example zTuNVUXEAvvnNN3IaqinkyMw
122
+ */
123
+ userId: string;
124
+ payload?: Record<string, any> | {
125
+ action: 'created' | 'updated' | 'deleted' | 'archived' | 'unarchived';
126
+ id: string;
127
+ slug: string;
128
+ projectId: string;
129
+ } | {
130
+ accessGroup: {
131
+ id: string;
132
+ name: string;
133
+ };
134
+ } | {
135
+ author: string;
136
+ accessGroup: {
137
+ id: string;
138
+ name: string;
139
+ };
140
+ } | {
141
+ accessGroup: {
142
+ id: string;
143
+ name?: string;
144
+ };
145
+ user: {
146
+ id: string;
147
+ username?: string;
148
+ };
149
+ directoryType?: string;
150
+ } | {
151
+ accessGroup: {
152
+ id: string;
153
+ name: string;
154
+ };
155
+ project: {
156
+ id: string;
157
+ name?: string;
158
+ };
159
+ next_role?: string | null;
160
+ previous_role?: string;
161
+ } | {
162
+ alias?: string;
163
+ deployment?: {
164
+ id: string;
165
+ name: string;
166
+ url: string;
167
+ meta: {
168
+ [key: string]: string;
169
+ };
170
+ } | null;
171
+ ruleCount?: number;
172
+ deploymentUrl?: string;
173
+ aliasId?: string;
174
+ deploymentId?: string | null;
175
+ oldDeploymentId?: string | null;
176
+ redirect?: string;
177
+ redirectStatusCode?: number | null;
178
+ target?: string | null;
179
+ system?: boolean;
180
+ aliasUpdatedAt?: number;
181
+ } | {
182
+ aliasId?: string;
183
+ alias?: string;
184
+ projectName?: string;
185
+ } | {
186
+ alias?: string;
187
+ } | {
188
+ alias?: string;
189
+ userId?: string;
190
+ username?: string;
191
+ } | {
192
+ alias?: string;
193
+ aliasId?: string;
194
+ userId?: string;
195
+ username?: string;
196
+ } | {
197
+ projectName: string;
198
+ alias: string;
199
+ action: 'created' | 'removed';
200
+ } | {
201
+ alias?: string;
202
+ email?: string;
203
+ username?: string;
204
+ } | {
205
+ alias?: string;
206
+ email?: string;
207
+ } | {
208
+ name?: string;
209
+ alias: string;
210
+ oldTeam?: {
211
+ name: string;
212
+ };
213
+ newTeam?: {
214
+ name: string;
215
+ };
216
+ } | {
217
+ name?: string;
218
+ alias: string;
219
+ aliasId: string;
220
+ deploymentId: string | null;
221
+ } | {
222
+ alias: string;
223
+ deploymentUrl: string;
224
+ } | {
225
+ projectName: string;
226
+ autoExposeSystemEnvs: boolean;
227
+ } | {
228
+ avatar?: string;
229
+ } | {
230
+ cn?: string;
231
+ cns?: string[];
232
+ custom: boolean;
233
+ id?: string;
234
+ } | {
235
+ cn?: string;
236
+ cns?: string[];
237
+ id?: string;
238
+ } | {
239
+ id: string;
240
+ oldTeam?: {
241
+ name: string;
242
+ };
243
+ newTeam?: {
244
+ name: string;
245
+ };
246
+ } | {
247
+ src: string;
248
+ dst: string;
249
+ } | {
250
+ id: string;
251
+ cn?: string;
252
+ cns?: string[];
253
+ } | {
254
+ cn?: string;
255
+ cns?: string[];
256
+ } | {
257
+ reason?: string;
258
+ suffix: string;
259
+ } | {
260
+ status: string;
261
+ suffix: string;
262
+ } | {
263
+ suffix: string;
264
+ } | {
265
+ team: {
266
+ id: string;
267
+ name: string;
268
+ };
269
+ configuration: {
270
+ id: string;
271
+ name?: string;
272
+ };
273
+ project: {
274
+ id: string;
275
+ name?: string;
276
+ };
277
+ buildsEnabled?: boolean;
278
+ } | {
279
+ team: {
280
+ id: string;
281
+ name: string;
282
+ };
283
+ configuration: {
284
+ id: string;
285
+ name?: string;
286
+ };
287
+ project: {
288
+ id: string;
289
+ name?: string;
290
+ };
291
+ buildsEnabled?: boolean;
292
+ passive?: boolean;
293
+ } | {
294
+ team: {
295
+ id: string;
296
+ name: string;
297
+ };
298
+ configuration: {
299
+ id: string;
300
+ name?: string;
301
+ };
302
+ project: {
303
+ id: string;
304
+ name?: string;
305
+ };
306
+ } | {
307
+ team: {
308
+ id: string;
309
+ name: string;
310
+ };
311
+ configuration: {
312
+ id: string;
313
+ name?: string;
314
+ };
315
+ newName: string;
316
+ } | {
317
+ githubLogin: string;
318
+ } | {
319
+ gitlabLogin: string;
320
+ gitlabEmail: string;
321
+ gitlabName?: string;
322
+ } | {
323
+ bitbucketEmail: string;
324
+ bitbucketLogin: string;
325
+ bitbucketName?: string;
326
+ } | {
327
+ project: {
328
+ name: string;
329
+ };
330
+ job: {
331
+ deployHook: {
332
+ createdAt: number;
333
+ id: string;
334
+ name: string;
335
+ ref: string;
336
+ };
337
+ state: string;
338
+ };
339
+ } | {
340
+ name?: string;
341
+ alias?: string[];
342
+ target?: string | null;
343
+ deployment?: {
344
+ id: string;
345
+ name: string;
346
+ url: string;
347
+ meta: {
348
+ [key: string]: string;
349
+ };
350
+ } | null;
351
+ url: string;
352
+ forced?: boolean;
353
+ deploymentId?: string;
354
+ plan?: string;
355
+ project?: string;
356
+ projectId?: string;
357
+ regions?: string[];
358
+ type?: string;
359
+ } | {
360
+ url: string;
361
+ oldTeam?: {
362
+ name: string;
363
+ };
364
+ newTeam?: {
365
+ name: string;
366
+ };
367
+ } | {
368
+ deployment: {
369
+ id: string;
370
+ name: string;
371
+ url: string;
372
+ meta: {
373
+ [key: string]: string;
374
+ };
375
+ };
376
+ deploymentId: string;
377
+ url: string;
378
+ } | {
379
+ id: string;
380
+ value: string;
381
+ name: string;
382
+ domain: string;
383
+ type: string;
384
+ mxPriority?: number;
385
+ } | {
386
+ id: string;
387
+ domain: string;
388
+ } | {
389
+ id: string;
390
+ value: string;
391
+ name: string;
392
+ domain: string;
393
+ type: string;
394
+ } | {
395
+ name: string;
396
+ } | {
397
+ name: string;
398
+ price: number;
399
+ currency?: string;
400
+ } | {
401
+ name: string;
402
+ cdnEnabled: boolean;
403
+ } | {
404
+ name: string;
405
+ userId: string;
406
+ teamId: string;
407
+ ownerName: string;
408
+ } | {
409
+ name: string;
410
+ oldTeam?: {
411
+ name: string;
412
+ };
413
+ newTeam?: {
414
+ name: string;
415
+ };
416
+ } | {
417
+ domainId: string;
418
+ name: string;
419
+ } | {
420
+ name: string;
421
+ fromId: string | null;
422
+ fromName: string | null;
423
+ } | {
424
+ name: string;
425
+ destinationId: string | null;
426
+ destinationName: string | null;
427
+ } | {
428
+ name: string;
429
+ destinationId: string;
430
+ destinationName: string;
431
+ } | {
432
+ renew?: boolean;
433
+ domain: string;
434
+ } | {
435
+ name: string;
436
+ price?: number;
437
+ currency?: string;
438
+ } | {
439
+ sha: string;
440
+ gitUserPlatform: string;
441
+ projectName: string;
442
+ } | {
443
+ email: string;
444
+ name: string;
445
+ } | {
446
+ key?: string;
447
+ projectId?: string;
448
+ projectName?: string;
449
+ target?: string | string[];
450
+ id?: string;
451
+ gitBranch?: string;
452
+ edgeConfigId?: string | null;
453
+ edgeConfigTokenId?: string | null;
454
+ source?: string;
455
+ } | {
456
+ /**
457
+ * The date when the Shared Env Var was created.
458
+ *
459
+ * @format date-time
460
+ * @example 2021-02-10T13:11:49.180Z
461
+ */
462
+ created?: string;
463
+ /**
464
+ * The name of the Shared Env Var.
465
+ *
466
+ * @example my-api-key
467
+ */
468
+ key?: string;
469
+ /**
470
+ * The unique identifier of the owner (team) the Shared Env Var was created for.
471
+ *
472
+ * @example team_LLHUOMOoDlqOp8wPE4kFo9pE
473
+ */
474
+ ownerId?: string | null;
475
+ /**
476
+ * The unique identifier of the Shared Env Var.
477
+ *
478
+ * @example env_XCG7t7AIHuO2SBA8667zNUiM
479
+ */
480
+ id?: string;
481
+ /**
482
+ * The unique identifier of the user who created the Shared Env Var.
483
+ *
484
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
485
+ */
486
+ createdBy?: string | null;
487
+ /**
488
+ * The unique identifier of the user who deleted the Shared Env Var.
489
+ *
490
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
491
+ */
492
+ deletedBy?: string | null;
493
+ /**
494
+ * The unique identifier of the user who last updated the Shared Env Var.
495
+ *
496
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
497
+ */
498
+ updatedBy?: string | null;
499
+ /**
500
+ * Timestamp for when the Shared Env Var was created.
501
+ *
502
+ * @example 1609492210000
503
+ */
504
+ createdAt?: number;
505
+ /**
506
+ * Timestamp for when the Shared Env Var was (soft) deleted.
507
+ *
508
+ * @example 1609492210000
509
+ */
510
+ deletedAt?: number;
511
+ /**
512
+ * Timestamp for when the Shared Env Var was last updated.
513
+ *
514
+ * @example 1609492210000
515
+ */
516
+ updatedAt?: number;
517
+ /**
518
+ * The value of the Shared Env Var.
519
+ */
520
+ value?: string;
521
+ /**
522
+ * The value of the shared environment variable decrypted against api-secrets-management.
523
+ */
524
+ vsmValue?: string;
525
+ /**
526
+ * The unique identifiers of the projects which the Shared Env Var is linked to.
527
+ *
528
+ * @example prj_2WjyKQmM8ZnGcJsPWMrHRHrE
529
+ * @example prj_2WjyKQmM8ZnGcJsPWMrasEFg
530
+ */
531
+ projectId?: string[];
532
+ /**
533
+ * The type of this cosmos doc instance, if blank, assume secret.
534
+ *
535
+ * @example encrypted
536
+ */
537
+ type?: 'system' | 'encrypted' | 'plain' | 'sensitive';
538
+ /**
539
+ * environments this env variable targets
540
+ *
541
+ * @example production
542
+ */
543
+ target?: ('production' | 'preview' | 'development')[];
544
+ /**
545
+ * whether or not this env varible applies to custom environments
546
+ */
547
+ applyToAllCustomEnvironments?: boolean;
548
+ /**
549
+ * whether or not this env variable is decrypted
550
+ */
551
+ decrypted?: boolean;
552
+ /**
553
+ * A user provided comment that describes what this Shared Env Var is for.
554
+ */
555
+ comment?: string;
556
+ /**
557
+ * The last editor full name or username.
558
+ */
559
+ lastEditedByDisplayName?: string;
560
+ projectNames?: string[];
561
+ } | {
562
+ oldEnvVar?: {
563
+ /**
564
+ * The date when the Shared Env Var was created.
565
+ *
566
+ * @format date-time
567
+ * @example 2021-02-10T13:11:49.180Z
568
+ */
569
+ created: string;
570
+ /**
571
+ * The name of the Shared Env Var.
572
+ *
573
+ * @example my-api-key
574
+ */
575
+ key: string;
576
+ /**
577
+ * The unique identifier of the owner (team) the Shared Env Var was created for.
578
+ *
579
+ * @example team_LLHUOMOoDlqOp8wPE4kFo9pE
580
+ */
581
+ ownerId?: string | null;
582
+ /**
583
+ * The unique identifier of the Shared Env Var.
584
+ *
585
+ * @example env_XCG7t7AIHuO2SBA8667zNUiM
586
+ */
587
+ id: string;
588
+ /**
589
+ * The unique identifier of the user who created the Shared Env Var.
590
+ *
591
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
592
+ */
593
+ createdBy?: string | null;
594
+ /**
595
+ * The unique identifier of the user who deleted the Shared Env Var.
596
+ *
597
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
598
+ */
599
+ deletedBy?: string | null;
600
+ /**
601
+ * The unique identifier of the user who last updated the Shared Env Var.
602
+ *
603
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
604
+ */
605
+ updatedBy?: string | null;
606
+ /**
607
+ * Timestamp for when the Shared Env Var was created.
608
+ *
609
+ * @example 1609492210000
610
+ */
611
+ createdAt?: number;
612
+ /**
613
+ * Timestamp for when the Shared Env Var was (soft) deleted.
614
+ *
615
+ * @example 1609492210000
616
+ */
617
+ deletedAt?: number;
618
+ /**
619
+ * Timestamp for when the Shared Env Var was last updated.
620
+ *
621
+ * @example 1609492210000
622
+ */
623
+ updatedAt?: number;
624
+ /**
625
+ * The value of the Shared Env Var.
626
+ */
627
+ value?: string;
628
+ /**
629
+ * The value of the shared environment variable decrypted against api-secrets-management.
630
+ */
631
+ vsmValue?: string;
632
+ /**
633
+ * The unique identifiers of the projects which the Shared Env Var is linked to.
634
+ *
635
+ * @example prj_2WjyKQmM8ZnGcJsPWMrHRHrE
636
+ * @example prj_2WjyKQmM8ZnGcJsPWMrasEFg
637
+ */
638
+ projectId?: string[];
639
+ /**
640
+ * The type of this cosmos doc instance, if blank, assume secret.
641
+ *
642
+ * @example encrypted
643
+ */
644
+ type?: 'system' | 'encrypted' | 'plain' | 'sensitive';
645
+ /**
646
+ * environments this env variable targets
647
+ *
648
+ * @example production
649
+ */
650
+ target?: ('production' | 'preview' | 'development')[];
651
+ /**
652
+ * whether or not this env varible applies to custom environments
653
+ */
654
+ applyToAllCustomEnvironments?: boolean;
655
+ /**
656
+ * whether or not this env variable is decrypted
657
+ */
658
+ decrypted: boolean;
659
+ /**
660
+ * A user provided comment that describes what this Shared Env Var is for.
661
+ */
662
+ comment?: string;
663
+ /**
664
+ * The last editor full name or username.
665
+ */
666
+ lastEditedByDisplayName?: string;
667
+ };
668
+ newEnvVar?: {
669
+ /**
670
+ * The date when the Shared Env Var was created.
671
+ *
672
+ * @format date-time
673
+ * @example 2021-02-10T13:11:49.180Z
674
+ */
675
+ created: string;
676
+ /**
677
+ * The name of the Shared Env Var.
678
+ *
679
+ * @example my-api-key
680
+ */
681
+ key: string;
682
+ /**
683
+ * The unique identifier of the owner (team) the Shared Env Var was created for.
684
+ *
685
+ * @example team_LLHUOMOoDlqOp8wPE4kFo9pE
686
+ */
687
+ ownerId?: string | null;
688
+ /**
689
+ * The unique identifier of the Shared Env Var.
690
+ *
691
+ * @example env_XCG7t7AIHuO2SBA8667zNUiM
692
+ */
693
+ id: string;
694
+ /**
695
+ * The unique identifier of the user who created the Shared Env Var.
696
+ *
697
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
698
+ */
699
+ createdBy?: string | null;
700
+ /**
701
+ * The unique identifier of the user who deleted the Shared Env Var.
702
+ *
703
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
704
+ */
705
+ deletedBy?: string | null;
706
+ /**
707
+ * The unique identifier of the user who last updated the Shared Env Var.
708
+ *
709
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
710
+ */
711
+ updatedBy?: string | null;
712
+ /**
713
+ * Timestamp for when the Shared Env Var was created.
714
+ *
715
+ * @example 1609492210000
716
+ */
717
+ createdAt?: number;
718
+ /**
719
+ * Timestamp for when the Shared Env Var was (soft) deleted.
720
+ *
721
+ * @example 1609492210000
722
+ */
723
+ deletedAt?: number;
724
+ /**
725
+ * Timestamp for when the Shared Env Var was last updated.
726
+ *
727
+ * @example 1609492210000
728
+ */
729
+ updatedAt?: number;
730
+ /**
731
+ * The value of the Shared Env Var.
732
+ */
733
+ value?: string;
734
+ /**
735
+ * The value of the shared environment variable decrypted against api-secrets-management.
736
+ */
737
+ vsmValue?: string;
738
+ /**
739
+ * The unique identifiers of the projects which the Shared Env Var is linked to.
740
+ *
741
+ * @example prj_2WjyKQmM8ZnGcJsPWMrHRHrE
742
+ * @example prj_2WjyKQmM8ZnGcJsPWMrasEFg
743
+ */
744
+ projectId?: string[];
745
+ /**
746
+ * The type of this cosmos doc instance, if blank, assume secret.
747
+ *
748
+ * @example encrypted
749
+ */
750
+ type?: 'system' | 'encrypted' | 'plain' | 'sensitive';
751
+ /**
752
+ * environments this env variable targets
753
+ *
754
+ * @example production
755
+ */
756
+ target?: ('production' | 'preview' | 'development')[];
757
+ /**
758
+ * whether or not this env varible applies to custom environments
759
+ */
760
+ applyToAllCustomEnvironments?: boolean;
761
+ /**
762
+ * whether or not this env variable is decrypted
763
+ */
764
+ decrypted: boolean;
765
+ /**
766
+ * A user provided comment that describes what this Shared Env Var is for.
767
+ */
768
+ comment?: string;
769
+ /**
770
+ * The last editor full name or username.
771
+ */
772
+ lastEditedByDisplayName?: string;
773
+ };
774
+ updateDiff?: {
775
+ id: string;
776
+ key?: string;
777
+ newKey?: string;
778
+ oldTarget?: ('production' | 'preview' | 'development')[];
779
+ newTarget?: ('production' | 'preview' | 'development')[];
780
+ oldType?: string;
781
+ newType?: string;
782
+ oldProjects?: {
783
+ projectName?: string;
784
+ projectId: string;
785
+ }[];
786
+ newProjects?: {
787
+ projectName?: string;
788
+ projectId: string;
789
+ }[];
790
+ changedValue: boolean;
791
+ };
792
+ } | {
793
+ projectId: string;
794
+ restore: boolean;
795
+ configVersion: number;
796
+ configChangeCount: number;
797
+ configChanges: Record<string, any>[];
798
+ } | {
799
+ projectId: string;
800
+ scope: string;
801
+ source: string;
802
+ } | {
803
+ integrationId: string;
804
+ integrationSlug: string;
805
+ integrationName: string;
806
+ } | {
807
+ userId: string;
808
+ integrationId: string;
809
+ configurationId: string;
810
+ integrationSlug: string;
811
+ integrationName?: string;
812
+ newOwner: {
813
+ abuse?: {
814
+ /**
815
+ * Since June 2023
816
+ */
817
+ blockHistory?: {
818
+ action: 'hard-blocked' | 'soft-blocked' | 'unblocked';
819
+ createdAt: number;
820
+ caseId?: string;
821
+ reason: string;
822
+ actor?: string;
823
+ statusCode?: number;
824
+ comment?: string;
825
+ }[];
826
+ /**
827
+ * Since March 2022. Helps abuse checks by tracking git auths. Format: `<platform>:<detail>:<value>`
828
+ */
829
+ gitAuthHistory?: string[];
830
+ /**
831
+ * (scanner history). Since November 2021. First element is newest.
832
+ */
833
+ history?: {
834
+ scanner: string;
835
+ reason: string;
836
+ by: string;
837
+ byId: string;
838
+ at: number;
839
+ }[];
840
+ /**
841
+ * Since September 2023. How often did this owner trigger an actual git lineage deploy block?
842
+ */
843
+ gitLineageBlocks?: number;
844
+ /**
845
+ * Since September 2023. How often did this owner trigger a git lineage deploy block dry run?
846
+ */
847
+ gitLineageBlocksDry?: number;
848
+ /**
849
+ * Since November 2021. Guides the abuse scanner in build container.
850
+ */
851
+ scanner?: string;
852
+ /**
853
+ * Since November 2021
854
+ */
855
+ updatedAt?: number;
856
+ creationUserAgent?: string;
857
+ creationIp?: string;
858
+ removedPhoneNumbers?: string;
859
+ };
860
+ acceptanceState?: string;
861
+ acceptedAt?: number;
862
+ avatar?: string;
863
+ billing: {
864
+ plan: 'pro' | 'enterprise' | 'hobby';
865
+ };
866
+ blocked: number | null;
867
+ blockReason?: string;
868
+ created?: number;
869
+ createdAt: number;
870
+ credentials?: ({
871
+ type: 'gitlab' | 'bitbucket' | 'github-oauth' | 'github-app';
872
+ id: string;
873
+ } | {
874
+ type: 'github-oauth-custom-host';
875
+ host: string;
876
+ id: string;
877
+ } | {
878
+ type: 'google';
879
+ id: string;
880
+ login: string;
881
+ createdAt: number;
882
+ } | {
883
+ type: 'tiktok';
884
+ id: string;
885
+ login: string;
886
+ createdAt: number;
887
+ })[];
888
+ customerId?: string | null;
889
+ orbCustomerId?: string | null;
890
+ dataCache?: {
891
+ excessBillingEnabled?: boolean;
892
+ };
893
+ deletedAt?: number | null;
894
+ deploymentSecret: string;
895
+ dismissedTeams?: string[];
896
+ dismissedToasts?: {
897
+ name: string;
898
+ dismissals: {
899
+ scopeId: string;
900
+ createdAt: number;
901
+ }[];
902
+ }[];
903
+ favoriteProjectsAndSpaces?: ({
904
+ projectId: string;
905
+ scopeSlug: string;
906
+ scopeId: string;
907
+ teamId?: string;
908
+ } | {
909
+ spaceId: string;
910
+ scopeSlug: string;
911
+ scopeId: string;
912
+ teamId?: string;
913
+ })[];
914
+ email: string;
915
+ id: string;
916
+ importFlowGitNamespace?: string | number | null;
917
+ importFlowGitNamespaceId?: string | number | null;
918
+ importFlowGitProvider?: 'github' | 'gitlab' | 'bitbucket' | null;
919
+ preferredScopesAndGitNamespaces?: {
920
+ scopeId: string;
921
+ gitNamespaceId: string | number | null;
922
+ }[];
923
+ isDomainReseller?: boolean;
924
+ isZeitPub?: boolean;
925
+ maxActiveSlots?: number;
926
+ name?: string;
927
+ phoneNumber?: string;
928
+ platformVersion: number | null;
929
+ preventAutoBlocking?: number | boolean;
930
+ /**
931
+ * Overrides our DEFAULT project domains limit per account or per project.
932
+ */
933
+ projectDomainsLimit?: number;
934
+ /**
935
+ * Represents configuration for remote caching
936
+ */
937
+ remoteCaching?: {
938
+ enabled?: boolean;
939
+ };
940
+ removedAliasesAt?: number;
941
+ removedBillingSubscriptionAt?: number;
942
+ removedConfigurationsAt?: number;
943
+ removedDeploymentsAt?: number;
944
+ removedDomiansAt?: number;
945
+ removedEventsAt?: number;
946
+ removedProjectsAt?: number;
947
+ removedSecretsAt?: number;
948
+ removedSharedEnvVarsAt?: number;
949
+ removedEdgeConfigsAt?: number;
950
+ resourceConfig?: {
951
+ nodeType?: string;
952
+ concurrentBuilds?: number;
953
+ buildEntitlements?: {
954
+ enhancedBuilds?: boolean;
955
+ };
956
+ awsAccountType?: string;
957
+ awsAccountIds?: string[];
958
+ cfZoneName?: string;
959
+ imageOptimizationType?: string;
960
+ edgeConfigs?: number;
961
+ edgeConfigSize?: number;
962
+ edgeFunctionMaxSizeBytes?: number;
963
+ edgeFunctionExecutionTimeoutMs?: number;
964
+ serverlessFunctionDefaultMaxExecutionTime?: number;
965
+ serverlessFunctionMaxMemorySize?: number;
966
+ kvDatabases?: number;
967
+ postgresDatabases?: number;
968
+ blobStores?: number;
969
+ integrationStores?: number;
970
+ cronJobs?: number;
971
+ cronJobsPerProject?: number;
972
+ microfrontendGroupsPerTeam?: number;
973
+ microfrontendProjectsPerGroup?: number;
974
+ };
975
+ /**
976
+ * User | Team resource limits
977
+ */
978
+ resourceLimits?: {
979
+ [key: string]: {
980
+ max: number;
981
+ duration: number;
982
+ };
983
+ };
984
+ activeDashboardViews?: {
985
+ scopeId: string;
986
+ viewPreference?: 'cards' | 'list' | null;
987
+ favoritesViewPreference?: 'open' | 'closed' | null;
988
+ recentsViewPreference?: 'open' | 'closed' | null;
989
+ }[];
990
+ secondaryEmails?: {
991
+ email: string;
992
+ verified: boolean;
993
+ }[];
994
+ emailNotifications?: {
995
+ rules?: {
996
+ [key: string]: {
997
+ email: string;
998
+ };
999
+ };
1000
+ };
1001
+ siftScore?: number;
1002
+ siftScores?: {
1003
+ [key: string]: {
1004
+ score: number;
1005
+ reasons: {
1006
+ name: string;
1007
+ value: string;
1008
+ }[];
1009
+ };
1010
+ };
1011
+ siftRoute?: {
1012
+ name: 'string';
1013
+ };
1014
+ sfdcId?: string;
1015
+ softBlock?: {
1016
+ blockedAt: number;
1017
+ reason: 'SUBSCRIPTION_CANCELED' | 'SUBSCRIPTION_EXPIRED' | 'UNPAID_INVOICE' | 'ENTERPRISE_TRIAL_ENDED' | 'FAIR_USE_LIMITS_EXCEEDED' | 'BLOCKED_FOR_PLATFORM_ABUSE';
1018
+ blockedDueToOverageType?: 'aiCredits' | 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'dataCacheRead' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequestAdditionalCpuDuration' | 'edgeRequest' | 'elasticConcurrencyBuildSlots' | 'fastDataTransfer' | 'fastOriginTransfer' | 'functionDuration' | 'functionInvocation' | 'imageOptimizationCacheRead' | 'imageOptimizationCacheWrite' | 'imageOptimizationTransformation' | 'logDrainsVolume' | 'monitoringMetric' | 'blobDataTransfer' | 'observabilityEvent' | 'postgresComputeTime' | 'postgresDataStorage' | 'postgresDataTransfer' | 'postgresDatabase' | 'postgresWrittenData' | 'serverlessFunctionExecution' | 'sourceImages' | 'storageRedisTotalBandwidthInBytes' | 'storageRedisTotalCommands' | 'storageRedisTotalDailyAvgStorageInBytes' | 'storageRedisTotalDatabases' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent';
1019
+ } | null;
1020
+ stagingPrefix: string;
1021
+ sysToken: string;
1022
+ /**
1023
+ * A helper that allows to describe a relationship attribute. It receives the shape of a relationship plus the foreignKey name to make it mandatory in the resulting type.
1024
+ */
1025
+ teams?: {
1026
+ created?: number;
1027
+ createdAt?: number;
1028
+ teamId: string;
1029
+ role?: 'OWNER' | 'MEMBER' | 'DEVELOPER' | 'SECURITY' | 'BILLING' | 'VIEWER' | 'CONTRIBUTOR';
1030
+ confirmed?: boolean;
1031
+ confirmedAt?: number;
1032
+ accessRequestedAt?: number;
1033
+ teamRoles?: ('OWNER' | 'MEMBER' | 'DEVELOPER' | 'SECURITY' | 'BILLING' | 'VIEWER' | 'CONTRIBUTOR')[];
1034
+ teamPermissions?: ('CreateProject' | 'FullProductionDeployment' | 'UsageViewer' | 'EnvVariableManager' | 'EnvironmentManager')[];
1035
+ joinedFrom?: {
1036
+ origin: 'teams' | 'saml' | 'link' | 'github' | 'gitlab' | 'bitbucket' | 'mail' | 'import' | 'dsync' | 'feedback' | 'organization-teams';
1037
+ commitId?: string;
1038
+ repoId?: string;
1039
+ repoPath?: string;
1040
+ gitUserId?: string | number;
1041
+ gitUserLogin?: string;
1042
+ ssoUserId?: string;
1043
+ ssoConnectedAt?: number;
1044
+ idpUserId?: string;
1045
+ dsyncUserId?: string;
1046
+ dsyncConnectedAt?: number;
1047
+ };
1048
+ }[];
1049
+ /**
1050
+ * Introduced 2022-04-12 An array of teamIds (for trial teams created after 2022-04-01), created by the user in question. Used in determining whether the team has a trial available in utils/api-teams/user-has-trial-available.ts.
1051
+ */
1052
+ trialTeamIds?: string[];
1053
+ /**
1054
+ * Introduced 2022-04-19 Number of maximum trials to allocate to a user. When undefined, defaults to MAX_TRIALS in utils/api-teams/user-has-trial-available.ts. This is set to trialTeamIds + 1 by services/api-backoffice/src/handlers/add-additional-trial.ts.
1055
+ */
1056
+ maxTrials?: number;
1057
+ /**
1058
+ * Deprecated on 2022-04-12 in favor of trialTeamIds and using utils/api-teams/user-has-trial-available.ts.
1059
+ */
1060
+ trialTeamId?: string;
1061
+ type: 'user';
1062
+ /**
1063
+ * Contains the timestamps when a user was notified about their usage
1064
+ */
1065
+ usageAlerts?: {
1066
+ warningAt?: number | null;
1067
+ blockingAt?: number | null;
1068
+ } | null;
1069
+ overageUsageAlerts?: {
1070
+ aiCredits?: {
1071
+ currentThreshold: number;
1072
+ warningAt?: number | null;
1073
+ blockedAt?: number | null;
1074
+ };
1075
+ analyticsUsage?: {
1076
+ currentThreshold: number;
1077
+ warningAt?: number | null;
1078
+ blockedAt?: number | null;
1079
+ };
1080
+ artifacts?: {
1081
+ currentThreshold: number;
1082
+ warningAt?: number | null;
1083
+ blockedAt?: number | null;
1084
+ };
1085
+ bandwidth?: {
1086
+ currentThreshold: number;
1087
+ warningAt?: number | null;
1088
+ blockedAt?: number | null;
1089
+ };
1090
+ blobTotalAdvancedRequests?: {
1091
+ currentThreshold: number;
1092
+ warningAt?: number | null;
1093
+ blockedAt?: number | null;
1094
+ };
1095
+ blobTotalAvgSizeInBytes?: {
1096
+ currentThreshold: number;
1097
+ warningAt?: number | null;
1098
+ blockedAt?: number | null;
1099
+ };
1100
+ blobTotalGetResponseObjectSizeInBytes?: {
1101
+ currentThreshold: number;
1102
+ warningAt?: number | null;
1103
+ blockedAt?: number | null;
1104
+ };
1105
+ blobTotalSimpleRequests?: {
1106
+ currentThreshold: number;
1107
+ warningAt?: number | null;
1108
+ blockedAt?: number | null;
1109
+ };
1110
+ dataCacheRead?: {
1111
+ currentThreshold: number;
1112
+ warningAt?: number | null;
1113
+ blockedAt?: number | null;
1114
+ };
1115
+ dataCacheWrite?: {
1116
+ currentThreshold: number;
1117
+ warningAt?: number | null;
1118
+ blockedAt?: number | null;
1119
+ };
1120
+ edgeConfigRead?: {
1121
+ currentThreshold: number;
1122
+ warningAt?: number | null;
1123
+ blockedAt?: number | null;
1124
+ };
1125
+ edgeConfigWrite?: {
1126
+ currentThreshold: number;
1127
+ warningAt?: number | null;
1128
+ blockedAt?: number | null;
1129
+ };
1130
+ edgeFunctionExecutionUnits?: {
1131
+ currentThreshold: number;
1132
+ warningAt?: number | null;
1133
+ blockedAt?: number | null;
1134
+ };
1135
+ edgeMiddlewareInvocations?: {
1136
+ currentThreshold: number;
1137
+ warningAt?: number | null;
1138
+ blockedAt?: number | null;
1139
+ };
1140
+ edgeRequestAdditionalCpuDuration?: {
1141
+ currentThreshold: number;
1142
+ warningAt?: number | null;
1143
+ blockedAt?: number | null;
1144
+ };
1145
+ edgeRequest?: {
1146
+ currentThreshold: number;
1147
+ warningAt?: number | null;
1148
+ blockedAt?: number | null;
1149
+ };
1150
+ elasticConcurrencyBuildSlots?: {
1151
+ currentThreshold: number;
1152
+ warningAt?: number | null;
1153
+ blockedAt?: number | null;
1154
+ };
1155
+ fastDataTransfer?: {
1156
+ currentThreshold: number;
1157
+ warningAt?: number | null;
1158
+ blockedAt?: number | null;
1159
+ };
1160
+ fastOriginTransfer?: {
1161
+ currentThreshold: number;
1162
+ warningAt?: number | null;
1163
+ blockedAt?: number | null;
1164
+ };
1165
+ functionDuration?: {
1166
+ currentThreshold: number;
1167
+ warningAt?: number | null;
1168
+ blockedAt?: number | null;
1169
+ };
1170
+ functionInvocation?: {
1171
+ currentThreshold: number;
1172
+ warningAt?: number | null;
1173
+ blockedAt?: number | null;
1174
+ };
1175
+ imageOptimizationCacheRead?: {
1176
+ currentThreshold: number;
1177
+ warningAt?: number | null;
1178
+ blockedAt?: number | null;
1179
+ };
1180
+ imageOptimizationCacheWrite?: {
1181
+ currentThreshold: number;
1182
+ warningAt?: number | null;
1183
+ blockedAt?: number | null;
1184
+ };
1185
+ imageOptimizationTransformation?: {
1186
+ currentThreshold: number;
1187
+ warningAt?: number | null;
1188
+ blockedAt?: number | null;
1189
+ };
1190
+ logDrainsVolume?: {
1191
+ currentThreshold: number;
1192
+ warningAt?: number | null;
1193
+ blockedAt?: number | null;
1194
+ };
1195
+ monitoringMetric?: {
1196
+ currentThreshold: number;
1197
+ warningAt?: number | null;
1198
+ blockedAt?: number | null;
1199
+ };
1200
+ blobDataTransfer?: {
1201
+ currentThreshold: number;
1202
+ warningAt?: number | null;
1203
+ blockedAt?: number | null;
1204
+ };
1205
+ observabilityEvent?: {
1206
+ currentThreshold: number;
1207
+ warningAt?: number | null;
1208
+ blockedAt?: number | null;
1209
+ };
1210
+ postgresComputeTime?: {
1211
+ currentThreshold: number;
1212
+ warningAt?: number | null;
1213
+ blockedAt?: number | null;
1214
+ };
1215
+ postgresDataStorage?: {
1216
+ currentThreshold: number;
1217
+ warningAt?: number | null;
1218
+ blockedAt?: number | null;
1219
+ };
1220
+ postgresDataTransfer?: {
1221
+ currentThreshold: number;
1222
+ warningAt?: number | null;
1223
+ blockedAt?: number | null;
1224
+ };
1225
+ postgresDatabase?: {
1226
+ currentThreshold: number;
1227
+ warningAt?: number | null;
1228
+ blockedAt?: number | null;
1229
+ };
1230
+ postgresWrittenData?: {
1231
+ currentThreshold: number;
1232
+ warningAt?: number | null;
1233
+ blockedAt?: number | null;
1234
+ };
1235
+ serverlessFunctionExecution?: {
1236
+ currentThreshold: number;
1237
+ warningAt?: number | null;
1238
+ blockedAt?: number | null;
1239
+ };
1240
+ sourceImages?: {
1241
+ currentThreshold: number;
1242
+ warningAt?: number | null;
1243
+ blockedAt?: number | null;
1244
+ };
1245
+ storageRedisTotalBandwidthInBytes?: {
1246
+ currentThreshold: number;
1247
+ warningAt?: number | null;
1248
+ blockedAt?: number | null;
1249
+ };
1250
+ storageRedisTotalCommands?: {
1251
+ currentThreshold: number;
1252
+ warningAt?: number | null;
1253
+ blockedAt?: number | null;
1254
+ };
1255
+ storageRedisTotalDailyAvgStorageInBytes?: {
1256
+ currentThreshold: number;
1257
+ warningAt?: number | null;
1258
+ blockedAt?: number | null;
1259
+ };
1260
+ storageRedisTotalDatabases?: {
1261
+ currentThreshold: number;
1262
+ warningAt?: number | null;
1263
+ blockedAt?: number | null;
1264
+ };
1265
+ wafOwaspExcessBytes?: {
1266
+ currentThreshold: number;
1267
+ warningAt?: number | null;
1268
+ blockedAt?: number | null;
1269
+ };
1270
+ wafOwaspRequests?: {
1271
+ currentThreshold: number;
1272
+ warningAt?: number | null;
1273
+ blockedAt?: number | null;
1274
+ };
1275
+ wafRateLimitRequest?: {
1276
+ currentThreshold: number;
1277
+ warningAt?: number | null;
1278
+ blockedAt?: number | null;
1279
+ };
1280
+ webAnalyticsEvent?: {
1281
+ currentThreshold: number;
1282
+ warningAt?: number | null;
1283
+ blockedAt?: number | null;
1284
+ };
1285
+ };
1286
+ username: string;
1287
+ updatedAt: number;
1288
+ /**
1289
+ * Whether the Vercel Toolbar is enabled for preview deployments.
1290
+ */
1291
+ enablePreviewFeedback?: 'default' | 'on' | 'off' | 'on-force' | 'off-force' | 'default-force';
1292
+ /**
1293
+ * Information about which features are blocked for a user. Blocks can be either soft (the user can still access the feature, but with a warning, e.g. prompting an upgrade) or hard (the user cannot access the feature at all).
1294
+ */
1295
+ featureBlocks?: {
1296
+ webAnalytics?: {
1297
+ updatedAt?: number;
1298
+ blockedFrom?: number;
1299
+ blockedUntil?: number;
1300
+ blockReason?: 'admin_override' | 'limits_exceeded';
1301
+ graceEmailSentAt?: number;
1302
+ };
1303
+ /**
1304
+ * A soft block indicates a temporary pause in data collection (ex limit exceeded for the current cycle) A hard block indicates a stoppage in data collection that requires manual intervention (ex upgrading a pro trial)
1305
+ */
1306
+ monitoring?: {
1307
+ updatedAt?: number;
1308
+ blockedFrom?: number;
1309
+ blockedUntil?: number;
1310
+ blockReason?: 'admin_override' | 'limits_exceeded';
1311
+ blockType: 'soft' | 'hard';
1312
+ };
1313
+ observabilityPlus?: {
1314
+ updatedAt?: number;
1315
+ blockedFrom?: number;
1316
+ blockedUntil?: number;
1317
+ blockReason?: 'admin_override' | 'limits_exceeded';
1318
+ blockType: 'soft' | 'hard';
1319
+ };
1320
+ dataCache?: {
1321
+ updatedAt: number;
1322
+ blockedFrom?: number;
1323
+ blockedUntil?: number;
1324
+ blockReason: 'admin_override' | 'limits_exceeded';
1325
+ };
1326
+ imageOptimizationTransformation?: {
1327
+ updatedAt: number;
1328
+ blockedFrom?: number;
1329
+ blockedUntil?: number;
1330
+ blockReason: 'admin_override' | 'limits_exceeded';
1331
+ };
1332
+ sourceImages?: {
1333
+ updatedAt: number;
1334
+ blockedFrom?: number;
1335
+ blockedUntil?: number;
1336
+ blockReason: 'admin_override' | 'limits_exceeded';
1337
+ };
1338
+ blob?: {
1339
+ updatedAt?: number;
1340
+ blockedFrom?: number;
1341
+ blockedUntil?: number;
1342
+ blockReason?: 'admin_override' | 'limits_exceeded';
1343
+ overageReason: 'aiCredits' | 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'dataCacheRead' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequestAdditionalCpuDuration' | 'edgeRequest' | 'elasticConcurrencyBuildSlots' | 'fastDataTransfer' | 'fastOriginTransfer' | 'functionDuration' | 'functionInvocation' | 'imageOptimizationCacheRead' | 'imageOptimizationCacheWrite' | 'imageOptimizationTransformation' | 'logDrainsVolume' | 'monitoringMetric' | 'blobDataTransfer' | 'observabilityEvent' | 'postgresComputeTime' | 'postgresDataStorage' | 'postgresDataTransfer' | 'postgresDatabase' | 'postgresWrittenData' | 'serverlessFunctionExecution' | 'sourceImages' | 'storageRedisTotalBandwidthInBytes' | 'storageRedisTotalCommands' | 'storageRedisTotalDailyAvgStorageInBytes' | 'storageRedisTotalDatabases' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent';
1344
+ };
1345
+ postgres?: {
1346
+ updatedAt?: number;
1347
+ blockedFrom?: number;
1348
+ blockedUntil?: number;
1349
+ blockReason?: 'admin_override' | 'limits_exceeded';
1350
+ overageReason: 'aiCredits' | 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'dataCacheRead' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequestAdditionalCpuDuration' | 'edgeRequest' | 'elasticConcurrencyBuildSlots' | 'fastDataTransfer' | 'fastOriginTransfer' | 'functionDuration' | 'functionInvocation' | 'imageOptimizationCacheRead' | 'imageOptimizationCacheWrite' | 'imageOptimizationTransformation' | 'logDrainsVolume' | 'monitoringMetric' | 'blobDataTransfer' | 'observabilityEvent' | 'postgresComputeTime' | 'postgresDataStorage' | 'postgresDataTransfer' | 'postgresDatabase' | 'postgresWrittenData' | 'serverlessFunctionExecution' | 'sourceImages' | 'storageRedisTotalBandwidthInBytes' | 'storageRedisTotalCommands' | 'storageRedisTotalDailyAvgStorageInBytes' | 'storageRedisTotalDatabases' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent';
1351
+ };
1352
+ redis?: {
1353
+ updatedAt?: number;
1354
+ blockedFrom?: number;
1355
+ blockedUntil?: number;
1356
+ blockReason?: 'admin_override' | 'limits_exceeded';
1357
+ overageReason: 'aiCredits' | 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'dataCacheRead' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequestAdditionalCpuDuration' | 'edgeRequest' | 'elasticConcurrencyBuildSlots' | 'fastDataTransfer' | 'fastOriginTransfer' | 'functionDuration' | 'functionInvocation' | 'imageOptimizationCacheRead' | 'imageOptimizationCacheWrite' | 'imageOptimizationTransformation' | 'logDrainsVolume' | 'monitoringMetric' | 'blobDataTransfer' | 'observabilityEvent' | 'postgresComputeTime' | 'postgresDataStorage' | 'postgresDataTransfer' | 'postgresDatabase' | 'postgresWrittenData' | 'serverlessFunctionExecution' | 'sourceImages' | 'storageRedisTotalBandwidthInBytes' | 'storageRedisTotalCommands' | 'storageRedisTotalDailyAvgStorageInBytes' | 'storageRedisTotalDatabases' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent';
1358
+ };
1359
+ };
1360
+ defaultTeamId?: string;
1361
+ version: 'northstar';
1362
+ /**
1363
+ * An archive of information about the Northstar migration, derived from the old (deprecated) property, `northstarMigrationEvents`.
1364
+ */
1365
+ northstarMigration?: {
1366
+ /**
1367
+ * The ID of the team we created for this user.
1368
+ */
1369
+ teamId: string;
1370
+ /**
1371
+ * The number of projects migrated for this user.
1372
+ */
1373
+ projects: number;
1374
+ /**
1375
+ * The number of stores migrated for this user.
1376
+ */
1377
+ stores: number;
1378
+ /**
1379
+ * The number of integration configurations migrated for this user.
1380
+ */
1381
+ integrationConfigurations: number;
1382
+ /**
1383
+ * The number of integration clients migrated for this user.
1384
+ */
1385
+ integrationClients: number;
1386
+ /**
1387
+ * The migration start time timestamp for this user.
1388
+ */
1389
+ startTime: number;
1390
+ /**
1391
+ * The migration end time timestamp for this user.
1392
+ */
1393
+ endTime: number;
1394
+ };
1395
+ /**
1396
+ * The salesforce opportunity ID that this user is linked to. This is used to automatically associate a team of the user's choosing with the opportunity.
1397
+ */
1398
+ opportunityId?: string;
1399
+ /**
1400
+ * MFA configuration. When enabled, the user will be required to provide a second factor of authentication when logging in.
1401
+ */
1402
+ mfaConfiguration?: {
1403
+ enabled: boolean;
1404
+ enabledAt?: number;
1405
+ recoveryCodes: string[];
1406
+ totp?: {
1407
+ secret: string;
1408
+ createdAt: number;
1409
+ };
1410
+ };
1411
+ } | null;
1412
+ } | {
1413
+ configurations: {
1414
+ integrationId: string;
1415
+ configurationId: string;
1416
+ integrationSlug: string;
1417
+ integrationName?: string;
1418
+ }[];
1419
+ ownerId: string;
1420
+ } | {
1421
+ integrationId: string;
1422
+ configurationId: string;
1423
+ integrationSlug: string;
1424
+ integrationName: string;
1425
+ ownerId: string;
1426
+ billingPlanId: string;
1427
+ billingPlanName?: string;
1428
+ } | {
1429
+ integrationId: string;
1430
+ configurationId: string;
1431
+ integrationSlug: string;
1432
+ integrationName: string;
1433
+ ownerId: string;
1434
+ projectIds?: string[];
1435
+ } | {
1436
+ projectId: string;
1437
+ fromDeploymentId: string;
1438
+ toDeploymentId: string;
1439
+ projectName: string;
1440
+ reason?: string;
1441
+ } | {
1442
+ integrationId: string;
1443
+ configurationId: string;
1444
+ integrationSlug: string;
1445
+ integrationName: string;
1446
+ ownerId: string;
1447
+ projectIds?: string[];
1448
+ confirmedScopes: string[];
1449
+ } | {
1450
+ userAgent?: {
1451
+ browser: {
1452
+ name: 'iphone' | 'ipad' | 'ipod' | 'chrome' | 'firefox' | 'mozilla' | 'unknown';
1453
+ };
1454
+ ua: string;
1455
+ program: string;
1456
+ os: {
1457
+ name: 'unknown' | 'darwin' | 'win32' | 'win' | 'windows' | 'linux' | 'freebsd' | 'sunos' | 'mac' | 'ios' | 'android' | 'Mac OS' | 'OS X';
1458
+ };
1459
+ };
1460
+ geolocation?: {
1461
+ city?: {
1462
+ names: {
1463
+ en: string;
1464
+ };
1465
+ };
1466
+ country: {
1467
+ names: {
1468
+ en: string;
1469
+ };
1470
+ };
1471
+ most_specific_subdivision?: {
1472
+ names: {
1473
+ en: string;
1474
+ };
1475
+ };
1476
+ regionName?: string;
1477
+ } | null;
1478
+ viaGithub: boolean;
1479
+ viaGitlab: boolean;
1480
+ viaBitbucket: boolean;
1481
+ viaSamlSso: boolean;
1482
+ viaPasskey: boolean;
1483
+ ssoType?: string;
1484
+ env?: string;
1485
+ os?: string;
1486
+ username?: string;
1487
+ } | {
1488
+ logDrainUrl: string | null;
1489
+ integrationName?: string;
1490
+ } | {
1491
+ logDrainUrl: string;
1492
+ integrationName?: string;
1493
+ } | {
1494
+ drainUrl: string | null;
1495
+ integrationName?: string;
1496
+ } | {
1497
+ projectId: string;
1498
+ toDeploymentId: string;
1499
+ projectName: string;
1500
+ } | {
1501
+ plan: string;
1502
+ removedUsers?: {
1503
+ [key: string]: {
1504
+ role: 'OWNER' | 'MEMBER' | 'DEVELOPER' | 'SECURITY' | 'BILLING' | 'VIEWER' | 'CONTRIBUTOR';
1505
+ confirmed: boolean;
1506
+ confirmedAt?: number;
1507
+ joinedFrom?: {
1508
+ origin: 'teams' | 'saml' | 'link' | 'github' | 'gitlab' | 'bitbucket' | 'mail' | 'import' | 'dsync' | 'feedback' | 'organization-teams';
1509
+ commitId?: string;
1510
+ repoId?: string;
1511
+ repoPath?: string;
1512
+ gitUserId?: string | number;
1513
+ gitUserLogin?: string;
1514
+ ssoUserId?: string;
1515
+ ssoConnectedAt?: number;
1516
+ idpUserId?: string;
1517
+ dsyncUserId?: string;
1518
+ dsyncConnectedAt?: number;
1519
+ };
1520
+ };
1521
+ };
1522
+ priorPlan?: string;
1523
+ isDowngrade?: boolean;
1524
+ userAgent?: string;
1525
+ isReactivate?: boolean;
1526
+ isTrialUpgrade?: boolean;
1527
+ } | {
1528
+ projectName?: string;
1529
+ projectId: string;
1530
+ projectAnalytics: {
1531
+ id: string;
1532
+ canceledAt?: number | null;
1533
+ disabledAt: number;
1534
+ enabledAt: number;
1535
+ paidAt?: number;
1536
+ sampleRatePercent?: number | null;
1537
+ spendLimitInDollars?: number | null;
1538
+ } | null;
1539
+ prevProjectAnalytics: {
1540
+ id: string;
1541
+ canceledAt?: number | null;
1542
+ disabledAt: number;
1543
+ enabledAt: number;
1544
+ paidAt?: number;
1545
+ sampleRatePercent?: number | null;
1546
+ spendLimitInDollars?: number | null;
1547
+ } | null;
1548
+ } | {
1549
+ projectName?: string;
1550
+ projectId: string;
1551
+ projectAnalytics?: {
1552
+ [key: string]: any;
1553
+ };
1554
+ prevProjectAnalytics?: {
1555
+ [key: string]: any;
1556
+ } | null;
1557
+ } | {
1558
+ projectName?: string;
1559
+ projectId: string;
1560
+ } | {
1561
+ projectName: string;
1562
+ ssoProtection: {
1563
+ deploymentType: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews';
1564
+ } | ('all' | 'preview' | 'prod_deployment_urls_and_all_previews') | null;
1565
+ oldSsoProtection: {
1566
+ deploymentType: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews';
1567
+ } | ('all' | 'preview' | 'prod_deployment_urls_and_all_previews') | null;
1568
+ } | {
1569
+ projectName: string;
1570
+ passwordProtection: {
1571
+ deploymentType: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews';
1572
+ } | ('all' | 'preview' | 'prod_deployment_urls_and_all_previews') | null;
1573
+ oldPasswordProtection: {
1574
+ deploymentType: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews';
1575
+ } | ('all' | 'preview' | 'prod_deployment_urls_and_all_previews') | null;
1576
+ } | {
1577
+ projectName: string;
1578
+ trustedIps?: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews' | 'production' | null;
1579
+ oldTrustedIps?: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews' | 'production' | null;
1580
+ addedAddresses?: string[] | null;
1581
+ removedAddresses?: string[] | null;
1582
+ } | {
1583
+ projectName: string;
1584
+ optionsAllowlist?: {
1585
+ paths: {
1586
+ value: string;
1587
+ }[];
1588
+ } | null;
1589
+ oldOptionsAllowlist?: {
1590
+ paths: {
1591
+ value: string;
1592
+ }[];
1593
+ } | null;
1594
+ } | {
1595
+ projectName: string;
1596
+ action: 'enabled' | 'disabled' | 'regenerated';
1597
+ } | {
1598
+ name: string;
1599
+ ownerId: string;
1600
+ } | {
1601
+ team: {
1602
+ id: string;
1603
+ name: string;
1604
+ };
1605
+ project: {
1606
+ id: string;
1607
+ name?: string;
1608
+ oldConnectConfigurations: Record<string, any>[] | null;
1609
+ newConnectConfigurations: Record<string, any>[] | null;
1610
+ };
1611
+ } | {
1612
+ projectId: string;
1613
+ } | {
1614
+ gitProvider: string;
1615
+ gitProviderGroupDescriptor: string;
1616
+ gitScope: string;
1617
+ } | {
1618
+ instances: number;
1619
+ url: string;
1620
+ } | {
1621
+ email: string;
1622
+ verified: boolean;
1623
+ } | {
1624
+ email: string;
1625
+ } | {
1626
+ team: {
1627
+ id: string;
1628
+ name?: string;
1629
+ };
1630
+ previousRule?: {
1631
+ email: string;
1632
+ };
1633
+ nextRule?: {
1634
+ email: string;
1635
+ };
1636
+ } | {
1637
+ team: {
1638
+ id: string;
1639
+ name?: string;
1640
+ };
1641
+ previousRule: {
1642
+ email: string;
1643
+ };
1644
+ } | {
1645
+ uid: string;
1646
+ name: string | {
1647
+ name: string;
1648
+ };
1649
+ } | {
1650
+ oldName: string;
1651
+ newName: string;
1652
+ uid?: string;
1653
+ } | {
1654
+ bio: string;
1655
+ } | {
1656
+ scalingRules: {
1657
+ [key: string]: {
1658
+ min: number;
1659
+ max: number;
1660
+ };
1661
+ };
1662
+ min: number;
1663
+ max: number;
1664
+ url: string;
1665
+ } | {
1666
+ webhookUrl?: string;
1667
+ } | {
1668
+ /**
1669
+ * Represents a budget for tracking and notifying teams on their spending.
1670
+ */
1671
+ budget: {
1672
+ /**
1673
+ * The budget type
1674
+ */
1675
+ type: 'fixed';
1676
+ /**
1677
+ * Budget amount
1678
+ */
1679
+ fixedBudget: number;
1680
+ /**
1681
+ * Array of the last 3 months of spend data
1682
+ */
1683
+ previousSpend: number[];
1684
+ /**
1685
+ * Array of 50, 75, 100 to keep track of notifications sent out
1686
+ */
1687
+ notifiedAt: number[];
1688
+ /**
1689
+ * Webhook id that corresponds to a webhook in Cosmos webhook collection
1690
+ */
1691
+ webhookId?: string;
1692
+ /**
1693
+ * Keep track if the webhook has been called for the month
1694
+ */
1695
+ webhookNotified?: boolean;
1696
+ /**
1697
+ * Date time when budget is created
1698
+ */
1699
+ createdAt: number;
1700
+ /**
1701
+ * Date time when budget is updated last
1702
+ */
1703
+ updatedAt?: number;
1704
+ /**
1705
+ * Is the budget currently active for a customer
1706
+ */
1707
+ isActive: boolean;
1708
+ /**
1709
+ * Should all projects be paused if budget is exceeded
1710
+ */
1711
+ pauseProjects?: boolean;
1712
+ /**
1713
+ * The acive pricing plan the team is billed with
1714
+ */
1715
+ pricingPlan?: 'legacy' | 'unbundled';
1716
+ /**
1717
+ * Partition key
1718
+ */
1719
+ teamId: string;
1720
+ /**
1721
+ * Sort key that needs to be unique per teamId
1722
+ */
1723
+ id: string;
1724
+ };
1725
+ } | {
1726
+ budget: {
1727
+ /**
1728
+ * Represents a budget for tracking and notifying teams on their spending.
1729
+ */
1730
+ budgetItem: {
1731
+ /**
1732
+ * The budget type
1733
+ */
1734
+ type: 'fixed';
1735
+ /**
1736
+ * Budget amount
1737
+ */
1738
+ fixedBudget: number;
1739
+ /**
1740
+ * Array of the last 3 months of spend data
1741
+ */
1742
+ previousSpend: number[];
1743
+ /**
1744
+ * Array of 50, 75, 100 to keep track of notifications sent out
1745
+ */
1746
+ notifiedAt: number[];
1747
+ /**
1748
+ * Webhook id that corresponds to a webhook in Cosmos webhook collection
1749
+ */
1750
+ webhookId?: string;
1751
+ /**
1752
+ * Keep track if the webhook has been called for the month
1753
+ */
1754
+ webhookNotified?: boolean;
1755
+ /**
1756
+ * Date time when budget is created
1757
+ */
1758
+ createdAt: number;
1759
+ /**
1760
+ * Date time when budget is updated last
1761
+ */
1762
+ updatedAt?: number;
1763
+ /**
1764
+ * Is the budget currently active for a customer
1765
+ */
1766
+ isActive: boolean;
1767
+ /**
1768
+ * Should all projects be paused if budget is exceeded
1769
+ */
1770
+ pauseProjects?: boolean;
1771
+ /**
1772
+ * The acive pricing plan the team is billed with
1773
+ */
1774
+ pricingPlan?: 'legacy' | 'unbundled';
1775
+ /**
1776
+ * Partition key
1777
+ */
1778
+ teamId: string;
1779
+ /**
1780
+ * Sort key that needs to be unique per teamId
1781
+ */
1782
+ id: string;
1783
+ };
1784
+ };
1785
+ } | {
1786
+ id: string;
1787
+ name?: string;
1788
+ computeUnitsMax?: number;
1789
+ computeUnitsMin?: number;
1790
+ suspendTimeoutSeconds?: number;
1791
+ type: 'integration' | 'edge-config' | 'redis' | 'postgres' | 'blob';
1792
+ } | {
1793
+ storeType: 'redis' | 'postgres';
1794
+ } | {
1795
+ store: {
1796
+ name: string;
1797
+ id: string;
1798
+ };
1799
+ ownerId?: string;
1800
+ } | {
1801
+ slug: string;
1802
+ } | {
1803
+ slug: string;
1804
+ teamId: string;
1805
+ by: string;
1806
+ reasons?: {
1807
+ slug: string;
1808
+ description: string;
1809
+ }[];
1810
+ } | {
1811
+ directoryType?: string;
1812
+ ssoType?: string;
1813
+ invitedUser?: {
1814
+ username: string;
1815
+ email: string;
1816
+ };
1817
+ invitedEmail?: string;
1818
+ invitationRole?: string;
1819
+ entitlements?: string[];
1820
+ invitedUid?: string;
1821
+ } | {
1822
+ deletedUser?: {
1823
+ username: string;
1824
+ email: string;
1825
+ };
1826
+ deletedUid?: string;
1827
+ githubUsername?: string | null;
1828
+ gitlabUsername?: string | null;
1829
+ bitbucketUsername?: string | null;
1830
+ directoryType?: string;
1831
+ } | {
1832
+ role?: string;
1833
+ uid: string;
1834
+ origin?: string;
1835
+ } | {
1836
+ directoryType?: string;
1837
+ updatedUser?: {
1838
+ username: string;
1839
+ email: string;
1840
+ };
1841
+ role?: string;
1842
+ previousRole: string;
1843
+ updatedUid?: string;
1844
+ } | {
1845
+ entitlement: string;
1846
+ user: {
1847
+ id: string;
1848
+ username: string;
1849
+ };
1850
+ } | {
1851
+ entitlement: string;
1852
+ user: {
1853
+ id: string;
1854
+ username: string;
1855
+ };
1856
+ previousCanceledAt?: string;
1857
+ } | {
1858
+ name?: string;
1859
+ } | {
1860
+ slug?: string;
1861
+ } | {
1862
+ /**
1863
+ * Represents configuration for remote caching
1864
+ */
1865
+ remoteCaching?: {
1866
+ enabled?: boolean;
1867
+ };
1868
+ } | {
1869
+ previous: {
1870
+ enabled: boolean;
1871
+ totpVerified: boolean;
1872
+ };
1873
+ next: {
1874
+ enabled: boolean;
1875
+ totpVerified: boolean;
1876
+ };
1877
+ } | {
1878
+ enabled: boolean;
1879
+ totpVerified: boolean;
1880
+ } | {
1881
+ mfaEnabled: boolean;
1882
+ } | {
1883
+ email: string;
1884
+ prevEmail: string;
1885
+ } | {
1886
+ username: string;
1887
+ } | {
1888
+ price?: number;
1889
+ currency?: string;
1890
+ enabled?: boolean;
1891
+ } | {
1892
+ previewDeploymentSuffix?: string | null;
1893
+ previousPreviewDeploymentSuffix?: string | null;
1894
+ } | {
1895
+ price?: number;
1896
+ currency?: string;
1897
+ } | {
1898
+ teamName: string;
1899
+ username?: string;
1900
+ gitUsername?: string;
1901
+ githubUsername?: string | null;
1902
+ gitlabUsername?: string | null;
1903
+ bitbucketUsername?: string | null;
1904
+ updatedUid?: string;
1905
+ teamId?: string;
1906
+ } | {
1907
+ teamName: string;
1908
+ username?: string;
1909
+ gitUsername?: string | null;
1910
+ githubUsername?: string | null;
1911
+ gitlabUsername?: string | null;
1912
+ bitbucketUsername?: string | null;
1913
+ } | {
1914
+ requestedTeamName: string;
1915
+ requestedUserName?: string;
1916
+ gitUsername?: string;
1917
+ githubUsername?: string;
1918
+ gitlabUsername?: string;
1919
+ bitbucketUsername?: string;
1920
+ } | {
1921
+ projectId: string;
1922
+ projectName: string;
1923
+ originAccountName: string;
1924
+ destinationAccountName: string;
1925
+ destinationAccountId: string;
1926
+ transferId?: string;
1927
+ } | {
1928
+ projectName: string;
1929
+ destinationAccountName: string | null;
1930
+ transferId?: string;
1931
+ } | {
1932
+ previousProjectName: string;
1933
+ newProjectName: string;
1934
+ destinationAccountName: string;
1935
+ transferId?: string;
1936
+ } | {
1937
+ previousProjectName: string;
1938
+ newProjectName: string;
1939
+ originAccountName: string;
1940
+ transferId?: string;
1941
+ } | {
1942
+ project: {
1943
+ name: string;
1944
+ id?: string;
1945
+ };
1946
+ projectMembership: {
1947
+ role?: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1948
+ uid?: string;
1949
+ createdAt?: number;
1950
+ username?: string;
1951
+ } | null;
1952
+ } | {
1953
+ project: {
1954
+ name: string;
1955
+ id?: string;
1956
+ };
1957
+ removedMembership: {
1958
+ role?: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1959
+ uid?: string;
1960
+ createdAt?: number;
1961
+ username?: string;
1962
+ };
1963
+ } | {
1964
+ project: {
1965
+ id: string;
1966
+ name: string;
1967
+ };
1968
+ projectMembership: {
1969
+ role?: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1970
+ uid?: string;
1971
+ createdAt?: number;
1972
+ username?: string;
1973
+ previousRole?: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1974
+ };
1975
+ } | {
1976
+ project: {
1977
+ name: string;
1978
+ role: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1979
+ invitedUserName: string;
1980
+ id?: string;
1981
+ invitedUserId?: string;
1982
+ };
1983
+ } | {
1984
+ edgeConfigId: string;
1985
+ edgeConfigSlug: string;
1986
+ edgeConfigDigest: string;
1987
+ } | {
1988
+ edgeConfigId: string;
1989
+ edgeConfigSlug: string;
1990
+ edgeConfigTokenId: string;
1991
+ label: string;
1992
+ } | {
1993
+ edgeConfigId: string;
1994
+ edgeConfigSlug: string;
1995
+ /**
1996
+ * ids of deleted tokens
1997
+ */
1998
+ edgeConfigTokenIds: string[];
1999
+ } | {
2000
+ id: string;
2001
+ slug: string;
2002
+ name: string;
2003
+ } | {
2004
+ id: string;
2005
+ slug: string;
2006
+ name: string;
2007
+ prev: {
2008
+ name: string;
2009
+ slug: string;
2010
+ };
2011
+ } | {
2012
+ project: {
2013
+ id: string;
2014
+ name: string;
2015
+ };
2016
+ group: {
2017
+ id: string;
2018
+ slug: string;
2019
+ name: string;
2020
+ };
2021
+ } | {
2022
+ project: {
2023
+ id: string;
2024
+ name: string;
2025
+ microfrontends?: {
2026
+ /**
2027
+ * Timestamp when the microfrontends settings were last updated.
2028
+ */
2029
+ updatedAt: number;
2030
+ /**
2031
+ * The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
2032
+ *
2033
+ * @maxItems 2
2034
+ * @minItems 2
2035
+ */
2036
+ groupIds: (string | string)[];
2037
+ /**
2038
+ * Whether microfrontends are enabled for this project.
2039
+ */
2040
+ enabled: boolean;
2041
+ /**
2042
+ * Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends.
2043
+ */
2044
+ isDefaultApp?: boolean;
2045
+ /**
2046
+ * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
2047
+ */
2048
+ defaultRoute?: string;
2049
+ /**
2050
+ * Whether observability data should be routed to this microfrontend project or a root project.
2051
+ */
2052
+ routeObservabilityToThisProject?: boolean;
2053
+ } | {
2054
+ updatedAt: number;
2055
+ /**
2056
+ * @maxItems 2
2057
+ * @minItems 2
2058
+ */
2059
+ groupIds: (string | string)[];
2060
+ enabled: boolean;
2061
+ };
2062
+ };
2063
+ prev: {
2064
+ project: {
2065
+ microfrontends?: {
2066
+ /**
2067
+ * Timestamp when the microfrontends settings were last updated.
2068
+ */
2069
+ updatedAt: number;
2070
+ /**
2071
+ * The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
2072
+ *
2073
+ * @maxItems 2
2074
+ * @minItems 2
2075
+ */
2076
+ groupIds: (string | string)[];
2077
+ /**
2078
+ * Whether microfrontends are enabled for this project.
2079
+ */
2080
+ enabled: boolean;
2081
+ /**
2082
+ * Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends.
2083
+ */
2084
+ isDefaultApp?: boolean;
2085
+ /**
2086
+ * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
2087
+ */
2088
+ defaultRoute?: string;
2089
+ /**
2090
+ * Whether observability data should be routed to this microfrontend project or a root project.
2091
+ */
2092
+ routeObservabilityToThisProject?: boolean;
2093
+ } | {
2094
+ updatedAt: number;
2095
+ /**
2096
+ * @maxItems 2
2097
+ * @minItems 2
2098
+ */
2099
+ groupIds: (string | string)[];
2100
+ enabled: boolean;
2101
+ };
2102
+ };
2103
+ };
2104
+ group: {
2105
+ id: string;
2106
+ slug: string;
2107
+ name: string;
2108
+ };
2109
+ } | {
2110
+ projectId: string;
2111
+ projectName: string;
2112
+ projectWebAnalytics?: {
2113
+ id: string;
2114
+ disabledAt?: number;
2115
+ canceledAt?: number;
2116
+ enabledAt?: number;
2117
+ hasData?: boolean;
2118
+ };
2119
+ prevProjectWebAnalytics?: {
2120
+ id: string;
2121
+ disabledAt?: number;
2122
+ canceledAt?: number;
2123
+ enabledAt?: number;
2124
+ hasData?: boolean;
2125
+ } | null;
2126
+ } | {
2127
+ tier: 'pro' | 'plus';
2128
+ } | {
2129
+ oldName: string;
2130
+ newName: string;
2131
+ } | {
2132
+ appName: string;
2133
+ scopes: string[];
2134
+ } | {
2135
+ appName: string;
2136
+ nextScopes: string[];
2137
+ } | {
2138
+ appName: string;
2139
+ } | {
2140
+ team: {
2141
+ id: string;
2142
+ name: string;
2143
+ };
2144
+ configuration: {
2145
+ id: string;
2146
+ name?: string;
2147
+ };
2148
+ peering: {
2149
+ id: string;
2150
+ accountId: string;
2151
+ region: string;
2152
+ vpcId: string;
2153
+ };
2154
+ } | {
2155
+ team: {
2156
+ id: string;
2157
+ name: string;
2158
+ };
2159
+ configuration: {
2160
+ id: string;
2161
+ name?: string;
2162
+ };
2163
+ peering: {
2164
+ id: string;
2165
+ name?: string;
2166
+ };
2167
+ } | {
2168
+ team: {
2169
+ id: string;
2170
+ name: string;
2171
+ };
2172
+ configuration: {
2173
+ id: string;
2174
+ name?: string;
2175
+ };
2176
+ peering: {
2177
+ id: string;
2178
+ name?: string;
2179
+ };
2180
+ newName?: string;
2181
+ } | {
2182
+ grantType: 'authorization_code' | 'refresh_token' | 'urn:ietf:params:oauth:grant-type:device_code' | 'client_credentials';
2183
+ appName: string;
2184
+ /**
2185
+ * access_token TTL
2186
+ */
2187
+ atTTL: number;
2188
+ /**
2189
+ * refresh_token TTL
2190
+ */
2191
+ rtTTL?: number;
2192
+ scope: string;
2193
+ authMethod: 'email' | 'saml' | 'github' | 'gitlab' | 'bitbucket' | 'manual' | 'passkey' | 'otp' | 'sms' | 'invite' | 'google' | 'tiktok';
2194
+ };
2195
+ };
67
2196
  /**
68
2197
  * Data representing a Team.
69
2198
  */
@@ -186,7 +2315,7 @@ type TeamLimited = {
186
2315
  accessRequestedAt?: number;
187
2316
  role: 'BILLING' | 'CONTRIBUTOR' | 'DEVELOPER' | 'MEMBER' | 'OWNER' | 'SECURITY' | 'VIEWER';
188
2317
  teamRoles?: ('BILLING' | 'CONTRIBUTOR' | 'DEVELOPER' | 'MEMBER' | 'OWNER' | 'SECURITY' | 'VIEWER')[];
189
- teamPermissions?: ('CreateProject' | 'FullProductionDeployment' | 'UsageViewer')[];
2318
+ teamPermissions?: ('CreateProject' | 'EnvVariableManager' | 'EnvironmentManager' | 'FullProductionDeployment' | 'UsageViewer')[];
190
2319
  teamId?: string;
191
2320
  createdAt: number;
192
2321
  created: number;
@@ -253,13 +2382,13 @@ type AuthToken = {
253
2382
  origin: 'totp' | 'webauthn' | 'recovery-code';
254
2383
  expiresAt: number;
255
2384
  };
256
- origin: 'saml' | 'github' | 'gitlab' | 'bitbucket' | 'email' | 'manual' | 'passkey' | 'otp' | 'sms' | 'invite';
2385
+ origin: 'saml' | 'github' | 'gitlab' | 'bitbucket' | 'email' | 'manual' | 'passkey' | 'otp' | 'sms' | 'invite' | 'google' | 'tiktok';
257
2386
  createdAt: number;
258
2387
  expiresAt?: number;
259
2388
  } | {
260
2389
  type: 'team';
261
2390
  teamId: string;
262
- origin: 'saml' | 'github' | 'gitlab' | 'bitbucket' | 'email' | 'manual' | 'passkey' | 'otp' | 'sms' | 'invite';
2391
+ origin: 'saml' | 'github' | 'gitlab' | 'bitbucket' | 'email' | 'manual' | 'passkey' | 'otp' | 'sms' | 'invite' | 'google' | 'tiktok';
263
2392
  createdAt: number;
264
2393
  expiresAt?: number;
265
2394
  })[];
@@ -298,7 +2427,7 @@ type AuthUser = {
298
2427
  softBlock: {
299
2428
  blockedAt: number;
300
2429
  reason: 'BLOCKED_FOR_PLATFORM_ABUSE' | 'ENTERPRISE_TRIAL_ENDED' | 'FAIR_USE_LIMITS_EXCEEDED' | 'SUBSCRIPTION_CANCELED' | 'SUBSCRIPTION_EXPIRED' | 'UNPAID_INVOICE';
301
- blockedDueToOverageType?: 'aiCredits' | 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'dataCacheRead' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequest' | 'edgeRequestAdditionalCpuDuration' | 'elasticConcurrencyBuildSlots' | 'fastDataTransfer' | 'fastOriginTransfer' | 'functionDuration' | 'functionInvocation' | 'imageOptimizationCacheRead' | 'imageOptimizationCacheWrite' | 'imageOptimizationTransformation' | 'logDrainsVolume' | 'monitoringMetric' | 'objectDataTransfer' | 'observabilityEvent' | 'postgresComputeTime' | 'postgresDataStorage' | 'postgresDataTransfer' | 'postgresDatabase' | 'postgresWrittenData' | 'serverlessFunctionExecution' | 'sourceImages' | 'storageRedisTotalBandwidthInBytes' | 'storageRedisTotalCommands' | 'storageRedisTotalDailyAvgStorageInBytes' | 'storageRedisTotalDatabases' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent';
2430
+ blockedDueToOverageType?: 'aiCredits' | 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobDataTransfer' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'dataCacheRead' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequest' | 'edgeRequestAdditionalCpuDuration' | 'elasticConcurrencyBuildSlots' | 'fastDataTransfer' | 'fastOriginTransfer' | 'functionDuration' | 'functionInvocation' | 'imageOptimizationCacheRead' | 'imageOptimizationCacheWrite' | 'imageOptimizationTransformation' | 'logDrainsVolume' | 'monitoringMetric' | 'observabilityEvent' | 'postgresComputeTime' | 'postgresDataStorage' | 'postgresDataTransfer' | 'postgresDatabase' | 'postgresWrittenData' | 'serverlessFunctionExecution' | 'sourceImages' | 'storageRedisTotalBandwidthInBytes' | 'storageRedisTotalCommands' | 'storageRedisTotalDailyAvgStorageInBytes' | 'storageRedisTotalDatabases' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent';
302
2431
  } | null;
303
2432
  /**
304
2433
  * An object containing billing infomation associated with the User account.
@@ -316,6 +2445,15 @@ type AuthUser = {
316
2445
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
317
2446
  */
318
2447
  concurrentBuilds?: number;
2448
+ /**
2449
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
2450
+ */
2451
+ buildEntitlements?: {
2452
+ /**
2453
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
2454
+ */
2455
+ enhancedBuilds?: boolean;
2456
+ };
319
2457
  /**
320
2458
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
321
2459
  */
@@ -352,6 +2490,10 @@ type AuthUser = {
352
2490
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
353
2491
  */
354
2492
  serverlessFunctionDefaultMaxExecutionTime?: number;
2493
+ /**
2494
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
2495
+ */
2496
+ serverlessFunctionMaxMemorySize?: number;
355
2497
  /**
356
2498
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
357
2499
  */
@@ -2364,7 +4506,7 @@ type UpdateProjectDataCacheResponse = {
2364
4506
  private: boolean;
2365
4507
  readyAt?: number;
2366
4508
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
2367
- readySubstate?: 'PROMOTED' | 'STAGED';
4509
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
2368
4510
  requestedAt?: number;
2369
4511
  target?: string | null;
2370
4512
  teamId?: string | null;
@@ -2595,7 +4737,7 @@ type UpdateProjectDataCacheResponse = {
2595
4737
  private: boolean;
2596
4738
  readyAt?: number;
2597
4739
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
2598
- readySubstate?: 'PROMOTED' | 'STAGED';
4740
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
2599
4741
  requestedAt?: number;
2600
4742
  target?: string | null;
2601
4743
  teamId?: string | null;
@@ -3106,7 +5248,13 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
3106
5248
  env: string[];
3107
5249
  };
3108
5250
  buildArtifactUrls?: string[];
3109
- builds?: Record<string, any>[];
5251
+ builds?: {
5252
+ use: string;
5253
+ src?: string;
5254
+ config?: {
5255
+ [key: string]: any;
5256
+ };
5257
+ }[];
3110
5258
  env: string[];
3111
5259
  inspectorUrl: string | null;
3112
5260
  isInConcurrentBuildsQueue: boolean;
@@ -3329,9 +5477,9 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
3329
5477
  framework?: string | null;
3330
5478
  };
3331
5479
  /**
3332
- * Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
5480
+ * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
3333
5481
  */
3334
- readySubstate?: "STAGED" | "PROMOTED";
5482
+ readySubstate?: "STAGED" | "ROLLING" | "PROMOTED";
3335
5483
  regions: string[];
3336
5484
  softDeletedByRetention?: boolean;
3337
5485
  source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
@@ -3679,9 +5827,9 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
3679
5827
  framework?: string | null;
3680
5828
  };
3681
5829
  /**
3682
- * Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
5830
+ * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
3683
5831
  */
3684
- readySubstate?: "STAGED" | "PROMOTED";
5832
+ readySubstate?: "STAGED" | "ROLLING" | "PROMOTED";
3685
5833
  regions: string[];
3686
5834
  softDeletedByRetention?: boolean;
3687
5835
  source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
@@ -3727,7 +5875,13 @@ type CreateDeploymentResponse = {
3727
5875
  env: string[];
3728
5876
  };
3729
5877
  buildArtifactUrls?: string[];
3730
- builds?: Record<string, any>[];
5878
+ builds?: {
5879
+ use: string;
5880
+ src?: string;
5881
+ config?: {
5882
+ [key: string]: any;
5883
+ };
5884
+ }[];
3731
5885
  env: string[];
3732
5886
  inspectorUrl: string | null;
3733
5887
  isInConcurrentBuildsQueue: boolean;
@@ -3954,9 +6108,9 @@ type CreateDeploymentResponse = {
3954
6108
  errorStep?: string;
3955
6109
  originCacheRegion?: string;
3956
6110
  /**
3957
- * Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
6111
+ * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
3958
6112
  */
3959
- readySubstate?: 'PROMOTED' | 'STAGED';
6113
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
3960
6114
  softDeletedByRetention?: boolean;
3961
6115
  undeletedAt?: number;
3962
6116
  url: string;
@@ -4404,7 +6558,13 @@ type CancelDeploymentResponse = {
4404
6558
  env: string[];
4405
6559
  };
4406
6560
  buildArtifactUrls?: string[];
4407
- builds?: Record<string, any>[];
6561
+ builds?: {
6562
+ use: string;
6563
+ src?: string;
6564
+ config?: {
6565
+ [key: string]: any;
6566
+ };
6567
+ }[];
4408
6568
  env: string[];
4409
6569
  inspectorUrl: string | null;
4410
6570
  isInConcurrentBuildsQueue: boolean;
@@ -4626,9 +6786,9 @@ type CancelDeploymentResponse = {
4626
6786
  };
4627
6787
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
4628
6788
  /**
4629
- * Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
6789
+ * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
4630
6790
  */
4631
- readySubstate?: 'PROMOTED' | 'STAGED';
6791
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
4632
6792
  regions: string[];
4633
6793
  softDeletedByRetention?: boolean;
4634
6794
  source?: 'api-trigger-git-deploy' | 'cli' | 'clone/repo' | 'git' | 'import' | 'import/repo' | 'redeploy' | 'v0-web';
@@ -5662,6 +7822,11 @@ type GetDomainConfigResponse = {
5662
7822
  * Whether or not the domain is configured AND we can automatically generate a TLS certificate.
5663
7823
  */
5664
7824
  misconfigured: boolean;
7825
+ /**
7826
+ * Recommended IPs and CNAME for the domain.
7827
+ */
7828
+ recommendedIps?: string[];
7829
+ recommendedCname?: string;
5665
7830
  };
5666
7831
  type GetDomainConfigVariables = {
5667
7832
  pathParams: GetDomainConfigPathParams;
@@ -5739,6 +7904,12 @@ type GetDomainResponse = {
5739
7904
  * @example 1613602938882
5740
7905
  */
5741
7906
  boughtAt: number | null;
7907
+ /**
7908
+ * The domain name.
7909
+ *
7910
+ * @example example.com
7911
+ */
7912
+ name: string;
5742
7913
  /**
5743
7914
  * Timestamp in milliseconds when the domain was created in the registry.
5744
7915
  *
@@ -5757,12 +7928,6 @@ type GetDomainResponse = {
5757
7928
  * @example EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1
5758
7929
  */
5759
7930
  id: string;
5760
- /**
5761
- * The domain name.
5762
- *
5763
- * @example example.com
5764
- */
5765
- name: string;
5766
7931
  /**
5767
7932
  * Timestamp in milliseconds at which the domain was ordered.
5768
7933
  *
@@ -6243,7 +8408,6 @@ type GetConfigurableLogDrainError = ErrorWrapper<undefined>;
6243
8408
  type GetConfigurableLogDrainResponse = {
6244
8409
  clientId?: string;
6245
8410
  configurationId?: string;
6246
- deliveryFormat: 'json' | 'ndjson' | 'syslog';
6247
8411
  sources?: ('build' | 'edge' | 'external' | 'firewall' | 'lambda' | 'static')[];
6248
8412
  environments: ('preview' | 'production')[];
6249
8413
  status?: 'disabled' | 'enabled' | 'errored';
@@ -6266,6 +8430,7 @@ type GetConfigurableLogDrainResponse = {
6266
8430
  teamId?: string | null;
6267
8431
  ownerId: string;
6268
8432
  createdFrom?: 'integration' | 'self-served';
8433
+ deliveryFormat: 'json' | 'ndjson' | 'protobuf' | 'syslog';
6269
8434
  secret: string;
6270
8435
  };
6271
8436
  type GetConfigurableLogDrainVariables = {
@@ -6317,7 +8482,6 @@ type GetAllLogDrainsError = ErrorWrapper<undefined>;
6317
8482
  type GetAllLogDrainsResponse = {
6318
8483
  clientId?: string;
6319
8484
  configurationId?: string;
6320
- deliveryFormat: 'json' | 'ndjson' | 'syslog';
6321
8485
  sources?: ('build' | 'edge' | 'external' | 'firewall' | 'lambda' | 'static')[];
6322
8486
  environments: ('preview' | 'production')[];
6323
8487
  status?: 'disabled' | 'enabled' | 'errored';
@@ -6340,6 +8504,7 @@ type GetAllLogDrainsResponse = {
6340
8504
  teamId?: string | null;
6341
8505
  ownerId: string;
6342
8506
  createdFrom?: 'integration' | 'self-served';
8507
+ deliveryFormat: 'json' | 'ndjson' | 'protobuf' | 'syslog';
6343
8508
  secret: string;
6344
8509
  }[];
6345
8510
  type GetAllLogDrainsVariables = {
@@ -6367,7 +8532,6 @@ type CreateConfigurableLogDrainResponse = {
6367
8532
  secret?: string;
6368
8533
  clientId?: string;
6369
8534
  configurationId?: string;
6370
- deliveryFormat: 'json' | 'ndjson' | 'syslog';
6371
8535
  sources?: ('build' | 'edge' | 'external' | 'firewall' | 'lambda' | 'static')[];
6372
8536
  environments: ('preview' | 'production')[];
6373
8537
  status?: 'disabled' | 'enabled' | 'errored';
@@ -6390,6 +8554,7 @@ type CreateConfigurableLogDrainResponse = {
6390
8554
  teamId?: string | null;
6391
8555
  ownerId: string;
6392
8556
  createdFrom?: 'integration' | 'self-served';
8557
+ deliveryFormat: 'json' | 'ndjson' | 'protobuf' | 'syslog';
6393
8558
  };
6394
8559
  type CreateConfigurableLogDrainRequestBody = {
6395
8560
  /**
@@ -7489,12 +9654,16 @@ type SubmitInvoiceRequestBody = {
7489
9654
  name: string;
7490
9655
  details?: string;
7491
9656
  /**
9657
+ * Currency amount as a decimal string.
9658
+ *
7492
9659
  * @pattern ^[0-9]+(\\.[0-9]+)?$
7493
9660
  */
7494
9661
  price: string;
7495
9662
  quantity: number;
7496
9663
  units: string;
7497
9664
  /**
9665
+ * Currency amount as a decimal string.
9666
+ *
7498
9667
  * @pattern ^[0-9]+(\\.[0-9]+)?$
7499
9668
  */
7500
9669
  total: string;
@@ -7523,6 +9692,8 @@ type SubmitInvoiceRequestBody = {
7523
9692
  name: string;
7524
9693
  details?: string;
7525
9694
  /**
9695
+ * Currency amount as a decimal string.
9696
+ *
7526
9697
  * @pattern ^[0-9]+(\\.[0-9]+)?$
7527
9698
  */
7528
9699
  amount: string;
@@ -7549,43 +9720,139 @@ type GetInvoicePathParams = {
7549
9720
  };
7550
9721
  type GetInvoiceError = ErrorWrapper<undefined>;
7551
9722
  type GetInvoiceResponse = {
9723
+ /**
9724
+ * Whether the invoice is in the testmode (no real transaction created).
9725
+ */
9726
+ test?: boolean;
9727
+ /**
9728
+ * Vercel Marketplace Invoice ID.
9729
+ */
7552
9730
  invoiceId: string;
9731
+ /**
9732
+ * Partner-supplied Invoice ID, if applicable.
9733
+ */
7553
9734
  externalId?: string;
9735
+ /**
9736
+ * Invoice state.
9737
+ */
9738
+ state: 'invoiced' | 'notpaid' | 'paid' | 'pending' | 'refund_requested' | 'refunded' | 'scheduled';
9739
+ /**
9740
+ * User-readable invoice number.
9741
+ */
7554
9742
  invoiceNumber?: string;
9743
+ /**
9744
+ * Invoice date. ISO 8601 timestamp.
9745
+ */
7555
9746
  invoiceDate: string;
9747
+ /**
9748
+ * Subscription period for this billing cycle. ISO 8601 timestamps.
9749
+ */
7556
9750
  period: {
7557
9751
  start: string;
7558
9752
  end: string;
7559
9753
  };
9754
+ /**
9755
+ * Additional memo for the invoice.
9756
+ */
7560
9757
  memo?: string;
9758
+ /**
9759
+ * Invoice items.
9760
+ */
7561
9761
  items: {
9762
+ /**
9763
+ * Partner's billing plan ID.
9764
+ */
7562
9765
  billingPlanId: string;
9766
+ /**
9767
+ * Partner's resource ID. If not specified, indicates installation-wide item.
9768
+ */
7563
9769
  resourceId?: string;
9770
+ /**
9771
+ * Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
9772
+ */
7564
9773
  start?: string;
9774
+ /**
9775
+ * Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
9776
+ */
7565
9777
  end?: string;
9778
+ /**
9779
+ * Invoice item name.
9780
+ */
7566
9781
  name: string;
9782
+ /**
9783
+ * Additional item details.
9784
+ */
7567
9785
  details?: string;
9786
+ /**
9787
+ * Item price. A dollar-based decimal string.
9788
+ */
7568
9789
  price: string;
9790
+ /**
9791
+ * Item quantity.
9792
+ */
7569
9793
  quantity: number;
9794
+ /**
9795
+ * Units for item's quantity.
9796
+ */
7570
9797
  units: string;
9798
+ /**
9799
+ * Item total. A dollar-based decimal string.
9800
+ */
7571
9801
  total: string;
7572
9802
  }[];
9803
+ /**
9804
+ * Invoice discounts.
9805
+ */
7573
9806
  discounts?: {
9807
+ /**
9808
+ * Partner's billing plan ID.
9809
+ */
7574
9810
  billingPlanId: string;
9811
+ /**
9812
+ * Partner's resource ID. If not specified, indicates installation-wide discount.
9813
+ */
7575
9814
  resourceId?: string;
9815
+ /**
9816
+ * Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
9817
+ */
7576
9818
  start?: string;
9819
+ /**
9820
+ * Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
9821
+ */
7577
9822
  end?: string;
9823
+ /**
9824
+ * Discount name.
9825
+ */
7578
9826
  name: string;
9827
+ /**
9828
+ * Additional discount details.
9829
+ */
7579
9830
  details?: string;
9831
+ /**
9832
+ * Discount amount. A dollar-based decimal string.
9833
+ */
7580
9834
  amount: string;
7581
9835
  }[];
9836
+ /**
9837
+ * Invoice total amount. A dollar-based decimal string.
9838
+ */
7582
9839
  total: string;
7583
- created: string;
7584
- updated: string;
7585
- state: 'invoiced' | 'notpaid' | 'paid' | 'pending' | 'refund_requested' | 'refunded' | 'scheduled';
9840
+ /**
9841
+ * The reason for refund. Only applicable for states "refunded" or "refund_request".
9842
+ */
7586
9843
  refundReason?: string;
9844
+ /**
9845
+ * Refund amount. Only applicable for states "refunded" or "refund_request". A dollar-based decimal string.
9846
+ */
7587
9847
  refundTotal?: string;
7588
- test: boolean;
9848
+ /**
9849
+ * System creation date. ISO 8601 timestamp.
9850
+ */
9851
+ created: string;
9852
+ /**
9853
+ * System update date. ISO 8601 timestamp.
9854
+ */
9855
+ updated: string;
7589
9856
  };
7590
9857
  type GetInvoiceVariables = {
7591
9858
  pathParams: GetInvoicePathParams;
@@ -8309,7 +10576,7 @@ type GetIntegrationLogDrainsResponse = {
8309
10576
  *
8310
10577
  * @example json
8311
10578
  */
8312
- deliveryFormat?: 'json' | 'ndjson' | 'syslog';
10579
+ deliveryFormat?: 'json' | 'ndjson' | 'protobuf' | 'syslog';
8313
10580
  /**
8314
10581
  * The name of the log drain
8315
10582
  *
@@ -8426,7 +10693,7 @@ type CreateLogDrainResponse = {
8426
10693
  *
8427
10694
  * @example json
8428
10695
  */
8429
- deliveryFormat?: 'json' | 'ndjson' | 'syslog';
10696
+ deliveryFormat?: 'json' | 'ndjson' | 'protobuf' | 'syslog';
8430
10697
  /**
8431
10698
  * The name of the log drain
8432
10699
  *
@@ -9388,7 +11655,7 @@ type GetProjectsResponse = {
9388
11655
  private: boolean;
9389
11656
  readyAt?: number;
9390
11657
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
9391
- readySubstate?: 'PROMOTED' | 'STAGED';
11658
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
9392
11659
  requestedAt?: number;
9393
11660
  target?: string | null;
9394
11661
  teamId?: string | null;
@@ -9619,7 +11886,7 @@ type GetProjectsResponse = {
9619
11886
  private: boolean;
9620
11887
  readyAt?: number;
9621
11888
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
9622
- readySubstate?: 'PROMOTED' | 'STAGED';
11889
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
9623
11890
  requestedAt?: number;
9624
11891
  target?: string | null;
9625
11892
  teamId?: string | null;
@@ -10224,7 +12491,7 @@ type CreateProjectResponse = {
10224
12491
  private: boolean;
10225
12492
  readyAt?: number;
10226
12493
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
10227
- readySubstate?: 'PROMOTED' | 'STAGED';
12494
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
10228
12495
  requestedAt?: number;
10229
12496
  target?: string | null;
10230
12497
  teamId?: string | null;
@@ -10455,7 +12722,7 @@ type CreateProjectResponse = {
10455
12722
  private: boolean;
10456
12723
  readyAt?: number;
10457
12724
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
10458
- readySubstate?: 'PROMOTED' | 'STAGED';
12725
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
10459
12726
  requestedAt?: number;
10460
12727
  target?: string | null;
10461
12728
  teamId?: string | null;
@@ -10878,7 +13145,6 @@ type CreateProjectRequestBody = {
10878
13145
  *
10879
13146
  * @example a-project-name
10880
13147
  * @maxLength 100
10881
- * @pattern ^(?!.*---)[a-z0-9-_.]+$
10882
13148
  */
10883
13149
  name: string;
10884
13150
  /**
@@ -11192,7 +13458,7 @@ type GetProjectResponse = {
11192
13458
  private: boolean;
11193
13459
  readyAt?: number;
11194
13460
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
11195
- readySubstate?: 'PROMOTED' | 'STAGED';
13461
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
11196
13462
  requestedAt?: number;
11197
13463
  target?: string | null;
11198
13464
  teamId?: string | null;
@@ -11423,7 +13689,7 @@ type GetProjectResponse = {
11423
13689
  private: boolean;
11424
13690
  readyAt?: number;
11425
13691
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
11426
- readySubstate?: 'PROMOTED' | 'STAGED';
13692
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
11427
13693
  requestedAt?: number;
11428
13694
  target?: string | null;
11429
13695
  teamId?: string | null;
@@ -12035,7 +14301,7 @@ type UpdateProjectResponse = {
12035
14301
  private: boolean;
12036
14302
  readyAt?: number;
12037
14303
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
12038
- readySubstate?: 'PROMOTED' | 'STAGED';
14304
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
12039
14305
  requestedAt?: number;
12040
14306
  target?: string | null;
12041
14307
  teamId?: string | null;
@@ -12266,7 +14532,7 @@ type UpdateProjectResponse = {
12266
14532
  private: boolean;
12267
14533
  readyAt?: number;
12268
14534
  readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
12269
- readySubstate?: 'PROMOTED' | 'STAGED';
14535
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
12270
14536
  requestedAt?: number;
12271
14537
  target?: string | null;
12272
14538
  teamId?: string | null;
@@ -12665,7 +14931,6 @@ type UpdateProjectRequestBody = {
12665
14931
  *
12666
14932
  * @example a-project-name
12667
14933
  * @maxLength 100
12668
- * @pattern ^(?!.*---)[a-z0-9-_.]+$
12669
14934
  */
12670
14935
  name?: string;
12671
14936
  nodeVersion?: '10.x' | '12.x' | '14.x' | '16.x' | '18.x' | '20.x' | '22.x';
@@ -14297,7 +16562,6 @@ declare const getProjectEnv: (variables: GetProjectEnvVariables, signal?: AbortS
14297
16562
  } | null;
14298
16563
  comment?: string;
14299
16564
  customEnvironmentIds?: string[];
14300
- vsmValue?: string;
14301
16565
  } | {
14302
16566
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
14303
16567
  type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
@@ -14975,7 +17239,6 @@ type AcceptProjectTransferRequestRequestBody = {
14975
17239
  *
14976
17240
  * @example a-project-name
14977
17241
  * @maxLength 100
14978
- * @pattern ^(?!.*---)[a-z0-9-_.]+$
14979
17242
  */
14980
17243
  newProjectName?: string;
14981
17244
  paidFeatures?: {
@@ -15944,6 +18207,7 @@ declare const addBypassIp: (variables: AddBypassIpVariables, signal?: AbortSigna
15944
18207
  Domain: string;
15945
18208
  Ip?: string;
15946
18209
  ProjectId: string;
18210
+ Note: string;
15947
18211
  IsProjectRule: boolean;
15948
18212
  }[];
15949
18213
  pagination: void | null;
@@ -16288,13 +18552,13 @@ declare const inviteUserToTeam: (variables: InviteUserToTeamVariables, signal?:
16288
18552
  *
16289
18553
  * @example CreateProject
16290
18554
  */
16291
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
18555
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
16292
18556
  } | {
16293
18557
  uid: string;
16294
18558
  username: string;
16295
18559
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
16296
18560
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
16297
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
18561
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
16298
18562
  }>;
16299
18563
  type RequestAccessToTeamError = ErrorWrapper<undefined>;
16300
18564
  type RequestAccessToTeamResponse = {
@@ -18363,9 +20627,9 @@ type GetDeploymentsResponse = {
18363
20627
  */
18364
20628
  ready?: number;
18365
20629
  /**
18366
- * Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
20630
+ * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of gradually transitioning production traffic - PROMOTED: has seen production traffic
18367
20631
  */
18368
- readySubstate?: 'PROMOTED' | 'STAGED';
20632
+ readySubstate?: 'PROMOTED' | 'ROLLING' | 'STAGED';
18369
20633
  /**
18370
20634
  * State of all registered checks
18371
20635
  */
@@ -19335,7 +21599,6 @@ declare const operationsByTag: {
19335
21599
  } | null;
19336
21600
  comment?: string;
19337
21601
  customEnvironmentIds?: string[];
19338
- vsmValue?: string;
19339
21602
  } | {
19340
21603
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
19341
21604
  type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
@@ -19867,7 +22130,13 @@ declare const operationsByTag: {
19867
22130
  env: string[];
19868
22131
  };
19869
22132
  buildArtifactUrls?: string[];
19870
- builds?: Record<string, any>[];
22133
+ builds?: {
22134
+ use: string;
22135
+ src?: string;
22136
+ config?: {
22137
+ [key: string]: any;
22138
+ };
22139
+ }[];
19871
22140
  env: string[];
19872
22141
  inspectorUrl: string | null;
19873
22142
  isInConcurrentBuildsQueue: boolean;
@@ -20090,9 +22359,9 @@ declare const operationsByTag: {
20090
22359
  framework?: string | null;
20091
22360
  };
20092
22361
  /**
20093
- * Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
22362
+ * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
20094
22363
  */
20095
- readySubstate?: "STAGED" | "PROMOTED";
22364
+ readySubstate?: "STAGED" | "ROLLING" | "PROMOTED";
20096
22365
  regions: string[];
20097
22366
  softDeletedByRetention?: boolean;
20098
22367
  source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
@@ -20440,9 +22709,9 @@ declare const operationsByTag: {
20440
22709
  framework?: string | null;
20441
22710
  };
20442
22711
  /**
20443
- * Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
22712
+ * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
20444
22713
  */
20445
- readySubstate?: "STAGED" | "PROMOTED";
22714
+ readySubstate?: "STAGED" | "ROLLING" | "PROMOTED";
20446
22715
  regions: string[];
20447
22716
  softDeletedByRetention?: boolean;
20448
22717
  source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
@@ -21278,6 +23547,7 @@ declare const operationsByTag: {
21278
23547
  Domain: string;
21279
23548
  Ip?: string;
21280
23549
  ProjectId: string;
23550
+ Note: string;
21281
23551
  IsProjectRule: boolean;
21282
23552
  }[];
21283
23553
  pagination: void | null;
@@ -21340,13 +23610,13 @@ declare const operationsByTag: {
21340
23610
  *
21341
23611
  * @example CreateProject
21342
23612
  */
21343
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
23613
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
21344
23614
  } | {
21345
23615
  uid: string;
21346
23616
  username: string;
21347
23617
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
21348
23618
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
21349
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
23619
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
21350
23620
  }>;
21351
23621
  requestAccessToTeam: (variables: RequestAccessToTeamVariables, signal?: AbortSignal) => Promise<RequestAccessToTeamResponse>;
21352
23622
  getTeamAccessRequest: (variables: GetTeamAccessRequestVariables, signal?: AbortSignal) => Promise<GetTeamAccessRequestResponse>;
@@ -22482,7 +24752,13 @@ declare const operationsByPath: {
22482
24752
  env: string[];
22483
24753
  };
22484
24754
  buildArtifactUrls?: string[];
22485
- builds?: Record<string, any>[];
24755
+ builds?: {
24756
+ use: string;
24757
+ src?: string;
24758
+ config?: {
24759
+ [key: string]: any;
24760
+ };
24761
+ }[];
22486
24762
  env: string[];
22487
24763
  inspectorUrl: string | null;
22488
24764
  isInConcurrentBuildsQueue: boolean;
@@ -22674,7 +24950,7 @@ declare const operationsByPath: {
22674
24950
  name: string;
22675
24951
  framework?: string | null;
22676
24952
  };
22677
- readySubstate?: "STAGED" | "PROMOTED";
24953
+ readySubstate?: "STAGED" | "ROLLING" | "PROMOTED";
22678
24954
  regions: string[];
22679
24955
  softDeletedByRetention?: boolean;
22680
24956
  source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
@@ -22967,7 +25243,7 @@ declare const operationsByPath: {
22967
25243
  name: string;
22968
25244
  framework?: string | null;
22969
25245
  };
22970
- readySubstate?: "STAGED" | "PROMOTED";
25246
+ readySubstate?: "STAGED" | "ROLLING" | "PROMOTED";
22971
25247
  regions: string[];
22972
25248
  softDeletedByRetention?: boolean;
22973
25249
  source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
@@ -23593,7 +25869,6 @@ declare const operationsByPath: {
23593
25869
  } | null;
23594
25870
  comment?: string;
23595
25871
  customEnvironmentIds?: string[];
23596
- vsmValue?: string;
23597
25872
  } | {
23598
25873
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
23599
25874
  type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
@@ -24123,6 +26398,7 @@ declare const operationsByPath: {
24123
26398
  Domain: string;
24124
26399
  Ip?: string;
24125
26400
  ProjectId: string;
26401
+ Note: string;
24126
26402
  IsProjectRule: boolean;
24127
26403
  }[];
24128
26404
  pagination: void | null;
@@ -24153,13 +26429,13 @@ declare const operationsByPath: {
24153
26429
  email?: string;
24154
26430
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
24155
26431
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
24156
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
26432
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
24157
26433
  } | {
24158
26434
  uid: string;
24159
26435
  username: string;
24160
26436
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
24161
26437
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
24162
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
26438
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
24163
26439
  }>;
24164
26440
  'POST /v1/teams/{teamId}/request': (variables: RequestAccessToTeamVariables, signal?: AbortSignal) => Promise<RequestAccessToTeamResponse>;
24165
26441
  'GET /v1/teams/{teamId}/request/{userId}': (variables: GetTeamAccessRequestVariables, signal?: AbortSignal) => Promise<GetTeamAccessRequestResponse>;
@@ -24303,7 +26579,13 @@ declare class VercelApi {
24303
26579
  env: string[];
24304
26580
  };
24305
26581
  buildArtifactUrls?: string[];
24306
- builds?: Record<string, any>[];
26582
+ builds?: {
26583
+ use: string;
26584
+ src?: string;
26585
+ config?: {
26586
+ [key: string]: any;
26587
+ };
26588
+ }[];
24307
26589
  env: string[];
24308
26590
  inspectorUrl: string | null;
24309
26591
  isInConcurrentBuildsQueue: boolean;
@@ -24495,7 +26777,7 @@ declare class VercelApi {
24495
26777
  name: string;
24496
26778
  framework?: string | null;
24497
26779
  };
24498
- readySubstate?: "STAGED" | "PROMOTED";
26780
+ readySubstate?: "STAGED" | "ROLLING" | "PROMOTED";
24499
26781
  regions: string[];
24500
26782
  softDeletedByRetention?: boolean;
24501
26783
  source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
@@ -24788,7 +27070,7 @@ declare class VercelApi {
24788
27070
  name: string;
24789
27071
  framework?: string | null;
24790
27072
  };
24791
- readySubstate?: "STAGED" | "PROMOTED";
27073
+ readySubstate?: "STAGED" | "ROLLING" | "PROMOTED";
24792
27074
  regions: string[];
24793
27075
  softDeletedByRetention?: boolean;
24794
27076
  source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
@@ -25414,7 +27696,6 @@ declare class VercelApi {
25414
27696
  } | null;
25415
27697
  comment?: string;
25416
27698
  customEnvironmentIds?: string[];
25417
- vsmValue?: string;
25418
27699
  } | {
25419
27700
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
25420
27701
  type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
@@ -25944,6 +28225,7 @@ declare class VercelApi {
25944
28225
  Domain: string;
25945
28226
  Ip?: string;
25946
28227
  ProjectId: string;
28228
+ Note: string;
25947
28229
  IsProjectRule: boolean;
25948
28230
  }[];
25949
28231
  pagination: void | null;
@@ -25974,13 +28256,13 @@ declare class VercelApi {
25974
28256
  email?: string;
25975
28257
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
25976
28258
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
25977
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
28259
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
25978
28260
  } | {
25979
28261
  uid: string;
25980
28262
  username: string;
25981
28263
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
25982
28264
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
25983
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
28265
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
25984
28266
  }>;
25985
28267
  'POST /v1/teams/{teamId}/request': (variables: RequestAccessToTeamVariables, signal?: AbortSignal) => Promise<RequestAccessToTeamResponse>;
25986
28268
  'GET /v1/teams/{teamId}/request/{userId}': (variables: GetTeamAccessRequestVariables, signal?: AbortSignal) => Promise<GetTeamAccessRequestResponse>;