vercel-api-js 0.22.1 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -63,7 +63,2126 @@ 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
+ customerId?: string | null;
879
+ orbCustomerId?: string | null;
880
+ dataCache?: {
881
+ excessBillingEnabled?: boolean;
882
+ };
883
+ deletedAt?: number | null;
884
+ deploymentSecret: string;
885
+ dismissedTeams?: string[];
886
+ dismissedToasts?: {
887
+ name: string;
888
+ dismissals: {
889
+ scopeId: string;
890
+ createdAt: number;
891
+ }[];
892
+ }[];
893
+ favoriteProjectsAndSpaces?: ({
894
+ projectId: string;
895
+ scopeSlug: string;
896
+ scopeId: string;
897
+ teamId?: string;
898
+ } | {
899
+ spaceId: string;
900
+ scopeSlug: string;
901
+ scopeId: string;
902
+ teamId?: string;
903
+ })[];
904
+ email: string;
905
+ id: string;
906
+ importFlowGitNamespace?: string | number | null;
907
+ importFlowGitNamespaceId?: string | number | null;
908
+ importFlowGitProvider?: 'github' | 'gitlab' | 'bitbucket' | null;
909
+ preferredScopesAndGitNamespaces?: {
910
+ scopeId: string;
911
+ gitNamespaceId: string | number | null;
912
+ }[];
913
+ isDomainReseller?: boolean;
914
+ isZeitPub?: boolean;
915
+ maxActiveSlots?: number;
916
+ name?: string;
917
+ phoneNumber?: string;
918
+ platformVersion: number | null;
919
+ preventAutoBlocking?: number | boolean;
920
+ /**
921
+ * Overrides our DEFAULT project domains limit per account or per project.
922
+ */
923
+ projectDomainsLimit?: number;
924
+ /**
925
+ * Represents configuration for remote caching
926
+ */
927
+ remoteCaching?: {
928
+ enabled?: boolean;
929
+ };
930
+ removedAliasesAt?: number;
931
+ removedBillingSubscriptionAt?: number;
932
+ removedConfigurationsAt?: number;
933
+ removedDeploymentsAt?: number;
934
+ removedDomiansAt?: number;
935
+ removedEventsAt?: number;
936
+ removedProjectsAt?: number;
937
+ removedSecretsAt?: number;
938
+ removedSharedEnvVarsAt?: number;
939
+ removedEdgeConfigsAt?: number;
940
+ resourceConfig?: {
941
+ nodeType?: string;
942
+ concurrentBuilds?: number;
943
+ buildEntitlements?: {
944
+ enhancedBuilds?: boolean;
945
+ };
946
+ awsAccountType?: string;
947
+ awsAccountIds?: string[];
948
+ cfZoneName?: string;
949
+ imageOptimizationType?: string;
950
+ edgeConfigs?: number;
951
+ edgeConfigSize?: number;
952
+ edgeFunctionMaxSizeBytes?: number;
953
+ edgeFunctionExecutionTimeoutMs?: number;
954
+ serverlessFunctionDefaultMaxExecutionTime?: number;
955
+ serverlessFunctionMaxMemorySize?: number;
956
+ kvDatabases?: number;
957
+ postgresDatabases?: number;
958
+ blobStores?: number;
959
+ integrationStores?: number;
960
+ cronJobs?: number;
961
+ cronJobsPerProject?: number;
962
+ microfrontendGroupsPerTeam?: number;
963
+ microfrontendProjectsPerGroup?: number;
964
+ };
965
+ /**
966
+ * User | Team resource limits
967
+ */
968
+ resourceLimits?: {
969
+ [key: string]: {
970
+ max: number;
971
+ duration: number;
972
+ };
973
+ };
974
+ activeDashboardViews?: {
975
+ scopeId: string;
976
+ viewPreference?: 'cards' | 'list' | null;
977
+ favoritesViewPreference?: 'open' | 'closed' | null;
978
+ recentsViewPreference?: 'open' | 'closed' | null;
979
+ }[];
980
+ secondaryEmails?: {
981
+ email: string;
982
+ verified: boolean;
983
+ }[];
984
+ emailNotifications?: {
985
+ rules?: {
986
+ [key: string]: {
987
+ email: string;
988
+ };
989
+ };
990
+ };
991
+ siftScore?: number;
992
+ siftScores?: {
993
+ [key: string]: {
994
+ score: number;
995
+ reasons: {
996
+ name: string;
997
+ value: string;
998
+ }[];
999
+ };
1000
+ };
1001
+ siftRoute?: {
1002
+ name: 'string';
1003
+ };
1004
+ sfdcId?: string;
1005
+ softBlock?: {
1006
+ blockedAt: number;
1007
+ reason: 'SUBSCRIPTION_CANCELED' | 'SUBSCRIPTION_EXPIRED' | 'UNPAID_INVOICE' | 'ENTERPRISE_TRIAL_ENDED' | 'FAIR_USE_LIMITS_EXCEEDED' | 'BLOCKED_FOR_PLATFORM_ABUSE';
1008
+ 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';
1009
+ } | null;
1010
+ stagingPrefix: string;
1011
+ sysToken: string;
1012
+ /**
1013
+ * 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.
1014
+ */
1015
+ teams?: {
1016
+ created?: number;
1017
+ createdAt?: number;
1018
+ teamId: string;
1019
+ role?: 'OWNER' | 'MEMBER' | 'DEVELOPER' | 'SECURITY' | 'BILLING' | 'VIEWER' | 'CONTRIBUTOR';
1020
+ confirmed?: boolean;
1021
+ confirmedAt?: number;
1022
+ accessRequestedAt?: number;
1023
+ teamRoles?: ('OWNER' | 'MEMBER' | 'DEVELOPER' | 'SECURITY' | 'BILLING' | 'VIEWER' | 'CONTRIBUTOR')[];
1024
+ teamPermissions?: ('CreateProject' | 'FullProductionDeployment' | 'UsageViewer' | 'EnvVariableManager' | 'EnvironmentManager')[];
1025
+ joinedFrom?: {
1026
+ origin: 'teams' | 'saml' | 'link' | 'github' | 'gitlab' | 'bitbucket' | 'mail' | 'import' | 'dsync' | 'feedback' | 'organization-teams';
1027
+ commitId?: string;
1028
+ repoId?: string;
1029
+ repoPath?: string;
1030
+ gitUserId?: string | number;
1031
+ gitUserLogin?: string;
1032
+ ssoUserId?: string;
1033
+ ssoConnectedAt?: number;
1034
+ idpUserId?: string;
1035
+ dsyncUserId?: string;
1036
+ dsyncConnectedAt?: number;
1037
+ };
1038
+ }[];
1039
+ /**
1040
+ * 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.
1041
+ */
1042
+ trialTeamIds?: string[];
1043
+ /**
1044
+ * 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.
1045
+ */
1046
+ maxTrials?: number;
1047
+ /**
1048
+ * Deprecated on 2022-04-12 in favor of trialTeamIds and using utils/api-teams/user-has-trial-available.ts.
1049
+ */
1050
+ trialTeamId?: string;
1051
+ type: 'user';
1052
+ /**
1053
+ * Contains the timestamps when a user was notified about their usage
1054
+ */
1055
+ usageAlerts?: {
1056
+ warningAt?: number | null;
1057
+ blockingAt?: number | null;
1058
+ } | null;
1059
+ overageUsageAlerts?: {
1060
+ aiCredits?: {
1061
+ currentThreshold: number;
1062
+ warningAt?: number | null;
1063
+ blockedAt?: number | null;
1064
+ };
1065
+ analyticsUsage?: {
1066
+ currentThreshold: number;
1067
+ warningAt?: number | null;
1068
+ blockedAt?: number | null;
1069
+ };
1070
+ artifacts?: {
1071
+ currentThreshold: number;
1072
+ warningAt?: number | null;
1073
+ blockedAt?: number | null;
1074
+ };
1075
+ bandwidth?: {
1076
+ currentThreshold: number;
1077
+ warningAt?: number | null;
1078
+ blockedAt?: number | null;
1079
+ };
1080
+ blobTotalAdvancedRequests?: {
1081
+ currentThreshold: number;
1082
+ warningAt?: number | null;
1083
+ blockedAt?: number | null;
1084
+ };
1085
+ blobTotalAvgSizeInBytes?: {
1086
+ currentThreshold: number;
1087
+ warningAt?: number | null;
1088
+ blockedAt?: number | null;
1089
+ };
1090
+ blobTotalGetResponseObjectSizeInBytes?: {
1091
+ currentThreshold: number;
1092
+ warningAt?: number | null;
1093
+ blockedAt?: number | null;
1094
+ };
1095
+ blobTotalSimpleRequests?: {
1096
+ currentThreshold: number;
1097
+ warningAt?: number | null;
1098
+ blockedAt?: number | null;
1099
+ };
1100
+ dataCacheRead?: {
1101
+ currentThreshold: number;
1102
+ warningAt?: number | null;
1103
+ blockedAt?: number | null;
1104
+ };
1105
+ dataCacheWrite?: {
1106
+ currentThreshold: number;
1107
+ warningAt?: number | null;
1108
+ blockedAt?: number | null;
1109
+ };
1110
+ edgeConfigRead?: {
1111
+ currentThreshold: number;
1112
+ warningAt?: number | null;
1113
+ blockedAt?: number | null;
1114
+ };
1115
+ edgeConfigWrite?: {
1116
+ currentThreshold: number;
1117
+ warningAt?: number | null;
1118
+ blockedAt?: number | null;
1119
+ };
1120
+ edgeFunctionExecutionUnits?: {
1121
+ currentThreshold: number;
1122
+ warningAt?: number | null;
1123
+ blockedAt?: number | null;
1124
+ };
1125
+ edgeMiddlewareInvocations?: {
1126
+ currentThreshold: number;
1127
+ warningAt?: number | null;
1128
+ blockedAt?: number | null;
1129
+ };
1130
+ edgeRequestAdditionalCpuDuration?: {
1131
+ currentThreshold: number;
1132
+ warningAt?: number | null;
1133
+ blockedAt?: number | null;
1134
+ };
1135
+ edgeRequest?: {
1136
+ currentThreshold: number;
1137
+ warningAt?: number | null;
1138
+ blockedAt?: number | null;
1139
+ };
1140
+ elasticConcurrencyBuildSlots?: {
1141
+ currentThreshold: number;
1142
+ warningAt?: number | null;
1143
+ blockedAt?: number | null;
1144
+ };
1145
+ fastDataTransfer?: {
1146
+ currentThreshold: number;
1147
+ warningAt?: number | null;
1148
+ blockedAt?: number | null;
1149
+ };
1150
+ fastOriginTransfer?: {
1151
+ currentThreshold: number;
1152
+ warningAt?: number | null;
1153
+ blockedAt?: number | null;
1154
+ };
1155
+ functionDuration?: {
1156
+ currentThreshold: number;
1157
+ warningAt?: number | null;
1158
+ blockedAt?: number | null;
1159
+ };
1160
+ functionInvocation?: {
1161
+ currentThreshold: number;
1162
+ warningAt?: number | null;
1163
+ blockedAt?: number | null;
1164
+ };
1165
+ imageOptimizationCacheRead?: {
1166
+ currentThreshold: number;
1167
+ warningAt?: number | null;
1168
+ blockedAt?: number | null;
1169
+ };
1170
+ imageOptimizationCacheWrite?: {
1171
+ currentThreshold: number;
1172
+ warningAt?: number | null;
1173
+ blockedAt?: number | null;
1174
+ };
1175
+ imageOptimizationTransformation?: {
1176
+ currentThreshold: number;
1177
+ warningAt?: number | null;
1178
+ blockedAt?: number | null;
1179
+ };
1180
+ logDrainsVolume?: {
1181
+ currentThreshold: number;
1182
+ warningAt?: number | null;
1183
+ blockedAt?: number | null;
1184
+ };
1185
+ monitoringMetric?: {
1186
+ currentThreshold: number;
1187
+ warningAt?: number | null;
1188
+ blockedAt?: number | null;
1189
+ };
1190
+ blobDataTransfer?: {
1191
+ currentThreshold: number;
1192
+ warningAt?: number | null;
1193
+ blockedAt?: number | null;
1194
+ };
1195
+ observabilityEvent?: {
1196
+ currentThreshold: number;
1197
+ warningAt?: number | null;
1198
+ blockedAt?: number | null;
1199
+ };
1200
+ postgresComputeTime?: {
1201
+ currentThreshold: number;
1202
+ warningAt?: number | null;
1203
+ blockedAt?: number | null;
1204
+ };
1205
+ postgresDataStorage?: {
1206
+ currentThreshold: number;
1207
+ warningAt?: number | null;
1208
+ blockedAt?: number | null;
1209
+ };
1210
+ postgresDataTransfer?: {
1211
+ currentThreshold: number;
1212
+ warningAt?: number | null;
1213
+ blockedAt?: number | null;
1214
+ };
1215
+ postgresDatabase?: {
1216
+ currentThreshold: number;
1217
+ warningAt?: number | null;
1218
+ blockedAt?: number | null;
1219
+ };
1220
+ postgresWrittenData?: {
1221
+ currentThreshold: number;
1222
+ warningAt?: number | null;
1223
+ blockedAt?: number | null;
1224
+ };
1225
+ serverlessFunctionExecution?: {
1226
+ currentThreshold: number;
1227
+ warningAt?: number | null;
1228
+ blockedAt?: number | null;
1229
+ };
1230
+ sourceImages?: {
1231
+ currentThreshold: number;
1232
+ warningAt?: number | null;
1233
+ blockedAt?: number | null;
1234
+ };
1235
+ storageRedisTotalBandwidthInBytes?: {
1236
+ currentThreshold: number;
1237
+ warningAt?: number | null;
1238
+ blockedAt?: number | null;
1239
+ };
1240
+ storageRedisTotalCommands?: {
1241
+ currentThreshold: number;
1242
+ warningAt?: number | null;
1243
+ blockedAt?: number | null;
1244
+ };
1245
+ storageRedisTotalDailyAvgStorageInBytes?: {
1246
+ currentThreshold: number;
1247
+ warningAt?: number | null;
1248
+ blockedAt?: number | null;
1249
+ };
1250
+ storageRedisTotalDatabases?: {
1251
+ currentThreshold: number;
1252
+ warningAt?: number | null;
1253
+ blockedAt?: number | null;
1254
+ };
1255
+ wafOwaspExcessBytes?: {
1256
+ currentThreshold: number;
1257
+ warningAt?: number | null;
1258
+ blockedAt?: number | null;
1259
+ };
1260
+ wafOwaspRequests?: {
1261
+ currentThreshold: number;
1262
+ warningAt?: number | null;
1263
+ blockedAt?: number | null;
1264
+ };
1265
+ wafRateLimitRequest?: {
1266
+ currentThreshold: number;
1267
+ warningAt?: number | null;
1268
+ blockedAt?: number | null;
1269
+ };
1270
+ webAnalyticsEvent?: {
1271
+ currentThreshold: number;
1272
+ warningAt?: number | null;
1273
+ blockedAt?: number | null;
1274
+ };
1275
+ };
1276
+ username: string;
1277
+ updatedAt: number;
1278
+ /**
1279
+ * Whether the Vercel Toolbar is enabled for preview deployments.
1280
+ */
1281
+ enablePreviewFeedback?: 'default' | 'on' | 'off' | 'on-force' | 'off-force' | 'default-force';
1282
+ /**
1283
+ * 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).
1284
+ */
1285
+ featureBlocks?: {
1286
+ webAnalytics?: {
1287
+ updatedAt?: number;
1288
+ blockedFrom?: number;
1289
+ blockedUntil?: number;
1290
+ blockReason?: 'admin_override' | 'limits_exceeded';
1291
+ graceEmailSentAt?: number;
1292
+ };
1293
+ /**
1294
+ * 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)
1295
+ */
1296
+ monitoring?: {
1297
+ updatedAt?: number;
1298
+ blockedFrom?: number;
1299
+ blockedUntil?: number;
1300
+ blockReason?: 'admin_override' | 'limits_exceeded';
1301
+ blockType: 'soft' | 'hard';
1302
+ };
1303
+ observabilityPlus?: {
1304
+ updatedAt?: number;
1305
+ blockedFrom?: number;
1306
+ blockedUntil?: number;
1307
+ blockReason?: 'admin_override' | 'limits_exceeded';
1308
+ blockType: 'soft' | 'hard';
1309
+ };
1310
+ dataCache?: {
1311
+ updatedAt: number;
1312
+ blockedFrom?: number;
1313
+ blockedUntil?: number;
1314
+ blockReason: 'admin_override' | 'limits_exceeded';
1315
+ };
1316
+ imageOptimizationTransformation?: {
1317
+ updatedAt: number;
1318
+ blockedFrom?: number;
1319
+ blockedUntil?: number;
1320
+ blockReason: 'admin_override' | 'limits_exceeded';
1321
+ };
1322
+ sourceImages?: {
1323
+ updatedAt: number;
1324
+ blockedFrom?: number;
1325
+ blockedUntil?: number;
1326
+ blockReason: 'admin_override' | 'limits_exceeded';
1327
+ };
1328
+ blob?: {
1329
+ updatedAt?: number;
1330
+ blockedFrom?: number;
1331
+ blockedUntil?: number;
1332
+ blockReason?: 'admin_override' | 'limits_exceeded';
1333
+ 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';
1334
+ };
1335
+ postgres?: {
1336
+ updatedAt?: number;
1337
+ blockedFrom?: number;
1338
+ blockedUntil?: number;
1339
+ blockReason?: 'admin_override' | 'limits_exceeded';
1340
+ 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';
1341
+ };
1342
+ redis?: {
1343
+ updatedAt?: number;
1344
+ blockedFrom?: number;
1345
+ blockedUntil?: number;
1346
+ blockReason?: 'admin_override' | 'limits_exceeded';
1347
+ 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';
1348
+ };
1349
+ };
1350
+ defaultTeamId?: string;
1351
+ version: 'northstar';
1352
+ /**
1353
+ * An archive of information about the Northstar migration, derived from the old (deprecated) property, `northstarMigrationEvents`.
1354
+ */
1355
+ northstarMigration?: {
1356
+ /**
1357
+ * The ID of the team we created for this user.
1358
+ */
1359
+ teamId: string;
1360
+ /**
1361
+ * The number of projects migrated for this user.
1362
+ */
1363
+ projects: number;
1364
+ /**
1365
+ * The number of stores migrated for this user.
1366
+ */
1367
+ stores: number;
1368
+ /**
1369
+ * The number of integration configurations migrated for this user.
1370
+ */
1371
+ integrationConfigurations: number;
1372
+ /**
1373
+ * The number of integration clients migrated for this user.
1374
+ */
1375
+ integrationClients: number;
1376
+ /**
1377
+ * The migration start time timestamp for this user.
1378
+ */
1379
+ startTime: number;
1380
+ /**
1381
+ * The migration end time timestamp for this user.
1382
+ */
1383
+ endTime: number;
1384
+ };
1385
+ /**
1386
+ * 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.
1387
+ */
1388
+ opportunityId?: string;
1389
+ /**
1390
+ * MFA configuration. When enabled, the user will be required to provide a second factor of authentication when logging in.
1391
+ */
1392
+ mfaConfiguration?: {
1393
+ enabled: boolean;
1394
+ enabledAt?: number;
1395
+ recoveryCodes: string[];
1396
+ totp?: {
1397
+ secret: string;
1398
+ createdAt: number;
1399
+ };
1400
+ };
1401
+ } | null;
1402
+ } | {
1403
+ configurations: {
1404
+ integrationId: string;
1405
+ configurationId: string;
1406
+ integrationSlug: string;
1407
+ integrationName?: string;
1408
+ }[];
1409
+ ownerId: string;
1410
+ } | {
1411
+ integrationId: string;
1412
+ configurationId: string;
1413
+ integrationSlug: string;
1414
+ integrationName: string;
1415
+ ownerId: string;
1416
+ billingPlanId: string;
1417
+ billingPlanName?: string;
1418
+ } | {
1419
+ integrationId: string;
1420
+ configurationId: string;
1421
+ integrationSlug: string;
1422
+ integrationName: string;
1423
+ ownerId: string;
1424
+ projectIds?: string[];
1425
+ } | {
1426
+ projectId: string;
1427
+ fromDeploymentId: string;
1428
+ toDeploymentId: string;
1429
+ projectName: string;
1430
+ reason?: string;
1431
+ } | {
1432
+ integrationId: string;
1433
+ configurationId: string;
1434
+ integrationSlug: string;
1435
+ integrationName: string;
1436
+ ownerId: string;
1437
+ projectIds?: string[];
1438
+ confirmedScopes: string[];
1439
+ } | {
1440
+ userAgent?: {
1441
+ browser: {
1442
+ name: 'iphone' | 'ipad' | 'ipod' | 'chrome' | 'firefox' | 'mozilla' | 'unknown';
1443
+ };
1444
+ ua: string;
1445
+ program: string;
1446
+ os: {
1447
+ name: 'unknown' | 'darwin' | 'win32' | 'win' | 'windows' | 'linux' | 'freebsd' | 'sunos' | 'mac' | 'ios' | 'android' | 'Mac OS' | 'OS X';
1448
+ };
1449
+ };
1450
+ geolocation?: {
1451
+ city?: {
1452
+ names: {
1453
+ en: string;
1454
+ };
1455
+ };
1456
+ country: {
1457
+ names: {
1458
+ en: string;
1459
+ };
1460
+ };
1461
+ most_specific_subdivision?: {
1462
+ names: {
1463
+ en: string;
1464
+ };
1465
+ };
1466
+ regionName?: string;
1467
+ } | null;
1468
+ viaGithub: boolean;
1469
+ viaGitlab: boolean;
1470
+ viaBitbucket: boolean;
1471
+ viaSamlSso: boolean;
1472
+ viaPasskey: boolean;
1473
+ ssoType?: string;
1474
+ env?: string;
1475
+ os?: string;
1476
+ username?: string;
1477
+ } | {
1478
+ logDrainUrl: string | null;
1479
+ integrationName?: string;
1480
+ } | {
1481
+ logDrainUrl: string;
1482
+ integrationName?: string;
1483
+ } | {
1484
+ drainUrl: string | null;
1485
+ integrationName?: string;
1486
+ } | {
1487
+ projectId: string;
1488
+ toDeploymentId: string;
1489
+ projectName: string;
1490
+ } | {
1491
+ plan: string;
1492
+ removedUsers?: {
1493
+ [key: string]: {
1494
+ role: 'OWNER' | 'MEMBER' | 'DEVELOPER' | 'SECURITY' | 'BILLING' | 'VIEWER' | 'CONTRIBUTOR';
1495
+ confirmed: boolean;
1496
+ confirmedAt?: number;
1497
+ joinedFrom?: {
1498
+ origin: 'teams' | 'saml' | 'link' | 'github' | 'gitlab' | 'bitbucket' | 'mail' | 'import' | 'dsync' | 'feedback' | 'organization-teams';
1499
+ commitId?: string;
1500
+ repoId?: string;
1501
+ repoPath?: string;
1502
+ gitUserId?: string | number;
1503
+ gitUserLogin?: string;
1504
+ ssoUserId?: string;
1505
+ ssoConnectedAt?: number;
1506
+ idpUserId?: string;
1507
+ dsyncUserId?: string;
1508
+ dsyncConnectedAt?: number;
1509
+ };
1510
+ };
1511
+ };
1512
+ priorPlan?: string;
1513
+ isDowngrade?: boolean;
1514
+ userAgent?: string;
1515
+ isReactivate?: boolean;
1516
+ isTrialUpgrade?: boolean;
1517
+ } | {
1518
+ projectName?: string;
1519
+ projectId: string;
1520
+ projectAnalytics: {
1521
+ id: string;
1522
+ canceledAt?: number | null;
1523
+ disabledAt: number;
1524
+ enabledAt: number;
1525
+ paidAt?: number;
1526
+ sampleRatePercent?: number | null;
1527
+ spendLimitInDollars?: number | null;
1528
+ } | null;
1529
+ prevProjectAnalytics: {
1530
+ id: string;
1531
+ canceledAt?: number | null;
1532
+ disabledAt: number;
1533
+ enabledAt: number;
1534
+ paidAt?: number;
1535
+ sampleRatePercent?: number | null;
1536
+ spendLimitInDollars?: number | null;
1537
+ } | null;
1538
+ } | {
1539
+ projectName?: string;
1540
+ projectId: string;
1541
+ projectAnalytics?: {
1542
+ [key: string]: any;
1543
+ };
1544
+ prevProjectAnalytics?: {
1545
+ [key: string]: any;
1546
+ } | null;
1547
+ } | {
1548
+ projectName?: string;
1549
+ projectId: string;
1550
+ } | {
1551
+ projectName: string;
1552
+ ssoProtection: {
1553
+ deploymentType: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews';
1554
+ } | ('all' | 'preview' | 'prod_deployment_urls_and_all_previews') | null;
1555
+ oldSsoProtection: {
1556
+ deploymentType: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews';
1557
+ } | ('all' | 'preview' | 'prod_deployment_urls_and_all_previews') | null;
1558
+ } | {
1559
+ projectName: string;
1560
+ passwordProtection: {
1561
+ deploymentType: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews';
1562
+ } | ('all' | 'preview' | 'prod_deployment_urls_and_all_previews') | null;
1563
+ oldPasswordProtection: {
1564
+ deploymentType: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews';
1565
+ } | ('all' | 'preview' | 'prod_deployment_urls_and_all_previews') | null;
1566
+ } | {
1567
+ projectName: string;
1568
+ trustedIps?: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews' | 'production' | null;
1569
+ oldTrustedIps?: 'all' | 'preview' | 'prod_deployment_urls_and_all_previews' | 'production' | null;
1570
+ addedAddresses?: string[] | null;
1571
+ removedAddresses?: string[] | null;
1572
+ } | {
1573
+ projectName: string;
1574
+ optionsAllowlist?: {
1575
+ paths: {
1576
+ value: string;
1577
+ }[];
1578
+ } | null;
1579
+ oldOptionsAllowlist?: {
1580
+ paths: {
1581
+ value: string;
1582
+ }[];
1583
+ } | null;
1584
+ } | {
1585
+ projectName: string;
1586
+ action: 'enabled' | 'disabled' | 'regenerated';
1587
+ } | {
1588
+ name: string;
1589
+ ownerId: string;
1590
+ } | {
1591
+ team: {
1592
+ id: string;
1593
+ name: string;
1594
+ };
1595
+ project: {
1596
+ id: string;
1597
+ name?: string;
1598
+ oldConnectConfigurations: Record<string, any>[] | null;
1599
+ newConnectConfigurations: Record<string, any>[] | null;
1600
+ };
1601
+ } | {
1602
+ projectId: string;
1603
+ } | {
1604
+ gitProvider: string;
1605
+ gitProviderGroupDescriptor: string;
1606
+ gitScope: string;
1607
+ } | {
1608
+ instances: number;
1609
+ url: string;
1610
+ } | {
1611
+ email: string;
1612
+ verified: boolean;
1613
+ } | {
1614
+ email: string;
1615
+ } | {
1616
+ team: {
1617
+ id: string;
1618
+ name?: string;
1619
+ };
1620
+ previousRule?: {
1621
+ email: string;
1622
+ };
1623
+ nextRule?: {
1624
+ email: string;
1625
+ };
1626
+ } | {
1627
+ team: {
1628
+ id: string;
1629
+ name?: string;
1630
+ };
1631
+ previousRule: {
1632
+ email: string;
1633
+ };
1634
+ } | {
1635
+ uid: string;
1636
+ name: string | {
1637
+ name: string;
1638
+ };
1639
+ } | {
1640
+ oldName: string;
1641
+ newName: string;
1642
+ uid?: string;
1643
+ } | {
1644
+ bio: string;
1645
+ } | {
1646
+ scalingRules: {
1647
+ [key: string]: {
1648
+ min: number;
1649
+ max: number;
1650
+ };
1651
+ };
1652
+ min: number;
1653
+ max: number;
1654
+ url: string;
1655
+ } | {
1656
+ webhookUrl?: string;
1657
+ } | {
1658
+ /**
1659
+ * Represents a budget for tracking and notifying teams on their spending.
1660
+ */
1661
+ budget: {
1662
+ /**
1663
+ * The budget type
1664
+ */
1665
+ type: 'fixed';
1666
+ /**
1667
+ * Budget amount
1668
+ */
1669
+ fixedBudget: number;
1670
+ /**
1671
+ * Array of the last 3 months of spend data
1672
+ */
1673
+ previousSpend: number[];
1674
+ /**
1675
+ * Array of 50, 75, 100 to keep track of notifications sent out
1676
+ */
1677
+ notifiedAt: number[];
1678
+ /**
1679
+ * Webhook id that corresponds to a webhook in Cosmos webhook collection
1680
+ */
1681
+ webhookId?: string;
1682
+ /**
1683
+ * Keep track if the webhook has been called for the month
1684
+ */
1685
+ webhookNotified?: boolean;
1686
+ /**
1687
+ * Date time when budget is created
1688
+ */
1689
+ createdAt: number;
1690
+ /**
1691
+ * Date time when budget is updated last
1692
+ */
1693
+ updatedAt?: number;
1694
+ /**
1695
+ * Is the budget currently active for a customer
1696
+ */
1697
+ isActive: boolean;
1698
+ /**
1699
+ * Should all projects be paused if budget is exceeded
1700
+ */
1701
+ pauseProjects?: boolean;
1702
+ /**
1703
+ * The acive pricing plan the team is billed with
1704
+ */
1705
+ pricingPlan?: 'legacy' | 'unbundled';
1706
+ /**
1707
+ * Partition key
1708
+ */
1709
+ teamId: string;
1710
+ /**
1711
+ * Sort key that needs to be unique per teamId
1712
+ */
1713
+ id: string;
1714
+ };
1715
+ } | {
1716
+ budget: {
1717
+ /**
1718
+ * Represents a budget for tracking and notifying teams on their spending.
1719
+ */
1720
+ budgetItem: {
1721
+ /**
1722
+ * The budget type
1723
+ */
1724
+ type: 'fixed';
1725
+ /**
1726
+ * Budget amount
1727
+ */
1728
+ fixedBudget: number;
1729
+ /**
1730
+ * Array of the last 3 months of spend data
1731
+ */
1732
+ previousSpend: number[];
1733
+ /**
1734
+ * Array of 50, 75, 100 to keep track of notifications sent out
1735
+ */
1736
+ notifiedAt: number[];
1737
+ /**
1738
+ * Webhook id that corresponds to a webhook in Cosmos webhook collection
1739
+ */
1740
+ webhookId?: string;
1741
+ /**
1742
+ * Keep track if the webhook has been called for the month
1743
+ */
1744
+ webhookNotified?: boolean;
1745
+ /**
1746
+ * Date time when budget is created
1747
+ */
1748
+ createdAt: number;
1749
+ /**
1750
+ * Date time when budget is updated last
1751
+ */
1752
+ updatedAt?: number;
1753
+ /**
1754
+ * Is the budget currently active for a customer
1755
+ */
1756
+ isActive: boolean;
1757
+ /**
1758
+ * Should all projects be paused if budget is exceeded
1759
+ */
1760
+ pauseProjects?: boolean;
1761
+ /**
1762
+ * The acive pricing plan the team is billed with
1763
+ */
1764
+ pricingPlan?: 'legacy' | 'unbundled';
1765
+ /**
1766
+ * Partition key
1767
+ */
1768
+ teamId: string;
1769
+ /**
1770
+ * Sort key that needs to be unique per teamId
1771
+ */
1772
+ id: string;
1773
+ };
1774
+ };
1775
+ } | {
1776
+ id: string;
1777
+ name?: string;
1778
+ computeUnitsMax?: number;
1779
+ computeUnitsMin?: number;
1780
+ suspendTimeoutSeconds?: number;
1781
+ type: 'integration' | 'edge-config' | 'redis' | 'postgres' | 'blob';
1782
+ } | {
1783
+ storeType: 'redis' | 'postgres';
1784
+ } | {
1785
+ store: {
1786
+ name: string;
1787
+ id: string;
1788
+ };
1789
+ ownerId?: string;
1790
+ } | {
1791
+ slug: string;
1792
+ } | {
1793
+ slug: string;
1794
+ teamId: string;
1795
+ by: string;
1796
+ reasons?: {
1797
+ slug: string;
1798
+ description: string;
1799
+ }[];
1800
+ } | {
1801
+ directoryType?: string;
1802
+ ssoType?: string;
1803
+ invitedUser?: {
1804
+ username: string;
1805
+ email: string;
1806
+ };
1807
+ invitedEmail?: string;
1808
+ invitationRole?: string;
1809
+ entitlements?: string[];
1810
+ invitedUid?: string;
1811
+ } | {
1812
+ deletedUser?: {
1813
+ username: string;
1814
+ email: string;
1815
+ };
1816
+ deletedUid?: string;
1817
+ githubUsername?: string | null;
1818
+ gitlabUsername?: string | null;
1819
+ bitbucketUsername?: string | null;
1820
+ directoryType?: string;
1821
+ } | {
1822
+ role?: string;
1823
+ uid: string;
1824
+ origin?: string;
1825
+ } | {
1826
+ directoryType?: string;
1827
+ updatedUser?: {
1828
+ username: string;
1829
+ email: string;
1830
+ };
1831
+ role?: string;
1832
+ previousRole: string;
1833
+ updatedUid?: string;
1834
+ } | {
1835
+ entitlement: string;
1836
+ user: {
1837
+ id: string;
1838
+ username: string;
1839
+ };
1840
+ } | {
1841
+ entitlement: string;
1842
+ user: {
1843
+ id: string;
1844
+ username: string;
1845
+ };
1846
+ previousCanceledAt?: string;
1847
+ } | {
1848
+ name?: string;
1849
+ } | {
1850
+ slug?: string;
1851
+ } | {
1852
+ /**
1853
+ * Represents configuration for remote caching
1854
+ */
1855
+ remoteCaching?: {
1856
+ enabled?: boolean;
1857
+ };
1858
+ } | {
1859
+ previous: {
1860
+ enabled: boolean;
1861
+ totpVerified: boolean;
1862
+ };
1863
+ next: {
1864
+ enabled: boolean;
1865
+ totpVerified: boolean;
1866
+ };
1867
+ } | {
1868
+ enabled: boolean;
1869
+ totpVerified: boolean;
1870
+ } | {
1871
+ mfaEnabled: boolean;
1872
+ } | {
1873
+ email: string;
1874
+ prevEmail: string;
1875
+ } | {
1876
+ username: string;
1877
+ } | {
1878
+ price?: number;
1879
+ currency?: string;
1880
+ enabled?: boolean;
1881
+ } | {
1882
+ previewDeploymentSuffix?: string | null;
1883
+ previousPreviewDeploymentSuffix?: string | null;
1884
+ } | {
1885
+ price?: number;
1886
+ currency?: string;
1887
+ } | {
1888
+ teamName: string;
1889
+ username?: string;
1890
+ gitUsername?: string;
1891
+ githubUsername?: string | null;
1892
+ gitlabUsername?: string | null;
1893
+ bitbucketUsername?: string | null;
1894
+ updatedUid?: string;
1895
+ teamId?: string;
1896
+ } | {
1897
+ teamName: string;
1898
+ username?: string;
1899
+ gitUsername?: string | null;
1900
+ githubUsername?: string | null;
1901
+ gitlabUsername?: string | null;
1902
+ bitbucketUsername?: string | null;
1903
+ } | {
1904
+ requestedTeamName: string;
1905
+ requestedUserName?: string;
1906
+ gitUsername?: string;
1907
+ githubUsername?: string;
1908
+ gitlabUsername?: string;
1909
+ bitbucketUsername?: string;
1910
+ } | {
1911
+ projectId: string;
1912
+ projectName: string;
1913
+ originAccountName: string;
1914
+ destinationAccountName: string;
1915
+ destinationAccountId: string;
1916
+ transferId?: string;
1917
+ } | {
1918
+ projectName: string;
1919
+ destinationAccountName: string | null;
1920
+ transferId?: string;
1921
+ } | {
1922
+ previousProjectName: string;
1923
+ newProjectName: string;
1924
+ destinationAccountName: string;
1925
+ transferId?: string;
1926
+ } | {
1927
+ previousProjectName: string;
1928
+ newProjectName: string;
1929
+ originAccountName: string;
1930
+ transferId?: string;
1931
+ } | {
1932
+ project: {
1933
+ name: string;
1934
+ id?: string;
1935
+ };
1936
+ projectMembership: {
1937
+ role?: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1938
+ uid?: string;
1939
+ createdAt?: number;
1940
+ username?: string;
1941
+ } | null;
1942
+ } | {
1943
+ project: {
1944
+ name: string;
1945
+ id?: string;
1946
+ };
1947
+ removedMembership: {
1948
+ role?: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1949
+ uid?: string;
1950
+ createdAt?: number;
1951
+ username?: string;
1952
+ };
1953
+ } | {
1954
+ project: {
1955
+ id: string;
1956
+ name: string;
1957
+ };
1958
+ projectMembership: {
1959
+ role?: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1960
+ uid?: string;
1961
+ createdAt?: number;
1962
+ username?: string;
1963
+ previousRole?: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1964
+ };
1965
+ } | {
1966
+ project: {
1967
+ name: string;
1968
+ role: 'ADMIN' | 'PROJECT_DEVELOPER' | 'PROJECT_VIEWER';
1969
+ invitedUserName: string;
1970
+ id?: string;
1971
+ invitedUserId?: string;
1972
+ };
1973
+ } | {
1974
+ edgeConfigId: string;
1975
+ edgeConfigSlug: string;
1976
+ edgeConfigDigest: string;
1977
+ } | {
1978
+ edgeConfigId: string;
1979
+ edgeConfigSlug: string;
1980
+ edgeConfigTokenId: string;
1981
+ label: string;
1982
+ } | {
1983
+ edgeConfigId: string;
1984
+ edgeConfigSlug: string;
1985
+ /**
1986
+ * ids of deleted tokens
1987
+ */
1988
+ edgeConfigTokenIds: string[];
1989
+ } | {
1990
+ id: string;
1991
+ slug: string;
1992
+ name: string;
1993
+ } | {
1994
+ id: string;
1995
+ slug: string;
1996
+ name: string;
1997
+ prev: {
1998
+ name: string;
1999
+ slug: string;
2000
+ };
2001
+ } | {
2002
+ project: {
2003
+ id: string;
2004
+ name: string;
2005
+ };
2006
+ group: {
2007
+ id: string;
2008
+ slug: string;
2009
+ name: string;
2010
+ };
2011
+ } | {
2012
+ project: {
2013
+ id: string;
2014
+ name: string;
2015
+ microfrontends?: {
2016
+ /**
2017
+ * Timestamp when the microfrontends settings were last updated.
2018
+ */
2019
+ updatedAt: number;
2020
+ /**
2021
+ * 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.
2022
+ *
2023
+ * @maxItems 2
2024
+ * @minItems 2
2025
+ */
2026
+ groupIds: (string | string)[];
2027
+ /**
2028
+ * Whether microfrontends are enabled for this project.
2029
+ */
2030
+ enabled: boolean;
2031
+ /**
2032
+ * 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.
2033
+ */
2034
+ isDefaultApp?: boolean;
2035
+ /**
2036
+ * 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.
2037
+ */
2038
+ defaultRoute?: string;
2039
+ /**
2040
+ * Whether observability data should be routed to this microfrontend project or a root project.
2041
+ */
2042
+ routeObservabilityToThisProject?: boolean;
2043
+ } | {
2044
+ updatedAt: number;
2045
+ /**
2046
+ * @maxItems 2
2047
+ * @minItems 2
2048
+ */
2049
+ groupIds: (string | string)[];
2050
+ enabled: boolean;
2051
+ };
2052
+ };
2053
+ prev: {
2054
+ project: {
2055
+ microfrontends?: {
2056
+ /**
2057
+ * Timestamp when the microfrontends settings were last updated.
2058
+ */
2059
+ updatedAt: number;
2060
+ /**
2061
+ * 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.
2062
+ *
2063
+ * @maxItems 2
2064
+ * @minItems 2
2065
+ */
2066
+ groupIds: (string | string)[];
2067
+ /**
2068
+ * Whether microfrontends are enabled for this project.
2069
+ */
2070
+ enabled: boolean;
2071
+ /**
2072
+ * 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.
2073
+ */
2074
+ isDefaultApp?: boolean;
2075
+ /**
2076
+ * 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.
2077
+ */
2078
+ defaultRoute?: string;
2079
+ /**
2080
+ * Whether observability data should be routed to this microfrontend project or a root project.
2081
+ */
2082
+ routeObservabilityToThisProject?: boolean;
2083
+ } | {
2084
+ updatedAt: number;
2085
+ /**
2086
+ * @maxItems 2
2087
+ * @minItems 2
2088
+ */
2089
+ groupIds: (string | string)[];
2090
+ enabled: boolean;
2091
+ };
2092
+ };
2093
+ };
2094
+ group: {
2095
+ id: string;
2096
+ slug: string;
2097
+ name: string;
2098
+ };
2099
+ } | {
2100
+ projectId: string;
2101
+ projectName: string;
2102
+ projectWebAnalytics?: {
2103
+ id: string;
2104
+ disabledAt?: number;
2105
+ canceledAt?: number;
2106
+ enabledAt?: number;
2107
+ hasData?: boolean;
2108
+ };
2109
+ prevProjectWebAnalytics?: {
2110
+ id: string;
2111
+ disabledAt?: number;
2112
+ canceledAt?: number;
2113
+ enabledAt?: number;
2114
+ hasData?: boolean;
2115
+ } | null;
2116
+ } | {
2117
+ tier: 'pro' | 'plus';
2118
+ } | {
2119
+ oldName: string;
2120
+ newName: string;
2121
+ } | {
2122
+ appName: string;
2123
+ scopes: string[];
2124
+ } | {
2125
+ appName: string;
2126
+ nextScopes: string[];
2127
+ } | {
2128
+ appName: string;
2129
+ } | {
2130
+ team: {
2131
+ id: string;
2132
+ name: string;
2133
+ };
2134
+ configuration: {
2135
+ id: string;
2136
+ name?: string;
2137
+ };
2138
+ peering: {
2139
+ id: string;
2140
+ accountId: string;
2141
+ region: string;
2142
+ vpcId: string;
2143
+ };
2144
+ } | {
2145
+ team: {
2146
+ id: string;
2147
+ name: string;
2148
+ };
2149
+ configuration: {
2150
+ id: string;
2151
+ name?: string;
2152
+ };
2153
+ peering: {
2154
+ id: string;
2155
+ name?: string;
2156
+ };
2157
+ } | {
2158
+ team: {
2159
+ id: string;
2160
+ name: string;
2161
+ };
2162
+ configuration: {
2163
+ id: string;
2164
+ name?: string;
2165
+ };
2166
+ peering: {
2167
+ id: string;
2168
+ name?: string;
2169
+ };
2170
+ newName?: string;
2171
+ } | {
2172
+ grantType: 'authorization_code' | 'refresh_token' | 'urn:ietf:params:oauth:grant-type:device_code' | 'client_credentials';
2173
+ appName: string;
2174
+ /**
2175
+ * access_token TTL
2176
+ */
2177
+ atTTL: number;
2178
+ /**
2179
+ * refresh_token TTL
2180
+ */
2181
+ rtTTL?: number;
2182
+ scope: string;
2183
+ authMethod: 'email' | 'saml' | 'github' | 'gitlab' | 'bitbucket' | 'manual' | 'passkey' | 'otp' | 'sms' | 'invite';
2184
+ };
2185
+ };
67
2186
  /**
68
2187
  * Data representing a Team.
69
2188
  */
@@ -186,7 +2305,7 @@ type TeamLimited = {
186
2305
  accessRequestedAt?: number;
187
2306
  role: 'BILLING' | 'CONTRIBUTOR' | 'DEVELOPER' | 'MEMBER' | 'OWNER' | 'SECURITY' | 'VIEWER';
188
2307
  teamRoles?: ('BILLING' | 'CONTRIBUTOR' | 'DEVELOPER' | 'MEMBER' | 'OWNER' | 'SECURITY' | 'VIEWER')[];
189
- teamPermissions?: ('CreateProject' | 'FullProductionDeployment' | 'UsageViewer')[];
2308
+ teamPermissions?: ('CreateProject' | 'EnvVariableManager' | 'EnvironmentManager' | 'FullProductionDeployment' | 'UsageViewer')[];
190
2309
  teamId?: string;
191
2310
  createdAt: number;
192
2311
  created: number;
@@ -298,7 +2417,7 @@ type AuthUser = {
298
2417
  softBlock: {
299
2418
  blockedAt: number;
300
2419
  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';
2420
+ 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
2421
  } | null;
303
2422
  /**
304
2423
  * An object containing billing infomation associated with the User account.
@@ -316,6 +2435,15 @@ type AuthUser = {
316
2435
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
317
2436
  */
318
2437
  concurrentBuilds?: number;
2438
+ /**
2439
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
2440
+ */
2441
+ buildEntitlements?: {
2442
+ /**
2443
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
2444
+ */
2445
+ enhancedBuilds?: boolean;
2446
+ };
319
2447
  /**
320
2448
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
321
2449
  */
@@ -352,6 +2480,10 @@ type AuthUser = {
352
2480
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
353
2481
  */
354
2482
  serverlessFunctionDefaultMaxExecutionTime?: number;
2483
+ /**
2484
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
2485
+ */
2486
+ serverlessFunctionMaxMemorySize?: number;
355
2487
  /**
356
2488
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
357
2489
  */
@@ -3106,7 +5238,13 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
3106
5238
  env: string[];
3107
5239
  };
3108
5240
  buildArtifactUrls?: string[];
3109
- builds?: Record<string, any>[];
5241
+ builds?: {
5242
+ use: string;
5243
+ src?: string;
5244
+ config?: {
5245
+ [key: string]: any;
5246
+ };
5247
+ }[];
3110
5248
  env: string[];
3111
5249
  inspectorUrl: string | null;
3112
5250
  isInConcurrentBuildsQueue: boolean;
@@ -3727,7 +5865,13 @@ type CreateDeploymentResponse = {
3727
5865
  env: string[];
3728
5866
  };
3729
5867
  buildArtifactUrls?: string[];
3730
- builds?: Record<string, any>[];
5868
+ builds?: {
5869
+ use: string;
5870
+ src?: string;
5871
+ config?: {
5872
+ [key: string]: any;
5873
+ };
5874
+ }[];
3731
5875
  env: string[];
3732
5876
  inspectorUrl: string | null;
3733
5877
  isInConcurrentBuildsQueue: boolean;
@@ -4404,7 +6548,13 @@ type CancelDeploymentResponse = {
4404
6548
  env: string[];
4405
6549
  };
4406
6550
  buildArtifactUrls?: string[];
4407
- builds?: Record<string, any>[];
6551
+ builds?: {
6552
+ use: string;
6553
+ src?: string;
6554
+ config?: {
6555
+ [key: string]: any;
6556
+ };
6557
+ }[];
4408
6558
  env: string[];
4409
6559
  inspectorUrl: string | null;
4410
6560
  isInConcurrentBuildsQueue: boolean;
@@ -5662,6 +7812,11 @@ type GetDomainConfigResponse = {
5662
7812
  * Whether or not the domain is configured AND we can automatically generate a TLS certificate.
5663
7813
  */
5664
7814
  misconfigured: boolean;
7815
+ /**
7816
+ * Recommended IPs and CNAME for the domain.
7817
+ */
7818
+ recommendedIps?: string[];
7819
+ recommendedCname?: string;
5665
7820
  };
5666
7821
  type GetDomainConfigVariables = {
5667
7822
  pathParams: GetDomainConfigPathParams;
@@ -5739,6 +7894,12 @@ type GetDomainResponse = {
5739
7894
  * @example 1613602938882
5740
7895
  */
5741
7896
  boughtAt: number | null;
7897
+ /**
7898
+ * The domain name.
7899
+ *
7900
+ * @example example.com
7901
+ */
7902
+ name: string;
5742
7903
  /**
5743
7904
  * Timestamp in milliseconds when the domain was created in the registry.
5744
7905
  *
@@ -5757,12 +7918,6 @@ type GetDomainResponse = {
5757
7918
  * @example EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1
5758
7919
  */
5759
7920
  id: string;
5760
- /**
5761
- * The domain name.
5762
- *
5763
- * @example example.com
5764
- */
5765
- name: string;
5766
7921
  /**
5767
7922
  * Timestamp in milliseconds at which the domain was ordered.
5768
7923
  *
@@ -6243,7 +8398,6 @@ type GetConfigurableLogDrainError = ErrorWrapper<undefined>;
6243
8398
  type GetConfigurableLogDrainResponse = {
6244
8399
  clientId?: string;
6245
8400
  configurationId?: string;
6246
- deliveryFormat: 'json' | 'ndjson' | 'syslog';
6247
8401
  sources?: ('build' | 'edge' | 'external' | 'firewall' | 'lambda' | 'static')[];
6248
8402
  environments: ('preview' | 'production')[];
6249
8403
  status?: 'disabled' | 'enabled' | 'errored';
@@ -6266,6 +8420,7 @@ type GetConfigurableLogDrainResponse = {
6266
8420
  teamId?: string | null;
6267
8421
  ownerId: string;
6268
8422
  createdFrom?: 'integration' | 'self-served';
8423
+ deliveryFormat: 'json' | 'ndjson' | 'syslog';
6269
8424
  secret: string;
6270
8425
  };
6271
8426
  type GetConfigurableLogDrainVariables = {
@@ -6317,7 +8472,6 @@ type GetAllLogDrainsError = ErrorWrapper<undefined>;
6317
8472
  type GetAllLogDrainsResponse = {
6318
8473
  clientId?: string;
6319
8474
  configurationId?: string;
6320
- deliveryFormat: 'json' | 'ndjson' | 'syslog';
6321
8475
  sources?: ('build' | 'edge' | 'external' | 'firewall' | 'lambda' | 'static')[];
6322
8476
  environments: ('preview' | 'production')[];
6323
8477
  status?: 'disabled' | 'enabled' | 'errored';
@@ -6340,6 +8494,7 @@ type GetAllLogDrainsResponse = {
6340
8494
  teamId?: string | null;
6341
8495
  ownerId: string;
6342
8496
  createdFrom?: 'integration' | 'self-served';
8497
+ deliveryFormat: 'json' | 'ndjson' | 'syslog';
6343
8498
  secret: string;
6344
8499
  }[];
6345
8500
  type GetAllLogDrainsVariables = {
@@ -6367,7 +8522,6 @@ type CreateConfigurableLogDrainResponse = {
6367
8522
  secret?: string;
6368
8523
  clientId?: string;
6369
8524
  configurationId?: string;
6370
- deliveryFormat: 'json' | 'ndjson' | 'syslog';
6371
8525
  sources?: ('build' | 'edge' | 'external' | 'firewall' | 'lambda' | 'static')[];
6372
8526
  environments: ('preview' | 'production')[];
6373
8527
  status?: 'disabled' | 'enabled' | 'errored';
@@ -6390,6 +8544,7 @@ type CreateConfigurableLogDrainResponse = {
6390
8544
  teamId?: string | null;
6391
8545
  ownerId: string;
6392
8546
  createdFrom?: 'integration' | 'self-served';
8547
+ deliveryFormat: 'json' | 'ndjson' | 'syslog';
6393
8548
  };
6394
8549
  type CreateConfigurableLogDrainRequestBody = {
6395
8550
  /**
@@ -7489,12 +9644,16 @@ type SubmitInvoiceRequestBody = {
7489
9644
  name: string;
7490
9645
  details?: string;
7491
9646
  /**
9647
+ * Currency amount as a decimal string.
9648
+ *
7492
9649
  * @pattern ^[0-9]+(\\.[0-9]+)?$
7493
9650
  */
7494
9651
  price: string;
7495
9652
  quantity: number;
7496
9653
  units: string;
7497
9654
  /**
9655
+ * Currency amount as a decimal string.
9656
+ *
7498
9657
  * @pattern ^[0-9]+(\\.[0-9]+)?$
7499
9658
  */
7500
9659
  total: string;
@@ -7523,6 +9682,8 @@ type SubmitInvoiceRequestBody = {
7523
9682
  name: string;
7524
9683
  details?: string;
7525
9684
  /**
9685
+ * Currency amount as a decimal string.
9686
+ *
7526
9687
  * @pattern ^[0-9]+(\\.[0-9]+)?$
7527
9688
  */
7528
9689
  amount: string;
@@ -7549,43 +9710,139 @@ type GetInvoicePathParams = {
7549
9710
  };
7550
9711
  type GetInvoiceError = ErrorWrapper<undefined>;
7551
9712
  type GetInvoiceResponse = {
9713
+ /**
9714
+ * Whether the invoice is in the testmode (no real transaction created).
9715
+ */
9716
+ test?: boolean;
9717
+ /**
9718
+ * Vercel Marketplace Invoice ID.
9719
+ */
7552
9720
  invoiceId: string;
9721
+ /**
9722
+ * Partner-supplied Invoice ID, if applicable.
9723
+ */
7553
9724
  externalId?: string;
9725
+ /**
9726
+ * Invoice state.
9727
+ */
9728
+ state: 'invoiced' | 'notpaid' | 'paid' | 'pending' | 'refund_requested' | 'refunded' | 'scheduled';
9729
+ /**
9730
+ * User-readable invoice number.
9731
+ */
7554
9732
  invoiceNumber?: string;
9733
+ /**
9734
+ * Invoice date. ISO 8601 timestamp.
9735
+ */
7555
9736
  invoiceDate: string;
9737
+ /**
9738
+ * Subscription period for this billing cycle. ISO 8601 timestamps.
9739
+ */
7556
9740
  period: {
7557
9741
  start: string;
7558
9742
  end: string;
7559
9743
  };
9744
+ /**
9745
+ * Additional memo for the invoice.
9746
+ */
7560
9747
  memo?: string;
9748
+ /**
9749
+ * Invoice items.
9750
+ */
7561
9751
  items: {
9752
+ /**
9753
+ * Partner's billing plan ID.
9754
+ */
7562
9755
  billingPlanId: string;
9756
+ /**
9757
+ * Partner's resource ID. If not specified, indicates installation-wide item.
9758
+ */
7563
9759
  resourceId?: string;
9760
+ /**
9761
+ * Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
9762
+ */
7564
9763
  start?: string;
9764
+ /**
9765
+ * Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
9766
+ */
7565
9767
  end?: string;
9768
+ /**
9769
+ * Invoice item name.
9770
+ */
7566
9771
  name: string;
9772
+ /**
9773
+ * Additional item details.
9774
+ */
7567
9775
  details?: string;
9776
+ /**
9777
+ * Item price. A dollar-based decimal string.
9778
+ */
7568
9779
  price: string;
9780
+ /**
9781
+ * Item quantity.
9782
+ */
7569
9783
  quantity: number;
9784
+ /**
9785
+ * Units for item's quantity.
9786
+ */
7570
9787
  units: string;
9788
+ /**
9789
+ * Item total. A dollar-based decimal string.
9790
+ */
7571
9791
  total: string;
7572
9792
  }[];
9793
+ /**
9794
+ * Invoice discounts.
9795
+ */
7573
9796
  discounts?: {
9797
+ /**
9798
+ * Partner's billing plan ID.
9799
+ */
7574
9800
  billingPlanId: string;
9801
+ /**
9802
+ * Partner's resource ID. If not specified, indicates installation-wide discount.
9803
+ */
7575
9804
  resourceId?: string;
9805
+ /**
9806
+ * Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
9807
+ */
7576
9808
  start?: string;
9809
+ /**
9810
+ * Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
9811
+ */
7577
9812
  end?: string;
9813
+ /**
9814
+ * Discount name.
9815
+ */
7578
9816
  name: string;
9817
+ /**
9818
+ * Additional discount details.
9819
+ */
7579
9820
  details?: string;
9821
+ /**
9822
+ * Discount amount. A dollar-based decimal string.
9823
+ */
7580
9824
  amount: string;
7581
9825
  }[];
9826
+ /**
9827
+ * Invoice total amount. A dollar-based decimal string.
9828
+ */
7582
9829
  total: string;
7583
- created: string;
7584
- updated: string;
7585
- state: 'invoiced' | 'notpaid' | 'paid' | 'pending' | 'refund_requested' | 'refunded' | 'scheduled';
9830
+ /**
9831
+ * The reason for refund. Only applicable for states "refunded" or "refund_request".
9832
+ */
7586
9833
  refundReason?: string;
9834
+ /**
9835
+ * Refund amount. Only applicable for states "refunded" or "refund_request". A dollar-based decimal string.
9836
+ */
7587
9837
  refundTotal?: string;
7588
- test: boolean;
9838
+ /**
9839
+ * System creation date. ISO 8601 timestamp.
9840
+ */
9841
+ created: string;
9842
+ /**
9843
+ * System update date. ISO 8601 timestamp.
9844
+ */
9845
+ updated: string;
7589
9846
  };
7590
9847
  type GetInvoiceVariables = {
7591
9848
  pathParams: GetInvoicePathParams;
@@ -13822,7 +16079,7 @@ type CreateProjectEnvError = ErrorWrapper<undefined>;
13822
16079
  type CreateProjectEnvResponse = {
13823
16080
  created: {
13824
16081
  target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
13825
- type?: 'system' | 'encrypted' | 'plain' | 'sensitive' | 'secret';
16082
+ type?: 'system' | 'secret' | 'encrypted' | 'plain' | 'sensitive';
13826
16083
  /**
13827
16084
  * This is used to identiy variables that have been migrated from type secret to sensitive.
13828
16085
  */
@@ -13907,7 +16164,7 @@ type CreateProjectEnvResponse = {
13907
16164
  system?: boolean;
13908
16165
  } | {
13909
16166
  target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
13910
- type?: 'system' | 'encrypted' | 'plain' | 'sensitive' | 'secret';
16167
+ type?: 'system' | 'secret' | 'encrypted' | 'plain' | 'sensitive';
13911
16168
  /**
13912
16169
  * This is used to identiy variables that have been migrated from type secret to sensitive.
13913
16170
  */
@@ -14297,7 +16554,6 @@ declare const getProjectEnv: (variables: GetProjectEnvVariables, signal?: AbortS
14297
16554
  } | null;
14298
16555
  comment?: string;
14299
16556
  customEnvironmentIds?: string[];
14300
- vsmValue?: string;
14301
16557
  } | {
14302
16558
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
14303
16559
  type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
@@ -14507,7 +16763,7 @@ type RemoveProjectEnvVariables = {
14507
16763
  declare const removeProjectEnv: (variables: RemoveProjectEnvVariables, signal?: AbortSignal) => Promise<{
14508
16764
  system?: boolean;
14509
16765
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
14510
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
16766
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
14511
16767
  /**
14512
16768
  * This is used to identiy variables that have been migrated from type secret to sensitive.
14513
16769
  */
@@ -14591,7 +16847,7 @@ declare const removeProjectEnv: (variables: RemoveProjectEnvVariables, signal?:
14591
16847
  vsmValue?: string;
14592
16848
  } | {
14593
16849
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
14594
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
16850
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
14595
16851
  /**
14596
16852
  * This is used to identiy variables that have been migrated from type secret to sensitive.
14597
16853
  */
@@ -14675,7 +16931,7 @@ declare const removeProjectEnv: (variables: RemoveProjectEnvVariables, signal?:
14675
16931
  vsmValue?: string;
14676
16932
  } | {
14677
16933
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
14678
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
16934
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
14679
16935
  /**
14680
16936
  * This is used to identiy variables that have been migrated from type secret to sensitive.
14681
16937
  */
@@ -14837,7 +17093,7 @@ type EditProjectEnvVariables = {
14837
17093
  */
14838
17094
  declare const editProjectEnv: (variables: EditProjectEnvVariables, signal?: AbortSignal) => Promise<Record<string, any> | {
14839
17095
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
14840
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
17096
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
14841
17097
  /**
14842
17098
  * This is used to identiy variables that have been migrated from type secret to sensitive.
14843
17099
  */
@@ -15944,6 +18200,7 @@ declare const addBypassIp: (variables: AddBypassIpVariables, signal?: AbortSigna
15944
18200
  Domain: string;
15945
18201
  Ip?: string;
15946
18202
  ProjectId: string;
18203
+ Note: string;
15947
18204
  IsProjectRule: boolean;
15948
18205
  }[];
15949
18206
  pagination: void | null;
@@ -16288,13 +18545,13 @@ declare const inviteUserToTeam: (variables: InviteUserToTeamVariables, signal?:
16288
18545
  *
16289
18546
  * @example CreateProject
16290
18547
  */
16291
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
18548
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
16292
18549
  } | {
16293
18550
  uid: string;
16294
18551
  username: string;
16295
18552
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
16296
18553
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
16297
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
18554
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
16298
18555
  }>;
16299
18556
  type RequestAccessToTeamError = ErrorWrapper<undefined>;
16300
18557
  type RequestAccessToTeamResponse = {
@@ -19335,7 +21592,6 @@ declare const operationsByTag: {
19335
21592
  } | null;
19336
21593
  comment?: string;
19337
21594
  customEnvironmentIds?: string[];
19338
- vsmValue?: string;
19339
21595
  } | {
19340
21596
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
19341
21597
  type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
@@ -19507,7 +21763,7 @@ declare const operationsByTag: {
19507
21763
  removeProjectEnv: (variables: RemoveProjectEnvVariables, signal?: AbortSignal) => Promise<{
19508
21764
  system?: boolean;
19509
21765
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
19510
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
21766
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
19511
21767
  /**
19512
21768
  * This is used to identiy variables that have been migrated from type secret to sensitive.
19513
21769
  */
@@ -19591,7 +21847,7 @@ declare const operationsByTag: {
19591
21847
  vsmValue?: string;
19592
21848
  } | {
19593
21849
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
19594
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
21850
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
19595
21851
  /**
19596
21852
  * This is used to identiy variables that have been migrated from type secret to sensitive.
19597
21853
  */
@@ -19675,7 +21931,7 @@ declare const operationsByTag: {
19675
21931
  vsmValue?: string;
19676
21932
  } | {
19677
21933
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
19678
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
21934
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
19679
21935
  /**
19680
21936
  * This is used to identiy variables that have been migrated from type secret to sensitive.
19681
21937
  */
@@ -19760,7 +22016,7 @@ declare const operationsByTag: {
19760
22016
  }[]>;
19761
22017
  editProjectEnv: (variables: EditProjectEnvVariables, signal?: AbortSignal) => Promise<Record<string, any> | {
19762
22018
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
19763
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
22019
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
19764
22020
  /**
19765
22021
  * This is used to identiy variables that have been migrated from type secret to sensitive.
19766
22022
  */
@@ -19867,7 +22123,13 @@ declare const operationsByTag: {
19867
22123
  env: string[];
19868
22124
  };
19869
22125
  buildArtifactUrls?: string[];
19870
- builds?: Record<string, any>[];
22126
+ builds?: {
22127
+ use: string;
22128
+ src?: string;
22129
+ config?: {
22130
+ [key: string]: any;
22131
+ };
22132
+ }[];
19871
22133
  env: string[];
19872
22134
  inspectorUrl: string | null;
19873
22135
  isInConcurrentBuildsQueue: boolean;
@@ -21278,6 +23540,7 @@ declare const operationsByTag: {
21278
23540
  Domain: string;
21279
23541
  Ip?: string;
21280
23542
  ProjectId: string;
23543
+ Note: string;
21281
23544
  IsProjectRule: boolean;
21282
23545
  }[];
21283
23546
  pagination: void | null;
@@ -21340,13 +23603,13 @@ declare const operationsByTag: {
21340
23603
  *
21341
23604
  * @example CreateProject
21342
23605
  */
21343
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
23606
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
21344
23607
  } | {
21345
23608
  uid: string;
21346
23609
  username: string;
21347
23610
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
21348
23611
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
21349
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
23612
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
21350
23613
  }>;
21351
23614
  requestAccessToTeam: (variables: RequestAccessToTeamVariables, signal?: AbortSignal) => Promise<RequestAccessToTeamResponse>;
21352
23615
  getTeamAccessRequest: (variables: GetTeamAccessRequestVariables, signal?: AbortSignal) => Promise<GetTeamAccessRequestResponse>;
@@ -22482,7 +24745,13 @@ declare const operationsByPath: {
22482
24745
  env: string[];
22483
24746
  };
22484
24747
  buildArtifactUrls?: string[];
22485
- builds?: Record<string, any>[];
24748
+ builds?: {
24749
+ use: string;
24750
+ src?: string;
24751
+ config?: {
24752
+ [key: string]: any;
24753
+ };
24754
+ }[];
22486
24755
  env: string[];
22487
24756
  inspectorUrl: string | null;
22488
24757
  isInConcurrentBuildsQueue: boolean;
@@ -23593,7 +25862,6 @@ declare const operationsByPath: {
23593
25862
  } | null;
23594
25863
  comment?: string;
23595
25864
  customEnvironmentIds?: string[];
23596
- vsmValue?: string;
23597
25865
  } | {
23598
25866
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
23599
25867
  type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
@@ -23741,7 +26009,7 @@ declare const operationsByPath: {
23741
26009
  'DELETE /v9/projects/{idOrName}/env/{id}': (variables: RemoveProjectEnvVariables, signal?: AbortSignal) => Promise<{
23742
26010
  system?: boolean;
23743
26011
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
23744
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
26012
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
23745
26013
  sunsetSecretId?: string;
23746
26014
  id?: string;
23747
26015
  key: string;
@@ -23813,7 +26081,7 @@ declare const operationsByPath: {
23813
26081
  vsmValue?: string;
23814
26082
  } | {
23815
26083
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
23816
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
26084
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
23817
26085
  sunsetSecretId?: string;
23818
26086
  id?: string;
23819
26087
  key: string;
@@ -23885,7 +26153,7 @@ declare const operationsByPath: {
23885
26153
  vsmValue?: string;
23886
26154
  } | {
23887
26155
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
23888
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
26156
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
23889
26157
  sunsetSecretId?: string;
23890
26158
  id?: string;
23891
26159
  key: string;
@@ -23958,7 +26226,7 @@ declare const operationsByPath: {
23958
26226
  }[]>;
23959
26227
  'PATCH /v9/projects/{idOrName}/env/{id}': (variables: EditProjectEnvVariables, signal?: AbortSignal) => Promise<Record<string, any> | {
23960
26228
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
23961
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
26229
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
23962
26230
  sunsetSecretId?: string;
23963
26231
  id?: string;
23964
26232
  key: string;
@@ -24123,6 +26391,7 @@ declare const operationsByPath: {
24123
26391
  Domain: string;
24124
26392
  Ip?: string;
24125
26393
  ProjectId: string;
26394
+ Note: string;
24126
26395
  IsProjectRule: boolean;
24127
26396
  }[];
24128
26397
  pagination: void | null;
@@ -24153,13 +26422,13 @@ declare const operationsByPath: {
24153
26422
  email?: string;
24154
26423
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
24155
26424
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
24156
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
26425
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
24157
26426
  } | {
24158
26427
  uid: string;
24159
26428
  username: string;
24160
26429
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
24161
26430
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
24162
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
26431
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
24163
26432
  }>;
24164
26433
  'POST /v1/teams/{teamId}/request': (variables: RequestAccessToTeamVariables, signal?: AbortSignal) => Promise<RequestAccessToTeamResponse>;
24165
26434
  'GET /v1/teams/{teamId}/request/{userId}': (variables: GetTeamAccessRequestVariables, signal?: AbortSignal) => Promise<GetTeamAccessRequestResponse>;
@@ -24303,7 +26572,13 @@ declare class VercelApi {
24303
26572
  env: string[];
24304
26573
  };
24305
26574
  buildArtifactUrls?: string[];
24306
- builds?: Record<string, any>[];
26575
+ builds?: {
26576
+ use: string;
26577
+ src?: string;
26578
+ config?: {
26579
+ [key: string]: any;
26580
+ };
26581
+ }[];
24307
26582
  env: string[];
24308
26583
  inspectorUrl: string | null;
24309
26584
  isInConcurrentBuildsQueue: boolean;
@@ -25414,7 +27689,6 @@ declare class VercelApi {
25414
27689
  } | null;
25415
27690
  comment?: string;
25416
27691
  customEnvironmentIds?: string[];
25417
- vsmValue?: string;
25418
27692
  } | {
25419
27693
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
25420
27694
  type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
@@ -25562,7 +27836,7 @@ declare class VercelApi {
25562
27836
  'DELETE /v9/projects/{idOrName}/env/{id}': (variables: RemoveProjectEnvVariables, signal?: AbortSignal) => Promise<{
25563
27837
  system?: boolean;
25564
27838
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
25565
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
27839
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
25566
27840
  sunsetSecretId?: string;
25567
27841
  id?: string;
25568
27842
  key: string;
@@ -25634,7 +27908,7 @@ declare class VercelApi {
25634
27908
  vsmValue?: string;
25635
27909
  } | {
25636
27910
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
25637
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
27911
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
25638
27912
  sunsetSecretId?: string;
25639
27913
  id?: string;
25640
27914
  key: string;
@@ -25706,7 +27980,7 @@ declare class VercelApi {
25706
27980
  vsmValue?: string;
25707
27981
  } | {
25708
27982
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
25709
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
27983
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
25710
27984
  sunsetSecretId?: string;
25711
27985
  id?: string;
25712
27986
  key: string;
@@ -25779,7 +28053,7 @@ declare class VercelApi {
25779
28053
  }[]>;
25780
28054
  'PATCH /v9/projects/{idOrName}/env/{id}': (variables: EditProjectEnvVariables, signal?: AbortSignal) => Promise<Record<string, any> | {
25781
28055
  target?: ("production" | "preview" | "development" | "preview" | "development")[] | ("production" | "preview" | "development" | "preview" | "development");
25782
- type: "system" | "encrypted" | "plain" | "sensitive" | "secret";
28056
+ type: "system" | "secret" | "encrypted" | "plain" | "sensitive";
25783
28057
  sunsetSecretId?: string;
25784
28058
  id?: string;
25785
28059
  key: string;
@@ -25944,6 +28218,7 @@ declare class VercelApi {
25944
28218
  Domain: string;
25945
28219
  Ip?: string;
25946
28220
  ProjectId: string;
28221
+ Note: string;
25947
28222
  IsProjectRule: boolean;
25948
28223
  }[];
25949
28224
  pagination: void | null;
@@ -25974,13 +28249,13 @@ declare class VercelApi {
25974
28249
  email?: string;
25975
28250
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
25976
28251
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
25977
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
28252
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
25978
28253
  } | {
25979
28254
  uid: string;
25980
28255
  username: string;
25981
28256
  role: "OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR";
25982
28257
  teamRoles?: ("OWNER" | "MEMBER" | "DEVELOPER" | "SECURITY" | "BILLING" | "VIEWER" | "CONTRIBUTOR")[];
25983
- teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer")[];
28258
+ teamPermissions?: ("CreateProject" | "FullProductionDeployment" | "UsageViewer" | "EnvVariableManager" | "EnvironmentManager")[];
25984
28259
  }>;
25985
28260
  'POST /v1/teams/{teamId}/request': (variables: RequestAccessToTeamVariables, signal?: AbortSignal) => Promise<RequestAccessToTeamResponse>;
25986
28261
  'GET /v1/teams/{teamId}/request/{userId}': (variables: GetTeamAccessRequestVariables, signal?: AbortSignal) => Promise<GetTeamAccessRequestResponse>;