@scalix-world/sdk 1.4.1 → 1.6.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/cjs/generated/client.gen.d.ts.map +1 -1
- package/dist/cjs/generated/client.gen.js +1 -1
- package/dist/cjs/generated/client.gen.js.map +1 -1
- package/dist/cjs/generated/index.d.ts +2 -2
- package/dist/cjs/generated/index.d.ts.map +1 -1
- package/dist/cjs/generated/index.js +4 -174
- package/dist/cjs/generated/index.js.map +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +21 -1083
- package/dist/cjs/generated/sdk.gen.d.ts.map +1 -1
- package/dist/cjs/generated/sdk.gen.js +480 -2516
- package/dist/cjs/generated/sdk.gen.js.map +1 -1
- package/dist/cjs/generated/types.gen.d.ts +2068 -6292
- package/dist/cjs/generated/types.gen.d.ts.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/generated/client.gen.d.ts.map +1 -1
- package/dist/esm/generated/client.gen.js +1 -1
- package/dist/esm/generated/client.gen.js.map +1 -1
- package/dist/esm/generated/index.d.ts +2 -2
- package/dist/esm/generated/index.d.ts.map +1 -1
- package/dist/esm/generated/index.js +1 -1
- package/dist/esm/generated/index.js.map +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +21 -1083
- package/dist/esm/generated/sdk.gen.d.ts.map +1 -1
- package/dist/esm/generated/sdk.gen.js +451 -2317
- package/dist/esm/generated/sdk.gen.js.map +1 -1
- package/dist/esm/generated/types.gen.d.ts +2068 -6292
- package/dist/esm/generated/types.gen.d.ts.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/package.json +3 -3
|
@@ -1,375 +1,6 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
import { client } from './client.gen.js';
|
|
3
3
|
import { formDataBodySerializer } from './client/index.js';
|
|
4
|
-
/**
|
|
5
|
-
* Detect database anomalies.
|
|
6
|
-
*
|
|
7
|
-
* Analyzes recent activity and returns a report of detected database anomalies.
|
|
8
|
-
*/
|
|
9
|
-
export const detectAnomalies = (options) => (options?.client ?? client).post({
|
|
10
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
11
|
-
url: '/api/v1/anomalies',
|
|
12
|
-
...options
|
|
13
|
-
});
|
|
14
|
-
/**
|
|
15
|
-
* Decrypt data.
|
|
16
|
-
*
|
|
17
|
-
* Decrypts the supplied ciphertext and returns the plaintext.
|
|
18
|
-
*/
|
|
19
|
-
export const decryptData = (options) => (options?.client ?? client).post({
|
|
20
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
21
|
-
url: '/api/v1/encryption/decrypt',
|
|
22
|
-
...options
|
|
23
|
-
});
|
|
24
|
-
/**
|
|
25
|
-
* Encrypt data.
|
|
26
|
-
*
|
|
27
|
-
* Encrypts the supplied plaintext and returns the ciphertext.
|
|
28
|
-
*/
|
|
29
|
-
export const encryptData = (options) => (options?.client ?? client).post({
|
|
30
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
31
|
-
url: '/api/v1/encryption/encrypt',
|
|
32
|
-
...options
|
|
33
|
-
});
|
|
34
|
-
/**
|
|
35
|
-
* Rotate the encryption key.
|
|
36
|
-
*
|
|
37
|
-
* Rotates the tenant's encryption key.
|
|
38
|
-
*/
|
|
39
|
-
export const rotateEncryptionKey = (options) => (options?.client ?? client).post({
|
|
40
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
41
|
-
url: '/api/v1/encryption/rotate-key',
|
|
42
|
-
...options
|
|
43
|
-
});
|
|
44
|
-
/**
|
|
45
|
-
* List MCP tools.
|
|
46
|
-
*
|
|
47
|
-
* Returns the MCP tool definitions available to the caller.
|
|
48
|
-
*/
|
|
49
|
-
export const listMcpTools = (options) => (options?.client ?? client).get({
|
|
50
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
51
|
-
url: '/api/v1/mcp',
|
|
52
|
-
...options
|
|
53
|
-
});
|
|
54
|
-
/**
|
|
55
|
-
* Call an MCP tool.
|
|
56
|
-
*
|
|
57
|
-
* Invokes an MCP tool and returns its result.
|
|
58
|
-
*/
|
|
59
|
-
export const callMcpTool = (options) => (options?.client ?? client).post({
|
|
60
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
61
|
-
url: '/api/v1/mcp/call',
|
|
62
|
-
...options
|
|
63
|
-
});
|
|
64
|
-
/**
|
|
65
|
-
* Translate natural language to SQL.
|
|
66
|
-
*
|
|
67
|
-
* Generates a SQL statement from a natural-language description of the desired query.
|
|
68
|
-
*/
|
|
69
|
-
export const naturalLanguageToSql = (options) => (options?.client ?? client).post({
|
|
70
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
71
|
-
url: '/api/v1/nl-to-sql',
|
|
72
|
-
...options
|
|
73
|
-
});
|
|
74
|
-
/**
|
|
75
|
-
* Get query optimization suggestions.
|
|
76
|
-
*
|
|
77
|
-
* Analyzes the tenant's database and returns indexing and query optimization suggestions.
|
|
78
|
-
*/
|
|
79
|
-
export const optimizeQuery = (options) => (options?.client ?? client).post({
|
|
80
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
81
|
-
url: '/api/v1/optimize',
|
|
82
|
-
...options
|
|
83
|
-
});
|
|
84
|
-
/**
|
|
85
|
-
* List recent query logs.
|
|
86
|
-
*
|
|
87
|
-
* Returns recent query-log entries for a tenant, newest first.
|
|
88
|
-
*/
|
|
89
|
-
export const listQueryLogs = (options) => (options.client ?? client).get({
|
|
90
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
91
|
-
url: '/api/v1/query-logs/{tenant_id}',
|
|
92
|
-
...options
|
|
93
|
-
});
|
|
94
|
-
/**
|
|
95
|
-
* Get scaling suggestions.
|
|
96
|
-
*
|
|
97
|
-
* Returns capacity and scaling recommendations for the tenant's database.
|
|
98
|
-
*/
|
|
99
|
-
export const getScalingSuggestions = (options) => (options?.client ?? client).get({
|
|
100
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
101
|
-
url: '/api/v1/scaling',
|
|
102
|
-
...options
|
|
103
|
-
});
|
|
104
|
-
/**
|
|
105
|
-
* Get the database schema.
|
|
106
|
-
*
|
|
107
|
-
* Returns the tables, views, and types in the tenant's database.
|
|
108
|
-
*/
|
|
109
|
-
export const getSchema = (options) => (options?.client ?? client).get({
|
|
110
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
111
|
-
url: '/api/v1/schema',
|
|
112
|
-
...options
|
|
113
|
-
});
|
|
114
|
-
/**
|
|
115
|
-
* Search schema columns.
|
|
116
|
-
*
|
|
117
|
-
* Returns columns across the schema matching an optional name search term.
|
|
118
|
-
*/
|
|
119
|
-
export const searchSchemaColumns = (options) => (options?.client ?? client).get({
|
|
120
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
121
|
-
url: '/api/v1/schema/columns',
|
|
122
|
-
...options
|
|
123
|
-
});
|
|
124
|
-
/**
|
|
125
|
-
* Analyze PII columns.
|
|
126
|
-
*
|
|
127
|
-
* Returns columns flagged as likely personally identifiable information.
|
|
128
|
-
*/
|
|
129
|
-
export const listPiiColumns = (options) => (options?.client ?? client).get({
|
|
130
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
131
|
-
url: '/api/v1/schema/pii',
|
|
132
|
-
...options
|
|
133
|
-
});
|
|
134
|
-
/**
|
|
135
|
-
* List schema relationships.
|
|
136
|
-
*
|
|
137
|
-
* Returns the foreign-key relationships between tables in the schema.
|
|
138
|
-
*/
|
|
139
|
-
export const getSchemaRelationships = (options) => (options?.client ?? client).get({
|
|
140
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
141
|
-
url: '/api/v1/schema/relationships',
|
|
142
|
-
...options
|
|
143
|
-
});
|
|
144
|
-
/**
|
|
145
|
-
* Get a table's schema.
|
|
146
|
-
*
|
|
147
|
-
* Returns the columns and types for a single table.
|
|
148
|
-
*/
|
|
149
|
-
export const getTableSchema = (options) => (options.client ?? client).get({
|
|
150
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
151
|
-
url: '/api/v1/schema/table/{name}',
|
|
152
|
-
...options
|
|
153
|
-
});
|
|
154
|
-
/**
|
|
155
|
-
* Get service status.
|
|
156
|
-
*
|
|
157
|
-
* Returns the operational status of Scalix Cloud services.
|
|
158
|
-
*/
|
|
159
|
-
export const getServicesStatus = (options) => (options?.client ?? client).get({
|
|
160
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
161
|
-
url: '/api/v1/services',
|
|
162
|
-
...options
|
|
163
|
-
});
|
|
164
|
-
/**
|
|
165
|
-
* Execute a SQL query.
|
|
166
|
-
*
|
|
167
|
-
* Runs a parameterized SQL statement against the tenant's database and returns the result set.
|
|
168
|
-
*/
|
|
169
|
-
export const executeSql = (options) => (options.client ?? client).post({
|
|
170
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
171
|
-
url: '/api/v1/sql',
|
|
172
|
-
...options,
|
|
173
|
-
headers: {
|
|
174
|
-
'Content-Type': 'application/json',
|
|
175
|
-
...options.headers
|
|
176
|
-
}
|
|
177
|
-
});
|
|
178
|
-
/**
|
|
179
|
-
* Execute a batch of SQL queries.
|
|
180
|
-
*
|
|
181
|
-
* Runs multiple SQL statements in one request; each query executes independently and returns its own result set.
|
|
182
|
-
*/
|
|
183
|
-
export const batchSql = (options) => (options.client ?? client).post({
|
|
184
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
185
|
-
url: '/api/v1/sql/batch',
|
|
186
|
-
...options,
|
|
187
|
-
headers: {
|
|
188
|
-
'Content-Type': 'application/json',
|
|
189
|
-
...options.headers
|
|
190
|
-
}
|
|
191
|
-
});
|
|
192
|
-
/**
|
|
193
|
-
* Register a migration.
|
|
194
|
-
*
|
|
195
|
-
* Registers a database migration for a tenant.
|
|
196
|
-
*/
|
|
197
|
-
export const registerMigration = (options) => (options.client ?? client).post({
|
|
198
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
199
|
-
url: '/api/v1/tenants/{tenant_id}/migrations',
|
|
200
|
-
...options
|
|
201
|
-
});
|
|
202
|
-
/**
|
|
203
|
-
* Get the migration plan.
|
|
204
|
-
*
|
|
205
|
-
* Returns the pending migrations for a tenant.
|
|
206
|
-
*/
|
|
207
|
-
export const getMigrationPlan = (options) => (options.client ?? client).get({
|
|
208
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
209
|
-
url: '/api/v1/tenants/{tenant_id}/migrations/plan',
|
|
210
|
-
...options
|
|
211
|
-
});
|
|
212
|
-
/**
|
|
213
|
-
* Restore to a point in time.
|
|
214
|
-
*
|
|
215
|
-
* Initiates a point-in-time restore of a tenant's database.
|
|
216
|
-
*/
|
|
217
|
-
export const restorePitr = (options) => (options.client ?? client).post({
|
|
218
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
219
|
-
url: '/api/v1/tenants/{tenant_id}/pitr/restore',
|
|
220
|
-
...options
|
|
221
|
-
});
|
|
222
|
-
/**
|
|
223
|
-
* Create a realtime subscription.
|
|
224
|
-
*
|
|
225
|
-
* Creates a realtime subscription for a tenant.
|
|
226
|
-
*/
|
|
227
|
-
export const subscribeRealtime = (options) => (options.client ?? client).post({
|
|
228
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
229
|
-
url: '/api/v1/tenants/{tenant_id}/realtime/subscribe',
|
|
230
|
-
...options
|
|
231
|
-
});
|
|
232
|
-
/**
|
|
233
|
-
* Open a realtime WebSocket.
|
|
234
|
-
*
|
|
235
|
-
* Upgrades the connection to a realtime WebSocket stream for a tenant.
|
|
236
|
-
*/
|
|
237
|
-
export const realtimeWebsocket = (options) => (options.client ?? client).get({
|
|
238
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
239
|
-
url: '/api/v1/tenants/{tenant_id}/realtime/ws',
|
|
240
|
-
...options
|
|
241
|
-
});
|
|
242
|
-
/**
|
|
243
|
-
* Branch a timeline.
|
|
244
|
-
*
|
|
245
|
-
* Restores the parent timeline's durable base backup + archived WAL into a
|
|
246
|
-
* NEW compute worker replayed to `branch_lsn` (`0` = latest), then routes the
|
|
247
|
-
* branch endpoint. The branch archives onto its own timeline from that point.
|
|
248
|
-
*/
|
|
249
|
-
export const branchTimeline = (options) => (options.client ?? client).post({
|
|
250
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
251
|
-
url: '/api/v1/tenants/{tenant_id}/timelines/{timeline_id}/branch',
|
|
252
|
-
...options,
|
|
253
|
-
headers: {
|
|
254
|
-
'Content-Type': 'application/json',
|
|
255
|
-
...options.headers
|
|
256
|
-
}
|
|
257
|
-
});
|
|
258
|
-
/**
|
|
259
|
-
* Batch upsert vectors.
|
|
260
|
-
*
|
|
261
|
-
* Inserts or updates many vectors in a collection in a single request
|
|
262
|
-
* (one multi-row write). Returns the number of vectors upserted.
|
|
263
|
-
*/
|
|
264
|
-
export const batchUpsertVectors = (options) => (options.client ?? client).post({
|
|
265
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
266
|
-
url: '/api/v1/tenants/{tenant_id}/vectors/batch/upsert',
|
|
267
|
-
...options,
|
|
268
|
-
headers: {
|
|
269
|
-
'Content-Type': 'application/json',
|
|
270
|
-
...options.headers
|
|
271
|
-
}
|
|
272
|
-
});
|
|
273
|
-
/**
|
|
274
|
-
* List vector collections.
|
|
275
|
-
*
|
|
276
|
-
* Returns the vector collections for a tenant.
|
|
277
|
-
*/
|
|
278
|
-
export const listVectorCollections = (options) => (options.client ?? client).get({
|
|
279
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
280
|
-
url: '/api/v1/tenants/{tenant_id}/vectors/collections',
|
|
281
|
-
...options
|
|
282
|
-
});
|
|
283
|
-
/**
|
|
284
|
-
* Create a vector collection.
|
|
285
|
-
*
|
|
286
|
-
* Creates a new vector collection for a tenant.
|
|
287
|
-
*/
|
|
288
|
-
export const createVectorCollection = (options) => (options.client ?? client).post({
|
|
289
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
290
|
-
url: '/api/v1/tenants/{tenant_id}/vectors/collections',
|
|
291
|
-
...options
|
|
292
|
-
});
|
|
293
|
-
/**
|
|
294
|
-
* Search vectors.
|
|
295
|
-
*
|
|
296
|
-
* Runs a nearest-neighbour vector search and returns scored matches.
|
|
297
|
-
*/
|
|
298
|
-
export const searchVectors = (options) => (options.client ?? client).post({
|
|
299
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
300
|
-
url: '/api/v1/tenants/{tenant_id}/vectors/search',
|
|
301
|
-
...options,
|
|
302
|
-
headers: {
|
|
303
|
-
'Content-Type': 'application/json',
|
|
304
|
-
...options.headers
|
|
305
|
-
}
|
|
306
|
-
});
|
|
307
|
-
/**
|
|
308
|
-
* Upsert vectors.
|
|
309
|
-
*
|
|
310
|
-
* Inserts or updates a batch of vectors in a collection.
|
|
311
|
-
*/
|
|
312
|
-
export const upsertVectors = (options) => (options.client ?? client).post({
|
|
313
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
314
|
-
url: '/api/v1/tenants/{tenant_id}/vectors/upsert',
|
|
315
|
-
...options,
|
|
316
|
-
headers: {
|
|
317
|
-
'Content-Type': 'application/json',
|
|
318
|
-
...options.headers
|
|
319
|
-
}
|
|
320
|
-
});
|
|
321
|
-
/**
|
|
322
|
-
* List webhooks.
|
|
323
|
-
*
|
|
324
|
-
* Returns the registered webhook endpoints for a tenant.
|
|
325
|
-
*/
|
|
326
|
-
export const listWebhooks = (options) => (options.client ?? client).get({
|
|
327
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
328
|
-
url: '/api/v1/tenants/{tenant_id}/webhooks',
|
|
329
|
-
...options
|
|
330
|
-
});
|
|
331
|
-
/**
|
|
332
|
-
* Register a webhook.
|
|
333
|
-
*
|
|
334
|
-
* Registers a webhook endpoint for a set of event types.
|
|
335
|
-
*/
|
|
336
|
-
export const registerWebhook = (options) => (options.client ?? client).post({
|
|
337
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
338
|
-
url: '/api/v1/tenants/{tenant_id}/webhooks',
|
|
339
|
-
...options,
|
|
340
|
-
headers: {
|
|
341
|
-
'Content-Type': 'application/json',
|
|
342
|
-
...options.headers
|
|
343
|
-
}
|
|
344
|
-
});
|
|
345
|
-
/**
|
|
346
|
-
* Get usage summary.
|
|
347
|
-
*
|
|
348
|
-
* Returns the caller's aggregate usage summary.
|
|
349
|
-
*/
|
|
350
|
-
export const getUsageSummary = (options) => (options?.client ?? client).get({
|
|
351
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
352
|
-
url: '/api/v1/usage',
|
|
353
|
-
...options
|
|
354
|
-
});
|
|
355
|
-
/**
|
|
356
|
-
* Liveness probe.
|
|
357
|
-
*
|
|
358
|
-
* Returns 200 while the gateway process is alive.
|
|
359
|
-
*/
|
|
360
|
-
export const healthz = (options) => (options?.client ?? client).get({ url: '/healthz', ...options });
|
|
361
|
-
/**
|
|
362
|
-
* Get the OpenAPI spec.
|
|
363
|
-
*
|
|
364
|
-
* Returns this OpenAPI specification document.
|
|
365
|
-
*/
|
|
366
|
-
export const getOpenapiSpec = (options) => (options?.client ?? client).get({ url: '/openapi.json', ...options });
|
|
367
|
-
/**
|
|
368
|
-
* Readiness probe.
|
|
369
|
-
*
|
|
370
|
-
* Returns 200 when the gateway is ready to serve traffic.
|
|
371
|
-
*/
|
|
372
|
-
export const readyz = (options) => (options?.client ?? client).get({ url: '/readyz', ...options });
|
|
373
4
|
/**
|
|
374
5
|
* Generate speech.
|
|
375
6
|
*
|
|
@@ -773,35 +404,23 @@ export const textVectorSearch = (options) => (options.client ?? client).post({
|
|
|
773
404
|
}
|
|
774
405
|
});
|
|
775
406
|
/**
|
|
776
|
-
*
|
|
777
|
-
*
|
|
778
|
-
* Creates an anonymous end-user account and returns auth tokens; the account
|
|
779
|
-
* can later be linked to a real identity via identity linking.
|
|
780
|
-
*/
|
|
781
|
-
export const signUpAnonymous = (options) => (options?.client ?? client).post({
|
|
782
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
783
|
-
url: '/v1/auth/anonymous',
|
|
784
|
-
...options
|
|
785
|
-
});
|
|
786
|
-
/**
|
|
787
|
-
* Link an identity.
|
|
407
|
+
* List deployments.
|
|
788
408
|
*
|
|
789
|
-
*
|
|
790
|
-
* the authenticated user, including upgrading anonymous accounts.
|
|
409
|
+
* Returns all compute deployments for the caller's project.
|
|
791
410
|
*/
|
|
792
|
-
export const
|
|
411
|
+
export const listDeployments = (options) => (options?.client ?? client).get({
|
|
793
412
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
794
|
-
url: '/v1/
|
|
413
|
+
url: '/v1/compute/deployments',
|
|
795
414
|
...options
|
|
796
415
|
});
|
|
797
416
|
/**
|
|
798
|
-
*
|
|
417
|
+
* Create a deployment.
|
|
799
418
|
*
|
|
800
|
-
*
|
|
419
|
+
* Deploys a container/VM compute workload and returns the created deployment.
|
|
801
420
|
*/
|
|
802
|
-
export const
|
|
421
|
+
export const createDeployment = (options) => (options.client ?? client).post({
|
|
803
422
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
804
|
-
url: '/v1/
|
|
423
|
+
url: '/v1/compute/deployments',
|
|
805
424
|
...options,
|
|
806
425
|
headers: {
|
|
807
426
|
'Content-Type': 'application/json',
|
|
@@ -809,204 +428,244 @@ export const login = (options) => (options.client ?? client).post({
|
|
|
809
428
|
}
|
|
810
429
|
});
|
|
811
430
|
/**
|
|
812
|
-
*
|
|
431
|
+
* Delete a deployment.
|
|
813
432
|
*
|
|
814
|
-
*
|
|
433
|
+
* Removes a compute deployment by id.
|
|
815
434
|
*/
|
|
816
|
-
export const
|
|
435
|
+
export const deleteDeployment = (options) => (options.client ?? client).delete({
|
|
817
436
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
818
|
-
url: '/v1/
|
|
437
|
+
url: '/v1/compute/deployments/{id}',
|
|
819
438
|
...options
|
|
820
439
|
});
|
|
821
440
|
/**
|
|
822
|
-
*
|
|
441
|
+
* Get a deployment.
|
|
823
442
|
*
|
|
824
|
-
*
|
|
443
|
+
* Returns a single compute deployment by id.
|
|
825
444
|
*/
|
|
826
|
-
export const
|
|
445
|
+
export const getDeployment = (options) => (options.client ?? client).get({
|
|
827
446
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
828
|
-
url: '/v1/
|
|
447
|
+
url: '/v1/compute/deployments/{id}',
|
|
829
448
|
...options
|
|
830
449
|
});
|
|
831
450
|
/**
|
|
832
|
-
*
|
|
451
|
+
* List deployment instances.
|
|
833
452
|
*
|
|
834
|
-
*
|
|
453
|
+
* Returns the running instances of a compute deployment.
|
|
835
454
|
*/
|
|
836
|
-
export const
|
|
455
|
+
export const listDeploymentInstances = (options) => (options.client ?? client).get({
|
|
837
456
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
838
|
-
url: '/v1/
|
|
457
|
+
url: '/v1/compute/deployments/{id}/instances',
|
|
839
458
|
...options
|
|
840
459
|
});
|
|
841
460
|
/**
|
|
842
|
-
*
|
|
461
|
+
* Get deployment logs.
|
|
843
462
|
*
|
|
844
|
-
* Returns
|
|
463
|
+
* Returns log output for a compute deployment.
|
|
845
464
|
*/
|
|
846
|
-
export const
|
|
465
|
+
export const getDeploymentLogs = (options) => (options.client ?? client).get({
|
|
847
466
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
848
|
-
url: '/v1/
|
|
467
|
+
url: '/v1/compute/deployments/{id}/logs',
|
|
849
468
|
...options
|
|
850
469
|
});
|
|
851
470
|
/**
|
|
852
|
-
*
|
|
471
|
+
* Restart a deployment.
|
|
853
472
|
*
|
|
854
|
-
*
|
|
855
|
-
* auth tokens.
|
|
473
|
+
* Restarts all instances of a compute deployment.
|
|
856
474
|
*/
|
|
857
|
-
export const
|
|
475
|
+
export const restartDeployment = (options) => (options.client ?? client).post({
|
|
858
476
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
859
|
-
url: '/v1/
|
|
477
|
+
url: '/v1/compute/deployments/{id}/restart',
|
|
860
478
|
...options
|
|
861
479
|
});
|
|
862
480
|
/**
|
|
863
|
-
*
|
|
481
|
+
* Roll back a deployment.
|
|
864
482
|
*
|
|
865
|
-
*
|
|
483
|
+
* Rolls a compute deployment back to a previous version.
|
|
866
484
|
*/
|
|
867
|
-
export const
|
|
485
|
+
export const rollbackDeployment = (options) => (options.client ?? client).post({
|
|
868
486
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
869
|
-
url: '/v1/
|
|
870
|
-
...options
|
|
487
|
+
url: '/v1/compute/deployments/{id}/rollback',
|
|
488
|
+
...options,
|
|
489
|
+
headers: {
|
|
490
|
+
'Content-Type': 'application/json',
|
|
491
|
+
...options.headers
|
|
492
|
+
}
|
|
871
493
|
});
|
|
872
494
|
/**
|
|
873
|
-
*
|
|
495
|
+
* Scale a deployment.
|
|
874
496
|
*
|
|
875
|
-
*
|
|
497
|
+
* Adjusts the instance count (min/max) for a compute deployment.
|
|
876
498
|
*/
|
|
877
|
-
export const
|
|
499
|
+
export const scaleDeployment = (options) => (options.client ?? client).post({
|
|
878
500
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
879
|
-
url: '/v1/
|
|
880
|
-
...options
|
|
501
|
+
url: '/v1/compute/deployments/{id}/scale',
|
|
502
|
+
...options,
|
|
503
|
+
headers: {
|
|
504
|
+
'Content-Type': 'application/json',
|
|
505
|
+
...options.headers
|
|
506
|
+
}
|
|
881
507
|
});
|
|
882
508
|
/**
|
|
883
|
-
*
|
|
509
|
+
* List deployment versions.
|
|
884
510
|
*
|
|
885
|
-
*
|
|
511
|
+
* Returns the version history of a compute deployment.
|
|
886
512
|
*/
|
|
887
|
-
export const
|
|
513
|
+
export const listDeploymentVersions = (options) => (options.client ?? client).get({
|
|
888
514
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
889
|
-
url: '/v1/
|
|
515
|
+
url: '/v1/compute/deployments/{id}/versions',
|
|
890
516
|
...options
|
|
891
517
|
});
|
|
892
518
|
/**
|
|
893
|
-
*
|
|
894
|
-
*
|
|
895
|
-
* Verifies a TOTP code to complete multi-factor enrollment or a challenge.
|
|
519
|
+
* List your Computers.
|
|
896
520
|
*/
|
|
897
|
-
export const
|
|
521
|
+
export const computerList = (options) => (options?.client ?? client).get({
|
|
898
522
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
899
|
-
url: '/v1/
|
|
523
|
+
url: '/v1/computers',
|
|
900
524
|
...options
|
|
901
525
|
});
|
|
902
526
|
/**
|
|
903
|
-
*
|
|
527
|
+
* Create a Computer.
|
|
904
528
|
*
|
|
905
|
-
*
|
|
529
|
+
* Boots a persistent Linux machine and returns once it is provisioning. The
|
|
530
|
+
* root disk survives stop/start and is only reclaimed by DELETE. Billed per
|
|
531
|
+
* start, per vCPU-hour and GiB-hour (RAM is binary gigabytes, 1024 MiB) while
|
|
532
|
+
* running, and per GB-month of disk (decimal, bytes / 1e9)
|
|
533
|
+
* for as long as the Computer exists.
|
|
906
534
|
*/
|
|
907
|
-
export const
|
|
535
|
+
export const computerCreate = (options) => (options.client ?? client).post({
|
|
908
536
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
909
|
-
url: '/v1/
|
|
910
|
-
...options
|
|
537
|
+
url: '/v1/computers',
|
|
538
|
+
...options,
|
|
539
|
+
headers: {
|
|
540
|
+
'Content-Type': 'application/json',
|
|
541
|
+
...options.headers
|
|
542
|
+
}
|
|
911
543
|
});
|
|
912
544
|
/**
|
|
913
|
-
*
|
|
545
|
+
* Get or create a Computer by name.
|
|
914
546
|
*
|
|
915
|
-
*
|
|
547
|
+
* Idempotent: the first call creates the machine (201), every identical
|
|
548
|
+
* repeat returns the existing one (200). Resource changes on a repeat are
|
|
549
|
+
* ignored — the existing machine wins. Use this instead of create when an
|
|
550
|
+
* agent may retry.
|
|
916
551
|
*/
|
|
917
|
-
export const
|
|
552
|
+
export const computerGetOrCreateByName = (options) => (options.client ?? client).put({
|
|
918
553
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
919
|
-
url: '/v1/
|
|
920
|
-
...options
|
|
554
|
+
url: '/v1/computers/by-name/{name}',
|
|
555
|
+
...options,
|
|
556
|
+
headers: {
|
|
557
|
+
'Content-Type': 'application/json',
|
|
558
|
+
...options.headers
|
|
559
|
+
}
|
|
921
560
|
});
|
|
922
561
|
/**
|
|
923
|
-
*
|
|
562
|
+
* Delete a Computer.
|
|
924
563
|
*
|
|
925
|
-
*
|
|
564
|
+
* The only operation that reclaims the root disk. Irreversible — stop the
|
|
565
|
+
* Computer instead if you want the files back later.
|
|
926
566
|
*/
|
|
927
|
-
export const
|
|
567
|
+
export const computerDelete = (options) => (options.client ?? client).delete({
|
|
928
568
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
929
|
-
url: '/v1/
|
|
569
|
+
url: '/v1/computers/{id}',
|
|
930
570
|
...options
|
|
931
571
|
});
|
|
932
572
|
/**
|
|
933
|
-
*
|
|
934
|
-
*
|
|
935
|
-
* Exchanges the phone number and OTP code for Scalix auth tokens.
|
|
573
|
+
* Get one Computer.
|
|
936
574
|
*/
|
|
937
|
-
export const
|
|
575
|
+
export const computerGet = (options) => (options.client ?? client).get({
|
|
938
576
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
939
|
-
url: '/v1/
|
|
577
|
+
url: '/v1/computers/{id}',
|
|
940
578
|
...options
|
|
941
579
|
});
|
|
942
580
|
/**
|
|
943
|
-
*
|
|
944
|
-
*
|
|
945
|
-
* Emails the user a password-recovery link.
|
|
581
|
+
* Run a command inside a Computer.
|
|
946
582
|
*/
|
|
947
|
-
export const
|
|
583
|
+
export const computerExec = (options) => (options.client ?? client).post({
|
|
948
584
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
949
|
-
url: '/v1/
|
|
950
|
-
...options
|
|
585
|
+
url: '/v1/computers/{id}/exec',
|
|
586
|
+
...options,
|
|
587
|
+
headers: {
|
|
588
|
+
'Content-Type': 'application/json',
|
|
589
|
+
...options.headers
|
|
590
|
+
}
|
|
951
591
|
});
|
|
952
592
|
/**
|
|
953
|
-
*
|
|
954
|
-
*
|
|
955
|
-
* Sets a new password using a recovery token.
|
|
593
|
+
* Read one file out of a Computer.
|
|
956
594
|
*/
|
|
957
|
-
export const
|
|
595
|
+
export const computerReadFile = (options) => (options.client ?? client).get({
|
|
958
596
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
959
|
-
url: '/v1/
|
|
597
|
+
url: '/v1/computers/{id}/files',
|
|
960
598
|
...options
|
|
961
599
|
});
|
|
962
600
|
/**
|
|
963
|
-
*
|
|
601
|
+
* Write files into a Computer.
|
|
602
|
+
*/
|
|
603
|
+
export const computerWriteFiles = (options) => (options.client ?? client).put({
|
|
604
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
605
|
+
url: '/v1/computers/{id}/files',
|
|
606
|
+
...options,
|
|
607
|
+
headers: {
|
|
608
|
+
'Content-Type': 'application/json',
|
|
609
|
+
...options.headers
|
|
610
|
+
}
|
|
611
|
+
});
|
|
612
|
+
/**
|
|
613
|
+
* Replace a Computer's authorised ssh keys.
|
|
964
614
|
*
|
|
965
|
-
*
|
|
615
|
+
* Sends the whole list every time, so removing a key is the same operation as
|
|
616
|
+
* adding one. On a RUNNING machine the change applies immediately — a
|
|
617
|
+
* revoked key stops working now, not at the next restart. On a stopped
|
|
618
|
+
* machine it is stored and delivered when it next boots.
|
|
966
619
|
*/
|
|
967
|
-
export const
|
|
620
|
+
export const computerSetSshKeys = (options) => (options.client ?? client).put({
|
|
968
621
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
969
|
-
url: '/v1/
|
|
970
|
-
...options
|
|
622
|
+
url: '/v1/computers/{id}/ssh-keys',
|
|
623
|
+
...options,
|
|
624
|
+
headers: {
|
|
625
|
+
'Content-Type': 'application/json',
|
|
626
|
+
...options.headers
|
|
627
|
+
}
|
|
971
628
|
});
|
|
972
629
|
/**
|
|
973
|
-
*
|
|
630
|
+
* Start a stopped Computer.
|
|
974
631
|
*
|
|
975
|
-
*
|
|
632
|
+
* Boots the same disk on the same host and reclaims the same address.
|
|
976
633
|
*/
|
|
977
|
-
export const
|
|
634
|
+
export const computerStart = (options) => (options.client ?? client).post({
|
|
978
635
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
979
|
-
url: '/v1/
|
|
636
|
+
url: '/v1/computers/{id}/start',
|
|
980
637
|
...options
|
|
981
638
|
});
|
|
982
639
|
/**
|
|
983
|
-
*
|
|
640
|
+
* Stop a Computer.
|
|
984
641
|
*
|
|
985
|
-
*
|
|
642
|
+
* Halts the machine. The root disk and the network address are kept, so a
|
|
643
|
+
* later start comes back to the same files at the same address. Runtime
|
|
644
|
+
* billing stops; disk billing continues at the parked rate.
|
|
986
645
|
*/
|
|
987
|
-
export const
|
|
646
|
+
export const computerStop = (options) => (options.client ?? client).post({
|
|
988
647
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
989
|
-
url: '/v1/
|
|
648
|
+
url: '/v1/computers/{id}/stop',
|
|
990
649
|
...options
|
|
991
650
|
});
|
|
992
651
|
/**
|
|
993
|
-
*
|
|
652
|
+
* List cron schedules.
|
|
994
653
|
*
|
|
995
|
-
*
|
|
654
|
+
* Returns all scheduled jobs for the caller's project.
|
|
996
655
|
*/
|
|
997
|
-
export const
|
|
656
|
+
export const listCronSchedules = (options) => (options?.client ?? client).get({
|
|
998
657
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
999
|
-
url: '/v1/
|
|
658
|
+
url: '/v1/cron/schedules',
|
|
1000
659
|
...options
|
|
1001
660
|
});
|
|
1002
661
|
/**
|
|
1003
|
-
*
|
|
662
|
+
* Create a cron schedule.
|
|
1004
663
|
*
|
|
1005
|
-
* Creates a new
|
|
664
|
+
* Creates a new scheduled job.
|
|
1006
665
|
*/
|
|
1007
|
-
export const
|
|
666
|
+
export const createCronSchedule = (options) => (options.client ?? client).post({
|
|
1008
667
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1009
|
-
url: '/v1/
|
|
668
|
+
url: '/v1/cron/schedules',
|
|
1010
669
|
...options,
|
|
1011
670
|
headers: {
|
|
1012
671
|
'Content-Type': 'application/json',
|
|
@@ -1014,43 +673,33 @@ export const signUp = (options) => (options.client ?? client).post({
|
|
|
1014
673
|
}
|
|
1015
674
|
});
|
|
1016
675
|
/**
|
|
1017
|
-
*
|
|
1018
|
-
*
|
|
1019
|
-
* Returns the authenticated end user's profile.
|
|
1020
|
-
*/
|
|
1021
|
-
export const getAuthUser = (options) => (options?.client ?? client).get({
|
|
1022
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1023
|
-
url: '/v1/auth/user',
|
|
1024
|
-
...options
|
|
1025
|
-
});
|
|
1026
|
-
/**
|
|
1027
|
-
* Update the current user.
|
|
676
|
+
* Delete a cron schedule.
|
|
1028
677
|
*
|
|
1029
|
-
*
|
|
678
|
+
* Removes a scheduled job by id.
|
|
1030
679
|
*/
|
|
1031
|
-
export const
|
|
680
|
+
export const deleteCronSchedule = (options) => (options.client ?? client).delete({
|
|
1032
681
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1033
|
-
url: '/v1/
|
|
682
|
+
url: '/v1/cron/schedules/{id}',
|
|
1034
683
|
...options
|
|
1035
684
|
});
|
|
1036
685
|
/**
|
|
1037
|
-
*
|
|
686
|
+
* Get a cron schedule.
|
|
1038
687
|
*
|
|
1039
|
-
* Returns
|
|
688
|
+
* Returns a single scheduled job by id.
|
|
1040
689
|
*/
|
|
1041
|
-
export const
|
|
690
|
+
export const getCronSchedule = (options) => (options.client ?? client).get({
|
|
1042
691
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1043
|
-
url: '/v1/
|
|
692
|
+
url: '/v1/cron/schedules/{id}',
|
|
1044
693
|
...options
|
|
1045
694
|
});
|
|
1046
695
|
/**
|
|
1047
|
-
*
|
|
696
|
+
* Update a cron schedule.
|
|
1048
697
|
*
|
|
1049
|
-
*
|
|
698
|
+
* Updates an existing scheduled job.
|
|
1050
699
|
*/
|
|
1051
|
-
export const
|
|
700
|
+
export const updateCronSchedule = (options) => (options.client ?? client).put({
|
|
1052
701
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1053
|
-
url: '/v1/
|
|
702
|
+
url: '/v1/cron/schedules/{id}',
|
|
1054
703
|
...options,
|
|
1055
704
|
headers: {
|
|
1056
705
|
'Content-Type': 'application/json',
|
|
@@ -1058,46 +707,46 @@ export const recordAuthUserConsent = (options) => (options.client ?? client).pos
|
|
|
1058
707
|
}
|
|
1059
708
|
});
|
|
1060
709
|
/**
|
|
1061
|
-
*
|
|
710
|
+
* List schedule executions.
|
|
1062
711
|
*
|
|
1063
|
-
* Returns
|
|
712
|
+
* Returns the execution history of a scheduled job.
|
|
1064
713
|
*/
|
|
1065
|
-
export const
|
|
714
|
+
export const listCronExecutions = (options) => (options.client ?? client).get({
|
|
1066
715
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1067
|
-
url: '/v1/
|
|
716
|
+
url: '/v1/cron/schedules/{id}/executions',
|
|
1068
717
|
...options
|
|
1069
718
|
});
|
|
1070
719
|
/**
|
|
1071
|
-
*
|
|
720
|
+
* Trigger a cron schedule.
|
|
1072
721
|
*
|
|
1073
|
-
*
|
|
722
|
+
* Runs a scheduled job immediately, outside its normal schedule.
|
|
1074
723
|
*/
|
|
1075
|
-
export const
|
|
724
|
+
export const triggerCronSchedule = (options) => (options.client ?? client).post({
|
|
1076
725
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1077
|
-
url: '/v1/
|
|
726
|
+
url: '/v1/cron/schedules/{id}/trigger',
|
|
1078
727
|
...options
|
|
1079
728
|
});
|
|
1080
729
|
/**
|
|
1081
|
-
* List
|
|
730
|
+
* List databases.
|
|
1082
731
|
*
|
|
1083
|
-
*
|
|
732
|
+
* Lists the project's databases. `include_deleted=true` also returns
|
|
733
|
+
* soft-deleted databases still inside the recovery grace window.
|
|
1084
734
|
*/
|
|
1085
|
-
export const
|
|
735
|
+
export const listDatabases = (options) => (options?.client ?? client).get({
|
|
1086
736
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1087
|
-
url: '/v1/
|
|
737
|
+
url: '/v1/databases',
|
|
1088
738
|
...options
|
|
1089
739
|
});
|
|
1090
740
|
/**
|
|
1091
|
-
*
|
|
1092
|
-
*
|
|
1093
|
-
* Starts a container image build and returns the build record.
|
|
741
|
+
* Create a database.
|
|
1094
742
|
*
|
|
1095
|
-
*
|
|
1096
|
-
*
|
|
743
|
+
* Creates a ScalixNova database in the project on the requested PostgreSQL
|
|
744
|
+
* major version (16 default, 17, or 18). The version is fixed at creation;
|
|
745
|
+
* branches and point-in-time restores keep it.
|
|
1097
746
|
*/
|
|
1098
|
-
export const
|
|
747
|
+
export const createDatabase = (options) => (options.client ?? client).post({
|
|
1099
748
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1100
|
-
url: '/v1/
|
|
749
|
+
url: '/v1/databases',
|
|
1101
750
|
...options,
|
|
1102
751
|
headers: {
|
|
1103
752
|
'Content-Type': 'application/json',
|
|
@@ -1105,94 +754,97 @@ export const createBuild = (options) => (options.client ?? client).post({
|
|
|
1105
754
|
}
|
|
1106
755
|
});
|
|
1107
756
|
/**
|
|
1108
|
-
*
|
|
757
|
+
* Get or create the project's default database.
|
|
1109
758
|
*
|
|
1110
|
-
*
|
|
1111
|
-
*
|
|
1112
|
-
* tarball (`Content-Type: application/gzip`); metadata goes in the query
|
|
1113
|
-
* string. Multipart is not accepted.
|
|
759
|
+
* Idempotent: returns the project's default database connection info,
|
|
760
|
+
* creating the database (on the default PostgreSQL version) if none exists.
|
|
1114
761
|
*/
|
|
1115
|
-
export const
|
|
762
|
+
export const provisionDatabase = (options) => (options?.client ?? client).post({
|
|
1116
763
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1117
|
-
url: '/v1/
|
|
1118
|
-
...options
|
|
1119
|
-
headers: {
|
|
1120
|
-
'Content-Type': 'application/gzip',
|
|
1121
|
-
...options.headers
|
|
1122
|
-
}
|
|
764
|
+
url: '/v1/databases/provision',
|
|
765
|
+
...options
|
|
1123
766
|
});
|
|
1124
767
|
/**
|
|
1125
|
-
*
|
|
768
|
+
* Delete a database.
|
|
1126
769
|
*
|
|
1127
|
-
*
|
|
770
|
+
* Soft-deletes the database: it is hidden from listings and restorable via
|
|
771
|
+
* `POST /v1/databases/{id}/restore` until the grace window ends, after which
|
|
772
|
+
* it is purged permanently.
|
|
1128
773
|
*/
|
|
1129
|
-
export const
|
|
774
|
+
export const deleteDatabase = (options) => (options.client ?? client).delete({
|
|
1130
775
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1131
|
-
url: '/v1/
|
|
776
|
+
url: '/v1/databases/{id}',
|
|
1132
777
|
...options
|
|
1133
778
|
});
|
|
1134
779
|
/**
|
|
1135
|
-
*
|
|
780
|
+
* Get a database.
|
|
1136
781
|
*
|
|
1137
|
-
*
|
|
782
|
+
* Fetches one database by id, including its PostgreSQL version and isolation tier.
|
|
1138
783
|
*/
|
|
1139
|
-
export const
|
|
784
|
+
export const getDatabase = (options) => (options.client ?? client).get({
|
|
1140
785
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1141
|
-
url: '/v1/
|
|
786
|
+
url: '/v1/databases/{id}',
|
|
1142
787
|
...options
|
|
1143
788
|
});
|
|
1144
789
|
/**
|
|
1145
|
-
*
|
|
790
|
+
* Restore a soft-deleted database.
|
|
1146
791
|
*
|
|
1147
|
-
*
|
|
792
|
+
* Undoes a delete within the recovery grace window; the database returns to
|
|
793
|
+
* `active` with its data, version, and tier intact.
|
|
1148
794
|
*/
|
|
1149
|
-
export const
|
|
795
|
+
export const restoreDatabase = (options) => (options.client ?? client).post({
|
|
1150
796
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1151
|
-
url: '/v1/
|
|
797
|
+
url: '/v1/databases/{id}/restore',
|
|
1152
798
|
...options
|
|
1153
799
|
});
|
|
1154
800
|
/**
|
|
1155
|
-
*
|
|
801
|
+
* Send a raw email.
|
|
1156
802
|
*
|
|
1157
|
-
*
|
|
1158
|
-
*
|
|
803
|
+
* Sends an HTML email without a stored template. Requires the `email:send`
|
|
804
|
+
* scope.
|
|
1159
805
|
*/
|
|
1160
|
-
export const
|
|
806
|
+
export const sendRawEmail = (options) => (options.client ?? client).post({
|
|
1161
807
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1162
|
-
url: '/v1/
|
|
1163
|
-
...options
|
|
808
|
+
url: '/v1/email/send/raw',
|
|
809
|
+
...options,
|
|
810
|
+
headers: {
|
|
811
|
+
'Content-Type': 'application/json',
|
|
812
|
+
...options.headers
|
|
813
|
+
}
|
|
1164
814
|
});
|
|
1165
815
|
/**
|
|
1166
|
-
*
|
|
816
|
+
* Send a templated email.
|
|
1167
817
|
*
|
|
1168
|
-
*
|
|
1169
|
-
*
|
|
818
|
+
* Renders `template` with `data` and sends it to `to`. Requires the
|
|
819
|
+
* `email:send` scope.
|
|
1170
820
|
*/
|
|
1171
|
-
export const
|
|
821
|
+
export const sendTransactionalEmail = (options) => (options.client ?? client).post({
|
|
1172
822
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1173
|
-
url: '/v1/
|
|
1174
|
-
...options
|
|
823
|
+
url: '/v1/email/send/tx',
|
|
824
|
+
...options,
|
|
825
|
+
headers: {
|
|
826
|
+
'Content-Type': 'application/json',
|
|
827
|
+
...options.headers
|
|
828
|
+
}
|
|
1175
829
|
});
|
|
1176
830
|
/**
|
|
1177
|
-
* List
|
|
831
|
+
* List email templates.
|
|
1178
832
|
*
|
|
1179
|
-
* Returns the
|
|
833
|
+
* Returns the org's stored templates. Requires the `email:read` scope.
|
|
1180
834
|
*/
|
|
1181
|
-
export const
|
|
835
|
+
export const listEmailTemplates = (options) => (options?.client ?? client).get({
|
|
1182
836
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1183
|
-
url: '/v1/
|
|
837
|
+
url: '/v1/email/templates',
|
|
1184
838
|
...options
|
|
1185
839
|
});
|
|
1186
840
|
/**
|
|
1187
|
-
* Create
|
|
841
|
+
* Create an email template.
|
|
1188
842
|
*
|
|
1189
|
-
*
|
|
1190
|
-
* intake only: the request is persisted with status `pending`; export and
|
|
1191
|
-
* erasure are fulfilled out of band.
|
|
843
|
+
* Stores a new template for the org. Requires the `email:write` scope.
|
|
1192
844
|
*/
|
|
1193
|
-
export const
|
|
845
|
+
export const createEmailTemplate = (options) => (options.client ?? client).post({
|
|
1194
846
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1195
|
-
url: '/v1/
|
|
847
|
+
url: '/v1/email/templates',
|
|
1196
848
|
...options,
|
|
1197
849
|
headers: {
|
|
1198
850
|
'Content-Type': 'application/json',
|
|
@@ -1200,28 +852,23 @@ export const createGdprRequest = (options) => (options.client ?? client).post({
|
|
|
1200
852
|
}
|
|
1201
853
|
});
|
|
1202
854
|
/**
|
|
1203
|
-
*
|
|
855
|
+
* Delete an email template.
|
|
1204
856
|
*
|
|
1205
|
-
*
|
|
857
|
+
* Removes a stored template. Requires the `email:write` scope.
|
|
1206
858
|
*/
|
|
1207
|
-
export const
|
|
859
|
+
export const deleteEmailTemplate = (options) => (options.client ?? client).delete({
|
|
1208
860
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1209
|
-
url: '/v1/
|
|
861
|
+
url: '/v1/email/templates/{id}',
|
|
1210
862
|
...options
|
|
1211
863
|
});
|
|
1212
864
|
/**
|
|
1213
|
-
*
|
|
865
|
+
* Update an email template.
|
|
1214
866
|
*
|
|
1215
|
-
*
|
|
1216
|
-
* way to fulfill them, while the compliance status implied a working workflow.
|
|
1217
|
-
* A data-protection officer (compliance:write) now moves each request through
|
|
1218
|
-
* pending → in_progress → completed/rejected; terminal states stamp
|
|
1219
|
-
* `completed_at`, giving an auditable fulfillment record within the GDPR Art.
|
|
1220
|
-
* 12(3) one-month window. Tenant-scoped.
|
|
867
|
+
* Replaces a stored template. Requires the `email:write` scope.
|
|
1221
868
|
*/
|
|
1222
|
-
export const
|
|
869
|
+
export const updateEmailTemplate = (options) => (options.client ?? client).put({
|
|
1223
870
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1224
|
-
url: '/v1/
|
|
871
|
+
url: '/v1/email/templates/{id}',
|
|
1225
872
|
...options,
|
|
1226
873
|
headers: {
|
|
1227
874
|
'Content-Type': 'application/json',
|
|
@@ -1229,1532 +876,53 @@ export const updateGdprRequestStatus = (options) => (options.client ?? client).p
|
|
|
1229
876
|
}
|
|
1230
877
|
});
|
|
1231
878
|
/**
|
|
1232
|
-
*
|
|
879
|
+
* Delete a subscription.
|
|
1233
880
|
*
|
|
1234
|
-
*
|
|
1235
|
-
* each check's result plus an overall score.
|
|
881
|
+
* Removes an event subscription by id.
|
|
1236
882
|
*/
|
|
1237
|
-
export const
|
|
883
|
+
export const deleteEventSubscription = (options) => (options.client ?? client).delete({
|
|
1238
884
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1239
|
-
url: '/v1/
|
|
885
|
+
url: '/v1/events/subscriptions/{id}',
|
|
1240
886
|
...options
|
|
1241
887
|
});
|
|
1242
888
|
/**
|
|
1243
|
-
*
|
|
889
|
+
* Get a subscription.
|
|
1244
890
|
*
|
|
1245
|
-
* Returns
|
|
891
|
+
* Returns a single event subscription by id.
|
|
1246
892
|
*/
|
|
1247
|
-
export const
|
|
893
|
+
export const getEventSubscription = (options) => (options.client ?? client).get({
|
|
1248
894
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1249
|
-
url: '/v1/
|
|
895
|
+
url: '/v1/events/subscriptions/{id}',
|
|
1250
896
|
...options
|
|
1251
897
|
});
|
|
1252
898
|
/**
|
|
1253
|
-
*
|
|
899
|
+
* List subscription deliveries.
|
|
1254
900
|
*
|
|
1255
|
-
*
|
|
901
|
+
* Returns the delivery attempts for an event subscription.
|
|
1256
902
|
*/
|
|
1257
|
-
export const
|
|
903
|
+
export const listSubscriptionDeliveries = (options) => (options.client ?? client).get({
|
|
1258
904
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1259
|
-
url: '/v1/
|
|
1260
|
-
...options
|
|
1261
|
-
headers: {
|
|
1262
|
-
'Content-Type': 'application/json',
|
|
1263
|
-
...options.headers
|
|
1264
|
-
}
|
|
905
|
+
url: '/v1/events/subscriptions/{id}/deliveries',
|
|
906
|
+
...options
|
|
1265
907
|
});
|
|
1266
908
|
/**
|
|
1267
|
-
*
|
|
909
|
+
* List topics.
|
|
1268
910
|
*
|
|
1269
|
-
*
|
|
1270
|
-
*/
|
|
1271
|
-
export const deleteDeployment = (options) => (options.client ?? client).delete({
|
|
1272
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1273
|
-
url: '/v1/compute/deployments/{id}',
|
|
1274
|
-
...options
|
|
1275
|
-
});
|
|
1276
|
-
/**
|
|
1277
|
-
* Get a deployment.
|
|
1278
|
-
*
|
|
1279
|
-
* Returns a single compute deployment by id.
|
|
1280
|
-
*/
|
|
1281
|
-
export const getDeployment = (options) => (options.client ?? client).get({
|
|
1282
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1283
|
-
url: '/v1/compute/deployments/{id}',
|
|
1284
|
-
...options
|
|
1285
|
-
});
|
|
1286
|
-
/**
|
|
1287
|
-
* List deployment instances.
|
|
1288
|
-
*
|
|
1289
|
-
* Returns the running instances of a compute deployment.
|
|
1290
|
-
*/
|
|
1291
|
-
export const listDeploymentInstances = (options) => (options.client ?? client).get({
|
|
1292
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1293
|
-
url: '/v1/compute/deployments/{id}/instances',
|
|
1294
|
-
...options
|
|
1295
|
-
});
|
|
1296
|
-
/**
|
|
1297
|
-
* Get deployment logs.
|
|
1298
|
-
*
|
|
1299
|
-
* Returns log output for a compute deployment.
|
|
1300
|
-
*/
|
|
1301
|
-
export const getDeploymentLogs = (options) => (options.client ?? client).get({
|
|
1302
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1303
|
-
url: '/v1/compute/deployments/{id}/logs',
|
|
1304
|
-
...options
|
|
1305
|
-
});
|
|
1306
|
-
/**
|
|
1307
|
-
* Restart a deployment.
|
|
1308
|
-
*
|
|
1309
|
-
* Restarts all instances of a compute deployment.
|
|
1310
|
-
*/
|
|
1311
|
-
export const restartDeployment = (options) => (options.client ?? client).post({
|
|
1312
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1313
|
-
url: '/v1/compute/deployments/{id}/restart',
|
|
1314
|
-
...options
|
|
1315
|
-
});
|
|
1316
|
-
/**
|
|
1317
|
-
* Roll back a deployment.
|
|
1318
|
-
*
|
|
1319
|
-
* Rolls a compute deployment back to a previous version.
|
|
1320
|
-
*/
|
|
1321
|
-
export const rollbackDeployment = (options) => (options.client ?? client).post({
|
|
1322
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1323
|
-
url: '/v1/compute/deployments/{id}/rollback',
|
|
1324
|
-
...options,
|
|
1325
|
-
headers: {
|
|
1326
|
-
'Content-Type': 'application/json',
|
|
1327
|
-
...options.headers
|
|
1328
|
-
}
|
|
1329
|
-
});
|
|
1330
|
-
/**
|
|
1331
|
-
* Scale a deployment.
|
|
1332
|
-
*
|
|
1333
|
-
* Adjusts the instance count (min/max) for a compute deployment.
|
|
1334
|
-
*/
|
|
1335
|
-
export const scaleDeployment = (options) => (options.client ?? client).post({
|
|
1336
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1337
|
-
url: '/v1/compute/deployments/{id}/scale',
|
|
1338
|
-
...options,
|
|
1339
|
-
headers: {
|
|
1340
|
-
'Content-Type': 'application/json',
|
|
1341
|
-
...options.headers
|
|
1342
|
-
}
|
|
1343
|
-
});
|
|
1344
|
-
/**
|
|
1345
|
-
* List deployment versions.
|
|
1346
|
-
*
|
|
1347
|
-
* Returns the version history of a compute deployment.
|
|
1348
|
-
*/
|
|
1349
|
-
export const listDeploymentVersions = (options) => (options.client ?? client).get({
|
|
1350
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1351
|
-
url: '/v1/compute/deployments/{id}/versions',
|
|
1352
|
-
...options
|
|
1353
|
-
});
|
|
1354
|
-
/**
|
|
1355
|
-
* List your Computers.
|
|
1356
|
-
*/
|
|
1357
|
-
export const computerList = (options) => (options?.client ?? client).get({
|
|
1358
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1359
|
-
url: '/v1/computers',
|
|
1360
|
-
...options
|
|
1361
|
-
});
|
|
1362
|
-
/**
|
|
1363
|
-
* Create a Computer.
|
|
1364
|
-
*
|
|
1365
|
-
* Boots a persistent Linux machine and returns once it is provisioning. The
|
|
1366
|
-
* root disk survives stop/start and is only reclaimed by DELETE. Billed per
|
|
1367
|
-
* start, per vCPU-hour and GB-hour while running, and per GB-month of disk
|
|
1368
|
-
* for as long as the Computer exists.
|
|
1369
|
-
*/
|
|
1370
|
-
export const computerCreate = (options) => (options.client ?? client).post({
|
|
1371
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1372
|
-
url: '/v1/computers',
|
|
1373
|
-
...options,
|
|
1374
|
-
headers: {
|
|
1375
|
-
'Content-Type': 'application/json',
|
|
1376
|
-
...options.headers
|
|
1377
|
-
}
|
|
1378
|
-
});
|
|
1379
|
-
/**
|
|
1380
|
-
* Get or create a Computer by name.
|
|
1381
|
-
*
|
|
1382
|
-
* Idempotent: the first call creates the machine (201), every identical
|
|
1383
|
-
* repeat returns the existing one (200). Resource changes on a repeat are
|
|
1384
|
-
* ignored — the existing machine wins. Use this instead of create when an
|
|
1385
|
-
* agent may retry.
|
|
1386
|
-
*/
|
|
1387
|
-
export const computerGetOrCreateByName = (options) => (options.client ?? client).put({
|
|
1388
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1389
|
-
url: '/v1/computers/by-name/{name}',
|
|
1390
|
-
...options,
|
|
1391
|
-
headers: {
|
|
1392
|
-
'Content-Type': 'application/json',
|
|
1393
|
-
...options.headers
|
|
1394
|
-
}
|
|
1395
|
-
});
|
|
1396
|
-
/**
|
|
1397
|
-
* Delete a Computer.
|
|
1398
|
-
*
|
|
1399
|
-
* The only operation that reclaims the root disk. Irreversible — stop the
|
|
1400
|
-
* Computer instead if you want the files back later.
|
|
1401
|
-
*/
|
|
1402
|
-
export const computerDelete = (options) => (options.client ?? client).delete({
|
|
1403
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1404
|
-
url: '/v1/computers/{id}',
|
|
1405
|
-
...options
|
|
1406
|
-
});
|
|
1407
|
-
/**
|
|
1408
|
-
* Get one Computer.
|
|
1409
|
-
*/
|
|
1410
|
-
export const computerGet = (options) => (options.client ?? client).get({
|
|
1411
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1412
|
-
url: '/v1/computers/{id}',
|
|
1413
|
-
...options
|
|
1414
|
-
});
|
|
1415
|
-
/**
|
|
1416
|
-
* Run a command inside a Computer.
|
|
1417
|
-
*/
|
|
1418
|
-
export const computerExec = (options) => (options.client ?? client).post({
|
|
1419
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1420
|
-
url: '/v1/computers/{id}/exec',
|
|
1421
|
-
...options,
|
|
1422
|
-
headers: {
|
|
1423
|
-
'Content-Type': 'application/json',
|
|
1424
|
-
...options.headers
|
|
1425
|
-
}
|
|
1426
|
-
});
|
|
1427
|
-
/**
|
|
1428
|
-
* Read one file out of a Computer.
|
|
1429
|
-
*/
|
|
1430
|
-
export const computerReadFile = (options) => (options.client ?? client).get({
|
|
1431
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1432
|
-
url: '/v1/computers/{id}/files',
|
|
1433
|
-
...options
|
|
1434
|
-
});
|
|
1435
|
-
/**
|
|
1436
|
-
* Write files into a Computer.
|
|
1437
|
-
*/
|
|
1438
|
-
export const computerWriteFiles = (options) => (options.client ?? client).put({
|
|
1439
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1440
|
-
url: '/v1/computers/{id}/files',
|
|
1441
|
-
...options,
|
|
1442
|
-
headers: {
|
|
1443
|
-
'Content-Type': 'application/json',
|
|
1444
|
-
...options.headers
|
|
1445
|
-
}
|
|
1446
|
-
});
|
|
1447
|
-
/**
|
|
1448
|
-
* Replace a Computer's authorised ssh keys.
|
|
1449
|
-
*
|
|
1450
|
-
* Sends the whole list every time, so removing a key is the same operation as
|
|
1451
|
-
* adding one. On a RUNNING machine the change applies immediately — a
|
|
1452
|
-
* revoked key stops working now, not at the next restart. On a stopped
|
|
1453
|
-
* machine it is stored and delivered when it next boots.
|
|
1454
|
-
*/
|
|
1455
|
-
export const computerSetSshKeys = (options) => (options.client ?? client).put({
|
|
1456
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1457
|
-
url: '/v1/computers/{id}/ssh-keys',
|
|
1458
|
-
...options,
|
|
1459
|
-
headers: {
|
|
1460
|
-
'Content-Type': 'application/json',
|
|
1461
|
-
...options.headers
|
|
1462
|
-
}
|
|
1463
|
-
});
|
|
1464
|
-
/**
|
|
1465
|
-
* Start a stopped Computer.
|
|
1466
|
-
*
|
|
1467
|
-
* Boots the same disk on the same host and reclaims the same address.
|
|
1468
|
-
*/
|
|
1469
|
-
export const computerStart = (options) => (options.client ?? client).post({
|
|
1470
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1471
|
-
url: '/v1/computers/{id}/start',
|
|
1472
|
-
...options
|
|
1473
|
-
});
|
|
1474
|
-
/**
|
|
1475
|
-
* Stop a Computer.
|
|
1476
|
-
*
|
|
1477
|
-
* Halts the machine. The root disk and the network address are kept, so a
|
|
1478
|
-
* later start comes back to the same files at the same address. Runtime
|
|
1479
|
-
* billing stops; disk billing continues at the parked rate.
|
|
1480
|
-
*/
|
|
1481
|
-
export const computerStop = (options) => (options.client ?? client).post({
|
|
1482
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1483
|
-
url: '/v1/computers/{id}/stop',
|
|
1484
|
-
...options
|
|
1485
|
-
});
|
|
1486
|
-
/**
|
|
1487
|
-
* List cron schedules.
|
|
1488
|
-
*
|
|
1489
|
-
* Returns all scheduled jobs for the caller's project.
|
|
1490
|
-
*/
|
|
1491
|
-
export const listCronSchedules = (options) => (options?.client ?? client).get({
|
|
1492
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1493
|
-
url: '/v1/cron/schedules',
|
|
1494
|
-
...options
|
|
1495
|
-
});
|
|
1496
|
-
/**
|
|
1497
|
-
* Create a cron schedule.
|
|
1498
|
-
*
|
|
1499
|
-
* Creates a new scheduled job.
|
|
1500
|
-
*/
|
|
1501
|
-
export const createCronSchedule = (options) => (options.client ?? client).post({
|
|
1502
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1503
|
-
url: '/v1/cron/schedules',
|
|
1504
|
-
...options,
|
|
1505
|
-
headers: {
|
|
1506
|
-
'Content-Type': 'application/json',
|
|
1507
|
-
...options.headers
|
|
1508
|
-
}
|
|
1509
|
-
});
|
|
1510
|
-
/**
|
|
1511
|
-
* Delete a cron schedule.
|
|
1512
|
-
*
|
|
1513
|
-
* Removes a scheduled job by id.
|
|
1514
|
-
*/
|
|
1515
|
-
export const deleteCronSchedule = (options) => (options.client ?? client).delete({
|
|
1516
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1517
|
-
url: '/v1/cron/schedules/{id}',
|
|
1518
|
-
...options
|
|
1519
|
-
});
|
|
1520
|
-
/**
|
|
1521
|
-
* Get a cron schedule.
|
|
1522
|
-
*
|
|
1523
|
-
* Returns a single scheduled job by id.
|
|
1524
|
-
*/
|
|
1525
|
-
export const getCronSchedule = (options) => (options.client ?? client).get({
|
|
1526
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1527
|
-
url: '/v1/cron/schedules/{id}',
|
|
1528
|
-
...options
|
|
1529
|
-
});
|
|
1530
|
-
/**
|
|
1531
|
-
* Update a cron schedule.
|
|
1532
|
-
*
|
|
1533
|
-
* Updates an existing scheduled job.
|
|
1534
|
-
*/
|
|
1535
|
-
export const updateCronSchedule = (options) => (options.client ?? client).put({
|
|
1536
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1537
|
-
url: '/v1/cron/schedules/{id}',
|
|
1538
|
-
...options,
|
|
1539
|
-
headers: {
|
|
1540
|
-
'Content-Type': 'application/json',
|
|
1541
|
-
...options.headers
|
|
1542
|
-
}
|
|
1543
|
-
});
|
|
1544
|
-
/**
|
|
1545
|
-
* List schedule executions.
|
|
1546
|
-
*
|
|
1547
|
-
* Returns the execution history of a scheduled job.
|
|
1548
|
-
*/
|
|
1549
|
-
export const listCronExecutions = (options) => (options.client ?? client).get({
|
|
1550
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1551
|
-
url: '/v1/cron/schedules/{id}/executions',
|
|
1552
|
-
...options
|
|
1553
|
-
});
|
|
1554
|
-
/**
|
|
1555
|
-
* Trigger a cron schedule.
|
|
1556
|
-
*
|
|
1557
|
-
* Runs a scheduled job immediately, outside its normal schedule.
|
|
1558
|
-
*/
|
|
1559
|
-
export const triggerCronSchedule = (options) => (options.client ?? client).post({
|
|
1560
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1561
|
-
url: '/v1/cron/schedules/{id}/trigger',
|
|
1562
|
-
...options
|
|
1563
|
-
});
|
|
1564
|
-
/**
|
|
1565
|
-
* List databases.
|
|
1566
|
-
*
|
|
1567
|
-
* Lists the project's databases. `include_deleted=true` also returns
|
|
1568
|
-
* soft-deleted databases still inside the recovery grace window.
|
|
1569
|
-
*/
|
|
1570
|
-
export const listDatabases = (options) => (options?.client ?? client).get({
|
|
1571
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1572
|
-
url: '/v1/databases',
|
|
1573
|
-
...options
|
|
1574
|
-
});
|
|
1575
|
-
/**
|
|
1576
|
-
* Create a database.
|
|
1577
|
-
*
|
|
1578
|
-
* Creates a ScalixNova database in the project on the requested PostgreSQL
|
|
1579
|
-
* major version (16 default, 17, or 18). The version is fixed at creation;
|
|
1580
|
-
* branches and point-in-time restores keep it.
|
|
1581
|
-
*/
|
|
1582
|
-
export const createDatabase = (options) => (options.client ?? client).post({
|
|
1583
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1584
|
-
url: '/v1/databases',
|
|
1585
|
-
...options,
|
|
1586
|
-
headers: {
|
|
1587
|
-
'Content-Type': 'application/json',
|
|
1588
|
-
...options.headers
|
|
1589
|
-
}
|
|
1590
|
-
});
|
|
1591
|
-
/**
|
|
1592
|
-
* Get or create the project's default database.
|
|
1593
|
-
*
|
|
1594
|
-
* Idempotent: returns the project's default database connection info,
|
|
1595
|
-
* creating the database (on the default PostgreSQL version) if none exists.
|
|
1596
|
-
*/
|
|
1597
|
-
export const provisionDatabase = (options) => (options?.client ?? client).post({
|
|
1598
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1599
|
-
url: '/v1/databases/provision',
|
|
1600
|
-
...options
|
|
1601
|
-
});
|
|
1602
|
-
/**
|
|
1603
|
-
* Delete a database.
|
|
1604
|
-
*
|
|
1605
|
-
* Soft-deletes the database: it is hidden from listings and restorable via
|
|
1606
|
-
* `POST /v1/databases/{id}/restore` until the grace window ends, after which
|
|
1607
|
-
* it is purged permanently.
|
|
1608
|
-
*/
|
|
1609
|
-
export const deleteDatabase = (options) => (options.client ?? client).delete({
|
|
1610
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1611
|
-
url: '/v1/databases/{id}',
|
|
1612
|
-
...options
|
|
1613
|
-
});
|
|
1614
|
-
/**
|
|
1615
|
-
* Get a database.
|
|
1616
|
-
*
|
|
1617
|
-
* Fetches one database by id, including its PostgreSQL version and isolation tier.
|
|
1618
|
-
*/
|
|
1619
|
-
export const getDatabase = (options) => (options.client ?? client).get({
|
|
1620
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1621
|
-
url: '/v1/databases/{id}',
|
|
1622
|
-
...options
|
|
1623
|
-
});
|
|
1624
|
-
/**
|
|
1625
|
-
* Restore a soft-deleted database.
|
|
1626
|
-
*
|
|
1627
|
-
* Undoes a delete within the recovery grace window; the database returns to
|
|
1628
|
-
* `active` with its data, version, and tier intact.
|
|
1629
|
-
*/
|
|
1630
|
-
export const restoreDatabase = (options) => (options.client ?? client).post({
|
|
1631
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1632
|
-
url: '/v1/databases/{id}/restore',
|
|
1633
|
-
...options
|
|
1634
|
-
});
|
|
1635
|
-
/**
|
|
1636
|
-
* List custom domains.
|
|
1637
|
-
*
|
|
1638
|
-
* Returns all custom domains attached to the caller's project, with their
|
|
1639
|
-
* verification and SSL status.
|
|
1640
|
-
*/
|
|
1641
|
-
export const listDomains = (options) => (options?.client ?? client).get({
|
|
1642
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1643
|
-
url: '/v1/domains',
|
|
1644
|
-
...options
|
|
1645
|
-
});
|
|
1646
|
-
/**
|
|
1647
|
-
* Add a custom domain.
|
|
1648
|
-
*
|
|
1649
|
-
* Registers a custom domain for the caller's project and returns the created
|
|
1650
|
-
* record plus the DNS records (CNAME + TXT) needed to verify and serve it.
|
|
1651
|
-
*/
|
|
1652
|
-
export const addDomain = (options) => (options.client ?? client).post({
|
|
1653
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1654
|
-
url: '/v1/domains',
|
|
1655
|
-
...options,
|
|
1656
|
-
headers: {
|
|
1657
|
-
'Content-Type': 'application/json',
|
|
1658
|
-
...options.headers
|
|
1659
|
-
}
|
|
1660
|
-
});
|
|
1661
|
-
/**
|
|
1662
|
-
* Remove a custom domain.
|
|
1663
|
-
*
|
|
1664
|
-
* Detaches a custom domain from the caller's project and deletes its record.
|
|
1665
|
-
*/
|
|
1666
|
-
export const deleteDomain = (options) => (options.client ?? client).delete({
|
|
1667
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1668
|
-
url: '/v1/domains/{id}',
|
|
1669
|
-
...options
|
|
1670
|
-
});
|
|
1671
|
-
/**
|
|
1672
|
-
* Get a custom domain.
|
|
1673
|
-
*
|
|
1674
|
-
* Returns a single custom domain by id, scoped to the caller's project.
|
|
1675
|
-
*/
|
|
1676
|
-
export const getDomain = (options) => (options.client ?? client).get({
|
|
1677
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1678
|
-
url: '/v1/domains/{id}',
|
|
1679
|
-
...options
|
|
1680
|
-
});
|
|
1681
|
-
/**
|
|
1682
|
-
* Provision SSL for a domain.
|
|
1683
|
-
*
|
|
1684
|
-
* Starts background Let's Encrypt certificate issuance for a verified domain.
|
|
1685
|
-
* The domain must be active; automatic SSL must be configured on the deployment.
|
|
1686
|
-
*/
|
|
1687
|
-
export const provisionDomainSsl = (options) => (options.client ?? client).post({
|
|
1688
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1689
|
-
url: '/v1/domains/{id}/ssl',
|
|
1690
|
-
...options
|
|
1691
|
-
});
|
|
1692
|
-
/**
|
|
1693
|
-
* Verify a custom domain.
|
|
1694
|
-
*
|
|
1695
|
-
* Confirms — via a standard public DNS lookup, no provider credentials — that the
|
|
1696
|
-
* customer's domain points at our edge (its A records match `cname.<platform>`,
|
|
1697
|
-
* or a configured `SCALIX_EDGE_IP`). On success, marks the domain active. This is
|
|
1698
|
-
* the industry-standard "does it point at us" check (Vercel/Netlify/Render).
|
|
1699
|
-
*/
|
|
1700
|
-
export const verifyDomain = (options) => (options.client ?? client).post({
|
|
1701
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1702
|
-
url: '/v1/domains/{id}/verify',
|
|
1703
|
-
...options
|
|
1704
|
-
});
|
|
1705
|
-
/**
|
|
1706
|
-
* Get campaign analytics.
|
|
1707
|
-
*
|
|
1708
|
-
* Returns engagement metrics for a single template. Requires the `email:read`
|
|
1709
|
-
* scope.
|
|
1710
|
-
*/
|
|
1711
|
-
export const getEmailCampaignAnalytics = (options) => (options.client ?? client).get({
|
|
1712
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1713
|
-
url: '/v1/email/analytics/campaign/{template_name}',
|
|
1714
|
-
...options
|
|
1715
|
-
});
|
|
1716
|
-
/**
|
|
1717
|
-
* Get analytics summary.
|
|
1718
|
-
*
|
|
1719
|
-
* Returns aggregate open, click, bounce, and complaint rates for the org.
|
|
1720
|
-
* Requires the `email:read` scope.
|
|
1721
|
-
*/
|
|
1722
|
-
export const getEmailAnalyticsSummary = (options) => (options?.client ?? client).get({
|
|
1723
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1724
|
-
url: '/v1/email/analytics/summary',
|
|
1725
|
-
...options
|
|
1726
|
-
});
|
|
1727
|
-
/**
|
|
1728
|
-
* List sending domains.
|
|
1729
|
-
*
|
|
1730
|
-
* Returns the org's bring-your-own sending domains and their verification
|
|
1731
|
-
* state. Requires the `email:read` scope.
|
|
1732
|
-
*/
|
|
1733
|
-
export const listEmailDomains = (options) => (options?.client ?? client).get({
|
|
1734
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1735
|
-
url: '/v1/email/domains',
|
|
1736
|
-
...options
|
|
1737
|
-
});
|
|
1738
|
-
/**
|
|
1739
|
-
* Add a sending domain.
|
|
1740
|
-
*
|
|
1741
|
-
* Registers a domain and returns the DNS records required to verify it.
|
|
1742
|
-
* Requires the `email:send` scope.
|
|
1743
|
-
*/
|
|
1744
|
-
export const addEmailDomain = (options) => (options.client ?? client).post({
|
|
1745
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1746
|
-
url: '/v1/email/domains',
|
|
1747
|
-
...options,
|
|
1748
|
-
headers: {
|
|
1749
|
-
'Content-Type': 'application/json',
|
|
1750
|
-
...options.headers
|
|
1751
|
-
}
|
|
1752
|
-
});
|
|
1753
|
-
/**
|
|
1754
|
-
* Delete a sending domain.
|
|
1755
|
-
*
|
|
1756
|
-
* Removes a sending domain from the org. Requires the `email:send` scope.
|
|
1757
|
-
*/
|
|
1758
|
-
export const deleteEmailDomain = (options) => (options.client ?? client).delete({
|
|
1759
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1760
|
-
url: '/v1/email/domains/{id}',
|
|
1761
|
-
...options
|
|
1762
|
-
});
|
|
1763
|
-
/**
|
|
1764
|
-
* Verify a sending domain.
|
|
1765
|
-
*
|
|
1766
|
-
* Re-checks the domain's DNS records and updates its verification state.
|
|
1767
|
-
* Verifying a domain proves ownership; it does not by itself enable delivery.
|
|
1768
|
-
* Requires the `email:send` scope.
|
|
1769
|
-
*/
|
|
1770
|
-
export const verifyEmailDomain = (options) => (options.client ?? client).post({
|
|
1771
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1772
|
-
url: '/v1/email/domains/{id}/verify',
|
|
1773
|
-
...options
|
|
1774
|
-
});
|
|
1775
|
-
/**
|
|
1776
|
-
* List delivery events.
|
|
1777
|
-
*
|
|
1778
|
-
* Returns recent per-message delivery events (delivered, bounced, opened,
|
|
1779
|
-
* clicked). Requires the `email:read` scope.
|
|
1780
|
-
*/
|
|
1781
|
-
export const listEmailEvents = (options) => (options?.client ?? client).get({
|
|
1782
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1783
|
-
url: '/v1/email/events',
|
|
1784
|
-
...options
|
|
1785
|
-
});
|
|
1786
|
-
/**
|
|
1787
|
-
* Send a raw email.
|
|
1788
|
-
*
|
|
1789
|
-
* Sends an HTML email without a stored template. Requires the `email:send`
|
|
1790
|
-
* scope.
|
|
1791
|
-
*/
|
|
1792
|
-
export const sendRawEmail = (options) => (options.client ?? client).post({
|
|
1793
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1794
|
-
url: '/v1/email/send/raw',
|
|
1795
|
-
...options,
|
|
1796
|
-
headers: {
|
|
1797
|
-
'Content-Type': 'application/json',
|
|
1798
|
-
...options.headers
|
|
1799
|
-
}
|
|
1800
|
-
});
|
|
1801
|
-
/**
|
|
1802
|
-
* Send a templated email.
|
|
1803
|
-
*
|
|
1804
|
-
* Renders `template` with `data` and sends it to `to`. Requires the
|
|
1805
|
-
* `email:send` scope.
|
|
1806
|
-
*/
|
|
1807
|
-
export const sendTransactionalEmail = (options) => (options.client ?? client).post({
|
|
1808
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1809
|
-
url: '/v1/email/send/tx',
|
|
1810
|
-
...options,
|
|
1811
|
-
headers: {
|
|
1812
|
-
'Content-Type': 'application/json',
|
|
1813
|
-
...options.headers
|
|
1814
|
-
}
|
|
1815
|
-
});
|
|
1816
|
-
/**
|
|
1817
|
-
* Get email settings.
|
|
1818
|
-
*
|
|
1819
|
-
* Returns the org's sender identity and delivery configuration, including
|
|
1820
|
-
* whether bring-your-own delivery is enabled. Requires the `email:read` scope.
|
|
1821
|
-
*/
|
|
1822
|
-
export const getEmailSettings = (options) => (options?.client ?? client).get({
|
|
1823
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1824
|
-
url: '/v1/email/settings',
|
|
1825
|
-
...options
|
|
1826
|
-
});
|
|
1827
|
-
/**
|
|
1828
|
-
* Update email settings.
|
|
1829
|
-
*
|
|
1830
|
-
* Updates the org's sender identity and delivery configuration. Requires the
|
|
1831
|
-
* `email:send` scope.
|
|
1832
|
-
*/
|
|
1833
|
-
export const updateEmailSettings = (options) => (options.client ?? client).put({
|
|
1834
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1835
|
-
url: '/v1/email/settings',
|
|
1836
|
-
...options,
|
|
1837
|
-
headers: {
|
|
1838
|
-
'Content-Type': 'application/json',
|
|
1839
|
-
...options.headers
|
|
1840
|
-
}
|
|
1841
|
-
});
|
|
1842
|
-
/**
|
|
1843
|
-
* Get email stats.
|
|
1844
|
-
*
|
|
1845
|
-
* Returns send counts and delivery health for the org. Requires the
|
|
1846
|
-
* `email:read` scope.
|
|
1847
|
-
*/
|
|
1848
|
-
export const getEmailStats = (options) => (options?.client ?? client).get({
|
|
1849
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1850
|
-
url: '/v1/email/stats',
|
|
1851
|
-
...options
|
|
1852
|
-
});
|
|
1853
|
-
/**
|
|
1854
|
-
* List suppressed addresses.
|
|
1855
|
-
*
|
|
1856
|
-
* Returns addresses excluded from sending after a hard bounce or complaint.
|
|
1857
|
-
* Requires the `email:read` scope.
|
|
1858
|
-
*/
|
|
1859
|
-
export const listEmailSuppression = (options) => (options?.client ?? client).get({
|
|
1860
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1861
|
-
url: '/v1/email/suppression',
|
|
1862
|
-
...options
|
|
1863
|
-
});
|
|
1864
|
-
/**
|
|
1865
|
-
* List email templates.
|
|
1866
|
-
*
|
|
1867
|
-
* Returns the org's stored templates. Requires the `email:read` scope.
|
|
1868
|
-
*/
|
|
1869
|
-
export const listEmailTemplates = (options) => (options?.client ?? client).get({
|
|
1870
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1871
|
-
url: '/v1/email/templates',
|
|
1872
|
-
...options
|
|
1873
|
-
});
|
|
1874
|
-
/**
|
|
1875
|
-
* Create an email template.
|
|
1876
|
-
*
|
|
1877
|
-
* Stores a new template for the org. Requires the `email:write` scope.
|
|
1878
|
-
*/
|
|
1879
|
-
export const createEmailTemplate = (options) => (options.client ?? client).post({
|
|
1880
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1881
|
-
url: '/v1/email/templates',
|
|
1882
|
-
...options,
|
|
1883
|
-
headers: {
|
|
1884
|
-
'Content-Type': 'application/json',
|
|
1885
|
-
...options.headers
|
|
1886
|
-
}
|
|
1887
|
-
});
|
|
1888
|
-
/**
|
|
1889
|
-
* Delete an email template.
|
|
1890
|
-
*
|
|
1891
|
-
* Removes a stored template. Requires the `email:write` scope.
|
|
1892
|
-
*/
|
|
1893
|
-
export const deleteEmailTemplate = (options) => (options.client ?? client).delete({
|
|
1894
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1895
|
-
url: '/v1/email/templates/{id}',
|
|
1896
|
-
...options
|
|
1897
|
-
});
|
|
1898
|
-
/**
|
|
1899
|
-
* Update an email template.
|
|
1900
|
-
*
|
|
1901
|
-
* Replaces a stored template. Requires the `email:write` scope.
|
|
1902
|
-
*/
|
|
1903
|
-
export const updateEmailTemplate = (options) => (options.client ?? client).put({
|
|
1904
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1905
|
-
url: '/v1/email/templates/{id}',
|
|
1906
|
-
...options,
|
|
1907
|
-
headers: {
|
|
1908
|
-
'Content-Type': 'application/json',
|
|
1909
|
-
...options.headers
|
|
1910
|
-
}
|
|
1911
|
-
});
|
|
1912
|
-
/**
|
|
1913
|
-
* List environment variables.
|
|
1914
|
-
*
|
|
1915
|
-
* Returns all project-level environment variables (secret values masked).
|
|
1916
|
-
*/
|
|
1917
|
-
export const listEnvVars = (options) => (options?.client ?? client).get({
|
|
1918
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1919
|
-
url: '/v1/env',
|
|
1920
|
-
...options
|
|
1921
|
-
});
|
|
1922
|
-
/**
|
|
1923
|
-
* Set an environment variable.
|
|
1924
|
-
*
|
|
1925
|
-
* Creates or updates a single project-level environment variable.
|
|
1926
|
-
*/
|
|
1927
|
-
export const setEnvVar = (options) => (options.client ?? client).post({
|
|
1928
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1929
|
-
url: '/v1/env',
|
|
1930
|
-
...options,
|
|
1931
|
-
headers: {
|
|
1932
|
-
'Content-Type': 'application/json',
|
|
1933
|
-
...options.headers
|
|
1934
|
-
}
|
|
1935
|
-
});
|
|
1936
|
-
/**
|
|
1937
|
-
* Bulk-import environment variables.
|
|
1938
|
-
*
|
|
1939
|
-
* Imports many project-level environment variables in one request.
|
|
1940
|
-
*/
|
|
1941
|
-
export const bulkImportEnvVars = (options) => (options.client ?? client).post({
|
|
1942
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1943
|
-
url: '/v1/env/bulk',
|
|
1944
|
-
...options,
|
|
1945
|
-
headers: {
|
|
1946
|
-
'Content-Type': 'application/json',
|
|
1947
|
-
...options.headers
|
|
1948
|
-
}
|
|
1949
|
-
});
|
|
1950
|
-
/**
|
|
1951
|
-
* Delete an environment variable.
|
|
1952
|
-
*
|
|
1953
|
-
* Removes a project-level environment variable by id.
|
|
1954
|
-
*/
|
|
1955
|
-
export const deleteEnvVar = (options) => (options.client ?? client).delete({
|
|
1956
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1957
|
-
url: '/v1/env/{id}',
|
|
1958
|
-
...options
|
|
1959
|
-
});
|
|
1960
|
-
/**
|
|
1961
|
-
* Delete a subscription.
|
|
1962
|
-
*
|
|
1963
|
-
* Removes an event subscription by id.
|
|
1964
|
-
*/
|
|
1965
|
-
export const deleteEventSubscription = (options) => (options.client ?? client).delete({
|
|
1966
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1967
|
-
url: '/v1/events/subscriptions/{id}',
|
|
1968
|
-
...options
|
|
1969
|
-
});
|
|
1970
|
-
/**
|
|
1971
|
-
* Get a subscription.
|
|
1972
|
-
*
|
|
1973
|
-
* Returns a single event subscription by id.
|
|
1974
|
-
*/
|
|
1975
|
-
export const getEventSubscription = (options) => (options.client ?? client).get({
|
|
1976
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1977
|
-
url: '/v1/events/subscriptions/{id}',
|
|
1978
|
-
...options
|
|
1979
|
-
});
|
|
1980
|
-
/**
|
|
1981
|
-
* List subscription deliveries.
|
|
1982
|
-
*
|
|
1983
|
-
* Returns the delivery attempts for an event subscription.
|
|
1984
|
-
*/
|
|
1985
|
-
export const listSubscriptionDeliveries = (options) => (options.client ?? client).get({
|
|
1986
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1987
|
-
url: '/v1/events/subscriptions/{id}/deliveries',
|
|
1988
|
-
...options
|
|
1989
|
-
});
|
|
1990
|
-
/**
|
|
1991
|
-
* List topics.
|
|
1992
|
-
*
|
|
1993
|
-
* Returns all event-bus topics for the caller's project.
|
|
1994
|
-
*/
|
|
1995
|
-
export const listEventTopics = (options) => (options?.client ?? client).get({
|
|
1996
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1997
|
-
url: '/v1/events/topics',
|
|
1998
|
-
...options
|
|
1999
|
-
});
|
|
2000
|
-
/**
|
|
2001
|
-
* Create a topic.
|
|
2002
|
-
*
|
|
2003
|
-
* Creates a new event-bus topic.
|
|
2004
|
-
*/
|
|
2005
|
-
export const createEventTopic = (options) => (options?.client ?? client).post({
|
|
2006
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2007
|
-
url: '/v1/events/topics',
|
|
2008
|
-
...options
|
|
2009
|
-
});
|
|
2010
|
-
/**
|
|
2011
|
-
* Delete a topic.
|
|
2012
|
-
*
|
|
2013
|
-
* Removes an event-bus topic by id or name.
|
|
2014
|
-
*/
|
|
2015
|
-
export const deleteEventTopic = (options) => (options.client ?? client).delete({
|
|
2016
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2017
|
-
url: '/v1/events/topics/{id}',
|
|
2018
|
-
...options
|
|
2019
|
-
});
|
|
2020
|
-
/**
|
|
2021
|
-
* Get a topic.
|
|
2022
|
-
*
|
|
2023
|
-
* Returns a single event-bus topic by id or name.
|
|
2024
|
-
*/
|
|
2025
|
-
export const getEventTopic = (options) => (options.client ?? client).get({
|
|
2026
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2027
|
-
url: '/v1/events/topics/{id}',
|
|
2028
|
-
...options
|
|
2029
|
-
});
|
|
2030
|
-
/**
|
|
2031
|
-
* List events on a topic.
|
|
2032
|
-
*
|
|
2033
|
-
* Returns the recent events published to a topic.
|
|
2034
|
-
*/
|
|
2035
|
-
export const listTopicEvents = (options) => (options.client ?? client).get({
|
|
2036
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2037
|
-
url: '/v1/events/topics/{id}/events',
|
|
2038
|
-
...options
|
|
2039
|
-
});
|
|
2040
|
-
/**
|
|
2041
|
-
* Publish an event.
|
|
2042
|
-
*
|
|
2043
|
-
* Publishes an event payload to a topic.
|
|
2044
|
-
*/
|
|
2045
|
-
export const publishEvent = (options) => (options.client ?? client).post({
|
|
2046
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2047
|
-
url: '/v1/events/topics/{id}/publish',
|
|
2048
|
-
...options,
|
|
2049
|
-
headers: {
|
|
2050
|
-
'Content-Type': 'application/json',
|
|
2051
|
-
...options.headers
|
|
2052
|
-
}
|
|
2053
|
-
});
|
|
2054
|
-
/**
|
|
2055
|
-
* List a topic's subscriptions.
|
|
2056
|
-
*
|
|
2057
|
-
* Returns the subscriptions attached to a topic.
|
|
2058
|
-
*/
|
|
2059
|
-
export const listTopicSubscriptions = (options) => (options.client ?? client).get({
|
|
2060
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2061
|
-
url: '/v1/events/topics/{id}/subscriptions',
|
|
2062
|
-
...options
|
|
2063
|
-
});
|
|
2064
|
-
/**
|
|
2065
|
-
* Create a subscription.
|
|
2066
|
-
*
|
|
2067
|
-
* Creates a subscription that delivers a topic's events to an endpoint.
|
|
2068
|
-
*/
|
|
2069
|
-
export const createEventSubscription = (options) => (options.client ?? client).post({
|
|
2070
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2071
|
-
url: '/v1/events/topics/{id}/subscriptions',
|
|
2072
|
-
...options,
|
|
2073
|
-
headers: {
|
|
2074
|
-
'Content-Type': 'application/json',
|
|
2075
|
-
...options.headers
|
|
2076
|
-
}
|
|
2077
|
-
});
|
|
2078
|
-
/**
|
|
2079
|
-
* List functions.
|
|
2080
|
-
*
|
|
2081
|
-
* Returns all serverless functions for the caller's project.
|
|
2082
|
-
*/
|
|
2083
|
-
export const listFunctions = (options) => (options?.client ?? client).get({
|
|
2084
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2085
|
-
url: '/v1/functions',
|
|
2086
|
-
...options
|
|
2087
|
-
});
|
|
2088
|
-
/**
|
|
2089
|
-
* Create a function.
|
|
2090
|
-
*
|
|
2091
|
-
* Deploys a serverless function and returns the created function.
|
|
2092
|
-
*/
|
|
2093
|
-
export const createFunction = (options) => (options.client ?? client).post({
|
|
2094
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2095
|
-
url: '/v1/functions',
|
|
2096
|
-
...options,
|
|
2097
|
-
headers: {
|
|
2098
|
-
'Content-Type': 'application/json',
|
|
2099
|
-
...options.headers
|
|
2100
|
-
}
|
|
2101
|
-
});
|
|
2102
|
-
/**
|
|
2103
|
-
* Delete a function.
|
|
2104
|
-
*
|
|
2105
|
-
* Removes a serverless function by id or name.
|
|
2106
|
-
*/
|
|
2107
|
-
export const deleteFunction = (options) => (options.client ?? client).delete({
|
|
2108
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2109
|
-
url: '/v1/functions/{id}',
|
|
2110
|
-
...options
|
|
2111
|
-
});
|
|
2112
|
-
/**
|
|
2113
|
-
* Get a function.
|
|
2114
|
-
*
|
|
2115
|
-
* Returns a single serverless function by id or name.
|
|
2116
|
-
*/
|
|
2117
|
-
export const getFunction = (options) => (options.client ?? client).get({
|
|
2118
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2119
|
-
url: '/v1/functions/{id}',
|
|
2120
|
-
...options
|
|
2121
|
-
});
|
|
2122
|
-
/**
|
|
2123
|
-
* Update a function.
|
|
2124
|
-
*
|
|
2125
|
-
* Redeploys a serverless function with a new configuration.
|
|
2126
|
-
*/
|
|
2127
|
-
export const updateFunction = (options) => (options.client ?? client).put({
|
|
2128
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2129
|
-
url: '/v1/functions/{id}',
|
|
2130
|
-
...options,
|
|
2131
|
-
headers: {
|
|
2132
|
-
'Content-Type': 'application/json',
|
|
2133
|
-
...options.headers
|
|
2134
|
-
}
|
|
2135
|
-
});
|
|
2136
|
-
/**
|
|
2137
|
-
* List function invocations.
|
|
2138
|
-
*
|
|
2139
|
-
* Returns the invocation history for a serverless function.
|
|
2140
|
-
*/
|
|
2141
|
-
export const listFunctionInvocations = (options) => (options.client ?? client).get({
|
|
2142
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2143
|
-
url: '/v1/functions/{id}/invocations',
|
|
2144
|
-
...options
|
|
2145
|
-
});
|
|
2146
|
-
/**
|
|
2147
|
-
* Invoke a function.
|
|
2148
|
-
*
|
|
2149
|
-
* Invokes a serverless function with the supplied payload and returns its result.
|
|
2150
|
-
*/
|
|
2151
|
-
export const invokeFunction = (options) => (options.client ?? client).post({
|
|
2152
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2153
|
-
url: '/v1/functions/{id}/invoke',
|
|
2154
|
-
...options,
|
|
2155
|
-
headers: {
|
|
2156
|
-
'Content-Type': 'application/json',
|
|
2157
|
-
...options.headers
|
|
2158
|
-
}
|
|
2159
|
-
});
|
|
2160
|
-
/**
|
|
2161
|
-
* Get function logs.
|
|
2162
|
-
*
|
|
2163
|
-
* Returns log output for a serverless function.
|
|
2164
|
-
*/
|
|
2165
|
-
export const getFunctionLogs = (options) => (options.client ?? client).get({
|
|
2166
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2167
|
-
url: '/v1/functions/{id}/logs',
|
|
2168
|
-
...options
|
|
2169
|
-
});
|
|
2170
|
-
/**
|
|
2171
|
-
* List source-control integrations.
|
|
2172
|
-
*
|
|
2173
|
-
* Returns all GitHub/GitLab/Bitbucket integrations attached to the caller's
|
|
2174
|
-
* project.
|
|
2175
|
-
*/
|
|
2176
|
-
export const listIntegrations = (options) => (options?.client ?? client).get({
|
|
2177
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2178
|
-
url: '/v1/integrations',
|
|
2179
|
-
...options
|
|
2180
|
-
});
|
|
2181
|
-
/**
|
|
2182
|
-
* Create a source-control integration.
|
|
2183
|
-
*
|
|
2184
|
-
* Attaches a Git provider repo to the caller's project and returns the created
|
|
2185
|
-
* integration plus the webhook URL and secret to configure on the provider.
|
|
2186
|
-
*/
|
|
2187
|
-
export const createIntegration = (options) => (options.client ?? client).post({
|
|
2188
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2189
|
-
url: '/v1/integrations',
|
|
2190
|
-
...options,
|
|
2191
|
-
headers: {
|
|
2192
|
-
'Content-Type': 'application/json',
|
|
2193
|
-
...options.headers
|
|
2194
|
-
}
|
|
2195
|
-
});
|
|
2196
|
-
/**
|
|
2197
|
-
* List GitHub App installations.
|
|
2198
|
-
*
|
|
2199
|
-
* Returns the GitHub App installations registered to the caller's project.
|
|
2200
|
-
*/
|
|
2201
|
-
export const listGithubInstallations = (options) => (options?.client ?? client).get({
|
|
2202
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2203
|
-
url: '/v1/integrations/github/installations',
|
|
2204
|
-
...options
|
|
2205
|
-
});
|
|
2206
|
-
/**
|
|
2207
|
-
* Mint an installation token.
|
|
2208
|
-
*
|
|
2209
|
-
* Returns a short-lived GitHub App installation access token for an
|
|
2210
|
-
* installation owned by the caller's project.
|
|
2211
|
-
*/
|
|
2212
|
-
export const createGithubInstallationToken = (options) => (options.client ?? client).post({
|
|
2213
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2214
|
-
url: '/v1/integrations/github/installations/{installation_id}/token',
|
|
2215
|
-
...options
|
|
2216
|
-
});
|
|
2217
|
-
/**
|
|
2218
|
-
* List accessible GitHub repos.
|
|
2219
|
-
*
|
|
2220
|
-
* Returns the repositories the project's GitHub App installations can access,
|
|
2221
|
-
* aggregated across all active installations.
|
|
2222
|
-
*/
|
|
2223
|
-
export const listGithubRepos = (options) => (options?.client ?? client).get({
|
|
2224
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2225
|
-
url: '/v1/integrations/github/repos',
|
|
2226
|
-
...options
|
|
2227
|
-
});
|
|
2228
|
-
/**
|
|
2229
|
-
* Delete a source-control integration.
|
|
2230
|
-
*
|
|
2231
|
-
* Detaches a Git provider repo from the caller's project and deletes the
|
|
2232
|
-
* integration record.
|
|
2233
|
-
*/
|
|
2234
|
-
export const deleteIntegration = (options) => (options.client ?? client).delete({
|
|
2235
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2236
|
-
url: '/v1/integrations/{id}',
|
|
2237
|
-
...options
|
|
2238
|
-
});
|
|
2239
|
-
/**
|
|
2240
|
-
* Get a source-control integration.
|
|
2241
|
-
*
|
|
2242
|
-
* Returns a single integration by id, scoped to the caller's project.
|
|
2243
|
-
*/
|
|
2244
|
-
export const getIntegration = (options) => (options.client ?? client).get({
|
|
2245
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2246
|
-
url: '/v1/integrations/{id}',
|
|
2247
|
-
...options
|
|
2248
|
-
});
|
|
2249
|
-
/**
|
|
2250
|
-
* Update a source-control integration.
|
|
2251
|
-
*
|
|
2252
|
-
* Updates an integration's build/deploy settings (branch filter, auto-build,
|
|
2253
|
-
* auto-deploy, preview, status) and returns the updated record.
|
|
2254
|
-
*/
|
|
2255
|
-
export const updateIntegration = (options) => (options.client ?? client).put({
|
|
2256
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2257
|
-
url: '/v1/integrations/{id}',
|
|
2258
|
-
...options,
|
|
2259
|
-
headers: {
|
|
2260
|
-
'Content-Type': 'application/json',
|
|
2261
|
-
...options.headers
|
|
2262
|
-
}
|
|
2263
|
-
});
|
|
2264
|
-
/**
|
|
2265
|
-
* Delete keys.
|
|
2266
|
-
*
|
|
2267
|
-
* Removes one or more keys from the tenant's key-value store (batch delete).
|
|
2268
|
-
*/
|
|
2269
|
-
export const kvDel = (options) => (options.client ?? client).post({
|
|
2270
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2271
|
-
url: '/v1/kv/del',
|
|
2272
|
-
...options,
|
|
2273
|
-
headers: {
|
|
2274
|
-
'Content-Type': 'application/json',
|
|
2275
|
-
...options.headers
|
|
2276
|
-
}
|
|
2277
|
-
});
|
|
2278
|
-
/**
|
|
2279
|
-
* Check if a key exists.
|
|
2280
|
-
*
|
|
2281
|
-
* Returns whether a key is present in the tenant's key-value store.
|
|
2282
|
-
*/
|
|
2283
|
-
export const kvExists = (options) => (options.client ?? client).post({
|
|
2284
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2285
|
-
url: '/v1/kv/exists',
|
|
2286
|
-
...options,
|
|
2287
|
-
headers: {
|
|
2288
|
-
'Content-Type': 'application/json',
|
|
2289
|
-
...options.headers
|
|
2290
|
-
}
|
|
2291
|
-
});
|
|
2292
|
-
/**
|
|
2293
|
-
* Fetch a value by key.
|
|
2294
|
-
*
|
|
2295
|
-
* Reads a single key from the tenant's key-value store; returns `value: null` if absent.
|
|
2296
|
-
*/
|
|
2297
|
-
export const kvGet = (options) => (options.client ?? client).post({
|
|
2298
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2299
|
-
url: '/v1/kv/get',
|
|
2300
|
-
...options,
|
|
2301
|
-
headers: {
|
|
2302
|
-
'Content-Type': 'application/json',
|
|
2303
|
-
...options.headers
|
|
2304
|
-
}
|
|
2305
|
-
});
|
|
2306
|
-
/**
|
|
2307
|
-
* List keys.
|
|
2308
|
-
*
|
|
2309
|
-
* Returns the keys in the tenant's key-value store matching an optional glob pattern.
|
|
2310
|
-
*/
|
|
2311
|
-
export const kvKeys = (options) => (options.client ?? client).post({
|
|
2312
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2313
|
-
url: '/v1/kv/keys',
|
|
2314
|
-
...options,
|
|
2315
|
-
headers: {
|
|
2316
|
-
'Content-Type': 'application/json',
|
|
2317
|
-
...options.headers
|
|
2318
|
-
}
|
|
2319
|
-
});
|
|
2320
|
-
/**
|
|
2321
|
-
* Set a value by key.
|
|
2322
|
-
*
|
|
2323
|
-
* Writes a value to the tenant's key-value store, with an optional TTL.
|
|
2324
|
-
*/
|
|
2325
|
-
export const kvSet = (options) => (options.client ?? client).post({
|
|
2326
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2327
|
-
url: '/v1/kv/set',
|
|
2328
|
-
...options,
|
|
2329
|
-
headers: {
|
|
2330
|
-
'Content-Type': 'application/json',
|
|
2331
|
-
...options.headers
|
|
2332
|
-
}
|
|
2333
|
-
});
|
|
2334
|
-
/**
|
|
2335
|
-
* List load balancers.
|
|
2336
|
-
*
|
|
2337
|
-
* Returns all load balancers belonging to the caller's project.
|
|
2338
|
-
*/
|
|
2339
|
-
export const listLoadBalancers = (options) => (options?.client ?? client).get({
|
|
2340
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2341
|
-
url: '/v1/lb',
|
|
2342
|
-
...options
|
|
2343
|
-
});
|
|
2344
|
-
/**
|
|
2345
|
-
* Create a load balancer.
|
|
2346
|
-
*
|
|
2347
|
-
* Provisions a load balancer for the caller's project and returns its details.
|
|
2348
|
-
*/
|
|
2349
|
-
export const createLoadBalancer = (options) => (options.client ?? client).post({
|
|
2350
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2351
|
-
url: '/v1/lb',
|
|
2352
|
-
...options,
|
|
2353
|
-
headers: {
|
|
2354
|
-
'Content-Type': 'application/json',
|
|
2355
|
-
...options.headers
|
|
2356
|
-
}
|
|
2357
|
-
});
|
|
2358
|
-
/**
|
|
2359
|
-
* Delete a load balancer.
|
|
2360
|
-
*
|
|
2361
|
-
* Removes a load balancer and its backends by id.
|
|
2362
|
-
*/
|
|
2363
|
-
export const deleteLoadBalancer = (options) => (options.client ?? client).delete({
|
|
2364
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2365
|
-
url: '/v1/lb/{id}',
|
|
2366
|
-
...options
|
|
2367
|
-
});
|
|
2368
|
-
/**
|
|
2369
|
-
* Get a load balancer.
|
|
2370
|
-
*
|
|
2371
|
-
* Returns a single load balancer by id.
|
|
2372
|
-
*/
|
|
2373
|
-
export const getLoadBalancer = (options) => (options.client ?? client).get({
|
|
2374
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2375
|
-
url: '/v1/lb/{id}',
|
|
2376
|
-
...options
|
|
2377
|
-
});
|
|
2378
|
-
/**
|
|
2379
|
-
* Add a backend to a load balancer.
|
|
2380
|
-
*
|
|
2381
|
-
* Registers a backend target on the load balancer and returns its details.
|
|
2382
|
-
*/
|
|
2383
|
-
export const addLoadBalancerBackend = (options) => (options.client ?? client).post({
|
|
2384
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2385
|
-
url: '/v1/lb/{id}/backends',
|
|
2386
|
-
...options,
|
|
2387
|
-
headers: {
|
|
2388
|
-
'Content-Type': 'application/json',
|
|
2389
|
-
...options.headers
|
|
2390
|
-
}
|
|
2391
|
-
});
|
|
2392
|
-
/**
|
|
2393
|
-
* Remove a backend from a load balancer.
|
|
2394
|
-
*
|
|
2395
|
-
* Deletes a backend target from the load balancer by id.
|
|
2396
|
-
*/
|
|
2397
|
-
export const removeLoadBalancerBackend = (options) => (options.client ?? client).delete({
|
|
2398
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2399
|
-
url: '/v1/lb/{id}/backends/{backend_id}',
|
|
2400
|
-
...options
|
|
2401
|
-
});
|
|
2402
|
-
/**
|
|
2403
|
-
* Describe the current token.
|
|
2404
|
-
*
|
|
2405
|
-
* Returns the caller's identity, effective permissions and scopes, the MCP
|
|
2406
|
-
* tools their scopes unlock, and their plan's rate-limit and API-key ceilings.
|
|
2407
|
-
*/
|
|
2408
|
-
export const getMe = (options) => (options?.client ?? client).get({
|
|
2409
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2410
|
-
url: '/v1/me',
|
|
2411
|
-
...options
|
|
2412
|
-
});
|
|
2413
|
-
/**
|
|
2414
|
-
* Check the registry API version.
|
|
2415
|
-
*
|
|
2416
|
-
* Returns the OCI Distribution API version supported by the registry.
|
|
2417
|
-
*/
|
|
2418
|
-
export const registryVersionCheck = (options) => (options?.client ?? client).get({
|
|
2419
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2420
|
-
url: '/v1/registry/v2/',
|
|
2421
|
-
...options
|
|
2422
|
-
});
|
|
2423
|
-
/**
|
|
2424
|
-
* List the repository catalog.
|
|
2425
|
-
*
|
|
2426
|
-
* Returns the catalog of repositories in the registry.
|
|
2427
|
-
*/
|
|
2428
|
-
export const getRegistryCatalog = (options) => (options?.client ?? client).get({
|
|
2429
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2430
|
-
url: '/v1/registry/v2/_catalog',
|
|
2431
|
-
...options
|
|
2432
|
-
});
|
|
2433
|
-
/**
|
|
2434
|
-
* Start a blob upload.
|
|
2435
|
-
*
|
|
2436
|
-
* Begins an OCI blob upload session and returns the upload location.
|
|
2437
|
-
*/
|
|
2438
|
-
export const startRegistryBlobUpload = (options) => (options.client ?? client).post({
|
|
2439
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2440
|
-
url: '/v1/registry/v2/{project_id}/{repository}/blobs/uploads/',
|
|
2441
|
-
...options
|
|
2442
|
-
});
|
|
2443
|
-
/**
|
|
2444
|
-
* Get a blob.
|
|
2445
|
-
*
|
|
2446
|
-
* Downloads an OCI blob by digest.
|
|
2447
|
-
*/
|
|
2448
|
-
export const getRegistryBlob = (options) => (options.client ?? client).get({
|
|
2449
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2450
|
-
url: '/v1/registry/v2/{project_id}/{repository}/blobs/{digest}',
|
|
2451
|
-
...options
|
|
2452
|
-
});
|
|
2453
|
-
/**
|
|
2454
|
-
* Check a blob exists.
|
|
2455
|
-
*
|
|
2456
|
-
* Returns headers indicating whether an OCI blob exists.
|
|
2457
|
-
*/
|
|
2458
|
-
export const headRegistryBlob = (options) => (options.client ?? client).head({
|
|
2459
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2460
|
-
url: '/v1/registry/v2/{project_id}/{repository}/blobs/{digest}',
|
|
2461
|
-
...options
|
|
2462
|
-
});
|
|
2463
|
-
/**
|
|
2464
|
-
* Delete a manifest.
|
|
2465
|
-
*
|
|
2466
|
-
* Removes an OCI image manifest by tag or digest.
|
|
2467
|
-
*/
|
|
2468
|
-
export const deleteRegistryManifest = (options) => (options.client ?? client).delete({
|
|
2469
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2470
|
-
url: '/v1/registry/v2/{project_id}/{repository}/manifests/{reference}',
|
|
2471
|
-
...options
|
|
2472
|
-
});
|
|
2473
|
-
/**
|
|
2474
|
-
* Get a manifest.
|
|
2475
|
-
*
|
|
2476
|
-
* Returns an OCI image manifest by tag or digest.
|
|
2477
|
-
*/
|
|
2478
|
-
export const getRegistryManifest = (options) => (options.client ?? client).get({
|
|
2479
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2480
|
-
url: '/v1/registry/v2/{project_id}/{repository}/manifests/{reference}',
|
|
2481
|
-
...options
|
|
2482
|
-
});
|
|
2483
|
-
/**
|
|
2484
|
-
* Check a manifest exists.
|
|
2485
|
-
*
|
|
2486
|
-
* Returns headers indicating whether an OCI manifest exists.
|
|
2487
|
-
*/
|
|
2488
|
-
export const headRegistryManifest = (options) => (options.client ?? client).head({
|
|
2489
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2490
|
-
url: '/v1/registry/v2/{project_id}/{repository}/manifests/{reference}',
|
|
2491
|
-
...options
|
|
2492
|
-
});
|
|
2493
|
-
/**
|
|
2494
|
-
* Store a manifest.
|
|
2495
|
-
*
|
|
2496
|
-
* Uploads an OCI image manifest under a tag or digest.
|
|
2497
|
-
*/
|
|
2498
|
-
export const putRegistryManifest = (options) => (options.client ?? client).put({
|
|
2499
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2500
|
-
url: '/v1/registry/v2/{project_id}/{repository}/manifests/{reference}',
|
|
2501
|
-
...options,
|
|
2502
|
-
headers: {
|
|
2503
|
-
'Content-Type': 'application/json',
|
|
2504
|
-
...options.headers
|
|
2505
|
-
}
|
|
2506
|
-
});
|
|
2507
|
-
/**
|
|
2508
|
-
* List tags.
|
|
2509
|
-
*
|
|
2510
|
-
* Returns the tags available for a repository.
|
|
2511
|
-
*/
|
|
2512
|
-
export const listRegistryTags = (options) => (options.client ?? client).get({
|
|
2513
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2514
|
-
url: '/v1/registry/v2/{project_id}/{repository}/tags/list',
|
|
2515
|
-
...options
|
|
2516
|
-
});
|
|
2517
|
-
/**
|
|
2518
|
-
* List Scalix Run services.
|
|
2519
|
-
*
|
|
2520
|
-
* Returns all Scalix Run services for the caller's project.
|
|
2521
|
-
*/
|
|
2522
|
-
export const listServices = (options) => (options?.client ?? client).get({
|
|
2523
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2524
|
-
url: '/v1/run/services',
|
|
2525
|
-
...options
|
|
2526
|
-
});
|
|
2527
|
-
/**
|
|
2528
|
-
* Deploy a Scalix Run service.
|
|
2529
|
-
*
|
|
2530
|
-
* Deploys a Scalix Run service and returns the created service.
|
|
2531
|
-
*/
|
|
2532
|
-
export const createService = (options) => (options.client ?? client).post({
|
|
2533
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2534
|
-
url: '/v1/run/services',
|
|
2535
|
-
...options,
|
|
2536
|
-
headers: {
|
|
2537
|
-
'Content-Type': 'application/json',
|
|
2538
|
-
...options.headers
|
|
2539
|
-
}
|
|
2540
|
-
});
|
|
2541
|
-
/**
|
|
2542
|
-
* Delete a Scalix Run service.
|
|
2543
|
-
*
|
|
2544
|
-
* Removes a Scalix Run service by id.
|
|
2545
|
-
*/
|
|
2546
|
-
export const deleteService = (options) => (options.client ?? client).delete({
|
|
2547
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2548
|
-
url: '/v1/run/services/{id}',
|
|
2549
|
-
...options
|
|
2550
|
-
});
|
|
2551
|
-
/**
|
|
2552
|
-
* Get a Scalix Run service.
|
|
2553
|
-
*
|
|
2554
|
-
* Returns a single Scalix Run service by id.
|
|
2555
|
-
*/
|
|
2556
|
-
export const getService = (options) => (options.client ?? client).get({
|
|
2557
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2558
|
-
url: '/v1/run/services/{id}',
|
|
2559
|
-
...options
|
|
2560
|
-
});
|
|
2561
|
-
/**
|
|
2562
|
-
* Update a Scalix Run service.
|
|
2563
|
-
*
|
|
2564
|
-
* Updates a Scalix Run service (e.g. scaling) and returns the new state.
|
|
2565
|
-
*/
|
|
2566
|
-
export const updateService = (options) => (options.client ?? client).put({
|
|
2567
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2568
|
-
url: '/v1/run/services/{id}',
|
|
2569
|
-
...options,
|
|
2570
|
-
headers: {
|
|
2571
|
-
'Content-Type': 'application/json',
|
|
2572
|
-
...options.headers
|
|
2573
|
-
}
|
|
2574
|
-
});
|
|
2575
|
-
/**
|
|
2576
|
-
* List service instances.
|
|
2577
|
-
*
|
|
2578
|
-
* Returns the running instances of a Scalix Run service.
|
|
2579
|
-
*/
|
|
2580
|
-
export const listServiceInstances = (options) => (options.client ?? client).get({
|
|
2581
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2582
|
-
url: '/v1/run/services/{id}/instances',
|
|
2583
|
-
...options
|
|
2584
|
-
});
|
|
2585
|
-
/**
|
|
2586
|
-
* Get service live instance state.
|
|
2587
|
-
*
|
|
2588
|
-
* Returns healthy/total instance counts and in-flight request totals for a
|
|
2589
|
-
* Scalix Run service. Request-level RED metrics (requests/sec, errors/sec,
|
|
2590
|
-
* latency percentiles) are served by
|
|
2591
|
-
* `GET /v1/metering/services/run-service/{id}/metrics`, whose response
|
|
2592
|
-
* carries `available:false` with a message when the deployment has no
|
|
2593
|
-
* metrics backend.
|
|
2594
|
-
*/
|
|
2595
|
-
export const getServiceMetrics = (options) => (options.client ?? client).get({
|
|
2596
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2597
|
-
url: '/v1/run/services/{id}/metrics',
|
|
2598
|
-
...options
|
|
2599
|
-
});
|
|
2600
|
-
/**
|
|
2601
|
-
* List service revisions.
|
|
2602
|
-
*
|
|
2603
|
-
* Returns the revision history of a Scalix Run service.
|
|
2604
|
-
*/
|
|
2605
|
-
export const listServiceRevisions = (options) => (options.client ?? client).get({
|
|
2606
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2607
|
-
url: '/v1/run/services/{id}/revisions',
|
|
2608
|
-
...options
|
|
2609
|
-
});
|
|
2610
|
-
/**
|
|
2611
|
-
* Roll back a service.
|
|
2612
|
-
*
|
|
2613
|
-
* Rolls a Scalix Run service back to a previous revision.
|
|
2614
|
-
*/
|
|
2615
|
-
export const rollbackService = (options) => (options.client ?? client).post({
|
|
2616
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2617
|
-
url: '/v1/run/services/{id}/rollback',
|
|
2618
|
-
...options,
|
|
2619
|
-
headers: {
|
|
2620
|
-
'Content-Type': 'application/json',
|
|
2621
|
-
...options.headers
|
|
2622
|
-
}
|
|
2623
|
-
});
|
|
2624
|
-
/**
|
|
2625
|
-
* List your sandboxes.
|
|
2626
|
-
*/
|
|
2627
|
-
export const sandboxList = (options) => (options?.client ?? client).get({
|
|
2628
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2629
|
-
url: '/v1/sandboxes',
|
|
2630
|
-
...options
|
|
2631
|
-
});
|
|
2632
|
-
/**
|
|
2633
|
-
* Create an ephemeral sandbox.
|
|
2634
|
-
*
|
|
2635
|
-
* Boots an isolated microVM. Ephemeral sandboxes are disposable: they stop
|
|
2636
|
-
* at their idle or hard timeout and nothing on the rootfs persists past
|
|
2637
|
-
* stop. Compute is billed per vCPU-hour and GB-hour of allocation while
|
|
2638
|
-
* running.
|
|
2639
|
-
*/
|
|
2640
|
-
export const sandboxCreate = (options) => (options.client ?? client).post({
|
|
2641
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2642
|
-
url: '/v1/sandboxes',
|
|
2643
|
-
...options,
|
|
2644
|
-
headers: {
|
|
2645
|
-
'Content-Type': 'application/json',
|
|
2646
|
-
...options.headers
|
|
2647
|
-
}
|
|
2648
|
-
});
|
|
2649
|
-
/**
|
|
2650
|
-
* Delete a sandbox and tear down its microVM.
|
|
2651
|
-
*/
|
|
2652
|
-
export const sandboxDelete = (options) => (options.client ?? client).delete({
|
|
2653
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2654
|
-
url: '/v1/sandboxes/{id}',
|
|
2655
|
-
...options
|
|
2656
|
-
});
|
|
2657
|
-
/**
|
|
2658
|
-
* Get a sandbox by id.
|
|
2659
|
-
*/
|
|
2660
|
-
export const sandboxGet = (options) => (options.client ?? client).get({
|
|
2661
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2662
|
-
url: '/v1/sandboxes/{id}',
|
|
2663
|
-
...options
|
|
2664
|
-
});
|
|
2665
|
-
/**
|
|
2666
|
-
* Run a command inside a running sandbox (synchronous).
|
|
2667
|
-
*/
|
|
2668
|
-
export const sandboxRunCommand = (options) => (options.client ?? client).post({
|
|
2669
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2670
|
-
url: '/v1/sandboxes/{id}/commands',
|
|
2671
|
-
...options,
|
|
2672
|
-
headers: {
|
|
2673
|
-
'Content-Type': 'application/json',
|
|
2674
|
-
...options.headers
|
|
2675
|
-
}
|
|
2676
|
-
});
|
|
2677
|
-
/**
|
|
2678
|
-
* Extend a sandbox's hard deadline.
|
|
2679
|
-
*/
|
|
2680
|
-
export const sandboxExtend = (options) => (options.client ?? client).post({
|
|
2681
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2682
|
-
url: '/v1/sandboxes/{id}/extend',
|
|
2683
|
-
...options,
|
|
2684
|
-
headers: {
|
|
2685
|
-
'Content-Type': 'application/json',
|
|
2686
|
-
...options.headers
|
|
2687
|
-
}
|
|
2688
|
-
});
|
|
2689
|
-
/**
|
|
2690
|
-
* Write files into a sandbox.
|
|
2691
|
-
*/
|
|
2692
|
-
export const sandboxWriteFiles = (options) => (options.client ?? client).post({
|
|
2693
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2694
|
-
url: '/v1/sandboxes/{id}/files',
|
|
2695
|
-
...options,
|
|
2696
|
-
headers: {
|
|
2697
|
-
'Content-Type': 'application/json',
|
|
2698
|
-
...options.headers
|
|
2699
|
-
}
|
|
2700
|
-
});
|
|
2701
|
-
/**
|
|
2702
|
-
* Read a file from a sandbox. The guest path follows `/files/`.
|
|
2703
|
-
*/
|
|
2704
|
-
export const sandboxReadFile = (options) => (options.client ?? client).get({
|
|
2705
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2706
|
-
url: '/v1/sandboxes/{id}/files/{path}',
|
|
2707
|
-
...options
|
|
2708
|
-
});
|
|
2709
|
-
/**
|
|
2710
|
-
* Snapshot a sandbox - not available.
|
|
2711
|
-
*
|
|
2712
|
-
* Ephemeral sandboxes are disposable; state does not persist past stop.
|
|
2713
|
-
* This endpoint returns 501 until snapshots ship (demand-gated).
|
|
2714
|
-
*/
|
|
2715
|
-
export const sandboxSnapshot = (options) => (options.client ?? client).post({
|
|
2716
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2717
|
-
url: '/v1/sandboxes/{id}/snapshot',
|
|
2718
|
-
...options
|
|
2719
|
-
});
|
|
2720
|
-
/**
|
|
2721
|
-
* Run a search.
|
|
2722
|
-
*
|
|
2723
|
-
* Runs a query against the curated Scalix Search index and returns ranked results.
|
|
2724
|
-
*/
|
|
2725
|
-
export const searchIndex = (options) => (options?.client ?? client).get({
|
|
2726
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2727
|
-
url: '/v1/search',
|
|
2728
|
-
...options
|
|
2729
|
-
});
|
|
2730
|
-
/**
|
|
2731
|
-
* Run a search ingest.
|
|
2732
|
-
*
|
|
2733
|
-
* Triggers an ingest run that crawls and indexes registered sources.
|
|
2734
|
-
*/
|
|
2735
|
-
export const runSearchIngest = (options) => (options?.client ?? client).post({
|
|
2736
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2737
|
-
url: '/v1/search/ingest/run',
|
|
2738
|
-
...options
|
|
2739
|
-
});
|
|
2740
|
-
/**
|
|
2741
|
-
* List search sources.
|
|
2742
|
-
*
|
|
2743
|
-
* Returns the curated sources registered in the search index.
|
|
911
|
+
* Returns all event-bus topics for the caller's project.
|
|
2744
912
|
*/
|
|
2745
|
-
export const
|
|
913
|
+
export const listEventTopics = (options) => (options?.client ?? client).get({
|
|
2746
914
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2747
|
-
url: '/v1/
|
|
915
|
+
url: '/v1/events/topics',
|
|
2748
916
|
...options
|
|
2749
917
|
});
|
|
2750
918
|
/**
|
|
2751
|
-
*
|
|
919
|
+
* Create a topic.
|
|
2752
920
|
*
|
|
2753
|
-
* Creates
|
|
921
|
+
* Creates a new event-bus topic.
|
|
2754
922
|
*/
|
|
2755
|
-
export const
|
|
923
|
+
export const createEventTopic = (options) => (options.client ?? client).post({
|
|
2756
924
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2757
|
-
url: '/v1/
|
|
925
|
+
url: '/v1/events/topics',
|
|
2758
926
|
...options,
|
|
2759
927
|
headers: {
|
|
2760
928
|
'Content-Type': 'application/json',
|
|
@@ -2762,61 +930,43 @@ export const upsertSearchSource = (options) => (options.client ?? client).post({
|
|
|
2762
930
|
}
|
|
2763
931
|
});
|
|
2764
932
|
/**
|
|
2765
|
-
*
|
|
933
|
+
* Delete a topic.
|
|
2766
934
|
*
|
|
2767
|
-
*
|
|
935
|
+
* Removes an event-bus topic by id or name.
|
|
2768
936
|
*/
|
|
2769
|
-
export const
|
|
937
|
+
export const deleteEventTopic = (options) => (options.client ?? client).delete({
|
|
2770
938
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2771
|
-
url: '/v1/
|
|
939
|
+
url: '/v1/events/topics/{id}',
|
|
2772
940
|
...options
|
|
2773
941
|
});
|
|
2774
942
|
/**
|
|
2775
|
-
* Get
|
|
943
|
+
* Get a topic.
|
|
2776
944
|
*
|
|
2777
|
-
* Returns
|
|
2778
|
-
* caller's project.
|
|
945
|
+
* Returns a single event-bus topic by id or name.
|
|
2779
946
|
*/
|
|
2780
|
-
export const
|
|
947
|
+
export const getEventTopic = (options) => (options.client ?? client).get({
|
|
2781
948
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2782
|
-
url: '/v1/
|
|
949
|
+
url: '/v1/events/topics/{id}',
|
|
2783
950
|
...options
|
|
2784
951
|
});
|
|
2785
952
|
/**
|
|
2786
|
-
*
|
|
2787
|
-
*
|
|
2788
|
-
* Replaces the Shield configuration for the caller's project. Requires the Pro
|
|
2789
|
-
* plan or higher.
|
|
2790
|
-
*/
|
|
2791
|
-
export const updateShieldConfig = (options) => (options.client ?? client).put({
|
|
2792
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2793
|
-
url: '/v1/shield/config',
|
|
2794
|
-
...options,
|
|
2795
|
-
headers: {
|
|
2796
|
-
'Content-Type': 'application/json',
|
|
2797
|
-
...options.headers
|
|
2798
|
-
}
|
|
2799
|
-
});
|
|
2800
|
-
/**
|
|
2801
|
-
* List Shield crawlers.
|
|
953
|
+
* List events on a topic.
|
|
2802
954
|
*
|
|
2803
|
-
* Returns the
|
|
2804
|
-
* stats, plus any custom user-defined crawler rules.
|
|
955
|
+
* Returns the recent events published to a topic.
|
|
2805
956
|
*/
|
|
2806
|
-
export const
|
|
957
|
+
export const listTopicEvents = (options) => (options.client ?? client).get({
|
|
2807
958
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2808
|
-
url: '/v1/
|
|
959
|
+
url: '/v1/events/topics/{id}/events',
|
|
2809
960
|
...options
|
|
2810
961
|
});
|
|
2811
962
|
/**
|
|
2812
|
-
*
|
|
963
|
+
* Publish an event.
|
|
2813
964
|
*
|
|
2814
|
-
*
|
|
2815
|
-
* Requires the Pro plan or higher.
|
|
965
|
+
* Publishes an event payload to a topic.
|
|
2816
966
|
*/
|
|
2817
|
-
export const
|
|
967
|
+
export const publishEvent = (options) => (options.client ?? client).post({
|
|
2818
968
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2819
|
-
url: '/v1/
|
|
969
|
+
url: '/v1/events/topics/{id}/publish',
|
|
2820
970
|
...options,
|
|
2821
971
|
headers: {
|
|
2822
972
|
'Content-Type': 'application/json',
|
|
@@ -2824,40 +974,23 @@ export const setShieldCrawlerIpRanges = (options) => (options.client ?? client).
|
|
|
2824
974
|
}
|
|
2825
975
|
});
|
|
2826
976
|
/**
|
|
2827
|
-
*
|
|
977
|
+
* List a topic's subscriptions.
|
|
2828
978
|
*
|
|
2829
|
-
*
|
|
2830
|
-
* Policy controls require the Pro plan or higher.
|
|
979
|
+
* Returns the subscriptions attached to a topic.
|
|
2831
980
|
*/
|
|
2832
|
-
export const
|
|
981
|
+
export const listTopicSubscriptions = (options) => (options.client ?? client).get({
|
|
2833
982
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2834
|
-
url: '/v1/
|
|
983
|
+
url: '/v1/events/topics/{id}/subscriptions',
|
|
2835
984
|
...options
|
|
2836
985
|
});
|
|
2837
986
|
/**
|
|
2838
|
-
*
|
|
2839
|
-
*
|
|
2840
|
-
* Sets the access policy (allow / block / rate-limit) for a known crawler in
|
|
2841
|
-
* the caller's project. Policy controls require the Pro plan or higher.
|
|
2842
|
-
*/
|
|
2843
|
-
export const setShieldCrawlerPolicy = (options) => (options.client ?? client).put({
|
|
2844
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2845
|
-
url: '/v1/shield/crawlers/{id}/policy',
|
|
2846
|
-
...options,
|
|
2847
|
-
headers: {
|
|
2848
|
-
'Content-Type': 'application/json',
|
|
2849
|
-
...options.headers
|
|
2850
|
-
}
|
|
2851
|
-
});
|
|
2852
|
-
/**
|
|
2853
|
-
* Create a custom Shield rule.
|
|
987
|
+
* Create a subscription.
|
|
2854
988
|
*
|
|
2855
|
-
*
|
|
2856
|
-
* its own access policy. Requires the Pro plan or higher.
|
|
989
|
+
* Creates a subscription that delivers a topic's events to an endpoint.
|
|
2857
990
|
*/
|
|
2858
|
-
export const
|
|
991
|
+
export const createEventSubscription = (options) => (options.client ?? client).post({
|
|
2859
992
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2860
|
-
url: '/v1/
|
|
993
|
+
url: '/v1/events/topics/{id}/subscriptions',
|
|
2861
994
|
...options,
|
|
2862
995
|
headers: {
|
|
2863
996
|
'Content-Type': 'application/json',
|
|
@@ -2865,24 +998,23 @@ export const createShieldCustomRule = (options) => (options.client ?? client).po
|
|
|
2865
998
|
}
|
|
2866
999
|
});
|
|
2867
1000
|
/**
|
|
2868
|
-
*
|
|
1001
|
+
* List functions.
|
|
2869
1002
|
*
|
|
2870
|
-
*
|
|
1003
|
+
* Returns all serverless functions for the caller's project.
|
|
2871
1004
|
*/
|
|
2872
|
-
export const
|
|
1005
|
+
export const listFunctions = (options) => (options?.client ?? client).get({
|
|
2873
1006
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2874
|
-
url: '/v1/
|
|
1007
|
+
url: '/v1/functions',
|
|
2875
1008
|
...options
|
|
2876
1009
|
});
|
|
2877
1010
|
/**
|
|
2878
|
-
*
|
|
1011
|
+
* Create a function.
|
|
2879
1012
|
*
|
|
2880
|
-
*
|
|
2881
|
-
* Pro plan or higher.
|
|
1013
|
+
* Deploys a serverless function and returns the created function.
|
|
2882
1014
|
*/
|
|
2883
|
-
export const
|
|
1015
|
+
export const createFunction = (options) => (options.client ?? client).post({
|
|
2884
1016
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2885
|
-
url: '/v1/
|
|
1017
|
+
url: '/v1/functions',
|
|
2886
1018
|
...options,
|
|
2887
1019
|
headers: {
|
|
2888
1020
|
'Content-Type': 'application/json',
|
|
@@ -2890,134 +1022,137 @@ export const updateShieldCustomRule = (options) => (options.client ?? client).pu
|
|
|
2890
1022
|
}
|
|
2891
1023
|
});
|
|
2892
1024
|
/**
|
|
2893
|
-
*
|
|
2894
|
-
*
|
|
2895
|
-
* Returns recent Shield crawler events for the project, paginated.
|
|
2896
|
-
*/
|
|
2897
|
-
export const listShieldEvents = (options) => (options?.client ?? client).get({
|
|
2898
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2899
|
-
url: '/v1/shield/events',
|
|
2900
|
-
...options
|
|
2901
|
-
});
|
|
2902
|
-
/**
|
|
2903
|
-
* Generate robots.txt.
|
|
2904
|
-
*
|
|
2905
|
-
* Returns a `robots.txt` generated from the project's Shield crawler policies.
|
|
1025
|
+
* Delete a function.
|
|
2906
1026
|
*
|
|
2907
|
-
*
|
|
2908
|
-
* An app that ships one has it served verbatim with these crawler rules
|
|
2909
|
-
* appended instead, so this is not necessarily the file a crawler receives.
|
|
2910
|
-
* You do not need to copy this into your project.
|
|
1027
|
+
* Removes a serverless function by id or name.
|
|
2911
1028
|
*/
|
|
2912
|
-
export const
|
|
1029
|
+
export const deleteFunction = (options) => (options.client ?? client).delete({
|
|
2913
1030
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2914
|
-
url: '/v1/
|
|
1031
|
+
url: '/v1/functions/{id}',
|
|
2915
1032
|
...options
|
|
2916
1033
|
});
|
|
2917
1034
|
/**
|
|
2918
|
-
* Get
|
|
1035
|
+
* Get a function.
|
|
2919
1036
|
*
|
|
2920
|
-
* Returns
|
|
2921
|
-
* crawler for the caller's project.
|
|
1037
|
+
* Returns a single serverless function by id or name.
|
|
2922
1038
|
*/
|
|
2923
|
-
export const
|
|
1039
|
+
export const getFunction = (options) => (options.client ?? client).get({
|
|
2924
1040
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2925
|
-
url: '/v1/
|
|
1041
|
+
url: '/v1/functions/{id}',
|
|
2926
1042
|
...options
|
|
2927
1043
|
});
|
|
2928
1044
|
/**
|
|
2929
|
-
*
|
|
1045
|
+
* Update a function.
|
|
2930
1046
|
*
|
|
2931
|
-
*
|
|
1047
|
+
* Redeploys a serverless function with a new configuration.
|
|
2932
1048
|
*/
|
|
2933
|
-
export const
|
|
1049
|
+
export const updateFunction = (options) => (options.client ?? client).put({
|
|
2934
1050
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2935
|
-
url: '/v1/
|
|
2936
|
-
...options
|
|
1051
|
+
url: '/v1/functions/{id}',
|
|
1052
|
+
...options,
|
|
1053
|
+
headers: {
|
|
1054
|
+
'Content-Type': 'application/json',
|
|
1055
|
+
...options.headers
|
|
1056
|
+
}
|
|
2937
1057
|
});
|
|
2938
1058
|
/**
|
|
2939
|
-
*
|
|
1059
|
+
* List function invocations.
|
|
2940
1060
|
*
|
|
2941
|
-
*
|
|
1061
|
+
* Returns the invocation history for a serverless function.
|
|
2942
1062
|
*/
|
|
2943
|
-
export const
|
|
1063
|
+
export const listFunctionInvocations = (options) => (options.client ?? client).get({
|
|
2944
1064
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2945
|
-
url: '/v1/
|
|
1065
|
+
url: '/v1/functions/{id}/invocations',
|
|
2946
1066
|
...options
|
|
2947
1067
|
});
|
|
2948
1068
|
/**
|
|
2949
|
-
*
|
|
1069
|
+
* Invoke a function.
|
|
2950
1070
|
*
|
|
2951
|
-
*
|
|
1071
|
+
* Invokes a serverless function with the supplied payload and returns its result.
|
|
2952
1072
|
*/
|
|
2953
|
-
export const
|
|
1073
|
+
export const invokeFunction = (options) => (options.client ?? client).post({
|
|
2954
1074
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2955
|
-
url: '/v1/
|
|
2956
|
-
...options
|
|
1075
|
+
url: '/v1/functions/{id}/invoke',
|
|
1076
|
+
...options,
|
|
1077
|
+
headers: {
|
|
1078
|
+
'Content-Type': 'application/json',
|
|
1079
|
+
...options.headers
|
|
1080
|
+
}
|
|
2957
1081
|
});
|
|
2958
1082
|
/**
|
|
2959
|
-
*
|
|
1083
|
+
* Get function logs.
|
|
2960
1084
|
*
|
|
2961
|
-
*
|
|
1085
|
+
* Returns log output for a serverless function.
|
|
2962
1086
|
*/
|
|
2963
|
-
export const
|
|
1087
|
+
export const getFunctionLogs = (options) => (options.client ?? client).get({
|
|
2964
1088
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2965
|
-
url: '/v1/
|
|
1089
|
+
url: '/v1/functions/{id}/logs',
|
|
2966
1090
|
...options
|
|
2967
1091
|
});
|
|
2968
1092
|
/**
|
|
2969
|
-
*
|
|
1093
|
+
* Delete keys.
|
|
2970
1094
|
*
|
|
2971
|
-
*
|
|
1095
|
+
* Removes one or more keys from the tenant's key-value store (batch delete).
|
|
2972
1096
|
*/
|
|
2973
|
-
export const
|
|
1097
|
+
export const kvDel = (options) => (options.client ?? client).post({
|
|
2974
1098
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2975
|
-
url: '/v1/
|
|
2976
|
-
...options
|
|
1099
|
+
url: '/v1/kv/del',
|
|
1100
|
+
...options,
|
|
1101
|
+
headers: {
|
|
1102
|
+
'Content-Type': 'application/json',
|
|
1103
|
+
...options.headers
|
|
1104
|
+
}
|
|
2977
1105
|
});
|
|
2978
1106
|
/**
|
|
2979
|
-
*
|
|
1107
|
+
* Check if a key exists.
|
|
2980
1108
|
*
|
|
2981
|
-
* Returns
|
|
1109
|
+
* Returns whether a key is present in the tenant's key-value store.
|
|
2982
1110
|
*/
|
|
2983
|
-
export const
|
|
1111
|
+
export const kvExists = (options) => (options.client ?? client).post({
|
|
2984
1112
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2985
|
-
url: '/v1/
|
|
2986
|
-
...options
|
|
1113
|
+
url: '/v1/kv/exists',
|
|
1114
|
+
...options,
|
|
1115
|
+
headers: {
|
|
1116
|
+
'Content-Type': 'application/json',
|
|
1117
|
+
...options.headers
|
|
1118
|
+
}
|
|
2987
1119
|
});
|
|
2988
1120
|
/**
|
|
2989
|
-
*
|
|
1121
|
+
* Fetch a value by key.
|
|
2990
1122
|
*
|
|
2991
|
-
*
|
|
1123
|
+
* Reads a single key from the tenant's key-value store; returns `value: null` if absent.
|
|
2992
1124
|
*/
|
|
2993
|
-
export const
|
|
2994
|
-
bodySerializer: null,
|
|
1125
|
+
export const kvGet = (options) => (options.client ?? client).post({
|
|
2995
1126
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2996
|
-
url: '/v1/
|
|
1127
|
+
url: '/v1/kv/get',
|
|
2997
1128
|
...options,
|
|
2998
1129
|
headers: {
|
|
2999
|
-
'Content-Type': 'application/
|
|
1130
|
+
'Content-Type': 'application/json',
|
|
3000
1131
|
...options.headers
|
|
3001
1132
|
}
|
|
3002
1133
|
});
|
|
3003
1134
|
/**
|
|
3004
|
-
*
|
|
1135
|
+
* List keys.
|
|
3005
1136
|
*
|
|
3006
|
-
*
|
|
1137
|
+
* Returns the keys in the tenant's key-value store matching an optional glob pattern.
|
|
3007
1138
|
*/
|
|
3008
|
-
export const
|
|
1139
|
+
export const kvKeys = (options) => (options.client ?? client).post({
|
|
3009
1140
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3010
|
-
url: '/v1/
|
|
3011
|
-
...options
|
|
1141
|
+
url: '/v1/kv/keys',
|
|
1142
|
+
...options,
|
|
1143
|
+
headers: {
|
|
1144
|
+
'Content-Type': 'application/json',
|
|
1145
|
+
...options.headers
|
|
1146
|
+
}
|
|
3012
1147
|
});
|
|
3013
1148
|
/**
|
|
3014
|
-
*
|
|
1149
|
+
* Set a value by key.
|
|
3015
1150
|
*
|
|
3016
|
-
*
|
|
1151
|
+
* Writes a value to the tenant's key-value store, with an optional TTL.
|
|
3017
1152
|
*/
|
|
3018
|
-
export const
|
|
1153
|
+
export const kvSet = (options) => (options.client ?? client).post({
|
|
3019
1154
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3020
|
-
url: '/v1/
|
|
1155
|
+
url: '/v1/kv/set',
|
|
3021
1156
|
...options,
|
|
3022
1157
|
headers: {
|
|
3023
1158
|
'Content-Type': 'application/json',
|
|
@@ -3025,79 +1160,73 @@ export const presignObject = (options) => (options.client ?? client).post({
|
|
|
3025
1160
|
}
|
|
3026
1161
|
});
|
|
3027
1162
|
/**
|
|
3028
|
-
* List
|
|
1163
|
+
* List the live region catalog.
|
|
3029
1164
|
*
|
|
3030
|
-
*
|
|
3031
|
-
*
|
|
1165
|
+
* Unauthenticated, read-only fleet topology: canonical region ids, status,
|
|
1166
|
+
* datacenter metadata (location, jurisdictions, ingress facts, service
|
|
1167
|
+
* capabilities) and aggregate node capacity. Backed by the `datacenters`
|
|
1168
|
+
* registry — onboarding a region is a DB insert, not a code change.
|
|
3032
1169
|
*/
|
|
3033
|
-
export const
|
|
3034
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3035
|
-
url: '/v1/usage/keys',
|
|
3036
|
-
...options
|
|
3037
|
-
});
|
|
1170
|
+
export const listRegions = (options) => (options?.client ?? client).get({ url: '/v1/regions', ...options });
|
|
3038
1171
|
/**
|
|
3039
|
-
*
|
|
3040
|
-
*
|
|
3041
|
-
* Returns the request count for a single API key this billing month. Requires
|
|
3042
|
-
* the `metering:read` scope; the key must belong to the caller's org.
|
|
1172
|
+
* List your sandboxes.
|
|
3043
1173
|
*/
|
|
3044
|
-
export const
|
|
1174
|
+
export const sandboxList = (options) => (options?.client ?? client).get({
|
|
3045
1175
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3046
|
-
url: '/v1/
|
|
1176
|
+
url: '/v1/sandboxes',
|
|
3047
1177
|
...options
|
|
3048
1178
|
});
|
|
3049
1179
|
/**
|
|
3050
|
-
*
|
|
1180
|
+
* Create an ephemeral sandbox.
|
|
3051
1181
|
*
|
|
3052
|
-
*
|
|
3053
|
-
*
|
|
1182
|
+
* Boots an isolated microVM. Ephemeral sandboxes are disposable: they stop
|
|
1183
|
+
* at their idle or hard timeout and nothing on the rootfs persists past
|
|
1184
|
+
* stop. Compute is billed per vCPU-hour and GiB-hour of allocation while
|
|
1185
|
+
* running.
|
|
3054
1186
|
*/
|
|
3055
|
-
export const
|
|
1187
|
+
export const sandboxCreate = (options) => (options.client ?? client).post({
|
|
3056
1188
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3057
|
-
url: '/v1/
|
|
3058
|
-
...options
|
|
1189
|
+
url: '/v1/sandboxes',
|
|
1190
|
+
...options,
|
|
1191
|
+
headers: {
|
|
1192
|
+
'Content-Type': 'application/json',
|
|
1193
|
+
...options.headers
|
|
1194
|
+
}
|
|
3059
1195
|
});
|
|
3060
1196
|
/**
|
|
3061
|
-
*
|
|
3062
|
-
*
|
|
3063
|
-
* Returns the authenticated user's id, email, name, plan, and status. Fields
|
|
3064
|
-
* after `status` are present only when a stored user record exists.
|
|
1197
|
+
* Delete a sandbox and tear down its microVM.
|
|
3065
1198
|
*/
|
|
3066
|
-
export const
|
|
1199
|
+
export const sandboxDelete = (options) => (options.client ?? client).delete({
|
|
3067
1200
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3068
|
-
url: '/v1/
|
|
1201
|
+
url: '/v1/sandboxes/{id}',
|
|
3069
1202
|
...options
|
|
3070
1203
|
});
|
|
3071
1204
|
/**
|
|
3072
|
-
* Get
|
|
3073
|
-
*
|
|
3074
|
-
* Returns a per-service usage breakdown (AI, storage, compute, bandwidth,
|
|
3075
|
-
* functions) for the current month.
|
|
1205
|
+
* Get a sandbox by id.
|
|
3076
1206
|
*/
|
|
3077
|
-
export const
|
|
1207
|
+
export const sandboxGet = (options) => (options.client ?? client).get({
|
|
3078
1208
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3079
|
-
url: '/v1/
|
|
1209
|
+
url: '/v1/sandboxes/{id}',
|
|
3080
1210
|
...options
|
|
3081
1211
|
});
|
|
3082
1212
|
/**
|
|
3083
|
-
*
|
|
3084
|
-
*
|
|
3085
|
-
* Returns all VPCs belonging to the caller's project.
|
|
1213
|
+
* Run a command inside a running sandbox (synchronous).
|
|
3086
1214
|
*/
|
|
3087
|
-
export const
|
|
1215
|
+
export const sandboxRunCommand = (options) => (options.client ?? client).post({
|
|
3088
1216
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3089
|
-
url: '/v1/
|
|
3090
|
-
...options
|
|
1217
|
+
url: '/v1/sandboxes/{id}/commands',
|
|
1218
|
+
...options,
|
|
1219
|
+
headers: {
|
|
1220
|
+
'Content-Type': 'application/json',
|
|
1221
|
+
...options.headers
|
|
1222
|
+
}
|
|
3091
1223
|
});
|
|
3092
1224
|
/**
|
|
3093
|
-
*
|
|
3094
|
-
*
|
|
3095
|
-
* Provisions a VPC for the caller's project. Currently returns 501 —
|
|
3096
|
-
* enforcement and durable storage are a planned capability.
|
|
1225
|
+
* Extend a sandbox's hard deadline.
|
|
3097
1226
|
*/
|
|
3098
|
-
export const
|
|
1227
|
+
export const sandboxExtend = (options) => (options.client ?? client).post({
|
|
3099
1228
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3100
|
-
url: '/v1/
|
|
1229
|
+
url: '/v1/sandboxes/{id}/extend',
|
|
3101
1230
|
...options,
|
|
3102
1231
|
headers: {
|
|
3103
1232
|
'Content-Type': 'application/json',
|
|
@@ -3105,122 +1234,119 @@ export const createVpc = (options) => (options.client ?? client).post({
|
|
|
3105
1234
|
}
|
|
3106
1235
|
});
|
|
3107
1236
|
/**
|
|
3108
|
-
*
|
|
3109
|
-
*
|
|
3110
|
-
* Removes a VPC and its peers by id.
|
|
1237
|
+
* Write files into a sandbox.
|
|
3111
1238
|
*/
|
|
3112
|
-
export const
|
|
1239
|
+
export const sandboxWriteFiles = (options) => (options.client ?? client).post({
|
|
3113
1240
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3114
|
-
url: '/v1/
|
|
3115
|
-
...options
|
|
1241
|
+
url: '/v1/sandboxes/{id}/files',
|
|
1242
|
+
...options,
|
|
1243
|
+
headers: {
|
|
1244
|
+
'Content-Type': 'application/json',
|
|
1245
|
+
...options.headers
|
|
1246
|
+
}
|
|
3116
1247
|
});
|
|
3117
1248
|
/**
|
|
3118
|
-
*
|
|
3119
|
-
*
|
|
3120
|
-
* Returns a single VPC by id.
|
|
1249
|
+
* Read a file from a sandbox. The guest path follows `/files/`.
|
|
3121
1250
|
*/
|
|
3122
|
-
export const
|
|
1251
|
+
export const sandboxReadFile = (options) => (options.client ?? client).get({
|
|
3123
1252
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3124
|
-
url: '/v1/
|
|
1253
|
+
url: '/v1/sandboxes/{id}/files/{path}',
|
|
3125
1254
|
...options
|
|
3126
1255
|
});
|
|
3127
1256
|
/**
|
|
3128
|
-
*
|
|
1257
|
+
* Snapshot a sandbox - not available.
|
|
3129
1258
|
*
|
|
3130
|
-
*
|
|
1259
|
+
* Ephemeral sandboxes are disposable; state does not persist past stop.
|
|
1260
|
+
* This endpoint returns 501 until snapshots ship (demand-gated).
|
|
3131
1261
|
*/
|
|
3132
|
-
export const
|
|
1262
|
+
export const sandboxSnapshot = (options) => (options.client ?? client).post({
|
|
3133
1263
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3134
|
-
url: '/v1/
|
|
1264
|
+
url: '/v1/sandboxes/{id}/snapshot',
|
|
3135
1265
|
...options
|
|
3136
1266
|
});
|
|
3137
1267
|
/**
|
|
3138
|
-
* List
|
|
1268
|
+
* List buckets.
|
|
3139
1269
|
*
|
|
3140
|
-
* Returns all
|
|
1270
|
+
* Returns all storage buckets for the caller's project.
|
|
3141
1271
|
*/
|
|
3142
|
-
export const
|
|
1272
|
+
export const listBuckets = (options) => (options?.client ?? client).get({
|
|
3143
1273
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3144
|
-
url: '/v1/
|
|
1274
|
+
url: '/v1/storage/buckets',
|
|
3145
1275
|
...options
|
|
3146
1276
|
});
|
|
3147
1277
|
/**
|
|
3148
|
-
*
|
|
1278
|
+
* Create a bucket.
|
|
3149
1279
|
*
|
|
3150
|
-
*
|
|
3151
|
-
* enforcement and durable storage are a planned capability.
|
|
1280
|
+
* Creates a new storage bucket.
|
|
3152
1281
|
*/
|
|
3153
|
-
export const
|
|
1282
|
+
export const createBucket = (options) => (options?.client ?? client).post({
|
|
3154
1283
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3155
|
-
url: '/v1/
|
|
3156
|
-
...options
|
|
3157
|
-
headers: {
|
|
3158
|
-
'Content-Type': 'application/json',
|
|
3159
|
-
...options.headers
|
|
3160
|
-
}
|
|
1284
|
+
url: '/v1/storage/buckets',
|
|
1285
|
+
...options
|
|
3161
1286
|
});
|
|
3162
1287
|
/**
|
|
3163
|
-
*
|
|
1288
|
+
* List objects.
|
|
3164
1289
|
*
|
|
3165
|
-
*
|
|
1290
|
+
* Returns the objects in a bucket, optionally filtered by key prefix.
|
|
3166
1291
|
*/
|
|
3167
|
-
export const
|
|
1292
|
+
export const listObjects = (options) => (options.client ?? client).get({
|
|
3168
1293
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3169
|
-
url: '/v1/
|
|
1294
|
+
url: '/v1/storage/buckets/{bucket}/objects',
|
|
3170
1295
|
...options
|
|
3171
1296
|
});
|
|
3172
1297
|
/**
|
|
3173
|
-
*
|
|
1298
|
+
* Delete an object.
|
|
3174
1299
|
*
|
|
3175
|
-
*
|
|
1300
|
+
* Removes an object from a bucket.
|
|
3176
1301
|
*/
|
|
3177
|
-
export const
|
|
1302
|
+
export const deleteObject = (options) => (options.client ?? client).delete({
|
|
3178
1303
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3179
|
-
url: '/v1/
|
|
1304
|
+
url: '/v1/storage/buckets/{bucket}/objects/{key}',
|
|
3180
1305
|
...options
|
|
3181
1306
|
});
|
|
3182
1307
|
/**
|
|
3183
|
-
*
|
|
1308
|
+
* Get an object.
|
|
3184
1309
|
*
|
|
3185
|
-
*
|
|
1310
|
+
* Downloads the contents of an object from a bucket.
|
|
3186
1311
|
*/
|
|
3187
|
-
export const
|
|
1312
|
+
export const getObject = (options) => (options.client ?? client).get({
|
|
3188
1313
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3189
|
-
url: '/v1/
|
|
1314
|
+
url: '/v1/storage/buckets/{bucket}/objects/{key}',
|
|
3190
1315
|
...options
|
|
3191
1316
|
});
|
|
3192
1317
|
/**
|
|
3193
|
-
*
|
|
1318
|
+
* Upload an object.
|
|
3194
1319
|
*
|
|
3195
|
-
*
|
|
1320
|
+
* Stores raw bytes as an object in a bucket.
|
|
3196
1321
|
*/
|
|
3197
|
-
export const
|
|
1322
|
+
export const putObject = (options) => (options.client ?? client).put({
|
|
1323
|
+
bodySerializer: null,
|
|
3198
1324
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3199
|
-
url: '/v1/
|
|
1325
|
+
url: '/v1/storage/buckets/{bucket}/objects/{key}',
|
|
3200
1326
|
...options,
|
|
3201
1327
|
headers: {
|
|
3202
|
-
'Content-Type': 'application/
|
|
1328
|
+
'Content-Type': 'application/octet-stream',
|
|
3203
1329
|
...options.headers
|
|
3204
1330
|
}
|
|
3205
1331
|
});
|
|
3206
1332
|
/**
|
|
3207
|
-
* Delete a
|
|
1333
|
+
* Delete a bucket.
|
|
3208
1334
|
*
|
|
3209
|
-
* Removes a
|
|
1335
|
+
* Removes a storage bucket by name.
|
|
3210
1336
|
*/
|
|
3211
|
-
export const
|
|
1337
|
+
export const deleteBucket = (options) => (options.client ?? client).delete({
|
|
3212
1338
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3213
|
-
url: '/v1/
|
|
1339
|
+
url: '/v1/storage/buckets/{name}',
|
|
3214
1340
|
...options
|
|
3215
1341
|
});
|
|
3216
1342
|
/**
|
|
3217
|
-
*
|
|
1343
|
+
* Presign an object URL.
|
|
3218
1344
|
*
|
|
3219
|
-
*
|
|
1345
|
+
* Returns a presigned URL for direct upload or download of an object.
|
|
3220
1346
|
*/
|
|
3221
|
-
export const
|
|
1347
|
+
export const presignObject = (options) => (options.client ?? client).post({
|
|
3222
1348
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3223
|
-
url: '/v1/
|
|
1349
|
+
url: '/v1/storage/presign',
|
|
3224
1350
|
...options,
|
|
3225
1351
|
headers: {
|
|
3226
1352
|
'Content-Type': 'application/json',
|
|
@@ -3228,13 +1354,21 @@ export const updateWafRule = (options) => (options.client ?? client).put({
|
|
|
3228
1354
|
}
|
|
3229
1355
|
});
|
|
3230
1356
|
/**
|
|
3231
|
-
*
|
|
1357
|
+
* List the org's API keys with their IAM-tracked metadata.
|
|
3232
1358
|
*
|
|
3233
|
-
*
|
|
1359
|
+
* XW-63: this is METADATA-ONLY — it returns each of the organization's API keys
|
|
1360
|
+
* with the authoritative metadata IAM holds (id, name, non-secret prefix,
|
|
1361
|
+
* `last_used_at`). Per-key *request counts* are NOT tracked: metering is keyed
|
|
1362
|
+
* by org/project (see docs/IDENTITY.md), not by individual key, so there is no
|
|
1363
|
+
* honest per-key total to return. The previous OpenAPI summary claimed
|
|
1364
|
+
* "per-API-key request counts for the current month" while the body carried no
|
|
1365
|
+
* counts — the description is corrected to match what is actually served.
|
|
1366
|
+
* Response fields are unchanged (published surface). Org/project usage totals
|
|
1367
|
+
* live at `/v1/usage/{id}`. Requires the `metering:read` scope.
|
|
3234
1368
|
*/
|
|
3235
|
-
export const
|
|
1369
|
+
export const getKeysUsage = (options) => (options?.client ?? client).get({
|
|
3236
1370
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3237
|
-
url: '/v1/
|
|
1371
|
+
url: '/v1/usage/keys',
|
|
3238
1372
|
...options
|
|
3239
1373
|
});
|
|
3240
1374
|
//# sourceMappingURL=sdk.gen.js.map
|