@meshery/schemas 1.2.15 → 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 (147) hide show
  1. package/dist/constructs/v1alpha1/capability/Capability.d.ts +114 -0
  2. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +2 -0
  3. package/dist/constructs/v1alpha1/core/Core.d.ts +832 -0
  4. package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +2 -0
  5. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +53 -0
  6. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +2 -0
  7. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1937 -0
  8. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +2 -0
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6417 -0
  10. package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +2 -0
  11. package/dist/constructs/v1beta1/badge/Badge.d.ts +546 -0
  12. package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +2 -0
  13. package/dist/constructs/v1beta1/capability/Capability.d.ts +114 -0
  14. package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts +2 -0
  15. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +53 -0
  16. package/dist/constructs/v1beta1/catalog/CatalogSchema.d.ts +2 -0
  17. package/dist/constructs/v1beta1/category/Category.d.ts +46 -0
  18. package/dist/constructs/v1beta1/category/CategorySchema.d.ts +2 -0
  19. package/dist/constructs/v1beta1/component/Component.d.ts +869 -0
  20. package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +2 -0
  21. package/dist/constructs/v1beta1/connection/Connection.d.ts +1300 -0
  22. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +2 -0
  23. package/dist/constructs/v1beta1/core/Core.d.ts +832 -0
  24. package/dist/constructs/v1beta1/core/CoreSchema.d.ts +2 -0
  25. package/dist/constructs/v1beta1/credential/Credential.d.ts +530 -0
  26. package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +2 -0
  27. package/dist/constructs/v1beta1/environment/Environment.d.ts +759 -0
  28. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +2 -0
  29. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6338 -0
  30. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +2 -0
  31. package/dist/constructs/v1beta1/event/Event.d.ts +570 -0
  32. package/dist/constructs/v1beta1/event/EventSchema.d.ts +2 -0
  33. package/dist/constructs/v1beta1/feature/Feature.d.ts +308 -0
  34. package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +2 -0
  35. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +983 -0
  36. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +2 -0
  37. package/dist/constructs/v1beta1/key/Key.d.ts +514 -0
  38. package/dist/constructs/v1beta1/key/KeySchema.d.ts +2 -0
  39. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +642 -0
  40. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +2 -0
  41. package/dist/constructs/v1beta1/model/Model.d.ts +659 -0
  42. package/dist/constructs/v1beta1/model/ModelSchema.d.ts +2 -0
  43. package/dist/constructs/v1beta1/organization/Organization.d.ts +1598 -0
  44. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +2 -0
  45. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +18407 -0
  46. package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +2 -0
  47. package/dist/constructs/v1beta1/plan/Plan.d.ts +149 -0
  48. package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +2 -0
  49. package/dist/constructs/v1beta1/relationship/Relationship.d.ts +1921 -0
  50. package/dist/constructs/v1beta1/relationship/RelationshipSchema.d.ts +2 -0
  51. package/dist/constructs/v1beta1/role/Role.d.ts +745 -0
  52. package/dist/constructs/v1beta1/role/RoleSchema.d.ts +2 -0
  53. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +374 -0
  54. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +2 -0
  55. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +68 -0
  56. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +2 -0
  57. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +752 -0
  58. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +2 -0
  59. package/dist/constructs/v1beta1/support/Support.d.ts +91 -0
  60. package/dist/constructs/v1beta1/support/SupportSchema.d.ts +2 -0
  61. package/dist/constructs/v1beta1/team/Team.d.ts +846 -0
  62. package/dist/constructs/v1beta1/team/TeamSchema.d.ts +2 -0
  63. package/dist/constructs/v1beta1/token/Token.d.ts +539 -0
  64. package/dist/constructs/v1beta1/token/TokenSchema.d.ts +2 -0
  65. package/dist/constructs/v1beta1/user/User.d.ts +1677 -0
  66. package/dist/constructs/v1beta1/user/UserSchema.d.ts +2 -0
  67. package/dist/constructs/v1beta1/view/View.d.ts +759 -0
  68. package/dist/constructs/v1beta1/view/ViewSchema.d.ts +2 -0
  69. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4947 -0
  70. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +2 -0
  71. package/dist/constructs/v1beta2/academy/Academy.d.ts +7762 -0
  72. package/dist/constructs/v1beta2/academy/AcademySchema.d.ts +2 -0
  73. package/dist/constructs/v1beta2/badge/Badge.d.ts +563 -0
  74. package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +2 -0
  75. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +53 -0
  76. package/dist/constructs/v1beta2/catalog/CatalogSchema.d.ts +2 -0
  77. package/dist/constructs/v1beta2/component/Component.d.ts +887 -0
  78. package/dist/constructs/v1beta2/component/ComponentSchema.d.ts +2 -0
  79. package/dist/constructs/v1beta2/connection/Connection.d.ts +1330 -0
  80. package/dist/constructs/v1beta2/connection/ConnectionSchema.d.ts +2 -0
  81. package/dist/constructs/v1beta2/core/Core.d.ts +866 -0
  82. package/dist/constructs/v1beta2/core/CoreSchema.d.ts +2 -0
  83. package/dist/constructs/v1beta2/credential/Credential.d.ts +519 -0
  84. package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +2 -0
  85. package/dist/constructs/v1beta2/design/Design.d.ts +19039 -0
  86. package/dist/constructs/v1beta2/design/DesignSchema.d.ts +2 -0
  87. package/dist/constructs/v1beta2/event/Event.d.ts +626 -0
  88. package/dist/constructs/v1beta2/event/EventSchema.d.ts +2 -0
  89. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1052 -0
  90. package/dist/constructs/v1beta2/invitation/InvitationSchema.d.ts +2 -0
  91. package/dist/constructs/v1beta2/key/Key.d.ts +524 -0
  92. package/dist/constructs/v1beta2/key/KeySchema.d.ts +2 -0
  93. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +652 -0
  94. package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +2 -0
  95. package/dist/constructs/v1beta2/model/Model.d.ts +697 -0
  96. package/dist/constructs/v1beta2/model/ModelSchema.d.ts +2 -0
  97. package/dist/constructs/v1beta2/organization/Organization.d.ts +1915 -0
  98. package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +2 -0
  99. package/dist/constructs/v1beta2/plan/Plan.d.ts +162 -0
  100. package/dist/constructs/v1beta2/plan/PlanSchema.d.ts +2 -0
  101. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2134 -0
  102. package/dist/constructs/v1beta2/relationship/RelationshipSchema.d.ts +2 -0
  103. package/dist/constructs/v1beta2/role/Role.d.ts +752 -0
  104. package/dist/constructs/v1beta2/role/RoleSchema.d.ts +2 -0
  105. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +431 -0
  106. package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +2 -0
  107. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +785 -0
  108. package/dist/constructs/v1beta2/subscription/SubscriptionSchema.d.ts +2 -0
  109. package/dist/constructs/v1beta2/team/Team.d.ts +960 -0
  110. package/dist/constructs/v1beta2/team/TeamSchema.d.ts +2 -0
  111. package/dist/constructs/v1beta2/token/Token.d.ts +544 -0
  112. package/dist/constructs/v1beta2/token/TokenSchema.d.ts +2 -0
  113. package/dist/constructs/v1beta2/user/User.d.ts +1677 -0
  114. package/dist/constructs/v1beta2/user/UserSchema.d.ts +2 -0
  115. package/dist/constructs/v1beta2/view/View.d.ts +767 -0
  116. package/dist/constructs/v1beta2/view/ViewSchema.d.ts +2 -0
  117. package/dist/constructs/v1beta3/academy/Academy.d.ts +7762 -0
  118. package/dist/constructs/v1beta3/academy/AcademySchema.d.ts +2 -0
  119. package/dist/constructs/v1beta3/component/Component.d.ts +892 -0
  120. package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +2 -0
  121. package/dist/constructs/v1beta3/connection/Connection.d.ts +1414 -0
  122. package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +2 -0
  123. package/dist/constructs/v1beta3/design/Design.d.ts +5704 -0
  124. package/dist/constructs/v1beta3/design/DesignSchema.d.ts +2 -0
  125. package/dist/constructs/v1beta3/environment/Environment.d.ts +785 -0
  126. package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +2 -0
  127. package/dist/constructs/v1beta3/event/Event.d.ts +720 -0
  128. package/dist/constructs/v1beta3/event/EventSchema.d.ts +2 -0
  129. package/dist/constructs/v1beta3/filter/Filter.d.ts +1452 -0
  130. package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +2 -0
  131. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1060 -0
  132. package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +2 -0
  133. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +813 -0
  134. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +2 -0
  135. package/dist/constructs/v1beta3/plan/Plan.d.ts +199 -0
  136. package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +2 -0
  137. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2134 -0
  138. package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +2 -0
  139. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +915 -0
  140. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +2 -0
  141. package/dist/constructs/v1beta3/token/Token.d.ts +544 -0
  142. package/dist/constructs/v1beta3/token/TokenSchema.d.ts +2 -0
  143. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5086 -0
  144. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +2 -0
  145. package/dist/index.js +1 -1
  146. package/dist/index.mjs +1 -1
  147. package/package.json +2 -2
@@ -0,0 +1,1052 @@
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
+ /** @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;
106
+ };
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 }[];
117
+ };
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";
159
+ };
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
+ };
249
+ };
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;
340
+ };
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
+ };
362
+ };
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;
442
+ };
443
+ };
444
+ /** Internal server error */
445
+ 500: {
446
+ content: {
447
+ "text/plain": string;
448
+ };
449
+ };
450
+ };
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";
493
+ };
494
+ };
495
+ };
496
+ };
497
+ deleteInvitation: {
498
+ parameters: {
499
+ path: {
500
+ /** The ID of the invitation */
501
+ invitationId: string;
502
+ };
503
+ };
504
+ responses: {
505
+ /** Invitation deleted */
506
+ 204: never;
507
+ /** Invalid request body or request param */
508
+ 400: {
509
+ content: {
510
+ "text/plain": string;
511
+ };
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
+ };
531
+ };
532
+ };
533
+ getInvitations: {
534
+ responses: {
535
+ 200: {
536
+ content: {
537
+ "application/json": {
538
+ /** @description List of invitations */
539
+ data: {
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;
596
+ }[];
597
+ /** @description Total number of invitations available */
598
+ total: number;
599
+ };
600
+ };
601
+ };
602
+ /** Invalid request body or request param */
603
+ 400: {
604
+ content: {
605
+ "text/plain": string;
606
+ };
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;
618
+ };
619
+ };
620
+ };
621
+ };
622
+ createInvitation: {
623
+ responses: {
624
+ 201: {
625
+ content: {
626
+ "application/json": {
627
+ /**
628
+ * Format: uuid
629
+ * @description Unique identifier for the invitation , is also used as the invitation code
630
+ */
631
+ id: string;
632
+ /**
633
+ * Format: uuid
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
635
+ */
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 */
638
+ is_default?: boolean;
639
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
640
+ name: string;
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 */
642
+ description: string;
643
+ /** @description The emails of the invitation. */
644
+ emails: string[];
645
+ /**
646
+ * Format: uuid
647
+ * @description ID of the organization to which the user is invited
648
+ */
649
+ org_id: string;
650
+ /**
651
+ * Format: date-time
652
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
653
+ */
654
+ expires_at?: string;
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 */
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[];
659
+ /** @description The roles of the invitation. */
660
+ roles: string[];
661
+ /** @description The teams of the invitation. */
662
+ teams: string[];
663
+ /**
664
+ * @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.
665
+ * @enum {string}
666
+ */
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
+ };
684
+ };
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": {
762
+ /**
763
+ * Format: uuid
764
+ * @description Unique identifier for the invitation , is also used as the invitation code
765
+ */
766
+ id: string;
767
+ /**
768
+ * Format: uuid
769
+ * @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
770
+ */
771
+ owner_id: string;
772
+ /** @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 */
773
+ is_default?: boolean;
774
+ /** @description Name of the invitation, which can be used to identify the invitation, required and cant be empty string, */
775
+ name: string;
776
+ /** @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 */
777
+ description: string;
778
+ /** @description The emails of the invitation. */
779
+ emails: string[];
780
+ /**
781
+ * Format: uuid
782
+ * @description ID of the organization to which the user is invited
783
+ */
784
+ org_id: string;
785
+ /**
786
+ * Format: date-time
787
+ * @description Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
788
+ */
789
+ expires_at?: string;
790
+ /** @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 */
791
+ quota?: number;
792
+ /** @description List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet */
793
+ accepted_by: string[];
794
+ /** @description The roles of the invitation. */
795
+ roles: string[];
796
+ /** @description The teams of the invitation. */
797
+ teams: string[];
798
+ /**
799
+ * @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.
800
+ * @enum {string}
801
+ */
802
+ status: "enabled" | "disabled";
803
+ /**
804
+ * Format: date-time
805
+ * @description Timestamp when the invitation was created
806
+ */
807
+ created_at: string;
808
+ /**
809
+ * Format: date-time
810
+ * @description Timestamp when the invitation was last updated
811
+ */
812
+ updated_at: string;
813
+ /**
814
+ * Format: date-time
815
+ * @description Timestamp when the invitation was deleted, if applicable
816
+ */
817
+ deleted_at: string;
818
+ };
819
+ };
820
+ };
821
+ /** Invalid request body or request param */
822
+ 400: {
823
+ content: {
824
+ "text/plain": string;
825
+ };
826
+ };
827
+ /** Expired JWT token used or insufficient privilege */
828
+ 401: {
829
+ content: {
830
+ "text/plain": string;
831
+ };
832
+ };
833
+ /** Result not found */
834
+ 404: {
835
+ content: {
836
+ "text/plain": string;
837
+ };
838
+ };
839
+ /** Internal server error */
840
+ 500: {
841
+ content: {
842
+ "text/plain": string;
843
+ };
844
+ };
845
+ };
846
+ };
847
+ handleUserInvite: {
848
+ parameters: {
849
+ path: {
850
+ /** The ID of the organization */
851
+ orgId: string;
852
+ };
853
+ };
854
+ responses: {
855
+ /** Invitation request accepted */
856
+ 200: {
857
+ content: {
858
+ "application/json": { [key: string]: unknown };
859
+ };
860
+ };
861
+ /** Invalid request body or request param */
862
+ 400: {
863
+ content: {
864
+ "text/plain": string;
865
+ };
866
+ };
867
+ /** Expired JWT token used or insufficient privilege */
868
+ 401: {
869
+ content: {
870
+ "text/plain": string;
871
+ };
872
+ };
873
+ /** Result not found */
874
+ 404: {
875
+ content: {
876
+ "text/plain": string;
877
+ };
878
+ };
879
+ /** Internal server error */
880
+ 500: {
881
+ content: {
882
+ "text/plain": string;
883
+ };
884
+ };
885
+ };
886
+ requestBody: {
887
+ content: {
888
+ "application/json": { [key: string]: unknown };
889
+ };
890
+ };
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
+ };
906
+ };
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
+ };
921
+ };
922
+ };
923
+ /** Expired JWT token used or insufficient privilege */
924
+ 401: {
925
+ content: {
926
+ "text/plain": string;
927
+ };
928
+ };
929
+ /** Internal server error */
930
+ 500: {
931
+ content: {
932
+ "text/plain": string;
933
+ };
934
+ };
935
+ };
936
+ };
937
+ signupRequest: {
938
+ responses: {
939
+ /** Signup request created */
940
+ 201: {
941
+ content: {
942
+ "application/json": { [key: string]: unknown };
943
+ };
944
+ };
945
+ /** Invalid request body or request param */
946
+ 400: {
947
+ content: {
948
+ "text/plain": string;
949
+ };
950
+ };
951
+ /** Expired JWT token used or insufficient privilege */
952
+ 401: {
953
+ content: {
954
+ "text/plain": string;
955
+ };
956
+ };
957
+ /** Internal server error */
958
+ 500: {
959
+ content: {
960
+ "text/plain": string;
961
+ };
962
+ };
963
+ };
964
+ requestBody: {
965
+ content: {
966
+ "application/json": { [key: string]: unknown };
967
+ };
968
+ };
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;
982
+ };
983
+ };
984
+ /** Expired JWT token used or insufficient privilege */
985
+ 401: {
986
+ content: {
987
+ "text/plain": string;
988
+ };
989
+ };
990
+ /** Internal server error */
991
+ 500: {
992
+ content: {
993
+ "text/plain": string;
994
+ };
995
+ };
996
+ };
997
+ };
998
+ denySignupRequest: {
999
+ responses: {
1000
+ /** Signup request denied */
1001
+ 200: {
1002
+ content: {
1003
+ "application/json": { [key: string]: unknown };
1004
+ };
1005
+ };
1006
+ /** Invalid request body or request param */
1007
+ 400: {
1008
+ content: {
1009
+ "text/plain": string;
1010
+ };
1011
+ };
1012
+ /** Expired JWT token used or insufficient privilege */
1013
+ 401: {
1014
+ content: {
1015
+ "text/plain": string;
1016
+ };
1017
+ };
1018
+ /** Internal server error */
1019
+ 500: {
1020
+ content: {
1021
+ "text/plain": string;
1022
+ };
1023
+ };
1024
+ };
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;
1040
+ };
1041
+ };
1042
+ /** Internal server error */
1043
+ 500: {
1044
+ content: {
1045
+ "text/plain": string;
1046
+ };
1047
+ };
1048
+ };
1049
+ };
1050
+ }
1051
+
1052
+ export interface external {}