@meshery/schemas 1.2.14 → 1.2.16

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 (151) hide show
  1. package/dist/cloudApi.d.mts +1516 -1516
  2. package/dist/cloudApi.d.ts +1516 -1516
  3. package/dist/constructs/v1alpha1/capability/Capability.d.ts +114 -0
  4. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +2 -0
  5. package/dist/constructs/v1alpha1/core/Core.d.ts +832 -0
  6. package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +2 -0
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +53 -0
  8. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +2 -0
  9. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1937 -0
  10. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +2 -0
  11. package/dist/constructs/v1beta1/academy/Academy.d.ts +6417 -0
  12. package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +2 -0
  13. package/dist/constructs/v1beta1/badge/Badge.d.ts +546 -0
  14. package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +2 -0
  15. package/dist/constructs/v1beta1/capability/Capability.d.ts +114 -0
  16. package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts +2 -0
  17. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +53 -0
  18. package/dist/constructs/v1beta1/catalog/CatalogSchema.d.ts +2 -0
  19. package/dist/constructs/v1beta1/category/Category.d.ts +46 -0
  20. package/dist/constructs/v1beta1/category/CategorySchema.d.ts +2 -0
  21. package/dist/constructs/v1beta1/component/Component.d.ts +869 -0
  22. package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +2 -0
  23. package/dist/constructs/v1beta1/connection/Connection.d.ts +1300 -0
  24. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +2 -0
  25. package/dist/constructs/v1beta1/core/Core.d.ts +832 -0
  26. package/dist/constructs/v1beta1/core/CoreSchema.d.ts +2 -0
  27. package/dist/constructs/v1beta1/credential/Credential.d.ts +530 -0
  28. package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +2 -0
  29. package/dist/constructs/v1beta1/environment/Environment.d.ts +759 -0
  30. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +2 -0
  31. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6338 -0
  32. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +2 -0
  33. package/dist/constructs/v1beta1/event/Event.d.ts +570 -0
  34. package/dist/constructs/v1beta1/event/EventSchema.d.ts +2 -0
  35. package/dist/constructs/v1beta1/feature/Feature.d.ts +308 -0
  36. package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +2 -0
  37. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +983 -0
  38. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +2 -0
  39. package/dist/constructs/v1beta1/key/Key.d.ts +514 -0
  40. package/dist/constructs/v1beta1/key/KeySchema.d.ts +2 -0
  41. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +642 -0
  42. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +2 -0
  43. package/dist/constructs/v1beta1/model/Model.d.ts +659 -0
  44. package/dist/constructs/v1beta1/model/ModelSchema.d.ts +2 -0
  45. package/dist/constructs/v1beta1/organization/Organization.d.ts +1598 -0
  46. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +2 -0
  47. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +18407 -0
  48. package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +2 -0
  49. package/dist/constructs/v1beta1/plan/Plan.d.ts +149 -0
  50. package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +2 -0
  51. package/dist/constructs/v1beta1/relationship/Relationship.d.ts +1921 -0
  52. package/dist/constructs/v1beta1/relationship/RelationshipSchema.d.ts +2 -0
  53. package/dist/constructs/v1beta1/role/Role.d.ts +745 -0
  54. package/dist/constructs/v1beta1/role/RoleSchema.d.ts +2 -0
  55. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +374 -0
  56. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +2 -0
  57. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +68 -0
  58. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +2 -0
  59. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +752 -0
  60. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +2 -0
  61. package/dist/constructs/v1beta1/support/Support.d.ts +91 -0
  62. package/dist/constructs/v1beta1/support/SupportSchema.d.ts +2 -0
  63. package/dist/constructs/v1beta1/team/Team.d.ts +846 -0
  64. package/dist/constructs/v1beta1/team/TeamSchema.d.ts +2 -0
  65. package/dist/constructs/v1beta1/token/Token.d.ts +539 -0
  66. package/dist/constructs/v1beta1/token/TokenSchema.d.ts +2 -0
  67. package/dist/constructs/v1beta1/user/User.d.ts +1677 -0
  68. package/dist/constructs/v1beta1/user/UserSchema.d.ts +2 -0
  69. package/dist/constructs/v1beta1/view/View.d.ts +759 -0
  70. package/dist/constructs/v1beta1/view/ViewSchema.d.ts +2 -0
  71. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4947 -0
  72. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +2 -0
  73. package/dist/constructs/v1beta2/academy/Academy.d.ts +7762 -0
  74. package/dist/constructs/v1beta2/academy/AcademySchema.d.ts +2 -0
  75. package/dist/constructs/v1beta2/badge/Badge.d.ts +563 -0
  76. package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +2 -0
  77. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +53 -0
  78. package/dist/constructs/v1beta2/catalog/CatalogSchema.d.ts +2 -0
  79. package/dist/constructs/v1beta2/component/Component.d.ts +887 -0
  80. package/dist/constructs/v1beta2/component/ComponentSchema.d.ts +2 -0
  81. package/dist/constructs/v1beta2/connection/Connection.d.ts +1330 -0
  82. package/dist/constructs/v1beta2/connection/ConnectionSchema.d.ts +2 -0
  83. package/dist/constructs/v1beta2/core/Core.d.ts +866 -0
  84. package/dist/constructs/v1beta2/core/CoreSchema.d.ts +2 -0
  85. package/dist/constructs/v1beta2/credential/Credential.d.ts +519 -0
  86. package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +2 -0
  87. package/dist/constructs/v1beta2/design/Design.d.ts +19039 -0
  88. package/dist/constructs/v1beta2/design/DesignSchema.d.ts +2 -0
  89. package/dist/constructs/v1beta2/event/Event.d.ts +626 -0
  90. package/dist/constructs/v1beta2/event/EventSchema.d.ts +2 -0
  91. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1052 -0
  92. package/dist/constructs/v1beta2/invitation/InvitationSchema.d.ts +2 -0
  93. package/dist/constructs/v1beta2/key/Key.d.ts +524 -0
  94. package/dist/constructs/v1beta2/key/KeySchema.d.ts +2 -0
  95. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +652 -0
  96. package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +2 -0
  97. package/dist/constructs/v1beta2/model/Model.d.ts +697 -0
  98. package/dist/constructs/v1beta2/model/ModelSchema.d.ts +2 -0
  99. package/dist/constructs/v1beta2/organization/Organization.d.ts +1915 -0
  100. package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +2 -0
  101. package/dist/constructs/v1beta2/plan/Plan.d.ts +162 -0
  102. package/dist/constructs/v1beta2/plan/PlanSchema.d.ts +2 -0
  103. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2134 -0
  104. package/dist/constructs/v1beta2/relationship/RelationshipSchema.d.ts +2 -0
  105. package/dist/constructs/v1beta2/role/Role.d.ts +752 -0
  106. package/dist/constructs/v1beta2/role/RoleSchema.d.ts +2 -0
  107. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +431 -0
  108. package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +2 -0
  109. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +785 -0
  110. package/dist/constructs/v1beta2/subscription/SubscriptionSchema.d.ts +2 -0
  111. package/dist/constructs/v1beta2/team/Team.d.ts +960 -0
  112. package/dist/constructs/v1beta2/team/TeamSchema.d.ts +2 -0
  113. package/dist/constructs/v1beta2/token/Token.d.ts +544 -0
  114. package/dist/constructs/v1beta2/token/TokenSchema.d.ts +2 -0
  115. package/dist/constructs/v1beta2/user/User.d.ts +1677 -0
  116. package/dist/constructs/v1beta2/user/UserSchema.d.ts +2 -0
  117. package/dist/constructs/v1beta2/view/View.d.ts +767 -0
  118. package/dist/constructs/v1beta2/view/ViewSchema.d.ts +2 -0
  119. package/dist/constructs/v1beta3/academy/Academy.d.ts +7762 -0
  120. package/dist/constructs/v1beta3/academy/AcademySchema.d.ts +2 -0
  121. package/dist/constructs/v1beta3/component/Component.d.ts +892 -0
  122. package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +2 -0
  123. package/dist/constructs/v1beta3/connection/Connection.d.ts +1414 -0
  124. package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +2 -0
  125. package/dist/constructs/v1beta3/design/Design.d.ts +5704 -0
  126. package/dist/constructs/v1beta3/design/DesignSchema.d.ts +2 -0
  127. package/dist/constructs/v1beta3/environment/Environment.d.ts +785 -0
  128. package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +2 -0
  129. package/dist/constructs/v1beta3/event/Event.d.ts +720 -0
  130. package/dist/constructs/v1beta3/event/EventSchema.d.ts +2 -0
  131. package/dist/constructs/v1beta3/filter/Filter.d.ts +1452 -0
  132. package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +2 -0
  133. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1060 -0
  134. package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +2 -0
  135. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +813 -0
  136. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +2 -0
  137. package/dist/constructs/v1beta3/plan/Plan.d.ts +199 -0
  138. package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +2 -0
  139. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2134 -0
  140. package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +2 -0
  141. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +915 -0
  142. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +2 -0
  143. package/dist/constructs/v1beta3/token/Token.d.ts +544 -0
  144. package/dist/constructs/v1beta3/token/TokenSchema.d.ts +2 -0
  145. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5086 -0
  146. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +2 -0
  147. package/dist/index.js +1 -1
  148. package/dist/index.mjs +1 -1
  149. package/dist/mesheryApi.d.mts +546 -546
  150. package/dist/mesheryApi.d.ts +546 -546
  151. package/package.json +2 -2
@@ -0,0 +1,983 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
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
+ emails: string[];
64
+ /** @description ID of the organization to which the user is invited */
65
+ org_id: string;
66
+ /**
67
+ * Format: date-time
68
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
69
+ */
70
+ expires_at?: string;
71
+ /** @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 */
72
+ quota?: number;
73
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
74
+ accepted_by: string[];
75
+ roles: string[];
76
+ teams: string[];
77
+ /**
78
+ * @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.
79
+ * @enum {string}
80
+ */
81
+ status: "enabled" | "disabled";
82
+ /**
83
+ * Format: date-time
84
+ * @description Timestamp when the invitation was created
85
+ */
86
+ created_at: string;
87
+ /**
88
+ * Format: date-time
89
+ * @description Timestamp when the invitation was last updated
90
+ */
91
+ updated_at: string;
92
+ /**
93
+ * Format: date-time
94
+ * @description Timestamp when the invitation was deleted, if applicable
95
+ */
96
+ deleted_at: string;
97
+ }[];
98
+ /** @description Total number of invitations available */
99
+ total: number;
100
+ };
101
+ SignupRequest: { [key: string]: unknown };
102
+ SignupRequestsPage: {
103
+ page?: number;
104
+ page_size?: number;
105
+ total_count?: number;
106
+ data?: { [key: string]: unknown }[];
107
+ };
108
+ /** @description Payload for creating or updating an invitation. */
109
+ InvitationPayload: {
110
+ /**
111
+ * Format: uuid
112
+ * @description Existing invitation ID for updates; omit on create.
113
+ */
114
+ id?: string;
115
+ /**
116
+ * Format: uuid
117
+ * @description ID of the user who created the invitation.
118
+ */
119
+ owner_id?: string;
120
+ /** @description Indicates whether the invitation is a default invitation (open invite). */
121
+ is_default?: boolean;
122
+ /** @description Name of the invitation. */
123
+ name: string;
124
+ /** @description Description of the invitation. */
125
+ description: string;
126
+ emails: string[];
127
+ /** @description ID of the organization to which the user is invited. */
128
+ org_id: string;
129
+ /**
130
+ * Format: date-time
131
+ * @description Timestamp when the invitation expires, if applicable.
132
+ */
133
+ expires_at?: string;
134
+ /** @description Quota for the invitation. */
135
+ quota?: number;
136
+ roles: string[];
137
+ teams: string[];
138
+ /**
139
+ * @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.
140
+ * @enum {string}
141
+ */
142
+ status: "enabled" | "disabled";
143
+ };
144
+ /**
145
+ * @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.
146
+ * @enum {string}
147
+ */
148
+ InvitationStatus: "enabled" | "disabled";
149
+ Invitation: {
150
+ /**
151
+ * Format: uuid
152
+ * @description Unique identifier for the invitation , is also used as the invitation code
153
+ */
154
+ id: string;
155
+ /**
156
+ * Format: uuid
157
+ * @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
158
+ */
159
+ owner_id: string;
160
+ /** @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 */
161
+ is_default?: boolean;
162
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
163
+ name: string;
164
+ /** @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 */
165
+ description: string;
166
+ emails: string[];
167
+ /** @description ID of the organization to which the user is invited */
168
+ org_id: string;
169
+ /**
170
+ * Format: date-time
171
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
172
+ */
173
+ expires_at?: string;
174
+ /** @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 */
175
+ quota?: number;
176
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
177
+ accepted_by: string[];
178
+ roles: string[];
179
+ teams: string[];
180
+ /**
181
+ * @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.
182
+ * @enum {string}
183
+ */
184
+ status: "enabled" | "disabled";
185
+ /**
186
+ * Format: date-time
187
+ * @description Timestamp when the invitation was created
188
+ */
189
+ created_at: string;
190
+ /**
191
+ * Format: date-time
192
+ * @description Timestamp when the invitation was last updated
193
+ */
194
+ updated_at: string;
195
+ /**
196
+ * Format: date-time
197
+ * @description Timestamp when the invitation was deleted, if applicable
198
+ */
199
+ deleted_at: string;
200
+ };
201
+ };
202
+ responses: {
203
+ /** Invalid request body or request param */
204
+ 400: {
205
+ content: {
206
+ "text/plain": string;
207
+ };
208
+ };
209
+ /** Expired JWT token used or insufficient privilege */
210
+ 401: {
211
+ content: {
212
+ "text/plain": string;
213
+ };
214
+ };
215
+ /** Result not found */
216
+ 404: {
217
+ content: {
218
+ "text/plain": string;
219
+ };
220
+ };
221
+ /** Internal server error */
222
+ 500: {
223
+ content: {
224
+ "text/plain": string;
225
+ };
226
+ };
227
+ };
228
+ parameters: {
229
+ /** @description The ID of the organization */
230
+ organization_id: string;
231
+ /** @description The ID of the invitation */
232
+ invitation_id: string;
233
+ };
234
+ }
235
+
236
+ export interface operations {
237
+ getInvitation: {
238
+ parameters: {
239
+ path: {
240
+ /** The ID of the invitation */
241
+ invitationId: string;
242
+ };
243
+ };
244
+ responses: {
245
+ 200: {
246
+ content: {
247
+ "application/json": {
248
+ /**
249
+ * Format: uuid
250
+ * @description Unique identifier for the invitation , is also used as the invitation code
251
+ */
252
+ id: string;
253
+ /**
254
+ * Format: uuid
255
+ * @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
256
+ */
257
+ owner_id: string;
258
+ /** @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 */
259
+ is_default?: boolean;
260
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
261
+ name: string;
262
+ /** @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 */
263
+ description: string;
264
+ emails: string[];
265
+ /** @description ID of the organization to which the user is invited */
266
+ org_id: string;
267
+ /**
268
+ * Format: date-time
269
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
270
+ */
271
+ expires_at?: string;
272
+ /** @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 */
273
+ quota?: number;
274
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
275
+ accepted_by: string[];
276
+ roles: string[];
277
+ teams: string[];
278
+ /**
279
+ * @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.
280
+ * @enum {string}
281
+ */
282
+ status: "enabled" | "disabled";
283
+ /**
284
+ * Format: date-time
285
+ * @description Timestamp when the invitation was created
286
+ */
287
+ created_at: string;
288
+ /**
289
+ * Format: date-time
290
+ * @description Timestamp when the invitation was last updated
291
+ */
292
+ updated_at: string;
293
+ /**
294
+ * Format: date-time
295
+ * @description Timestamp when the invitation was deleted, if applicable
296
+ */
297
+ deleted_at: string;
298
+ };
299
+ };
300
+ };
301
+ /** Invalid request body or request param */
302
+ 400: {
303
+ content: {
304
+ "text/plain": string;
305
+ };
306
+ };
307
+ /** Expired JWT token used or insufficient privilege */
308
+ 401: {
309
+ content: {
310
+ "text/plain": string;
311
+ };
312
+ };
313
+ /** Result not found */
314
+ 404: {
315
+ content: {
316
+ "text/plain": string;
317
+ };
318
+ };
319
+ /** Internal server error */
320
+ 500: {
321
+ content: {
322
+ "text/plain": string;
323
+ };
324
+ };
325
+ };
326
+ };
327
+ updateInvitation: {
328
+ parameters: {
329
+ path: {
330
+ /** The ID of the invitation */
331
+ invitationId: string;
332
+ };
333
+ };
334
+ responses: {
335
+ 200: {
336
+ content: {
337
+ "application/json": {
338
+ /**
339
+ * Format: uuid
340
+ * @description Unique identifier for the invitation , is also used as the invitation code
341
+ */
342
+ id: string;
343
+ /**
344
+ * Format: uuid
345
+ * @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
346
+ */
347
+ owner_id: string;
348
+ /** @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 */
349
+ is_default?: boolean;
350
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
351
+ name: string;
352
+ /** @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 */
353
+ description: string;
354
+ emails: string[];
355
+ /** @description ID of the organization to which the user is invited */
356
+ org_id: string;
357
+ /**
358
+ * Format: date-time
359
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
360
+ */
361
+ expires_at?: string;
362
+ /** @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 */
363
+ quota?: number;
364
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
365
+ accepted_by: string[];
366
+ roles: string[];
367
+ teams: string[];
368
+ /**
369
+ * @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.
370
+ * @enum {string}
371
+ */
372
+ status: "enabled" | "disabled";
373
+ /**
374
+ * Format: date-time
375
+ * @description Timestamp when the invitation was created
376
+ */
377
+ created_at: string;
378
+ /**
379
+ * Format: date-time
380
+ * @description Timestamp when the invitation was last updated
381
+ */
382
+ updated_at: string;
383
+ /**
384
+ * Format: date-time
385
+ * @description Timestamp when the invitation was deleted, if applicable
386
+ */
387
+ deleted_at: string;
388
+ };
389
+ };
390
+ };
391
+ /** Invalid request body or request param */
392
+ 400: {
393
+ content: {
394
+ "text/plain": string;
395
+ };
396
+ };
397
+ /** Expired JWT token used or insufficient privilege */
398
+ 401: {
399
+ content: {
400
+ "text/plain": string;
401
+ };
402
+ };
403
+ /** Result not found */
404
+ 404: {
405
+ content: {
406
+ "text/plain": string;
407
+ };
408
+ };
409
+ /** Internal server error */
410
+ 500: {
411
+ content: {
412
+ "text/plain": string;
413
+ };
414
+ };
415
+ };
416
+ requestBody: {
417
+ content: {
418
+ "application/json": {
419
+ /**
420
+ * Format: uuid
421
+ * @description Existing invitation ID for updates; omit on create.
422
+ */
423
+ id?: string;
424
+ /**
425
+ * Format: uuid
426
+ * @description ID of the user who created the invitation.
427
+ */
428
+ owner_id?: string;
429
+ /** @description Indicates whether the invitation is a default invitation (open invite). */
430
+ is_default?: boolean;
431
+ /** @description Name of the invitation. */
432
+ name: string;
433
+ /** @description Description of the invitation. */
434
+ description: string;
435
+ emails: string[];
436
+ /** @description ID of the organization to which the user is invited. */
437
+ org_id: string;
438
+ /**
439
+ * Format: date-time
440
+ * @description Timestamp when the invitation expires, if applicable.
441
+ */
442
+ expires_at?: string;
443
+ /** @description Quota for the invitation. */
444
+ quota?: number;
445
+ roles: string[];
446
+ teams: string[];
447
+ /**
448
+ * @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.
449
+ * @enum {string}
450
+ */
451
+ status: "enabled" | "disabled";
452
+ };
453
+ };
454
+ };
455
+ };
456
+ deleteInvitation: {
457
+ parameters: {
458
+ path: {
459
+ /** The ID of the invitation */
460
+ invitationId: string;
461
+ };
462
+ };
463
+ responses: {
464
+ /** Invitation deleted */
465
+ 204: never;
466
+ /** Invalid request body or request param */
467
+ 400: {
468
+ content: {
469
+ "text/plain": string;
470
+ };
471
+ };
472
+ /** Expired JWT token used or insufficient privilege */
473
+ 401: {
474
+ content: {
475
+ "text/plain": string;
476
+ };
477
+ };
478
+ /** Result not found */
479
+ 404: {
480
+ content: {
481
+ "text/plain": string;
482
+ };
483
+ };
484
+ /** Internal server error */
485
+ 500: {
486
+ content: {
487
+ "text/plain": string;
488
+ };
489
+ };
490
+ };
491
+ };
492
+ getInvitations: {
493
+ responses: {
494
+ 200: {
495
+ content: {
496
+ "application/json": {
497
+ /** @description List of invitations */
498
+ data: {
499
+ /**
500
+ * Format: uuid
501
+ * @description Unique identifier for the invitation , is also used as the invitation code
502
+ */
503
+ id: string;
504
+ /**
505
+ * Format: uuid
506
+ * @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
507
+ */
508
+ owner_id: string;
509
+ /** @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 */
510
+ is_default?: boolean;
511
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
512
+ name: string;
513
+ /** @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 */
514
+ description: string;
515
+ emails: string[];
516
+ /** @description ID of the organization to which the user is invited */
517
+ org_id: string;
518
+ /**
519
+ * Format: date-time
520
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
521
+ */
522
+ expires_at?: string;
523
+ /** @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 */
524
+ quota?: number;
525
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
526
+ accepted_by: string[];
527
+ roles: string[];
528
+ teams: string[];
529
+ /**
530
+ * @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.
531
+ * @enum {string}
532
+ */
533
+ status: "enabled" | "disabled";
534
+ /**
535
+ * Format: date-time
536
+ * @description Timestamp when the invitation was created
537
+ */
538
+ created_at: string;
539
+ /**
540
+ * Format: date-time
541
+ * @description Timestamp when the invitation was last updated
542
+ */
543
+ updated_at: string;
544
+ /**
545
+ * Format: date-time
546
+ * @description Timestamp when the invitation was deleted, if applicable
547
+ */
548
+ deleted_at: string;
549
+ }[];
550
+ /** @description Total number of invitations available */
551
+ total: number;
552
+ };
553
+ };
554
+ };
555
+ /** Invalid request body or request param */
556
+ 400: {
557
+ content: {
558
+ "text/plain": string;
559
+ };
560
+ };
561
+ /** Expired JWT token used or insufficient privilege */
562
+ 401: {
563
+ content: {
564
+ "text/plain": string;
565
+ };
566
+ };
567
+ /** Internal server error */
568
+ 500: {
569
+ content: {
570
+ "text/plain": string;
571
+ };
572
+ };
573
+ };
574
+ };
575
+ createInvitation: {
576
+ responses: {
577
+ 201: {
578
+ content: {
579
+ "application/json": {
580
+ /**
581
+ * Format: uuid
582
+ * @description Unique identifier for the invitation , is also used as the invitation code
583
+ */
584
+ id: string;
585
+ /**
586
+ * Format: uuid
587
+ * @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
588
+ */
589
+ owner_id: string;
590
+ /** @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 */
591
+ is_default?: boolean;
592
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
593
+ name: string;
594
+ /** @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 */
595
+ description: string;
596
+ emails: string[];
597
+ /** @description ID of the organization to which the user is invited */
598
+ org_id: string;
599
+ /**
600
+ * Format: date-time
601
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
602
+ */
603
+ expires_at?: string;
604
+ /** @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 */
605
+ quota?: number;
606
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
607
+ accepted_by: string[];
608
+ roles: string[];
609
+ teams: string[];
610
+ /**
611
+ * @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.
612
+ * @enum {string}
613
+ */
614
+ status: "enabled" | "disabled";
615
+ /**
616
+ * Format: date-time
617
+ * @description Timestamp when the invitation was created
618
+ */
619
+ created_at: string;
620
+ /**
621
+ * Format: date-time
622
+ * @description Timestamp when the invitation was last updated
623
+ */
624
+ updated_at: string;
625
+ /**
626
+ * Format: date-time
627
+ * @description Timestamp when the invitation was deleted, if applicable
628
+ */
629
+ deleted_at: string;
630
+ };
631
+ };
632
+ };
633
+ /** Invalid request body or request param */
634
+ 400: {
635
+ content: {
636
+ "text/plain": string;
637
+ };
638
+ };
639
+ /** Expired JWT token used or insufficient privilege */
640
+ 401: {
641
+ content: {
642
+ "text/plain": string;
643
+ };
644
+ };
645
+ /** Internal server error */
646
+ 500: {
647
+ content: {
648
+ "text/plain": string;
649
+ };
650
+ };
651
+ };
652
+ requestBody: {
653
+ content: {
654
+ "application/json": {
655
+ /**
656
+ * Format: uuid
657
+ * @description Existing invitation ID for updates; omit on create.
658
+ */
659
+ id?: string;
660
+ /**
661
+ * Format: uuid
662
+ * @description ID of the user who created the invitation.
663
+ */
664
+ owner_id?: string;
665
+ /** @description Indicates whether the invitation is a default invitation (open invite). */
666
+ is_default?: boolean;
667
+ /** @description Name of the invitation. */
668
+ name: string;
669
+ /** @description Description of the invitation. */
670
+ description: string;
671
+ emails: string[];
672
+ /** @description ID of the organization to which the user is invited. */
673
+ org_id: string;
674
+ /**
675
+ * Format: date-time
676
+ * @description Timestamp when the invitation expires, if applicable.
677
+ */
678
+ expires_at?: string;
679
+ /** @description Quota for the invitation. */
680
+ quota?: number;
681
+ roles: string[];
682
+ teams: string[];
683
+ /**
684
+ * @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.
685
+ * @enum {string}
686
+ */
687
+ status: "enabled" | "disabled";
688
+ };
689
+ };
690
+ };
691
+ };
692
+ acceptInvitation: {
693
+ parameters: {
694
+ path: {
695
+ /** The ID of the invitation */
696
+ invitationId: string;
697
+ };
698
+ };
699
+ responses: {
700
+ 200: {
701
+ content: {
702
+ "application/json": {
703
+ /**
704
+ * Format: uuid
705
+ * @description Unique identifier for the invitation , is also used as the invitation code
706
+ */
707
+ id: string;
708
+ /**
709
+ * Format: uuid
710
+ * @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
711
+ */
712
+ owner_id: string;
713
+ /** @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 */
714
+ is_default?: boolean;
715
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
716
+ name: string;
717
+ /** @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 */
718
+ description: string;
719
+ emails: string[];
720
+ /** @description ID of the organization to which the user is invited */
721
+ org_id: string;
722
+ /**
723
+ * Format: date-time
724
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
725
+ */
726
+ expires_at?: string;
727
+ /** @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 */
728
+ quota?: number;
729
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
730
+ accepted_by: string[];
731
+ roles: string[];
732
+ teams: string[];
733
+ /**
734
+ * @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.
735
+ * @enum {string}
736
+ */
737
+ status: "enabled" | "disabled";
738
+ /**
739
+ * Format: date-time
740
+ * @description Timestamp when the invitation was created
741
+ */
742
+ created_at: string;
743
+ /**
744
+ * Format: date-time
745
+ * @description Timestamp when the invitation was last updated
746
+ */
747
+ updated_at: string;
748
+ /**
749
+ * Format: date-time
750
+ * @description Timestamp when the invitation was deleted, if applicable
751
+ */
752
+ deleted_at: string;
753
+ };
754
+ };
755
+ };
756
+ /** Invalid request body or request param */
757
+ 400: {
758
+ content: {
759
+ "text/plain": string;
760
+ };
761
+ };
762
+ /** Expired JWT token used or insufficient privilege */
763
+ 401: {
764
+ content: {
765
+ "text/plain": string;
766
+ };
767
+ };
768
+ /** Result not found */
769
+ 404: {
770
+ content: {
771
+ "text/plain": string;
772
+ };
773
+ };
774
+ /** Internal server error */
775
+ 500: {
776
+ content: {
777
+ "text/plain": string;
778
+ };
779
+ };
780
+ };
781
+ };
782
+ handleUserInvite: {
783
+ parameters: {
784
+ path: {
785
+ /** The ID of the organization */
786
+ orgId: string;
787
+ };
788
+ };
789
+ responses: {
790
+ /** Invitation request accepted */
791
+ 200: {
792
+ content: {
793
+ "application/json": { [key: string]: unknown };
794
+ };
795
+ };
796
+ /** Invalid request body or request param */
797
+ 400: {
798
+ content: {
799
+ "text/plain": string;
800
+ };
801
+ };
802
+ /** Expired JWT token used or insufficient privilege */
803
+ 401: {
804
+ content: {
805
+ "text/plain": string;
806
+ };
807
+ };
808
+ /** Result not found */
809
+ 404: {
810
+ content: {
811
+ "text/plain": string;
812
+ };
813
+ };
814
+ /** Internal server error */
815
+ 500: {
816
+ content: {
817
+ "text/plain": string;
818
+ };
819
+ };
820
+ };
821
+ requestBody: {
822
+ content: {
823
+ "application/json": { [key: string]: unknown };
824
+ };
825
+ };
826
+ };
827
+ getSignupRequests: {
828
+ parameters: {
829
+ query: {
830
+ /** Get responses by page */
831
+ page?: string;
832
+ /** Get responses by pagesize */
833
+ pagesize?: string;
834
+ /** Get responses that match search param value */
835
+ search?: string;
836
+ /** Get ordered responses */
837
+ order?: string;
838
+ /** Get filtered reponses */
839
+ filter?: string;
840
+ };
841
+ };
842
+ responses: {
843
+ /** Signup requests page */
844
+ 200: {
845
+ content: {
846
+ "application/json": {
847
+ page?: number;
848
+ page_size?: number;
849
+ total_count?: number;
850
+ data?: { [key: string]: unknown }[];
851
+ };
852
+ };
853
+ };
854
+ /** Expired JWT token used or insufficient privilege */
855
+ 401: {
856
+ content: {
857
+ "text/plain": string;
858
+ };
859
+ };
860
+ /** Internal server error */
861
+ 500: {
862
+ content: {
863
+ "text/plain": string;
864
+ };
865
+ };
866
+ };
867
+ };
868
+ signupRequest: {
869
+ responses: {
870
+ /** Signup request created */
871
+ 200: {
872
+ content: {
873
+ "application/json": { [key: string]: unknown };
874
+ };
875
+ };
876
+ /** Invalid request body or request param */
877
+ 400: {
878
+ content: {
879
+ "text/plain": string;
880
+ };
881
+ };
882
+ /** Expired JWT token used or insufficient privilege */
883
+ 401: {
884
+ content: {
885
+ "text/plain": string;
886
+ };
887
+ };
888
+ /** Internal server error */
889
+ 500: {
890
+ content: {
891
+ "text/plain": string;
892
+ };
893
+ };
894
+ };
895
+ requestBody: {
896
+ content: {
897
+ "application/json": { [key: string]: unknown };
898
+ };
899
+ };
900
+ };
901
+ approveSignupRequest: {
902
+ responses: {
903
+ /** Signup request approved */
904
+ 200: {
905
+ content: {
906
+ "application/json": { [key: string]: unknown };
907
+ };
908
+ };
909
+ /** Invalid request body or request param */
910
+ 400: {
911
+ content: {
912
+ "text/plain": string;
913
+ };
914
+ };
915
+ /** Expired JWT token used or insufficient privilege */
916
+ 401: {
917
+ content: {
918
+ "text/plain": string;
919
+ };
920
+ };
921
+ /** Internal server error */
922
+ 500: {
923
+ content: {
924
+ "text/plain": string;
925
+ };
926
+ };
927
+ };
928
+ };
929
+ denySignupRequest: {
930
+ responses: {
931
+ /** Signup request denied */
932
+ 200: {
933
+ content: {
934
+ "application/json": { [key: string]: unknown };
935
+ };
936
+ };
937
+ /** Invalid request body or request param */
938
+ 400: {
939
+ content: {
940
+ "text/plain": string;
941
+ };
942
+ };
943
+ /** Expired JWT token used or insufficient privilege */
944
+ 401: {
945
+ content: {
946
+ "text/plain": string;
947
+ };
948
+ };
949
+ /** Internal server error */
950
+ 500: {
951
+ content: {
952
+ "text/plain": string;
953
+ };
954
+ };
955
+ };
956
+ };
957
+ getSignupRequestNotification: {
958
+ responses: {
959
+ /** Signup request notification payload */
960
+ 200: {
961
+ content: {
962
+ "application/json": { [key: string]: unknown };
963
+ };
964
+ };
965
+ /** No pending signup request notifications */
966
+ 204: never;
967
+ /** Expired JWT token used or insufficient privilege */
968
+ 401: {
969
+ content: {
970
+ "text/plain": string;
971
+ };
972
+ };
973
+ /** Internal server error */
974
+ 500: {
975
+ content: {
976
+ "text/plain": string;
977
+ };
978
+ };
979
+ };
980
+ };
981
+ }
982
+
983
+ export interface external {}