@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.
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +114 -0
- package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1alpha1/core/Core.d.ts +832 -0
- package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1937 -0
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6417 -0
- package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/badge/Badge.d.ts +546 -0
- package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/capability/Capability.d.ts +114 -0
- package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1beta1/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/category/Category.d.ts +46 -0
- package/dist/constructs/v1beta1/category/CategorySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/component/Component.d.ts +869 -0
- package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1300 -0
- package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/core/Core.d.ts +832 -0
- package/dist/constructs/v1beta1/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/credential/Credential.d.ts +530 -0
- package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/environment/Environment.d.ts +759 -0
- package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6338 -0
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/event/Event.d.ts +570 -0
- package/dist/constructs/v1beta1/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/feature/Feature.d.ts +308 -0
- package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +983 -0
- package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/key/Key.d.ts +514 -0
- package/dist/constructs/v1beta1/key/KeySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +642 -0
- package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/model/Model.d.ts +659 -0
- package/dist/constructs/v1beta1/model/ModelSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1598 -0
- package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +18407 -0
- package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/plan/Plan.d.ts +149 -0
- package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/relationship/Relationship.d.ts +1921 -0
- package/dist/constructs/v1beta1/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/role/Role.d.ts +745 -0
- package/dist/constructs/v1beta1/role/RoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +374 -0
- package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +68 -0
- package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +752 -0
- package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/support/Support.d.ts +91 -0
- package/dist/constructs/v1beta1/support/SupportSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +846 -0
- package/dist/constructs/v1beta1/team/TeamSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/token/Token.d.ts +539 -0
- package/dist/constructs/v1beta1/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/user/User.d.ts +1677 -0
- package/dist/constructs/v1beta1/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/view/View.d.ts +759 -0
- package/dist/constructs/v1beta1/view/ViewSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4947 -0
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7762 -0
- package/dist/constructs/v1beta2/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta2/badge/Badge.d.ts +563 -0
- package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1beta2/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/component/Component.d.ts +887 -0
- package/dist/constructs/v1beta2/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1330 -0
- package/dist/constructs/v1beta2/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/core/Core.d.ts +866 -0
- package/dist/constructs/v1beta2/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/credential/Credential.d.ts +519 -0
- package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/design/Design.d.ts +19039 -0
- package/dist/constructs/v1beta2/design/DesignSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/event/Event.d.ts +626 -0
- package/dist/constructs/v1beta2/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1052 -0
- package/dist/constructs/v1beta2/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/key/Key.d.ts +524 -0
- package/dist/constructs/v1beta2/key/KeySchema.d.ts +2 -0
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +652 -0
- package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/model/Model.d.ts +697 -0
- package/dist/constructs/v1beta2/model/ModelSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/organization/Organization.d.ts +1915 -0
- package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/plan/Plan.d.ts +162 -0
- package/dist/constructs/v1beta2/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2134 -0
- package/dist/constructs/v1beta2/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/role/Role.d.ts +752 -0
- package/dist/constructs/v1beta2/role/RoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +431 -0
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +785 -0
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/team/Team.d.ts +960 -0
- package/dist/constructs/v1beta2/team/TeamSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/token/Token.d.ts +544 -0
- package/dist/constructs/v1beta2/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/user/User.d.ts +1677 -0
- package/dist/constructs/v1beta2/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/view/View.d.ts +767 -0
- package/dist/constructs/v1beta2/view/ViewSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7762 -0
- package/dist/constructs/v1beta3/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta3/component/Component.d.ts +892 -0
- package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1414 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/design/Design.d.ts +5704 -0
- package/dist/constructs/v1beta3/design/DesignSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/environment/Environment.d.ts +785 -0
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/event/Event.d.ts +720 -0
- package/dist/constructs/v1beta3/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1452 -0
- package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1060 -0
- package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +813 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/plan/Plan.d.ts +199 -0
- package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2134 -0
- package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +915 -0
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/token/Token.d.ts +544 -0
- package/dist/constructs/v1beta3/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5086 -0
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +2 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,1915 @@
|
|
|
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/identity/orgs": {
|
|
8
|
+
/** Returns organizations for the current user. */
|
|
9
|
+
get: operations["getOrgs"];
|
|
10
|
+
/** Creates a new organization. */
|
|
11
|
+
post: operations["createOrg"];
|
|
12
|
+
};
|
|
13
|
+
"/api/identity/orgs/by-domain": {
|
|
14
|
+
get: operations["getOrgByDomain"];
|
|
15
|
+
};
|
|
16
|
+
"/api/identity/orgs/{orgId}": {
|
|
17
|
+
/** Returns the organization in the single-item page wrapper currently emitted by meshery-cloud. */
|
|
18
|
+
get: operations["getOrg"];
|
|
19
|
+
/** Updates the organization. */
|
|
20
|
+
put: operations["updateOrg"];
|
|
21
|
+
/** Deletes the organization. */
|
|
22
|
+
delete: operations["deleteOrg"];
|
|
23
|
+
};
|
|
24
|
+
"/api/identity/orgs/{orgId}/preferences": {
|
|
25
|
+
/** Returns preferences for the specified organization. */
|
|
26
|
+
get: operations["getOrgPreferences"];
|
|
27
|
+
};
|
|
28
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}": {
|
|
29
|
+
/** Adds a team to an organization. If request body contains action=delete, tombstones a team by setting its deletedAt timestamp. The team's organization mapping remains intact. */
|
|
30
|
+
post: operations["addTeamToOrg"];
|
|
31
|
+
};
|
|
32
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}/remove": {
|
|
33
|
+
/** Removes (unassigns) a team from an organization. */
|
|
34
|
+
post: operations["removeTeamFromOrg"];
|
|
35
|
+
};
|
|
36
|
+
"/api/identity/orgs/{orgId}/users/{userId}": {
|
|
37
|
+
post: operations["addUserToOrg"];
|
|
38
|
+
delete: operations["deleteUserFromOrg"];
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface components {
|
|
43
|
+
schemas: {
|
|
44
|
+
/**
|
|
45
|
+
* Format: uuid
|
|
46
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
47
|
+
*/
|
|
48
|
+
UUID: string;
|
|
49
|
+
/** Format: date-time */
|
|
50
|
+
NullableTime: string;
|
|
51
|
+
/** Format: date-time */
|
|
52
|
+
Time: string;
|
|
53
|
+
Text: string;
|
|
54
|
+
MapObject: { [key: string]: string };
|
|
55
|
+
/** @description Optional action payload for POST on /api/identity/orgs/{orgId}/teams/{teamId}. */
|
|
56
|
+
OrgTeamActionPayload: {
|
|
57
|
+
/**
|
|
58
|
+
* @description Internal action to perform on the team resource.
|
|
59
|
+
* @enum {string}
|
|
60
|
+
*/
|
|
61
|
+
action?: "delete";
|
|
62
|
+
};
|
|
63
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
64
|
+
Location: {
|
|
65
|
+
/** @description SVG markup for the asset. */
|
|
66
|
+
svg: string;
|
|
67
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
68
|
+
location: string;
|
|
69
|
+
};
|
|
70
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
71
|
+
Logo: {
|
|
72
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
73
|
+
desktopView: {
|
|
74
|
+
/** @description SVG markup for the asset. */
|
|
75
|
+
svg: string;
|
|
76
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
77
|
+
location: string;
|
|
78
|
+
};
|
|
79
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
80
|
+
mobileView: {
|
|
81
|
+
/** @description SVG markup for the asset. */
|
|
82
|
+
svg: string;
|
|
83
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
84
|
+
location: string;
|
|
85
|
+
};
|
|
86
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
87
|
+
darkDesktopView: {
|
|
88
|
+
/** @description SVG markup for the asset. */
|
|
89
|
+
svg: string;
|
|
90
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
91
|
+
location: string;
|
|
92
|
+
};
|
|
93
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
94
|
+
darkMobileView: {
|
|
95
|
+
/** @description SVG markup for the asset. */
|
|
96
|
+
svg: string;
|
|
97
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
98
|
+
location: string;
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
/** @description UI theme configured for an organization. */
|
|
102
|
+
Theme: {
|
|
103
|
+
/**
|
|
104
|
+
* Format: uuid
|
|
105
|
+
* @description Theme identifier.
|
|
106
|
+
*/
|
|
107
|
+
id: string;
|
|
108
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
109
|
+
logo: {
|
|
110
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
111
|
+
desktopView: {
|
|
112
|
+
/** @description SVG markup for the asset. */
|
|
113
|
+
svg: string;
|
|
114
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
115
|
+
location: string;
|
|
116
|
+
};
|
|
117
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
118
|
+
mobileView: {
|
|
119
|
+
/** @description SVG markup for the asset. */
|
|
120
|
+
svg: string;
|
|
121
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
122
|
+
location: string;
|
|
123
|
+
};
|
|
124
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
125
|
+
darkDesktopView: {
|
|
126
|
+
/** @description SVG markup for the asset. */
|
|
127
|
+
svg: string;
|
|
128
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
129
|
+
location: string;
|
|
130
|
+
};
|
|
131
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
132
|
+
darkMobileView: {
|
|
133
|
+
/** @description SVG markup for the asset. */
|
|
134
|
+
svg: string;
|
|
135
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
136
|
+
location: string;
|
|
137
|
+
};
|
|
138
|
+
};
|
|
139
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
140
|
+
vars?: { [key: string]: unknown };
|
|
141
|
+
};
|
|
142
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
143
|
+
DashboardPrefs: { [key: string]: unknown };
|
|
144
|
+
/** @description Organization-level user experience preferences. */
|
|
145
|
+
Preferences: {
|
|
146
|
+
/** @description UI theme configured for an organization. */
|
|
147
|
+
theme: {
|
|
148
|
+
/**
|
|
149
|
+
* Format: uuid
|
|
150
|
+
* @description Theme identifier.
|
|
151
|
+
*/
|
|
152
|
+
id: string;
|
|
153
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
154
|
+
logo: {
|
|
155
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
156
|
+
desktopView: {
|
|
157
|
+
/** @description SVG markup for the asset. */
|
|
158
|
+
svg: string;
|
|
159
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
160
|
+
location: string;
|
|
161
|
+
};
|
|
162
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
163
|
+
mobileView: {
|
|
164
|
+
/** @description SVG markup for the asset. */
|
|
165
|
+
svg: string;
|
|
166
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
167
|
+
location: string;
|
|
168
|
+
};
|
|
169
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
170
|
+
darkDesktopView: {
|
|
171
|
+
/** @description SVG markup for the asset. */
|
|
172
|
+
svg: string;
|
|
173
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
174
|
+
location: string;
|
|
175
|
+
};
|
|
176
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
177
|
+
darkMobileView: {
|
|
178
|
+
/** @description SVG markup for the asset. */
|
|
179
|
+
svg: string;
|
|
180
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
181
|
+
location: string;
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
185
|
+
vars?: { [key: string]: unknown };
|
|
186
|
+
};
|
|
187
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
188
|
+
dashboard: { [key: string]: unknown };
|
|
189
|
+
};
|
|
190
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
191
|
+
OrgMetadata: {
|
|
192
|
+
/** @description Organization-level user experience preferences. */
|
|
193
|
+
preferences: {
|
|
194
|
+
/** @description UI theme configured for an organization. */
|
|
195
|
+
theme: {
|
|
196
|
+
/**
|
|
197
|
+
* Format: uuid
|
|
198
|
+
* @description Theme identifier.
|
|
199
|
+
*/
|
|
200
|
+
id: string;
|
|
201
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
202
|
+
logo: {
|
|
203
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
204
|
+
desktopView: {
|
|
205
|
+
/** @description SVG markup for the asset. */
|
|
206
|
+
svg: string;
|
|
207
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
208
|
+
location: string;
|
|
209
|
+
};
|
|
210
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
211
|
+
mobileView: {
|
|
212
|
+
/** @description SVG markup for the asset. */
|
|
213
|
+
svg: string;
|
|
214
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
215
|
+
location: string;
|
|
216
|
+
};
|
|
217
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
218
|
+
darkDesktopView: {
|
|
219
|
+
/** @description SVG markup for the asset. */
|
|
220
|
+
svg: string;
|
|
221
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
222
|
+
location: string;
|
|
223
|
+
};
|
|
224
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
225
|
+
darkMobileView: {
|
|
226
|
+
/** @description SVG markup for the asset. */
|
|
227
|
+
svg: string;
|
|
228
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
229
|
+
location: string;
|
|
230
|
+
};
|
|
231
|
+
};
|
|
232
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
233
|
+
vars?: { [key: string]: unknown };
|
|
234
|
+
};
|
|
235
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
236
|
+
dashboard: { [key: string]: unknown };
|
|
237
|
+
};
|
|
238
|
+
};
|
|
239
|
+
/** @description An organization in Meshery Cloud. Organizations are the top-level tenancy boundary and own teams, workspaces, environments, designs, and other resources. Learn more at https://docs.meshery.io/concepts/logical/organizations */
|
|
240
|
+
Organization: {
|
|
241
|
+
/**
|
|
242
|
+
* Format: uuid
|
|
243
|
+
* @description Organization ID.
|
|
244
|
+
*/
|
|
245
|
+
id: string;
|
|
246
|
+
/** @description Name of the organization. */
|
|
247
|
+
name: string;
|
|
248
|
+
/** @description Country of the organization. */
|
|
249
|
+
country: string;
|
|
250
|
+
/** @description Region of the organization. */
|
|
251
|
+
region: string;
|
|
252
|
+
/** @description Description of the organization. */
|
|
253
|
+
description: string;
|
|
254
|
+
/**
|
|
255
|
+
* Format: uuid
|
|
256
|
+
* @description Owner user ID of the organization.
|
|
257
|
+
*/
|
|
258
|
+
owner: string;
|
|
259
|
+
/** @description Free-form metadata associated with the organization, including preferences. */
|
|
260
|
+
metadata: { [key: string]: unknown };
|
|
261
|
+
/** @description Domain of the organization. */
|
|
262
|
+
domain?: string | null;
|
|
263
|
+
/**
|
|
264
|
+
* Format: date-time
|
|
265
|
+
* @description Timestamp when the organization was created.
|
|
266
|
+
*/
|
|
267
|
+
createdAt: string;
|
|
268
|
+
/**
|
|
269
|
+
* Format: date-time
|
|
270
|
+
* @description Timestamp when the organization was last updated.
|
|
271
|
+
*/
|
|
272
|
+
updatedAt: string;
|
|
273
|
+
/**
|
|
274
|
+
* Format: date-time
|
|
275
|
+
* @description Timestamp when the organization was soft-deleted. Null while the organization is active.
|
|
276
|
+
*/
|
|
277
|
+
deletedAt?: string;
|
|
278
|
+
};
|
|
279
|
+
/** @description Organization listing record used in list and get responses. */
|
|
280
|
+
AvailableOrganization: {
|
|
281
|
+
/**
|
|
282
|
+
* Format: uuid
|
|
283
|
+
* @description Organization ID.
|
|
284
|
+
*/
|
|
285
|
+
id?: string;
|
|
286
|
+
/** @description Name of the organization. */
|
|
287
|
+
name?: string;
|
|
288
|
+
/** @description Description of the organization. */
|
|
289
|
+
description?: string;
|
|
290
|
+
/** @description Country of the organization. */
|
|
291
|
+
country?: string;
|
|
292
|
+
/** @description Region of the organization. */
|
|
293
|
+
region?: string;
|
|
294
|
+
/** @description Display name of the organization owner. */
|
|
295
|
+
owner?: string;
|
|
296
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
297
|
+
metadata?: {
|
|
298
|
+
/** @description Organization-level user experience preferences. */
|
|
299
|
+
preferences: {
|
|
300
|
+
/** @description UI theme configured for an organization. */
|
|
301
|
+
theme: {
|
|
302
|
+
/**
|
|
303
|
+
* Format: uuid
|
|
304
|
+
* @description Theme identifier.
|
|
305
|
+
*/
|
|
306
|
+
id: string;
|
|
307
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
308
|
+
logo: {
|
|
309
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
310
|
+
desktopView: {
|
|
311
|
+
/** @description SVG markup for the asset. */
|
|
312
|
+
svg: string;
|
|
313
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
314
|
+
location: string;
|
|
315
|
+
};
|
|
316
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
317
|
+
mobileView: {
|
|
318
|
+
/** @description SVG markup for the asset. */
|
|
319
|
+
svg: string;
|
|
320
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
321
|
+
location: string;
|
|
322
|
+
};
|
|
323
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
324
|
+
darkDesktopView: {
|
|
325
|
+
/** @description SVG markup for the asset. */
|
|
326
|
+
svg: string;
|
|
327
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
328
|
+
location: string;
|
|
329
|
+
};
|
|
330
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
331
|
+
darkMobileView: {
|
|
332
|
+
/** @description SVG markup for the asset. */
|
|
333
|
+
svg: string;
|
|
334
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
335
|
+
location: string;
|
|
336
|
+
};
|
|
337
|
+
};
|
|
338
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
339
|
+
vars?: { [key: string]: unknown };
|
|
340
|
+
};
|
|
341
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
342
|
+
dashboard: { [key: string]: unknown };
|
|
343
|
+
};
|
|
344
|
+
};
|
|
345
|
+
/**
|
|
346
|
+
* Format: date-time
|
|
347
|
+
* @description Timestamp when the organization was created.
|
|
348
|
+
*/
|
|
349
|
+
createdAt?: string;
|
|
350
|
+
/**
|
|
351
|
+
* Format: date-time
|
|
352
|
+
* @description Timestamp when the organization was last updated.
|
|
353
|
+
*/
|
|
354
|
+
updatedAt?: string;
|
|
355
|
+
/**
|
|
356
|
+
* Format: date-time
|
|
357
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
358
|
+
*/
|
|
359
|
+
deletedAt?: string;
|
|
360
|
+
};
|
|
361
|
+
/** @description Paginated list of organizations. */
|
|
362
|
+
OrganizationsPage: {
|
|
363
|
+
/** @description Zero-based page index returned in this response. */
|
|
364
|
+
page?: number;
|
|
365
|
+
/** @description Maximum number of items returned on each page. */
|
|
366
|
+
pageSize?: number;
|
|
367
|
+
/** @description Total number of items across all pages. */
|
|
368
|
+
totalCount?: number;
|
|
369
|
+
/** @description Organizations in this page. */
|
|
370
|
+
organizations?: {
|
|
371
|
+
/**
|
|
372
|
+
* Format: uuid
|
|
373
|
+
* @description Organization ID.
|
|
374
|
+
*/
|
|
375
|
+
id?: string;
|
|
376
|
+
/** @description Name of the organization. */
|
|
377
|
+
name?: string;
|
|
378
|
+
/** @description Description of the organization. */
|
|
379
|
+
description?: string;
|
|
380
|
+
/** @description Country of the organization. */
|
|
381
|
+
country?: string;
|
|
382
|
+
/** @description Region of the organization. */
|
|
383
|
+
region?: string;
|
|
384
|
+
/** @description Display name of the organization owner. */
|
|
385
|
+
owner?: string;
|
|
386
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
387
|
+
metadata?: {
|
|
388
|
+
/** @description Organization-level user experience preferences. */
|
|
389
|
+
preferences: {
|
|
390
|
+
/** @description UI theme configured for an organization. */
|
|
391
|
+
theme: {
|
|
392
|
+
/**
|
|
393
|
+
* Format: uuid
|
|
394
|
+
* @description Theme identifier.
|
|
395
|
+
*/
|
|
396
|
+
id: string;
|
|
397
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
398
|
+
logo: {
|
|
399
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
400
|
+
desktopView: {
|
|
401
|
+
/** @description SVG markup for the asset. */
|
|
402
|
+
svg: string;
|
|
403
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
404
|
+
location: string;
|
|
405
|
+
};
|
|
406
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
407
|
+
mobileView: {
|
|
408
|
+
/** @description SVG markup for the asset. */
|
|
409
|
+
svg: string;
|
|
410
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
411
|
+
location: string;
|
|
412
|
+
};
|
|
413
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
414
|
+
darkDesktopView: {
|
|
415
|
+
/** @description SVG markup for the asset. */
|
|
416
|
+
svg: string;
|
|
417
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
418
|
+
location: string;
|
|
419
|
+
};
|
|
420
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
421
|
+
darkMobileView: {
|
|
422
|
+
/** @description SVG markup for the asset. */
|
|
423
|
+
svg: string;
|
|
424
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
425
|
+
location: string;
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
429
|
+
vars?: { [key: string]: unknown };
|
|
430
|
+
};
|
|
431
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
432
|
+
dashboard: { [key: string]: unknown };
|
|
433
|
+
};
|
|
434
|
+
};
|
|
435
|
+
/**
|
|
436
|
+
* Format: date-time
|
|
437
|
+
* @description Timestamp when the organization was created.
|
|
438
|
+
*/
|
|
439
|
+
createdAt?: string;
|
|
440
|
+
/**
|
|
441
|
+
* Format: date-time
|
|
442
|
+
* @description Timestamp when the organization was last updated.
|
|
443
|
+
*/
|
|
444
|
+
updatedAt?: string;
|
|
445
|
+
/**
|
|
446
|
+
* Format: date-time
|
|
447
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
448
|
+
*/
|
|
449
|
+
deletedAt?: string;
|
|
450
|
+
}[];
|
|
451
|
+
};
|
|
452
|
+
/** @description Single-organization wrapper used by current meshery-cloud organization handlers. */
|
|
453
|
+
OrganizationPage: {
|
|
454
|
+
/** @description Zero-based page index returned in this response. */
|
|
455
|
+
page?: number;
|
|
456
|
+
/** @description Maximum number of items returned on each page. */
|
|
457
|
+
pageSize?: number;
|
|
458
|
+
/** @description Total number of items across all pages. */
|
|
459
|
+
totalCount?: number;
|
|
460
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
461
|
+
organizations?: {
|
|
462
|
+
/**
|
|
463
|
+
* Format: uuid
|
|
464
|
+
* @description Organization ID.
|
|
465
|
+
*/
|
|
466
|
+
id?: string;
|
|
467
|
+
/** @description Name of the organization. */
|
|
468
|
+
name?: string;
|
|
469
|
+
/** @description Description of the organization. */
|
|
470
|
+
description?: string;
|
|
471
|
+
/** @description Country of the organization. */
|
|
472
|
+
country?: string;
|
|
473
|
+
/** @description Region of the organization. */
|
|
474
|
+
region?: string;
|
|
475
|
+
/** @description Display name of the organization owner. */
|
|
476
|
+
owner?: string;
|
|
477
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
478
|
+
metadata?: {
|
|
479
|
+
/** @description Organization-level user experience preferences. */
|
|
480
|
+
preferences: {
|
|
481
|
+
/** @description UI theme configured for an organization. */
|
|
482
|
+
theme: {
|
|
483
|
+
/**
|
|
484
|
+
* Format: uuid
|
|
485
|
+
* @description Theme identifier.
|
|
486
|
+
*/
|
|
487
|
+
id: string;
|
|
488
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
489
|
+
logo: {
|
|
490
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
491
|
+
desktopView: {
|
|
492
|
+
/** @description SVG markup for the asset. */
|
|
493
|
+
svg: string;
|
|
494
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
495
|
+
location: string;
|
|
496
|
+
};
|
|
497
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
498
|
+
mobileView: {
|
|
499
|
+
/** @description SVG markup for the asset. */
|
|
500
|
+
svg: string;
|
|
501
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
502
|
+
location: string;
|
|
503
|
+
};
|
|
504
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
505
|
+
darkDesktopView: {
|
|
506
|
+
/** @description SVG markup for the asset. */
|
|
507
|
+
svg: string;
|
|
508
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
509
|
+
location: string;
|
|
510
|
+
};
|
|
511
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
512
|
+
darkMobileView: {
|
|
513
|
+
/** @description SVG markup for the asset. */
|
|
514
|
+
svg: string;
|
|
515
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
516
|
+
location: string;
|
|
517
|
+
};
|
|
518
|
+
};
|
|
519
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
520
|
+
vars?: { [key: string]: unknown };
|
|
521
|
+
};
|
|
522
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
523
|
+
dashboard: { [key: string]: unknown };
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
/**
|
|
527
|
+
* Format: date-time
|
|
528
|
+
* @description Timestamp when the organization was created.
|
|
529
|
+
*/
|
|
530
|
+
createdAt?: string;
|
|
531
|
+
/**
|
|
532
|
+
* Format: date-time
|
|
533
|
+
* @description Timestamp when the organization was last updated.
|
|
534
|
+
*/
|
|
535
|
+
updatedAt?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Format: date-time
|
|
538
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
539
|
+
*/
|
|
540
|
+
deletedAt?: string;
|
|
541
|
+
}[];
|
|
542
|
+
};
|
|
543
|
+
/** @description Payload for creating or updating an organization. Contains only client-settable fields. */
|
|
544
|
+
OrganizationPayload: {
|
|
545
|
+
/** @description Name of the organization. */
|
|
546
|
+
name?: string;
|
|
547
|
+
/** @description Country of the organization. */
|
|
548
|
+
country?: string;
|
|
549
|
+
/** @description Region of the organization. */
|
|
550
|
+
region?: string;
|
|
551
|
+
/** @description Description of the organization. */
|
|
552
|
+
description?: string;
|
|
553
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
554
|
+
notifyOrgUpdate?: boolean;
|
|
555
|
+
/** @description Organization-level user experience preferences. */
|
|
556
|
+
preferences?: {
|
|
557
|
+
/** @description UI theme configured for an organization. */
|
|
558
|
+
theme: {
|
|
559
|
+
/**
|
|
560
|
+
* Format: uuid
|
|
561
|
+
* @description Theme identifier.
|
|
562
|
+
*/
|
|
563
|
+
id: string;
|
|
564
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
565
|
+
logo: {
|
|
566
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
567
|
+
desktopView: {
|
|
568
|
+
/** @description SVG markup for the asset. */
|
|
569
|
+
svg: string;
|
|
570
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
571
|
+
location: string;
|
|
572
|
+
};
|
|
573
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
574
|
+
mobileView: {
|
|
575
|
+
/** @description SVG markup for the asset. */
|
|
576
|
+
svg: string;
|
|
577
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
578
|
+
location: string;
|
|
579
|
+
};
|
|
580
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
581
|
+
darkDesktopView: {
|
|
582
|
+
/** @description SVG markup for the asset. */
|
|
583
|
+
svg: string;
|
|
584
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
585
|
+
location: string;
|
|
586
|
+
};
|
|
587
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
588
|
+
darkMobileView: {
|
|
589
|
+
/** @description SVG markup for the asset. */
|
|
590
|
+
svg: string;
|
|
591
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
592
|
+
location: string;
|
|
593
|
+
};
|
|
594
|
+
};
|
|
595
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
596
|
+
vars?: { [key: string]: unknown };
|
|
597
|
+
};
|
|
598
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
599
|
+
dashboard: { [key: string]: unknown };
|
|
600
|
+
};
|
|
601
|
+
};
|
|
602
|
+
/** @description Team listing record used in team listings associated with an organization. */
|
|
603
|
+
AvailableTeam: {
|
|
604
|
+
/**
|
|
605
|
+
* Format: uuid
|
|
606
|
+
* @description Team ID.
|
|
607
|
+
*/
|
|
608
|
+
id?: string;
|
|
609
|
+
/** @description Name of the team. */
|
|
610
|
+
name?: string;
|
|
611
|
+
/** @description Description of the team. */
|
|
612
|
+
description?: string;
|
|
613
|
+
/** @description Display name of the team owner. */
|
|
614
|
+
owner?: string;
|
|
615
|
+
/** @description Free-form team metadata. */
|
|
616
|
+
metadata?: { [key: string]: string };
|
|
617
|
+
/**
|
|
618
|
+
* Format: date-time
|
|
619
|
+
* @description Timestamp when the team was created.
|
|
620
|
+
*/
|
|
621
|
+
createdAt?: string;
|
|
622
|
+
/**
|
|
623
|
+
* Format: date-time
|
|
624
|
+
* @description Timestamp when the team was last updated.
|
|
625
|
+
*/
|
|
626
|
+
updatedAt?: string;
|
|
627
|
+
/**
|
|
628
|
+
* Format: date-time
|
|
629
|
+
* @description Timestamp when the team was soft-deleted.
|
|
630
|
+
*/
|
|
631
|
+
deletedAt?: string;
|
|
632
|
+
};
|
|
633
|
+
/** @description Paginated list of teams. */
|
|
634
|
+
TeamsPage: {
|
|
635
|
+
/** @description Zero-based page index returned in this response. */
|
|
636
|
+
page?: number;
|
|
637
|
+
/** @description Maximum number of items returned on each page. */
|
|
638
|
+
pageSize?: number;
|
|
639
|
+
/** @description Total number of items across all pages. */
|
|
640
|
+
totalCount?: number;
|
|
641
|
+
/** @description Teams in this page. */
|
|
642
|
+
teams?: {
|
|
643
|
+
/**
|
|
644
|
+
* Format: uuid
|
|
645
|
+
* @description Team ID.
|
|
646
|
+
*/
|
|
647
|
+
id?: string;
|
|
648
|
+
/** @description Name of the team. */
|
|
649
|
+
name?: string;
|
|
650
|
+
/** @description Description of the team. */
|
|
651
|
+
description?: string;
|
|
652
|
+
/** @description Display name of the team owner. */
|
|
653
|
+
owner?: string;
|
|
654
|
+
/** @description Free-form team metadata. */
|
|
655
|
+
metadata?: { [key: string]: string };
|
|
656
|
+
/**
|
|
657
|
+
* Format: date-time
|
|
658
|
+
* @description Timestamp when the team was created.
|
|
659
|
+
*/
|
|
660
|
+
createdAt?: string;
|
|
661
|
+
/**
|
|
662
|
+
* Format: date-time
|
|
663
|
+
* @description Timestamp when the team was last updated.
|
|
664
|
+
*/
|
|
665
|
+
updatedAt?: string;
|
|
666
|
+
/**
|
|
667
|
+
* Format: date-time
|
|
668
|
+
* @description Timestamp when the team was soft-deleted.
|
|
669
|
+
*/
|
|
670
|
+
deletedAt?: string;
|
|
671
|
+
}[];
|
|
672
|
+
};
|
|
673
|
+
/** @description Junction record linking a team to an organization. */
|
|
674
|
+
TeamsOrganizationsMapping: {
|
|
675
|
+
/**
|
|
676
|
+
* Format: uuid
|
|
677
|
+
* @description Mapping record ID.
|
|
678
|
+
*/
|
|
679
|
+
id?: string;
|
|
680
|
+
/**
|
|
681
|
+
* Format: uuid
|
|
682
|
+
* @description Organization ID for this mapping.
|
|
683
|
+
*/
|
|
684
|
+
orgId?: string;
|
|
685
|
+
/**
|
|
686
|
+
* Format: uuid
|
|
687
|
+
* @description Team ID for this mapping.
|
|
688
|
+
*/
|
|
689
|
+
teamId?: string;
|
|
690
|
+
/**
|
|
691
|
+
* Format: date-time
|
|
692
|
+
* @description Timestamp when the mapping was created.
|
|
693
|
+
*/
|
|
694
|
+
createdAt?: string;
|
|
695
|
+
/**
|
|
696
|
+
* Format: date-time
|
|
697
|
+
* @description Timestamp when the mapping was last updated.
|
|
698
|
+
*/
|
|
699
|
+
updatedAt?: string;
|
|
700
|
+
/**
|
|
701
|
+
* Format: date-time
|
|
702
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
703
|
+
*/
|
|
704
|
+
deletedAt?: string;
|
|
705
|
+
};
|
|
706
|
+
/** @description Paginated list of team-organization mappings. */
|
|
707
|
+
TeamsOrganizationsMappingPage: {
|
|
708
|
+
/** @description Zero-based page index returned in this response. */
|
|
709
|
+
page?: number;
|
|
710
|
+
/** @description Maximum number of items returned on each page. */
|
|
711
|
+
pageSize?: number;
|
|
712
|
+
/** @description Total number of items across all pages. */
|
|
713
|
+
totalCount?: number;
|
|
714
|
+
/** @description Team-organization mapping entries. */
|
|
715
|
+
teamsOrganizationsMapping?: {
|
|
716
|
+
/**
|
|
717
|
+
* Format: uuid
|
|
718
|
+
* @description Mapping record ID.
|
|
719
|
+
*/
|
|
720
|
+
id?: string;
|
|
721
|
+
/**
|
|
722
|
+
* Format: uuid
|
|
723
|
+
* @description Organization ID for this mapping.
|
|
724
|
+
*/
|
|
725
|
+
orgId?: string;
|
|
726
|
+
/**
|
|
727
|
+
* Format: uuid
|
|
728
|
+
* @description Team ID for this mapping.
|
|
729
|
+
*/
|
|
730
|
+
teamId?: string;
|
|
731
|
+
/**
|
|
732
|
+
* Format: date-time
|
|
733
|
+
* @description Timestamp when the mapping was created.
|
|
734
|
+
*/
|
|
735
|
+
createdAt?: string;
|
|
736
|
+
/**
|
|
737
|
+
* Format: date-time
|
|
738
|
+
* @description Timestamp when the mapping was last updated.
|
|
739
|
+
*/
|
|
740
|
+
updatedAt?: string;
|
|
741
|
+
/**
|
|
742
|
+
* Format: date-time
|
|
743
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
744
|
+
*/
|
|
745
|
+
deletedAt?: string;
|
|
746
|
+
}[];
|
|
747
|
+
};
|
|
748
|
+
};
|
|
749
|
+
responses: {
|
|
750
|
+
/** Invalid request body or request param */
|
|
751
|
+
400: {
|
|
752
|
+
content: {
|
|
753
|
+
"text/plain": string;
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
/** Expired JWT token used or insufficient privilege */
|
|
757
|
+
401: {
|
|
758
|
+
content: {
|
|
759
|
+
"text/plain": string;
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
/** Result not found */
|
|
763
|
+
404: {
|
|
764
|
+
content: {
|
|
765
|
+
"text/plain": string;
|
|
766
|
+
};
|
|
767
|
+
};
|
|
768
|
+
/** Internal server error */
|
|
769
|
+
500: {
|
|
770
|
+
content: {
|
|
771
|
+
"text/plain": string;
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
};
|
|
775
|
+
parameters: {
|
|
776
|
+
/** @description Organization ID. */
|
|
777
|
+
orgId: string;
|
|
778
|
+
/** @description User ID. */
|
|
779
|
+
userId: string;
|
|
780
|
+
/** @description Team ID. */
|
|
781
|
+
teamId: string;
|
|
782
|
+
/** @description Zero-based index of the result page to return. */
|
|
783
|
+
page: number;
|
|
784
|
+
/** @description Maximum number of items returned on each page. */
|
|
785
|
+
pageSize: number;
|
|
786
|
+
/** @description Get responses that match search param value */
|
|
787
|
+
search: string;
|
|
788
|
+
/** @description Get ordered responses */
|
|
789
|
+
order: string;
|
|
790
|
+
/** @description Get all possible entries */
|
|
791
|
+
all: boolean;
|
|
792
|
+
};
|
|
793
|
+
requestBodies: {
|
|
794
|
+
/** Body for creating or updating an organization */
|
|
795
|
+
organizationPayload: {
|
|
796
|
+
content: {
|
|
797
|
+
"application/json": {
|
|
798
|
+
/** @description Name of the organization. */
|
|
799
|
+
name?: string;
|
|
800
|
+
/** @description Country of the organization. */
|
|
801
|
+
country?: string;
|
|
802
|
+
/** @description Region of the organization. */
|
|
803
|
+
region?: string;
|
|
804
|
+
/** @description Description of the organization. */
|
|
805
|
+
description?: string;
|
|
806
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
807
|
+
notifyOrgUpdate?: boolean;
|
|
808
|
+
/** @description Organization-level user experience preferences. */
|
|
809
|
+
preferences?: {
|
|
810
|
+
/** @description UI theme configured for an organization. */
|
|
811
|
+
theme: {
|
|
812
|
+
/**
|
|
813
|
+
* Format: uuid
|
|
814
|
+
* @description Theme identifier.
|
|
815
|
+
*/
|
|
816
|
+
id: string;
|
|
817
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
818
|
+
logo: {
|
|
819
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
820
|
+
desktopView: {
|
|
821
|
+
/** @description SVG markup for the asset. */
|
|
822
|
+
svg: string;
|
|
823
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
824
|
+
location: string;
|
|
825
|
+
};
|
|
826
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
827
|
+
mobileView: {
|
|
828
|
+
/** @description SVG markup for the asset. */
|
|
829
|
+
svg: string;
|
|
830
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
831
|
+
location: string;
|
|
832
|
+
};
|
|
833
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
834
|
+
darkDesktopView: {
|
|
835
|
+
/** @description SVG markup for the asset. */
|
|
836
|
+
svg: string;
|
|
837
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
838
|
+
location: string;
|
|
839
|
+
};
|
|
840
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
841
|
+
darkMobileView: {
|
|
842
|
+
/** @description SVG markup for the asset. */
|
|
843
|
+
svg: string;
|
|
844
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
845
|
+
location: string;
|
|
846
|
+
};
|
|
847
|
+
};
|
|
848
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
849
|
+
vars?: { [key: string]: unknown };
|
|
850
|
+
};
|
|
851
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
852
|
+
dashboard: { [key: string]: unknown };
|
|
853
|
+
};
|
|
854
|
+
};
|
|
855
|
+
};
|
|
856
|
+
};
|
|
857
|
+
};
|
|
858
|
+
}
|
|
859
|
+
|
|
860
|
+
export interface operations {
|
|
861
|
+
/** Returns organizations for the current user. */
|
|
862
|
+
getOrgs: {
|
|
863
|
+
parameters: {
|
|
864
|
+
query: {
|
|
865
|
+
/** Zero-based index of the result page to return. */
|
|
866
|
+
page?: number;
|
|
867
|
+
/** Maximum number of items returned on each page. */
|
|
868
|
+
pageSize?: number;
|
|
869
|
+
/** Get responses that match search param value */
|
|
870
|
+
search?: string;
|
|
871
|
+
/** Get ordered responses */
|
|
872
|
+
order?: string;
|
|
873
|
+
/** Get all possible entries */
|
|
874
|
+
all?: boolean;
|
|
875
|
+
};
|
|
876
|
+
};
|
|
877
|
+
responses: {
|
|
878
|
+
/** Organizations response */
|
|
879
|
+
200: {
|
|
880
|
+
content: {
|
|
881
|
+
"application/json": {
|
|
882
|
+
/** @description Zero-based page index returned in this response. */
|
|
883
|
+
page?: number;
|
|
884
|
+
/** @description Maximum number of items returned on each page. */
|
|
885
|
+
pageSize?: number;
|
|
886
|
+
/** @description Total number of items across all pages. */
|
|
887
|
+
totalCount?: number;
|
|
888
|
+
/** @description Organizations in this page. */
|
|
889
|
+
organizations?: {
|
|
890
|
+
/**
|
|
891
|
+
* Format: uuid
|
|
892
|
+
* @description Organization ID.
|
|
893
|
+
*/
|
|
894
|
+
id?: string;
|
|
895
|
+
/** @description Name of the organization. */
|
|
896
|
+
name?: string;
|
|
897
|
+
/** @description Description of the organization. */
|
|
898
|
+
description?: string;
|
|
899
|
+
/** @description Country of the organization. */
|
|
900
|
+
country?: string;
|
|
901
|
+
/** @description Region of the organization. */
|
|
902
|
+
region?: string;
|
|
903
|
+
/** @description Display name of the organization owner. */
|
|
904
|
+
owner?: string;
|
|
905
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
906
|
+
metadata?: {
|
|
907
|
+
/** @description Organization-level user experience preferences. */
|
|
908
|
+
preferences: {
|
|
909
|
+
/** @description UI theme configured for an organization. */
|
|
910
|
+
theme: {
|
|
911
|
+
/**
|
|
912
|
+
* Format: uuid
|
|
913
|
+
* @description Theme identifier.
|
|
914
|
+
*/
|
|
915
|
+
id: string;
|
|
916
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
917
|
+
logo: {
|
|
918
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
919
|
+
desktopView: {
|
|
920
|
+
/** @description SVG markup for the asset. */
|
|
921
|
+
svg: string;
|
|
922
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
923
|
+
location: string;
|
|
924
|
+
};
|
|
925
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
926
|
+
mobileView: {
|
|
927
|
+
/** @description SVG markup for the asset. */
|
|
928
|
+
svg: string;
|
|
929
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
930
|
+
location: string;
|
|
931
|
+
};
|
|
932
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
933
|
+
darkDesktopView: {
|
|
934
|
+
/** @description SVG markup for the asset. */
|
|
935
|
+
svg: string;
|
|
936
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
937
|
+
location: string;
|
|
938
|
+
};
|
|
939
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
940
|
+
darkMobileView: {
|
|
941
|
+
/** @description SVG markup for the asset. */
|
|
942
|
+
svg: string;
|
|
943
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
944
|
+
location: string;
|
|
945
|
+
};
|
|
946
|
+
};
|
|
947
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
948
|
+
vars?: { [key: string]: unknown };
|
|
949
|
+
};
|
|
950
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
951
|
+
dashboard: { [key: string]: unknown };
|
|
952
|
+
};
|
|
953
|
+
};
|
|
954
|
+
/**
|
|
955
|
+
* Format: date-time
|
|
956
|
+
* @description Timestamp when the organization was created.
|
|
957
|
+
*/
|
|
958
|
+
createdAt?: string;
|
|
959
|
+
/**
|
|
960
|
+
* Format: date-time
|
|
961
|
+
* @description Timestamp when the organization was last updated.
|
|
962
|
+
*/
|
|
963
|
+
updatedAt?: string;
|
|
964
|
+
/**
|
|
965
|
+
* Format: date-time
|
|
966
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
967
|
+
*/
|
|
968
|
+
deletedAt?: string;
|
|
969
|
+
}[];
|
|
970
|
+
};
|
|
971
|
+
};
|
|
972
|
+
};
|
|
973
|
+
/** No content */
|
|
974
|
+
204: never;
|
|
975
|
+
/** Expired JWT token used or insufficient privilege */
|
|
976
|
+
401: {
|
|
977
|
+
content: {
|
|
978
|
+
"text/plain": string;
|
|
979
|
+
};
|
|
980
|
+
};
|
|
981
|
+
/** Internal server error */
|
|
982
|
+
500: {
|
|
983
|
+
content: {
|
|
984
|
+
"text/plain": string;
|
|
985
|
+
};
|
|
986
|
+
};
|
|
987
|
+
};
|
|
988
|
+
};
|
|
989
|
+
/** Creates a new organization. */
|
|
990
|
+
createOrg: {
|
|
991
|
+
responses: {
|
|
992
|
+
/** Single-organization page response */
|
|
993
|
+
201: {
|
|
994
|
+
content: {
|
|
995
|
+
"application/json": {
|
|
996
|
+
/** @description Zero-based page index returned in this response. */
|
|
997
|
+
page?: number;
|
|
998
|
+
/** @description Maximum number of items returned on each page. */
|
|
999
|
+
pageSize?: number;
|
|
1000
|
+
/** @description Total number of items across all pages. */
|
|
1001
|
+
totalCount?: number;
|
|
1002
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
1003
|
+
organizations?: {
|
|
1004
|
+
/**
|
|
1005
|
+
* Format: uuid
|
|
1006
|
+
* @description Organization ID.
|
|
1007
|
+
*/
|
|
1008
|
+
id?: string;
|
|
1009
|
+
/** @description Name of the organization. */
|
|
1010
|
+
name?: string;
|
|
1011
|
+
/** @description Description of the organization. */
|
|
1012
|
+
description?: string;
|
|
1013
|
+
/** @description Country of the organization. */
|
|
1014
|
+
country?: string;
|
|
1015
|
+
/** @description Region of the organization. */
|
|
1016
|
+
region?: string;
|
|
1017
|
+
/** @description Display name of the organization owner. */
|
|
1018
|
+
owner?: string;
|
|
1019
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1020
|
+
metadata?: {
|
|
1021
|
+
/** @description Organization-level user experience preferences. */
|
|
1022
|
+
preferences: {
|
|
1023
|
+
/** @description UI theme configured for an organization. */
|
|
1024
|
+
theme: {
|
|
1025
|
+
/**
|
|
1026
|
+
* Format: uuid
|
|
1027
|
+
* @description Theme identifier.
|
|
1028
|
+
*/
|
|
1029
|
+
id: string;
|
|
1030
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1031
|
+
logo: {
|
|
1032
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1033
|
+
desktopView: {
|
|
1034
|
+
/** @description SVG markup for the asset. */
|
|
1035
|
+
svg: string;
|
|
1036
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1037
|
+
location: string;
|
|
1038
|
+
};
|
|
1039
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1040
|
+
mobileView: {
|
|
1041
|
+
/** @description SVG markup for the asset. */
|
|
1042
|
+
svg: string;
|
|
1043
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1044
|
+
location: string;
|
|
1045
|
+
};
|
|
1046
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1047
|
+
darkDesktopView: {
|
|
1048
|
+
/** @description SVG markup for the asset. */
|
|
1049
|
+
svg: string;
|
|
1050
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1051
|
+
location: string;
|
|
1052
|
+
};
|
|
1053
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1054
|
+
darkMobileView: {
|
|
1055
|
+
/** @description SVG markup for the asset. */
|
|
1056
|
+
svg: string;
|
|
1057
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1058
|
+
location: string;
|
|
1059
|
+
};
|
|
1060
|
+
};
|
|
1061
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1062
|
+
vars?: { [key: string]: unknown };
|
|
1063
|
+
};
|
|
1064
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1065
|
+
dashboard: { [key: string]: unknown };
|
|
1066
|
+
};
|
|
1067
|
+
};
|
|
1068
|
+
/**
|
|
1069
|
+
* Format: date-time
|
|
1070
|
+
* @description Timestamp when the organization was created.
|
|
1071
|
+
*/
|
|
1072
|
+
createdAt?: string;
|
|
1073
|
+
/**
|
|
1074
|
+
* Format: date-time
|
|
1075
|
+
* @description Timestamp when the organization was last updated.
|
|
1076
|
+
*/
|
|
1077
|
+
updatedAt?: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* Format: date-time
|
|
1080
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1081
|
+
*/
|
|
1082
|
+
deletedAt?: string;
|
|
1083
|
+
}[];
|
|
1084
|
+
};
|
|
1085
|
+
};
|
|
1086
|
+
};
|
|
1087
|
+
/** Invalid request body or request param */
|
|
1088
|
+
400: {
|
|
1089
|
+
content: {
|
|
1090
|
+
"text/plain": string;
|
|
1091
|
+
};
|
|
1092
|
+
};
|
|
1093
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1094
|
+
401: {
|
|
1095
|
+
content: {
|
|
1096
|
+
"text/plain": string;
|
|
1097
|
+
};
|
|
1098
|
+
};
|
|
1099
|
+
/** Internal server error */
|
|
1100
|
+
500: {
|
|
1101
|
+
content: {
|
|
1102
|
+
"text/plain": string;
|
|
1103
|
+
};
|
|
1104
|
+
};
|
|
1105
|
+
};
|
|
1106
|
+
/** Body for creating or updating an organization */
|
|
1107
|
+
requestBody: {
|
|
1108
|
+
content: {
|
|
1109
|
+
"application/json": {
|
|
1110
|
+
/** @description Name of the organization. */
|
|
1111
|
+
name?: string;
|
|
1112
|
+
/** @description Country of the organization. */
|
|
1113
|
+
country?: string;
|
|
1114
|
+
/** @description Region of the organization. */
|
|
1115
|
+
region?: string;
|
|
1116
|
+
/** @description Description of the organization. */
|
|
1117
|
+
description?: string;
|
|
1118
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
1119
|
+
notifyOrgUpdate?: boolean;
|
|
1120
|
+
/** @description Organization-level user experience preferences. */
|
|
1121
|
+
preferences?: {
|
|
1122
|
+
/** @description UI theme configured for an organization. */
|
|
1123
|
+
theme: {
|
|
1124
|
+
/**
|
|
1125
|
+
* Format: uuid
|
|
1126
|
+
* @description Theme identifier.
|
|
1127
|
+
*/
|
|
1128
|
+
id: string;
|
|
1129
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1130
|
+
logo: {
|
|
1131
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1132
|
+
desktopView: {
|
|
1133
|
+
/** @description SVG markup for the asset. */
|
|
1134
|
+
svg: string;
|
|
1135
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1136
|
+
location: string;
|
|
1137
|
+
};
|
|
1138
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1139
|
+
mobileView: {
|
|
1140
|
+
/** @description SVG markup for the asset. */
|
|
1141
|
+
svg: string;
|
|
1142
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1143
|
+
location: string;
|
|
1144
|
+
};
|
|
1145
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1146
|
+
darkDesktopView: {
|
|
1147
|
+
/** @description SVG markup for the asset. */
|
|
1148
|
+
svg: string;
|
|
1149
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1150
|
+
location: string;
|
|
1151
|
+
};
|
|
1152
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1153
|
+
darkMobileView: {
|
|
1154
|
+
/** @description SVG markup for the asset. */
|
|
1155
|
+
svg: string;
|
|
1156
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1157
|
+
location: string;
|
|
1158
|
+
};
|
|
1159
|
+
};
|
|
1160
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1161
|
+
vars?: { [key: string]: unknown };
|
|
1162
|
+
};
|
|
1163
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1164
|
+
dashboard: { [key: string]: unknown };
|
|
1165
|
+
};
|
|
1166
|
+
};
|
|
1167
|
+
};
|
|
1168
|
+
};
|
|
1169
|
+
};
|
|
1170
|
+
getOrgByDomain: {
|
|
1171
|
+
parameters: {
|
|
1172
|
+
query: {
|
|
1173
|
+
/** Domain name of the organization to look up. */
|
|
1174
|
+
domain: string;
|
|
1175
|
+
};
|
|
1176
|
+
};
|
|
1177
|
+
responses: {
|
|
1178
|
+
/** Organization response */
|
|
1179
|
+
200: {
|
|
1180
|
+
content: {
|
|
1181
|
+
"application/json": {
|
|
1182
|
+
/**
|
|
1183
|
+
* Format: uuid
|
|
1184
|
+
* @description Organization ID.
|
|
1185
|
+
*/
|
|
1186
|
+
id: string;
|
|
1187
|
+
/** @description Name of the organization. */
|
|
1188
|
+
name: string;
|
|
1189
|
+
/** @description Country of the organization. */
|
|
1190
|
+
country: string;
|
|
1191
|
+
/** @description Region of the organization. */
|
|
1192
|
+
region: string;
|
|
1193
|
+
/** @description Description of the organization. */
|
|
1194
|
+
description: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* Format: uuid
|
|
1197
|
+
* @description Owner user ID of the organization.
|
|
1198
|
+
*/
|
|
1199
|
+
owner: string;
|
|
1200
|
+
/** @description Free-form metadata associated with the organization, including preferences. */
|
|
1201
|
+
metadata: { [key: string]: unknown };
|
|
1202
|
+
/** @description Domain of the organization. */
|
|
1203
|
+
domain?: string | null;
|
|
1204
|
+
/**
|
|
1205
|
+
* Format: date-time
|
|
1206
|
+
* @description Timestamp when the organization was created.
|
|
1207
|
+
*/
|
|
1208
|
+
createdAt: string;
|
|
1209
|
+
/**
|
|
1210
|
+
* Format: date-time
|
|
1211
|
+
* @description Timestamp when the organization was last updated.
|
|
1212
|
+
*/
|
|
1213
|
+
updatedAt: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* Format: date-time
|
|
1216
|
+
* @description Timestamp when the organization was soft-deleted. Null while the organization is active.
|
|
1217
|
+
*/
|
|
1218
|
+
deletedAt?: string;
|
|
1219
|
+
};
|
|
1220
|
+
};
|
|
1221
|
+
};
|
|
1222
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1223
|
+
401: {
|
|
1224
|
+
content: {
|
|
1225
|
+
"text/plain": string;
|
|
1226
|
+
};
|
|
1227
|
+
};
|
|
1228
|
+
/** Organization not found */
|
|
1229
|
+
404: unknown;
|
|
1230
|
+
/** Internal server error */
|
|
1231
|
+
500: unknown;
|
|
1232
|
+
};
|
|
1233
|
+
};
|
|
1234
|
+
/** Returns the organization in the single-item page wrapper currently emitted by meshery-cloud. */
|
|
1235
|
+
getOrg: {
|
|
1236
|
+
parameters: {
|
|
1237
|
+
path: {
|
|
1238
|
+
/** Organization ID. */
|
|
1239
|
+
orgId: string;
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
responses: {
|
|
1243
|
+
/** Single-organization page response */
|
|
1244
|
+
200: {
|
|
1245
|
+
content: {
|
|
1246
|
+
"application/json": {
|
|
1247
|
+
/** @description Zero-based page index returned in this response. */
|
|
1248
|
+
page?: number;
|
|
1249
|
+
/** @description Maximum number of items returned on each page. */
|
|
1250
|
+
pageSize?: number;
|
|
1251
|
+
/** @description Total number of items across all pages. */
|
|
1252
|
+
totalCount?: number;
|
|
1253
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
1254
|
+
organizations?: {
|
|
1255
|
+
/**
|
|
1256
|
+
* Format: uuid
|
|
1257
|
+
* @description Organization ID.
|
|
1258
|
+
*/
|
|
1259
|
+
id?: string;
|
|
1260
|
+
/** @description Name of the organization. */
|
|
1261
|
+
name?: string;
|
|
1262
|
+
/** @description Description of the organization. */
|
|
1263
|
+
description?: string;
|
|
1264
|
+
/** @description Country of the organization. */
|
|
1265
|
+
country?: string;
|
|
1266
|
+
/** @description Region of the organization. */
|
|
1267
|
+
region?: string;
|
|
1268
|
+
/** @description Display name of the organization owner. */
|
|
1269
|
+
owner?: string;
|
|
1270
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1271
|
+
metadata?: {
|
|
1272
|
+
/** @description Organization-level user experience preferences. */
|
|
1273
|
+
preferences: {
|
|
1274
|
+
/** @description UI theme configured for an organization. */
|
|
1275
|
+
theme: {
|
|
1276
|
+
/**
|
|
1277
|
+
* Format: uuid
|
|
1278
|
+
* @description Theme identifier.
|
|
1279
|
+
*/
|
|
1280
|
+
id: string;
|
|
1281
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1282
|
+
logo: {
|
|
1283
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1284
|
+
desktopView: {
|
|
1285
|
+
/** @description SVG markup for the asset. */
|
|
1286
|
+
svg: string;
|
|
1287
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1288
|
+
location: string;
|
|
1289
|
+
};
|
|
1290
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1291
|
+
mobileView: {
|
|
1292
|
+
/** @description SVG markup for the asset. */
|
|
1293
|
+
svg: string;
|
|
1294
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1295
|
+
location: string;
|
|
1296
|
+
};
|
|
1297
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1298
|
+
darkDesktopView: {
|
|
1299
|
+
/** @description SVG markup for the asset. */
|
|
1300
|
+
svg: string;
|
|
1301
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1302
|
+
location: string;
|
|
1303
|
+
};
|
|
1304
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1305
|
+
darkMobileView: {
|
|
1306
|
+
/** @description SVG markup for the asset. */
|
|
1307
|
+
svg: string;
|
|
1308
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1309
|
+
location: string;
|
|
1310
|
+
};
|
|
1311
|
+
};
|
|
1312
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1313
|
+
vars?: { [key: string]: unknown };
|
|
1314
|
+
};
|
|
1315
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1316
|
+
dashboard: { [key: string]: unknown };
|
|
1317
|
+
};
|
|
1318
|
+
};
|
|
1319
|
+
/**
|
|
1320
|
+
* Format: date-time
|
|
1321
|
+
* @description Timestamp when the organization was created.
|
|
1322
|
+
*/
|
|
1323
|
+
createdAt?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Format: date-time
|
|
1326
|
+
* @description Timestamp when the organization was last updated.
|
|
1327
|
+
*/
|
|
1328
|
+
updatedAt?: string;
|
|
1329
|
+
/**
|
|
1330
|
+
* Format: date-time
|
|
1331
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1332
|
+
*/
|
|
1333
|
+
deletedAt?: string;
|
|
1334
|
+
}[];
|
|
1335
|
+
};
|
|
1336
|
+
};
|
|
1337
|
+
};
|
|
1338
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1339
|
+
401: {
|
|
1340
|
+
content: {
|
|
1341
|
+
"text/plain": string;
|
|
1342
|
+
};
|
|
1343
|
+
};
|
|
1344
|
+
/** Result not found */
|
|
1345
|
+
404: {
|
|
1346
|
+
content: {
|
|
1347
|
+
"text/plain": string;
|
|
1348
|
+
};
|
|
1349
|
+
};
|
|
1350
|
+
/** Internal server error */
|
|
1351
|
+
500: {
|
|
1352
|
+
content: {
|
|
1353
|
+
"text/plain": string;
|
|
1354
|
+
};
|
|
1355
|
+
};
|
|
1356
|
+
};
|
|
1357
|
+
};
|
|
1358
|
+
/** Updates the organization. */
|
|
1359
|
+
updateOrg: {
|
|
1360
|
+
parameters: {
|
|
1361
|
+
path: {
|
|
1362
|
+
/** Organization ID. */
|
|
1363
|
+
orgId: string;
|
|
1364
|
+
};
|
|
1365
|
+
};
|
|
1366
|
+
responses: {
|
|
1367
|
+
/** Single-organization page response for the updated organization */
|
|
1368
|
+
200: {
|
|
1369
|
+
content: {
|
|
1370
|
+
"application/json": {
|
|
1371
|
+
/** @description Zero-based page index returned in this response. */
|
|
1372
|
+
page?: number;
|
|
1373
|
+
/** @description Maximum number of items returned on each page. */
|
|
1374
|
+
pageSize?: number;
|
|
1375
|
+
/** @description Total number of items across all pages. */
|
|
1376
|
+
totalCount?: number;
|
|
1377
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
1378
|
+
organizations?: {
|
|
1379
|
+
/**
|
|
1380
|
+
* Format: uuid
|
|
1381
|
+
* @description Organization ID.
|
|
1382
|
+
*/
|
|
1383
|
+
id?: string;
|
|
1384
|
+
/** @description Name of the organization. */
|
|
1385
|
+
name?: string;
|
|
1386
|
+
/** @description Description of the organization. */
|
|
1387
|
+
description?: string;
|
|
1388
|
+
/** @description Country of the organization. */
|
|
1389
|
+
country?: string;
|
|
1390
|
+
/** @description Region of the organization. */
|
|
1391
|
+
region?: string;
|
|
1392
|
+
/** @description Display name of the organization owner. */
|
|
1393
|
+
owner?: string;
|
|
1394
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1395
|
+
metadata?: {
|
|
1396
|
+
/** @description Organization-level user experience preferences. */
|
|
1397
|
+
preferences: {
|
|
1398
|
+
/** @description UI theme configured for an organization. */
|
|
1399
|
+
theme: {
|
|
1400
|
+
/**
|
|
1401
|
+
* Format: uuid
|
|
1402
|
+
* @description Theme identifier.
|
|
1403
|
+
*/
|
|
1404
|
+
id: string;
|
|
1405
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1406
|
+
logo: {
|
|
1407
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1408
|
+
desktopView: {
|
|
1409
|
+
/** @description SVG markup for the asset. */
|
|
1410
|
+
svg: string;
|
|
1411
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1412
|
+
location: string;
|
|
1413
|
+
};
|
|
1414
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1415
|
+
mobileView: {
|
|
1416
|
+
/** @description SVG markup for the asset. */
|
|
1417
|
+
svg: string;
|
|
1418
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1419
|
+
location: string;
|
|
1420
|
+
};
|
|
1421
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1422
|
+
darkDesktopView: {
|
|
1423
|
+
/** @description SVG markup for the asset. */
|
|
1424
|
+
svg: string;
|
|
1425
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1426
|
+
location: string;
|
|
1427
|
+
};
|
|
1428
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1429
|
+
darkMobileView: {
|
|
1430
|
+
/** @description SVG markup for the asset. */
|
|
1431
|
+
svg: string;
|
|
1432
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1433
|
+
location: string;
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1437
|
+
vars?: { [key: string]: unknown };
|
|
1438
|
+
};
|
|
1439
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1440
|
+
dashboard: { [key: string]: unknown };
|
|
1441
|
+
};
|
|
1442
|
+
};
|
|
1443
|
+
/**
|
|
1444
|
+
* Format: date-time
|
|
1445
|
+
* @description Timestamp when the organization was created.
|
|
1446
|
+
*/
|
|
1447
|
+
createdAt?: string;
|
|
1448
|
+
/**
|
|
1449
|
+
* Format: date-time
|
|
1450
|
+
* @description Timestamp when the organization was last updated.
|
|
1451
|
+
*/
|
|
1452
|
+
updatedAt?: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Format: date-time
|
|
1455
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1456
|
+
*/
|
|
1457
|
+
deletedAt?: string;
|
|
1458
|
+
}[];
|
|
1459
|
+
};
|
|
1460
|
+
};
|
|
1461
|
+
};
|
|
1462
|
+
/** Invalid request body or request param */
|
|
1463
|
+
400: {
|
|
1464
|
+
content: {
|
|
1465
|
+
"text/plain": string;
|
|
1466
|
+
};
|
|
1467
|
+
};
|
|
1468
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1469
|
+
401: {
|
|
1470
|
+
content: {
|
|
1471
|
+
"text/plain": string;
|
|
1472
|
+
};
|
|
1473
|
+
};
|
|
1474
|
+
/** Result not found */
|
|
1475
|
+
404: {
|
|
1476
|
+
content: {
|
|
1477
|
+
"text/plain": string;
|
|
1478
|
+
};
|
|
1479
|
+
};
|
|
1480
|
+
/** Internal server error */
|
|
1481
|
+
500: {
|
|
1482
|
+
content: {
|
|
1483
|
+
"text/plain": string;
|
|
1484
|
+
};
|
|
1485
|
+
};
|
|
1486
|
+
};
|
|
1487
|
+
/** Body for creating or updating an organization */
|
|
1488
|
+
requestBody: {
|
|
1489
|
+
content: {
|
|
1490
|
+
"application/json": {
|
|
1491
|
+
/** @description Name of the organization. */
|
|
1492
|
+
name?: string;
|
|
1493
|
+
/** @description Country of the organization. */
|
|
1494
|
+
country?: string;
|
|
1495
|
+
/** @description Region of the organization. */
|
|
1496
|
+
region?: string;
|
|
1497
|
+
/** @description Description of the organization. */
|
|
1498
|
+
description?: string;
|
|
1499
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
1500
|
+
notifyOrgUpdate?: boolean;
|
|
1501
|
+
/** @description Organization-level user experience preferences. */
|
|
1502
|
+
preferences?: {
|
|
1503
|
+
/** @description UI theme configured for an organization. */
|
|
1504
|
+
theme: {
|
|
1505
|
+
/**
|
|
1506
|
+
* Format: uuid
|
|
1507
|
+
* @description Theme identifier.
|
|
1508
|
+
*/
|
|
1509
|
+
id: string;
|
|
1510
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1511
|
+
logo: {
|
|
1512
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1513
|
+
desktopView: {
|
|
1514
|
+
/** @description SVG markup for the asset. */
|
|
1515
|
+
svg: string;
|
|
1516
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1517
|
+
location: string;
|
|
1518
|
+
};
|
|
1519
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1520
|
+
mobileView: {
|
|
1521
|
+
/** @description SVG markup for the asset. */
|
|
1522
|
+
svg: string;
|
|
1523
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1524
|
+
location: string;
|
|
1525
|
+
};
|
|
1526
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1527
|
+
darkDesktopView: {
|
|
1528
|
+
/** @description SVG markup for the asset. */
|
|
1529
|
+
svg: string;
|
|
1530
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1531
|
+
location: string;
|
|
1532
|
+
};
|
|
1533
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1534
|
+
darkMobileView: {
|
|
1535
|
+
/** @description SVG markup for the asset. */
|
|
1536
|
+
svg: string;
|
|
1537
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1538
|
+
location: string;
|
|
1539
|
+
};
|
|
1540
|
+
};
|
|
1541
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1542
|
+
vars?: { [key: string]: unknown };
|
|
1543
|
+
};
|
|
1544
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1545
|
+
dashboard: { [key: string]: unknown };
|
|
1546
|
+
};
|
|
1547
|
+
};
|
|
1548
|
+
};
|
|
1549
|
+
};
|
|
1550
|
+
};
|
|
1551
|
+
/** Deletes the organization. */
|
|
1552
|
+
deleteOrg: {
|
|
1553
|
+
parameters: {
|
|
1554
|
+
path: {
|
|
1555
|
+
/** Organization ID. */
|
|
1556
|
+
orgId: string;
|
|
1557
|
+
};
|
|
1558
|
+
};
|
|
1559
|
+
responses: {
|
|
1560
|
+
/** Organization deleted */
|
|
1561
|
+
204: never;
|
|
1562
|
+
/** Invalid request body or request param */
|
|
1563
|
+
400: {
|
|
1564
|
+
content: {
|
|
1565
|
+
"text/plain": string;
|
|
1566
|
+
};
|
|
1567
|
+
};
|
|
1568
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1569
|
+
401: {
|
|
1570
|
+
content: {
|
|
1571
|
+
"text/plain": string;
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
/** Result not found */
|
|
1575
|
+
404: {
|
|
1576
|
+
content: {
|
|
1577
|
+
"text/plain": string;
|
|
1578
|
+
};
|
|
1579
|
+
};
|
|
1580
|
+
/** Internal server error */
|
|
1581
|
+
500: {
|
|
1582
|
+
content: {
|
|
1583
|
+
"text/plain": string;
|
|
1584
|
+
};
|
|
1585
|
+
};
|
|
1586
|
+
};
|
|
1587
|
+
};
|
|
1588
|
+
/** Returns preferences for the specified organization. */
|
|
1589
|
+
getOrgPreferences: {
|
|
1590
|
+
parameters: {
|
|
1591
|
+
path: {
|
|
1592
|
+
/** Organization ID. */
|
|
1593
|
+
orgId: string;
|
|
1594
|
+
};
|
|
1595
|
+
};
|
|
1596
|
+
responses: {
|
|
1597
|
+
/** Organization metadata, including preferences */
|
|
1598
|
+
200: {
|
|
1599
|
+
content: {
|
|
1600
|
+
"application/json": {
|
|
1601
|
+
/** @description Organization-level user experience preferences. */
|
|
1602
|
+
preferences: {
|
|
1603
|
+
/** @description UI theme configured for an organization. */
|
|
1604
|
+
theme: {
|
|
1605
|
+
/**
|
|
1606
|
+
* Format: uuid
|
|
1607
|
+
* @description Theme identifier.
|
|
1608
|
+
*/
|
|
1609
|
+
id: string;
|
|
1610
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1611
|
+
logo: {
|
|
1612
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1613
|
+
desktopView: {
|
|
1614
|
+
/** @description SVG markup for the asset. */
|
|
1615
|
+
svg: string;
|
|
1616
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1617
|
+
location: string;
|
|
1618
|
+
};
|
|
1619
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1620
|
+
mobileView: {
|
|
1621
|
+
/** @description SVG markup for the asset. */
|
|
1622
|
+
svg: string;
|
|
1623
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1624
|
+
location: string;
|
|
1625
|
+
};
|
|
1626
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1627
|
+
darkDesktopView: {
|
|
1628
|
+
/** @description SVG markup for the asset. */
|
|
1629
|
+
svg: string;
|
|
1630
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1631
|
+
location: string;
|
|
1632
|
+
};
|
|
1633
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1634
|
+
darkMobileView: {
|
|
1635
|
+
/** @description SVG markup for the asset. */
|
|
1636
|
+
svg: string;
|
|
1637
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1638
|
+
location: string;
|
|
1639
|
+
};
|
|
1640
|
+
};
|
|
1641
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1642
|
+
vars?: { [key: string]: unknown };
|
|
1643
|
+
};
|
|
1644
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1645
|
+
dashboard: { [key: string]: unknown };
|
|
1646
|
+
};
|
|
1647
|
+
};
|
|
1648
|
+
};
|
|
1649
|
+
};
|
|
1650
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1651
|
+
401: {
|
|
1652
|
+
content: {
|
|
1653
|
+
"text/plain": string;
|
|
1654
|
+
};
|
|
1655
|
+
};
|
|
1656
|
+
/** Result not found */
|
|
1657
|
+
404: {
|
|
1658
|
+
content: {
|
|
1659
|
+
"text/plain": string;
|
|
1660
|
+
};
|
|
1661
|
+
};
|
|
1662
|
+
/** Internal server error */
|
|
1663
|
+
500: {
|
|
1664
|
+
content: {
|
|
1665
|
+
"text/plain": string;
|
|
1666
|
+
};
|
|
1667
|
+
};
|
|
1668
|
+
};
|
|
1669
|
+
};
|
|
1670
|
+
/** Adds a team to an organization. If request body contains action=delete, tombstones a team by setting its deletedAt timestamp. The team's organization mapping remains intact. */
|
|
1671
|
+
addTeamToOrg: {
|
|
1672
|
+
parameters: {
|
|
1673
|
+
path: {
|
|
1674
|
+
/** Organization ID. */
|
|
1675
|
+
orgId: string;
|
|
1676
|
+
/** Team ID. */
|
|
1677
|
+
teamId: string;
|
|
1678
|
+
};
|
|
1679
|
+
};
|
|
1680
|
+
responses: {
|
|
1681
|
+
/** Team added to organization or team tombstoned */
|
|
1682
|
+
201: {
|
|
1683
|
+
content: {
|
|
1684
|
+
"application/json":
|
|
1685
|
+
| {
|
|
1686
|
+
/** @description Zero-based page index returned in this response. */
|
|
1687
|
+
page?: number;
|
|
1688
|
+
/** @description Maximum number of items returned on each page. */
|
|
1689
|
+
pageSize?: number;
|
|
1690
|
+
/** @description Total number of items across all pages. */
|
|
1691
|
+
totalCount?: number;
|
|
1692
|
+
/** @description Team-organization mapping entries. */
|
|
1693
|
+
teamsOrganizationsMapping?: {
|
|
1694
|
+
/**
|
|
1695
|
+
* Format: uuid
|
|
1696
|
+
* @description Mapping record ID.
|
|
1697
|
+
*/
|
|
1698
|
+
id?: string;
|
|
1699
|
+
/**
|
|
1700
|
+
* Format: uuid
|
|
1701
|
+
* @description Organization ID for this mapping.
|
|
1702
|
+
*/
|
|
1703
|
+
orgId?: string;
|
|
1704
|
+
/**
|
|
1705
|
+
* Format: uuid
|
|
1706
|
+
* @description Team ID for this mapping.
|
|
1707
|
+
*/
|
|
1708
|
+
teamId?: string;
|
|
1709
|
+
/**
|
|
1710
|
+
* Format: date-time
|
|
1711
|
+
* @description Timestamp when the mapping was created.
|
|
1712
|
+
*/
|
|
1713
|
+
createdAt?: string;
|
|
1714
|
+
/**
|
|
1715
|
+
* Format: date-time
|
|
1716
|
+
* @description Timestamp when the mapping was last updated.
|
|
1717
|
+
*/
|
|
1718
|
+
updatedAt?: string;
|
|
1719
|
+
/**
|
|
1720
|
+
* Format: date-time
|
|
1721
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
1722
|
+
*/
|
|
1723
|
+
deletedAt?: string;
|
|
1724
|
+
}[];
|
|
1725
|
+
}
|
|
1726
|
+
| {
|
|
1727
|
+
/** @description Zero-based page index returned in this response. */
|
|
1728
|
+
page?: number;
|
|
1729
|
+
/** @description Maximum number of items returned on each page. */
|
|
1730
|
+
pageSize?: number;
|
|
1731
|
+
/** @description Total number of items across all pages. */
|
|
1732
|
+
totalCount?: number;
|
|
1733
|
+
/** @description Teams in this page. */
|
|
1734
|
+
teams?: {
|
|
1735
|
+
/**
|
|
1736
|
+
* Format: uuid
|
|
1737
|
+
* @description Team ID.
|
|
1738
|
+
*/
|
|
1739
|
+
id?: string;
|
|
1740
|
+
/** @description Name of the team. */
|
|
1741
|
+
name?: string;
|
|
1742
|
+
/** @description Description of the team. */
|
|
1743
|
+
description?: string;
|
|
1744
|
+
/** @description Display name of the team owner. */
|
|
1745
|
+
owner?: string;
|
|
1746
|
+
/** @description Free-form team metadata. */
|
|
1747
|
+
metadata?: { [key: string]: string };
|
|
1748
|
+
/**
|
|
1749
|
+
* Format: date-time
|
|
1750
|
+
* @description Timestamp when the team was created.
|
|
1751
|
+
*/
|
|
1752
|
+
createdAt?: string;
|
|
1753
|
+
/**
|
|
1754
|
+
* Format: date-time
|
|
1755
|
+
* @description Timestamp when the team was last updated.
|
|
1756
|
+
*/
|
|
1757
|
+
updatedAt?: string;
|
|
1758
|
+
/**
|
|
1759
|
+
* Format: date-time
|
|
1760
|
+
* @description Timestamp when the team was soft-deleted.
|
|
1761
|
+
*/
|
|
1762
|
+
deletedAt?: string;
|
|
1763
|
+
}[];
|
|
1764
|
+
};
|
|
1765
|
+
};
|
|
1766
|
+
};
|
|
1767
|
+
/** Bad request */
|
|
1768
|
+
400: unknown;
|
|
1769
|
+
/** Unauthorized */
|
|
1770
|
+
401: unknown;
|
|
1771
|
+
/** Not found */
|
|
1772
|
+
404: unknown;
|
|
1773
|
+
/** Internal server error */
|
|
1774
|
+
500: unknown;
|
|
1775
|
+
};
|
|
1776
|
+
requestBody: {
|
|
1777
|
+
content: {
|
|
1778
|
+
"application/json": {
|
|
1779
|
+
/**
|
|
1780
|
+
* @description Internal action to perform on the team resource.
|
|
1781
|
+
* @enum {string}
|
|
1782
|
+
*/
|
|
1783
|
+
action?: "delete";
|
|
1784
|
+
};
|
|
1785
|
+
};
|
|
1786
|
+
};
|
|
1787
|
+
};
|
|
1788
|
+
/** Removes (unassigns) a team from an organization. */
|
|
1789
|
+
removeTeamFromOrg: {
|
|
1790
|
+
parameters: {
|
|
1791
|
+
path: {
|
|
1792
|
+
/** Organization ID. */
|
|
1793
|
+
orgId: string;
|
|
1794
|
+
/** Team ID. */
|
|
1795
|
+
teamId: string;
|
|
1796
|
+
};
|
|
1797
|
+
};
|
|
1798
|
+
responses: {
|
|
1799
|
+
/** Team removed from organization */
|
|
1800
|
+
200: {
|
|
1801
|
+
content: {
|
|
1802
|
+
"application/json": {
|
|
1803
|
+
/** @description Zero-based page index returned in this response. */
|
|
1804
|
+
page?: number;
|
|
1805
|
+
/** @description Maximum number of items returned on each page. */
|
|
1806
|
+
pageSize?: number;
|
|
1807
|
+
/** @description Total number of items across all pages. */
|
|
1808
|
+
totalCount?: number;
|
|
1809
|
+
/** @description Team-organization mapping entries. */
|
|
1810
|
+
teamsOrganizationsMapping?: {
|
|
1811
|
+
/**
|
|
1812
|
+
* Format: uuid
|
|
1813
|
+
* @description Mapping record ID.
|
|
1814
|
+
*/
|
|
1815
|
+
id?: string;
|
|
1816
|
+
/**
|
|
1817
|
+
* Format: uuid
|
|
1818
|
+
* @description Organization ID for this mapping.
|
|
1819
|
+
*/
|
|
1820
|
+
orgId?: string;
|
|
1821
|
+
/**
|
|
1822
|
+
* Format: uuid
|
|
1823
|
+
* @description Team ID for this mapping.
|
|
1824
|
+
*/
|
|
1825
|
+
teamId?: string;
|
|
1826
|
+
/**
|
|
1827
|
+
* Format: date-time
|
|
1828
|
+
* @description Timestamp when the mapping was created.
|
|
1829
|
+
*/
|
|
1830
|
+
createdAt?: string;
|
|
1831
|
+
/**
|
|
1832
|
+
* Format: date-time
|
|
1833
|
+
* @description Timestamp when the mapping was last updated.
|
|
1834
|
+
*/
|
|
1835
|
+
updatedAt?: string;
|
|
1836
|
+
/**
|
|
1837
|
+
* Format: date-time
|
|
1838
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
1839
|
+
*/
|
|
1840
|
+
deletedAt?: string;
|
|
1841
|
+
}[];
|
|
1842
|
+
};
|
|
1843
|
+
};
|
|
1844
|
+
};
|
|
1845
|
+
/** Bad request */
|
|
1846
|
+
400: unknown;
|
|
1847
|
+
/** Unauthorized */
|
|
1848
|
+
401: unknown;
|
|
1849
|
+
/** Not found */
|
|
1850
|
+
404: unknown;
|
|
1851
|
+
/** Internal server error */
|
|
1852
|
+
500: unknown;
|
|
1853
|
+
};
|
|
1854
|
+
};
|
|
1855
|
+
addUserToOrg: {
|
|
1856
|
+
parameters: {
|
|
1857
|
+
path: {
|
|
1858
|
+
/** Organization ID. */
|
|
1859
|
+
orgId: string;
|
|
1860
|
+
/** User ID. */
|
|
1861
|
+
userId: string;
|
|
1862
|
+
};
|
|
1863
|
+
};
|
|
1864
|
+
responses: {
|
|
1865
|
+
/** User added to organization */
|
|
1866
|
+
201: {
|
|
1867
|
+
content: {
|
|
1868
|
+
"application/json": { [key: string]: unknown };
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
/** Invalid request body or request param */
|
|
1872
|
+
400: {
|
|
1873
|
+
content: {
|
|
1874
|
+
"text/plain": string;
|
|
1875
|
+
};
|
|
1876
|
+
};
|
|
1877
|
+
/** Unauthorized */
|
|
1878
|
+
401: unknown;
|
|
1879
|
+
/** Result not found */
|
|
1880
|
+
404: {
|
|
1881
|
+
content: {
|
|
1882
|
+
"text/plain": string;
|
|
1883
|
+
};
|
|
1884
|
+
};
|
|
1885
|
+
/** Internal server error */
|
|
1886
|
+
500: unknown;
|
|
1887
|
+
};
|
|
1888
|
+
};
|
|
1889
|
+
deleteUserFromOrg: {
|
|
1890
|
+
parameters: {
|
|
1891
|
+
path: {
|
|
1892
|
+
/** Organization ID. */
|
|
1893
|
+
orgId: string;
|
|
1894
|
+
/** User ID. */
|
|
1895
|
+
userId: string;
|
|
1896
|
+
};
|
|
1897
|
+
};
|
|
1898
|
+
responses: {
|
|
1899
|
+
/** User removed from organization */
|
|
1900
|
+
204: never;
|
|
1901
|
+
/** Unauthorized */
|
|
1902
|
+
401: unknown;
|
|
1903
|
+
/** Result not found */
|
|
1904
|
+
404: {
|
|
1905
|
+
content: {
|
|
1906
|
+
"text/plain": string;
|
|
1907
|
+
};
|
|
1908
|
+
};
|
|
1909
|
+
/** Internal server error */
|
|
1910
|
+
500: unknown;
|
|
1911
|
+
};
|
|
1912
|
+
};
|
|
1913
|
+
}
|
|
1914
|
+
|
|
1915
|
+
export interface external {}
|