@meshery/schemas 1.3.9 → 1.4.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.
Files changed (101) hide show
  1. package/dist/cloudApi.d.mts +28 -28
  2. package/dist/cloudApi.d.ts +28 -28
  3. package/dist/constructs/v1alpha1/capability/Capability.d.ts +106 -111
  4. package/dist/constructs/v1alpha1/core/Core.d.ts +822 -734
  5. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +45 -40
  6. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1829 -1716
  7. package/dist/constructs/v1beta1/academy/Academy.d.ts +6023 -6642
  8. package/dist/constructs/v1beta1/badge/Badge.d.ts +439 -600
  9. package/dist/constructs/v1beta1/capability/Capability.d.ts +106 -111
  10. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +45 -40
  11. package/dist/constructs/v1beta1/category/Category.d.ts +38 -26
  12. package/dist/constructs/v1beta1/component/Component.d.ts +833 -729
  13. package/dist/constructs/v1beta1/connection/Connection.d.ts +1170 -1357
  14. package/dist/constructs/v1beta1/core/Core.d.ts +822 -734
  15. package/dist/constructs/v1beta1/credential/Credential.d.ts +458 -593
  16. package/dist/constructs/v1beta1/environment/Environment.d.ts +666 -835
  17. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6142 -5619
  18. package/dist/constructs/v1beta1/event/Event.d.ts +527 -898
  19. package/dist/constructs/v1beta1/feature/Feature.d.ts +343 -389
  20. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +877 -1244
  21. package/dist/constructs/v1beta1/key/Key.d.ts +444 -589
  22. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +575 -796
  23. package/dist/constructs/v1beta1/model/Model.d.ts +598 -572
  24. package/dist/constructs/v1beta1/organization/Organization.d.ts +1410 -1829
  25. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17988 -17171
  26. package/dist/constructs/v1beta1/plan/Plan.d.ts +115 -159
  27. package/dist/constructs/v1beta1/role/Role.d.ts +688 -933
  28. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +315 -425
  29. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +61 -18
  30. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +674 -839
  31. package/dist/constructs/v1beta1/support/Support.d.ts +74 -115
  32. package/dist/constructs/v1beta1/system/System.d.ts +250 -385
  33. package/dist/constructs/v1beta1/team/Team.d.ts +762 -1028
  34. package/dist/constructs/v1beta1/token/Token.d.ts +475 -612
  35. package/dist/constructs/v1beta1/user/User.d.ts +1553 -1722
  36. package/dist/constructs/v1beta1/view/View.d.ts +664 -833
  37. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4705 -4910
  38. package/dist/constructs/v1beta2/academy/Academy.d.ts +7246 -7864
  39. package/dist/constructs/v1beta2/badge/Badge.d.ts +453 -610
  40. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +45 -40
  41. package/dist/constructs/v1beta2/component/Component.d.ts +851 -747
  42. package/dist/constructs/v1beta2/connection/Connection.d.ts +1189 -1376
  43. package/dist/constructs/v1beta2/core/Core.d.ts +856 -768
  44. package/dist/constructs/v1beta2/credential/Credential.d.ts +437 -572
  45. package/dist/constructs/v1beta2/design/Design.d.ts +18631 -17846
  46. package/dist/constructs/v1beta2/event/Event.d.ts +575 -946
  47. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +901 -1268
  48. package/dist/constructs/v1beta2/key/Key.d.ts +454 -599
  49. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +585 -806
  50. package/dist/constructs/v1beta2/model/Model.d.ts +636 -610
  51. package/dist/constructs/v1beta2/organization/Organization.d.ts +2017 -2458
  52. package/dist/constructs/v1beta2/plan/Plan.d.ts +128 -169
  53. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2013 -1844
  54. package/dist/constructs/v1beta2/role/Role.d.ts +695 -940
  55. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +356 -466
  56. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +701 -866
  57. package/dist/constructs/v1beta2/team/Team.d.ts +852 -1118
  58. package/dist/constructs/v1beta2/token/Token.d.ts +479 -616
  59. package/dist/constructs/v1beta2/user/User.d.ts +1553 -1722
  60. package/dist/constructs/v1beta2/view/View.d.ts +669 -838
  61. package/dist/constructs/v1beta3/academy/Academy.d.ts +7246 -7864
  62. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  63. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  64. package/dist/constructs/v1beta3/component/Component.d.ts +857 -753
  65. package/dist/constructs/v1beta3/connection/Connection.d.ts +5559 -5053
  66. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +6 -6
  67. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +6 -6
  68. package/dist/constructs/v1beta3/design/Design.d.ts +5297 -5719
  69. package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
  70. package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
  71. package/dist/constructs/v1beta3/environment/Environment.d.ts +689 -858
  72. package/dist/constructs/v1beta3/event/Event.d.ts +666 -1041
  73. package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
  74. package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
  75. package/dist/constructs/v1beta3/filter/Filter.d.ts +1300 -1438
  76. package/dist/constructs/v1beta3/filter/FilterSchema.js +7 -7
  77. package/dist/constructs/v1beta3/filter/FilterSchema.mjs +7 -7
  78. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +911 -1278
  79. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
  80. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
  81. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +1114 -1412
  82. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
  83. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
  84. package/dist/constructs/v1beta3/plan/Plan.d.ts +156 -197
  85. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2013 -1844
  86. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +804 -969
  87. package/dist/constructs/v1beta3/token/Token.d.ts +480 -617
  88. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  89. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  90. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +4825 -5033
  91. package/dist/index.d.mts +5032 -5501
  92. package/dist/index.d.ts +5032 -5501
  93. package/dist/mesheryApi.d.mts +8 -8
  94. package/dist/mesheryApi.d.ts +8 -8
  95. package/dist/mesheryApi.js +1 -1
  96. package/dist/mesheryApi.mjs +1 -1
  97. package/dist/permissions.d.mts +25 -1
  98. package/dist/permissions.d.ts +25 -1
  99. package/dist/permissions.js +1 -1
  100. package/dist/permissions.mjs +1 -1
  101. package/package.json +1 -1
@@ -4,265 +4,658 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/api/organizations/invitations/{invitationId}": {
8
- parameters: {
9
- query?: never;
10
- header?: never;
11
- path?: never;
12
- cookie?: never;
13
- };
14
- /** Get an invitation by ID */
15
- get: operations["getInvitation"];
16
- /** Update an existing invitation */
17
- put: operations["updateInvitation"];
18
- post?: never;
19
- /** Delete an invitation by ID */
20
- delete: operations["deleteInvitation"];
21
- options?: never;
22
- head?: never;
23
- patch?: never;
24
- trace?: never;
7
+ "/api/organizations/invitations/{invitationId}": {
8
+ get: operations["getInvitation"];
9
+ put: operations["updateInvitation"];
10
+ delete: operations["deleteInvitation"];
11
+ };
12
+ "/api/organizations/invitations": {
13
+ get: operations["getInvitations"];
14
+ post: operations["createInvitation"];
15
+ };
16
+ "/api/organizations/invitations/{invitationId}/accept": {
17
+ post: operations["acceptInvitation"];
18
+ };
19
+ "/api/identity/orgs/{orgId}/users/invite": {
20
+ post: operations["handleUserInvite"];
21
+ };
22
+ "/api/identity/users/request": {
23
+ get: operations["getSignupRequests"];
24
+ post: operations["signupRequest"];
25
+ };
26
+ "/api/identity/users/request/approve": {
27
+ post: operations["approveSignupRequest"];
28
+ };
29
+ "/api/identity/users/request/deny": {
30
+ post: operations["denySignupRequest"];
31
+ };
32
+ "/api/identity/users/request/notification": {
33
+ get: operations["getSignupRequestNotification"];
34
+ };
35
+ }
36
+
37
+ export interface components {
38
+ schemas: {
39
+ /**
40
+ * Format: uuid
41
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
42
+ */
43
+ Uuid: string;
44
+ InvitationsPage: {
45
+ /** @description List of invitations */
46
+ data: {
47
+ /**
48
+ * Format: uuid
49
+ * @description Unique identifier for the invitation , is also used as the invitation code
50
+ */
51
+ id: string;
52
+ /**
53
+ * Format: uuid
54
+ * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
55
+ */
56
+ owner_id: string;
57
+ /** @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, a organization can only have one default invitation */
58
+ is_default?: boolean;
59
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
60
+ name: string;
61
+ /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
62
+ description: string;
63
+ /** @description The emails of the invitation. */
64
+ emails: string[];
65
+ /**
66
+ * Format: uuid
67
+ * @description ID of the organization to which the user is invited
68
+ */
69
+ org_id: string;
70
+ /**
71
+ * Format: date-time
72
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
73
+ */
74
+ expires_at?: string;
75
+ /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
76
+ quota?: number;
77
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
78
+ accepted_by: string[];
79
+ /** @description The roles of the invitation. */
80
+ roles: string[];
81
+ /** @description The teams of the invitation. */
82
+ teams: string[];
83
+ /**
84
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
85
+ * @enum {string}
86
+ */
87
+ status: "enabled" | "disabled";
88
+ /**
89
+ * Format: date-time
90
+ * @description Timestamp when the invitation was created
91
+ */
92
+ created_at: string;
93
+ /**
94
+ * Format: date-time
95
+ * @description Timestamp when the invitation was last updated
96
+ */
97
+ updated_at: string;
98
+ /**
99
+ * Format: date-time
100
+ * @description Timestamp when the invitation was deleted, if applicable
101
+ */
102
+ deleted_at: string;
103
+ }[];
104
+ /** @description Total number of invitations available */
105
+ total: number;
25
106
  };
26
- "/api/organizations/invitations": {
27
- parameters: {
28
- query?: never;
29
- header?: never;
30
- path?: never;
31
- cookie?: never;
32
- };
33
- /** Get all invitations for the organization */
34
- get: operations["getInvitations"];
35
- put?: never;
36
- /** Create a new invitation for the organization */
37
- post: operations["createInvitation"];
38
- delete?: never;
39
- options?: never;
40
- head?: never;
41
- patch?: never;
42
- trace?: never;
107
+ SignupRequest: { [key: string]: unknown };
108
+ SignupRequestsPage: {
109
+ /** @description Current page number of the result set. */
110
+ page?: number;
111
+ /** @description Number of items per page. */
112
+ page_size?: number;
113
+ /** @description Total number of items available. */
114
+ total_count?: number;
115
+ /** @description The data of the signuprequestspage. */
116
+ data?: { [key: string]: unknown }[];
43
117
  };
44
- "/api/organizations/invitations/{invitationId}/accept": {
45
- parameters: {
46
- query?: never;
47
- header?: never;
48
- path?: never;
49
- cookie?: never;
50
- };
51
- get?: never;
52
- put?: never;
53
- /** Accept an invitation by ID */
54
- post: operations["acceptInvitation"];
55
- delete?: never;
56
- options?: never;
57
- head?: never;
58
- patch?: never;
59
- trace?: never;
118
+ /** @description Payload for creating or updating an invitation. */
119
+ InvitationPayload: {
120
+ /**
121
+ * Format: uuid
122
+ * @description Existing invitation ID for updates; omit on create.
123
+ */
124
+ id?: string;
125
+ /**
126
+ * Format: uuid
127
+ * @description ID of the user who created the invitation.
128
+ */
129
+ owner_id?: string;
130
+ /** @description Indicates whether the invitation is a default invitation (open invite). */
131
+ is_default?: boolean;
132
+ /** @description Name of the invitation. */
133
+ name: string;
134
+ /** @description Description of the invitation. */
135
+ description: string;
136
+ /** @description The emails of the invitation. */
137
+ emails: string[];
138
+ /**
139
+ * Format: uuid
140
+ * @description ID of the organization to which the user is invited.
141
+ */
142
+ org_id: string;
143
+ /**
144
+ * Format: date-time
145
+ * @description Timestamp when the invitation expires, if applicable.
146
+ */
147
+ expires_at?: string;
148
+ /** @description Quota for the invitation. */
149
+ quota?: number;
150
+ /** @description The roles of the invitation. */
151
+ roles: string[];
152
+ /** @description The teams of the invitation. */
153
+ teams: string[];
154
+ /**
155
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
156
+ * @enum {string}
157
+ */
158
+ status: "enabled" | "disabled";
60
159
  };
61
- "/api/identity/orgs/{orgId}/users/invite": {
62
- parameters: {
63
- query?: never;
64
- header?: never;
65
- path?: never;
66
- cookie?: never;
67
- };
68
- get?: never;
69
- put?: never;
70
- /** Invite users to an organization */
71
- post: operations["handleUserInvite"];
72
- delete?: never;
73
- options?: never;
74
- head?: never;
75
- patch?: never;
76
- trace?: never;
160
+ /**
161
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
162
+ * @enum {string}
163
+ */
164
+ InvitationStatus: "enabled" | "disabled";
165
+ /** @description Invitation entity schema. */
166
+ Invitation: {
167
+ /**
168
+ * Format: uuid
169
+ * @description Unique identifier for the invitation , is also used as the invitation code
170
+ */
171
+ id: string;
172
+ /**
173
+ * Format: uuid
174
+ * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
175
+ */
176
+ owner_id: string;
177
+ /** @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, a organization can only have one default invitation */
178
+ is_default?: boolean;
179
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
180
+ name: string;
181
+ /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
182
+ description: string;
183
+ /** @description The emails of the invitation. */
184
+ emails: string[];
185
+ /**
186
+ * Format: uuid
187
+ * @description ID of the organization to which the user is invited
188
+ */
189
+ org_id: string;
190
+ /**
191
+ * Format: date-time
192
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
193
+ */
194
+ expires_at?: string;
195
+ /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
196
+ quota?: number;
197
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
198
+ accepted_by: string[];
199
+ /** @description The roles of the invitation. */
200
+ roles: string[];
201
+ /** @description The teams of the invitation. */
202
+ teams: string[];
203
+ /**
204
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
205
+ * @enum {string}
206
+ */
207
+ status: "enabled" | "disabled";
208
+ /**
209
+ * Format: date-time
210
+ * @description Timestamp when the invitation was created
211
+ */
212
+ created_at: string;
213
+ /**
214
+ * Format: date-time
215
+ * @description Timestamp when the invitation was last updated
216
+ */
217
+ updated_at: string;
218
+ /**
219
+ * Format: date-time
220
+ * @description Timestamp when the invitation was deleted, if applicable
221
+ */
222
+ deleted_at: string;
223
+ };
224
+ };
225
+ responses: {
226
+ /** Invalid request body or request param */
227
+ 400: {
228
+ content: {
229
+ "text/plain": string;
230
+ };
231
+ };
232
+ /** Expired JWT token used or insufficient privilege */
233
+ 401: {
234
+ content: {
235
+ "text/plain": string;
236
+ };
237
+ };
238
+ /** Result not found */
239
+ 404: {
240
+ content: {
241
+ "text/plain": string;
242
+ };
243
+ };
244
+ /** Internal server error */
245
+ 500: {
246
+ content: {
247
+ "text/plain": string;
248
+ };
77
249
  };
78
- "/api/identity/users/request": {
79
- parameters: {
80
- query?: never;
81
- header?: never;
82
- path?: never;
83
- cookie?: never;
250
+ };
251
+ parameters: {
252
+ /** @description The ID of the organization */
253
+ organization_id: string;
254
+ /** @description The ID of the invitation */
255
+ invitation_id: string;
256
+ };
257
+ }
258
+
259
+ export interface operations {
260
+ getInvitation: {
261
+ parameters: {
262
+ path: {
263
+ /** The ID of the invitation */
264
+ invitationId: string;
265
+ };
266
+ };
267
+ responses: {
268
+ 200: {
269
+ content: {
270
+ "application/json": {
271
+ /**
272
+ * Format: uuid
273
+ * @description Unique identifier for the invitation , is also used as the invitation code
274
+ */
275
+ id: string;
276
+ /**
277
+ * Format: uuid
278
+ * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
279
+ */
280
+ owner_id: string;
281
+ /** @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, a organization can only have one default invitation */
282
+ is_default?: boolean;
283
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
284
+ name: string;
285
+ /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
286
+ description: string;
287
+ /** @description The emails of the invitation. */
288
+ emails: string[];
289
+ /**
290
+ * Format: uuid
291
+ * @description ID of the organization to which the user is invited
292
+ */
293
+ org_id: string;
294
+ /**
295
+ * Format: date-time
296
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
297
+ */
298
+ expires_at?: string;
299
+ /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
300
+ quota?: number;
301
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
302
+ accepted_by: string[];
303
+ /** @description The roles of the invitation. */
304
+ roles: string[];
305
+ /** @description The teams of the invitation. */
306
+ teams: string[];
307
+ /**
308
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
309
+ * @enum {string}
310
+ */
311
+ status: "enabled" | "disabled";
312
+ /**
313
+ * Format: date-time
314
+ * @description Timestamp when the invitation was created
315
+ */
316
+ created_at: string;
317
+ /**
318
+ * Format: date-time
319
+ * @description Timestamp when the invitation was last updated
320
+ */
321
+ updated_at: string;
322
+ /**
323
+ * Format: date-time
324
+ * @description Timestamp when the invitation was deleted, if applicable
325
+ */
326
+ deleted_at: string;
327
+ };
328
+ };
329
+ };
330
+ /** Invalid request body or request param */
331
+ 400: {
332
+ content: {
333
+ "text/plain": string;
334
+ };
335
+ };
336
+ /** Expired JWT token used or insufficient privilege */
337
+ 401: {
338
+ content: {
339
+ "text/plain": string;
84
340
  };
85
- /** Get signup requests */
86
- get: operations["getSignupRequests"];
87
- put?: never;
88
- /** Create a signup request */
89
- post: operations["signupRequest"];
90
- delete?: never;
91
- options?: never;
92
- head?: never;
93
- patch?: never;
94
- trace?: never;
341
+ };
342
+ /** Result not found */
343
+ 404: {
344
+ content: {
345
+ "text/plain": string;
346
+ };
347
+ };
348
+ /** Internal server error */
349
+ 500: {
350
+ content: {
351
+ "text/plain": string;
352
+ };
353
+ };
354
+ };
355
+ };
356
+ updateInvitation: {
357
+ parameters: {
358
+ path: {
359
+ /** The ID of the invitation */
360
+ invitationId: string;
361
+ };
95
362
  };
96
- "/api/identity/users/request/approve": {
97
- parameters: {
98
- query?: never;
99
- header?: never;
100
- path?: never;
101
- cookie?: never;
363
+ responses: {
364
+ 200: {
365
+ content: {
366
+ "application/json": {
367
+ /**
368
+ * Format: uuid
369
+ * @description Unique identifier for the invitation , is also used as the invitation code
370
+ */
371
+ id: string;
372
+ /**
373
+ * Format: uuid
374
+ * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
375
+ */
376
+ owner_id: string;
377
+ /** @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, a organization can only have one default invitation */
378
+ is_default?: boolean;
379
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
380
+ name: string;
381
+ /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
382
+ description: string;
383
+ /** @description The emails of the invitation. */
384
+ emails: string[];
385
+ /**
386
+ * Format: uuid
387
+ * @description ID of the organization to which the user is invited
388
+ */
389
+ org_id: string;
390
+ /**
391
+ * Format: date-time
392
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
393
+ */
394
+ expires_at?: string;
395
+ /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
396
+ quota?: number;
397
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
398
+ accepted_by: string[];
399
+ /** @description The roles of the invitation. */
400
+ roles: string[];
401
+ /** @description The teams of the invitation. */
402
+ teams: string[];
403
+ /**
404
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
405
+ * @enum {string}
406
+ */
407
+ status: "enabled" | "disabled";
408
+ /**
409
+ * Format: date-time
410
+ * @description Timestamp when the invitation was created
411
+ */
412
+ created_at: string;
413
+ /**
414
+ * Format: date-time
415
+ * @description Timestamp when the invitation was last updated
416
+ */
417
+ updated_at: string;
418
+ /**
419
+ * Format: date-time
420
+ * @description Timestamp when the invitation was deleted, if applicable
421
+ */
422
+ deleted_at: string;
423
+ };
424
+ };
425
+ };
426
+ /** Invalid request body or request param */
427
+ 400: {
428
+ content: {
429
+ "text/plain": string;
430
+ };
431
+ };
432
+ /** Expired JWT token used or insufficient privilege */
433
+ 401: {
434
+ content: {
435
+ "text/plain": string;
436
+ };
437
+ };
438
+ /** Result not found */
439
+ 404: {
440
+ content: {
441
+ "text/plain": string;
102
442
  };
103
- get?: never;
104
- put?: never;
105
- /** Approve a signup request */
106
- post: operations["approveSignupRequest"];
107
- delete?: never;
108
- options?: never;
109
- head?: never;
110
- patch?: never;
111
- trace?: never;
443
+ };
444
+ /** Internal server error */
445
+ 500: {
446
+ content: {
447
+ "text/plain": string;
448
+ };
449
+ };
112
450
  };
113
- "/api/identity/users/request/deny": {
114
- parameters: {
115
- query?: never;
116
- header?: never;
117
- path?: never;
118
- cookie?: never;
451
+ requestBody: {
452
+ content: {
453
+ "application/json": {
454
+ /**
455
+ * Format: uuid
456
+ * @description Existing invitation ID for updates; omit on create.
457
+ */
458
+ id?: string;
459
+ /**
460
+ * Format: uuid
461
+ * @description ID of the user who created the invitation.
462
+ */
463
+ owner_id?: string;
464
+ /** @description Indicates whether the invitation is a default invitation (open invite). */
465
+ is_default?: boolean;
466
+ /** @description Name of the invitation. */
467
+ name: string;
468
+ /** @description Description of the invitation. */
469
+ description: string;
470
+ /** @description The emails of the invitation. */
471
+ emails: string[];
472
+ /**
473
+ * Format: uuid
474
+ * @description ID of the organization to which the user is invited.
475
+ */
476
+ org_id: string;
477
+ /**
478
+ * Format: date-time
479
+ * @description Timestamp when the invitation expires, if applicable.
480
+ */
481
+ expires_at?: string;
482
+ /** @description Quota for the invitation. */
483
+ quota?: number;
484
+ /** @description The roles of the invitation. */
485
+ roles: string[];
486
+ /** @description The teams of the invitation. */
487
+ teams: string[];
488
+ /**
489
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
490
+ * @enum {string}
491
+ */
492
+ status: "enabled" | "disabled";
119
493
  };
120
- get?: never;
121
- put?: never;
122
- /** Deny a signup request */
123
- post: operations["denySignupRequest"];
124
- delete?: never;
125
- options?: never;
126
- head?: never;
127
- patch?: never;
128
- trace?: never;
494
+ };
495
+ };
496
+ };
497
+ deleteInvitation: {
498
+ parameters: {
499
+ path: {
500
+ /** The ID of the invitation */
501
+ invitationId: string;
502
+ };
129
503
  };
130
- "/api/identity/users/request/notification": {
131
- parameters: {
132
- query?: never;
133
- header?: never;
134
- path?: never;
135
- cookie?: never;
504
+ responses: {
505
+ /** Invitation deleted */
506
+ 204: never;
507
+ /** Invalid request body or request param */
508
+ 400: {
509
+ content: {
510
+ "text/plain": string;
136
511
  };
137
- /** Get signup request notification summary */
138
- get: operations["getSignupRequestNotification"];
139
- put?: never;
140
- post?: never;
141
- delete?: never;
142
- options?: never;
143
- head?: never;
144
- patch?: never;
145
- trace?: never;
512
+ };
513
+ /** Expired JWT token used or insufficient privilege */
514
+ 401: {
515
+ content: {
516
+ "text/plain": string;
517
+ };
518
+ };
519
+ /** Result not found */
520
+ 404: {
521
+ content: {
522
+ "text/plain": string;
523
+ };
524
+ };
525
+ /** Internal server error */
526
+ 500: {
527
+ content: {
528
+ "text/plain": string;
529
+ };
530
+ };
146
531
  };
147
- }
148
- export type webhooks = Record<string, never>;
149
- export interface components {
150
- schemas: {
151
- /**
152
- * Format: uuid
153
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
154
- */
155
- Uuid: string;
156
- InvitationsPage: {
532
+ };
533
+ getInvitations: {
534
+ responses: {
535
+ 200: {
536
+ content: {
537
+ "application/json": {
157
538
  /** @description List of invitations */
158
539
  data: {
159
- /**
160
- * Format: uuid
161
- * @description Unique identifier for the invitation , is also used as the invitation code
162
- */
163
- id: string;
164
- /**
165
- * Format: uuid
166
- * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
167
- */
168
- owner_id: string;
169
- /** @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, a organization can only have one default invitation */
170
- is_default?: boolean;
171
- /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
172
- name: string;
173
- /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
174
- description: string;
175
- /** @description The emails of the invitation. */
176
- emails: string[];
177
- /**
178
- * Format: uuid
179
- * @description ID of the organization to which the user is invited
180
- */
181
- org_id: string;
182
- /**
183
- * Format: date-time
184
- * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
185
- */
186
- expires_at?: string;
187
- /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
188
- quota?: number;
189
- /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
190
- accepted_by: string[];
191
- /** @description The roles of the invitation. */
192
- roles: string[];
193
- /** @description The teams of the invitation. */
194
- teams: string[];
195
- /**
196
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
197
- * @enum {string}
198
- */
199
- status: "enabled" | "disabled";
200
- /**
201
- * Format: date-time
202
- * @description Timestamp when the invitation was created
203
- */
204
- created_at: string;
205
- /**
206
- * Format: date-time
207
- * @description Timestamp when the invitation was last updated
208
- */
209
- updated_at: string;
210
- /**
211
- * Format: date-time
212
- * @description Timestamp when the invitation was deleted, if applicable
213
- */
214
- deleted_at: string;
540
+ /**
541
+ * Format: uuid
542
+ * @description Unique identifier for the invitation , is also used as the invitation code
543
+ */
544
+ id: string;
545
+ /**
546
+ * Format: uuid
547
+ * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
548
+ */
549
+ owner_id: string;
550
+ /** @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, a organization can only have one default invitation */
551
+ is_default?: boolean;
552
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
553
+ name: string;
554
+ /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
555
+ description: string;
556
+ /** @description The emails of the invitation. */
557
+ emails: string[];
558
+ /**
559
+ * Format: uuid
560
+ * @description ID of the organization to which the user is invited
561
+ */
562
+ org_id: string;
563
+ /**
564
+ * Format: date-time
565
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
566
+ */
567
+ expires_at?: string;
568
+ /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
569
+ quota?: number;
570
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
571
+ accepted_by: string[];
572
+ /** @description The roles of the invitation. */
573
+ roles: string[];
574
+ /** @description The teams of the invitation. */
575
+ teams: string[];
576
+ /**
577
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
578
+ * @enum {string}
579
+ */
580
+ status: "enabled" | "disabled";
581
+ /**
582
+ * Format: date-time
583
+ * @description Timestamp when the invitation was created
584
+ */
585
+ created_at: string;
586
+ /**
587
+ * Format: date-time
588
+ * @description Timestamp when the invitation was last updated
589
+ */
590
+ updated_at: string;
591
+ /**
592
+ * Format: date-time
593
+ * @description Timestamp when the invitation was deleted, if applicable
594
+ */
595
+ deleted_at: string;
215
596
  }[];
216
597
  /** @description Total number of invitations available */
217
598
  total: number;
599
+ };
218
600
  };
219
- SignupRequest: {
220
- [key: string]: unknown;
601
+ };
602
+ /** Invalid request body or request param */
603
+ 400: {
604
+ content: {
605
+ "text/plain": string;
221
606
  };
222
- SignupRequestsPage: {
223
- /** @description Current page number of the result set. */
224
- page?: number;
225
- /** @description Number of items per page. */
226
- page_size?: number;
227
- /** @description Total number of items available. */
228
- total_count?: number;
229
- /** @description The data of the signuprequestspage. */
230
- data?: {
231
- [key: string]: unknown;
232
- }[];
607
+ };
608
+ /** Expired JWT token used or insufficient privilege */
609
+ 401: {
610
+ content: {
611
+ "text/plain": string;
612
+ };
613
+ };
614
+ /** Internal server error */
615
+ 500: {
616
+ content: {
617
+ "text/plain": string;
233
618
  };
234
- /** @description Payload for creating or updating an invitation. */
235
- InvitationPayload: {
619
+ };
620
+ };
621
+ };
622
+ createInvitation: {
623
+ responses: {
624
+ 201: {
625
+ content: {
626
+ "application/json": {
236
627
  /**
237
628
  * Format: uuid
238
- * @description Existing invitation ID for updates; omit on create.
629
+ * @description Unique identifier for the invitation , is also used as the invitation code
239
630
  */
240
- id?: string;
631
+ id: string;
241
632
  /**
242
633
  * Format: uuid
243
- * @description ID of the user who created the invitation.
634
+ * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
244
635
  */
245
- owner_id?: string;
246
- /** @description Indicates whether the invitation is a default invitation (open invite). */
636
+ owner_id: string;
637
+ /** @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, a organization can only have one default invitation */
247
638
  is_default?: boolean;
248
- /** @description Name of the invitation. */
639
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
249
640
  name: string;
250
- /** @description Description of the invitation. */
641
+ /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
251
642
  description: string;
252
643
  /** @description The emails of the invitation. */
253
644
  emails: string[];
254
645
  /**
255
646
  * Format: uuid
256
- * @description ID of the organization to which the user is invited.
647
+ * @description ID of the organization to which the user is invited
257
648
  */
258
649
  org_id: string;
259
650
  /**
260
651
  * Format: date-time
261
- * @description Timestamp when the invitation expires, if applicable.
652
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
262
653
  */
263
654
  expires_at?: string;
264
- /** @description Quota for the invitation. */
655
+ /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
265
656
  quota?: number;
657
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
658
+ accepted_by: string[];
266
659
  /** @description The roles of the invitation. */
267
660
  roles: string[];
268
661
  /** @description The teams of the invitation. */
@@ -272,14 +665,100 @@ export interface components {
272
665
  * @enum {string}
273
666
  */
274
667
  status: "enabled" | "disabled";
668
+ /**
669
+ * Format: date-time
670
+ * @description Timestamp when the invitation was created
671
+ */
672
+ created_at: string;
673
+ /**
674
+ * Format: date-time
675
+ * @description Timestamp when the invitation was last updated
676
+ */
677
+ updated_at: string;
678
+ /**
679
+ * Format: date-time
680
+ * @description Timestamp when the invitation was deleted, if applicable
681
+ */
682
+ deleted_at: string;
683
+ };
275
684
  };
276
- /**
277
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
278
- * @enum {string}
279
- */
280
- InvitationStatus: "enabled" | "disabled";
281
- /** @description Invitation entity schema. */
282
- Invitation: {
685
+ };
686
+ /** Invalid request body or request param */
687
+ 400: {
688
+ content: {
689
+ "text/plain": string;
690
+ };
691
+ };
692
+ /** Expired JWT token used or insufficient privilege */
693
+ 401: {
694
+ content: {
695
+ "text/plain": string;
696
+ };
697
+ };
698
+ /** Internal server error */
699
+ 500: {
700
+ content: {
701
+ "text/plain": string;
702
+ };
703
+ };
704
+ };
705
+ requestBody: {
706
+ content: {
707
+ "application/json": {
708
+ /**
709
+ * Format: uuid
710
+ * @description Existing invitation ID for updates; omit on create.
711
+ */
712
+ id?: string;
713
+ /**
714
+ * Format: uuid
715
+ * @description ID of the user who created the invitation.
716
+ */
717
+ owner_id?: string;
718
+ /** @description Indicates whether the invitation is a default invitation (open invite). */
719
+ is_default?: boolean;
720
+ /** @description Name of the invitation. */
721
+ name: string;
722
+ /** @description Description of the invitation. */
723
+ description: string;
724
+ /** @description The emails of the invitation. */
725
+ emails: string[];
726
+ /**
727
+ * Format: uuid
728
+ * @description ID of the organization to which the user is invited.
729
+ */
730
+ org_id: string;
731
+ /**
732
+ * Format: date-time
733
+ * @description Timestamp when the invitation expires, if applicable.
734
+ */
735
+ expires_at?: string;
736
+ /** @description Quota for the invitation. */
737
+ quota?: number;
738
+ /** @description The roles of the invitation. */
739
+ roles: string[];
740
+ /** @description The teams of the invitation. */
741
+ teams: string[];
742
+ /**
743
+ * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
744
+ * @enum {string}
745
+ */
746
+ status: "enabled" | "disabled";
747
+ };
748
+ };
749
+ };
750
+ };
751
+ acceptInvitation: {
752
+ parameters: {
753
+ path: {
754
+ /** The ID of the invitation */
755
+ invitationId: string;
756
+ };
757
+ };
758
+ responses: {
759
+ 200: {
760
+ content: {
761
+ "application/json": {
283
762
  /**
284
763
  * Format: uuid
285
764
  * @description Unique identifier for the invitation , is also used as the invitation code
@@ -336,1084 +815,238 @@ export interface components {
336
815
  * @description Timestamp when the invitation was deleted, if applicable
337
816
  */
338
817
  deleted_at: string;
818
+ };
339
819
  };
340
- };
341
- responses: {
342
- /** @description Invalid request body or request param */
343
- 400: {
344
- headers: {
345
- [name: string]: unknown;
346
- };
347
- content: {
348
- "text/plain": string;
349
- };
820
+ };
821
+ /** Invalid request body or request param */
822
+ 400: {
823
+ content: {
824
+ "text/plain": string;
350
825
  };
351
- /** @description Expired JWT token used or insufficient privilege */
352
- 401: {
353
- headers: {
354
- [name: string]: unknown;
355
- };
356
- content: {
357
- "text/plain": string;
358
- };
826
+ };
827
+ /** Expired JWT token used or insufficient privilege */
828
+ 401: {
829
+ content: {
830
+ "text/plain": string;
359
831
  };
360
- /** @description Result not found */
361
- 404: {
362
- headers: {
363
- [name: string]: unknown;
364
- };
365
- content: {
366
- "text/plain": string;
367
- };
832
+ };
833
+ /** Result not found */
834
+ 404: {
835
+ content: {
836
+ "text/plain": string;
368
837
  };
369
- /** @description Internal server error */
370
- 500: {
371
- headers: {
372
- [name: string]: unknown;
373
- };
374
- content: {
375
- "text/plain": string;
376
- };
838
+ };
839
+ /** Internal server error */
840
+ 500: {
841
+ content: {
842
+ "text/plain": string;
377
843
  };
844
+ };
378
845
  };
846
+ };
847
+ handleUserInvite: {
379
848
  parameters: {
380
- /** @description The ID of the organization */
381
- organization_id: string;
382
- /** @description The ID of the invitation */
383
- invitation_id: string;
849
+ path: {
850
+ /** The ID of the organization */
851
+ orgId: string;
852
+ };
384
853
  };
385
- requestBodies: never;
386
- headers: never;
387
- pathItems: never;
388
- }
389
- export type $defs = Record<string, never>;
390
- export interface operations {
391
- getInvitation: {
392
- parameters: {
393
- query?: never;
394
- header?: never;
395
- path: {
396
- /** @description The ID of the invitation */
397
- invitationId: string;
398
- };
399
- cookie?: never;
854
+ responses: {
855
+ /** Invitation request accepted */
856
+ 200: {
857
+ content: {
858
+ "application/json": { [key: string]: unknown };
400
859
  };
401
- requestBody?: never;
402
- responses: {
403
- 200: {
404
- headers: {
405
- [name: string]: unknown;
406
- };
407
- content: {
408
- "application/json": {
409
- /**
410
- * Format: uuid
411
- * @description Unique identifier for the invitation , is also used as the invitation code
412
- */
413
- id: string;
414
- /**
415
- * Format: uuid
416
- * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
417
- */
418
- owner_id: string;
419
- /** @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, a organization can only have one default invitation */
420
- is_default?: boolean;
421
- /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
422
- name: string;
423
- /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
424
- description: string;
425
- /** @description The emails of the invitation. */
426
- emails: string[];
427
- /**
428
- * Format: uuid
429
- * @description ID of the organization to which the user is invited
430
- */
431
- org_id: string;
432
- /**
433
- * Format: date-time
434
- * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
435
- */
436
- expires_at?: string;
437
- /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
438
- quota?: number;
439
- /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
440
- accepted_by: string[];
441
- /** @description The roles of the invitation. */
442
- roles: string[];
443
- /** @description The teams of the invitation. */
444
- teams: string[];
445
- /**
446
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
447
- * @enum {string}
448
- */
449
- status: "enabled" | "disabled";
450
- /**
451
- * Format: date-time
452
- * @description Timestamp when the invitation was created
453
- */
454
- created_at: string;
455
- /**
456
- * Format: date-time
457
- * @description Timestamp when the invitation was last updated
458
- */
459
- updated_at: string;
460
- /**
461
- * Format: date-time
462
- * @description Timestamp when the invitation was deleted, if applicable
463
- */
464
- deleted_at: string;
465
- };
466
- };
467
- };
468
- /** @description Invalid request body or request param */
469
- 400: {
470
- headers: {
471
- [name: string]: unknown;
472
- };
473
- content: {
474
- "text/plain": string;
475
- };
476
- };
477
- /** @description Expired JWT token used or insufficient privilege */
478
- 401: {
479
- headers: {
480
- [name: string]: unknown;
481
- };
482
- content: {
483
- "text/plain": string;
484
- };
485
- };
486
- /** @description Result not found */
487
- 404: {
488
- headers: {
489
- [name: string]: unknown;
490
- };
491
- content: {
492
- "text/plain": string;
493
- };
494
- };
495
- /** @description Internal server error */
496
- 500: {
497
- headers: {
498
- [name: string]: unknown;
499
- };
500
- content: {
501
- "text/plain": string;
502
- };
503
- };
860
+ };
861
+ /** Invalid request body or request param */
862
+ 400: {
863
+ content: {
864
+ "text/plain": string;
504
865
  };
505
- };
506
- updateInvitation: {
507
- parameters: {
508
- query?: never;
509
- header?: never;
510
- path: {
511
- /** @description The ID of the invitation */
512
- invitationId: string;
513
- };
514
- cookie?: never;
866
+ };
867
+ /** Expired JWT token used or insufficient privilege */
868
+ 401: {
869
+ content: {
870
+ "text/plain": string;
515
871
  };
516
- requestBody: {
517
- content: {
518
- "application/json": {
519
- /**
520
- * Format: uuid
521
- * @description Existing invitation ID for updates; omit on create.
522
- */
523
- id?: string;
524
- /**
525
- * Format: uuid
526
- * @description ID of the user who created the invitation.
527
- */
528
- owner_id?: string;
529
- /** @description Indicates whether the invitation is a default invitation (open invite). */
530
- is_default?: boolean;
531
- /** @description Name of the invitation. */
532
- name: string;
533
- /** @description Description of the invitation. */
534
- description: string;
535
- /** @description The emails of the invitation. */
536
- emails: string[];
537
- /**
538
- * Format: uuid
539
- * @description ID of the organization to which the user is invited.
540
- */
541
- org_id: string;
542
- /**
543
- * Format: date-time
544
- * @description Timestamp when the invitation expires, if applicable.
545
- */
546
- expires_at?: string;
547
- /** @description Quota for the invitation. */
548
- quota?: number;
549
- /** @description The roles of the invitation. */
550
- roles: string[];
551
- /** @description The teams of the invitation. */
552
- teams: string[];
553
- /**
554
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
555
- * @enum {string}
556
- */
557
- status: "enabled" | "disabled";
558
- };
559
- };
872
+ };
873
+ /** Result not found */
874
+ 404: {
875
+ content: {
876
+ "text/plain": string;
560
877
  };
561
- responses: {
562
- 200: {
563
- headers: {
564
- [name: string]: unknown;
565
- };
566
- content: {
567
- "application/json": {
568
- /**
569
- * Format: uuid
570
- * @description Unique identifier for the invitation , is also used as the invitation code
571
- */
572
- id: string;
573
- /**
574
- * Format: uuid
575
- * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
576
- */
577
- owner_id: string;
578
- /** @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, a organization can only have one default invitation */
579
- is_default?: boolean;
580
- /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
581
- name: string;
582
- /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
583
- description: string;
584
- /** @description The emails of the invitation. */
585
- emails: string[];
586
- /**
587
- * Format: uuid
588
- * @description ID of the organization to which the user is invited
589
- */
590
- org_id: string;
591
- /**
592
- * Format: date-time
593
- * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
594
- */
595
- expires_at?: string;
596
- /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
597
- quota?: number;
598
- /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
599
- accepted_by: string[];
600
- /** @description The roles of the invitation. */
601
- roles: string[];
602
- /** @description The teams of the invitation. */
603
- teams: string[];
604
- /**
605
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
606
- * @enum {string}
607
- */
608
- status: "enabled" | "disabled";
609
- /**
610
- * Format: date-time
611
- * @description Timestamp when the invitation was created
612
- */
613
- created_at: string;
614
- /**
615
- * Format: date-time
616
- * @description Timestamp when the invitation was last updated
617
- */
618
- updated_at: string;
619
- /**
620
- * Format: date-time
621
- * @description Timestamp when the invitation was deleted, if applicable
622
- */
623
- deleted_at: string;
624
- };
625
- };
626
- };
627
- /** @description Invalid request body or request param */
628
- 400: {
629
- headers: {
630
- [name: string]: unknown;
631
- };
632
- content: {
633
- "text/plain": string;
634
- };
635
- };
636
- /** @description Expired JWT token used or insufficient privilege */
637
- 401: {
638
- headers: {
639
- [name: string]: unknown;
640
- };
641
- content: {
642
- "text/plain": string;
643
- };
644
- };
645
- /** @description Result not found */
646
- 404: {
647
- headers: {
648
- [name: string]: unknown;
649
- };
650
- content: {
651
- "text/plain": string;
652
- };
653
- };
654
- /** @description Internal server error */
655
- 500: {
656
- headers: {
657
- [name: string]: unknown;
658
- };
659
- content: {
660
- "text/plain": string;
661
- };
662
- };
878
+ };
879
+ /** Internal server error */
880
+ 500: {
881
+ content: {
882
+ "text/plain": string;
663
883
  };
884
+ };
664
885
  };
665
- deleteInvitation: {
666
- parameters: {
667
- query?: never;
668
- header?: never;
669
- path: {
670
- /** @description The ID of the invitation */
671
- invitationId: string;
672
- };
673
- cookie?: never;
674
- };
675
- requestBody?: never;
676
- responses: {
677
- /** @description Invitation deleted */
678
- 204: {
679
- headers: {
680
- [name: string]: unknown;
681
- };
682
- content?: never;
683
- };
684
- /** @description Invalid request body or request param */
685
- 400: {
686
- headers: {
687
- [name: string]: unknown;
688
- };
689
- content: {
690
- "text/plain": string;
691
- };
692
- };
693
- /** @description Expired JWT token used or insufficient privilege */
694
- 401: {
695
- headers: {
696
- [name: string]: unknown;
697
- };
698
- content: {
699
- "text/plain": string;
700
- };
701
- };
702
- /** @description Result not found */
703
- 404: {
704
- headers: {
705
- [name: string]: unknown;
706
- };
707
- content: {
708
- "text/plain": string;
709
- };
710
- };
711
- /** @description Internal server error */
712
- 500: {
713
- headers: {
714
- [name: string]: unknown;
715
- };
716
- content: {
717
- "text/plain": string;
718
- };
719
- };
720
- };
886
+ requestBody: {
887
+ content: {
888
+ "application/json": { [key: string]: unknown };
889
+ };
721
890
  };
722
- getInvitations: {
723
- parameters: {
724
- query?: never;
725
- header?: never;
726
- path?: never;
727
- cookie?: never;
728
- };
729
- requestBody?: never;
730
- responses: {
731
- 200: {
732
- headers: {
733
- [name: string]: unknown;
734
- };
735
- content: {
736
- "application/json": {
737
- /** @description List of invitations */
738
- data: {
739
- /**
740
- * Format: uuid
741
- * @description Unique identifier for the invitation , is also used as the invitation code
742
- */
743
- id: string;
744
- /**
745
- * Format: uuid
746
- * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
747
- */
748
- owner_id: string;
749
- /** @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, a organization can only have one default invitation */
750
- is_default?: boolean;
751
- /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
752
- name: string;
753
- /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
754
- description: string;
755
- /** @description The emails of the invitation. */
756
- emails: string[];
757
- /**
758
- * Format: uuid
759
- * @description ID of the organization to which the user is invited
760
- */
761
- org_id: string;
762
- /**
763
- * Format: date-time
764
- * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
765
- */
766
- expires_at?: string;
767
- /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
768
- quota?: number;
769
- /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
770
- accepted_by: string[];
771
- /** @description The roles of the invitation. */
772
- roles: string[];
773
- /** @description The teams of the invitation. */
774
- teams: string[];
775
- /**
776
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
777
- * @enum {string}
778
- */
779
- status: "enabled" | "disabled";
780
- /**
781
- * Format: date-time
782
- * @description Timestamp when the invitation was created
783
- */
784
- created_at: string;
785
- /**
786
- * Format: date-time
787
- * @description Timestamp when the invitation was last updated
788
- */
789
- updated_at: string;
790
- /**
791
- * Format: date-time
792
- * @description Timestamp when the invitation was deleted, if applicable
793
- */
794
- deleted_at: string;
795
- }[];
796
- /** @description Total number of invitations available */
797
- total: number;
798
- };
799
- };
800
- };
801
- /** @description Invalid request body or request param */
802
- 400: {
803
- headers: {
804
- [name: string]: unknown;
805
- };
806
- content: {
807
- "text/plain": string;
808
- };
809
- };
810
- /** @description Expired JWT token used or insufficient privilege */
811
- 401: {
812
- headers: {
813
- [name: string]: unknown;
814
- };
815
- content: {
816
- "text/plain": string;
817
- };
818
- };
819
- /** @description Internal server error */
820
- 500: {
821
- headers: {
822
- [name: string]: unknown;
823
- };
824
- content: {
825
- "text/plain": string;
826
- };
827
- };
828
- };
891
+ };
892
+ getSignupRequests: {
893
+ parameters: {
894
+ query: {
895
+ /** Get responses by page */
896
+ page?: string;
897
+ /** Get responses by pagesize */
898
+ pagesize?: string;
899
+ /** Get responses that match search param value */
900
+ search?: string;
901
+ /** Get ordered responses */
902
+ order?: string;
903
+ /** Get filtered reponses */
904
+ filter?: string;
905
+ };
829
906
  };
830
- createInvitation: {
831
- parameters: {
832
- query?: never;
833
- header?: never;
834
- path?: never;
835
- cookie?: never;
907
+ responses: {
908
+ /** Signup requests page */
909
+ 200: {
910
+ content: {
911
+ "application/json": {
912
+ /** @description Current page number of the result set. */
913
+ page?: number;
914
+ /** @description Number of items per page. */
915
+ page_size?: number;
916
+ /** @description Total number of items available. */
917
+ total_count?: number;
918
+ /** @description The data of the signuprequestspage. */
919
+ data?: { [key: string]: unknown }[];
920
+ };
836
921
  };
837
- requestBody: {
838
- content: {
839
- "application/json": {
840
- /**
841
- * Format: uuid
842
- * @description Existing invitation ID for updates; omit on create.
843
- */
844
- id?: string;
845
- /**
846
- * Format: uuid
847
- * @description ID of the user who created the invitation.
848
- */
849
- owner_id?: string;
850
- /** @description Indicates whether the invitation is a default invitation (open invite). */
851
- is_default?: boolean;
852
- /** @description Name of the invitation. */
853
- name: string;
854
- /** @description Description of the invitation. */
855
- description: string;
856
- /** @description The emails of the invitation. */
857
- emails: string[];
858
- /**
859
- * Format: uuid
860
- * @description ID of the organization to which the user is invited.
861
- */
862
- org_id: string;
863
- /**
864
- * Format: date-time
865
- * @description Timestamp when the invitation expires, if applicable.
866
- */
867
- expires_at?: string;
868
- /** @description Quota for the invitation. */
869
- quota?: number;
870
- /** @description The roles of the invitation. */
871
- roles: string[];
872
- /** @description The teams of the invitation. */
873
- teams: string[];
874
- /**
875
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
876
- * @enum {string}
877
- */
878
- status: "enabled" | "disabled";
879
- };
880
- };
922
+ };
923
+ /** Expired JWT token used or insufficient privilege */
924
+ 401: {
925
+ content: {
926
+ "text/plain": string;
881
927
  };
882
- responses: {
883
- 201: {
884
- headers: {
885
- [name: string]: unknown;
886
- };
887
- content: {
888
- "application/json": {
889
- /**
890
- * Format: uuid
891
- * @description Unique identifier for the invitation , is also used as the invitation code
892
- */
893
- id: string;
894
- /**
895
- * Format: uuid
896
- * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
897
- */
898
- owner_id: string;
899
- /** @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, a organization can only have one default invitation */
900
- is_default?: boolean;
901
- /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
902
- name: string;
903
- /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
904
- description: string;
905
- /** @description The emails of the invitation. */
906
- emails: string[];
907
- /**
908
- * Format: uuid
909
- * @description ID of the organization to which the user is invited
910
- */
911
- org_id: string;
912
- /**
913
- * Format: date-time
914
- * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
915
- */
916
- expires_at?: string;
917
- /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
918
- quota?: number;
919
- /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
920
- accepted_by: string[];
921
- /** @description The roles of the invitation. */
922
- roles: string[];
923
- /** @description The teams of the invitation. */
924
- teams: string[];
925
- /**
926
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
927
- * @enum {string}
928
- */
929
- status: "enabled" | "disabled";
930
- /**
931
- * Format: date-time
932
- * @description Timestamp when the invitation was created
933
- */
934
- created_at: string;
935
- /**
936
- * Format: date-time
937
- * @description Timestamp when the invitation was last updated
938
- */
939
- updated_at: string;
940
- /**
941
- * Format: date-time
942
- * @description Timestamp when the invitation was deleted, if applicable
943
- */
944
- deleted_at: string;
945
- };
946
- };
947
- };
948
- /** @description Invalid request body or request param */
949
- 400: {
950
- headers: {
951
- [name: string]: unknown;
952
- };
953
- content: {
954
- "text/plain": string;
955
- };
956
- };
957
- /** @description Expired JWT token used or insufficient privilege */
958
- 401: {
959
- headers: {
960
- [name: string]: unknown;
961
- };
962
- content: {
963
- "text/plain": string;
964
- };
965
- };
966
- /** @description Internal server error */
967
- 500: {
968
- headers: {
969
- [name: string]: unknown;
970
- };
971
- content: {
972
- "text/plain": string;
973
- };
974
- };
928
+ };
929
+ /** Internal server error */
930
+ 500: {
931
+ content: {
932
+ "text/plain": string;
975
933
  };
934
+ };
976
935
  };
977
- acceptInvitation: {
978
- parameters: {
979
- query?: never;
980
- header?: never;
981
- path: {
982
- /** @description The ID of the invitation */
983
- invitationId: string;
984
- };
985
- cookie?: never;
986
- };
987
- requestBody?: never;
988
- responses: {
989
- 200: {
990
- headers: {
991
- [name: string]: unknown;
992
- };
993
- content: {
994
- "application/json": {
995
- /**
996
- * Format: uuid
997
- * @description Unique identifier for the invitation , is also used as the invitation code
998
- */
999
- id: string;
1000
- /**
1001
- * Format: uuid
1002
- * @description ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
1003
- */
1004
- owner_id: string;
1005
- /** @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, a organization can only have one default invitation */
1006
- is_default?: boolean;
1007
- /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
1008
- name: string;
1009
- /** @description Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description */
1010
- description: string;
1011
- /** @description The emails of the invitation. */
1012
- emails: string[];
1013
- /**
1014
- * Format: uuid
1015
- * @description ID of the organization to which the user is invited
1016
- */
1017
- org_id: string;
1018
- /**
1019
- * Format: date-time
1020
- * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
1021
- */
1022
- expires_at?: string;
1023
- /** @description Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota */
1024
- quota?: number;
1025
- /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
1026
- accepted_by: string[];
1027
- /** @description The roles of the invitation. */
1028
- roles: string[];
1029
- /** @description The teams of the invitation. */
1030
- teams: string[];
1031
- /**
1032
- * @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
1033
- * @enum {string}
1034
- */
1035
- status: "enabled" | "disabled";
1036
- /**
1037
- * Format: date-time
1038
- * @description Timestamp when the invitation was created
1039
- */
1040
- created_at: string;
1041
- /**
1042
- * Format: date-time
1043
- * @description Timestamp when the invitation was last updated
1044
- */
1045
- updated_at: string;
1046
- /**
1047
- * Format: date-time
1048
- * @description Timestamp when the invitation was deleted, if applicable
1049
- */
1050
- deleted_at: string;
1051
- };
1052
- };
1053
- };
1054
- /** @description Invalid request body or request param */
1055
- 400: {
1056
- headers: {
1057
- [name: string]: unknown;
1058
- };
1059
- content: {
1060
- "text/plain": string;
1061
- };
1062
- };
1063
- /** @description Expired JWT token used or insufficient privilege */
1064
- 401: {
1065
- headers: {
1066
- [name: string]: unknown;
1067
- };
1068
- content: {
1069
- "text/plain": string;
1070
- };
1071
- };
1072
- /** @description Result not found */
1073
- 404: {
1074
- headers: {
1075
- [name: string]: unknown;
1076
- };
1077
- content: {
1078
- "text/plain": string;
1079
- };
1080
- };
1081
- /** @description Internal server error */
1082
- 500: {
1083
- headers: {
1084
- [name: string]: unknown;
1085
- };
1086
- content: {
1087
- "text/plain": string;
1088
- };
1089
- };
936
+ };
937
+ signupRequest: {
938
+ responses: {
939
+ /** Signup request created */
940
+ 201: {
941
+ content: {
942
+ "application/json": { [key: string]: unknown };
1090
943
  };
1091
- };
1092
- handleUserInvite: {
1093
- parameters: {
1094
- query?: never;
1095
- header?: never;
1096
- path: {
1097
- /** @description The ID of the organization */
1098
- orgId: string;
1099
- };
1100
- cookie?: never;
944
+ };
945
+ /** Invalid request body or request param */
946
+ 400: {
947
+ content: {
948
+ "text/plain": string;
1101
949
  };
1102
- requestBody: {
1103
- content: {
1104
- "application/json": {
1105
- [key: string]: unknown;
1106
- };
1107
- };
950
+ };
951
+ /** Expired JWT token used or insufficient privilege */
952
+ 401: {
953
+ content: {
954
+ "text/plain": string;
1108
955
  };
1109
- responses: {
1110
- /** @description Invitation request accepted */
1111
- 200: {
1112
- headers: {
1113
- [name: string]: unknown;
1114
- };
1115
- content: {
1116
- "application/json": {
1117
- [key: string]: unknown;
1118
- };
1119
- };
1120
- };
1121
- /** @description Invalid request body or request param */
1122
- 400: {
1123
- headers: {
1124
- [name: string]: unknown;
1125
- };
1126
- content: {
1127
- "text/plain": string;
1128
- };
1129
- };
1130
- /** @description Expired JWT token used or insufficient privilege */
1131
- 401: {
1132
- headers: {
1133
- [name: string]: unknown;
1134
- };
1135
- content: {
1136
- "text/plain": string;
1137
- };
1138
- };
1139
- /** @description Result not found */
1140
- 404: {
1141
- headers: {
1142
- [name: string]: unknown;
1143
- };
1144
- content: {
1145
- "text/plain": string;
1146
- };
1147
- };
1148
- /** @description Internal server error */
1149
- 500: {
1150
- headers: {
1151
- [name: string]: unknown;
1152
- };
1153
- content: {
1154
- "text/plain": string;
1155
- };
1156
- };
956
+ };
957
+ /** Internal server error */
958
+ 500: {
959
+ content: {
960
+ "text/plain": string;
1157
961
  };
962
+ };
1158
963
  };
1159
- getSignupRequests: {
1160
- parameters: {
1161
- query?: {
1162
- /** @description Get responses by page */
1163
- page?: string;
1164
- /** @description Get responses by pagesize */
1165
- pagesize?: string;
1166
- /** @description Get responses that match search param value */
1167
- search?: string;
1168
- /** @description Get ordered responses */
1169
- order?: string;
1170
- /** @description Get filtered reponses */
1171
- filter?: string;
1172
- };
1173
- header?: never;
1174
- path?: never;
1175
- cookie?: never;
1176
- };
1177
- requestBody?: never;
1178
- responses: {
1179
- /** @description Signup requests page */
1180
- 200: {
1181
- headers: {
1182
- [name: string]: unknown;
1183
- };
1184
- content: {
1185
- "application/json": {
1186
- /** @description Current page number of the result set. */
1187
- page?: number;
1188
- /** @description Number of items per page. */
1189
- page_size?: number;
1190
- /** @description Total number of items available. */
1191
- total_count?: number;
1192
- /** @description The data of the signuprequestspage. */
1193
- data?: {
1194
- [key: string]: unknown;
1195
- }[];
1196
- };
1197
- };
1198
- };
1199
- /** @description Expired JWT token used or insufficient privilege */
1200
- 401: {
1201
- headers: {
1202
- [name: string]: unknown;
1203
- };
1204
- content: {
1205
- "text/plain": string;
1206
- };
1207
- };
1208
- /** @description Internal server error */
1209
- 500: {
1210
- headers: {
1211
- [name: string]: unknown;
1212
- };
1213
- content: {
1214
- "text/plain": string;
1215
- };
1216
- };
1217
- };
964
+ requestBody: {
965
+ content: {
966
+ "application/json": { [key: string]: unknown };
967
+ };
1218
968
  };
1219
- signupRequest: {
1220
- parameters: {
1221
- query?: never;
1222
- header?: never;
1223
- path?: never;
1224
- cookie?: never;
969
+ };
970
+ approveSignupRequest: {
971
+ responses: {
972
+ /** Signup request approved */
973
+ 200: {
974
+ content: {
975
+ "application/json": { [key: string]: unknown };
976
+ };
977
+ };
978
+ /** Invalid request body or request param */
979
+ 400: {
980
+ content: {
981
+ "text/plain": string;
1225
982
  };
1226
- requestBody: {
1227
- content: {
1228
- "application/json": {
1229
- [key: string]: unknown;
1230
- };
1231
- };
983
+ };
984
+ /** Expired JWT token used or insufficient privilege */
985
+ 401: {
986
+ content: {
987
+ "text/plain": string;
1232
988
  };
1233
- responses: {
1234
- /** @description Signup request created */
1235
- 201: {
1236
- headers: {
1237
- [name: string]: unknown;
1238
- };
1239
- content: {
1240
- "application/json": {
1241
- [key: string]: unknown;
1242
- };
1243
- };
1244
- };
1245
- /** @description Invalid request body or request param */
1246
- 400: {
1247
- headers: {
1248
- [name: string]: unknown;
1249
- };
1250
- content: {
1251
- "text/plain": string;
1252
- };
1253
- };
1254
- /** @description Expired JWT token used or insufficient privilege */
1255
- 401: {
1256
- headers: {
1257
- [name: string]: unknown;
1258
- };
1259
- content: {
1260
- "text/plain": string;
1261
- };
1262
- };
1263
- /** @description Internal server error */
1264
- 500: {
1265
- headers: {
1266
- [name: string]: unknown;
1267
- };
1268
- content: {
1269
- "text/plain": string;
1270
- };
1271
- };
989
+ };
990
+ /** Internal server error */
991
+ 500: {
992
+ content: {
993
+ "text/plain": string;
1272
994
  };
995
+ };
1273
996
  };
1274
- approveSignupRequest: {
1275
- parameters: {
1276
- query?: never;
1277
- header?: never;
1278
- path?: never;
1279
- cookie?: never;
997
+ };
998
+ denySignupRequest: {
999
+ responses: {
1000
+ /** Signup request denied */
1001
+ 200: {
1002
+ content: {
1003
+ "application/json": { [key: string]: unknown };
1280
1004
  };
1281
- requestBody?: never;
1282
- responses: {
1283
- /** @description Signup request approved */
1284
- 200: {
1285
- headers: {
1286
- [name: string]: unknown;
1287
- };
1288
- content: {
1289
- "application/json": {
1290
- [key: string]: unknown;
1291
- };
1292
- };
1293
- };
1294
- /** @description Invalid request body or request param */
1295
- 400: {
1296
- headers: {
1297
- [name: string]: unknown;
1298
- };
1299
- content: {
1300
- "text/plain": string;
1301
- };
1302
- };
1303
- /** @description Expired JWT token used or insufficient privilege */
1304
- 401: {
1305
- headers: {
1306
- [name: string]: unknown;
1307
- };
1308
- content: {
1309
- "text/plain": string;
1310
- };
1311
- };
1312
- /** @description Internal server error */
1313
- 500: {
1314
- headers: {
1315
- [name: string]: unknown;
1316
- };
1317
- content: {
1318
- "text/plain": string;
1319
- };
1320
- };
1005
+ };
1006
+ /** Invalid request body or request param */
1007
+ 400: {
1008
+ content: {
1009
+ "text/plain": string;
1321
1010
  };
1322
- };
1323
- denySignupRequest: {
1324
- parameters: {
1325
- query?: never;
1326
- header?: never;
1327
- path?: never;
1328
- cookie?: never;
1011
+ };
1012
+ /** Expired JWT token used or insufficient privilege */
1013
+ 401: {
1014
+ content: {
1015
+ "text/plain": string;
1329
1016
  };
1330
- requestBody?: never;
1331
- responses: {
1332
- /** @description Signup request denied */
1333
- 200: {
1334
- headers: {
1335
- [name: string]: unknown;
1336
- };
1337
- content: {
1338
- "application/json": {
1339
- [key: string]: unknown;
1340
- };
1341
- };
1342
- };
1343
- /** @description Invalid request body or request param */
1344
- 400: {
1345
- headers: {
1346
- [name: string]: unknown;
1347
- };
1348
- content: {
1349
- "text/plain": string;
1350
- };
1351
- };
1352
- /** @description Expired JWT token used or insufficient privilege */
1353
- 401: {
1354
- headers: {
1355
- [name: string]: unknown;
1356
- };
1357
- content: {
1358
- "text/plain": string;
1359
- };
1360
- };
1361
- /** @description Internal server error */
1362
- 500: {
1363
- headers: {
1364
- [name: string]: unknown;
1365
- };
1366
- content: {
1367
- "text/plain": string;
1368
- };
1369
- };
1017
+ };
1018
+ /** Internal server error */
1019
+ 500: {
1020
+ content: {
1021
+ "text/plain": string;
1370
1022
  };
1023
+ };
1371
1024
  };
1372
- getSignupRequestNotification: {
1373
- parameters: {
1374
- query?: never;
1375
- header?: never;
1376
- path?: never;
1377
- cookie?: never;
1025
+ };
1026
+ getSignupRequestNotification: {
1027
+ responses: {
1028
+ /** Signup request notification payload */
1029
+ 200: {
1030
+ content: {
1031
+ "application/json": { [key: string]: unknown };
1032
+ };
1033
+ };
1034
+ /** No pending signup request notifications */
1035
+ 204: never;
1036
+ /** Expired JWT token used or insufficient privilege */
1037
+ 401: {
1038
+ content: {
1039
+ "text/plain": string;
1378
1040
  };
1379
- requestBody?: never;
1380
- responses: {
1381
- /** @description Signup request notification payload */
1382
- 200: {
1383
- headers: {
1384
- [name: string]: unknown;
1385
- };
1386
- content: {
1387
- "application/json": {
1388
- [key: string]: unknown;
1389
- };
1390
- };
1391
- };
1392
- /** @description No pending signup request notifications */
1393
- 204: {
1394
- headers: {
1395
- [name: string]: unknown;
1396
- };
1397
- content?: never;
1398
- };
1399
- /** @description Expired JWT token used or insufficient privilege */
1400
- 401: {
1401
- headers: {
1402
- [name: string]: unknown;
1403
- };
1404
- content: {
1405
- "text/plain": string;
1406
- };
1407
- };
1408
- /** @description Internal server error */
1409
- 500: {
1410
- headers: {
1411
- [name: string]: unknown;
1412
- };
1413
- content: {
1414
- "text/plain": string;
1415
- };
1416
- };
1041
+ };
1042
+ /** Internal server error */
1043
+ 500: {
1044
+ content: {
1045
+ "text/plain": string;
1417
1046
  };
1047
+ };
1418
1048
  };
1049
+ };
1419
1050
  }
1051
+
1052
+ export interface external {}