@convex-dev/platform 0.1.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/README.md +7 -0
- package/dist/client.cjs +47 -0
- package/dist/client.cjs.map +1 -0
- package/dist/client.d.cts +14 -0
- package/dist/client.d.cts.map +1 -0
- package/dist/client.d.ts +14 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +39 -0
- package/dist/client.js.map +1 -0
- package/dist/generatedDeploymentApi.cjs +7 -0
- package/dist/generatedDeploymentApi.cjs.map +1 -0
- package/dist/generatedDeploymentApi.d.cts +787 -0
- package/dist/generatedDeploymentApi.d.cts.map +1 -0
- package/dist/generatedDeploymentApi.d.ts +787 -0
- package/dist/generatedDeploymentApi.d.ts.map +1 -0
- package/dist/generatedDeploymentApi.js +6 -0
- package/dist/generatedDeploymentApi.js.map +1 -0
- package/dist/generatedLogStreamApi.cjs +7 -0
- package/dist/generatedLogStreamApi.cjs.map +1 -0
- package/dist/generatedLogStreamApi.d.cts +149 -0
- package/dist/generatedLogStreamApi.d.cts.map +1 -0
- package/dist/generatedLogStreamApi.d.ts +149 -0
- package/dist/generatedLogStreamApi.d.ts.map +1 -0
- package/dist/generatedLogStreamApi.js +6 -0
- package/dist/generatedLogStreamApi.js.map +1 -0
- package/dist/generatedManagementApi.cjs +7 -0
- package/dist/generatedManagementApi.cjs.map +1 -0
- package/dist/generatedManagementApi.d.cts +924 -0
- package/dist/generatedManagementApi.d.cts.map +1 -0
- package/dist/generatedManagementApi.d.ts +924 -0
- package/dist/generatedManagementApi.d.ts.map +1 -0
- package/dist/generatedManagementApi.js +6 -0
- package/dist/generatedManagementApi.js.map +1 -0
- package/dist/index.cjs +18 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +2 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/version.cjs +5 -0
- package/dist/version.cjs.map +1 -0
- package/dist/version.d.cts +2 -0
- package/dist/version.d.cts.map +1 -0
- package/dist/version.d.ts +2 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/version.js +2 -0
- package/dist/version.js.map +1 -0
- package/package.json +69 -0
|
@@ -0,0 +1,924 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
"/teams/{team_id}/create_project": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
get?: never;
|
|
14
|
+
put?: never;
|
|
15
|
+
/**
|
|
16
|
+
* Create project
|
|
17
|
+
* @description Create a new project on a team and provision a dev or prod deployment.
|
|
18
|
+
*/
|
|
19
|
+
post: operations["create project"];
|
|
20
|
+
delete?: never;
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/teams/{team_id}/list_projects": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* List projects
|
|
35
|
+
* @description List all projects for a team.
|
|
36
|
+
*/
|
|
37
|
+
get: operations["list projects"];
|
|
38
|
+
put?: never;
|
|
39
|
+
post?: never;
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
"/projects/{project_id}/list_deployments": {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* List deployments
|
|
55
|
+
* @description List deployments for a projects.
|
|
56
|
+
*/
|
|
57
|
+
get: operations["list deployments"];
|
|
58
|
+
put?: never;
|
|
59
|
+
post?: never;
|
|
60
|
+
delete?: never;
|
|
61
|
+
options?: never;
|
|
62
|
+
head?: never;
|
|
63
|
+
patch?: never;
|
|
64
|
+
trace?: never;
|
|
65
|
+
};
|
|
66
|
+
"/projects/{project_id}/delete": {
|
|
67
|
+
parameters: {
|
|
68
|
+
query?: never;
|
|
69
|
+
header?: never;
|
|
70
|
+
path?: never;
|
|
71
|
+
cookie?: never;
|
|
72
|
+
};
|
|
73
|
+
get?: never;
|
|
74
|
+
put?: never;
|
|
75
|
+
/**
|
|
76
|
+
* Delete project
|
|
77
|
+
* @description Delete a project. Deletes all deployments in the project as well.
|
|
78
|
+
*/
|
|
79
|
+
post: operations["delete project"];
|
|
80
|
+
delete?: never;
|
|
81
|
+
options?: never;
|
|
82
|
+
head?: never;
|
|
83
|
+
patch?: never;
|
|
84
|
+
trace?: never;
|
|
85
|
+
};
|
|
86
|
+
"/projects/{project_id}/create_deployment": {
|
|
87
|
+
parameters: {
|
|
88
|
+
query?: never;
|
|
89
|
+
header?: never;
|
|
90
|
+
path?: never;
|
|
91
|
+
cookie?: never;
|
|
92
|
+
};
|
|
93
|
+
get?: never;
|
|
94
|
+
put?: never;
|
|
95
|
+
/**
|
|
96
|
+
* Create deployment
|
|
97
|
+
* @description Create a new deployment for a project.
|
|
98
|
+
*/
|
|
99
|
+
post: operations["create deployment"];
|
|
100
|
+
delete?: never;
|
|
101
|
+
options?: never;
|
|
102
|
+
head?: never;
|
|
103
|
+
patch?: never;
|
|
104
|
+
trace?: never;
|
|
105
|
+
};
|
|
106
|
+
"/deployments/{deployment_name}/delete": {
|
|
107
|
+
parameters: {
|
|
108
|
+
query?: never;
|
|
109
|
+
header?: never;
|
|
110
|
+
path?: never;
|
|
111
|
+
cookie?: never;
|
|
112
|
+
};
|
|
113
|
+
get?: never;
|
|
114
|
+
put?: never;
|
|
115
|
+
/**
|
|
116
|
+
* Delete deployment
|
|
117
|
+
* @description Delete a deployment. This will delete all data and files in the deployment,
|
|
118
|
+
* so we recommend creating and downloading a backup before calling this
|
|
119
|
+
* endpoint. This does not delete the project itself.
|
|
120
|
+
*/
|
|
121
|
+
post: operations["delete deployment"];
|
|
122
|
+
delete?: never;
|
|
123
|
+
options?: never;
|
|
124
|
+
head?: never;
|
|
125
|
+
patch?: never;
|
|
126
|
+
trace?: never;
|
|
127
|
+
};
|
|
128
|
+
"/teams/{team_id}/list_deployment_classes": {
|
|
129
|
+
parameters: {
|
|
130
|
+
query?: never;
|
|
131
|
+
header?: never;
|
|
132
|
+
path?: never;
|
|
133
|
+
cookie?: never;
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* List deployment classes
|
|
137
|
+
* @description Lists the available deployment classes for a team.
|
|
138
|
+
*/
|
|
139
|
+
get: operations["list deployment classes"];
|
|
140
|
+
put?: never;
|
|
141
|
+
post?: never;
|
|
142
|
+
delete?: never;
|
|
143
|
+
options?: never;
|
|
144
|
+
head?: never;
|
|
145
|
+
patch?: never;
|
|
146
|
+
trace?: never;
|
|
147
|
+
};
|
|
148
|
+
"/teams/{team_id}/list_deployment_regions": {
|
|
149
|
+
parameters: {
|
|
150
|
+
query?: never;
|
|
151
|
+
header?: never;
|
|
152
|
+
path?: never;
|
|
153
|
+
cookie?: never;
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* List deployment regions
|
|
157
|
+
* @description Lists the available deployment regions for a team.
|
|
158
|
+
*/
|
|
159
|
+
get: operations["list deployment regions"];
|
|
160
|
+
put?: never;
|
|
161
|
+
post?: never;
|
|
162
|
+
delete?: never;
|
|
163
|
+
options?: never;
|
|
164
|
+
head?: never;
|
|
165
|
+
patch?: never;
|
|
166
|
+
trace?: never;
|
|
167
|
+
};
|
|
168
|
+
"/deployments/{deployment_name}/create_deploy_key": {
|
|
169
|
+
parameters: {
|
|
170
|
+
query?: never;
|
|
171
|
+
header?: never;
|
|
172
|
+
path?: never;
|
|
173
|
+
cookie?: never;
|
|
174
|
+
};
|
|
175
|
+
get?: never;
|
|
176
|
+
put?: never;
|
|
177
|
+
/**
|
|
178
|
+
* Create deploy key
|
|
179
|
+
* @description Create a deploy key like "dev:happy-animal-123|ey..." which can be
|
|
180
|
+
* used with the Convex CLI to develop against or deploy code.
|
|
181
|
+
*
|
|
182
|
+
* When access to the deployment is granted through an OAuth token this
|
|
183
|
+
* deploy key will use the same OAuth-granted token.
|
|
184
|
+
*
|
|
185
|
+
* When access to the deployment is granted any other way a new token will be
|
|
186
|
+
* created which grants access only to this deployment.
|
|
187
|
+
*/
|
|
188
|
+
post: operations["create deploy key"];
|
|
189
|
+
delete?: never;
|
|
190
|
+
options?: never;
|
|
191
|
+
head?: never;
|
|
192
|
+
patch?: never;
|
|
193
|
+
trace?: never;
|
|
194
|
+
};
|
|
195
|
+
"/deployments/{deployment_name}/list_deploy_keys": {
|
|
196
|
+
parameters: {
|
|
197
|
+
query?: never;
|
|
198
|
+
header?: never;
|
|
199
|
+
path?: never;
|
|
200
|
+
cookie?: never;
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* List deploy keys
|
|
204
|
+
* @description Lists all deploy keys for the specified deployment.
|
|
205
|
+
*/
|
|
206
|
+
get: operations["list deploy keys"];
|
|
207
|
+
put?: never;
|
|
208
|
+
post?: never;
|
|
209
|
+
delete?: never;
|
|
210
|
+
options?: never;
|
|
211
|
+
head?: never;
|
|
212
|
+
patch?: never;
|
|
213
|
+
trace?: never;
|
|
214
|
+
};
|
|
215
|
+
"/deployments/{deployment_name}/delete_deploy_key": {
|
|
216
|
+
parameters: {
|
|
217
|
+
query?: never;
|
|
218
|
+
header?: never;
|
|
219
|
+
path?: never;
|
|
220
|
+
cookie?: never;
|
|
221
|
+
};
|
|
222
|
+
get?: never;
|
|
223
|
+
put?: never;
|
|
224
|
+
/**
|
|
225
|
+
* Delete deploy key
|
|
226
|
+
* @description Deletes a deploy key for the specified deployment. The `id` in the request
|
|
227
|
+
* body can be the full deploy key (with prefix), encoded token, or the name of
|
|
228
|
+
* the deploy key.
|
|
229
|
+
*/
|
|
230
|
+
post: operations["delete deploy key"];
|
|
231
|
+
delete?: never;
|
|
232
|
+
options?: never;
|
|
233
|
+
head?: never;
|
|
234
|
+
patch?: never;
|
|
235
|
+
trace?: never;
|
|
236
|
+
};
|
|
237
|
+
"/token_details": {
|
|
238
|
+
parameters: {
|
|
239
|
+
query?: never;
|
|
240
|
+
header?: never;
|
|
241
|
+
path?: never;
|
|
242
|
+
cookie?: never;
|
|
243
|
+
};
|
|
244
|
+
/**
|
|
245
|
+
* Get token details
|
|
246
|
+
* @description Returns the team ID for team tokens.
|
|
247
|
+
* Especially useful after receiving a team token from an OAuth flow
|
|
248
|
+
* since most endpoints require team ID.
|
|
249
|
+
*/
|
|
250
|
+
get: operations["get token details"];
|
|
251
|
+
put?: never;
|
|
252
|
+
post?: never;
|
|
253
|
+
delete?: never;
|
|
254
|
+
options?: never;
|
|
255
|
+
head?: never;
|
|
256
|
+
patch?: never;
|
|
257
|
+
trace?: never;
|
|
258
|
+
};
|
|
259
|
+
"/deployments/{deployment_name}/create_custom_domain": {
|
|
260
|
+
parameters: {
|
|
261
|
+
query?: never;
|
|
262
|
+
header?: never;
|
|
263
|
+
path?: never;
|
|
264
|
+
cookie?: never;
|
|
265
|
+
};
|
|
266
|
+
get?: never;
|
|
267
|
+
put?: never;
|
|
268
|
+
/** Create custom domain */
|
|
269
|
+
post: operations["create custom domain"];
|
|
270
|
+
delete?: never;
|
|
271
|
+
options?: never;
|
|
272
|
+
head?: never;
|
|
273
|
+
patch?: never;
|
|
274
|
+
trace?: never;
|
|
275
|
+
};
|
|
276
|
+
"/deployments/{deployment_name}/delete_custom_domain": {
|
|
277
|
+
parameters: {
|
|
278
|
+
query?: never;
|
|
279
|
+
header?: never;
|
|
280
|
+
path?: never;
|
|
281
|
+
cookie?: never;
|
|
282
|
+
};
|
|
283
|
+
get?: never;
|
|
284
|
+
put?: never;
|
|
285
|
+
/**
|
|
286
|
+
* Delete custom domain
|
|
287
|
+
* @description Remove a custom domain from a deployment.
|
|
288
|
+
*/
|
|
289
|
+
post: operations["delete custom domain"];
|
|
290
|
+
delete?: never;
|
|
291
|
+
options?: never;
|
|
292
|
+
head?: never;
|
|
293
|
+
patch?: never;
|
|
294
|
+
trace?: never;
|
|
295
|
+
};
|
|
296
|
+
"/deployments/{deployment_name}/custom_domains": {
|
|
297
|
+
parameters: {
|
|
298
|
+
query?: never;
|
|
299
|
+
header?: never;
|
|
300
|
+
path?: never;
|
|
301
|
+
cookie?: never;
|
|
302
|
+
};
|
|
303
|
+
/**
|
|
304
|
+
* List custom domains
|
|
305
|
+
* @description Get all custom domains configured for a deployment.
|
|
306
|
+
*/
|
|
307
|
+
get: operations["list custom domains"];
|
|
308
|
+
put?: never;
|
|
309
|
+
post?: never;
|
|
310
|
+
delete?: never;
|
|
311
|
+
options?: never;
|
|
312
|
+
head?: never;
|
|
313
|
+
patch?: never;
|
|
314
|
+
trace?: never;
|
|
315
|
+
};
|
|
316
|
+
}
|
|
317
|
+
export type webhooks = Record<string, never>;
|
|
318
|
+
export interface components {
|
|
319
|
+
schemas: {
|
|
320
|
+
/** @description Encrypted admin key */
|
|
321
|
+
AdminKey: string;
|
|
322
|
+
/** @enum {string} */
|
|
323
|
+
CreateDeploymentType: "dev" | "prod";
|
|
324
|
+
/** @enum {string} */
|
|
325
|
+
DeploymentClass: "s16" | "s256" | "d1024";
|
|
326
|
+
DeploymentClassMetadata: {
|
|
327
|
+
available: boolean;
|
|
328
|
+
type: components["schemas"]["DeploymentClass"];
|
|
329
|
+
};
|
|
330
|
+
/** Format: int64 */
|
|
331
|
+
DeploymentId: number;
|
|
332
|
+
DeploymentRegionMetadata: {
|
|
333
|
+
available: boolean;
|
|
334
|
+
displayName: string;
|
|
335
|
+
name: components["schemas"]["RegionName"];
|
|
336
|
+
};
|
|
337
|
+
/** @enum {string} */
|
|
338
|
+
DeploymentType: "dev" | "prod" | "preview" | "custom";
|
|
339
|
+
DeviceName: string;
|
|
340
|
+
/** @description Indicates whether the deployment is the default prod deployment for the
|
|
341
|
+
* project, or the default cloud dev deployment for the member in the project. */
|
|
342
|
+
IsDefaultDeployment: boolean;
|
|
343
|
+
ListDeploymentClassesResponse: {
|
|
344
|
+
items: components["schemas"]["DeploymentClassMetadata"][];
|
|
345
|
+
};
|
|
346
|
+
ListDeploymentRegionsResponse: {
|
|
347
|
+
items: components["schemas"]["DeploymentRegionMetadata"][];
|
|
348
|
+
};
|
|
349
|
+
/** Format: int64 */
|
|
350
|
+
MemberId: number;
|
|
351
|
+
PlatformCreateDeployKeyArgs: {
|
|
352
|
+
/** @description Name for the deploy key. */
|
|
353
|
+
name: string;
|
|
354
|
+
};
|
|
355
|
+
PlatformCreateDeployKeyResponse: {
|
|
356
|
+
/** @description The generated deploy key. */
|
|
357
|
+
deployKey: components["schemas"]["AdminKey"];
|
|
358
|
+
};
|
|
359
|
+
PlatformCreateDeploymentArgs: {
|
|
360
|
+
/** @description The class to use for this deployment. If not provided, the default
|
|
361
|
+
* deployment class for your team will be used. */
|
|
362
|
+
class?: string | null;
|
|
363
|
+
region?: null | components["schemas"]["RegionName"];
|
|
364
|
+
type: components["schemas"]["CreateDeploymentType"];
|
|
365
|
+
};
|
|
366
|
+
PlatformCreateProjectArgs: {
|
|
367
|
+
/** @description The class to use for this deployment. If not provided, the default
|
|
368
|
+
* deployment class for your team will be used. */
|
|
369
|
+
deploymentClass?: string | null;
|
|
370
|
+
deploymentRegion?: null | components["schemas"]["RegionName"];
|
|
371
|
+
/** @description Projects always include a deployment, so start this project off with a
|
|
372
|
+
* "dev" development deployment or a "prod" production deployment. */
|
|
373
|
+
deploymentType: components["schemas"]["CreateDeploymentType"];
|
|
374
|
+
/** @description The full name of the project as it will appear in the dashboard. Spaces
|
|
375
|
+
* and punctuations allowed. */
|
|
376
|
+
projectName: components["schemas"]["ProjectName"];
|
|
377
|
+
};
|
|
378
|
+
PlatformCreateProjectResponse: {
|
|
379
|
+
/** @description The readable identifier for this deployment, something like
|
|
380
|
+
* playful-otter-123. */
|
|
381
|
+
deploymentName: string;
|
|
382
|
+
/** @description Deployment cloud URL, where this deployment lives. */
|
|
383
|
+
deploymentUrl: string;
|
|
384
|
+
projectId: components["schemas"]["ProjectId"];
|
|
385
|
+
};
|
|
386
|
+
PlatformCustomDomainResponse: {
|
|
387
|
+
/**
|
|
388
|
+
* Format: int64
|
|
389
|
+
* @description Timestamp in milliseconds when this domain was created.
|
|
390
|
+
*/
|
|
391
|
+
creationTime: number;
|
|
392
|
+
/** @description The deployment name this domain is configured for. */
|
|
393
|
+
deploymentName: string;
|
|
394
|
+
/** @description The custom domain name. */
|
|
395
|
+
domain: string;
|
|
396
|
+
/** @description The destination for this custom domain (convexCloud or convexSite). */
|
|
397
|
+
requestDestination: components["schemas"]["RequestDestination"];
|
|
398
|
+
/**
|
|
399
|
+
* Format: int64
|
|
400
|
+
* @description Timestamp in milliseconds when this domain was verified, or null if not
|
|
401
|
+
* yet verified.
|
|
402
|
+
*/
|
|
403
|
+
verificationTime?: number | null;
|
|
404
|
+
};
|
|
405
|
+
PlatformDeleteCustomDomainArgs: {
|
|
406
|
+
/** @description The custom domain name to delete. */
|
|
407
|
+
domain: string;
|
|
408
|
+
/** @description The destination for this custom domain (convexCloud or convexSite). */
|
|
409
|
+
requestDestination: components["schemas"]["RequestDestination"];
|
|
410
|
+
};
|
|
411
|
+
PlatformDeleteDeployKeyArgs: {
|
|
412
|
+
/** @description The token to delete. This can be the secret value of the token or the
|
|
413
|
+
* token's unique name. */
|
|
414
|
+
id: string;
|
|
415
|
+
};
|
|
416
|
+
PlatformDeployKeyResponse: {
|
|
417
|
+
/**
|
|
418
|
+
* Format: int64
|
|
419
|
+
* @description Timestamp in milliseconds when this token was created.
|
|
420
|
+
*/
|
|
421
|
+
creationTime: number;
|
|
422
|
+
creator?: null | components["schemas"]["MemberId"];
|
|
423
|
+
/**
|
|
424
|
+
* Format: int64
|
|
425
|
+
* @description Timestamp in milliseconds when this token was last used (if ever).
|
|
426
|
+
*/
|
|
427
|
+
lastUsedTime?: number | null;
|
|
428
|
+
/** @description The name given to the deploy key at creation. */
|
|
429
|
+
name: string;
|
|
430
|
+
};
|
|
431
|
+
PlatformDeploymentResponse: {
|
|
432
|
+
/**
|
|
433
|
+
* Format: int64
|
|
434
|
+
* @description Timestamp in milliseconds when this deployment was created.
|
|
435
|
+
*/
|
|
436
|
+
createTime: number;
|
|
437
|
+
creator?: null | components["schemas"]["MemberId"];
|
|
438
|
+
/** @description The type of this deployment. */
|
|
439
|
+
deploymentType: components["schemas"]["DeploymentType"];
|
|
440
|
+
id: components["schemas"]["DeploymentId"];
|
|
441
|
+
/** @description For prod deployments, whether they are the default prod deployment
|
|
442
|
+
* of the project. For dev deployments, whether they are the default
|
|
443
|
+
* dev deployment for the member that created it.
|
|
444
|
+
* For other deployments, set to false. */
|
|
445
|
+
isDefault: components["schemas"]["IsDefaultDeployment"];
|
|
446
|
+
/** @enum {string} */
|
|
447
|
+
kind: "cloud";
|
|
448
|
+
/** @description The readable identifier for this deployment, something like
|
|
449
|
+
* playful-otter-123. */
|
|
450
|
+
name: string;
|
|
451
|
+
previewIdentifier?: null | components["schemas"]["PreviewDeploymentIdentifier"];
|
|
452
|
+
/** @description The project this deployment belongs to. */
|
|
453
|
+
projectId: components["schemas"]["ProjectId"];
|
|
454
|
+
/** @description The region where this deployment is hosted. */
|
|
455
|
+
region: components["schemas"]["RegionName"];
|
|
456
|
+
} | {
|
|
457
|
+
/**
|
|
458
|
+
* Format: int64
|
|
459
|
+
* @description Timestamp in milliseconds when this deployment was created.
|
|
460
|
+
*/
|
|
461
|
+
createTime: number;
|
|
462
|
+
/** @description The member who created this deployment. */
|
|
463
|
+
creator: components["schemas"]["MemberId"];
|
|
464
|
+
/** @description Whether this is a "dev" development deployment or "prod" production
|
|
465
|
+
* deployment. Note that this will always be "dev" for local
|
|
466
|
+
* deployments. */
|
|
467
|
+
deploymentType: components["schemas"]["DeploymentType"];
|
|
468
|
+
/** @description The device name where this local deployment is running. */
|
|
469
|
+
deviceName: components["schemas"]["DeviceName"];
|
|
470
|
+
/** @description Whether this local deployment is currently active. */
|
|
471
|
+
isActive: boolean;
|
|
472
|
+
/** @enum {string} */
|
|
473
|
+
kind: "local";
|
|
474
|
+
/** @description The readable identifier for this deployment. */
|
|
475
|
+
name: string;
|
|
476
|
+
/**
|
|
477
|
+
* Format: int32
|
|
478
|
+
* @description The port where this local deployment is running.
|
|
479
|
+
*/
|
|
480
|
+
port: number;
|
|
481
|
+
previewIdentifier?: null | components["schemas"]["PreviewDeploymentIdentifier"];
|
|
482
|
+
/** @description The project this deployment belongs to. */
|
|
483
|
+
projectId: components["schemas"]["ProjectId"];
|
|
484
|
+
};
|
|
485
|
+
PlatformListCustomDomainsResponse: {
|
|
486
|
+
/** @description List of custom domains configured for this deployment. */
|
|
487
|
+
domains: components["schemas"]["PlatformCustomDomainResponse"][];
|
|
488
|
+
};
|
|
489
|
+
PlatformProjectDetails: {
|
|
490
|
+
/**
|
|
491
|
+
* Format: int64
|
|
492
|
+
* @description Timestamp in milliseconds.
|
|
493
|
+
*/
|
|
494
|
+
createTime: number;
|
|
495
|
+
id: components["schemas"]["ProjectId"];
|
|
496
|
+
/** @description The full project name, including spaces and punctuation. */
|
|
497
|
+
name: components["schemas"]["ProjectName"];
|
|
498
|
+
/** @description This shortened version of the name used in Convex Dashboard URLs. */
|
|
499
|
+
slug: components["schemas"]["ProjectSlug"];
|
|
500
|
+
teamId: components["schemas"]["TeamId"];
|
|
501
|
+
};
|
|
502
|
+
PlatformTokenDetailsResponse: {
|
|
503
|
+
/**
|
|
504
|
+
* Format: int64
|
|
505
|
+
* @description Timestamp in milliseconds when this token was created.
|
|
506
|
+
*/
|
|
507
|
+
createTime: number;
|
|
508
|
+
/** @description The name given to the token at creation. */
|
|
509
|
+
name: components["schemas"]["DeviceName"];
|
|
510
|
+
/** @description The team ID this token is associated with. */
|
|
511
|
+
teamId: components["schemas"]["TeamId"];
|
|
512
|
+
/** @enum {string} */
|
|
513
|
+
type: "teamToken";
|
|
514
|
+
} | {
|
|
515
|
+
/**
|
|
516
|
+
* Format: int64
|
|
517
|
+
* @description Timestamp in milliseconds when this token was created.
|
|
518
|
+
*/
|
|
519
|
+
createTime: number;
|
|
520
|
+
/** @description The name given to the token at creation. */
|
|
521
|
+
name: components["schemas"]["DeviceName"];
|
|
522
|
+
/** @description The project ID this token is associated with. */
|
|
523
|
+
projectId: components["schemas"]["ProjectId"];
|
|
524
|
+
/** @enum {string} */
|
|
525
|
+
type: "projectToken";
|
|
526
|
+
};
|
|
527
|
+
PreviewDeploymentIdentifier: string;
|
|
528
|
+
/** Format: int64 */
|
|
529
|
+
ProjectId: number;
|
|
530
|
+
ProjectName: string;
|
|
531
|
+
ProjectSlug: string;
|
|
532
|
+
RegionName: string;
|
|
533
|
+
/** @enum {string} */
|
|
534
|
+
RequestDestination: "convexCloud" | "convexSite";
|
|
535
|
+
/** Format: int64 */
|
|
536
|
+
TeamId: number;
|
|
537
|
+
};
|
|
538
|
+
responses: never;
|
|
539
|
+
parameters: never;
|
|
540
|
+
requestBodies: never;
|
|
541
|
+
headers: never;
|
|
542
|
+
pathItems: never;
|
|
543
|
+
}
|
|
544
|
+
export type AdminKey = components['schemas']['AdminKey'];
|
|
545
|
+
export type CreateDeploymentType = components['schemas']['CreateDeploymentType'];
|
|
546
|
+
export type DeploymentClass = components['schemas']['DeploymentClass'];
|
|
547
|
+
export type DeploymentClassMetadata = components['schemas']['DeploymentClassMetadata'];
|
|
548
|
+
export type DeploymentId = components['schemas']['DeploymentId'];
|
|
549
|
+
export type DeploymentRegionMetadata = components['schemas']['DeploymentRegionMetadata'];
|
|
550
|
+
export type DeploymentType = components['schemas']['DeploymentType'];
|
|
551
|
+
export type DeviceName = components['schemas']['DeviceName'];
|
|
552
|
+
export type IsDefaultDeployment = components['schemas']['IsDefaultDeployment'];
|
|
553
|
+
export type ListDeploymentClassesResponse = components['schemas']['ListDeploymentClassesResponse'];
|
|
554
|
+
export type ListDeploymentRegionsResponse = components['schemas']['ListDeploymentRegionsResponse'];
|
|
555
|
+
export type MemberId = components['schemas']['MemberId'];
|
|
556
|
+
export type PlatformCreateDeployKeyArgs = components['schemas']['PlatformCreateDeployKeyArgs'];
|
|
557
|
+
export type PlatformCreateDeployKeyResponse = components['schemas']['PlatformCreateDeployKeyResponse'];
|
|
558
|
+
export type PlatformCreateDeploymentArgs = components['schemas']['PlatformCreateDeploymentArgs'];
|
|
559
|
+
export type PlatformCreateProjectArgs = components['schemas']['PlatformCreateProjectArgs'];
|
|
560
|
+
export type PlatformCreateProjectResponse = components['schemas']['PlatformCreateProjectResponse'];
|
|
561
|
+
export type PlatformCustomDomainResponse = components['schemas']['PlatformCustomDomainResponse'];
|
|
562
|
+
export type PlatformDeleteCustomDomainArgs = components['schemas']['PlatformDeleteCustomDomainArgs'];
|
|
563
|
+
export type PlatformDeleteDeployKeyArgs = components['schemas']['PlatformDeleteDeployKeyArgs'];
|
|
564
|
+
export type PlatformDeployKeyResponse = components['schemas']['PlatformDeployKeyResponse'];
|
|
565
|
+
export type PlatformDeploymentResponse = components['schemas']['PlatformDeploymentResponse'];
|
|
566
|
+
export type PlatformListCustomDomainsResponse = components['schemas']['PlatformListCustomDomainsResponse'];
|
|
567
|
+
export type PlatformProjectDetails = components['schemas']['PlatformProjectDetails'];
|
|
568
|
+
export type PlatformTokenDetailsResponse = components['schemas']['PlatformTokenDetailsResponse'];
|
|
569
|
+
export type PreviewDeploymentIdentifier = components['schemas']['PreviewDeploymentIdentifier'];
|
|
570
|
+
export type ProjectId = components['schemas']['ProjectId'];
|
|
571
|
+
export type ProjectName = components['schemas']['ProjectName'];
|
|
572
|
+
export type ProjectSlug = components['schemas']['ProjectSlug'];
|
|
573
|
+
export type RegionName = components['schemas']['RegionName'];
|
|
574
|
+
export type RequestDestination = components['schemas']['RequestDestination'];
|
|
575
|
+
export type TeamId = components['schemas']['TeamId'];
|
|
576
|
+
export type $defs = Record<string, never>;
|
|
577
|
+
export interface operations {
|
|
578
|
+
"create project": {
|
|
579
|
+
parameters: {
|
|
580
|
+
query?: never;
|
|
581
|
+
header?: never;
|
|
582
|
+
path: {
|
|
583
|
+
/** @description Team ID */
|
|
584
|
+
team_id: components["schemas"]["TeamId"];
|
|
585
|
+
};
|
|
586
|
+
cookie?: never;
|
|
587
|
+
};
|
|
588
|
+
requestBody: {
|
|
589
|
+
content: {
|
|
590
|
+
"application/json": components["schemas"]["PlatformCreateProjectArgs"];
|
|
591
|
+
};
|
|
592
|
+
};
|
|
593
|
+
responses: {
|
|
594
|
+
200: {
|
|
595
|
+
headers: {
|
|
596
|
+
[name: string]: unknown;
|
|
597
|
+
};
|
|
598
|
+
content: {
|
|
599
|
+
"application/json": components["schemas"]["PlatformCreateProjectResponse"];
|
|
600
|
+
};
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
};
|
|
604
|
+
"list projects": {
|
|
605
|
+
parameters: {
|
|
606
|
+
query?: never;
|
|
607
|
+
header?: never;
|
|
608
|
+
path: {
|
|
609
|
+
/** @description Team ID */
|
|
610
|
+
team_id: components["schemas"]["TeamId"];
|
|
611
|
+
};
|
|
612
|
+
cookie?: never;
|
|
613
|
+
};
|
|
614
|
+
requestBody?: never;
|
|
615
|
+
responses: {
|
|
616
|
+
200: {
|
|
617
|
+
headers: {
|
|
618
|
+
[name: string]: unknown;
|
|
619
|
+
};
|
|
620
|
+
content: {
|
|
621
|
+
"application/json": components["schemas"]["PlatformProjectDetails"][];
|
|
622
|
+
};
|
|
623
|
+
};
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
"list deployments": {
|
|
627
|
+
parameters: {
|
|
628
|
+
query?: {
|
|
629
|
+
/** @description If true, include local deployments in the response (filtered to only
|
|
630
|
+
* show local deployments created by the requesting team member). */
|
|
631
|
+
includeLocal?: boolean;
|
|
632
|
+
};
|
|
633
|
+
header?: never;
|
|
634
|
+
path: {
|
|
635
|
+
/** @description Project ID */
|
|
636
|
+
project_id: components["schemas"]["ProjectId"];
|
|
637
|
+
};
|
|
638
|
+
cookie?: never;
|
|
639
|
+
};
|
|
640
|
+
requestBody?: never;
|
|
641
|
+
responses: {
|
|
642
|
+
200: {
|
|
643
|
+
headers: {
|
|
644
|
+
[name: string]: unknown;
|
|
645
|
+
};
|
|
646
|
+
content: {
|
|
647
|
+
"application/json": components["schemas"]["PlatformDeploymentResponse"][];
|
|
648
|
+
};
|
|
649
|
+
};
|
|
650
|
+
};
|
|
651
|
+
};
|
|
652
|
+
"delete project": {
|
|
653
|
+
parameters: {
|
|
654
|
+
query?: never;
|
|
655
|
+
header?: never;
|
|
656
|
+
path: {
|
|
657
|
+
/** @description Project ID */
|
|
658
|
+
project_id: components["schemas"]["ProjectId"];
|
|
659
|
+
};
|
|
660
|
+
cookie?: never;
|
|
661
|
+
};
|
|
662
|
+
requestBody?: never;
|
|
663
|
+
responses: {
|
|
664
|
+
200: {
|
|
665
|
+
headers: {
|
|
666
|
+
[name: string]: unknown;
|
|
667
|
+
};
|
|
668
|
+
content?: never;
|
|
669
|
+
};
|
|
670
|
+
};
|
|
671
|
+
};
|
|
672
|
+
"create deployment": {
|
|
673
|
+
parameters: {
|
|
674
|
+
query?: never;
|
|
675
|
+
header?: never;
|
|
676
|
+
path: {
|
|
677
|
+
/** @description Project ID */
|
|
678
|
+
project_id: components["schemas"]["ProjectId"];
|
|
679
|
+
};
|
|
680
|
+
cookie?: never;
|
|
681
|
+
};
|
|
682
|
+
requestBody: {
|
|
683
|
+
content: {
|
|
684
|
+
"application/json": components["schemas"]["PlatformCreateDeploymentArgs"];
|
|
685
|
+
};
|
|
686
|
+
};
|
|
687
|
+
responses: {
|
|
688
|
+
200: {
|
|
689
|
+
headers: {
|
|
690
|
+
[name: string]: unknown;
|
|
691
|
+
};
|
|
692
|
+
content: {
|
|
693
|
+
"application/json": components["schemas"]["PlatformDeploymentResponse"];
|
|
694
|
+
};
|
|
695
|
+
};
|
|
696
|
+
};
|
|
697
|
+
};
|
|
698
|
+
"delete deployment": {
|
|
699
|
+
parameters: {
|
|
700
|
+
query?: never;
|
|
701
|
+
header?: never;
|
|
702
|
+
path: {
|
|
703
|
+
/** @description Deployment Name */
|
|
704
|
+
deployment_name: string;
|
|
705
|
+
};
|
|
706
|
+
cookie?: never;
|
|
707
|
+
};
|
|
708
|
+
requestBody?: never;
|
|
709
|
+
responses: {
|
|
710
|
+
200: {
|
|
711
|
+
headers: {
|
|
712
|
+
[name: string]: unknown;
|
|
713
|
+
};
|
|
714
|
+
content?: never;
|
|
715
|
+
};
|
|
716
|
+
};
|
|
717
|
+
};
|
|
718
|
+
"list deployment classes": {
|
|
719
|
+
parameters: {
|
|
720
|
+
query?: never;
|
|
721
|
+
header?: never;
|
|
722
|
+
path: {
|
|
723
|
+
/** @description Team ID */
|
|
724
|
+
team_id: string;
|
|
725
|
+
};
|
|
726
|
+
cookie?: never;
|
|
727
|
+
};
|
|
728
|
+
requestBody?: never;
|
|
729
|
+
responses: {
|
|
730
|
+
200: {
|
|
731
|
+
headers: {
|
|
732
|
+
[name: string]: unknown;
|
|
733
|
+
};
|
|
734
|
+
content: {
|
|
735
|
+
"application/json": components["schemas"]["ListDeploymentClassesResponse"];
|
|
736
|
+
};
|
|
737
|
+
};
|
|
738
|
+
};
|
|
739
|
+
};
|
|
740
|
+
"list deployment regions": {
|
|
741
|
+
parameters: {
|
|
742
|
+
query?: never;
|
|
743
|
+
header?: never;
|
|
744
|
+
path: {
|
|
745
|
+
/** @description Team ID */
|
|
746
|
+
team_id: string;
|
|
747
|
+
};
|
|
748
|
+
cookie?: never;
|
|
749
|
+
};
|
|
750
|
+
requestBody?: never;
|
|
751
|
+
responses: {
|
|
752
|
+
200: {
|
|
753
|
+
headers: {
|
|
754
|
+
[name: string]: unknown;
|
|
755
|
+
};
|
|
756
|
+
content: {
|
|
757
|
+
"application/json": components["schemas"]["ListDeploymentRegionsResponse"];
|
|
758
|
+
};
|
|
759
|
+
};
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
"create deploy key": {
|
|
763
|
+
parameters: {
|
|
764
|
+
query?: never;
|
|
765
|
+
header?: never;
|
|
766
|
+
path: {
|
|
767
|
+
/** @description Deployment name */
|
|
768
|
+
deployment_name: string;
|
|
769
|
+
};
|
|
770
|
+
cookie?: never;
|
|
771
|
+
};
|
|
772
|
+
requestBody: {
|
|
773
|
+
content: {
|
|
774
|
+
"application/json": components["schemas"]["PlatformCreateDeployKeyArgs"];
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
responses: {
|
|
778
|
+
200: {
|
|
779
|
+
headers: {
|
|
780
|
+
[name: string]: unknown;
|
|
781
|
+
};
|
|
782
|
+
content: {
|
|
783
|
+
"application/json": components["schemas"]["PlatformCreateDeployKeyResponse"];
|
|
784
|
+
};
|
|
785
|
+
};
|
|
786
|
+
};
|
|
787
|
+
};
|
|
788
|
+
"list deploy keys": {
|
|
789
|
+
parameters: {
|
|
790
|
+
query?: never;
|
|
791
|
+
header?: never;
|
|
792
|
+
path: {
|
|
793
|
+
/** @description Deployment name */
|
|
794
|
+
deployment_name: string;
|
|
795
|
+
};
|
|
796
|
+
cookie?: never;
|
|
797
|
+
};
|
|
798
|
+
requestBody?: never;
|
|
799
|
+
responses: {
|
|
800
|
+
200: {
|
|
801
|
+
headers: {
|
|
802
|
+
[name: string]: unknown;
|
|
803
|
+
};
|
|
804
|
+
content: {
|
|
805
|
+
"application/json": components["schemas"]["PlatformDeployKeyResponse"][];
|
|
806
|
+
};
|
|
807
|
+
};
|
|
808
|
+
};
|
|
809
|
+
};
|
|
810
|
+
"delete deploy key": {
|
|
811
|
+
parameters: {
|
|
812
|
+
query?: never;
|
|
813
|
+
header?: never;
|
|
814
|
+
path: {
|
|
815
|
+
/** @description Deployment name */
|
|
816
|
+
deployment_name: string;
|
|
817
|
+
};
|
|
818
|
+
cookie?: never;
|
|
819
|
+
};
|
|
820
|
+
requestBody: {
|
|
821
|
+
content: {
|
|
822
|
+
"application/json": components["schemas"]["PlatformDeleteDeployKeyArgs"];
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
responses: {
|
|
826
|
+
200: {
|
|
827
|
+
headers: {
|
|
828
|
+
[name: string]: unknown;
|
|
829
|
+
};
|
|
830
|
+
content?: never;
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
"get token details": {
|
|
835
|
+
parameters: {
|
|
836
|
+
query?: never;
|
|
837
|
+
header?: never;
|
|
838
|
+
path?: never;
|
|
839
|
+
cookie?: never;
|
|
840
|
+
};
|
|
841
|
+
requestBody?: never;
|
|
842
|
+
responses: {
|
|
843
|
+
200: {
|
|
844
|
+
headers: {
|
|
845
|
+
[name: string]: unknown;
|
|
846
|
+
};
|
|
847
|
+
content: {
|
|
848
|
+
"application/json": components["schemas"]["PlatformTokenDetailsResponse"];
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
"create custom domain": {
|
|
854
|
+
parameters: {
|
|
855
|
+
query?: never;
|
|
856
|
+
header?: never;
|
|
857
|
+
path: {
|
|
858
|
+
/** @description Deployment name */
|
|
859
|
+
deployment_name: string;
|
|
860
|
+
};
|
|
861
|
+
cookie?: never;
|
|
862
|
+
};
|
|
863
|
+
requestBody: {
|
|
864
|
+
content: {
|
|
865
|
+
"application/json": components["schemas"]["PlatformDeleteCustomDomainArgs"];
|
|
866
|
+
};
|
|
867
|
+
};
|
|
868
|
+
responses: {
|
|
869
|
+
200: {
|
|
870
|
+
headers: {
|
|
871
|
+
[name: string]: unknown;
|
|
872
|
+
};
|
|
873
|
+
content?: never;
|
|
874
|
+
};
|
|
875
|
+
};
|
|
876
|
+
};
|
|
877
|
+
"delete custom domain": {
|
|
878
|
+
parameters: {
|
|
879
|
+
query?: never;
|
|
880
|
+
header?: never;
|
|
881
|
+
path: {
|
|
882
|
+
/** @description Deployment name */
|
|
883
|
+
deployment_name: string;
|
|
884
|
+
};
|
|
885
|
+
cookie?: never;
|
|
886
|
+
};
|
|
887
|
+
requestBody: {
|
|
888
|
+
content: {
|
|
889
|
+
"application/json": components["schemas"]["PlatformDeleteCustomDomainArgs"];
|
|
890
|
+
};
|
|
891
|
+
};
|
|
892
|
+
responses: {
|
|
893
|
+
200: {
|
|
894
|
+
headers: {
|
|
895
|
+
[name: string]: unknown;
|
|
896
|
+
};
|
|
897
|
+
content?: never;
|
|
898
|
+
};
|
|
899
|
+
};
|
|
900
|
+
};
|
|
901
|
+
"list custom domains": {
|
|
902
|
+
parameters: {
|
|
903
|
+
query?: never;
|
|
904
|
+
header?: never;
|
|
905
|
+
path: {
|
|
906
|
+
/** @description Deployment name */
|
|
907
|
+
deployment_name: string;
|
|
908
|
+
};
|
|
909
|
+
cookie?: never;
|
|
910
|
+
};
|
|
911
|
+
requestBody?: never;
|
|
912
|
+
responses: {
|
|
913
|
+
200: {
|
|
914
|
+
headers: {
|
|
915
|
+
[name: string]: unknown;
|
|
916
|
+
};
|
|
917
|
+
content: {
|
|
918
|
+
"application/json": components["schemas"]["PlatformListCustomDomainsResponse"];
|
|
919
|
+
};
|
|
920
|
+
};
|
|
921
|
+
};
|
|
922
|
+
};
|
|
923
|
+
}
|
|
924
|
+
//# sourceMappingURL=generatedManagementApi.d.ts.map
|