@meshery/schemas 1.2.22 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +1719 -1518
- package/dist/cloudApi.d.ts +1719 -1518
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
- package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
- package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
- package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
- package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
- package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
- package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
- package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
- package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
- package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
- package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
- package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
- package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
- package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
- package/dist/constructs/v1beta1/system/System.d.ts +434 -0
- package/dist/constructs/v1beta1/system/System.js +1 -0
- package/dist/constructs/v1beta1/system/System.mjs +0 -0
- package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
- package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
- package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta1/view/View.d.ts +833 -664
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
- package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
- package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
- package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
- package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
- package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
- package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
- package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
- package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
- package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
- package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta2/view/View.d.ts +838 -669
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
- package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
- package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
- package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
- package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
- package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
- package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
- package/dist/index.d.mts +5480 -5022
- package/dist/index.d.ts +5480 -5022
- package/dist/mesheryApi.d.mts +1314 -522
- package/dist/mesheryApi.d.ts +1314 -522
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -2
|
@@ -4,1024 +4,319 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
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";
|
|
7
|
+
"/api/identity/orgs": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Read organizations
|
|
16
|
+
* @description Returns organizations for the current user.
|
|
17
|
+
*/
|
|
18
|
+
get: operations["getOrgs"];
|
|
19
|
+
put?: never;
|
|
20
|
+
/**
|
|
21
|
+
* Create an organization
|
|
22
|
+
* @description Creates a new organization.
|
|
23
|
+
*/
|
|
24
|
+
post: operations["createOrg"];
|
|
25
|
+
delete?: never;
|
|
26
|
+
options?: never;
|
|
27
|
+
head?: never;
|
|
28
|
+
patch?: never;
|
|
29
|
+
trace?: never;
|
|
62
30
|
};
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
31
|
+
"/api/identity/orgs/by-domain": {
|
|
32
|
+
parameters: {
|
|
33
|
+
query?: never;
|
|
34
|
+
header?: never;
|
|
35
|
+
path?: never;
|
|
36
|
+
cookie?: never;
|
|
37
|
+
};
|
|
38
|
+
/** Get organization by domain */
|
|
39
|
+
get: operations["getOrgByDomain"];
|
|
40
|
+
put?: never;
|
|
41
|
+
post?: never;
|
|
42
|
+
delete?: never;
|
|
43
|
+
options?: never;
|
|
44
|
+
head?: never;
|
|
45
|
+
patch?: never;
|
|
46
|
+
trace?: never;
|
|
69
47
|
};
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
/**
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
98
|
-
location: string;
|
|
99
|
-
};
|
|
48
|
+
"/api/identity/orgs/{orgId}": {
|
|
49
|
+
parameters: {
|
|
50
|
+
query?: never;
|
|
51
|
+
header?: never;
|
|
52
|
+
path?: never;
|
|
53
|
+
cookie?: never;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* Read an organization
|
|
57
|
+
* @description Returns the organization in the single-item page wrapper currently emitted by meshery-cloud.
|
|
58
|
+
*/
|
|
59
|
+
get: operations["getOrg"];
|
|
60
|
+
/**
|
|
61
|
+
* Update an organization
|
|
62
|
+
* @description Updates the organization.
|
|
63
|
+
*/
|
|
64
|
+
put: operations["updateOrg"];
|
|
65
|
+
post?: never;
|
|
66
|
+
/**
|
|
67
|
+
* Delete an organization
|
|
68
|
+
* @description Deletes the organization.
|
|
69
|
+
*/
|
|
70
|
+
delete: operations["deleteOrg"];
|
|
71
|
+
options?: never;
|
|
72
|
+
head?: never;
|
|
73
|
+
patch?: never;
|
|
74
|
+
trace?: never;
|
|
100
75
|
};
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
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;
|
|
76
|
+
"/api/identity/orgs/{orgId}/preferences": {
|
|
77
|
+
parameters: {
|
|
78
|
+
query?: never;
|
|
79
|
+
header?: never;
|
|
80
|
+
path?: never;
|
|
81
|
+
cookie?: never;
|
|
116
82
|
};
|
|
117
|
-
/**
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
83
|
+
/**
|
|
84
|
+
* Get organization preferences
|
|
85
|
+
* @description Returns preferences for the specified organization.
|
|
86
|
+
*/
|
|
87
|
+
get: operations["getOrgPreferences"];
|
|
88
|
+
put?: never;
|
|
89
|
+
post?: never;
|
|
90
|
+
delete?: never;
|
|
91
|
+
options?: never;
|
|
92
|
+
head?: never;
|
|
93
|
+
patch?: never;
|
|
94
|
+
trace?: never;
|
|
95
|
+
};
|
|
96
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}": {
|
|
97
|
+
parameters: {
|
|
98
|
+
query?: never;
|
|
99
|
+
header?: never;
|
|
100
|
+
path?: never;
|
|
101
|
+
cookie?: never;
|
|
123
102
|
};
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
103
|
+
get?: never;
|
|
104
|
+
put?: never;
|
|
105
|
+
/**
|
|
106
|
+
* Add team to organization or soft delete team
|
|
107
|
+
* @description 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.
|
|
108
|
+
*/
|
|
109
|
+
post: operations["addTeamToOrg"];
|
|
110
|
+
delete?: never;
|
|
111
|
+
options?: never;
|
|
112
|
+
head?: never;
|
|
113
|
+
patch?: never;
|
|
114
|
+
trace?: never;
|
|
115
|
+
};
|
|
116
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}/remove": {
|
|
117
|
+
parameters: {
|
|
118
|
+
query?: never;
|
|
119
|
+
header?: never;
|
|
120
|
+
path?: never;
|
|
121
|
+
cookie?: never;
|
|
130
122
|
};
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
123
|
+
get?: never;
|
|
124
|
+
put?: never;
|
|
125
|
+
/**
|
|
126
|
+
* Remove team from organization
|
|
127
|
+
* @description Removes (unassigns) a team from an organization.
|
|
128
|
+
*/
|
|
129
|
+
post: operations["removeTeamFromOrg"];
|
|
130
|
+
delete?: never;
|
|
131
|
+
options?: never;
|
|
132
|
+
head?: never;
|
|
133
|
+
patch?: never;
|
|
134
|
+
trace?: never;
|
|
135
|
+
};
|
|
136
|
+
"/api/identity/orgs/{orgId}/users/{userId}": {
|
|
137
|
+
parameters: {
|
|
138
|
+
query?: never;
|
|
139
|
+
header?: never;
|
|
140
|
+
path?: never;
|
|
141
|
+
cookie?: never;
|
|
137
142
|
};
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
143
|
+
get?: never;
|
|
144
|
+
put?: never;
|
|
145
|
+
/** Add user to organization */
|
|
146
|
+
post: operations["addUserToOrg"];
|
|
147
|
+
/** Remove user from organization */
|
|
148
|
+
delete: operations["deleteUserFromOrg"];
|
|
149
|
+
options?: never;
|
|
150
|
+
head?: never;
|
|
151
|
+
patch?: never;
|
|
152
|
+
trace?: never;
|
|
141
153
|
};
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
/** @description UI theme configured for an organization. */
|
|
147
|
-
theme: {
|
|
154
|
+
}
|
|
155
|
+
export type webhooks = Record<string, never>;
|
|
156
|
+
export interface components {
|
|
157
|
+
schemas: {
|
|
148
158
|
/**
|
|
149
159
|
* Format: uuid
|
|
150
|
-
* @description
|
|
160
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
151
161
|
*/
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
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: {
|
|
162
|
+
UUID: string;
|
|
163
|
+
/** Format: date-time */
|
|
164
|
+
NullableTime: string;
|
|
165
|
+
/** Format: date-time */
|
|
166
|
+
Time: string;
|
|
167
|
+
Text: string;
|
|
168
|
+
MapObject: {
|
|
169
|
+
[key: string]: string;
|
|
170
|
+
};
|
|
171
|
+
/** @description Optional action payload for POST on /api/identity/orgs/{orgId}/teams/{teamId}. */
|
|
172
|
+
OrgTeamActionPayload: {
|
|
173
|
+
/**
|
|
174
|
+
* @description Internal action to perform on the team resource.
|
|
175
|
+
* @enum {string}
|
|
176
|
+
*/
|
|
177
|
+
action?: "delete";
|
|
178
|
+
};
|
|
179
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
180
|
+
Location: {
|
|
178
181
|
/** @description SVG markup for the asset. */
|
|
179
182
|
svg: string;
|
|
180
183
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
181
184
|
location: string;
|
|
182
|
-
};
|
|
183
185
|
};
|
|
184
|
-
/** @description
|
|
185
|
-
|
|
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: {
|
|
186
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
187
|
+
Logo: {
|
|
203
188
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
204
189
|
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
190
|
/** @description SVG markup for the asset. */
|
|
312
191
|
svg: string;
|
|
313
192
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
314
193
|
location: string;
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
194
|
+
};
|
|
195
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
196
|
+
mobileView: {
|
|
318
197
|
/** @description SVG markup for the asset. */
|
|
319
198
|
svg: string;
|
|
320
199
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
321
200
|
location: string;
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
201
|
+
};
|
|
202
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
203
|
+
darkDesktopView: {
|
|
325
204
|
/** @description SVG markup for the asset. */
|
|
326
205
|
svg: string;
|
|
327
206
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
328
207
|
location: string;
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
208
|
+
};
|
|
209
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
210
|
+
darkMobileView: {
|
|
332
211
|
/** @description SVG markup for the asset. */
|
|
333
212
|
svg: string;
|
|
334
213
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
335
214
|
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
215
|
};
|
|
431
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
432
|
-
dashboard: { [key: string]: unknown };
|
|
433
|
-
};
|
|
434
216
|
};
|
|
435
|
-
/**
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
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: {
|
|
217
|
+
/** @description UI theme configured for an organization. */
|
|
218
|
+
Theme: {
|
|
219
|
+
/**
|
|
220
|
+
* Format: uuid
|
|
221
|
+
* @description Theme identifier.
|
|
222
|
+
*/
|
|
223
|
+
id: string;
|
|
224
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
225
|
+
logo: {
|
|
490
226
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
491
227
|
desktopView: {
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
228
|
+
/** @description SVG markup for the asset. */
|
|
229
|
+
svg: string;
|
|
230
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
231
|
+
location: string;
|
|
496
232
|
};
|
|
497
233
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
498
234
|
mobileView: {
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
235
|
+
/** @description SVG markup for the asset. */
|
|
236
|
+
svg: string;
|
|
237
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
238
|
+
location: string;
|
|
503
239
|
};
|
|
504
240
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
505
241
|
darkDesktopView: {
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
242
|
+
/** @description SVG markup for the asset. */
|
|
243
|
+
svg: string;
|
|
244
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
245
|
+
location: string;
|
|
510
246
|
};
|
|
511
247
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
512
248
|
darkMobileView: {
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
249
|
+
/** @description SVG markup for the asset. */
|
|
250
|
+
svg: string;
|
|
251
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
252
|
+
location: string;
|
|
517
253
|
};
|
|
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
254
|
};
|
|
580
|
-
/** @description
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
svg: string;
|
|
584
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
585
|
-
location: string;
|
|
255
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
256
|
+
vars?: {
|
|
257
|
+
[key: string]: unknown;
|
|
586
258
|
};
|
|
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
259
|
};
|
|
598
260
|
/** @description Preferences specific to dashboard behavior. */
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
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?: {
|
|
261
|
+
DashboardPrefs: {
|
|
262
|
+
[key: string]: unknown;
|
|
263
|
+
};
|
|
264
|
+
/** @description Organization-level user experience preferences. */
|
|
265
|
+
Preferences: {
|
|
810
266
|
/** @description UI theme configured for an organization. */
|
|
811
267
|
theme: {
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
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: {
|
|
268
|
+
/**
|
|
269
|
+
* Format: uuid
|
|
270
|
+
* @description Theme identifier.
|
|
271
|
+
*/
|
|
272
|
+
id: string;
|
|
273
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
274
|
+
logo: {
|
|
275
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
276
|
+
desktopView: {
|
|
920
277
|
/** @description SVG markup for the asset. */
|
|
921
278
|
svg: string;
|
|
922
279
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
923
280
|
location: string;
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
281
|
+
};
|
|
282
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
283
|
+
mobileView: {
|
|
927
284
|
/** @description SVG markup for the asset. */
|
|
928
285
|
svg: string;
|
|
929
286
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
930
287
|
location: string;
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
288
|
+
};
|
|
289
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
290
|
+
darkDesktopView: {
|
|
934
291
|
/** @description SVG markup for the asset. */
|
|
935
292
|
svg: string;
|
|
936
293
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
937
294
|
location: string;
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
295
|
+
};
|
|
296
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
297
|
+
darkMobileView: {
|
|
941
298
|
/** @description SVG markup for the asset. */
|
|
942
299
|
svg: string;
|
|
943
300
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
944
301
|
location: string;
|
|
945
|
-
};
|
|
946
302
|
};
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
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;
|
|
303
|
+
};
|
|
304
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
305
|
+
vars?: {
|
|
306
|
+
[key: string]: unknown;
|
|
307
|
+
};
|
|
308
|
+
};
|
|
309
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
310
|
+
dashboard: {
|
|
311
|
+
[key: string]: unknown;
|
|
312
|
+
};
|
|
979
313
|
};
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
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: {
|
|
314
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
315
|
+
OrgMetadata: {
|
|
316
|
+
/** @description Organization-level user experience preferences. */
|
|
317
|
+
preferences: {
|
|
318
|
+
/** @description UI theme configured for an organization. */
|
|
319
|
+
theme: {
|
|
1025
320
|
/**
|
|
1026
321
|
* Format: uuid
|
|
1027
322
|
* @description Theme identifier.
|
|
@@ -1029,156 +324,48 @@ export interface operations {
|
|
|
1029
324
|
id: string;
|
|
1030
325
|
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1031
326
|
logo: {
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
327
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
328
|
+
desktopView: {
|
|
329
|
+
/** @description SVG markup for the asset. */
|
|
330
|
+
svg: string;
|
|
331
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
332
|
+
location: string;
|
|
333
|
+
};
|
|
334
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
335
|
+
mobileView: {
|
|
336
|
+
/** @description SVG markup for the asset. */
|
|
337
|
+
svg: string;
|
|
338
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
339
|
+
location: string;
|
|
340
|
+
};
|
|
341
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
342
|
+
darkDesktopView: {
|
|
343
|
+
/** @description SVG markup for the asset. */
|
|
344
|
+
svg: string;
|
|
345
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
346
|
+
location: string;
|
|
347
|
+
};
|
|
348
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
349
|
+
darkMobileView: {
|
|
350
|
+
/** @description SVG markup for the asset. */
|
|
351
|
+
svg: string;
|
|
352
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
353
|
+
location: string;
|
|
354
|
+
};
|
|
1060
355
|
};
|
|
1061
356
|
/** @description Arbitrary theme variables keyed by name. */
|
|
1062
|
-
vars?: {
|
|
1063
|
-
|
|
1064
|
-
|
|
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;
|
|
357
|
+
vars?: {
|
|
358
|
+
[key: string]: unknown;
|
|
359
|
+
};
|
|
1151
360
|
};
|
|
1152
|
-
/** @description
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
svg: string;
|
|
1156
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1157
|
-
location: string;
|
|
361
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
362
|
+
dashboard: {
|
|
363
|
+
[key: string]: unknown;
|
|
1158
364
|
};
|
|
1159
|
-
};
|
|
1160
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
1161
|
-
vars?: { [key: string]: unknown };
|
|
1162
365
|
};
|
|
1163
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
1164
|
-
dashboard: { [key: string]: unknown };
|
|
1165
|
-
};
|
|
1166
366
|
};
|
|
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": {
|
|
367
|
+
/** @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 */
|
|
368
|
+
Organization: {
|
|
1182
369
|
/**
|
|
1183
370
|
* Format: uuid
|
|
1184
371
|
* @description Organization ID.
|
|
@@ -1198,7 +385,7 @@ export interface operations {
|
|
|
1198
385
|
*/
|
|
1199
386
|
owner: string;
|
|
1200
387
|
/** @description Free-form metadata associated with the organization, including preferences. */
|
|
1201
|
-
metadata:
|
|
388
|
+
metadata: Record<string, never>;
|
|
1202
389
|
/** @description Domain of the organization. */
|
|
1203
390
|
domain?: string | null;
|
|
1204
391
|
/**
|
|
@@ -1216,158 +403,190 @@ export interface operations {
|
|
|
1216
403
|
* @description Timestamp when the organization was soft-deleted. Null while the organization is active.
|
|
1217
404
|
*/
|
|
1218
405
|
deletedAt?: string;
|
|
1219
|
-
};
|
|
1220
406
|
};
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
407
|
+
/** @description Organization listing record used in list and get responses. */
|
|
408
|
+
AvailableOrganization: {
|
|
409
|
+
/**
|
|
410
|
+
* Format: uuid
|
|
411
|
+
* @description Organization ID.
|
|
412
|
+
*/
|
|
413
|
+
id?: string;
|
|
414
|
+
/** @description Name of the organization. */
|
|
415
|
+
name?: string;
|
|
416
|
+
/** @description Description of the organization. */
|
|
417
|
+
description?: string;
|
|
418
|
+
/** @description Country of the organization. */
|
|
419
|
+
country?: string;
|
|
420
|
+
/** @description Region of the organization. */
|
|
421
|
+
region?: string;
|
|
422
|
+
/** @description Display name of the organization owner. */
|
|
423
|
+
owner?: string;
|
|
424
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
425
|
+
metadata?: {
|
|
426
|
+
/** @description Organization-level user experience preferences. */
|
|
427
|
+
preferences: {
|
|
428
|
+
/** @description UI theme configured for an organization. */
|
|
429
|
+
theme: {
|
|
430
|
+
/**
|
|
431
|
+
* Format: uuid
|
|
432
|
+
* @description Theme identifier.
|
|
433
|
+
*/
|
|
434
|
+
id: string;
|
|
435
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
436
|
+
logo: {
|
|
437
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
438
|
+
desktopView: {
|
|
439
|
+
/** @description SVG markup for the asset. */
|
|
440
|
+
svg: string;
|
|
441
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
442
|
+
location: string;
|
|
443
|
+
};
|
|
444
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
445
|
+
mobileView: {
|
|
446
|
+
/** @description SVG markup for the asset. */
|
|
447
|
+
svg: string;
|
|
448
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
449
|
+
location: string;
|
|
450
|
+
};
|
|
451
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
452
|
+
darkDesktopView: {
|
|
453
|
+
/** @description SVG markup for the asset. */
|
|
454
|
+
svg: string;
|
|
455
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
456
|
+
location: string;
|
|
457
|
+
};
|
|
458
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
459
|
+
darkMobileView: {
|
|
460
|
+
/** @description SVG markup for the asset. */
|
|
461
|
+
svg: string;
|
|
462
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
463
|
+
location: string;
|
|
464
|
+
};
|
|
465
|
+
};
|
|
466
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
467
|
+
vars?: {
|
|
468
|
+
[key: string]: unknown;
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
472
|
+
dashboard: {
|
|
473
|
+
[key: string]: unknown;
|
|
474
|
+
};
|
|
475
|
+
};
|
|
476
|
+
};
|
|
477
|
+
/**
|
|
478
|
+
* Format: date-time
|
|
479
|
+
* @description Timestamp when the organization was created.
|
|
480
|
+
*/
|
|
481
|
+
createdAt?: string;
|
|
482
|
+
/**
|
|
483
|
+
* Format: date-time
|
|
484
|
+
* @description Timestamp when the organization was last updated.
|
|
485
|
+
*/
|
|
486
|
+
updatedAt?: string;
|
|
487
|
+
/**
|
|
488
|
+
* Format: date-time
|
|
489
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
490
|
+
*/
|
|
491
|
+
deletedAt?: string;
|
|
1226
492
|
};
|
|
1227
|
-
|
|
1228
|
-
|
|
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": {
|
|
493
|
+
/** @description Paginated list of organizations. */
|
|
494
|
+
OrganizationsPage: {
|
|
1247
495
|
/** @description Zero-based page index returned in this response. */
|
|
1248
496
|
page?: number;
|
|
1249
497
|
/** @description Maximum number of items returned on each page. */
|
|
1250
498
|
pageSize?: number;
|
|
1251
499
|
/** @description Total number of items across all pages. */
|
|
1252
500
|
totalCount?: number;
|
|
1253
|
-
/** @description Organizations
|
|
501
|
+
/** @description Organizations in this page. */
|
|
1254
502
|
organizations?: {
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
503
|
+
/**
|
|
504
|
+
* Format: uuid
|
|
505
|
+
* @description Organization ID.
|
|
506
|
+
*/
|
|
507
|
+
id?: string;
|
|
508
|
+
/** @description Name of the organization. */
|
|
509
|
+
name?: string;
|
|
510
|
+
/** @description Description of the organization. */
|
|
511
|
+
description?: string;
|
|
512
|
+
/** @description Country of the organization. */
|
|
513
|
+
country?: string;
|
|
514
|
+
/** @description Region of the organization. */
|
|
515
|
+
region?: string;
|
|
516
|
+
/** @description Display name of the organization owner. */
|
|
517
|
+
owner?: string;
|
|
518
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
519
|
+
metadata?: {
|
|
520
|
+
/** @description Organization-level user experience preferences. */
|
|
521
|
+
preferences: {
|
|
522
|
+
/** @description UI theme configured for an organization. */
|
|
523
|
+
theme: {
|
|
524
|
+
/**
|
|
525
|
+
* Format: uuid
|
|
526
|
+
* @description Theme identifier.
|
|
527
|
+
*/
|
|
528
|
+
id: string;
|
|
529
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
530
|
+
logo: {
|
|
531
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
532
|
+
desktopView: {
|
|
533
|
+
/** @description SVG markup for the asset. */
|
|
534
|
+
svg: string;
|
|
535
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
536
|
+
location: string;
|
|
537
|
+
};
|
|
538
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
539
|
+
mobileView: {
|
|
540
|
+
/** @description SVG markup for the asset. */
|
|
541
|
+
svg: string;
|
|
542
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
543
|
+
location: string;
|
|
544
|
+
};
|
|
545
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
546
|
+
darkDesktopView: {
|
|
547
|
+
/** @description SVG markup for the asset. */
|
|
548
|
+
svg: string;
|
|
549
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
550
|
+
location: string;
|
|
551
|
+
};
|
|
552
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
553
|
+
darkMobileView: {
|
|
554
|
+
/** @description SVG markup for the asset. */
|
|
555
|
+
svg: string;
|
|
556
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
557
|
+
location: string;
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
561
|
+
vars?: {
|
|
562
|
+
[key: string]: unknown;
|
|
563
|
+
};
|
|
564
|
+
};
|
|
565
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
566
|
+
dashboard: {
|
|
567
|
+
[key: string]: unknown;
|
|
568
|
+
};
|
|
1311
569
|
};
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
updatedAt?: string;
|
|
1329
|
-
/**
|
|
1330
|
-
* Format: date-time
|
|
1331
|
-
* @description Timestamp when the organization was soft-deleted.
|
|
1332
|
-
*/
|
|
1333
|
-
deletedAt?: string;
|
|
570
|
+
};
|
|
571
|
+
/**
|
|
572
|
+
* Format: date-time
|
|
573
|
+
* @description Timestamp when the organization was created.
|
|
574
|
+
*/
|
|
575
|
+
createdAt?: string;
|
|
576
|
+
/**
|
|
577
|
+
* Format: date-time
|
|
578
|
+
* @description Timestamp when the organization was last updated.
|
|
579
|
+
*/
|
|
580
|
+
updatedAt?: string;
|
|
581
|
+
/**
|
|
582
|
+
* Format: date-time
|
|
583
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
584
|
+
*/
|
|
585
|
+
deletedAt?: string;
|
|
1334
586
|
}[];
|
|
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
587
|
};
|
|
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": {
|
|
588
|
+
/** @description Single-organization wrapper used by current meshery-cloud organization handlers. */
|
|
589
|
+
OrganizationPage: {
|
|
1371
590
|
/** @description Zero-based page index returned in this response. */
|
|
1372
591
|
page?: number;
|
|
1373
592
|
/** @description Maximum number of items returned on each page. */
|
|
@@ -1376,27 +595,107 @@ export interface operations {
|
|
|
1376
595
|
totalCount?: number;
|
|
1377
596
|
/** @description Organizations returned in this single-item page wrapper. */
|
|
1378
597
|
organizations?: {
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
598
|
+
/**
|
|
599
|
+
* Format: uuid
|
|
600
|
+
* @description Organization ID.
|
|
601
|
+
*/
|
|
602
|
+
id?: string;
|
|
603
|
+
/** @description Name of the organization. */
|
|
604
|
+
name?: string;
|
|
605
|
+
/** @description Description of the organization. */
|
|
606
|
+
description?: string;
|
|
607
|
+
/** @description Country of the organization. */
|
|
608
|
+
country?: string;
|
|
609
|
+
/** @description Region of the organization. */
|
|
610
|
+
region?: string;
|
|
611
|
+
/** @description Display name of the organization owner. */
|
|
612
|
+
owner?: string;
|
|
613
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
614
|
+
metadata?: {
|
|
615
|
+
/** @description Organization-level user experience preferences. */
|
|
616
|
+
preferences: {
|
|
617
|
+
/** @description UI theme configured for an organization. */
|
|
618
|
+
theme: {
|
|
619
|
+
/**
|
|
620
|
+
* Format: uuid
|
|
621
|
+
* @description Theme identifier.
|
|
622
|
+
*/
|
|
623
|
+
id: string;
|
|
624
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
625
|
+
logo: {
|
|
626
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
627
|
+
desktopView: {
|
|
628
|
+
/** @description SVG markup for the asset. */
|
|
629
|
+
svg: string;
|
|
630
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
631
|
+
location: string;
|
|
632
|
+
};
|
|
633
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
634
|
+
mobileView: {
|
|
635
|
+
/** @description SVG markup for the asset. */
|
|
636
|
+
svg: string;
|
|
637
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
638
|
+
location: string;
|
|
639
|
+
};
|
|
640
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
641
|
+
darkDesktopView: {
|
|
642
|
+
/** @description SVG markup for the asset. */
|
|
643
|
+
svg: string;
|
|
644
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
645
|
+
location: string;
|
|
646
|
+
};
|
|
647
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
648
|
+
darkMobileView: {
|
|
649
|
+
/** @description SVG markup for the asset. */
|
|
650
|
+
svg: string;
|
|
651
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
652
|
+
location: string;
|
|
653
|
+
};
|
|
654
|
+
};
|
|
655
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
656
|
+
vars?: {
|
|
657
|
+
[key: string]: unknown;
|
|
658
|
+
};
|
|
659
|
+
};
|
|
660
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
661
|
+
dashboard: {
|
|
662
|
+
[key: string]: unknown;
|
|
663
|
+
};
|
|
664
|
+
};
|
|
665
|
+
};
|
|
666
|
+
/**
|
|
667
|
+
* Format: date-time
|
|
668
|
+
* @description Timestamp when the organization was created.
|
|
669
|
+
*/
|
|
670
|
+
createdAt?: string;
|
|
671
|
+
/**
|
|
672
|
+
* Format: date-time
|
|
673
|
+
* @description Timestamp when the organization was last updated.
|
|
674
|
+
*/
|
|
675
|
+
updatedAt?: string;
|
|
676
|
+
/**
|
|
677
|
+
* Format: date-time
|
|
678
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
679
|
+
*/
|
|
680
|
+
deletedAt?: string;
|
|
681
|
+
}[];
|
|
682
|
+
};
|
|
683
|
+
/** @description Payload for creating or updating an organization. Contains only client-settable fields. */
|
|
684
|
+
OrganizationPayload: {
|
|
685
|
+
/** @description Name of the organization. */
|
|
686
|
+
name?: string;
|
|
687
|
+
/** @description Country of the organization. */
|
|
688
|
+
country?: string;
|
|
689
|
+
/** @description Region of the organization. */
|
|
690
|
+
region?: string;
|
|
691
|
+
/** @description Description of the organization. */
|
|
692
|
+
description?: string;
|
|
693
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
694
|
+
notifyOrgUpdate?: boolean;
|
|
695
|
+
/** @description Organization-level user experience preferences. */
|
|
696
|
+
preferences?: {
|
|
697
|
+
/** @description UI theme configured for an organization. */
|
|
698
|
+
theme: {
|
|
1400
699
|
/**
|
|
1401
700
|
* Format: uuid
|
|
1402
701
|
* @description Theme identifier.
|
|
@@ -1404,512 +703,1624 @@ export interface operations {
|
|
|
1404
703
|
id: string;
|
|
1405
704
|
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1406
705
|
logo: {
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
706
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
707
|
+
desktopView: {
|
|
708
|
+
/** @description SVG markup for the asset. */
|
|
709
|
+
svg: string;
|
|
710
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
711
|
+
location: string;
|
|
712
|
+
};
|
|
713
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
714
|
+
mobileView: {
|
|
715
|
+
/** @description SVG markup for the asset. */
|
|
716
|
+
svg: string;
|
|
717
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
718
|
+
location: string;
|
|
719
|
+
};
|
|
720
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
721
|
+
darkDesktopView: {
|
|
722
|
+
/** @description SVG markup for the asset. */
|
|
723
|
+
svg: string;
|
|
724
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
725
|
+
location: string;
|
|
726
|
+
};
|
|
727
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
728
|
+
darkMobileView: {
|
|
729
|
+
/** @description SVG markup for the asset. */
|
|
730
|
+
svg: string;
|
|
731
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
732
|
+
location: string;
|
|
733
|
+
};
|
|
1435
734
|
};
|
|
1436
735
|
/** @description Arbitrary theme variables keyed by name. */
|
|
1437
|
-
vars?: {
|
|
1438
|
-
|
|
1439
|
-
|
|
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;
|
|
736
|
+
vars?: {
|
|
737
|
+
[key: string]: unknown;
|
|
738
|
+
};
|
|
1532
739
|
};
|
|
1533
|
-
/** @description
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
svg: string;
|
|
1537
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1538
|
-
location: string;
|
|
740
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
741
|
+
dashboard: {
|
|
742
|
+
[key: string]: unknown;
|
|
1539
743
|
};
|
|
1540
|
-
};
|
|
1541
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
1542
|
-
vars?: { [key: string]: unknown };
|
|
1543
744
|
};
|
|
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
745
|
};
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
|
|
746
|
+
/** @description Team listing record used in team listings associated with an organization. */
|
|
747
|
+
AvailableTeam: {
|
|
748
|
+
/**
|
|
749
|
+
* Format: uuid
|
|
750
|
+
* @description Team ID.
|
|
751
|
+
*/
|
|
752
|
+
id?: string;
|
|
753
|
+
/** @description Name of the team. */
|
|
754
|
+
name?: string;
|
|
755
|
+
/** @description Description of the team. */
|
|
756
|
+
description?: string;
|
|
757
|
+
/** @description Display name of the team owner. */
|
|
758
|
+
owner?: string;
|
|
759
|
+
/** @description Free-form team metadata. */
|
|
760
|
+
metadata?: {
|
|
761
|
+
[key: string]: string;
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
764
|
+
* Format: date-time
|
|
765
|
+
* @description Timestamp when the team was created.
|
|
766
|
+
*/
|
|
767
|
+
createdAt?: string;
|
|
768
|
+
/**
|
|
769
|
+
* Format: date-time
|
|
770
|
+
* @description Timestamp when the team was last updated.
|
|
771
|
+
*/
|
|
772
|
+
updatedAt?: string;
|
|
773
|
+
/**
|
|
774
|
+
* Format: date-time
|
|
775
|
+
* @description Timestamp when the team was soft-deleted.
|
|
776
|
+
*/
|
|
777
|
+
deletedAt?: string;
|
|
1584
778
|
};
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
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: {
|
|
779
|
+
/** @description Paginated list of teams. */
|
|
780
|
+
TeamsPage: {
|
|
781
|
+
/** @description Zero-based page index returned in this response. */
|
|
782
|
+
page?: number;
|
|
783
|
+
/** @description Maximum number of items returned on each page. */
|
|
784
|
+
pageSize?: number;
|
|
785
|
+
/** @description Total number of items across all pages. */
|
|
786
|
+
totalCount?: number;
|
|
787
|
+
/** @description Teams in this page. */
|
|
788
|
+
teams?: {
|
|
1605
789
|
/**
|
|
1606
790
|
* Format: uuid
|
|
1607
|
-
* @description
|
|
791
|
+
* @description Team ID.
|
|
1608
792
|
*/
|
|
1609
|
-
id
|
|
1610
|
-
/** @description
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
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
|
-
};
|
|
793
|
+
id?: string;
|
|
794
|
+
/** @description Name of the team. */
|
|
795
|
+
name?: string;
|
|
796
|
+
/** @description Description of the team. */
|
|
797
|
+
description?: string;
|
|
798
|
+
/** @description Display name of the team owner. */
|
|
799
|
+
owner?: string;
|
|
800
|
+
/** @description Free-form team metadata. */
|
|
801
|
+
metadata?: {
|
|
802
|
+
[key: string]: string;
|
|
1640
803
|
};
|
|
1641
|
-
/**
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
404: {
|
|
1658
|
-
content: {
|
|
1659
|
-
"text/plain": string;
|
|
804
|
+
/**
|
|
805
|
+
* Format: date-time
|
|
806
|
+
* @description Timestamp when the team was created.
|
|
807
|
+
*/
|
|
808
|
+
createdAt?: string;
|
|
809
|
+
/**
|
|
810
|
+
* Format: date-time
|
|
811
|
+
* @description Timestamp when the team was last updated.
|
|
812
|
+
*/
|
|
813
|
+
updatedAt?: string;
|
|
814
|
+
/**
|
|
815
|
+
* Format: date-time
|
|
816
|
+
* @description Timestamp when the team was soft-deleted.
|
|
817
|
+
*/
|
|
818
|
+
deletedAt?: string;
|
|
819
|
+
}[];
|
|
1660
820
|
};
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
821
|
+
/** @description Junction record linking a team to an organization. */
|
|
822
|
+
TeamsOrganizationsMapping: {
|
|
823
|
+
/**
|
|
824
|
+
* Format: uuid
|
|
825
|
+
* @description Mapping record ID.
|
|
826
|
+
*/
|
|
827
|
+
id?: string;
|
|
828
|
+
/**
|
|
829
|
+
* Format: uuid
|
|
830
|
+
* @description Organization ID for this mapping.
|
|
831
|
+
*/
|
|
832
|
+
orgId?: string;
|
|
833
|
+
/**
|
|
834
|
+
* Format: uuid
|
|
835
|
+
* @description Team ID for this mapping.
|
|
836
|
+
*/
|
|
837
|
+
teamId?: string;
|
|
838
|
+
/**
|
|
839
|
+
* Format: date-time
|
|
840
|
+
* @description Timestamp when the mapping was created.
|
|
841
|
+
*/
|
|
842
|
+
createdAt?: string;
|
|
843
|
+
/**
|
|
844
|
+
* Format: date-time
|
|
845
|
+
* @description Timestamp when the mapping was last updated.
|
|
846
|
+
*/
|
|
847
|
+
updatedAt?: string;
|
|
848
|
+
/**
|
|
849
|
+
* Format: date-time
|
|
850
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
851
|
+
*/
|
|
852
|
+
deletedAt?: string;
|
|
853
|
+
};
|
|
854
|
+
/** @description Paginated list of team-organization mappings. */
|
|
855
|
+
TeamsOrganizationsMappingPage: {
|
|
856
|
+
/** @description Zero-based page index returned in this response. */
|
|
857
|
+
page?: number;
|
|
858
|
+
/** @description Maximum number of items returned on each page. */
|
|
859
|
+
pageSize?: number;
|
|
860
|
+
/** @description Total number of items across all pages. */
|
|
861
|
+
totalCount?: number;
|
|
862
|
+
/** @description Team-organization mapping entries. */
|
|
863
|
+
teamsOrganizationsMapping?: {
|
|
864
|
+
/**
|
|
865
|
+
* Format: uuid
|
|
866
|
+
* @description Mapping record ID.
|
|
867
|
+
*/
|
|
868
|
+
id?: string;
|
|
869
|
+
/**
|
|
870
|
+
* Format: uuid
|
|
871
|
+
* @description Organization ID for this mapping.
|
|
872
|
+
*/
|
|
873
|
+
orgId?: string;
|
|
874
|
+
/**
|
|
875
|
+
* Format: uuid
|
|
876
|
+
* @description Team ID for this mapping.
|
|
877
|
+
*/
|
|
878
|
+
teamId?: string;
|
|
879
|
+
/**
|
|
880
|
+
* Format: date-time
|
|
881
|
+
* @description Timestamp when the mapping was created.
|
|
882
|
+
*/
|
|
883
|
+
createdAt?: string;
|
|
884
|
+
/**
|
|
885
|
+
* Format: date-time
|
|
886
|
+
* @description Timestamp when the mapping was last updated.
|
|
887
|
+
*/
|
|
888
|
+
updatedAt?: string;
|
|
889
|
+
/**
|
|
890
|
+
* Format: date-time
|
|
891
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
892
|
+
*/
|
|
893
|
+
deletedAt?: string;
|
|
894
|
+
}[];
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
responses: {
|
|
898
|
+
/** @description Invalid request body or request param */
|
|
899
|
+
400: {
|
|
900
|
+
headers: {
|
|
901
|
+
[name: string]: unknown;
|
|
902
|
+
};
|
|
903
|
+
content: {
|
|
904
|
+
"text/plain": string;
|
|
905
|
+
};
|
|
906
|
+
};
|
|
907
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
908
|
+
401: {
|
|
909
|
+
headers: {
|
|
910
|
+
[name: string]: unknown;
|
|
911
|
+
};
|
|
912
|
+
content: {
|
|
913
|
+
"text/plain": string;
|
|
914
|
+
};
|
|
915
|
+
};
|
|
916
|
+
/** @description Result not found */
|
|
917
|
+
404: {
|
|
918
|
+
headers: {
|
|
919
|
+
[name: string]: unknown;
|
|
920
|
+
};
|
|
921
|
+
content: {
|
|
922
|
+
"text/plain": string;
|
|
923
|
+
};
|
|
924
|
+
};
|
|
925
|
+
/** @description Internal server error */
|
|
926
|
+
500: {
|
|
927
|
+
headers: {
|
|
928
|
+
[name: string]: unknown;
|
|
929
|
+
};
|
|
930
|
+
content: {
|
|
931
|
+
"text/plain": string;
|
|
932
|
+
};
|
|
1666
933
|
};
|
|
1667
|
-
};
|
|
1668
934
|
};
|
|
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
935
|
parameters: {
|
|
1673
|
-
|
|
1674
|
-
/** Organization ID. */
|
|
936
|
+
/** @description Organization ID. */
|
|
1675
937
|
orgId: string;
|
|
1676
|
-
/**
|
|
938
|
+
/** @description User ID. */
|
|
939
|
+
userId: string;
|
|
940
|
+
/** @description Team ID. */
|
|
1677
941
|
teamId: string;
|
|
1678
|
-
|
|
942
|
+
/** @description Zero-based index of the result page to return. */
|
|
943
|
+
page: number;
|
|
944
|
+
/** @description Maximum number of items returned on each page. */
|
|
945
|
+
pageSize: number;
|
|
946
|
+
/** @description Get responses that match search param value */
|
|
947
|
+
search: string;
|
|
948
|
+
/** @description Get ordered responses */
|
|
949
|
+
order: string;
|
|
950
|
+
/** @description Get all possible entries */
|
|
951
|
+
all: boolean;
|
|
1679
952
|
};
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
953
|
+
requestBodies: {
|
|
954
|
+
/** @description Body for creating or updating an organization */
|
|
955
|
+
organizationPayload: {
|
|
956
|
+
content: {
|
|
957
|
+
"application/json": {
|
|
958
|
+
/** @description Name of the organization. */
|
|
959
|
+
name?: string;
|
|
960
|
+
/** @description Country of the organization. */
|
|
961
|
+
country?: string;
|
|
962
|
+
/** @description Region of the organization. */
|
|
963
|
+
region?: string;
|
|
964
|
+
/** @description Description of the organization. */
|
|
965
|
+
description?: string;
|
|
966
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
967
|
+
notifyOrgUpdate?: boolean;
|
|
968
|
+
/** @description Organization-level user experience preferences. */
|
|
969
|
+
preferences?: {
|
|
970
|
+
/** @description UI theme configured for an organization. */
|
|
971
|
+
theme: {
|
|
972
|
+
/**
|
|
973
|
+
* Format: uuid
|
|
974
|
+
* @description Theme identifier.
|
|
975
|
+
*/
|
|
976
|
+
id: string;
|
|
977
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
978
|
+
logo: {
|
|
979
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
980
|
+
desktopView: {
|
|
981
|
+
/** @description SVG markup for the asset. */
|
|
982
|
+
svg: string;
|
|
983
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
984
|
+
location: string;
|
|
985
|
+
};
|
|
986
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
987
|
+
mobileView: {
|
|
988
|
+
/** @description SVG markup for the asset. */
|
|
989
|
+
svg: string;
|
|
990
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
991
|
+
location: string;
|
|
992
|
+
};
|
|
993
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
994
|
+
darkDesktopView: {
|
|
995
|
+
/** @description SVG markup for the asset. */
|
|
996
|
+
svg: string;
|
|
997
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
998
|
+
location: string;
|
|
999
|
+
};
|
|
1000
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1001
|
+
darkMobileView: {
|
|
1002
|
+
/** @description SVG markup for the asset. */
|
|
1003
|
+
svg: string;
|
|
1004
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1005
|
+
location: string;
|
|
1006
|
+
};
|
|
1007
|
+
};
|
|
1008
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1009
|
+
vars?: {
|
|
1010
|
+
[key: string]: unknown;
|
|
1011
|
+
};
|
|
1012
|
+
};
|
|
1013
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1014
|
+
dashboard: {
|
|
1015
|
+
[key: string]: unknown;
|
|
1016
|
+
};
|
|
1017
|
+
};
|
|
1018
|
+
};
|
|
1019
|
+
};
|
|
1020
|
+
};
|
|
1021
|
+
};
|
|
1022
|
+
headers: never;
|
|
1023
|
+
pathItems: never;
|
|
1024
|
+
}
|
|
1025
|
+
export type $defs = Record<string, never>;
|
|
1026
|
+
export interface operations {
|
|
1027
|
+
getOrgs: {
|
|
1028
|
+
parameters: {
|
|
1029
|
+
query?: {
|
|
1030
|
+
/** @description Zero-based index of the result page to return. */
|
|
1728
1031
|
page?: number;
|
|
1729
1032
|
/** @description Maximum number of items returned on each page. */
|
|
1730
1033
|
pageSize?: number;
|
|
1731
|
-
/** @description
|
|
1732
|
-
|
|
1733
|
-
/** @description
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1034
|
+
/** @description Get responses that match search param value */
|
|
1035
|
+
search?: string;
|
|
1036
|
+
/** @description Get ordered responses */
|
|
1037
|
+
order?: string;
|
|
1038
|
+
/** @description Get all possible entries */
|
|
1039
|
+
all?: boolean;
|
|
1040
|
+
};
|
|
1041
|
+
header?: never;
|
|
1042
|
+
path?: never;
|
|
1043
|
+
cookie?: never;
|
|
1044
|
+
};
|
|
1045
|
+
requestBody?: never;
|
|
1046
|
+
responses: {
|
|
1047
|
+
/** @description Organizations response */
|
|
1048
|
+
200: {
|
|
1049
|
+
headers: {
|
|
1050
|
+
[name: string]: unknown;
|
|
1051
|
+
};
|
|
1052
|
+
content: {
|
|
1053
|
+
"application/json": {
|
|
1054
|
+
/** @description Zero-based page index returned in this response. */
|
|
1055
|
+
page?: number;
|
|
1056
|
+
/** @description Maximum number of items returned on each page. */
|
|
1057
|
+
pageSize?: number;
|
|
1058
|
+
/** @description Total number of items across all pages. */
|
|
1059
|
+
totalCount?: number;
|
|
1060
|
+
/** @description Organizations in this page. */
|
|
1061
|
+
organizations?: {
|
|
1062
|
+
/**
|
|
1063
|
+
* Format: uuid
|
|
1064
|
+
* @description Organization ID.
|
|
1065
|
+
*/
|
|
1066
|
+
id?: string;
|
|
1067
|
+
/** @description Name of the organization. */
|
|
1068
|
+
name?: string;
|
|
1069
|
+
/** @description Description of the organization. */
|
|
1070
|
+
description?: string;
|
|
1071
|
+
/** @description Country of the organization. */
|
|
1072
|
+
country?: string;
|
|
1073
|
+
/** @description Region of the organization. */
|
|
1074
|
+
region?: string;
|
|
1075
|
+
/** @description Display name of the organization owner. */
|
|
1076
|
+
owner?: string;
|
|
1077
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1078
|
+
metadata?: {
|
|
1079
|
+
/** @description Organization-level user experience preferences. */
|
|
1080
|
+
preferences: {
|
|
1081
|
+
/** @description UI theme configured for an organization. */
|
|
1082
|
+
theme: {
|
|
1083
|
+
/**
|
|
1084
|
+
* Format: uuid
|
|
1085
|
+
* @description Theme identifier.
|
|
1086
|
+
*/
|
|
1087
|
+
id: string;
|
|
1088
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1089
|
+
logo: {
|
|
1090
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1091
|
+
desktopView: {
|
|
1092
|
+
/** @description SVG markup for the asset. */
|
|
1093
|
+
svg: string;
|
|
1094
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1095
|
+
location: string;
|
|
1096
|
+
};
|
|
1097
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1098
|
+
mobileView: {
|
|
1099
|
+
/** @description SVG markup for the asset. */
|
|
1100
|
+
svg: string;
|
|
1101
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1102
|
+
location: string;
|
|
1103
|
+
};
|
|
1104
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1105
|
+
darkDesktopView: {
|
|
1106
|
+
/** @description SVG markup for the asset. */
|
|
1107
|
+
svg: string;
|
|
1108
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1109
|
+
location: string;
|
|
1110
|
+
};
|
|
1111
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1112
|
+
darkMobileView: {
|
|
1113
|
+
/** @description SVG markup for the asset. */
|
|
1114
|
+
svg: string;
|
|
1115
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1116
|
+
location: string;
|
|
1117
|
+
};
|
|
1118
|
+
};
|
|
1119
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1120
|
+
vars?: {
|
|
1121
|
+
[key: string]: unknown;
|
|
1122
|
+
};
|
|
1123
|
+
};
|
|
1124
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1125
|
+
dashboard: {
|
|
1126
|
+
[key: string]: unknown;
|
|
1127
|
+
};
|
|
1128
|
+
};
|
|
1129
|
+
};
|
|
1130
|
+
/**
|
|
1131
|
+
* Format: date-time
|
|
1132
|
+
* @description Timestamp when the organization was created.
|
|
1133
|
+
*/
|
|
1134
|
+
createdAt?: string;
|
|
1135
|
+
/**
|
|
1136
|
+
* Format: date-time
|
|
1137
|
+
* @description Timestamp when the organization was last updated.
|
|
1138
|
+
*/
|
|
1139
|
+
updatedAt?: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* Format: date-time
|
|
1142
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1143
|
+
*/
|
|
1144
|
+
deletedAt?: string;
|
|
1145
|
+
}[];
|
|
1146
|
+
};
|
|
1147
|
+
};
|
|
1148
|
+
};
|
|
1149
|
+
/** @description No content */
|
|
1150
|
+
204: {
|
|
1151
|
+
headers: {
|
|
1152
|
+
[name: string]: unknown;
|
|
1153
|
+
};
|
|
1154
|
+
content?: never;
|
|
1155
|
+
};
|
|
1156
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1157
|
+
401: {
|
|
1158
|
+
headers: {
|
|
1159
|
+
[name: string]: unknown;
|
|
1160
|
+
};
|
|
1161
|
+
content: {
|
|
1162
|
+
"text/plain": string;
|
|
1163
|
+
};
|
|
1164
|
+
};
|
|
1165
|
+
/** @description Internal server error */
|
|
1166
|
+
500: {
|
|
1167
|
+
headers: {
|
|
1168
|
+
[name: string]: unknown;
|
|
1169
|
+
};
|
|
1170
|
+
content: {
|
|
1171
|
+
"text/plain": string;
|
|
1172
|
+
};
|
|
1173
|
+
};
|
|
1765
1174
|
};
|
|
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
1175
|
};
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1176
|
+
createOrg: {
|
|
1177
|
+
parameters: {
|
|
1178
|
+
query?: never;
|
|
1179
|
+
header?: never;
|
|
1180
|
+
path?: never;
|
|
1181
|
+
cookie?: never;
|
|
1182
|
+
};
|
|
1183
|
+
/** @description Body for creating or updating an organization */
|
|
1184
|
+
requestBody: {
|
|
1185
|
+
content: {
|
|
1186
|
+
"application/json": {
|
|
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
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
1196
|
+
notifyOrgUpdate?: boolean;
|
|
1197
|
+
/** @description Organization-level user experience preferences. */
|
|
1198
|
+
preferences?: {
|
|
1199
|
+
/** @description UI theme configured for an organization. */
|
|
1200
|
+
theme: {
|
|
1201
|
+
/**
|
|
1202
|
+
* Format: uuid
|
|
1203
|
+
* @description Theme identifier.
|
|
1204
|
+
*/
|
|
1205
|
+
id: string;
|
|
1206
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1207
|
+
logo: {
|
|
1208
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1209
|
+
desktopView: {
|
|
1210
|
+
/** @description SVG markup for the asset. */
|
|
1211
|
+
svg: string;
|
|
1212
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1213
|
+
location: string;
|
|
1214
|
+
};
|
|
1215
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1216
|
+
mobileView: {
|
|
1217
|
+
/** @description SVG markup for the asset. */
|
|
1218
|
+
svg: string;
|
|
1219
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1220
|
+
location: string;
|
|
1221
|
+
};
|
|
1222
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1223
|
+
darkDesktopView: {
|
|
1224
|
+
/** @description SVG markup for the asset. */
|
|
1225
|
+
svg: string;
|
|
1226
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1227
|
+
location: string;
|
|
1228
|
+
};
|
|
1229
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1230
|
+
darkMobileView: {
|
|
1231
|
+
/** @description SVG markup for the asset. */
|
|
1232
|
+
svg: string;
|
|
1233
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1234
|
+
location: string;
|
|
1235
|
+
};
|
|
1236
|
+
};
|
|
1237
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1238
|
+
vars?: {
|
|
1239
|
+
[key: string]: unknown;
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1243
|
+
dashboard: {
|
|
1244
|
+
[key: string]: unknown;
|
|
1245
|
+
};
|
|
1246
|
+
};
|
|
1247
|
+
};
|
|
1248
|
+
};
|
|
1249
|
+
};
|
|
1250
|
+
responses: {
|
|
1251
|
+
/** @description Single-organization page response */
|
|
1252
|
+
201: {
|
|
1253
|
+
headers: {
|
|
1254
|
+
[name: string]: unknown;
|
|
1255
|
+
};
|
|
1256
|
+
content: {
|
|
1257
|
+
"application/json": {
|
|
1258
|
+
/** @description Zero-based page index returned in this response. */
|
|
1259
|
+
page?: number;
|
|
1260
|
+
/** @description Maximum number of items returned on each page. */
|
|
1261
|
+
pageSize?: number;
|
|
1262
|
+
/** @description Total number of items across all pages. */
|
|
1263
|
+
totalCount?: number;
|
|
1264
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
1265
|
+
organizations?: {
|
|
1266
|
+
/**
|
|
1267
|
+
* Format: uuid
|
|
1268
|
+
* @description Organization ID.
|
|
1269
|
+
*/
|
|
1270
|
+
id?: string;
|
|
1271
|
+
/** @description Name of the organization. */
|
|
1272
|
+
name?: string;
|
|
1273
|
+
/** @description Description of the organization. */
|
|
1274
|
+
description?: string;
|
|
1275
|
+
/** @description Country of the organization. */
|
|
1276
|
+
country?: string;
|
|
1277
|
+
/** @description Region of the organization. */
|
|
1278
|
+
region?: string;
|
|
1279
|
+
/** @description Display name of the organization owner. */
|
|
1280
|
+
owner?: string;
|
|
1281
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1282
|
+
metadata?: {
|
|
1283
|
+
/** @description Organization-level user experience preferences. */
|
|
1284
|
+
preferences: {
|
|
1285
|
+
/** @description UI theme configured for an organization. */
|
|
1286
|
+
theme: {
|
|
1287
|
+
/**
|
|
1288
|
+
* Format: uuid
|
|
1289
|
+
* @description Theme identifier.
|
|
1290
|
+
*/
|
|
1291
|
+
id: string;
|
|
1292
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1293
|
+
logo: {
|
|
1294
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1295
|
+
desktopView: {
|
|
1296
|
+
/** @description SVG markup for the asset. */
|
|
1297
|
+
svg: string;
|
|
1298
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1299
|
+
location: string;
|
|
1300
|
+
};
|
|
1301
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1302
|
+
mobileView: {
|
|
1303
|
+
/** @description SVG markup for the asset. */
|
|
1304
|
+
svg: string;
|
|
1305
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1306
|
+
location: string;
|
|
1307
|
+
};
|
|
1308
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1309
|
+
darkDesktopView: {
|
|
1310
|
+
/** @description SVG markup for the asset. */
|
|
1311
|
+
svg: string;
|
|
1312
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1313
|
+
location: string;
|
|
1314
|
+
};
|
|
1315
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1316
|
+
darkMobileView: {
|
|
1317
|
+
/** @description SVG markup for the asset. */
|
|
1318
|
+
svg: string;
|
|
1319
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1320
|
+
location: string;
|
|
1321
|
+
};
|
|
1322
|
+
};
|
|
1323
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1324
|
+
vars?: {
|
|
1325
|
+
[key: string]: unknown;
|
|
1326
|
+
};
|
|
1327
|
+
};
|
|
1328
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1329
|
+
dashboard: {
|
|
1330
|
+
[key: string]: unknown;
|
|
1331
|
+
};
|
|
1332
|
+
};
|
|
1333
|
+
};
|
|
1334
|
+
/**
|
|
1335
|
+
* Format: date-time
|
|
1336
|
+
* @description Timestamp when the organization was created.
|
|
1337
|
+
*/
|
|
1338
|
+
createdAt?: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* Format: date-time
|
|
1341
|
+
* @description Timestamp when the organization was last updated.
|
|
1342
|
+
*/
|
|
1343
|
+
updatedAt?: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* Format: date-time
|
|
1346
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1347
|
+
*/
|
|
1348
|
+
deletedAt?: string;
|
|
1349
|
+
}[];
|
|
1350
|
+
};
|
|
1351
|
+
};
|
|
1352
|
+
};
|
|
1353
|
+
/** @description Invalid request body or request param */
|
|
1354
|
+
400: {
|
|
1355
|
+
headers: {
|
|
1356
|
+
[name: string]: unknown;
|
|
1357
|
+
};
|
|
1358
|
+
content: {
|
|
1359
|
+
"text/plain": string;
|
|
1360
|
+
};
|
|
1361
|
+
};
|
|
1362
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1363
|
+
401: {
|
|
1364
|
+
headers: {
|
|
1365
|
+
[name: string]: unknown;
|
|
1366
|
+
};
|
|
1367
|
+
content: {
|
|
1368
|
+
"text/plain": string;
|
|
1369
|
+
};
|
|
1370
|
+
};
|
|
1371
|
+
/** @description Internal server error */
|
|
1372
|
+
500: {
|
|
1373
|
+
headers: {
|
|
1374
|
+
[name: string]: unknown;
|
|
1375
|
+
};
|
|
1376
|
+
content: {
|
|
1377
|
+
"text/plain": string;
|
|
1378
|
+
};
|
|
1379
|
+
};
|
|
1784
1380
|
};
|
|
1785
|
-
};
|
|
1786
1381
|
};
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1382
|
+
getOrgByDomain: {
|
|
1383
|
+
parameters: {
|
|
1384
|
+
query: {
|
|
1385
|
+
/** @description Domain name of the organization to look up. */
|
|
1386
|
+
domain: string;
|
|
1387
|
+
};
|
|
1388
|
+
header?: never;
|
|
1389
|
+
path?: never;
|
|
1390
|
+
cookie?: never;
|
|
1391
|
+
};
|
|
1392
|
+
requestBody?: never;
|
|
1393
|
+
responses: {
|
|
1394
|
+
/** @description Organization response */
|
|
1395
|
+
200: {
|
|
1396
|
+
headers: {
|
|
1397
|
+
[name: string]: unknown;
|
|
1398
|
+
};
|
|
1399
|
+
content: {
|
|
1400
|
+
"application/json": {
|
|
1401
|
+
/**
|
|
1402
|
+
* Format: uuid
|
|
1403
|
+
* @description Organization ID.
|
|
1404
|
+
*/
|
|
1405
|
+
id: string;
|
|
1406
|
+
/** @description Name of the organization. */
|
|
1407
|
+
name: string;
|
|
1408
|
+
/** @description Country of the organization. */
|
|
1409
|
+
country: string;
|
|
1410
|
+
/** @description Region of the organization. */
|
|
1411
|
+
region: string;
|
|
1412
|
+
/** @description Description of the organization. */
|
|
1413
|
+
description: string;
|
|
1414
|
+
/**
|
|
1415
|
+
* Format: uuid
|
|
1416
|
+
* @description Owner user ID of the organization.
|
|
1417
|
+
*/
|
|
1418
|
+
owner: string;
|
|
1419
|
+
/** @description Free-form metadata associated with the organization, including preferences. */
|
|
1420
|
+
metadata: Record<string, never>;
|
|
1421
|
+
/** @description Domain of the organization. */
|
|
1422
|
+
domain?: string | null;
|
|
1423
|
+
/**
|
|
1424
|
+
* Format: date-time
|
|
1425
|
+
* @description Timestamp when the organization was created.
|
|
1426
|
+
*/
|
|
1427
|
+
createdAt: string;
|
|
1428
|
+
/**
|
|
1429
|
+
* Format: date-time
|
|
1430
|
+
* @description Timestamp when the organization was last updated.
|
|
1431
|
+
*/
|
|
1432
|
+
updatedAt: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* Format: date-time
|
|
1435
|
+
* @description Timestamp when the organization was soft-deleted. Null while the organization is active.
|
|
1436
|
+
*/
|
|
1437
|
+
deletedAt?: string;
|
|
1438
|
+
};
|
|
1439
|
+
};
|
|
1440
|
+
};
|
|
1441
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1442
|
+
401: {
|
|
1443
|
+
headers: {
|
|
1444
|
+
[name: string]: unknown;
|
|
1445
|
+
};
|
|
1446
|
+
content: {
|
|
1447
|
+
"text/plain": string;
|
|
1448
|
+
};
|
|
1449
|
+
};
|
|
1450
|
+
/** @description Organization not found */
|
|
1451
|
+
404: {
|
|
1452
|
+
headers: {
|
|
1453
|
+
[name: string]: unknown;
|
|
1454
|
+
};
|
|
1455
|
+
content?: never;
|
|
1456
|
+
};
|
|
1457
|
+
/** @description Internal server error */
|
|
1458
|
+
500: {
|
|
1459
|
+
headers: {
|
|
1460
|
+
[name: string]: unknown;
|
|
1461
|
+
};
|
|
1462
|
+
content?: never;
|
|
1463
|
+
};
|
|
1464
|
+
};
|
|
1797
1465
|
};
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1466
|
+
getOrg: {
|
|
1467
|
+
parameters: {
|
|
1468
|
+
query?: never;
|
|
1469
|
+
header?: never;
|
|
1470
|
+
path: {
|
|
1471
|
+
/** @description Organization ID. */
|
|
1472
|
+
orgId: string;
|
|
1473
|
+
};
|
|
1474
|
+
cookie?: never;
|
|
1475
|
+
};
|
|
1476
|
+
requestBody?: never;
|
|
1477
|
+
responses: {
|
|
1478
|
+
/** @description Single-organization page response */
|
|
1479
|
+
200: {
|
|
1480
|
+
headers: {
|
|
1481
|
+
[name: string]: unknown;
|
|
1482
|
+
};
|
|
1483
|
+
content: {
|
|
1484
|
+
"application/json": {
|
|
1485
|
+
/** @description Zero-based page index returned in this response. */
|
|
1486
|
+
page?: number;
|
|
1487
|
+
/** @description Maximum number of items returned on each page. */
|
|
1488
|
+
pageSize?: number;
|
|
1489
|
+
/** @description Total number of items across all pages. */
|
|
1490
|
+
totalCount?: number;
|
|
1491
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
1492
|
+
organizations?: {
|
|
1493
|
+
/**
|
|
1494
|
+
* Format: uuid
|
|
1495
|
+
* @description Organization ID.
|
|
1496
|
+
*/
|
|
1497
|
+
id?: string;
|
|
1498
|
+
/** @description Name of the organization. */
|
|
1499
|
+
name?: string;
|
|
1500
|
+
/** @description Description of the organization. */
|
|
1501
|
+
description?: string;
|
|
1502
|
+
/** @description Country of the organization. */
|
|
1503
|
+
country?: string;
|
|
1504
|
+
/** @description Region of the organization. */
|
|
1505
|
+
region?: string;
|
|
1506
|
+
/** @description Display name of the organization owner. */
|
|
1507
|
+
owner?: string;
|
|
1508
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1509
|
+
metadata?: {
|
|
1510
|
+
/** @description Organization-level user experience preferences. */
|
|
1511
|
+
preferences: {
|
|
1512
|
+
/** @description UI theme configured for an organization. */
|
|
1513
|
+
theme: {
|
|
1514
|
+
/**
|
|
1515
|
+
* Format: uuid
|
|
1516
|
+
* @description Theme identifier.
|
|
1517
|
+
*/
|
|
1518
|
+
id: string;
|
|
1519
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1520
|
+
logo: {
|
|
1521
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1522
|
+
desktopView: {
|
|
1523
|
+
/** @description SVG markup for the asset. */
|
|
1524
|
+
svg: string;
|
|
1525
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1526
|
+
location: string;
|
|
1527
|
+
};
|
|
1528
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1529
|
+
mobileView: {
|
|
1530
|
+
/** @description SVG markup for the asset. */
|
|
1531
|
+
svg: string;
|
|
1532
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1533
|
+
location: string;
|
|
1534
|
+
};
|
|
1535
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1536
|
+
darkDesktopView: {
|
|
1537
|
+
/** @description SVG markup for the asset. */
|
|
1538
|
+
svg: string;
|
|
1539
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1540
|
+
location: string;
|
|
1541
|
+
};
|
|
1542
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1543
|
+
darkMobileView: {
|
|
1544
|
+
/** @description SVG markup for the asset. */
|
|
1545
|
+
svg: string;
|
|
1546
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1547
|
+
location: string;
|
|
1548
|
+
};
|
|
1549
|
+
};
|
|
1550
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1551
|
+
vars?: {
|
|
1552
|
+
[key: string]: unknown;
|
|
1553
|
+
};
|
|
1554
|
+
};
|
|
1555
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1556
|
+
dashboard: {
|
|
1557
|
+
[key: string]: unknown;
|
|
1558
|
+
};
|
|
1559
|
+
};
|
|
1560
|
+
};
|
|
1561
|
+
/**
|
|
1562
|
+
* Format: date-time
|
|
1563
|
+
* @description Timestamp when the organization was created.
|
|
1564
|
+
*/
|
|
1565
|
+
createdAt?: string;
|
|
1566
|
+
/**
|
|
1567
|
+
* Format: date-time
|
|
1568
|
+
* @description Timestamp when the organization was last updated.
|
|
1569
|
+
*/
|
|
1570
|
+
updatedAt?: string;
|
|
1571
|
+
/**
|
|
1572
|
+
* Format: date-time
|
|
1573
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1574
|
+
*/
|
|
1575
|
+
deletedAt?: string;
|
|
1576
|
+
}[];
|
|
1577
|
+
};
|
|
1578
|
+
};
|
|
1579
|
+
};
|
|
1580
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1581
|
+
401: {
|
|
1582
|
+
headers: {
|
|
1583
|
+
[name: string]: unknown;
|
|
1584
|
+
};
|
|
1585
|
+
content: {
|
|
1586
|
+
"text/plain": string;
|
|
1587
|
+
};
|
|
1588
|
+
};
|
|
1589
|
+
/** @description Result not found */
|
|
1590
|
+
404: {
|
|
1591
|
+
headers: {
|
|
1592
|
+
[name: string]: unknown;
|
|
1593
|
+
};
|
|
1594
|
+
content: {
|
|
1595
|
+
"text/plain": string;
|
|
1596
|
+
};
|
|
1597
|
+
};
|
|
1598
|
+
/** @description Internal server error */
|
|
1599
|
+
500: {
|
|
1600
|
+
headers: {
|
|
1601
|
+
[name: string]: unknown;
|
|
1602
|
+
};
|
|
1603
|
+
content: {
|
|
1604
|
+
"text/plain": string;
|
|
1605
|
+
};
|
|
1606
|
+
};
|
|
1843
1607
|
};
|
|
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
1608
|
};
|
|
1854
|
-
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1609
|
+
updateOrg: {
|
|
1610
|
+
parameters: {
|
|
1611
|
+
query?: never;
|
|
1612
|
+
header?: never;
|
|
1613
|
+
path: {
|
|
1614
|
+
/** @description Organization ID. */
|
|
1615
|
+
orgId: string;
|
|
1616
|
+
};
|
|
1617
|
+
cookie?: never;
|
|
1618
|
+
};
|
|
1619
|
+
/** @description Body for creating or updating an organization */
|
|
1620
|
+
requestBody: {
|
|
1621
|
+
content: {
|
|
1622
|
+
"application/json": {
|
|
1623
|
+
/** @description Name of the organization. */
|
|
1624
|
+
name?: string;
|
|
1625
|
+
/** @description Country of the organization. */
|
|
1626
|
+
country?: string;
|
|
1627
|
+
/** @description Region of the organization. */
|
|
1628
|
+
region?: string;
|
|
1629
|
+
/** @description Description of the organization. */
|
|
1630
|
+
description?: string;
|
|
1631
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
1632
|
+
notifyOrgUpdate?: boolean;
|
|
1633
|
+
/** @description Organization-level user experience preferences. */
|
|
1634
|
+
preferences?: {
|
|
1635
|
+
/** @description UI theme configured for an organization. */
|
|
1636
|
+
theme: {
|
|
1637
|
+
/**
|
|
1638
|
+
* Format: uuid
|
|
1639
|
+
* @description Theme identifier.
|
|
1640
|
+
*/
|
|
1641
|
+
id: string;
|
|
1642
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1643
|
+
logo: {
|
|
1644
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1645
|
+
desktopView: {
|
|
1646
|
+
/** @description SVG markup for the asset. */
|
|
1647
|
+
svg: string;
|
|
1648
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1649
|
+
location: string;
|
|
1650
|
+
};
|
|
1651
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1652
|
+
mobileView: {
|
|
1653
|
+
/** @description SVG markup for the asset. */
|
|
1654
|
+
svg: string;
|
|
1655
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1656
|
+
location: string;
|
|
1657
|
+
};
|
|
1658
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1659
|
+
darkDesktopView: {
|
|
1660
|
+
/** @description SVG markup for the asset. */
|
|
1661
|
+
svg: string;
|
|
1662
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1663
|
+
location: string;
|
|
1664
|
+
};
|
|
1665
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1666
|
+
darkMobileView: {
|
|
1667
|
+
/** @description SVG markup for the asset. */
|
|
1668
|
+
svg: string;
|
|
1669
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1670
|
+
location: string;
|
|
1671
|
+
};
|
|
1672
|
+
};
|
|
1673
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1674
|
+
vars?: {
|
|
1675
|
+
[key: string]: unknown;
|
|
1676
|
+
};
|
|
1677
|
+
};
|
|
1678
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1679
|
+
dashboard: {
|
|
1680
|
+
[key: string]: unknown;
|
|
1681
|
+
};
|
|
1682
|
+
};
|
|
1683
|
+
};
|
|
1684
|
+
};
|
|
1685
|
+
};
|
|
1686
|
+
responses: {
|
|
1687
|
+
/** @description Single-organization page response for the updated organization */
|
|
1688
|
+
200: {
|
|
1689
|
+
headers: {
|
|
1690
|
+
[name: string]: unknown;
|
|
1691
|
+
};
|
|
1692
|
+
content: {
|
|
1693
|
+
"application/json": {
|
|
1694
|
+
/** @description Zero-based page index returned in this response. */
|
|
1695
|
+
page?: number;
|
|
1696
|
+
/** @description Maximum number of items returned on each page. */
|
|
1697
|
+
pageSize?: number;
|
|
1698
|
+
/** @description Total number of items across all pages. */
|
|
1699
|
+
totalCount?: number;
|
|
1700
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
1701
|
+
organizations?: {
|
|
1702
|
+
/**
|
|
1703
|
+
* Format: uuid
|
|
1704
|
+
* @description Organization ID.
|
|
1705
|
+
*/
|
|
1706
|
+
id?: string;
|
|
1707
|
+
/** @description Name of the organization. */
|
|
1708
|
+
name?: string;
|
|
1709
|
+
/** @description Description of the organization. */
|
|
1710
|
+
description?: string;
|
|
1711
|
+
/** @description Country of the organization. */
|
|
1712
|
+
country?: string;
|
|
1713
|
+
/** @description Region of the organization. */
|
|
1714
|
+
region?: string;
|
|
1715
|
+
/** @description Display name of the organization owner. */
|
|
1716
|
+
owner?: string;
|
|
1717
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1718
|
+
metadata?: {
|
|
1719
|
+
/** @description Organization-level user experience preferences. */
|
|
1720
|
+
preferences: {
|
|
1721
|
+
/** @description UI theme configured for an organization. */
|
|
1722
|
+
theme: {
|
|
1723
|
+
/**
|
|
1724
|
+
* Format: uuid
|
|
1725
|
+
* @description Theme identifier.
|
|
1726
|
+
*/
|
|
1727
|
+
id: string;
|
|
1728
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1729
|
+
logo: {
|
|
1730
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1731
|
+
desktopView: {
|
|
1732
|
+
/** @description SVG markup for the asset. */
|
|
1733
|
+
svg: string;
|
|
1734
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1735
|
+
location: string;
|
|
1736
|
+
};
|
|
1737
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1738
|
+
mobileView: {
|
|
1739
|
+
/** @description SVG markup for the asset. */
|
|
1740
|
+
svg: string;
|
|
1741
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1742
|
+
location: string;
|
|
1743
|
+
};
|
|
1744
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1745
|
+
darkDesktopView: {
|
|
1746
|
+
/** @description SVG markup for the asset. */
|
|
1747
|
+
svg: string;
|
|
1748
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1749
|
+
location: string;
|
|
1750
|
+
};
|
|
1751
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1752
|
+
darkMobileView: {
|
|
1753
|
+
/** @description SVG markup for the asset. */
|
|
1754
|
+
svg: string;
|
|
1755
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1756
|
+
location: string;
|
|
1757
|
+
};
|
|
1758
|
+
};
|
|
1759
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1760
|
+
vars?: {
|
|
1761
|
+
[key: string]: unknown;
|
|
1762
|
+
};
|
|
1763
|
+
};
|
|
1764
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1765
|
+
dashboard: {
|
|
1766
|
+
[key: string]: unknown;
|
|
1767
|
+
};
|
|
1768
|
+
};
|
|
1769
|
+
};
|
|
1770
|
+
/**
|
|
1771
|
+
* Format: date-time
|
|
1772
|
+
* @description Timestamp when the organization was created.
|
|
1773
|
+
*/
|
|
1774
|
+
createdAt?: string;
|
|
1775
|
+
/**
|
|
1776
|
+
* Format: date-time
|
|
1777
|
+
* @description Timestamp when the organization was last updated.
|
|
1778
|
+
*/
|
|
1779
|
+
updatedAt?: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* Format: date-time
|
|
1782
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1783
|
+
*/
|
|
1784
|
+
deletedAt?: string;
|
|
1785
|
+
}[];
|
|
1786
|
+
};
|
|
1787
|
+
};
|
|
1788
|
+
};
|
|
1789
|
+
/** @description Invalid request body or request param */
|
|
1790
|
+
400: {
|
|
1791
|
+
headers: {
|
|
1792
|
+
[name: string]: unknown;
|
|
1793
|
+
};
|
|
1794
|
+
content: {
|
|
1795
|
+
"text/plain": string;
|
|
1796
|
+
};
|
|
1797
|
+
};
|
|
1798
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1799
|
+
401: {
|
|
1800
|
+
headers: {
|
|
1801
|
+
[name: string]: unknown;
|
|
1802
|
+
};
|
|
1803
|
+
content: {
|
|
1804
|
+
"text/plain": string;
|
|
1805
|
+
};
|
|
1806
|
+
};
|
|
1807
|
+
/** @description Result not found */
|
|
1808
|
+
404: {
|
|
1809
|
+
headers: {
|
|
1810
|
+
[name: string]: unknown;
|
|
1811
|
+
};
|
|
1812
|
+
content: {
|
|
1813
|
+
"text/plain": string;
|
|
1814
|
+
};
|
|
1815
|
+
};
|
|
1816
|
+
/** @description Internal server error */
|
|
1817
|
+
500: {
|
|
1818
|
+
headers: {
|
|
1819
|
+
[name: string]: unknown;
|
|
1820
|
+
};
|
|
1821
|
+
content: {
|
|
1822
|
+
"text/plain": string;
|
|
1823
|
+
};
|
|
1824
|
+
};
|
|
1825
|
+
};
|
|
1863
1826
|
};
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1827
|
+
deleteOrg: {
|
|
1828
|
+
parameters: {
|
|
1829
|
+
query?: never;
|
|
1830
|
+
header?: never;
|
|
1831
|
+
path: {
|
|
1832
|
+
/** @description Organization ID. */
|
|
1833
|
+
orgId: string;
|
|
1834
|
+
};
|
|
1835
|
+
cookie?: never;
|
|
1836
|
+
};
|
|
1837
|
+
requestBody?: never;
|
|
1838
|
+
responses: {
|
|
1839
|
+
/** @description Organization deleted */
|
|
1840
|
+
204: {
|
|
1841
|
+
headers: {
|
|
1842
|
+
[name: string]: unknown;
|
|
1843
|
+
};
|
|
1844
|
+
content?: never;
|
|
1845
|
+
};
|
|
1846
|
+
/** @description Invalid request body or request param */
|
|
1847
|
+
400: {
|
|
1848
|
+
headers: {
|
|
1849
|
+
[name: string]: unknown;
|
|
1850
|
+
};
|
|
1851
|
+
content: {
|
|
1852
|
+
"text/plain": string;
|
|
1853
|
+
};
|
|
1854
|
+
};
|
|
1855
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1856
|
+
401: {
|
|
1857
|
+
headers: {
|
|
1858
|
+
[name: string]: unknown;
|
|
1859
|
+
};
|
|
1860
|
+
content: {
|
|
1861
|
+
"text/plain": string;
|
|
1862
|
+
};
|
|
1863
|
+
};
|
|
1864
|
+
/** @description Result not found */
|
|
1865
|
+
404: {
|
|
1866
|
+
headers: {
|
|
1867
|
+
[name: string]: unknown;
|
|
1868
|
+
};
|
|
1869
|
+
content: {
|
|
1870
|
+
"text/plain": string;
|
|
1871
|
+
};
|
|
1872
|
+
};
|
|
1873
|
+
/** @description Internal server error */
|
|
1874
|
+
500: {
|
|
1875
|
+
headers: {
|
|
1876
|
+
[name: string]: unknown;
|
|
1877
|
+
};
|
|
1878
|
+
content: {
|
|
1879
|
+
"text/plain": string;
|
|
1880
|
+
};
|
|
1881
|
+
};
|
|
1869
1882
|
};
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1883
|
+
};
|
|
1884
|
+
getOrgPreferences: {
|
|
1885
|
+
parameters: {
|
|
1886
|
+
query?: never;
|
|
1887
|
+
header?: never;
|
|
1888
|
+
path: {
|
|
1889
|
+
/** @description Organization ID. */
|
|
1890
|
+
orgId: string;
|
|
1891
|
+
};
|
|
1892
|
+
cookie?: never;
|
|
1875
1893
|
};
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1894
|
+
requestBody?: never;
|
|
1895
|
+
responses: {
|
|
1896
|
+
/** @description Organization metadata, including preferences */
|
|
1897
|
+
200: {
|
|
1898
|
+
headers: {
|
|
1899
|
+
[name: string]: unknown;
|
|
1900
|
+
};
|
|
1901
|
+
content: {
|
|
1902
|
+
"application/json": {
|
|
1903
|
+
/** @description Organization-level user experience preferences. */
|
|
1904
|
+
preferences: {
|
|
1905
|
+
/** @description UI theme configured for an organization. */
|
|
1906
|
+
theme: {
|
|
1907
|
+
/**
|
|
1908
|
+
* Format: uuid
|
|
1909
|
+
* @description Theme identifier.
|
|
1910
|
+
*/
|
|
1911
|
+
id: string;
|
|
1912
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1913
|
+
logo: {
|
|
1914
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1915
|
+
desktopView: {
|
|
1916
|
+
/** @description SVG markup for the asset. */
|
|
1917
|
+
svg: string;
|
|
1918
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1919
|
+
location: string;
|
|
1920
|
+
};
|
|
1921
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1922
|
+
mobileView: {
|
|
1923
|
+
/** @description SVG markup for the asset. */
|
|
1924
|
+
svg: string;
|
|
1925
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1926
|
+
location: string;
|
|
1927
|
+
};
|
|
1928
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1929
|
+
darkDesktopView: {
|
|
1930
|
+
/** @description SVG markup for the asset. */
|
|
1931
|
+
svg: string;
|
|
1932
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1933
|
+
location: string;
|
|
1934
|
+
};
|
|
1935
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1936
|
+
darkMobileView: {
|
|
1937
|
+
/** @description SVG markup for the asset. */
|
|
1938
|
+
svg: string;
|
|
1939
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1940
|
+
location: string;
|
|
1941
|
+
};
|
|
1942
|
+
};
|
|
1943
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1944
|
+
vars?: {
|
|
1945
|
+
[key: string]: unknown;
|
|
1946
|
+
};
|
|
1947
|
+
};
|
|
1948
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1949
|
+
dashboard: {
|
|
1950
|
+
[key: string]: unknown;
|
|
1951
|
+
};
|
|
1952
|
+
};
|
|
1953
|
+
};
|
|
1954
|
+
};
|
|
1955
|
+
};
|
|
1956
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1957
|
+
401: {
|
|
1958
|
+
headers: {
|
|
1959
|
+
[name: string]: unknown;
|
|
1960
|
+
};
|
|
1961
|
+
content: {
|
|
1962
|
+
"text/plain": string;
|
|
1963
|
+
};
|
|
1964
|
+
};
|
|
1965
|
+
/** @description Result not found */
|
|
1966
|
+
404: {
|
|
1967
|
+
headers: {
|
|
1968
|
+
[name: string]: unknown;
|
|
1969
|
+
};
|
|
1970
|
+
content: {
|
|
1971
|
+
"text/plain": string;
|
|
1972
|
+
};
|
|
1973
|
+
};
|
|
1974
|
+
/** @description Internal server error */
|
|
1975
|
+
500: {
|
|
1976
|
+
headers: {
|
|
1977
|
+
[name: string]: unknown;
|
|
1978
|
+
};
|
|
1979
|
+
content: {
|
|
1980
|
+
"text/plain": string;
|
|
1981
|
+
};
|
|
1982
|
+
};
|
|
1883
1983
|
};
|
|
1884
|
-
};
|
|
1885
|
-
/** Internal server error */
|
|
1886
|
-
500: unknown;
|
|
1887
1984
|
};
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
|
|
1896
|
-
|
|
1985
|
+
addTeamToOrg: {
|
|
1986
|
+
parameters: {
|
|
1987
|
+
query?: never;
|
|
1988
|
+
header?: never;
|
|
1989
|
+
path: {
|
|
1990
|
+
/** @description Organization ID. */
|
|
1991
|
+
orgId: string;
|
|
1992
|
+
/** @description Team ID. */
|
|
1993
|
+
teamId: string;
|
|
1994
|
+
};
|
|
1995
|
+
cookie?: never;
|
|
1996
|
+
};
|
|
1997
|
+
requestBody?: {
|
|
1998
|
+
content: {
|
|
1999
|
+
"application/json": {
|
|
2000
|
+
/**
|
|
2001
|
+
* @description Internal action to perform on the team resource.
|
|
2002
|
+
* @enum {string}
|
|
2003
|
+
*/
|
|
2004
|
+
action?: "delete";
|
|
2005
|
+
};
|
|
2006
|
+
};
|
|
2007
|
+
};
|
|
2008
|
+
responses: {
|
|
2009
|
+
/** @description Team added to organization or team tombstoned */
|
|
2010
|
+
201: {
|
|
2011
|
+
headers: {
|
|
2012
|
+
[name: string]: unknown;
|
|
2013
|
+
};
|
|
2014
|
+
content: {
|
|
2015
|
+
"application/json": {
|
|
2016
|
+
/** @description Zero-based page index returned in this response. */
|
|
2017
|
+
page?: number;
|
|
2018
|
+
/** @description Maximum number of items returned on each page. */
|
|
2019
|
+
pageSize?: number;
|
|
2020
|
+
/** @description Total number of items across all pages. */
|
|
2021
|
+
totalCount?: number;
|
|
2022
|
+
/** @description Team-organization mapping entries. */
|
|
2023
|
+
teamsOrganizationsMapping?: {
|
|
2024
|
+
/**
|
|
2025
|
+
* Format: uuid
|
|
2026
|
+
* @description Mapping record ID.
|
|
2027
|
+
*/
|
|
2028
|
+
id?: string;
|
|
2029
|
+
/**
|
|
2030
|
+
* Format: uuid
|
|
2031
|
+
* @description Organization ID for this mapping.
|
|
2032
|
+
*/
|
|
2033
|
+
orgId?: string;
|
|
2034
|
+
/**
|
|
2035
|
+
* Format: uuid
|
|
2036
|
+
* @description Team ID for this mapping.
|
|
2037
|
+
*/
|
|
2038
|
+
teamId?: string;
|
|
2039
|
+
/**
|
|
2040
|
+
* Format: date-time
|
|
2041
|
+
* @description Timestamp when the mapping was created.
|
|
2042
|
+
*/
|
|
2043
|
+
createdAt?: string;
|
|
2044
|
+
/**
|
|
2045
|
+
* Format: date-time
|
|
2046
|
+
* @description Timestamp when the mapping was last updated.
|
|
2047
|
+
*/
|
|
2048
|
+
updatedAt?: string;
|
|
2049
|
+
/**
|
|
2050
|
+
* Format: date-time
|
|
2051
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
2052
|
+
*/
|
|
2053
|
+
deletedAt?: string;
|
|
2054
|
+
}[];
|
|
2055
|
+
} | {
|
|
2056
|
+
/** @description Zero-based page index returned in this response. */
|
|
2057
|
+
page?: number;
|
|
2058
|
+
/** @description Maximum number of items returned on each page. */
|
|
2059
|
+
pageSize?: number;
|
|
2060
|
+
/** @description Total number of items across all pages. */
|
|
2061
|
+
totalCount?: number;
|
|
2062
|
+
/** @description Teams in this page. */
|
|
2063
|
+
teams?: {
|
|
2064
|
+
/**
|
|
2065
|
+
* Format: uuid
|
|
2066
|
+
* @description Team ID.
|
|
2067
|
+
*/
|
|
2068
|
+
id?: string;
|
|
2069
|
+
/** @description Name of the team. */
|
|
2070
|
+
name?: string;
|
|
2071
|
+
/** @description Description of the team. */
|
|
2072
|
+
description?: string;
|
|
2073
|
+
/** @description Display name of the team owner. */
|
|
2074
|
+
owner?: string;
|
|
2075
|
+
/** @description Free-form team metadata. */
|
|
2076
|
+
metadata?: {
|
|
2077
|
+
[key: string]: string;
|
|
2078
|
+
};
|
|
2079
|
+
/**
|
|
2080
|
+
* Format: date-time
|
|
2081
|
+
* @description Timestamp when the team was created.
|
|
2082
|
+
*/
|
|
2083
|
+
createdAt?: string;
|
|
2084
|
+
/**
|
|
2085
|
+
* Format: date-time
|
|
2086
|
+
* @description Timestamp when the team was last updated.
|
|
2087
|
+
*/
|
|
2088
|
+
updatedAt?: string;
|
|
2089
|
+
/**
|
|
2090
|
+
* Format: date-time
|
|
2091
|
+
* @description Timestamp when the team was soft-deleted.
|
|
2092
|
+
*/
|
|
2093
|
+
deletedAt?: string;
|
|
2094
|
+
}[];
|
|
2095
|
+
};
|
|
2096
|
+
};
|
|
2097
|
+
};
|
|
2098
|
+
/** @description Bad request */
|
|
2099
|
+
400: {
|
|
2100
|
+
headers: {
|
|
2101
|
+
[name: string]: unknown;
|
|
2102
|
+
};
|
|
2103
|
+
content?: never;
|
|
2104
|
+
};
|
|
2105
|
+
/** @description Unauthorized */
|
|
2106
|
+
401: {
|
|
2107
|
+
headers: {
|
|
2108
|
+
[name: string]: unknown;
|
|
2109
|
+
};
|
|
2110
|
+
content?: never;
|
|
2111
|
+
};
|
|
2112
|
+
/** @description Not found */
|
|
2113
|
+
404: {
|
|
2114
|
+
headers: {
|
|
2115
|
+
[name: string]: unknown;
|
|
2116
|
+
};
|
|
2117
|
+
content?: never;
|
|
2118
|
+
};
|
|
2119
|
+
/** @description Internal server error */
|
|
2120
|
+
500: {
|
|
2121
|
+
headers: {
|
|
2122
|
+
[name: string]: unknown;
|
|
2123
|
+
};
|
|
2124
|
+
content?: never;
|
|
2125
|
+
};
|
|
2126
|
+
};
|
|
1897
2127
|
};
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
|
|
2128
|
+
removeTeamFromOrg: {
|
|
2129
|
+
parameters: {
|
|
2130
|
+
query?: never;
|
|
2131
|
+
header?: never;
|
|
2132
|
+
path: {
|
|
2133
|
+
/** @description Organization ID. */
|
|
2134
|
+
orgId: string;
|
|
2135
|
+
/** @description Team ID. */
|
|
2136
|
+
teamId: string;
|
|
2137
|
+
};
|
|
2138
|
+
cookie?: never;
|
|
2139
|
+
};
|
|
2140
|
+
requestBody?: never;
|
|
2141
|
+
responses: {
|
|
2142
|
+
/** @description Team removed from organization */
|
|
2143
|
+
200: {
|
|
2144
|
+
headers: {
|
|
2145
|
+
[name: string]: unknown;
|
|
2146
|
+
};
|
|
2147
|
+
content: {
|
|
2148
|
+
"application/json": {
|
|
2149
|
+
/** @description Zero-based page index returned in this response. */
|
|
2150
|
+
page?: number;
|
|
2151
|
+
/** @description Maximum number of items returned on each page. */
|
|
2152
|
+
pageSize?: number;
|
|
2153
|
+
/** @description Total number of items across all pages. */
|
|
2154
|
+
totalCount?: number;
|
|
2155
|
+
/** @description Team-organization mapping entries. */
|
|
2156
|
+
teamsOrganizationsMapping?: {
|
|
2157
|
+
/**
|
|
2158
|
+
* Format: uuid
|
|
2159
|
+
* @description Mapping record ID.
|
|
2160
|
+
*/
|
|
2161
|
+
id?: string;
|
|
2162
|
+
/**
|
|
2163
|
+
* Format: uuid
|
|
2164
|
+
* @description Organization ID for this mapping.
|
|
2165
|
+
*/
|
|
2166
|
+
orgId?: string;
|
|
2167
|
+
/**
|
|
2168
|
+
* Format: uuid
|
|
2169
|
+
* @description Team ID for this mapping.
|
|
2170
|
+
*/
|
|
2171
|
+
teamId?: string;
|
|
2172
|
+
/**
|
|
2173
|
+
* Format: date-time
|
|
2174
|
+
* @description Timestamp when the mapping was created.
|
|
2175
|
+
*/
|
|
2176
|
+
createdAt?: string;
|
|
2177
|
+
/**
|
|
2178
|
+
* Format: date-time
|
|
2179
|
+
* @description Timestamp when the mapping was last updated.
|
|
2180
|
+
*/
|
|
2181
|
+
updatedAt?: string;
|
|
2182
|
+
/**
|
|
2183
|
+
* Format: date-time
|
|
2184
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
2185
|
+
*/
|
|
2186
|
+
deletedAt?: string;
|
|
2187
|
+
}[];
|
|
2188
|
+
};
|
|
2189
|
+
};
|
|
2190
|
+
};
|
|
2191
|
+
/** @description Bad request */
|
|
2192
|
+
400: {
|
|
2193
|
+
headers: {
|
|
2194
|
+
[name: string]: unknown;
|
|
2195
|
+
};
|
|
2196
|
+
content?: never;
|
|
2197
|
+
};
|
|
2198
|
+
/** @description Unauthorized */
|
|
2199
|
+
401: {
|
|
2200
|
+
headers: {
|
|
2201
|
+
[name: string]: unknown;
|
|
2202
|
+
};
|
|
2203
|
+
content?: never;
|
|
2204
|
+
};
|
|
2205
|
+
/** @description Not found */
|
|
2206
|
+
404: {
|
|
2207
|
+
headers: {
|
|
2208
|
+
[name: string]: unknown;
|
|
2209
|
+
};
|
|
2210
|
+
content?: never;
|
|
2211
|
+
};
|
|
2212
|
+
/** @description Internal server error */
|
|
2213
|
+
500: {
|
|
2214
|
+
headers: {
|
|
2215
|
+
[name: string]: unknown;
|
|
2216
|
+
};
|
|
2217
|
+
content?: never;
|
|
2218
|
+
};
|
|
2219
|
+
};
|
|
2220
|
+
};
|
|
2221
|
+
addUserToOrg: {
|
|
2222
|
+
parameters: {
|
|
2223
|
+
query?: never;
|
|
2224
|
+
header?: never;
|
|
2225
|
+
path: {
|
|
2226
|
+
/** @description Organization ID. */
|
|
2227
|
+
orgId: string;
|
|
2228
|
+
/** @description User ID. */
|
|
2229
|
+
userId: string;
|
|
2230
|
+
};
|
|
2231
|
+
cookie?: never;
|
|
2232
|
+
};
|
|
2233
|
+
requestBody?: never;
|
|
2234
|
+
responses: {
|
|
2235
|
+
/** @description User added to organization */
|
|
2236
|
+
201: {
|
|
2237
|
+
headers: {
|
|
2238
|
+
[name: string]: unknown;
|
|
2239
|
+
};
|
|
2240
|
+
content: {
|
|
2241
|
+
"application/json": {
|
|
2242
|
+
[key: string]: unknown;
|
|
2243
|
+
};
|
|
2244
|
+
};
|
|
2245
|
+
};
|
|
2246
|
+
/** @description Invalid request body or request param */
|
|
2247
|
+
400: {
|
|
2248
|
+
headers: {
|
|
2249
|
+
[name: string]: unknown;
|
|
2250
|
+
};
|
|
2251
|
+
content: {
|
|
2252
|
+
"text/plain": string;
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
/** @description Unauthorized */
|
|
2256
|
+
401: {
|
|
2257
|
+
headers: {
|
|
2258
|
+
[name: string]: unknown;
|
|
2259
|
+
};
|
|
2260
|
+
content?: never;
|
|
2261
|
+
};
|
|
2262
|
+
/** @description Result not found */
|
|
2263
|
+
404: {
|
|
2264
|
+
headers: {
|
|
2265
|
+
[name: string]: unknown;
|
|
2266
|
+
};
|
|
2267
|
+
content: {
|
|
2268
|
+
"text/plain": string;
|
|
2269
|
+
};
|
|
2270
|
+
};
|
|
2271
|
+
/** @description Internal server error */
|
|
2272
|
+
500: {
|
|
2273
|
+
headers: {
|
|
2274
|
+
[name: string]: unknown;
|
|
2275
|
+
};
|
|
2276
|
+
content?: never;
|
|
2277
|
+
};
|
|
2278
|
+
};
|
|
2279
|
+
};
|
|
2280
|
+
deleteUserFromOrg: {
|
|
2281
|
+
parameters: {
|
|
2282
|
+
query?: never;
|
|
2283
|
+
header?: never;
|
|
2284
|
+
path: {
|
|
2285
|
+
/** @description Organization ID. */
|
|
2286
|
+
orgId: string;
|
|
2287
|
+
/** @description User ID. */
|
|
2288
|
+
userId: string;
|
|
2289
|
+
};
|
|
2290
|
+
cookie?: never;
|
|
2291
|
+
};
|
|
2292
|
+
requestBody?: never;
|
|
2293
|
+
responses: {
|
|
2294
|
+
/** @description User removed from organization */
|
|
2295
|
+
204: {
|
|
2296
|
+
headers: {
|
|
2297
|
+
[name: string]: unknown;
|
|
2298
|
+
};
|
|
2299
|
+
content?: never;
|
|
2300
|
+
};
|
|
2301
|
+
/** @description Unauthorized */
|
|
2302
|
+
401: {
|
|
2303
|
+
headers: {
|
|
2304
|
+
[name: string]: unknown;
|
|
2305
|
+
};
|
|
2306
|
+
content?: never;
|
|
2307
|
+
};
|
|
2308
|
+
/** @description Result not found */
|
|
2309
|
+
404: {
|
|
2310
|
+
headers: {
|
|
2311
|
+
[name: string]: unknown;
|
|
2312
|
+
};
|
|
2313
|
+
content: {
|
|
2314
|
+
"text/plain": string;
|
|
2315
|
+
};
|
|
2316
|
+
};
|
|
2317
|
+
/** @description Internal server error */
|
|
2318
|
+
500: {
|
|
2319
|
+
headers: {
|
|
2320
|
+
[name: string]: unknown;
|
|
2321
|
+
};
|
|
2322
|
+
content?: never;
|
|
2323
|
+
};
|
|
1907
2324
|
};
|
|
1908
|
-
};
|
|
1909
|
-
/** Internal server error */
|
|
1910
|
-
500: unknown;
|
|
1911
2325
|
};
|
|
1912
|
-
};
|
|
1913
2326
|
}
|
|
1914
|
-
|
|
1915
|
-
export interface external {}
|