@scalix-world/sdk 1.3.5 → 1.4.1

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.
@@ -1,11 +1,12 @@
1
1
  "use strict";
2
2
  // This file is auto-generated by @hey-api/openapi-ts
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.listModels = exports.generateImage = exports.createEmbeddings = exports.listDocgenVersions = exports.listDocgenTemplates = exports.getDocgenStatus = exports.reviseDocgen = exports.previewDocgen = exports.getDocgenHistory = exports.listDocgenFormats = exports.downloadDocgen = exports.createDocgen = exports.streamChatCompletion = exports.chatCompletion = exports.transcribeAudio = exports.generateSpeech = exports.readyz = exports.getOpenapiSpec = exports.healthz = exports.getUsageSummary = exports.registerWebhook = exports.listWebhooks = exports.upsertVectors = exports.searchVectors = exports.createVectorCollection = exports.listVectorCollections = exports.batchUpsertVectors = exports.realtimeWebsocket = exports.subscribeRealtime = exports.restorePitr = exports.getMigrationPlan = exports.registerMigration = exports.batchSql = exports.executeSql = exports.getServicesStatus = exports.getTableSchema = exports.getSchemaRelationships = exports.listPiiColumns = exports.searchSchemaColumns = exports.getSchema = exports.getScalingSuggestions = exports.listQueryLogs = exports.optimizeQuery = exports.naturalLanguageToSql = exports.callMcpTool = exports.listMcpTools = exports.rotateEncryptionKey = exports.encryptData = exports.decryptData = exports.detectAnomalies = void 0;
5
- exports.getBuildLogs = exports.cancelBuild = exports.getBuild = exports.createBuild = exports.listBuilds = exports.verifyEmail = exports.exportAuthUser = exports.recordAuthUserConsent = exports.listAuthUserConsent = exports.updateAuthUser = exports.getAuthUser = exports.signUp = exports.revokeSession = exports.listSessions = exports.resendVerification = exports.refreshToken = exports.resetPassword = exports.requestPasswordReset = exports.verifyOtp = exports.sendOtp = exports.oauthCallback = exports.authorizeOauth = exports.verifyMfa = exports.deleteMfaFactor = exports.listMfaFactors = exports.enrollMfa = exports.challengeMfa = exports.listUserOrgs = exports.verifyMagicLink = exports.sendMagicLink = exports.logout = exports.login = exports.linkIdentity = exports.signUpAnonymous = exports.textVectorSearch = exports.translateText = exports.summarizeText = exports.analyzeSentiment = exports.checkGrammar = exports.autocompleteText = exports.getResearchStatus = exports.searchResearch = exports.runDeepResearch = exports.runResearch = exports.uploadRagDocument = exports.getRagStatus = exports.queryRag = exports.deleteRagDocument = exports.listRagDocuments = exports.getAiProvidersStatus = void 0;
6
- exports.updateFunction = exports.getFunction = exports.deleteFunction = exports.createFunction = exports.listFunctions = exports.createEventSubscription = exports.listTopicSubscriptions = exports.publishEvent = exports.listTopicEvents = exports.getEventTopic = exports.deleteEventTopic = exports.createEventTopic = exports.listEventTopics = exports.listSubscriptionDeliveries = exports.getEventSubscription = exports.deleteEventSubscription = exports.deleteEnvVar = exports.bulkImportEnvVars = exports.setEnvVar = exports.listEnvVars = exports.verifyDomain = exports.provisionDomainSsl = exports.getDomain = exports.deleteDomain = exports.addDomain = exports.listDomains = exports.triggerCronSchedule = exports.listCronExecutions = exports.updateCronSchedule = exports.getCronSchedule = exports.deleteCronSchedule = exports.createCronSchedule = exports.listCronSchedules = exports.listDeploymentVersions = exports.scaleDeployment = exports.rollbackDeployment = exports.restartDeployment = exports.getDeploymentLogs = exports.listDeploymentInstances = exports.getDeployment = exports.deleteDeployment = exports.createDeployment = exports.listDeployments = exports.getComplianceStatus = exports.updateGdprRequestStatus = exports.getGdprRequest = exports.createGdprRequest = exports.listGdprRequests = exports.exportAuditLog = exports.queryAuditLog = void 0;
7
- exports.listShieldCrawlers = exports.updateShieldConfig = exports.getShieldConfig = exports.getSearchStats = exports.upsertSearchSource = exports.listSearchSources = exports.runSearchIngest = exports.searchIndex = exports.rollbackService = exports.listServiceRevisions = exports.getServiceMetrics = exports.listServiceInstances = exports.updateService = exports.getService = exports.deleteService = exports.createService = exports.listServices = exports.listRegistryTags = exports.putRegistryManifest = exports.headRegistryManifest = exports.getRegistryManifest = exports.deleteRegistryManifest = exports.headRegistryBlob = exports.getRegistryBlob = exports.startRegistryBlobUpload = exports.getRegistryCatalog = exports.registryVersionCheck = exports.getMe = exports.removeLoadBalancerBackend = exports.addLoadBalancerBackend = exports.getLoadBalancer = exports.deleteLoadBalancer = exports.createLoadBalancer = exports.listLoadBalancers = exports.kvSet = exports.kvKeys = exports.kvGet = exports.kvExists = exports.kvDel = exports.updateIntegration = exports.getIntegration = exports.deleteIntegration = exports.listGithubRepos = exports.createGithubInstallationToken = exports.listGithubInstallations = exports.createIntegration = exports.listIntegrations = exports.getFunctionLogs = exports.invokeFunction = exports.listFunctionInvocations = void 0;
8
- exports.getWafStats = exports.updateWafRule = exports.deleteWafRule = exports.createWafRule = exports.listWafRules = exports.listWafEvents = exports.removeVpcPeer = exports.addVpcPeer = exports.listVpcPeers = exports.getVpcConfig = exports.getVpc = exports.deleteVpc = exports.createVpc = exports.listVpcs = exports.getUserStats = exports.getUserInfo = exports.getUserBudget = exports.getKeyUsage = exports.getKeysUsage = exports.presignObject = exports.deleteBucket = exports.putObject = exports.headObject = exports.getObject = exports.deleteObject = exports.listObjects = exports.createBucket = exports.listBuckets = exports.getShieldStats = exports.getShieldRobotsTxt = exports.listShieldEvents = exports.updateShieldCustomRule = exports.deleteShieldCustomRule = exports.createShieldCustomRule = exports.setShieldCrawlerPolicy = exports.clearShieldCrawlerPolicy = exports.setShieldCrawlerIpRanges = void 0;
4
+ exports.generateImage = exports.createEmbeddings = exports.listDocgenVersions = exports.listDocgenTemplates = exports.getDocgenStatus = exports.reviseDocgen = exports.previewDocgen = exports.getDocgenHistory = exports.listDocgenFormats = exports.downloadDocgen = exports.createDocgen = exports.streamChatCompletion = exports.chatCompletion = exports.transcribeAudio = exports.generateSpeech = exports.readyz = exports.getOpenapiSpec = exports.healthz = exports.getUsageSummary = exports.registerWebhook = exports.listWebhooks = exports.upsertVectors = exports.searchVectors = exports.createVectorCollection = exports.listVectorCollections = exports.batchUpsertVectors = exports.branchTimeline = exports.realtimeWebsocket = exports.subscribeRealtime = exports.restorePitr = exports.getMigrationPlan = exports.registerMigration = exports.batchSql = exports.executeSql = exports.getServicesStatus = exports.getTableSchema = exports.getSchemaRelationships = exports.listPiiColumns = exports.searchSchemaColumns = exports.getSchema = exports.getScalingSuggestions = exports.listQueryLogs = exports.optimizeQuery = exports.naturalLanguageToSql = exports.callMcpTool = exports.listMcpTools = exports.rotateEncryptionKey = exports.encryptData = exports.decryptData = exports.detectAnomalies = void 0;
5
+ exports.getBuild = exports.uploadBuild = exports.createBuild = exports.listBuilds = exports.verifyEmail = exports.exportAuthUser = exports.recordAuthUserConsent = exports.listAuthUserConsent = exports.updateAuthUser = exports.getAuthUser = exports.signUp = exports.revokeSession = exports.listSessions = exports.resendVerification = exports.refreshToken = exports.resetPassword = exports.requestPasswordReset = exports.verifyOtp = exports.sendOtp = exports.oauthCallback = exports.authorizeOauth = exports.verifyMfa = exports.deleteMfaFactor = exports.listMfaFactors = exports.enrollMfa = exports.challengeMfa = exports.listUserOrgs = exports.verifyMagicLink = exports.sendMagicLink = exports.logout = exports.login = exports.linkIdentity = exports.signUpAnonymous = exports.textVectorSearch = exports.translateText = exports.summarizeText = exports.analyzeSentiment = exports.checkGrammar = exports.autocompleteText = exports.getResearchStatus = exports.searchResearch = exports.runDeepResearch = exports.runResearch = exports.uploadRagDocument = exports.getRagStatus = exports.queryRag = exports.deleteRagDocument = exports.listRagDocuments = exports.getAiProvidersStatus = exports.listModels = void 0;
6
+ exports.getEmailCampaignAnalytics = exports.verifyDomain = exports.provisionDomainSsl = exports.getDomain = exports.deleteDomain = exports.addDomain = exports.listDomains = exports.restoreDatabase = exports.getDatabase = exports.deleteDatabase = exports.provisionDatabase = exports.createDatabase = exports.listDatabases = exports.triggerCronSchedule = exports.listCronExecutions = exports.updateCronSchedule = exports.getCronSchedule = exports.deleteCronSchedule = exports.createCronSchedule = exports.listCronSchedules = exports.computerStop = exports.computerStart = exports.computerSetSshKeys = exports.computerWriteFiles = exports.computerReadFile = exports.computerExec = exports.computerGet = exports.computerDelete = exports.computerGetOrCreateByName = exports.computerCreate = exports.computerList = exports.listDeploymentVersions = exports.scaleDeployment = exports.rollbackDeployment = exports.restartDeployment = exports.getDeploymentLogs = exports.listDeploymentInstances = exports.getDeployment = exports.deleteDeployment = exports.createDeployment = exports.listDeployments = exports.getComplianceStatus = exports.updateGdprRequestStatus = exports.getGdprRequest = exports.createGdprRequest = exports.listGdprRequests = exports.exportAuditLog = exports.queryAuditLog = exports.getBuildLogs = exports.cancelBuild = void 0;
7
+ exports.kvGet = exports.kvExists = exports.kvDel = exports.updateIntegration = exports.getIntegration = exports.deleteIntegration = exports.listGithubRepos = exports.createGithubInstallationToken = exports.listGithubInstallations = exports.createIntegration = exports.listIntegrations = exports.getFunctionLogs = exports.invokeFunction = exports.listFunctionInvocations = exports.updateFunction = exports.getFunction = exports.deleteFunction = exports.createFunction = exports.listFunctions = exports.createEventSubscription = exports.listTopicSubscriptions = exports.publishEvent = exports.listTopicEvents = exports.getEventTopic = exports.deleteEventTopic = exports.createEventTopic = exports.listEventTopics = exports.listSubscriptionDeliveries = exports.getEventSubscription = exports.deleteEventSubscription = exports.deleteEnvVar = exports.bulkImportEnvVars = exports.setEnvVar = exports.listEnvVars = exports.updateEmailTemplate = exports.deleteEmailTemplate = exports.createEmailTemplate = exports.listEmailTemplates = exports.listEmailSuppression = exports.getEmailStats = exports.updateEmailSettings = exports.getEmailSettings = exports.sendTransactionalEmail = exports.sendRawEmail = exports.listEmailEvents = exports.verifyEmailDomain = exports.deleteEmailDomain = exports.addEmailDomain = exports.listEmailDomains = exports.getEmailAnalyticsSummary = void 0;
8
+ exports.deleteShieldCustomRule = exports.createShieldCustomRule = exports.setShieldCrawlerPolicy = exports.clearShieldCrawlerPolicy = exports.setShieldCrawlerIpRanges = exports.listShieldCrawlers = exports.updateShieldConfig = exports.getShieldConfig = exports.getSearchStats = exports.upsertSearchSource = exports.listSearchSources = exports.runSearchIngest = exports.searchIndex = exports.sandboxSnapshot = exports.sandboxReadFile = exports.sandboxWriteFiles = exports.sandboxExtend = exports.sandboxRunCommand = exports.sandboxGet = exports.sandboxDelete = exports.sandboxCreate = exports.sandboxList = exports.rollbackService = exports.listServiceRevisions = exports.getServiceMetrics = exports.listServiceInstances = exports.updateService = exports.getService = exports.deleteService = exports.createService = exports.listServices = exports.listRegistryTags = exports.putRegistryManifest = exports.headRegistryManifest = exports.getRegistryManifest = exports.deleteRegistryManifest = exports.headRegistryBlob = exports.getRegistryBlob = exports.startRegistryBlobUpload = exports.getRegistryCatalog = exports.registryVersionCheck = exports.getMe = exports.removeLoadBalancerBackend = exports.addLoadBalancerBackend = exports.getLoadBalancer = exports.deleteLoadBalancer = exports.createLoadBalancer = exports.listLoadBalancers = exports.kvSet = exports.kvKeys = void 0;
9
+ exports.getWafStats = exports.updateWafRule = exports.deleteWafRule = exports.createWafRule = exports.listWafRules = exports.listWafEvents = exports.removeVpcPeer = exports.addVpcPeer = exports.listVpcPeers = exports.getVpcConfig = exports.getVpc = exports.deleteVpc = exports.createVpc = exports.listVpcs = exports.getUserStats = exports.getUserInfo = exports.getUserBudget = exports.getKeyUsage = exports.getKeysUsage = exports.presignObject = exports.deleteBucket = exports.putObject = exports.headObject = exports.getObject = exports.deleteObject = exports.listObjects = exports.createBucket = exports.listBuckets = exports.getShieldStats = exports.getShieldRobotsTxt = exports.listShieldEvents = exports.updateShieldCustomRule = void 0;
9
10
  const client_gen_js_1 = require("./client.gen.js");
10
11
  const index_js_1 = require("./client/index.js");
11
12
  /**
@@ -269,6 +270,23 @@ const realtimeWebsocket = (options) => (options.client ?? client_gen_js_1.client
269
270
  ...options
270
271
  });
271
272
  exports.realtimeWebsocket = realtimeWebsocket;
273
+ /**
274
+ * Branch a timeline.
275
+ *
276
+ * Restores the parent timeline's durable base backup + archived WAL into a
277
+ * NEW compute worker replayed to `branch_lsn` (`0` = latest), then routes the
278
+ * branch endpoint. The branch archives onto its own timeline from that point.
279
+ */
280
+ const branchTimeline = (options) => (options.client ?? client_gen_js_1.client).post({
281
+ security: [{ scheme: 'bearer', type: 'http' }],
282
+ url: '/api/v1/tenants/{tenant_id}/timelines/{timeline_id}/branch',
283
+ ...options,
284
+ headers: {
285
+ 'Content-Type': 'application/json',
286
+ ...options.headers
287
+ }
288
+ });
289
+ exports.branchTimeline = branchTimeline;
272
290
  /**
273
291
  * Batch upsert vectors.
274
292
  *
@@ -1178,6 +1196,9 @@ exports.listBuilds = listBuilds;
1178
1196
  * Start a build.
1179
1197
  *
1180
1198
  * Starts a container image build and returns the build record.
1199
+ *
1200
+ * For a private repository, either install the Scalix GitHub App for the
1201
+ * project (builds then authenticate themselves) or pass `auth_token`.
1181
1202
  */
1182
1203
  const createBuild = (options) => (options.client ?? client_gen_js_1.client).post({
1183
1204
  security: [{ scheme: 'bearer', type: 'http' }],
@@ -1189,6 +1210,24 @@ const createBuild = (options) => (options.client ?? client_gen_js_1.client).post
1189
1210
  }
1190
1211
  });
1191
1212
  exports.createBuild = createBuild;
1213
+ /**
1214
+ * Upload source and build.
1215
+ *
1216
+ * Builds from an uploaded source tree instead of a URL, so the source never
1217
+ * has to be reachable from the internet. The request body IS the gzipped
1218
+ * tarball (`Content-Type: application/gzip`); metadata goes in the query
1219
+ * string. Multipart is not accepted.
1220
+ */
1221
+ const uploadBuild = (options) => (options.client ?? client_gen_js_1.client).post({
1222
+ security: [{ scheme: 'bearer', type: 'http' }],
1223
+ url: '/v1/build/upload',
1224
+ ...options,
1225
+ headers: {
1226
+ 'Content-Type': 'application/gzip',
1227
+ ...options.headers
1228
+ }
1229
+ });
1230
+ exports.uploadBuild = uploadBuild;
1192
1231
  /**
1193
1232
  * Get a build.
1194
1233
  *
@@ -1439,6 +1478,149 @@ const listDeploymentVersions = (options) => (options.client ?? client_gen_js_1.c
1439
1478
  ...options
1440
1479
  });
1441
1480
  exports.listDeploymentVersions = listDeploymentVersions;
1481
+ /**
1482
+ * List your Computers.
1483
+ */
1484
+ const computerList = (options) => (options?.client ?? client_gen_js_1.client).get({
1485
+ security: [{ scheme: 'bearer', type: 'http' }],
1486
+ url: '/v1/computers',
1487
+ ...options
1488
+ });
1489
+ exports.computerList = computerList;
1490
+ /**
1491
+ * Create a Computer.
1492
+ *
1493
+ * Boots a persistent Linux machine and returns once it is provisioning. The
1494
+ * root disk survives stop/start and is only reclaimed by DELETE. Billed per
1495
+ * start, per vCPU-hour and GB-hour while running, and per GB-month of disk
1496
+ * for as long as the Computer exists.
1497
+ */
1498
+ const computerCreate = (options) => (options.client ?? client_gen_js_1.client).post({
1499
+ security: [{ scheme: 'bearer', type: 'http' }],
1500
+ url: '/v1/computers',
1501
+ ...options,
1502
+ headers: {
1503
+ 'Content-Type': 'application/json',
1504
+ ...options.headers
1505
+ }
1506
+ });
1507
+ exports.computerCreate = computerCreate;
1508
+ /**
1509
+ * Get or create a Computer by name.
1510
+ *
1511
+ * Idempotent: the first call creates the machine (201), every identical
1512
+ * repeat returns the existing one (200). Resource changes on a repeat are
1513
+ * ignored — the existing machine wins. Use this instead of create when an
1514
+ * agent may retry.
1515
+ */
1516
+ const computerGetOrCreateByName = (options) => (options.client ?? client_gen_js_1.client).put({
1517
+ security: [{ scheme: 'bearer', type: 'http' }],
1518
+ url: '/v1/computers/by-name/{name}',
1519
+ ...options,
1520
+ headers: {
1521
+ 'Content-Type': 'application/json',
1522
+ ...options.headers
1523
+ }
1524
+ });
1525
+ exports.computerGetOrCreateByName = computerGetOrCreateByName;
1526
+ /**
1527
+ * Delete a Computer.
1528
+ *
1529
+ * The only operation that reclaims the root disk. Irreversible — stop the
1530
+ * Computer instead if you want the files back later.
1531
+ */
1532
+ const computerDelete = (options) => (options.client ?? client_gen_js_1.client).delete({
1533
+ security: [{ scheme: 'bearer', type: 'http' }],
1534
+ url: '/v1/computers/{id}',
1535
+ ...options
1536
+ });
1537
+ exports.computerDelete = computerDelete;
1538
+ /**
1539
+ * Get one Computer.
1540
+ */
1541
+ const computerGet = (options) => (options.client ?? client_gen_js_1.client).get({
1542
+ security: [{ scheme: 'bearer', type: 'http' }],
1543
+ url: '/v1/computers/{id}',
1544
+ ...options
1545
+ });
1546
+ exports.computerGet = computerGet;
1547
+ /**
1548
+ * Run a command inside a Computer.
1549
+ */
1550
+ const computerExec = (options) => (options.client ?? client_gen_js_1.client).post({
1551
+ security: [{ scheme: 'bearer', type: 'http' }],
1552
+ url: '/v1/computers/{id}/exec',
1553
+ ...options,
1554
+ headers: {
1555
+ 'Content-Type': 'application/json',
1556
+ ...options.headers
1557
+ }
1558
+ });
1559
+ exports.computerExec = computerExec;
1560
+ /**
1561
+ * Read one file out of a Computer.
1562
+ */
1563
+ const computerReadFile = (options) => (options.client ?? client_gen_js_1.client).get({
1564
+ security: [{ scheme: 'bearer', type: 'http' }],
1565
+ url: '/v1/computers/{id}/files',
1566
+ ...options
1567
+ });
1568
+ exports.computerReadFile = computerReadFile;
1569
+ /**
1570
+ * Write files into a Computer.
1571
+ */
1572
+ const computerWriteFiles = (options) => (options.client ?? client_gen_js_1.client).put({
1573
+ security: [{ scheme: 'bearer', type: 'http' }],
1574
+ url: '/v1/computers/{id}/files',
1575
+ ...options,
1576
+ headers: {
1577
+ 'Content-Type': 'application/json',
1578
+ ...options.headers
1579
+ }
1580
+ });
1581
+ exports.computerWriteFiles = computerWriteFiles;
1582
+ /**
1583
+ * Replace a Computer's authorised ssh keys.
1584
+ *
1585
+ * Sends the whole list every time, so removing a key is the same operation as
1586
+ * adding one. On a RUNNING machine the change applies immediately — a
1587
+ * revoked key stops working now, not at the next restart. On a stopped
1588
+ * machine it is stored and delivered when it next boots.
1589
+ */
1590
+ const computerSetSshKeys = (options) => (options.client ?? client_gen_js_1.client).put({
1591
+ security: [{ scheme: 'bearer', type: 'http' }],
1592
+ url: '/v1/computers/{id}/ssh-keys',
1593
+ ...options,
1594
+ headers: {
1595
+ 'Content-Type': 'application/json',
1596
+ ...options.headers
1597
+ }
1598
+ });
1599
+ exports.computerSetSshKeys = computerSetSshKeys;
1600
+ /**
1601
+ * Start a stopped Computer.
1602
+ *
1603
+ * Boots the same disk on the same host and reclaims the same address.
1604
+ */
1605
+ const computerStart = (options) => (options.client ?? client_gen_js_1.client).post({
1606
+ security: [{ scheme: 'bearer', type: 'http' }],
1607
+ url: '/v1/computers/{id}/start',
1608
+ ...options
1609
+ });
1610
+ exports.computerStart = computerStart;
1611
+ /**
1612
+ * Stop a Computer.
1613
+ *
1614
+ * Halts the machine. The root disk and the network address are kept, so a
1615
+ * later start comes back to the same files at the same address. Runtime
1616
+ * billing stops; disk billing continues at the parked rate.
1617
+ */
1618
+ const computerStop = (options) => (options.client ?? client_gen_js_1.client).post({
1619
+ security: [{ scheme: 'bearer', type: 'http' }],
1620
+ url: '/v1/computers/{id}/stop',
1621
+ ...options
1622
+ });
1623
+ exports.computerStop = computerStop;
1442
1624
  /**
1443
1625
  * List cron schedules.
1444
1626
  *
@@ -1524,6 +1706,83 @@ const triggerCronSchedule = (options) => (options.client ?? client_gen_js_1.clie
1524
1706
  ...options
1525
1707
  });
1526
1708
  exports.triggerCronSchedule = triggerCronSchedule;
1709
+ /**
1710
+ * List databases.
1711
+ *
1712
+ * Lists the project's databases. `include_deleted=true` also returns
1713
+ * soft-deleted databases still inside the recovery grace window.
1714
+ */
1715
+ const listDatabases = (options) => (options?.client ?? client_gen_js_1.client).get({
1716
+ security: [{ scheme: 'bearer', type: 'http' }],
1717
+ url: '/v1/databases',
1718
+ ...options
1719
+ });
1720
+ exports.listDatabases = listDatabases;
1721
+ /**
1722
+ * Create a database.
1723
+ *
1724
+ * Creates a ScalixNova database in the project on the requested PostgreSQL
1725
+ * major version (16 default, 17, or 18). The version is fixed at creation;
1726
+ * branches and point-in-time restores keep it.
1727
+ */
1728
+ const createDatabase = (options) => (options.client ?? client_gen_js_1.client).post({
1729
+ security: [{ scheme: 'bearer', type: 'http' }],
1730
+ url: '/v1/databases',
1731
+ ...options,
1732
+ headers: {
1733
+ 'Content-Type': 'application/json',
1734
+ ...options.headers
1735
+ }
1736
+ });
1737
+ exports.createDatabase = createDatabase;
1738
+ /**
1739
+ * Get or create the project's default database.
1740
+ *
1741
+ * Idempotent: returns the project's default database connection info,
1742
+ * creating the database (on the default PostgreSQL version) if none exists.
1743
+ */
1744
+ const provisionDatabase = (options) => (options?.client ?? client_gen_js_1.client).post({
1745
+ security: [{ scheme: 'bearer', type: 'http' }],
1746
+ url: '/v1/databases/provision',
1747
+ ...options
1748
+ });
1749
+ exports.provisionDatabase = provisionDatabase;
1750
+ /**
1751
+ * Delete a database.
1752
+ *
1753
+ * Soft-deletes the database: it is hidden from listings and restorable via
1754
+ * `POST /v1/databases/{id}/restore` until the grace window ends, after which
1755
+ * it is purged permanently.
1756
+ */
1757
+ const deleteDatabase = (options) => (options.client ?? client_gen_js_1.client).delete({
1758
+ security: [{ scheme: 'bearer', type: 'http' }],
1759
+ url: '/v1/databases/{id}',
1760
+ ...options
1761
+ });
1762
+ exports.deleteDatabase = deleteDatabase;
1763
+ /**
1764
+ * Get a database.
1765
+ *
1766
+ * Fetches one database by id, including its PostgreSQL version and isolation tier.
1767
+ */
1768
+ const getDatabase = (options) => (options.client ?? client_gen_js_1.client).get({
1769
+ security: [{ scheme: 'bearer', type: 'http' }],
1770
+ url: '/v1/databases/{id}',
1771
+ ...options
1772
+ });
1773
+ exports.getDatabase = getDatabase;
1774
+ /**
1775
+ * Restore a soft-deleted database.
1776
+ *
1777
+ * Undoes a delete within the recovery grace window; the database returns to
1778
+ * `active` with its data, version, and tier intact.
1779
+ */
1780
+ const restoreDatabase = (options) => (options.client ?? client_gen_js_1.client).post({
1781
+ security: [{ scheme: 'bearer', type: 'http' }],
1782
+ url: '/v1/databases/{id}/restore',
1783
+ ...options
1784
+ });
1785
+ exports.restoreDatabase = restoreDatabase;
1527
1786
  /**
1528
1787
  * List custom domains.
1529
1788
  *
@@ -1600,6 +1859,230 @@ const verifyDomain = (options) => (options.client ?? client_gen_js_1.client).pos
1600
1859
  ...options
1601
1860
  });
1602
1861
  exports.verifyDomain = verifyDomain;
1862
+ /**
1863
+ * Get campaign analytics.
1864
+ *
1865
+ * Returns engagement metrics for a single template. Requires the `email:read`
1866
+ * scope.
1867
+ */
1868
+ const getEmailCampaignAnalytics = (options) => (options.client ?? client_gen_js_1.client).get({
1869
+ security: [{ scheme: 'bearer', type: 'http' }],
1870
+ url: '/v1/email/analytics/campaign/{template_name}',
1871
+ ...options
1872
+ });
1873
+ exports.getEmailCampaignAnalytics = getEmailCampaignAnalytics;
1874
+ /**
1875
+ * Get analytics summary.
1876
+ *
1877
+ * Returns aggregate open, click, bounce, and complaint rates for the org.
1878
+ * Requires the `email:read` scope.
1879
+ */
1880
+ const getEmailAnalyticsSummary = (options) => (options?.client ?? client_gen_js_1.client).get({
1881
+ security: [{ scheme: 'bearer', type: 'http' }],
1882
+ url: '/v1/email/analytics/summary',
1883
+ ...options
1884
+ });
1885
+ exports.getEmailAnalyticsSummary = getEmailAnalyticsSummary;
1886
+ /**
1887
+ * List sending domains.
1888
+ *
1889
+ * Returns the org's bring-your-own sending domains and their verification
1890
+ * state. Requires the `email:read` scope.
1891
+ */
1892
+ const listEmailDomains = (options) => (options?.client ?? client_gen_js_1.client).get({
1893
+ security: [{ scheme: 'bearer', type: 'http' }],
1894
+ url: '/v1/email/domains',
1895
+ ...options
1896
+ });
1897
+ exports.listEmailDomains = listEmailDomains;
1898
+ /**
1899
+ * Add a sending domain.
1900
+ *
1901
+ * Registers a domain and returns the DNS records required to verify it.
1902
+ * Requires the `email:send` scope.
1903
+ */
1904
+ const addEmailDomain = (options) => (options.client ?? client_gen_js_1.client).post({
1905
+ security: [{ scheme: 'bearer', type: 'http' }],
1906
+ url: '/v1/email/domains',
1907
+ ...options,
1908
+ headers: {
1909
+ 'Content-Type': 'application/json',
1910
+ ...options.headers
1911
+ }
1912
+ });
1913
+ exports.addEmailDomain = addEmailDomain;
1914
+ /**
1915
+ * Delete a sending domain.
1916
+ *
1917
+ * Removes a sending domain from the org. Requires the `email:send` scope.
1918
+ */
1919
+ const deleteEmailDomain = (options) => (options.client ?? client_gen_js_1.client).delete({
1920
+ security: [{ scheme: 'bearer', type: 'http' }],
1921
+ url: '/v1/email/domains/{id}',
1922
+ ...options
1923
+ });
1924
+ exports.deleteEmailDomain = deleteEmailDomain;
1925
+ /**
1926
+ * Verify a sending domain.
1927
+ *
1928
+ * Re-checks the domain's DNS records and updates its verification state.
1929
+ * Verifying a domain proves ownership; it does not by itself enable delivery.
1930
+ * Requires the `email:send` scope.
1931
+ */
1932
+ const verifyEmailDomain = (options) => (options.client ?? client_gen_js_1.client).post({
1933
+ security: [{ scheme: 'bearer', type: 'http' }],
1934
+ url: '/v1/email/domains/{id}/verify',
1935
+ ...options
1936
+ });
1937
+ exports.verifyEmailDomain = verifyEmailDomain;
1938
+ /**
1939
+ * List delivery events.
1940
+ *
1941
+ * Returns recent per-message delivery events (delivered, bounced, opened,
1942
+ * clicked). Requires the `email:read` scope.
1943
+ */
1944
+ const listEmailEvents = (options) => (options?.client ?? client_gen_js_1.client).get({
1945
+ security: [{ scheme: 'bearer', type: 'http' }],
1946
+ url: '/v1/email/events',
1947
+ ...options
1948
+ });
1949
+ exports.listEmailEvents = listEmailEvents;
1950
+ /**
1951
+ * Send a raw email.
1952
+ *
1953
+ * Sends an HTML email without a stored template. Requires the `email:send`
1954
+ * scope.
1955
+ */
1956
+ const sendRawEmail = (options) => (options.client ?? client_gen_js_1.client).post({
1957
+ security: [{ scheme: 'bearer', type: 'http' }],
1958
+ url: '/v1/email/send/raw',
1959
+ ...options,
1960
+ headers: {
1961
+ 'Content-Type': 'application/json',
1962
+ ...options.headers
1963
+ }
1964
+ });
1965
+ exports.sendRawEmail = sendRawEmail;
1966
+ /**
1967
+ * Send a templated email.
1968
+ *
1969
+ * Renders `template` with `data` and sends it to `to`. Requires the
1970
+ * `email:send` scope.
1971
+ */
1972
+ const sendTransactionalEmail = (options) => (options.client ?? client_gen_js_1.client).post({
1973
+ security: [{ scheme: 'bearer', type: 'http' }],
1974
+ url: '/v1/email/send/tx',
1975
+ ...options,
1976
+ headers: {
1977
+ 'Content-Type': 'application/json',
1978
+ ...options.headers
1979
+ }
1980
+ });
1981
+ exports.sendTransactionalEmail = sendTransactionalEmail;
1982
+ /**
1983
+ * Get email settings.
1984
+ *
1985
+ * Returns the org's sender identity and delivery configuration, including
1986
+ * whether bring-your-own delivery is enabled. Requires the `email:read` scope.
1987
+ */
1988
+ const getEmailSettings = (options) => (options?.client ?? client_gen_js_1.client).get({
1989
+ security: [{ scheme: 'bearer', type: 'http' }],
1990
+ url: '/v1/email/settings',
1991
+ ...options
1992
+ });
1993
+ exports.getEmailSettings = getEmailSettings;
1994
+ /**
1995
+ * Update email settings.
1996
+ *
1997
+ * Updates the org's sender identity and delivery configuration. Requires the
1998
+ * `email:send` scope.
1999
+ */
2000
+ const updateEmailSettings = (options) => (options.client ?? client_gen_js_1.client).put({
2001
+ security: [{ scheme: 'bearer', type: 'http' }],
2002
+ url: '/v1/email/settings',
2003
+ ...options,
2004
+ headers: {
2005
+ 'Content-Type': 'application/json',
2006
+ ...options.headers
2007
+ }
2008
+ });
2009
+ exports.updateEmailSettings = updateEmailSettings;
2010
+ /**
2011
+ * Get email stats.
2012
+ *
2013
+ * Returns send counts and delivery health for the org. Requires the
2014
+ * `email:read` scope.
2015
+ */
2016
+ const getEmailStats = (options) => (options?.client ?? client_gen_js_1.client).get({
2017
+ security: [{ scheme: 'bearer', type: 'http' }],
2018
+ url: '/v1/email/stats',
2019
+ ...options
2020
+ });
2021
+ exports.getEmailStats = getEmailStats;
2022
+ /**
2023
+ * List suppressed addresses.
2024
+ *
2025
+ * Returns addresses excluded from sending after a hard bounce or complaint.
2026
+ * Requires the `email:read` scope.
2027
+ */
2028
+ const listEmailSuppression = (options) => (options?.client ?? client_gen_js_1.client).get({
2029
+ security: [{ scheme: 'bearer', type: 'http' }],
2030
+ url: '/v1/email/suppression',
2031
+ ...options
2032
+ });
2033
+ exports.listEmailSuppression = listEmailSuppression;
2034
+ /**
2035
+ * List email templates.
2036
+ *
2037
+ * Returns the org's stored templates. Requires the `email:read` scope.
2038
+ */
2039
+ const listEmailTemplates = (options) => (options?.client ?? client_gen_js_1.client).get({
2040
+ security: [{ scheme: 'bearer', type: 'http' }],
2041
+ url: '/v1/email/templates',
2042
+ ...options
2043
+ });
2044
+ exports.listEmailTemplates = listEmailTemplates;
2045
+ /**
2046
+ * Create an email template.
2047
+ *
2048
+ * Stores a new template for the org. Requires the `email:write` scope.
2049
+ */
2050
+ const createEmailTemplate = (options) => (options.client ?? client_gen_js_1.client).post({
2051
+ security: [{ scheme: 'bearer', type: 'http' }],
2052
+ url: '/v1/email/templates',
2053
+ ...options,
2054
+ headers: {
2055
+ 'Content-Type': 'application/json',
2056
+ ...options.headers
2057
+ }
2058
+ });
2059
+ exports.createEmailTemplate = createEmailTemplate;
2060
+ /**
2061
+ * Delete an email template.
2062
+ *
2063
+ * Removes a stored template. Requires the `email:write` scope.
2064
+ */
2065
+ const deleteEmailTemplate = (options) => (options.client ?? client_gen_js_1.client).delete({
2066
+ security: [{ scheme: 'bearer', type: 'http' }],
2067
+ url: '/v1/email/templates/{id}',
2068
+ ...options
2069
+ });
2070
+ exports.deleteEmailTemplate = deleteEmailTemplate;
2071
+ /**
2072
+ * Update an email template.
2073
+ *
2074
+ * Replaces a stored template. Requires the `email:write` scope.
2075
+ */
2076
+ const updateEmailTemplate = (options) => (options.client ?? client_gen_js_1.client).put({
2077
+ security: [{ scheme: 'bearer', type: 'http' }],
2078
+ url: '/v1/email/templates/{id}',
2079
+ ...options,
2080
+ headers: {
2081
+ 'Content-Type': 'application/json',
2082
+ ...options.headers
2083
+ }
2084
+ });
2085
+ exports.updateEmailTemplate = updateEmailTemplate;
1603
2086
  /**
1604
2087
  * List environment variables.
1605
2088
  *
@@ -2374,6 +2857,111 @@ const rollbackService = (options) => (options.client ?? client_gen_js_1.client).
2374
2857
  }
2375
2858
  });
2376
2859
  exports.rollbackService = rollbackService;
2860
+ /**
2861
+ * List your sandboxes.
2862
+ */
2863
+ const sandboxList = (options) => (options?.client ?? client_gen_js_1.client).get({
2864
+ security: [{ scheme: 'bearer', type: 'http' }],
2865
+ url: '/v1/sandboxes',
2866
+ ...options
2867
+ });
2868
+ exports.sandboxList = sandboxList;
2869
+ /**
2870
+ * Create an ephemeral sandbox.
2871
+ *
2872
+ * Boots an isolated microVM. Ephemeral sandboxes are disposable: they stop
2873
+ * at their idle or hard timeout and nothing on the rootfs persists past
2874
+ * stop. Compute is billed per vCPU-hour and GB-hour of allocation while
2875
+ * running.
2876
+ */
2877
+ const sandboxCreate = (options) => (options.client ?? client_gen_js_1.client).post({
2878
+ security: [{ scheme: 'bearer', type: 'http' }],
2879
+ url: '/v1/sandboxes',
2880
+ ...options,
2881
+ headers: {
2882
+ 'Content-Type': 'application/json',
2883
+ ...options.headers
2884
+ }
2885
+ });
2886
+ exports.sandboxCreate = sandboxCreate;
2887
+ /**
2888
+ * Delete a sandbox and tear down its microVM.
2889
+ */
2890
+ const sandboxDelete = (options) => (options.client ?? client_gen_js_1.client).delete({
2891
+ security: [{ scheme: 'bearer', type: 'http' }],
2892
+ url: '/v1/sandboxes/{id}',
2893
+ ...options
2894
+ });
2895
+ exports.sandboxDelete = sandboxDelete;
2896
+ /**
2897
+ * Get a sandbox by id.
2898
+ */
2899
+ const sandboxGet = (options) => (options.client ?? client_gen_js_1.client).get({
2900
+ security: [{ scheme: 'bearer', type: 'http' }],
2901
+ url: '/v1/sandboxes/{id}',
2902
+ ...options
2903
+ });
2904
+ exports.sandboxGet = sandboxGet;
2905
+ /**
2906
+ * Run a command inside a running sandbox (synchronous).
2907
+ */
2908
+ const sandboxRunCommand = (options) => (options.client ?? client_gen_js_1.client).post({
2909
+ security: [{ scheme: 'bearer', type: 'http' }],
2910
+ url: '/v1/sandboxes/{id}/commands',
2911
+ ...options,
2912
+ headers: {
2913
+ 'Content-Type': 'application/json',
2914
+ ...options.headers
2915
+ }
2916
+ });
2917
+ exports.sandboxRunCommand = sandboxRunCommand;
2918
+ /**
2919
+ * Extend a sandbox's hard deadline.
2920
+ */
2921
+ const sandboxExtend = (options) => (options.client ?? client_gen_js_1.client).post({
2922
+ security: [{ scheme: 'bearer', type: 'http' }],
2923
+ url: '/v1/sandboxes/{id}/extend',
2924
+ ...options,
2925
+ headers: {
2926
+ 'Content-Type': 'application/json',
2927
+ ...options.headers
2928
+ }
2929
+ });
2930
+ exports.sandboxExtend = sandboxExtend;
2931
+ /**
2932
+ * Write files into a sandbox.
2933
+ */
2934
+ const sandboxWriteFiles = (options) => (options.client ?? client_gen_js_1.client).post({
2935
+ security: [{ scheme: 'bearer', type: 'http' }],
2936
+ url: '/v1/sandboxes/{id}/files',
2937
+ ...options,
2938
+ headers: {
2939
+ 'Content-Type': 'application/json',
2940
+ ...options.headers
2941
+ }
2942
+ });
2943
+ exports.sandboxWriteFiles = sandboxWriteFiles;
2944
+ /**
2945
+ * Read a file from a sandbox. The guest path follows `/files/`.
2946
+ */
2947
+ const sandboxReadFile = (options) => (options.client ?? client_gen_js_1.client).get({
2948
+ security: [{ scheme: 'bearer', type: 'http' }],
2949
+ url: '/v1/sandboxes/{id}/files/{path}',
2950
+ ...options
2951
+ });
2952
+ exports.sandboxReadFile = sandboxReadFile;
2953
+ /**
2954
+ * Snapshot a sandbox - not available.
2955
+ *
2956
+ * Ephemeral sandboxes are disposable; state does not persist past stop.
2957
+ * This endpoint returns 501 until snapshots ship (demand-gated).
2958
+ */
2959
+ const sandboxSnapshot = (options) => (options.client ?? client_gen_js_1.client).post({
2960
+ security: [{ scheme: 'bearer', type: 'http' }],
2961
+ url: '/v1/sandboxes/{id}/snapshot',
2962
+ ...options
2963
+ });
2964
+ exports.sandboxSnapshot = sandboxSnapshot;
2377
2965
  /**
2378
2966
  * Run a search.
2379
2967
  *
@@ -2574,8 +3162,12 @@ exports.listShieldEvents = listShieldEvents;
2574
3162
  /**
2575
3163
  * Generate robots.txt.
2576
3164
  *
2577
- * Returns a `robots.txt` file generated from the project's Shield crawler
2578
- * policies.
3165
+ * Returns a `robots.txt` generated from the project's Shield crawler policies.
3166
+ *
3167
+ * This is what Shield serves for apps that have NO robots.txt of their own.
3168
+ * An app that ships one has it served verbatim with these crawler rules
3169
+ * appended instead, so this is not necessarily the file a crawler receives.
3170
+ * You do not need to copy this into your project.
2579
3171
  */
2580
3172
  const getShieldRobotsTxt = (options) => (options?.client ?? client_gen_js_1.client).get({
2581
3173
  security: [{ scheme: 'bearer', type: 'http' }],