@meshery/schemas 1.3.26 → 1.3.28

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.
@@ -167,12 +167,12 @@ export interface components {
167
167
  * Format: uuid
168
168
  * @description Unique identifier for the invitation, also used as the invitation code.
169
169
  */
170
- id: string;
170
+ readonly id: string;
171
171
  /**
172
172
  * Format: uuid
173
173
  * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
174
174
  */
175
- owner: string;
175
+ readonly owner: string;
176
176
  /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
177
177
  isDefault?: boolean;
178
178
  /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
@@ -180,21 +180,21 @@ export interface components {
180
180
  /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
181
181
  description: string;
182
182
  /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
183
- emails: string[];
183
+ emails: string[] | null;
184
184
  /**
185
185
  * Format: uuid
186
186
  * @description ID of the organization to which the user is invited.
187
187
  */
188
- orgId: string;
188
+ readonly orgId: string;
189
189
  /**
190
190
  * Format: date-time
191
191
  * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
192
192
  */
193
- expiresAt?: string;
193
+ expiresAt?: string | null;
194
194
  /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
195
195
  quota?: number;
196
196
  /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
197
- acceptedBy: string[];
197
+ readonly acceptedBy: string[];
198
198
  /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
199
199
  roles: string[];
200
200
  /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
@@ -208,17 +208,17 @@ export interface components {
208
208
  * Format: date-time
209
209
  * @description Timestamp when the invitation was created.
210
210
  */
211
- createdAt: string;
211
+ readonly createdAt: string;
212
212
  /**
213
213
  * Format: date-time
214
214
  * @description Timestamp when the invitation was last updated.
215
215
  */
216
- updatedAt: string;
216
+ readonly updatedAt: string;
217
217
  /**
218
218
  * Format: date-time
219
219
  * @description Timestamp when the invitation was deleted, if applicable.
220
220
  */
221
- deletedAt: string;
221
+ readonly deletedAt: string | null;
222
222
  }[];
223
223
  };
224
224
  /** @description A signup request submitted for organization access. */
@@ -433,12 +433,12 @@ export interface components {
433
433
  * Format: uuid
434
434
  * @description Unique identifier for the invitation, also used as the invitation code.
435
435
  */
436
- id: string;
436
+ readonly id: string;
437
437
  /**
438
438
  * Format: uuid
439
439
  * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
440
440
  */
441
- owner: string;
441
+ readonly owner: string;
442
442
  /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
443
443
  isDefault?: boolean;
444
444
  /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
@@ -446,21 +446,21 @@ export interface components {
446
446
  /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
447
447
  description: string;
448
448
  /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
449
- emails: string[];
449
+ emails: string[] | null;
450
450
  /**
451
451
  * Format: uuid
452
452
  * @description ID of the organization to which the user is invited.
453
453
  */
454
- orgId: string;
454
+ readonly orgId: string;
455
455
  /**
456
456
  * Format: date-time
457
457
  * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
458
458
  */
459
- expiresAt?: string;
459
+ expiresAt?: string | null;
460
460
  /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
461
461
  quota?: number;
462
462
  /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
463
- acceptedBy: string[];
463
+ readonly acceptedBy: string[];
464
464
  /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
465
465
  roles: string[];
466
466
  /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
@@ -474,17 +474,17 @@ export interface components {
474
474
  * Format: date-time
475
475
  * @description Timestamp when the invitation was created.
476
476
  */
477
- createdAt: string;
477
+ readonly createdAt: string;
478
478
  /**
479
479
  * Format: date-time
480
480
  * @description Timestamp when the invitation was last updated.
481
481
  */
482
- updatedAt: string;
482
+ readonly updatedAt: string;
483
483
  /**
484
484
  * Format: date-time
485
485
  * @description Timestamp when the invitation was deleted, if applicable.
486
486
  */
487
- deletedAt: string;
487
+ readonly deletedAt: string | null;
488
488
  };
489
489
  };
490
490
  responses: {
@@ -530,6 +530,28 @@ export interface components {
530
530
  orgId: string;
531
531
  /** @description The ID of the invitation. */
532
532
  invitationId: string;
533
+ /** @description The ID of the signup request being approved or denied. */
534
+ signupRequestId: string;
535
+ /** @description First name of the requester. */
536
+ signupFirstName: string;
537
+ /** @description Last name of the requester. */
538
+ signupLastName: string;
539
+ /** @description Email address of the requester. */
540
+ signupEmail: string;
541
+ /** @description Occupation of the requester. */
542
+ signupOccupation: string;
543
+ /** @description Organization of the requester. */
544
+ signupOrganization: string;
545
+ /** @description Requested role. */
546
+ signupRole: string;
547
+ /** @description The signup form variant the request originated from. */
548
+ signupFormType: string;
549
+ /** @description Status to record on the signup request. */
550
+ signupStatus: string;
551
+ /** @description Tracking task identifier associated with the request. */
552
+ signupTaskId: string;
553
+ /** @description Tracking task link associated with the request. */
554
+ signupTaskLink: string;
533
555
  };
534
556
  requestBodies: never;
535
557
  headers: never;
@@ -560,12 +582,12 @@ export interface operations {
560
582
  * Format: uuid
561
583
  * @description Unique identifier for the invitation, also used as the invitation code.
562
584
  */
563
- id: string;
585
+ readonly id: string;
564
586
  /**
565
587
  * Format: uuid
566
588
  * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
567
589
  */
568
- owner: string;
590
+ readonly owner: string;
569
591
  /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
570
592
  isDefault?: boolean;
571
593
  /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
@@ -573,21 +595,21 @@ export interface operations {
573
595
  /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
574
596
  description: string;
575
597
  /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
576
- emails: string[];
598
+ emails: string[] | null;
577
599
  /**
578
600
  * Format: uuid
579
601
  * @description ID of the organization to which the user is invited.
580
602
  */
581
- orgId: string;
603
+ readonly orgId: string;
582
604
  /**
583
605
  * Format: date-time
584
606
  * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
585
607
  */
586
- expiresAt?: string;
608
+ expiresAt?: string | null;
587
609
  /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
588
610
  quota?: number;
589
611
  /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
590
- acceptedBy: string[];
612
+ readonly acceptedBy: string[];
591
613
  /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
592
614
  roles: string[];
593
615
  /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
@@ -601,17 +623,17 @@ export interface operations {
601
623
  * Format: date-time
602
624
  * @description Timestamp when the invitation was created.
603
625
  */
604
- createdAt: string;
626
+ readonly createdAt: string;
605
627
  /**
606
628
  * Format: date-time
607
629
  * @description Timestamp when the invitation was last updated.
608
630
  */
609
- updatedAt: string;
631
+ readonly updatedAt: string;
610
632
  /**
611
633
  * Format: date-time
612
634
  * @description Timestamp when the invitation was deleted, if applicable.
613
635
  */
614
- deletedAt: string;
636
+ readonly deletedAt: string | null;
615
637
  };
616
638
  };
617
639
  };
@@ -720,12 +742,12 @@ export interface operations {
720
742
  * Format: uuid
721
743
  * @description Unique identifier for the invitation, also used as the invitation code.
722
744
  */
723
- id: string;
745
+ readonly id: string;
724
746
  /**
725
747
  * Format: uuid
726
748
  * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
727
749
  */
728
- owner: string;
750
+ readonly owner: string;
729
751
  /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
730
752
  isDefault?: boolean;
731
753
  /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
@@ -733,21 +755,21 @@ export interface operations {
733
755
  /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
734
756
  description: string;
735
757
  /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
736
- emails: string[];
758
+ emails: string[] | null;
737
759
  /**
738
760
  * Format: uuid
739
761
  * @description ID of the organization to which the user is invited.
740
762
  */
741
- orgId: string;
763
+ readonly orgId: string;
742
764
  /**
743
765
  * Format: date-time
744
766
  * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
745
767
  */
746
- expiresAt?: string;
768
+ expiresAt?: string | null;
747
769
  /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
748
770
  quota?: number;
749
771
  /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
750
- acceptedBy: string[];
772
+ readonly acceptedBy: string[];
751
773
  /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
752
774
  roles: string[];
753
775
  /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
@@ -761,17 +783,17 @@ export interface operations {
761
783
  * Format: date-time
762
784
  * @description Timestamp when the invitation was created.
763
785
  */
764
- createdAt: string;
786
+ readonly createdAt: string;
765
787
  /**
766
788
  * Format: date-time
767
789
  * @description Timestamp when the invitation was last updated.
768
790
  */
769
- updatedAt: string;
791
+ readonly updatedAt: string;
770
792
  /**
771
793
  * Format: date-time
772
794
  * @description Timestamp when the invitation was deleted, if applicable.
773
795
  */
774
- deletedAt: string;
796
+ readonly deletedAt: string | null;
775
797
  };
776
798
  };
777
799
  };
@@ -909,12 +931,12 @@ export interface operations {
909
931
  * Format: uuid
910
932
  * @description Unique identifier for the invitation, also used as the invitation code.
911
933
  */
912
- id: string;
934
+ readonly id: string;
913
935
  /**
914
936
  * Format: uuid
915
937
  * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
916
938
  */
917
- owner: string;
939
+ readonly owner: string;
918
940
  /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
919
941
  isDefault?: boolean;
920
942
  /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
@@ -922,21 +944,21 @@ export interface operations {
922
944
  /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
923
945
  description: string;
924
946
  /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
925
- emails: string[];
947
+ emails: string[] | null;
926
948
  /**
927
949
  * Format: uuid
928
950
  * @description ID of the organization to which the user is invited.
929
951
  */
930
- orgId: string;
952
+ readonly orgId: string;
931
953
  /**
932
954
  * Format: date-time
933
955
  * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
934
956
  */
935
- expiresAt?: string;
957
+ expiresAt?: string | null;
936
958
  /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
937
959
  quota?: number;
938
960
  /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
939
- acceptedBy: string[];
961
+ readonly acceptedBy: string[];
940
962
  /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
941
963
  roles: string[];
942
964
  /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
@@ -950,17 +972,17 @@ export interface operations {
950
972
  * Format: date-time
951
973
  * @description Timestamp when the invitation was created.
952
974
  */
953
- createdAt: string;
975
+ readonly createdAt: string;
954
976
  /**
955
977
  * Format: date-time
956
978
  * @description Timestamp when the invitation was last updated.
957
979
  */
958
- updatedAt: string;
980
+ readonly updatedAt: string;
959
981
  /**
960
982
  * Format: date-time
961
983
  * @description Timestamp when the invitation was deleted, if applicable.
962
984
  */
963
- deletedAt: string;
985
+ readonly deletedAt: string | null;
964
986
  }[];
965
987
  };
966
988
  };
@@ -1058,12 +1080,12 @@ export interface operations {
1058
1080
  * Format: uuid
1059
1081
  * @description Unique identifier for the invitation, also used as the invitation code.
1060
1082
  */
1061
- id: string;
1083
+ readonly id: string;
1062
1084
  /**
1063
1085
  * Format: uuid
1064
1086
  * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
1065
1087
  */
1066
- owner: string;
1088
+ readonly owner: string;
1067
1089
  /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
1068
1090
  isDefault?: boolean;
1069
1091
  /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
@@ -1071,21 +1093,21 @@ export interface operations {
1071
1093
  /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
1072
1094
  description: string;
1073
1095
  /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
1074
- emails: string[];
1096
+ emails: string[] | null;
1075
1097
  /**
1076
1098
  * Format: uuid
1077
1099
  * @description ID of the organization to which the user is invited.
1078
1100
  */
1079
- orgId: string;
1101
+ readonly orgId: string;
1080
1102
  /**
1081
1103
  * Format: date-time
1082
1104
  * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
1083
1105
  */
1084
- expiresAt?: string;
1106
+ expiresAt?: string | null;
1085
1107
  /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
1086
1108
  quota?: number;
1087
1109
  /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
1088
- acceptedBy: string[];
1110
+ readonly acceptedBy: string[];
1089
1111
  /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
1090
1112
  roles: string[];
1091
1113
  /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
@@ -1099,17 +1121,17 @@ export interface operations {
1099
1121
  * Format: date-time
1100
1122
  * @description Timestamp when the invitation was created.
1101
1123
  */
1102
- createdAt: string;
1124
+ readonly createdAt: string;
1103
1125
  /**
1104
1126
  * Format: date-time
1105
1127
  * @description Timestamp when the invitation was last updated.
1106
1128
  */
1107
- updatedAt: string;
1129
+ readonly updatedAt: string;
1108
1130
  /**
1109
1131
  * Format: date-time
1110
1132
  * @description Timestamp when the invitation was deleted, if applicable.
1111
1133
  */
1112
- deletedAt: string;
1134
+ readonly deletedAt: string | null;
1113
1135
  };
1114
1136
  };
1115
1137
  };
@@ -1165,12 +1187,12 @@ export interface operations {
1165
1187
  * Format: uuid
1166
1188
  * @description Unique identifier for the invitation, also used as the invitation code.
1167
1189
  */
1168
- id: string;
1190
+ readonly id: string;
1169
1191
  /**
1170
1192
  * Format: uuid
1171
1193
  * @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
1172
1194
  */
1173
- owner: string;
1195
+ readonly owner: string;
1174
1196
  /** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
1175
1197
  isDefault?: boolean;
1176
1198
  /** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
@@ -1178,21 +1200,21 @@ export interface operations {
1178
1200
  /** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
1179
1201
  description: string;
1180
1202
  /** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
1181
- emails: string[];
1203
+ emails: string[] | null;
1182
1204
  /**
1183
1205
  * Format: uuid
1184
1206
  * @description ID of the organization to which the user is invited.
1185
1207
  */
1186
- orgId: string;
1208
+ readonly orgId: string;
1187
1209
  /**
1188
1210
  * Format: date-time
1189
1211
  * @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
1190
1212
  */
1191
- expiresAt?: string;
1213
+ expiresAt?: string | null;
1192
1214
  /** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
1193
1215
  quota?: number;
1194
1216
  /** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
1195
- acceptedBy: string[];
1217
+ readonly acceptedBy: string[];
1196
1218
  /** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
1197
1219
  roles: string[];
1198
1220
  /** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
@@ -1206,17 +1228,17 @@ export interface operations {
1206
1228
  * Format: date-time
1207
1229
  * @description Timestamp when the invitation was created.
1208
1230
  */
1209
- createdAt: string;
1231
+ readonly createdAt: string;
1210
1232
  /**
1211
1233
  * Format: date-time
1212
1234
  * @description Timestamp when the invitation was last updated.
1213
1235
  */
1214
- updatedAt: string;
1236
+ readonly updatedAt: string;
1215
1237
  /**
1216
1238
  * Format: date-time
1217
1239
  * @description Timestamp when the invitation was deleted, if applicable.
1218
1240
  */
1219
- deletedAt: string;
1241
+ readonly deletedAt: string | null;
1220
1242
  };
1221
1243
  };
1222
1244
  };
@@ -1442,7 +1464,30 @@ export interface operations {
1442
1464
  };
1443
1465
  approveSignupRequest: {
1444
1466
  parameters: {
1445
- query?: never;
1467
+ query: {
1468
+ /** @description The ID of the signup request being approved or denied. */
1469
+ id: string;
1470
+ /** @description First name of the requester. */
1471
+ firstName?: string;
1472
+ /** @description Last name of the requester. */
1473
+ lastName?: string;
1474
+ /** @description Email address of the requester. */
1475
+ email?: string;
1476
+ /** @description Occupation of the requester. */
1477
+ occupation?: string;
1478
+ /** @description Organization of the requester. */
1479
+ organization?: string;
1480
+ /** @description Requested role. */
1481
+ role?: string;
1482
+ /** @description The signup form variant the request originated from. */
1483
+ formType?: string;
1484
+ /** @description Status to record on the signup request. */
1485
+ status?: string;
1486
+ /** @description Tracking task identifier associated with the request. */
1487
+ taskId?: string;
1488
+ /** @description Tracking task link associated with the request. */
1489
+ taskLink?: string;
1490
+ };
1446
1491
  header?: never;
1447
1492
  path?: never;
1448
1493
  cookie?: never;
@@ -1491,7 +1536,30 @@ export interface operations {
1491
1536
  };
1492
1537
  denySignupRequest: {
1493
1538
  parameters: {
1494
- query?: never;
1539
+ query: {
1540
+ /** @description The ID of the signup request being approved or denied. */
1541
+ id: string;
1542
+ /** @description First name of the requester. */
1543
+ firstName?: string;
1544
+ /** @description Last name of the requester. */
1545
+ lastName?: string;
1546
+ /** @description Email address of the requester. */
1547
+ email?: string;
1548
+ /** @description Occupation of the requester. */
1549
+ occupation?: string;
1550
+ /** @description Organization of the requester. */
1551
+ organization?: string;
1552
+ /** @description Requested role. */
1553
+ role?: string;
1554
+ /** @description The signup form variant the request originated from. */
1555
+ formType?: string;
1556
+ /** @description Status to record on the signup request. */
1557
+ status?: string;
1558
+ /** @description Tracking task identifier associated with the request. */
1559
+ taskId?: string;
1560
+ /** @description Tracking task link associated with the request. */
1561
+ taskLink?: string;
1562
+ };
1495
1563
  header?: never;
1496
1564
  path?: never;
1497
1565
  cookie?: never;