@meshery/schemas 0.8.127 → 0.8.129

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 (159) hide show
  1. package/dist/{Core-vaTzd8cz.d.mts → Core-BiYtFM4v.d.mts} +1 -1
  2. package/dist/{Core-vaTzd8cz.d.ts → Core-BiYtFM4v.d.ts} +1 -1
  3. package/dist/cloudApi.d.mts +13676 -3825
  4. package/dist/cloudApi.d.ts +13676 -3825
  5. package/dist/cloudApi.js +1 -1
  6. package/dist/cloudApi.mjs +1 -1
  7. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.mts +1 -149
  8. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +1 -149
  9. package/dist/constructs/v1alpha1/capability/CapabilitySchema.js +1 -1
  10. package/dist/constructs/v1alpha1/capability/CapabilitySchema.mjs +1 -1
  11. package/dist/constructs/v1alpha1/core/Core.d.mts +1 -1
  12. package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
  13. package/dist/constructs/v1alpha1/core/CoreSchema.d.mts +1 -1643
  14. package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +1 -1643
  15. package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
  16. package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
  17. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.mts +1 -74
  18. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +1 -74
  19. package/dist/constructs/v1alpha2/catalog/CatalogSchema.js +1 -1
  20. package/dist/constructs/v1alpha2/catalog/CatalogSchema.mjs +1 -1
  21. package/dist/constructs/v1alpha3/relationship/Relationship.d.mts +32 -128
  22. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +32 -128
  23. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.mts +1 -6973
  24. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +1 -6973
  25. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.js +15 -15
  26. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.mjs +15 -15
  27. package/dist/constructs/v1beta1/academy/Academy.d.mts +749 -319
  28. package/dist/constructs/v1beta1/academy/Academy.d.ts +749 -319
  29. package/dist/constructs/v1beta1/academy/AcademySchema.d.mts +1 -11832
  30. package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +1 -11832
  31. package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
  32. package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
  33. package/dist/constructs/v1beta1/badge/BadgeSchema.d.mts +1 -513
  34. package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +1 -513
  35. package/dist/constructs/v1beta1/badge/BadgeSchema.js +1 -1
  36. package/dist/constructs/v1beta1/badge/BadgeSchema.mjs +1 -1
  37. package/dist/constructs/v1beta1/category/CategorySchema.d.mts +1 -54
  38. package/dist/constructs/v1beta1/category/CategorySchema.d.ts +1 -54
  39. package/dist/constructs/v1beta1/category/CategorySchema.js +1 -1
  40. package/dist/constructs/v1beta1/category/CategorySchema.mjs +1 -1
  41. package/dist/constructs/v1beta1/component/Component.d.mts +6 -12
  42. package/dist/constructs/v1beta1/component/Component.d.ts +6 -12
  43. package/dist/constructs/v1beta1/component/ComponentSchema.d.mts +1 -1771
  44. package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +1 -1771
  45. package/dist/constructs/v1beta1/component/ComponentSchema.js +3 -3
  46. package/dist/constructs/v1beta1/component/ComponentSchema.mjs +3 -3
  47. package/dist/constructs/v1beta1/connection/Connection.d.mts +12 -12
  48. package/dist/constructs/v1beta1/connection/Connection.d.ts +12 -12
  49. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.mts +1 -2978
  50. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +1 -2978
  51. package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
  52. package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
  53. package/dist/constructs/v1beta1/credential/Credential.d.mts +517 -0
  54. package/dist/constructs/v1beta1/credential/Credential.d.ts +517 -0
  55. package/dist/constructs/v1beta1/credential/Credential.js +1 -0
  56. package/dist/constructs/v1beta1/credential/Credential.mjs +0 -0
  57. package/dist/constructs/v1beta1/credential/CredentialSchema.d.mts +7 -0
  58. package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +7 -0
  59. package/dist/constructs/v1beta1/credential/CredentialSchema.js +9 -0
  60. package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +9 -0
  61. package/dist/constructs/v1beta1/environment/Environment.d.mts +4 -4
  62. package/dist/constructs/v1beta1/environment/Environment.d.ts +4 -4
  63. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.mts +1 -958
  64. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +1 -958
  65. package/dist/constructs/v1beta1/environment/EnvironmentSchema.js +1 -1
  66. package/dist/constructs/v1beta1/environment/EnvironmentSchema.mjs +1 -1
  67. package/dist/constructs/v1beta1/evaluation/Evaluation.d.mts +68 -212
  68. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +68 -212
  69. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.mts +1 -16507
  70. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +1 -16507
  71. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +25 -25
  72. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +25 -25
  73. package/dist/constructs/v1beta1/event/EventSchema.d.mts +1 -354
  74. package/dist/constructs/v1beta1/event/EventSchema.d.ts +1 -354
  75. package/dist/constructs/v1beta1/event/EventSchema.js +2 -1
  76. package/dist/constructs/v1beta1/event/EventSchema.mjs +2 -1
  77. package/dist/constructs/v1beta1/feature/FeatureSchema.d.mts +1 -767
  78. package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +1 -767
  79. package/dist/constructs/v1beta1/feature/FeatureSchema.js +2 -1
  80. package/dist/constructs/v1beta1/feature/FeatureSchema.mjs +2 -1
  81. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.mts +1 -1646
  82. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +1 -1646
  83. package/dist/constructs/v1beta1/invitation/InvitationSchema.js +2 -1
  84. package/dist/constructs/v1beta1/invitation/InvitationSchema.mjs +2 -1
  85. package/dist/constructs/v1beta1/key/KeySchema.d.mts +1 -1219
  86. package/dist/constructs/v1beta1/key/KeySchema.d.ts +1 -1219
  87. package/dist/constructs/v1beta1/key/KeySchema.js +2 -1
  88. package/dist/constructs/v1beta1/key/KeySchema.mjs +2 -1
  89. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.mts +1 -1543
  90. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +1 -1543
  91. package/dist/constructs/v1beta1/keychain/KeychainSchema.js +2 -1
  92. package/dist/constructs/v1beta1/keychain/KeychainSchema.mjs +2 -1
  93. package/dist/constructs/v1beta1/model/Model.d.mts +7 -13
  94. package/dist/constructs/v1beta1/model/Model.d.ts +7 -13
  95. package/dist/constructs/v1beta1/model/ModelSchema.d.mts +1 -1301
  96. package/dist/constructs/v1beta1/model/ModelSchema.d.ts +1 -1301
  97. package/dist/constructs/v1beta1/model/ModelSchema.js +2 -2
  98. package/dist/constructs/v1beta1/model/ModelSchema.mjs +2 -2
  99. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.mts +1 -1488
  100. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +1 -1488
  101. package/dist/constructs/v1beta1/organization/OrganizationSchema.js +2 -1
  102. package/dist/constructs/v1beta1/organization/OrganizationSchema.mjs +2 -1
  103. package/dist/constructs/v1beta1/pattern/Pattern.d.mts +7481 -212
  104. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +7481 -212
  105. package/dist/constructs/v1beta1/pattern/PatternSchema.d.mts +1 -16703
  106. package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +1 -16703
  107. package/dist/constructs/v1beta1/pattern/PatternSchema.js +265 -25
  108. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +265 -25
  109. package/dist/constructs/v1beta1/plan/PlanSchema.d.mts +1 -316
  110. package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +1 -316
  111. package/dist/constructs/v1beta1/plan/PlanSchema.js +2 -1
  112. package/dist/constructs/v1beta1/plan/PlanSchema.mjs +2 -1
  113. package/dist/constructs/v1beta1/role/Role.d.mts +614 -0
  114. package/dist/constructs/v1beta1/role/Role.d.ts +614 -0
  115. package/dist/constructs/v1beta1/role/Role.js +1 -0
  116. package/dist/constructs/v1beta1/role/Role.mjs +0 -0
  117. package/dist/constructs/v1beta1/role/RoleSchema.d.mts +7 -0
  118. package/dist/constructs/v1beta1/role/RoleSchema.d.ts +7 -0
  119. package/dist/constructs/v1beta1/role/RoleSchema.js +2 -0
  120. package/dist/constructs/v1beta1/role/RoleSchema.mjs +2 -0
  121. package/dist/constructs/v1beta1/schedule/Schedule.d.mts +371 -0
  122. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +371 -0
  123. package/dist/constructs/v1beta1/schedule/Schedule.js +1 -0
  124. package/dist/constructs/v1beta1/schedule/Schedule.mjs +0 -0
  125. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.mts +7 -0
  126. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +7 -0
  127. package/dist/constructs/v1beta1/schedule/ScheduleSchema.js +13 -0
  128. package/dist/constructs/v1beta1/schedule/ScheduleSchema.mjs +13 -0
  129. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.mts +1 -27
  130. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +1 -27
  131. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.js +1 -1
  132. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.mjs +1 -1
  133. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.mts +1 -1636
  134. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +1 -1636
  135. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.js +1 -1
  136. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.mjs +1 -1
  137. package/dist/constructs/v1beta1/team/Team.d.mts +46 -16
  138. package/dist/constructs/v1beta1/team/Team.d.ts +46 -16
  139. package/dist/constructs/v1beta1/team/TeamSchema.d.mts +1 -2016
  140. package/dist/constructs/v1beta1/team/TeamSchema.d.ts +1 -2016
  141. package/dist/constructs/v1beta1/team/TeamSchema.js +1 -1
  142. package/dist/constructs/v1beta1/team/TeamSchema.mjs +1 -1
  143. package/dist/constructs/v1beta1/user/UserSchema.d.mts +1 -1106
  144. package/dist/constructs/v1beta1/user/UserSchema.d.ts +1 -1106
  145. package/dist/constructs/v1beta1/user/UserSchema.js +2 -1
  146. package/dist/constructs/v1beta1/user/UserSchema.mjs +2 -1
  147. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.mts +1 -958
  148. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +1 -958
  149. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +1 -1
  150. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +1 -1
  151. package/dist/index.d.mts +1 -1
  152. package/dist/index.d.ts +1 -1
  153. package/dist/index.js +283 -43
  154. package/dist/index.mjs +283 -43
  155. package/dist/mesheryApi.d.mts +2025 -183
  156. package/dist/mesheryApi.d.ts +2025 -183
  157. package/dist/mesheryApi.js +1 -1
  158. package/dist/mesheryApi.mjs +1 -1
  159. package/package.json +1 -1
@@ -2,1651 +2,6 @@
2
2
  * This file was automatically generated from OpenAPI schema.
3
3
  * Do not manually modify this file.
4
4
  */
5
- declare const InvitationSchema: {
6
- readonly openapi: "3.0.0";
7
- readonly info: {
8
- readonly title: "invitation";
9
- readonly description: "OpenAPI schema for managing invitations";
10
- readonly version: "v1beta1";
11
- };
12
- readonly tags: readonly [{
13
- readonly name: "Invitation";
14
- readonly description: "Operations related to invitation";
15
- }];
16
- readonly paths: {
17
- readonly "/api/organizations/invitations/{invitationId}": {
18
- readonly get: {
19
- readonly "x-internal": readonly ["cloud"];
20
- readonly operationId: "getInvitation";
21
- readonly tags: readonly ["Invitation"];
22
- readonly summary: "Get an invitation by ID";
23
- readonly parameters: readonly [{
24
- readonly name: "invitationId";
25
- readonly in: "path";
26
- readonly required: true;
27
- readonly description: "The ID of the invitation";
28
- readonly schema: {
29
- readonly type: "string";
30
- };
31
- }];
32
- readonly responses: {
33
- readonly "200": {
34
- readonly content: {
35
- readonly "application/json": {
36
- readonly schema: {
37
- readonly type: "object";
38
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
39
- readonly properties: {
40
- readonly id: {
41
- readonly "x-go-name": "ID";
42
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
43
- readonly type: "string";
44
- readonly format: "uuid";
45
- readonly "x-go-type": "uuid.UUID";
46
- readonly "x-go-type-import": {
47
- readonly path: "github.com/gofrs/uuid";
48
- };
49
- };
50
- readonly owner_id: {
51
- readonly 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";
52
- readonly "x-oapi-codegen-extra-tags": {
53
- readonly db: "owner_id";
54
- readonly json: "owner_id";
55
- };
56
- readonly type: "string";
57
- readonly format: "uuid";
58
- readonly "x-go-type": "uuid.UUID";
59
- readonly "x-go-type-import": {
60
- readonly path: "github.com/gofrs/uuid";
61
- };
62
- };
63
- readonly is_default: {
64
- readonly type: "boolean";
65
- readonly 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";
66
- readonly "x-oapi-codegen-extra-tags": {
67
- readonly db: "is_default";
68
- readonly json: "is_default";
69
- };
70
- };
71
- readonly name: {
72
- readonly type: "string";
73
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
74
- };
75
- readonly description: {
76
- readonly type: "string";
77
- readonly 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";
78
- };
79
- readonly emails: {
80
- readonly type: "array";
81
- readonly "x-go-type": "pq.StringArray";
82
- readonly "x-go-type-import": {
83
- readonly path: "github.com/lib/pq";
84
- };
85
- readonly items: {
86
- readonly type: "string";
87
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
88
- readonly "x-go-type": "string";
89
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
90
- };
91
- };
92
- readonly org_id: {
93
- readonly type: "string";
94
- readonly description: "ID of the organization to which the user is invited";
95
- readonly "x-oapi-codegen-extra-tags": {
96
- readonly db: "org_id";
97
- readonly json: "org_id";
98
- };
99
- };
100
- readonly expires_at: {
101
- readonly type: "string";
102
- readonly format: "date-time";
103
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
104
- readonly "x-oapi-codegen-extra-tags": {
105
- readonly db: "expires_at";
106
- readonly json: "expires_at";
107
- };
108
- };
109
- readonly quota: {
110
- readonly type: "integer";
111
- readonly 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";
112
- };
113
- readonly accepted_by: {
114
- readonly type: "array";
115
- readonly "x-go-type": "pq.StringArray";
116
- readonly "x-go-type-import": {
117
- readonly path: "github.com/lib/pq";
118
- };
119
- readonly items: {
120
- readonly type: "string";
121
- };
122
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
123
- readonly "x-oapi-codegen-extra-tags": {
124
- readonly db: "accepted_by";
125
- readonly json: "accepted_by";
126
- };
127
- };
128
- readonly roles: {
129
- readonly type: "array";
130
- readonly "x-go-type": "pq.StringArray";
131
- readonly "x-go-type-import": {
132
- readonly path: "github.com/lib/pq";
133
- };
134
- readonly items: {
135
- readonly type: "string";
136
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
137
- };
138
- };
139
- readonly teams: {
140
- readonly type: "array";
141
- readonly "x-go-type": "pq.StringArray";
142
- readonly "x-go-type-import": {
143
- readonly path: "github.com/lib/pq";
144
- };
145
- readonly items: {
146
- readonly type: "string";
147
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
148
- };
149
- };
150
- readonly status: {
151
- readonly type: "string";
152
- readonly "x-go-type": "InvitationStatus";
153
- readonly enum: readonly ["enabled", "disabled"];
154
- readonly 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.";
155
- };
156
- readonly created_at: {
157
- readonly type: "string";
158
- readonly format: "date-time";
159
- readonly description: "Timestamp when the invitation was created";
160
- readonly "x-oapi-codegen-extra-tags": {
161
- readonly db: "created_at";
162
- readonly json: "created_at";
163
- };
164
- };
165
- readonly updated_at: {
166
- readonly type: "string";
167
- readonly format: "date-time";
168
- readonly description: "Timestamp when the invitation was last updated";
169
- readonly "x-oapi-codegen-extra-tags": {
170
- readonly db: "updated_at";
171
- readonly json: "updated_at";
172
- };
173
- };
174
- readonly deleted_at: {
175
- readonly type: "string";
176
- readonly format: "date-time";
177
- readonly "x-go-type": "core.NullTime";
178
- readonly description: "Timestamp when the invitation was deleted, if applicable";
179
- readonly "x-oapi-codegen-extra-tags": {
180
- readonly db: "deleted_at";
181
- readonly json: "deleted_at";
182
- };
183
- };
184
- };
185
- };
186
- };
187
- };
188
- };
189
- readonly "400": {
190
- readonly description: "Bad Request";
191
- };
192
- readonly "401": {
193
- readonly description: "Unauthorized";
194
- };
195
- readonly "500": {
196
- readonly description: "Internal Server Error";
197
- };
198
- };
199
- };
200
- readonly delete: {
201
- readonly "x-internal": readonly ["cloud"];
202
- readonly operationId: "deleteInvitation";
203
- readonly tags: readonly ["Invitation"];
204
- readonly summary: "Delete an invitation by ID";
205
- readonly parameters: readonly [{
206
- readonly name: "invitationId";
207
- readonly in: "path";
208
- readonly required: true;
209
- readonly description: "The ID of the invitation";
210
- readonly schema: {
211
- readonly type: "string";
212
- };
213
- }];
214
- readonly responses: {
215
- readonly "204": {
216
- readonly description: "Invitation deleted successfully";
217
- };
218
- readonly "400": {
219
- readonly description: "Bad Request";
220
- };
221
- readonly "401": {
222
- readonly description: "Unauthorized";
223
- };
224
- readonly "500": {
225
- readonly description: "Internal Server Error";
226
- };
227
- };
228
- };
229
- readonly put: {
230
- readonly "x-internal": readonly ["cloud"];
231
- readonly operationId: "updateInvitation";
232
- readonly tags: readonly ["Invitation"];
233
- readonly summary: "Update an existing invitation";
234
- readonly parameters: readonly [{
235
- readonly name: "invitationId";
236
- readonly in: "path";
237
- readonly required: true;
238
- readonly description: "The ID of the invitation";
239
- readonly schema: {
240
- readonly type: "string";
241
- };
242
- }];
243
- readonly requestBody: {
244
- readonly content: {
245
- readonly "application/json": {
246
- readonly schema: {
247
- readonly type: "object";
248
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
249
- readonly properties: {
250
- readonly id: {
251
- readonly "x-go-name": "ID";
252
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
253
- readonly type: "string";
254
- readonly format: "uuid";
255
- readonly "x-go-type": "uuid.UUID";
256
- readonly "x-go-type-import": {
257
- readonly path: "github.com/gofrs/uuid";
258
- };
259
- };
260
- readonly owner_id: {
261
- readonly 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";
262
- readonly "x-oapi-codegen-extra-tags": {
263
- readonly db: "owner_id";
264
- readonly json: "owner_id";
265
- };
266
- readonly type: "string";
267
- readonly format: "uuid";
268
- readonly "x-go-type": "uuid.UUID";
269
- readonly "x-go-type-import": {
270
- readonly path: "github.com/gofrs/uuid";
271
- };
272
- };
273
- readonly is_default: {
274
- readonly type: "boolean";
275
- readonly 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";
276
- readonly "x-oapi-codegen-extra-tags": {
277
- readonly db: "is_default";
278
- readonly json: "is_default";
279
- };
280
- };
281
- readonly name: {
282
- readonly type: "string";
283
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
284
- };
285
- readonly description: {
286
- readonly type: "string";
287
- readonly 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";
288
- };
289
- readonly emails: {
290
- readonly type: "array";
291
- readonly "x-go-type": "pq.StringArray";
292
- readonly "x-go-type-import": {
293
- readonly path: "github.com/lib/pq";
294
- };
295
- readonly items: {
296
- readonly type: "string";
297
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
298
- readonly "x-go-type": "string";
299
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
300
- };
301
- };
302
- readonly org_id: {
303
- readonly type: "string";
304
- readonly description: "ID of the organization to which the user is invited";
305
- readonly "x-oapi-codegen-extra-tags": {
306
- readonly db: "org_id";
307
- readonly json: "org_id";
308
- };
309
- };
310
- readonly expires_at: {
311
- readonly type: "string";
312
- readonly format: "date-time";
313
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
314
- readonly "x-oapi-codegen-extra-tags": {
315
- readonly db: "expires_at";
316
- readonly json: "expires_at";
317
- };
318
- };
319
- readonly quota: {
320
- readonly type: "integer";
321
- readonly 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";
322
- };
323
- readonly accepted_by: {
324
- readonly type: "array";
325
- readonly "x-go-type": "pq.StringArray";
326
- readonly "x-go-type-import": {
327
- readonly path: "github.com/lib/pq";
328
- };
329
- readonly items: {
330
- readonly type: "string";
331
- };
332
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
333
- readonly "x-oapi-codegen-extra-tags": {
334
- readonly db: "accepted_by";
335
- readonly json: "accepted_by";
336
- };
337
- };
338
- readonly roles: {
339
- readonly type: "array";
340
- readonly "x-go-type": "pq.StringArray";
341
- readonly "x-go-type-import": {
342
- readonly path: "github.com/lib/pq";
343
- };
344
- readonly items: {
345
- readonly type: "string";
346
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
347
- };
348
- };
349
- readonly teams: {
350
- readonly type: "array";
351
- readonly "x-go-type": "pq.StringArray";
352
- readonly "x-go-type-import": {
353
- readonly path: "github.com/lib/pq";
354
- };
355
- readonly items: {
356
- readonly type: "string";
357
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
358
- };
359
- };
360
- readonly status: {
361
- readonly type: "string";
362
- readonly "x-go-type": "InvitationStatus";
363
- readonly enum: readonly ["enabled", "disabled"];
364
- readonly 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.";
365
- };
366
- readonly created_at: {
367
- readonly type: "string";
368
- readonly format: "date-time";
369
- readonly description: "Timestamp when the invitation was created";
370
- readonly "x-oapi-codegen-extra-tags": {
371
- readonly db: "created_at";
372
- readonly json: "created_at";
373
- };
374
- };
375
- readonly updated_at: {
376
- readonly type: "string";
377
- readonly format: "date-time";
378
- readonly description: "Timestamp when the invitation was last updated";
379
- readonly "x-oapi-codegen-extra-tags": {
380
- readonly db: "updated_at";
381
- readonly json: "updated_at";
382
- };
383
- };
384
- readonly deleted_at: {
385
- readonly type: "string";
386
- readonly format: "date-time";
387
- readonly "x-go-type": "core.NullTime";
388
- readonly description: "Timestamp when the invitation was deleted, if applicable";
389
- readonly "x-oapi-codegen-extra-tags": {
390
- readonly db: "deleted_at";
391
- readonly json: "deleted_at";
392
- };
393
- };
394
- };
395
- };
396
- };
397
- };
398
- readonly required: true;
399
- };
400
- readonly responses: {
401
- readonly "200": {
402
- readonly content: {
403
- readonly "application/json": {
404
- readonly schema: {
405
- readonly type: "object";
406
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
407
- readonly properties: {
408
- readonly id: {
409
- readonly "x-go-name": "ID";
410
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
411
- readonly type: "string";
412
- readonly format: "uuid";
413
- readonly "x-go-type": "uuid.UUID";
414
- readonly "x-go-type-import": {
415
- readonly path: "github.com/gofrs/uuid";
416
- };
417
- };
418
- readonly owner_id: {
419
- readonly 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";
420
- readonly "x-oapi-codegen-extra-tags": {
421
- readonly db: "owner_id";
422
- readonly json: "owner_id";
423
- };
424
- readonly type: "string";
425
- readonly format: "uuid";
426
- readonly "x-go-type": "uuid.UUID";
427
- readonly "x-go-type-import": {
428
- readonly path: "github.com/gofrs/uuid";
429
- };
430
- };
431
- readonly is_default: {
432
- readonly type: "boolean";
433
- readonly 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";
434
- readonly "x-oapi-codegen-extra-tags": {
435
- readonly db: "is_default";
436
- readonly json: "is_default";
437
- };
438
- };
439
- readonly name: {
440
- readonly type: "string";
441
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
442
- };
443
- readonly description: {
444
- readonly type: "string";
445
- readonly 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";
446
- };
447
- readonly emails: {
448
- readonly type: "array";
449
- readonly "x-go-type": "pq.StringArray";
450
- readonly "x-go-type-import": {
451
- readonly path: "github.com/lib/pq";
452
- };
453
- readonly items: {
454
- readonly type: "string";
455
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
456
- readonly "x-go-type": "string";
457
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
458
- };
459
- };
460
- readonly org_id: {
461
- readonly type: "string";
462
- readonly description: "ID of the organization to which the user is invited";
463
- readonly "x-oapi-codegen-extra-tags": {
464
- readonly db: "org_id";
465
- readonly json: "org_id";
466
- };
467
- };
468
- readonly expires_at: {
469
- readonly type: "string";
470
- readonly format: "date-time";
471
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
472
- readonly "x-oapi-codegen-extra-tags": {
473
- readonly db: "expires_at";
474
- readonly json: "expires_at";
475
- };
476
- };
477
- readonly quota: {
478
- readonly type: "integer";
479
- readonly 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";
480
- };
481
- readonly accepted_by: {
482
- readonly type: "array";
483
- readonly "x-go-type": "pq.StringArray";
484
- readonly "x-go-type-import": {
485
- readonly path: "github.com/lib/pq";
486
- };
487
- readonly items: {
488
- readonly type: "string";
489
- };
490
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
491
- readonly "x-oapi-codegen-extra-tags": {
492
- readonly db: "accepted_by";
493
- readonly json: "accepted_by";
494
- };
495
- };
496
- readonly roles: {
497
- readonly type: "array";
498
- readonly "x-go-type": "pq.StringArray";
499
- readonly "x-go-type-import": {
500
- readonly path: "github.com/lib/pq";
501
- };
502
- readonly items: {
503
- readonly type: "string";
504
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
505
- };
506
- };
507
- readonly teams: {
508
- readonly type: "array";
509
- readonly "x-go-type": "pq.StringArray";
510
- readonly "x-go-type-import": {
511
- readonly path: "github.com/lib/pq";
512
- };
513
- readonly items: {
514
- readonly type: "string";
515
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
516
- };
517
- };
518
- readonly status: {
519
- readonly type: "string";
520
- readonly "x-go-type": "InvitationStatus";
521
- readonly enum: readonly ["enabled", "disabled"];
522
- readonly 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.";
523
- };
524
- readonly created_at: {
525
- readonly type: "string";
526
- readonly format: "date-time";
527
- readonly description: "Timestamp when the invitation was created";
528
- readonly "x-oapi-codegen-extra-tags": {
529
- readonly db: "created_at";
530
- readonly json: "created_at";
531
- };
532
- };
533
- readonly updated_at: {
534
- readonly type: "string";
535
- readonly format: "date-time";
536
- readonly description: "Timestamp when the invitation was last updated";
537
- readonly "x-oapi-codegen-extra-tags": {
538
- readonly db: "updated_at";
539
- readonly json: "updated_at";
540
- };
541
- };
542
- readonly deleted_at: {
543
- readonly type: "string";
544
- readonly format: "date-time";
545
- readonly "x-go-type": "core.NullTime";
546
- readonly description: "Timestamp when the invitation was deleted, if applicable";
547
- readonly "x-oapi-codegen-extra-tags": {
548
- readonly db: "deleted_at";
549
- readonly json: "deleted_at";
550
- };
551
- };
552
- };
553
- };
554
- };
555
- };
556
- };
557
- readonly "400": {
558
- readonly description: "Bad Request";
559
- };
560
- readonly "401": {
561
- readonly description: "Unauthorized";
562
- };
563
- readonly "500": {
564
- readonly description: "Internal Server Error";
565
- };
566
- };
567
- };
568
- };
569
- readonly "/api/organizations/invitations": {
570
- readonly get: {
571
- readonly "x-internal": readonly ["cloud"];
572
- readonly operationId: "getInvitations";
573
- readonly tags: readonly ["Invitation"];
574
- readonly summary: "Get all invitations for the organization";
575
- readonly responses: {
576
- readonly "200": {
577
- readonly content: {
578
- readonly "application/json": {
579
- readonly schema: {
580
- readonly type: "object";
581
- readonly required: readonly ["data", "total"];
582
- readonly properties: {
583
- readonly data: {
584
- readonly type: "array";
585
- readonly items: {
586
- readonly type: "object";
587
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
588
- readonly properties: {
589
- readonly id: {
590
- readonly "x-go-name": "ID";
591
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
592
- readonly type: "string";
593
- readonly format: "uuid";
594
- readonly "x-go-type": "uuid.UUID";
595
- readonly "x-go-type-import": {
596
- readonly path: "github.com/gofrs/uuid";
597
- };
598
- };
599
- readonly owner_id: {
600
- readonly 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";
601
- readonly "x-oapi-codegen-extra-tags": {
602
- readonly db: "owner_id";
603
- readonly json: "owner_id";
604
- };
605
- readonly type: "string";
606
- readonly format: "uuid";
607
- readonly "x-go-type": "uuid.UUID";
608
- readonly "x-go-type-import": {
609
- readonly path: "github.com/gofrs/uuid";
610
- };
611
- };
612
- readonly is_default: {
613
- readonly type: "boolean";
614
- readonly 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";
615
- readonly "x-oapi-codegen-extra-tags": {
616
- readonly db: "is_default";
617
- readonly json: "is_default";
618
- };
619
- };
620
- readonly name: {
621
- readonly type: "string";
622
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
623
- };
624
- readonly description: {
625
- readonly type: "string";
626
- readonly 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";
627
- };
628
- readonly emails: {
629
- readonly type: "array";
630
- readonly "x-go-type": "pq.StringArray";
631
- readonly "x-go-type-import": {
632
- readonly path: "github.com/lib/pq";
633
- };
634
- readonly items: {
635
- readonly type: "string";
636
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
637
- readonly "x-go-type": "string";
638
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
639
- };
640
- };
641
- readonly org_id: {
642
- readonly type: "string";
643
- readonly description: "ID of the organization to which the user is invited";
644
- readonly "x-oapi-codegen-extra-tags": {
645
- readonly db: "org_id";
646
- readonly json: "org_id";
647
- };
648
- };
649
- readonly expires_at: {
650
- readonly type: "string";
651
- readonly format: "date-time";
652
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
653
- readonly "x-oapi-codegen-extra-tags": {
654
- readonly db: "expires_at";
655
- readonly json: "expires_at";
656
- };
657
- };
658
- readonly quota: {
659
- readonly type: "integer";
660
- readonly 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";
661
- };
662
- readonly accepted_by: {
663
- readonly type: "array";
664
- readonly "x-go-type": "pq.StringArray";
665
- readonly "x-go-type-import": {
666
- readonly path: "github.com/lib/pq";
667
- };
668
- readonly items: {
669
- readonly type: "string";
670
- };
671
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
672
- readonly "x-oapi-codegen-extra-tags": {
673
- readonly db: "accepted_by";
674
- readonly json: "accepted_by";
675
- };
676
- };
677
- readonly roles: {
678
- readonly type: "array";
679
- readonly "x-go-type": "pq.StringArray";
680
- readonly "x-go-type-import": {
681
- readonly path: "github.com/lib/pq";
682
- };
683
- readonly items: {
684
- readonly type: "string";
685
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
686
- };
687
- };
688
- readonly teams: {
689
- readonly type: "array";
690
- readonly "x-go-type": "pq.StringArray";
691
- readonly "x-go-type-import": {
692
- readonly path: "github.com/lib/pq";
693
- };
694
- readonly items: {
695
- readonly type: "string";
696
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
697
- };
698
- };
699
- readonly status: {
700
- readonly type: "string";
701
- readonly "x-go-type": "InvitationStatus";
702
- readonly enum: readonly ["enabled", "disabled"];
703
- readonly 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.";
704
- };
705
- readonly created_at: {
706
- readonly type: "string";
707
- readonly format: "date-time";
708
- readonly description: "Timestamp when the invitation was created";
709
- readonly "x-oapi-codegen-extra-tags": {
710
- readonly db: "created_at";
711
- readonly json: "created_at";
712
- };
713
- };
714
- readonly updated_at: {
715
- readonly type: "string";
716
- readonly format: "date-time";
717
- readonly description: "Timestamp when the invitation was last updated";
718
- readonly "x-oapi-codegen-extra-tags": {
719
- readonly db: "updated_at";
720
- readonly json: "updated_at";
721
- };
722
- };
723
- readonly deleted_at: {
724
- readonly type: "string";
725
- readonly format: "date-time";
726
- readonly "x-go-type": "core.NullTime";
727
- readonly description: "Timestamp when the invitation was deleted, if applicable";
728
- readonly "x-oapi-codegen-extra-tags": {
729
- readonly db: "deleted_at";
730
- readonly json: "deleted_at";
731
- };
732
- };
733
- };
734
- readonly "x-go-type": "Invitation";
735
- };
736
- readonly description: "List of invitations";
737
- readonly "x-oapi-codegen-extra-tags": {
738
- readonly json: "data";
739
- };
740
- };
741
- readonly total: {
742
- readonly type: "integer";
743
- readonly description: "Total number of invitations available";
744
- readonly "x-oapi-codegen-extra-tags": {
745
- readonly json: "total";
746
- };
747
- };
748
- };
749
- };
750
- };
751
- };
752
- };
753
- readonly "400": {
754
- readonly description: "Bad Request";
755
- };
756
- readonly "401": {
757
- readonly description: "Unauthorized";
758
- };
759
- readonly "500": {
760
- readonly description: "Internal Server Error";
761
- };
762
- };
763
- };
764
- readonly post: {
765
- readonly "x-internal": readonly ["cloud"];
766
- readonly operationId: "createInvitation";
767
- readonly tags: readonly ["Invitation"];
768
- readonly summary: "Create a new invitation for the organization";
769
- readonly requestBody: {
770
- readonly content: {
771
- readonly "application/json": {
772
- readonly schema: {
773
- readonly type: "object";
774
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
775
- readonly properties: {
776
- readonly id: {
777
- readonly "x-go-name": "ID";
778
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
779
- readonly type: "string";
780
- readonly format: "uuid";
781
- readonly "x-go-type": "uuid.UUID";
782
- readonly "x-go-type-import": {
783
- readonly path: "github.com/gofrs/uuid";
784
- };
785
- };
786
- readonly owner_id: {
787
- readonly 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";
788
- readonly "x-oapi-codegen-extra-tags": {
789
- readonly db: "owner_id";
790
- readonly json: "owner_id";
791
- };
792
- readonly type: "string";
793
- readonly format: "uuid";
794
- readonly "x-go-type": "uuid.UUID";
795
- readonly "x-go-type-import": {
796
- readonly path: "github.com/gofrs/uuid";
797
- };
798
- };
799
- readonly is_default: {
800
- readonly type: "boolean";
801
- readonly 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";
802
- readonly "x-oapi-codegen-extra-tags": {
803
- readonly db: "is_default";
804
- readonly json: "is_default";
805
- };
806
- };
807
- readonly name: {
808
- readonly type: "string";
809
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
810
- };
811
- readonly description: {
812
- readonly type: "string";
813
- readonly 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";
814
- };
815
- readonly emails: {
816
- readonly type: "array";
817
- readonly "x-go-type": "pq.StringArray";
818
- readonly "x-go-type-import": {
819
- readonly path: "github.com/lib/pq";
820
- };
821
- readonly items: {
822
- readonly type: "string";
823
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
824
- readonly "x-go-type": "string";
825
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
826
- };
827
- };
828
- readonly org_id: {
829
- readonly type: "string";
830
- readonly description: "ID of the organization to which the user is invited";
831
- readonly "x-oapi-codegen-extra-tags": {
832
- readonly db: "org_id";
833
- readonly json: "org_id";
834
- };
835
- };
836
- readonly expires_at: {
837
- readonly type: "string";
838
- readonly format: "date-time";
839
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
840
- readonly "x-oapi-codegen-extra-tags": {
841
- readonly db: "expires_at";
842
- readonly json: "expires_at";
843
- };
844
- };
845
- readonly quota: {
846
- readonly type: "integer";
847
- readonly 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";
848
- };
849
- readonly accepted_by: {
850
- readonly type: "array";
851
- readonly "x-go-type": "pq.StringArray";
852
- readonly "x-go-type-import": {
853
- readonly path: "github.com/lib/pq";
854
- };
855
- readonly items: {
856
- readonly type: "string";
857
- };
858
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
859
- readonly "x-oapi-codegen-extra-tags": {
860
- readonly db: "accepted_by";
861
- readonly json: "accepted_by";
862
- };
863
- };
864
- readonly roles: {
865
- readonly type: "array";
866
- readonly "x-go-type": "pq.StringArray";
867
- readonly "x-go-type-import": {
868
- readonly path: "github.com/lib/pq";
869
- };
870
- readonly items: {
871
- readonly type: "string";
872
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
873
- };
874
- };
875
- readonly teams: {
876
- readonly type: "array";
877
- readonly "x-go-type": "pq.StringArray";
878
- readonly "x-go-type-import": {
879
- readonly path: "github.com/lib/pq";
880
- };
881
- readonly items: {
882
- readonly type: "string";
883
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
884
- };
885
- };
886
- readonly status: {
887
- readonly type: "string";
888
- readonly "x-go-type": "InvitationStatus";
889
- readonly enum: readonly ["enabled", "disabled"];
890
- readonly 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.";
891
- };
892
- readonly created_at: {
893
- readonly type: "string";
894
- readonly format: "date-time";
895
- readonly description: "Timestamp when the invitation was created";
896
- readonly "x-oapi-codegen-extra-tags": {
897
- readonly db: "created_at";
898
- readonly json: "created_at";
899
- };
900
- };
901
- readonly updated_at: {
902
- readonly type: "string";
903
- readonly format: "date-time";
904
- readonly description: "Timestamp when the invitation was last updated";
905
- readonly "x-oapi-codegen-extra-tags": {
906
- readonly db: "updated_at";
907
- readonly json: "updated_at";
908
- };
909
- };
910
- readonly deleted_at: {
911
- readonly type: "string";
912
- readonly format: "date-time";
913
- readonly "x-go-type": "core.NullTime";
914
- readonly description: "Timestamp when the invitation was deleted, if applicable";
915
- readonly "x-oapi-codegen-extra-tags": {
916
- readonly db: "deleted_at";
917
- readonly json: "deleted_at";
918
- };
919
- };
920
- };
921
- };
922
- };
923
- };
924
- readonly required: true;
925
- };
926
- readonly responses: {
927
- readonly "201": {
928
- readonly content: {
929
- readonly "application/json": {
930
- readonly schema: {
931
- readonly type: "object";
932
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
933
- readonly properties: {
934
- readonly id: {
935
- readonly "x-go-name": "ID";
936
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
937
- readonly type: "string";
938
- readonly format: "uuid";
939
- readonly "x-go-type": "uuid.UUID";
940
- readonly "x-go-type-import": {
941
- readonly path: "github.com/gofrs/uuid";
942
- };
943
- };
944
- readonly owner_id: {
945
- readonly 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";
946
- readonly "x-oapi-codegen-extra-tags": {
947
- readonly db: "owner_id";
948
- readonly json: "owner_id";
949
- };
950
- readonly type: "string";
951
- readonly format: "uuid";
952
- readonly "x-go-type": "uuid.UUID";
953
- readonly "x-go-type-import": {
954
- readonly path: "github.com/gofrs/uuid";
955
- };
956
- };
957
- readonly is_default: {
958
- readonly type: "boolean";
959
- readonly 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";
960
- readonly "x-oapi-codegen-extra-tags": {
961
- readonly db: "is_default";
962
- readonly json: "is_default";
963
- };
964
- };
965
- readonly name: {
966
- readonly type: "string";
967
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
968
- };
969
- readonly description: {
970
- readonly type: "string";
971
- readonly 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";
972
- };
973
- readonly emails: {
974
- readonly type: "array";
975
- readonly "x-go-type": "pq.StringArray";
976
- readonly "x-go-type-import": {
977
- readonly path: "github.com/lib/pq";
978
- };
979
- readonly items: {
980
- readonly type: "string";
981
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
982
- readonly "x-go-type": "string";
983
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
984
- };
985
- };
986
- readonly org_id: {
987
- readonly type: "string";
988
- readonly description: "ID of the organization to which the user is invited";
989
- readonly "x-oapi-codegen-extra-tags": {
990
- readonly db: "org_id";
991
- readonly json: "org_id";
992
- };
993
- };
994
- readonly expires_at: {
995
- readonly type: "string";
996
- readonly format: "date-time";
997
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
998
- readonly "x-oapi-codegen-extra-tags": {
999
- readonly db: "expires_at";
1000
- readonly json: "expires_at";
1001
- };
1002
- };
1003
- readonly quota: {
1004
- readonly type: "integer";
1005
- readonly 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";
1006
- };
1007
- readonly accepted_by: {
1008
- readonly type: "array";
1009
- readonly "x-go-type": "pq.StringArray";
1010
- readonly "x-go-type-import": {
1011
- readonly path: "github.com/lib/pq";
1012
- };
1013
- readonly items: {
1014
- readonly type: "string";
1015
- };
1016
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
1017
- readonly "x-oapi-codegen-extra-tags": {
1018
- readonly db: "accepted_by";
1019
- readonly json: "accepted_by";
1020
- };
1021
- };
1022
- readonly roles: {
1023
- readonly type: "array";
1024
- readonly "x-go-type": "pq.StringArray";
1025
- readonly "x-go-type-import": {
1026
- readonly path: "github.com/lib/pq";
1027
- };
1028
- readonly items: {
1029
- readonly type: "string";
1030
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
1031
- };
1032
- };
1033
- readonly teams: {
1034
- readonly type: "array";
1035
- readonly "x-go-type": "pq.StringArray";
1036
- readonly "x-go-type-import": {
1037
- readonly path: "github.com/lib/pq";
1038
- };
1039
- readonly items: {
1040
- readonly type: "string";
1041
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
1042
- };
1043
- };
1044
- readonly status: {
1045
- readonly type: "string";
1046
- readonly "x-go-type": "InvitationStatus";
1047
- readonly enum: readonly ["enabled", "disabled"];
1048
- readonly 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.";
1049
- };
1050
- readonly created_at: {
1051
- readonly type: "string";
1052
- readonly format: "date-time";
1053
- readonly description: "Timestamp when the invitation was created";
1054
- readonly "x-oapi-codegen-extra-tags": {
1055
- readonly db: "created_at";
1056
- readonly json: "created_at";
1057
- };
1058
- };
1059
- readonly updated_at: {
1060
- readonly type: "string";
1061
- readonly format: "date-time";
1062
- readonly description: "Timestamp when the invitation was last updated";
1063
- readonly "x-oapi-codegen-extra-tags": {
1064
- readonly db: "updated_at";
1065
- readonly json: "updated_at";
1066
- };
1067
- };
1068
- readonly deleted_at: {
1069
- readonly type: "string";
1070
- readonly format: "date-time";
1071
- readonly "x-go-type": "core.NullTime";
1072
- readonly description: "Timestamp when the invitation was deleted, if applicable";
1073
- readonly "x-oapi-codegen-extra-tags": {
1074
- readonly db: "deleted_at";
1075
- readonly json: "deleted_at";
1076
- };
1077
- };
1078
- };
1079
- };
1080
- };
1081
- };
1082
- };
1083
- readonly "400": {
1084
- readonly description: "Bad Request";
1085
- };
1086
- readonly "401": {
1087
- readonly description: "Unauthorized";
1088
- };
1089
- readonly "500": {
1090
- readonly description: "Internal Server Error";
1091
- };
1092
- };
1093
- };
1094
- };
1095
- readonly "/api/organizations/invitations/{invitationId}/accept": {
1096
- readonly post: {
1097
- readonly "x-internal": readonly ["cloud"];
1098
- readonly operationId: "acceptInvitation";
1099
- readonly tags: readonly ["Invitation"];
1100
- readonly summary: "Accept an invitation by ID";
1101
- readonly parameters: readonly [{
1102
- readonly name: "invitationId";
1103
- readonly in: "path";
1104
- readonly required: true;
1105
- readonly description: "The ID of the invitation";
1106
- readonly schema: {
1107
- readonly type: "string";
1108
- };
1109
- }];
1110
- readonly responses: {
1111
- readonly "200": {
1112
- readonly content: {
1113
- readonly "application/json": {
1114
- readonly schema: {
1115
- readonly type: "object";
1116
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
1117
- readonly properties: {
1118
- readonly id: {
1119
- readonly "x-go-name": "ID";
1120
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
1121
- readonly type: "string";
1122
- readonly format: "uuid";
1123
- readonly "x-go-type": "uuid.UUID";
1124
- readonly "x-go-type-import": {
1125
- readonly path: "github.com/gofrs/uuid";
1126
- };
1127
- };
1128
- readonly owner_id: {
1129
- readonly 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";
1130
- readonly "x-oapi-codegen-extra-tags": {
1131
- readonly db: "owner_id";
1132
- readonly json: "owner_id";
1133
- };
1134
- readonly type: "string";
1135
- readonly format: "uuid";
1136
- readonly "x-go-type": "uuid.UUID";
1137
- readonly "x-go-type-import": {
1138
- readonly path: "github.com/gofrs/uuid";
1139
- };
1140
- };
1141
- readonly is_default: {
1142
- readonly type: "boolean";
1143
- readonly 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";
1144
- readonly "x-oapi-codegen-extra-tags": {
1145
- readonly db: "is_default";
1146
- readonly json: "is_default";
1147
- };
1148
- };
1149
- readonly name: {
1150
- readonly type: "string";
1151
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
1152
- };
1153
- readonly description: {
1154
- readonly type: "string";
1155
- readonly 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";
1156
- };
1157
- readonly emails: {
1158
- readonly type: "array";
1159
- readonly "x-go-type": "pq.StringArray";
1160
- readonly "x-go-type-import": {
1161
- readonly path: "github.com/lib/pq";
1162
- };
1163
- readonly items: {
1164
- readonly type: "string";
1165
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
1166
- readonly "x-go-type": "string";
1167
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
1168
- };
1169
- };
1170
- readonly org_id: {
1171
- readonly type: "string";
1172
- readonly description: "ID of the organization to which the user is invited";
1173
- readonly "x-oapi-codegen-extra-tags": {
1174
- readonly db: "org_id";
1175
- readonly json: "org_id";
1176
- };
1177
- };
1178
- readonly expires_at: {
1179
- readonly type: "string";
1180
- readonly format: "date-time";
1181
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
1182
- readonly "x-oapi-codegen-extra-tags": {
1183
- readonly db: "expires_at";
1184
- readonly json: "expires_at";
1185
- };
1186
- };
1187
- readonly quota: {
1188
- readonly type: "integer";
1189
- readonly 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";
1190
- };
1191
- readonly accepted_by: {
1192
- readonly type: "array";
1193
- readonly "x-go-type": "pq.StringArray";
1194
- readonly "x-go-type-import": {
1195
- readonly path: "github.com/lib/pq";
1196
- };
1197
- readonly items: {
1198
- readonly type: "string";
1199
- };
1200
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
1201
- readonly "x-oapi-codegen-extra-tags": {
1202
- readonly db: "accepted_by";
1203
- readonly json: "accepted_by";
1204
- };
1205
- };
1206
- readonly roles: {
1207
- readonly type: "array";
1208
- readonly "x-go-type": "pq.StringArray";
1209
- readonly "x-go-type-import": {
1210
- readonly path: "github.com/lib/pq";
1211
- };
1212
- readonly items: {
1213
- readonly type: "string";
1214
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
1215
- };
1216
- };
1217
- readonly teams: {
1218
- readonly type: "array";
1219
- readonly "x-go-type": "pq.StringArray";
1220
- readonly "x-go-type-import": {
1221
- readonly path: "github.com/lib/pq";
1222
- };
1223
- readonly items: {
1224
- readonly type: "string";
1225
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
1226
- };
1227
- };
1228
- readonly status: {
1229
- readonly type: "string";
1230
- readonly "x-go-type": "InvitationStatus";
1231
- readonly enum: readonly ["enabled", "disabled"];
1232
- readonly 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.";
1233
- };
1234
- readonly created_at: {
1235
- readonly type: "string";
1236
- readonly format: "date-time";
1237
- readonly description: "Timestamp when the invitation was created";
1238
- readonly "x-oapi-codegen-extra-tags": {
1239
- readonly db: "created_at";
1240
- readonly json: "created_at";
1241
- };
1242
- };
1243
- readonly updated_at: {
1244
- readonly type: "string";
1245
- readonly format: "date-time";
1246
- readonly description: "Timestamp when the invitation was last updated";
1247
- readonly "x-oapi-codegen-extra-tags": {
1248
- readonly db: "updated_at";
1249
- readonly json: "updated_at";
1250
- };
1251
- };
1252
- readonly deleted_at: {
1253
- readonly type: "string";
1254
- readonly format: "date-time";
1255
- readonly "x-go-type": "core.NullTime";
1256
- readonly description: "Timestamp when the invitation was deleted, if applicable";
1257
- readonly "x-oapi-codegen-extra-tags": {
1258
- readonly db: "deleted_at";
1259
- readonly json: "deleted_at";
1260
- };
1261
- };
1262
- };
1263
- };
1264
- };
1265
- };
1266
- };
1267
- readonly "400": {
1268
- readonly description: "Bad Request";
1269
- };
1270
- readonly "401": {
1271
- readonly description: "Unauthorized";
1272
- };
1273
- readonly "500": {
1274
- readonly description: "Internal Server Error";
1275
- };
1276
- };
1277
- };
1278
- };
1279
- };
1280
- readonly components: {
1281
- readonly parameters: {
1282
- readonly organization_id: {
1283
- readonly name: "organizationId";
1284
- readonly in: "path";
1285
- readonly required: true;
1286
- readonly description: "The ID of the organization";
1287
- readonly schema: {
1288
- readonly type: "string";
1289
- };
1290
- };
1291
- readonly invitation_id: {
1292
- readonly name: "invitationId";
1293
- readonly in: "path";
1294
- readonly required: true;
1295
- readonly description: "The ID of the invitation";
1296
- readonly schema: {
1297
- readonly type: "string";
1298
- };
1299
- };
1300
- };
1301
- readonly responses: {
1302
- readonly "400": {
1303
- readonly description: "Bad Request";
1304
- };
1305
- readonly "401": {
1306
- readonly description: "Unauthorized";
1307
- };
1308
- readonly "500": {
1309
- readonly description: "Internal Server Error";
1310
- };
1311
- };
1312
- readonly schemas: {
1313
- readonly uuid: {
1314
- readonly type: "string";
1315
- readonly format: "uuid";
1316
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1317
- readonly "x-go-type": "uuid.UUID";
1318
- readonly "x-go-type-import": {
1319
- readonly path: "github.com/gofrs/uuid";
1320
- };
1321
- };
1322
- readonly InvitationsPage: {
1323
- readonly type: "object";
1324
- readonly required: readonly ["data", "total"];
1325
- readonly properties: {
1326
- readonly data: {
1327
- readonly type: "array";
1328
- readonly items: {
1329
- readonly type: "object";
1330
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
1331
- readonly properties: {
1332
- readonly id: {
1333
- readonly "x-go-name": "ID";
1334
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
1335
- readonly type: "string";
1336
- readonly format: "uuid";
1337
- readonly "x-go-type": "uuid.UUID";
1338
- readonly "x-go-type-import": {
1339
- readonly path: "github.com/gofrs/uuid";
1340
- };
1341
- };
1342
- readonly owner_id: {
1343
- readonly 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";
1344
- readonly "x-oapi-codegen-extra-tags": {
1345
- readonly db: "owner_id";
1346
- readonly json: "owner_id";
1347
- };
1348
- readonly type: "string";
1349
- readonly format: "uuid";
1350
- readonly "x-go-type": "uuid.UUID";
1351
- readonly "x-go-type-import": {
1352
- readonly path: "github.com/gofrs/uuid";
1353
- };
1354
- };
1355
- readonly is_default: {
1356
- readonly type: "boolean";
1357
- readonly 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";
1358
- readonly "x-oapi-codegen-extra-tags": {
1359
- readonly db: "is_default";
1360
- readonly json: "is_default";
1361
- };
1362
- };
1363
- readonly name: {
1364
- readonly type: "string";
1365
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
1366
- };
1367
- readonly description: {
1368
- readonly type: "string";
1369
- readonly 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";
1370
- };
1371
- readonly emails: {
1372
- readonly type: "array";
1373
- readonly "x-go-type": "pq.StringArray";
1374
- readonly "x-go-type-import": {
1375
- readonly path: "github.com/lib/pq";
1376
- };
1377
- readonly items: {
1378
- readonly type: "string";
1379
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
1380
- readonly "x-go-type": "string";
1381
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
1382
- };
1383
- };
1384
- readonly org_id: {
1385
- readonly type: "string";
1386
- readonly description: "ID of the organization to which the user is invited";
1387
- readonly "x-oapi-codegen-extra-tags": {
1388
- readonly db: "org_id";
1389
- readonly json: "org_id";
1390
- };
1391
- };
1392
- readonly expires_at: {
1393
- readonly type: "string";
1394
- readonly format: "date-time";
1395
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
1396
- readonly "x-oapi-codegen-extra-tags": {
1397
- readonly db: "expires_at";
1398
- readonly json: "expires_at";
1399
- };
1400
- };
1401
- readonly quota: {
1402
- readonly type: "integer";
1403
- readonly 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";
1404
- };
1405
- readonly accepted_by: {
1406
- readonly type: "array";
1407
- readonly "x-go-type": "pq.StringArray";
1408
- readonly "x-go-type-import": {
1409
- readonly path: "github.com/lib/pq";
1410
- };
1411
- readonly items: {
1412
- readonly type: "string";
1413
- };
1414
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
1415
- readonly "x-oapi-codegen-extra-tags": {
1416
- readonly db: "accepted_by";
1417
- readonly json: "accepted_by";
1418
- };
1419
- };
1420
- readonly roles: {
1421
- readonly type: "array";
1422
- readonly "x-go-type": "pq.StringArray";
1423
- readonly "x-go-type-import": {
1424
- readonly path: "github.com/lib/pq";
1425
- };
1426
- readonly items: {
1427
- readonly type: "string";
1428
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
1429
- };
1430
- };
1431
- readonly teams: {
1432
- readonly type: "array";
1433
- readonly "x-go-type": "pq.StringArray";
1434
- readonly "x-go-type-import": {
1435
- readonly path: "github.com/lib/pq";
1436
- };
1437
- readonly items: {
1438
- readonly type: "string";
1439
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
1440
- };
1441
- };
1442
- readonly status: {
1443
- readonly type: "string";
1444
- readonly "x-go-type": "InvitationStatus";
1445
- readonly enum: readonly ["enabled", "disabled"];
1446
- readonly 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.";
1447
- };
1448
- readonly created_at: {
1449
- readonly type: "string";
1450
- readonly format: "date-time";
1451
- readonly description: "Timestamp when the invitation was created";
1452
- readonly "x-oapi-codegen-extra-tags": {
1453
- readonly db: "created_at";
1454
- readonly json: "created_at";
1455
- };
1456
- };
1457
- readonly updated_at: {
1458
- readonly type: "string";
1459
- readonly format: "date-time";
1460
- readonly description: "Timestamp when the invitation was last updated";
1461
- readonly "x-oapi-codegen-extra-tags": {
1462
- readonly db: "updated_at";
1463
- readonly json: "updated_at";
1464
- };
1465
- };
1466
- readonly deleted_at: {
1467
- readonly type: "string";
1468
- readonly format: "date-time";
1469
- readonly "x-go-type": "core.NullTime";
1470
- readonly description: "Timestamp when the invitation was deleted, if applicable";
1471
- readonly "x-oapi-codegen-extra-tags": {
1472
- readonly db: "deleted_at";
1473
- readonly json: "deleted_at";
1474
- };
1475
- };
1476
- };
1477
- readonly "x-go-type": "Invitation";
1478
- };
1479
- readonly description: "List of invitations";
1480
- readonly "x-oapi-codegen-extra-tags": {
1481
- readonly json: "data";
1482
- };
1483
- };
1484
- readonly total: {
1485
- readonly type: "integer";
1486
- readonly description: "Total number of invitations available";
1487
- readonly "x-oapi-codegen-extra-tags": {
1488
- readonly json: "total";
1489
- };
1490
- };
1491
- };
1492
- };
1493
- readonly InvitationStatus: {
1494
- readonly type: "string";
1495
- readonly enum: readonly ["enabled", "disabled"];
1496
- readonly 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.";
1497
- };
1498
- readonly Invitation: {
1499
- readonly type: "object";
1500
- readonly required: readonly ["id", "owner_id", "name", "description", "org_id", "accepted_by", "emails", "roles", "teams", "status", "created_at", "updated_at", "deleted_at"];
1501
- readonly properties: {
1502
- readonly id: {
1503
- readonly "x-go-name": "ID";
1504
- readonly description: "Unique identifier for the invitation , is also used as the invitation code";
1505
- readonly type: "string";
1506
- readonly format: "uuid";
1507
- readonly "x-go-type": "uuid.UUID";
1508
- readonly "x-go-type-import": {
1509
- readonly path: "github.com/gofrs/uuid";
1510
- };
1511
- };
1512
- readonly owner_id: {
1513
- readonly 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";
1514
- readonly "x-oapi-codegen-extra-tags": {
1515
- readonly db: "owner_id";
1516
- readonly json: "owner_id";
1517
- };
1518
- readonly type: "string";
1519
- readonly format: "uuid";
1520
- readonly "x-go-type": "uuid.UUID";
1521
- readonly "x-go-type-import": {
1522
- readonly path: "github.com/gofrs/uuid";
1523
- };
1524
- };
1525
- readonly is_default: {
1526
- readonly type: "boolean";
1527
- readonly 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";
1528
- readonly "x-oapi-codegen-extra-tags": {
1529
- readonly db: "is_default";
1530
- readonly json: "is_default";
1531
- };
1532
- };
1533
- readonly name: {
1534
- readonly type: "string";
1535
- readonly description: "Name of the invitation, which can be used to identify the invitation, required and cant be empty string,";
1536
- };
1537
- readonly description: {
1538
- readonly type: "string";
1539
- readonly 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";
1540
- };
1541
- readonly emails: {
1542
- readonly type: "array";
1543
- readonly "x-go-type": "pq.StringArray";
1544
- readonly "x-go-type-import": {
1545
- readonly path: "github.com/lib/pq";
1546
- };
1547
- readonly items: {
1548
- readonly type: "string";
1549
- readonly pattern: "^([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-z]{2,}|@[a-zA-Z0-9.-]+\\.[a-z]{2,})$";
1550
- readonly "x-go-type": "string";
1551
- readonly description: "Exact email address or the email address pattern for which the invitation is valid , null means the invitation is valid for all email addresses";
1552
- };
1553
- };
1554
- readonly org_id: {
1555
- readonly type: "string";
1556
- readonly description: "ID of the organization to which the user is invited";
1557
- readonly "x-oapi-codegen-extra-tags": {
1558
- readonly db: "org_id";
1559
- readonly json: "org_id";
1560
- };
1561
- };
1562
- readonly expires_at: {
1563
- readonly type: "string";
1564
- readonly format: "date-time";
1565
- readonly description: "Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire";
1566
- readonly "x-oapi-codegen-extra-tags": {
1567
- readonly db: "expires_at";
1568
- readonly json: "expires_at";
1569
- };
1570
- };
1571
- readonly quota: {
1572
- readonly type: "integer";
1573
- readonly 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";
1574
- };
1575
- readonly accepted_by: {
1576
- readonly type: "array";
1577
- readonly "x-go-type": "pq.StringArray";
1578
- readonly "x-go-type-import": {
1579
- readonly path: "github.com/lib/pq";
1580
- };
1581
- readonly items: {
1582
- readonly type: "string";
1583
- };
1584
- readonly description: "List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet";
1585
- readonly "x-oapi-codegen-extra-tags": {
1586
- readonly db: "accepted_by";
1587
- readonly json: "accepted_by";
1588
- };
1589
- };
1590
- readonly roles: {
1591
- readonly type: "array";
1592
- readonly "x-go-type": "pq.StringArray";
1593
- readonly "x-go-type-import": {
1594
- readonly path: "github.com/lib/pq";
1595
- };
1596
- readonly items: {
1597
- readonly type: "string";
1598
- readonly description: "Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles";
1599
- };
1600
- };
1601
- readonly teams: {
1602
- readonly type: "array";
1603
- readonly "x-go-type": "pq.StringArray";
1604
- readonly "x-go-type-import": {
1605
- readonly path: "github.com/lib/pq";
1606
- };
1607
- readonly items: {
1608
- readonly type: "string";
1609
- readonly description: "Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams";
1610
- };
1611
- };
1612
- readonly status: {
1613
- readonly type: "string";
1614
- readonly "x-go-type": "InvitationStatus";
1615
- readonly enum: readonly ["enabled", "disabled"];
1616
- readonly 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.";
1617
- };
1618
- readonly created_at: {
1619
- readonly type: "string";
1620
- readonly format: "date-time";
1621
- readonly description: "Timestamp when the invitation was created";
1622
- readonly "x-oapi-codegen-extra-tags": {
1623
- readonly db: "created_at";
1624
- readonly json: "created_at";
1625
- };
1626
- };
1627
- readonly updated_at: {
1628
- readonly type: "string";
1629
- readonly format: "date-time";
1630
- readonly description: "Timestamp when the invitation was last updated";
1631
- readonly "x-oapi-codegen-extra-tags": {
1632
- readonly db: "updated_at";
1633
- readonly json: "updated_at";
1634
- };
1635
- };
1636
- readonly deleted_at: {
1637
- readonly type: "string";
1638
- readonly format: "date-time";
1639
- readonly "x-go-type": "core.NullTime";
1640
- readonly description: "Timestamp when the invitation was deleted, if applicable";
1641
- readonly "x-oapi-codegen-extra-tags": {
1642
- readonly db: "deleted_at";
1643
- readonly json: "deleted_at";
1644
- };
1645
- };
1646
- };
1647
- };
1648
- };
1649
- };
1650
- };
5
+ declare const InvitationSchema: Record<string, unknown>;
1651
6
 
1652
7
  export { InvitationSchema as default };