@meshery/schemas 1.3.107 → 1.3.109
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 +8651 -4670
- package/dist/cloudApi.d.ts +8651 -4670
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/academy/Academy.d.ts +9 -3
- package/dist/constructs/v1beta3/academy/AcademySchema.js +2 -2
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +2 -2
- package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +682 -33
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +215 -22
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +215 -22
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +30 -10
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/media_asset/MediaAsset.d.ts +2322 -0
- package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.js +61 -0
- package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.mjs +61 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAlias.d.ts +678 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAlias.js +1 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAlias.mjs +0 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.js +75 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.mjs +75 -0
- package/dist/constructs/v1beta3/{risk_profile/RiskProfile.d.ts → posture/Posture.d.ts} +7 -7
- package/dist/constructs/v1beta3/posture/Posture.js +1 -0
- package/dist/constructs/v1beta3/posture/Posture.mjs +0 -0
- package/dist/constructs/v1beta3/posture/PostureSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/posture/PostureSchema.js +22 -0
- package/dist/constructs/v1beta3/posture/PostureSchema.mjs +22 -0
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +41 -41
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +23 -23
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +23 -23
- package/dist/index.d.mts +23 -1
- package/dist/index.d.ts +23 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/package.json +1 -1
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.d.ts +0 -2
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.js +0 -22
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.mjs +0 -22
- /package/dist/constructs/v1beta3/{risk_profile/RiskProfile.js → media_asset/MediaAsset.js} +0 -0
- /package/dist/constructs/v1beta3/{risk_profile/RiskProfile.mjs → media_asset/MediaAsset.mjs} +0 -0
|
@@ -0,0 +1,678 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/api/mention-aliases": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* List mention aliases
|
|
16
|
+
* @description Returns a paginated list of the mention aliases of the organization
|
|
17
|
+
* of the authenticated session. `entity` (repeatable) returns only the
|
|
18
|
+
* aliases of those entities, each compared ignoring case, so the
|
|
19
|
+
* aliases for every tag in one message come back in one read; an entity
|
|
20
|
+
* with no alias contributes nothing. `platform` (repeatable) returns
|
|
21
|
+
* only the aliases on those platforms. `search` matches `entity` or
|
|
22
|
+
* `handle` containing the term, ignoring case. `order` sorts by
|
|
23
|
+
* `entity`, `platform`, `createdAt` or `updatedAt` (`asc` or `desc`);
|
|
24
|
+
* the default is `entity asc`, then `platform asc`. An organization
|
|
25
|
+
* with no matching alias returns an empty page.
|
|
26
|
+
*/
|
|
27
|
+
get: operations["getMentionAliases"];
|
|
28
|
+
put?: never;
|
|
29
|
+
/**
|
|
30
|
+
* Write mention aliases
|
|
31
|
+
* @description Writes the confirmed aliases in `mentionAliases`, keyed by (`entity`,
|
|
32
|
+
* `platform`) with `entity` compared ignoring case. A new key creates
|
|
33
|
+
* the alias; an existing key replaces its `handle` and `entity` casing,
|
|
34
|
+
* sets `confirmedBy` to the caller and advances `updatedAt`, even when
|
|
35
|
+
* the handle is unchanged. `id`, `organizationId` and `createdAt` of an
|
|
36
|
+
* existing alias never change. The write is all or nothing in one
|
|
37
|
+
* transaction: a body that fails validation, or that names the same key
|
|
38
|
+
* twice, is refused with a 400 and stores nothing. Answers 200 with the
|
|
39
|
+
* stored aliases, one per entry and in the order of the request.
|
|
40
|
+
*/
|
|
41
|
+
post: operations["upsertMentionAliases"];
|
|
42
|
+
delete?: never;
|
|
43
|
+
options?: never;
|
|
44
|
+
head?: never;
|
|
45
|
+
patch?: never;
|
|
46
|
+
trace?: never;
|
|
47
|
+
};
|
|
48
|
+
"/api/mention-aliases/{mentionAliasId}": {
|
|
49
|
+
parameters: {
|
|
50
|
+
query?: never;
|
|
51
|
+
header?: never;
|
|
52
|
+
path?: never;
|
|
53
|
+
cookie?: never;
|
|
54
|
+
};
|
|
55
|
+
get?: never;
|
|
56
|
+
put?: never;
|
|
57
|
+
post?: never;
|
|
58
|
+
/**
|
|
59
|
+
* Delete a mention alias
|
|
60
|
+
* @description Removes the mention alias, so the next message that tags its entity
|
|
61
|
+
* on its platform starts without a confirmed answer. The row is
|
|
62
|
+
* removed, not soft-deleted, and its key can be written again. An id
|
|
63
|
+
* that does not name a mention alias of the session organization is a
|
|
64
|
+
* 404, the same answer whether it never existed or belongs to another
|
|
65
|
+
* organization.
|
|
66
|
+
*/
|
|
67
|
+
delete: operations["deleteMentionAlias"];
|
|
68
|
+
options?: never;
|
|
69
|
+
head?: never;
|
|
70
|
+
patch?: never;
|
|
71
|
+
trace?: never;
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
export type webhooks = Record<string, never>;
|
|
75
|
+
export interface components {
|
|
76
|
+
schemas: {
|
|
77
|
+
/**
|
|
78
|
+
* Mention Alias Schema
|
|
79
|
+
* @description Server-returned mention alias: how one tagged entity (a person, company,
|
|
80
|
+
* page or community, written `@entity` in a message) is named on one
|
|
81
|
+
* platform, as a member of the organization confirmed it. An organization
|
|
82
|
+
* keeps at most one alias per (entity, platform), with `entity` compared
|
|
83
|
+
* ignoring case, so a confirmed answer is remembered across every later
|
|
84
|
+
* message that tags the same entity. Writing the same key again replaces the
|
|
85
|
+
* alias rather than adding a second one. Aliases belong to the organization
|
|
86
|
+
* of the authenticated session; any member holding the content item keys
|
|
87
|
+
* may read and change them.
|
|
88
|
+
*/
|
|
89
|
+
MentionAlias: {
|
|
90
|
+
/**
|
|
91
|
+
* Format: uuid
|
|
92
|
+
* @description Server-generated mention alias ID.
|
|
93
|
+
*/
|
|
94
|
+
id: string;
|
|
95
|
+
/**
|
|
96
|
+
* Format: uuid
|
|
97
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
98
|
+
*/
|
|
99
|
+
organizationId: string;
|
|
100
|
+
/** @description The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`. */
|
|
101
|
+
entity: string;
|
|
102
|
+
/**
|
|
103
|
+
* @description A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.
|
|
104
|
+
* @enum {string}
|
|
105
|
+
*/
|
|
106
|
+
platform: "linkedin" | "x" | "bluesky" | "reddit" | "slack";
|
|
107
|
+
/** @description The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check. */
|
|
108
|
+
handle: string;
|
|
109
|
+
/**
|
|
110
|
+
* Format: uuid
|
|
111
|
+
* @description ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
|
|
112
|
+
*/
|
|
113
|
+
confirmedBy?: string;
|
|
114
|
+
/**
|
|
115
|
+
* Format: date-time
|
|
116
|
+
* @description Timestamp the alias was first confirmed.
|
|
117
|
+
*/
|
|
118
|
+
createdAt: string;
|
|
119
|
+
/**
|
|
120
|
+
* Format: date-time
|
|
121
|
+
* @description Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
|
|
122
|
+
*/
|
|
123
|
+
updatedAt: string;
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* @description A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.
|
|
127
|
+
* @enum {string}
|
|
128
|
+
*/
|
|
129
|
+
MentionAliasPlatform: "linkedin" | "x" | "bluesky" | "reddit" | "slack";
|
|
130
|
+
/** @description Paginated collection of mention aliases. */
|
|
131
|
+
MentionAliasPage: {
|
|
132
|
+
/** @description Current page number of the result set. */
|
|
133
|
+
page: number;
|
|
134
|
+
/** @description Number of items per page. */
|
|
135
|
+
pageSize: number;
|
|
136
|
+
/** @description Total number of items available. */
|
|
137
|
+
totalCount: number;
|
|
138
|
+
/** @description Mention aliases included on this page of results. */
|
|
139
|
+
mentionAliases: {
|
|
140
|
+
/**
|
|
141
|
+
* Format: uuid
|
|
142
|
+
* @description Server-generated mention alias ID.
|
|
143
|
+
*/
|
|
144
|
+
id: string;
|
|
145
|
+
/**
|
|
146
|
+
* Format: uuid
|
|
147
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
148
|
+
*/
|
|
149
|
+
organizationId: string;
|
|
150
|
+
/** @description The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`. */
|
|
151
|
+
entity: string;
|
|
152
|
+
/**
|
|
153
|
+
* @description A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.
|
|
154
|
+
* @enum {string}
|
|
155
|
+
*/
|
|
156
|
+
platform: "linkedin" | "x" | "bluesky" | "reddit" | "slack";
|
|
157
|
+
/** @description The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check. */
|
|
158
|
+
handle: string;
|
|
159
|
+
/**
|
|
160
|
+
* Format: uuid
|
|
161
|
+
* @description ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
|
|
162
|
+
*/
|
|
163
|
+
confirmedBy?: string;
|
|
164
|
+
/**
|
|
165
|
+
* Format: date-time
|
|
166
|
+
* @description Timestamp the alias was first confirmed.
|
|
167
|
+
*/
|
|
168
|
+
createdAt: string;
|
|
169
|
+
/**
|
|
170
|
+
* Format: date-time
|
|
171
|
+
* @description Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
|
|
172
|
+
*/
|
|
173
|
+
updatedAt: string;
|
|
174
|
+
}[];
|
|
175
|
+
};
|
|
176
|
+
/** @description One confirmed alias to write. Contains only client-settable fields: the alias is keyed by (`entity`, `platform`), so there is no `id`; the owning `organizationId` comes from the session; `confirmedBy` is the caller; and the timestamps are server-generated. */
|
|
177
|
+
MentionAliasPayload: {
|
|
178
|
+
/** @description The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing. */
|
|
179
|
+
entity: string;
|
|
180
|
+
/**
|
|
181
|
+
* @description A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.
|
|
182
|
+
* @enum {string}
|
|
183
|
+
*/
|
|
184
|
+
platform: "linkedin" | "x" | "bluesky" | "reddit" | "slack";
|
|
185
|
+
/** @description The entity's form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored". */
|
|
186
|
+
handle: string;
|
|
187
|
+
};
|
|
188
|
+
/** @description The confirmed aliases to write in one all-or-nothing request. */
|
|
189
|
+
MentionAliasesPayload: {
|
|
190
|
+
/** @description Aliases to write, at most one per (`entity`, `platform`) key with `entity` compared ignoring case. A key named twice refuses the whole request with 400. */
|
|
191
|
+
mentionAliases: {
|
|
192
|
+
/** @description The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing. */
|
|
193
|
+
entity: string;
|
|
194
|
+
/**
|
|
195
|
+
* @description A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.
|
|
196
|
+
* @enum {string}
|
|
197
|
+
*/
|
|
198
|
+
platform: "linkedin" | "x" | "bluesky" | "reddit" | "slack";
|
|
199
|
+
/** @description The entity's form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored". */
|
|
200
|
+
handle: string;
|
|
201
|
+
}[];
|
|
202
|
+
};
|
|
203
|
+
};
|
|
204
|
+
responses: {
|
|
205
|
+
/** @description Invalid request body or request param */
|
|
206
|
+
400: {
|
|
207
|
+
headers: {
|
|
208
|
+
[name: string]: unknown;
|
|
209
|
+
};
|
|
210
|
+
content: {
|
|
211
|
+
"text/plain": string;
|
|
212
|
+
};
|
|
213
|
+
};
|
|
214
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
215
|
+
401: {
|
|
216
|
+
headers: {
|
|
217
|
+
[name: string]: unknown;
|
|
218
|
+
};
|
|
219
|
+
content: {
|
|
220
|
+
"text/plain": string;
|
|
221
|
+
};
|
|
222
|
+
};
|
|
223
|
+
/** @description Forbidden */
|
|
224
|
+
403: {
|
|
225
|
+
headers: {
|
|
226
|
+
[name: string]: unknown;
|
|
227
|
+
};
|
|
228
|
+
content: {
|
|
229
|
+
"text/plain": string;
|
|
230
|
+
};
|
|
231
|
+
};
|
|
232
|
+
/** @description Result not found */
|
|
233
|
+
404: {
|
|
234
|
+
headers: {
|
|
235
|
+
[name: string]: unknown;
|
|
236
|
+
};
|
|
237
|
+
content: {
|
|
238
|
+
"text/plain": string;
|
|
239
|
+
};
|
|
240
|
+
};
|
|
241
|
+
/** @description Internal server error */
|
|
242
|
+
500: {
|
|
243
|
+
headers: {
|
|
244
|
+
[name: string]: unknown;
|
|
245
|
+
};
|
|
246
|
+
content: {
|
|
247
|
+
"text/plain": string;
|
|
248
|
+
};
|
|
249
|
+
};
|
|
250
|
+
/** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
|
|
251
|
+
MeshkitError429: {
|
|
252
|
+
headers: {
|
|
253
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
254
|
+
"Retry-After": number;
|
|
255
|
+
[name: string]: unknown;
|
|
256
|
+
};
|
|
257
|
+
content: {
|
|
258
|
+
"application/json": {
|
|
259
|
+
/** @description The sentence the caller is shown. */
|
|
260
|
+
error: string;
|
|
261
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
262
|
+
code?: string;
|
|
263
|
+
/**
|
|
264
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
265
|
+
* @enum {string}
|
|
266
|
+
*/
|
|
267
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
268
|
+
/** @description MeshKit's probable causes of the error. */
|
|
269
|
+
probableCause?: string[];
|
|
270
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
271
|
+
suggestedRemediation?: string[];
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
};
|
|
275
|
+
};
|
|
276
|
+
parameters: {
|
|
277
|
+
/** @description Get responses by page */
|
|
278
|
+
page: number;
|
|
279
|
+
/** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
280
|
+
pageSize: number;
|
|
281
|
+
/** @description Get responses that match search param value */
|
|
282
|
+
search: string;
|
|
283
|
+
/** @description Get ordered responses */
|
|
284
|
+
order: string;
|
|
285
|
+
/** @description Return only the aliases of these entities (repeatable), each compared ignoring case. */
|
|
286
|
+
entity: string[];
|
|
287
|
+
/** @description Return only the aliases on these platforms (repeatable). */
|
|
288
|
+
platform: ("linkedin" | "x" | "bluesky" | "reddit" | "slack")[];
|
|
289
|
+
/** @description Mention alias ID */
|
|
290
|
+
mentionAliasId: string;
|
|
291
|
+
};
|
|
292
|
+
requestBodies: never;
|
|
293
|
+
headers: never;
|
|
294
|
+
pathItems: never;
|
|
295
|
+
}
|
|
296
|
+
export type $defs = Record<string, never>;
|
|
297
|
+
export interface operations {
|
|
298
|
+
getMentionAliases: {
|
|
299
|
+
parameters: {
|
|
300
|
+
query?: {
|
|
301
|
+
/** @description Get responses by page */
|
|
302
|
+
page?: number;
|
|
303
|
+
/** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
304
|
+
pageSize?: number;
|
|
305
|
+
/** @description Get responses that match search param value */
|
|
306
|
+
search?: string;
|
|
307
|
+
/** @description Get ordered responses */
|
|
308
|
+
order?: string;
|
|
309
|
+
/** @description Return only the aliases of these entities (repeatable), each compared ignoring case. */
|
|
310
|
+
entity?: string[];
|
|
311
|
+
/** @description Return only the aliases on these platforms (repeatable). */
|
|
312
|
+
platform?: ("linkedin" | "x" | "bluesky" | "reddit" | "slack")[];
|
|
313
|
+
};
|
|
314
|
+
header?: never;
|
|
315
|
+
path?: never;
|
|
316
|
+
cookie?: never;
|
|
317
|
+
};
|
|
318
|
+
requestBody?: never;
|
|
319
|
+
responses: {
|
|
320
|
+
/** @description Mention alias page */
|
|
321
|
+
200: {
|
|
322
|
+
headers: {
|
|
323
|
+
[name: string]: unknown;
|
|
324
|
+
};
|
|
325
|
+
content: {
|
|
326
|
+
"application/json": {
|
|
327
|
+
/** @description Current page number of the result set. */
|
|
328
|
+
page: number;
|
|
329
|
+
/** @description Number of items per page. */
|
|
330
|
+
pageSize: number;
|
|
331
|
+
/** @description Total number of items available. */
|
|
332
|
+
totalCount: number;
|
|
333
|
+
/** @description Mention aliases included on this page of results. */
|
|
334
|
+
mentionAliases: {
|
|
335
|
+
/**
|
|
336
|
+
* Format: uuid
|
|
337
|
+
* @description Server-generated mention alias ID.
|
|
338
|
+
*/
|
|
339
|
+
id: string;
|
|
340
|
+
/**
|
|
341
|
+
* Format: uuid
|
|
342
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
343
|
+
*/
|
|
344
|
+
organizationId: string;
|
|
345
|
+
/** @description The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`. */
|
|
346
|
+
entity: string;
|
|
347
|
+
/**
|
|
348
|
+
* @description A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.
|
|
349
|
+
* @enum {string}
|
|
350
|
+
*/
|
|
351
|
+
platform: "linkedin" | "x" | "bluesky" | "reddit" | "slack";
|
|
352
|
+
/** @description The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check. */
|
|
353
|
+
handle: string;
|
|
354
|
+
/**
|
|
355
|
+
* Format: uuid
|
|
356
|
+
* @description ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
|
|
357
|
+
*/
|
|
358
|
+
confirmedBy?: string;
|
|
359
|
+
/**
|
|
360
|
+
* Format: date-time
|
|
361
|
+
* @description Timestamp the alias was first confirmed.
|
|
362
|
+
*/
|
|
363
|
+
createdAt: string;
|
|
364
|
+
/**
|
|
365
|
+
* Format: date-time
|
|
366
|
+
* @description Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
|
|
367
|
+
*/
|
|
368
|
+
updatedAt: string;
|
|
369
|
+
}[];
|
|
370
|
+
};
|
|
371
|
+
};
|
|
372
|
+
};
|
|
373
|
+
/** @description Invalid request body or request param */
|
|
374
|
+
400: {
|
|
375
|
+
headers: {
|
|
376
|
+
[name: string]: unknown;
|
|
377
|
+
};
|
|
378
|
+
content: {
|
|
379
|
+
"text/plain": string;
|
|
380
|
+
};
|
|
381
|
+
};
|
|
382
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
383
|
+
401: {
|
|
384
|
+
headers: {
|
|
385
|
+
[name: string]: unknown;
|
|
386
|
+
};
|
|
387
|
+
content: {
|
|
388
|
+
"text/plain": string;
|
|
389
|
+
};
|
|
390
|
+
};
|
|
391
|
+
/** @description Forbidden */
|
|
392
|
+
403: {
|
|
393
|
+
headers: {
|
|
394
|
+
[name: string]: unknown;
|
|
395
|
+
};
|
|
396
|
+
content: {
|
|
397
|
+
"text/plain": string;
|
|
398
|
+
};
|
|
399
|
+
};
|
|
400
|
+
/** @description Result not found */
|
|
401
|
+
404: {
|
|
402
|
+
headers: {
|
|
403
|
+
[name: string]: unknown;
|
|
404
|
+
};
|
|
405
|
+
content: {
|
|
406
|
+
"text/plain": string;
|
|
407
|
+
};
|
|
408
|
+
};
|
|
409
|
+
/** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
|
|
410
|
+
429: {
|
|
411
|
+
headers: {
|
|
412
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
413
|
+
"Retry-After": number;
|
|
414
|
+
[name: string]: unknown;
|
|
415
|
+
};
|
|
416
|
+
content: {
|
|
417
|
+
"application/json": {
|
|
418
|
+
/** @description The sentence the caller is shown. */
|
|
419
|
+
error: string;
|
|
420
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
421
|
+
code?: string;
|
|
422
|
+
/**
|
|
423
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
424
|
+
* @enum {string}
|
|
425
|
+
*/
|
|
426
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
427
|
+
/** @description MeshKit's probable causes of the error. */
|
|
428
|
+
probableCause?: string[];
|
|
429
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
430
|
+
suggestedRemediation?: string[];
|
|
431
|
+
};
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
/** @description Internal server error */
|
|
435
|
+
500: {
|
|
436
|
+
headers: {
|
|
437
|
+
[name: string]: unknown;
|
|
438
|
+
};
|
|
439
|
+
content: {
|
|
440
|
+
"text/plain": string;
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
};
|
|
444
|
+
};
|
|
445
|
+
upsertMentionAliases: {
|
|
446
|
+
parameters: {
|
|
447
|
+
query?: never;
|
|
448
|
+
header?: never;
|
|
449
|
+
path?: never;
|
|
450
|
+
cookie?: never;
|
|
451
|
+
};
|
|
452
|
+
requestBody: {
|
|
453
|
+
content: {
|
|
454
|
+
"application/json": {
|
|
455
|
+
/** @description Aliases to write, at most one per (`entity`, `platform`) key with `entity` compared ignoring case. A key named twice refuses the whole request with 400. */
|
|
456
|
+
mentionAliases: {
|
|
457
|
+
/** @description The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing. */
|
|
458
|
+
entity: string;
|
|
459
|
+
/**
|
|
460
|
+
* @description A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.
|
|
461
|
+
* @enum {string}
|
|
462
|
+
*/
|
|
463
|
+
platform: "linkedin" | "x" | "bluesky" | "reddit" | "slack";
|
|
464
|
+
/** @description The entity's form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored". */
|
|
465
|
+
handle: string;
|
|
466
|
+
}[];
|
|
467
|
+
};
|
|
468
|
+
};
|
|
469
|
+
};
|
|
470
|
+
responses: {
|
|
471
|
+
/** @description The stored mention aliases, one per request entry, in request order */
|
|
472
|
+
200: {
|
|
473
|
+
headers: {
|
|
474
|
+
[name: string]: unknown;
|
|
475
|
+
};
|
|
476
|
+
content: {
|
|
477
|
+
"application/json": {
|
|
478
|
+
/**
|
|
479
|
+
* Format: uuid
|
|
480
|
+
* @description Server-generated mention alias ID.
|
|
481
|
+
*/
|
|
482
|
+
id: string;
|
|
483
|
+
/**
|
|
484
|
+
* Format: uuid
|
|
485
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
486
|
+
*/
|
|
487
|
+
organizationId: string;
|
|
488
|
+
/** @description The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`. */
|
|
489
|
+
entity: string;
|
|
490
|
+
/**
|
|
491
|
+
* @description A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.
|
|
492
|
+
* @enum {string}
|
|
493
|
+
*/
|
|
494
|
+
platform: "linkedin" | "x" | "bluesky" | "reddit" | "slack";
|
|
495
|
+
/** @description The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check. */
|
|
496
|
+
handle: string;
|
|
497
|
+
/**
|
|
498
|
+
* Format: uuid
|
|
499
|
+
* @description ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
|
|
500
|
+
*/
|
|
501
|
+
confirmedBy?: string;
|
|
502
|
+
/**
|
|
503
|
+
* Format: date-time
|
|
504
|
+
* @description Timestamp the alias was first confirmed.
|
|
505
|
+
*/
|
|
506
|
+
createdAt: string;
|
|
507
|
+
/**
|
|
508
|
+
* Format: date-time
|
|
509
|
+
* @description Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
|
|
510
|
+
*/
|
|
511
|
+
updatedAt: string;
|
|
512
|
+
}[];
|
|
513
|
+
};
|
|
514
|
+
};
|
|
515
|
+
/** @description Invalid request body or request param */
|
|
516
|
+
400: {
|
|
517
|
+
headers: {
|
|
518
|
+
[name: string]: unknown;
|
|
519
|
+
};
|
|
520
|
+
content: {
|
|
521
|
+
"text/plain": string;
|
|
522
|
+
};
|
|
523
|
+
};
|
|
524
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
525
|
+
401: {
|
|
526
|
+
headers: {
|
|
527
|
+
[name: string]: unknown;
|
|
528
|
+
};
|
|
529
|
+
content: {
|
|
530
|
+
"text/plain": string;
|
|
531
|
+
};
|
|
532
|
+
};
|
|
533
|
+
/** @description Forbidden */
|
|
534
|
+
403: {
|
|
535
|
+
headers: {
|
|
536
|
+
[name: string]: unknown;
|
|
537
|
+
};
|
|
538
|
+
content: {
|
|
539
|
+
"text/plain": string;
|
|
540
|
+
};
|
|
541
|
+
};
|
|
542
|
+
/** @description Result not found */
|
|
543
|
+
404: {
|
|
544
|
+
headers: {
|
|
545
|
+
[name: string]: unknown;
|
|
546
|
+
};
|
|
547
|
+
content: {
|
|
548
|
+
"text/plain": string;
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
/** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
|
|
552
|
+
429: {
|
|
553
|
+
headers: {
|
|
554
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
555
|
+
"Retry-After": number;
|
|
556
|
+
[name: string]: unknown;
|
|
557
|
+
};
|
|
558
|
+
content: {
|
|
559
|
+
"application/json": {
|
|
560
|
+
/** @description The sentence the caller is shown. */
|
|
561
|
+
error: string;
|
|
562
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
563
|
+
code?: string;
|
|
564
|
+
/**
|
|
565
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
566
|
+
* @enum {string}
|
|
567
|
+
*/
|
|
568
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
569
|
+
/** @description MeshKit's probable causes of the error. */
|
|
570
|
+
probableCause?: string[];
|
|
571
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
572
|
+
suggestedRemediation?: string[];
|
|
573
|
+
};
|
|
574
|
+
};
|
|
575
|
+
};
|
|
576
|
+
/** @description Internal server error */
|
|
577
|
+
500: {
|
|
578
|
+
headers: {
|
|
579
|
+
[name: string]: unknown;
|
|
580
|
+
};
|
|
581
|
+
content: {
|
|
582
|
+
"text/plain": string;
|
|
583
|
+
};
|
|
584
|
+
};
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
deleteMentionAlias: {
|
|
588
|
+
parameters: {
|
|
589
|
+
query?: never;
|
|
590
|
+
header?: never;
|
|
591
|
+
path: {
|
|
592
|
+
/** @description Mention alias ID */
|
|
593
|
+
mentionAliasId: string;
|
|
594
|
+
};
|
|
595
|
+
cookie?: never;
|
|
596
|
+
};
|
|
597
|
+
requestBody?: never;
|
|
598
|
+
responses: {
|
|
599
|
+
/** @description Mention alias deleted */
|
|
600
|
+
204: {
|
|
601
|
+
headers: {
|
|
602
|
+
[name: string]: unknown;
|
|
603
|
+
};
|
|
604
|
+
content?: never;
|
|
605
|
+
};
|
|
606
|
+
/** @description Invalid request body or request param */
|
|
607
|
+
400: {
|
|
608
|
+
headers: {
|
|
609
|
+
[name: string]: unknown;
|
|
610
|
+
};
|
|
611
|
+
content: {
|
|
612
|
+
"text/plain": string;
|
|
613
|
+
};
|
|
614
|
+
};
|
|
615
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
616
|
+
401: {
|
|
617
|
+
headers: {
|
|
618
|
+
[name: string]: unknown;
|
|
619
|
+
};
|
|
620
|
+
content: {
|
|
621
|
+
"text/plain": string;
|
|
622
|
+
};
|
|
623
|
+
};
|
|
624
|
+
/** @description Forbidden */
|
|
625
|
+
403: {
|
|
626
|
+
headers: {
|
|
627
|
+
[name: string]: unknown;
|
|
628
|
+
};
|
|
629
|
+
content: {
|
|
630
|
+
"text/plain": string;
|
|
631
|
+
};
|
|
632
|
+
};
|
|
633
|
+
/** @description Result not found */
|
|
634
|
+
404: {
|
|
635
|
+
headers: {
|
|
636
|
+
[name: string]: unknown;
|
|
637
|
+
};
|
|
638
|
+
content: {
|
|
639
|
+
"text/plain": string;
|
|
640
|
+
};
|
|
641
|
+
};
|
|
642
|
+
/** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
|
|
643
|
+
429: {
|
|
644
|
+
headers: {
|
|
645
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
646
|
+
"Retry-After": number;
|
|
647
|
+
[name: string]: unknown;
|
|
648
|
+
};
|
|
649
|
+
content: {
|
|
650
|
+
"application/json": {
|
|
651
|
+
/** @description The sentence the caller is shown. */
|
|
652
|
+
error: string;
|
|
653
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
654
|
+
code?: string;
|
|
655
|
+
/**
|
|
656
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
657
|
+
* @enum {string}
|
|
658
|
+
*/
|
|
659
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
660
|
+
/** @description MeshKit's probable causes of the error. */
|
|
661
|
+
probableCause?: string[];
|
|
662
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
663
|
+
suggestedRemediation?: string[];
|
|
664
|
+
};
|
|
665
|
+
};
|
|
666
|
+
};
|
|
667
|
+
/** @description Internal server error */
|
|
668
|
+
500: {
|
|
669
|
+
headers: {
|
|
670
|
+
[name: string]: unknown;
|
|
671
|
+
};
|
|
672
|
+
content: {
|
|
673
|
+
"text/plain": string;
|
|
674
|
+
};
|
|
675
|
+
};
|
|
676
|
+
};
|
|
677
|
+
};
|
|
678
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|