@scalix-world/sdk 1.4.0 → 1.4.1

package/dist/cjs/generated/sdk.gen.js

@@ -2,11 +2,11 @@
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
 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;
-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 = exports.listModels = void 0;
-exports.setEnvVar = exports.listEnvVars = 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 = void 0;
-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 = 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 = void 0;
-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 = 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 = void 0;
-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 = void 0;
+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;
+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;
+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;
+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;
+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;
 const client_gen_js_1 = require("./client.gen.js");
 const index_js_1 = require("./client/index.js");
 /**
@@ -1196,6 +1196,9 @@ exports.listBuilds = listBuilds;
  * Start a build.
  *
  * Starts a container image build and returns the build record.
+ *
+ * For a private repository, either install the Scalix GitHub App for the
+ * project (builds then authenticate themselves) or pass `auth_token`.
  */
 const createBuild = (options) => (options.client ?? client_gen_js_1.client).post({
     security: [{ scheme: 'bearer', type: 'http' }],
@@ -1207,6 +1210,24 @@ const createBuild = (options) => (options.client ?? client_gen_js_1.client).post
     }
 });
 exports.createBuild = createBuild;
+/**
+ * Upload source and build.
+ *
+ * Builds from an uploaded source tree instead of a URL, so the source never
+ * has to be reachable from the internet. The request body IS the gzipped
+ * tarball (`Content-Type: application/gzip`); metadata goes in the query
+ * string. Multipart is not accepted.
+ */
+const uploadBuild = (options) => (options.client ?? client_gen_js_1.client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/build/upload',
+    ...options,
+    headers: {
+        'Content-Type': 'application/gzip',
+        ...options.headers
+    }
+});
+exports.uploadBuild = uploadBuild;
 /**
  * Get a build.
  *
@@ -1838,6 +1859,230 @@ const verifyDomain = (options) => (options.client ?? client_gen_js_1.client).pos
     ...options
 });
 exports.verifyDomain = verifyDomain;
+/**
+ * Get campaign analytics.
+ *
+ * Returns engagement metrics for a single template. Requires the `email:read`
+ * scope.
+ */
+const getEmailCampaignAnalytics = (options) => (options.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/analytics/campaign/{template_name}',
+    ...options
+});
+exports.getEmailCampaignAnalytics = getEmailCampaignAnalytics;
+/**
+ * Get analytics summary.
+ *
+ * Returns aggregate open, click, bounce, and complaint rates for the org.
+ * Requires the `email:read` scope.
+ */
+const getEmailAnalyticsSummary = (options) => (options?.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/analytics/summary',
+    ...options
+});
+exports.getEmailAnalyticsSummary = getEmailAnalyticsSummary;
+/**
+ * List sending domains.
+ *
+ * Returns the org's bring-your-own sending domains and their verification
+ * state. Requires the `email:read` scope.
+ */
+const listEmailDomains = (options) => (options?.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/domains',
+    ...options
+});
+exports.listEmailDomains = listEmailDomains;
+/**
+ * Add a sending domain.
+ *
+ * Registers a domain and returns the DNS records required to verify it.
+ * Requires the `email:send` scope.
+ */
+const addEmailDomain = (options) => (options.client ?? client_gen_js_1.client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/domains',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.addEmailDomain = addEmailDomain;
+/**
+ * Delete a sending domain.
+ *
+ * Removes a sending domain from the org. Requires the `email:send` scope.
+ */
+const deleteEmailDomain = (options) => (options.client ?? client_gen_js_1.client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/domains/{id}',
+    ...options
+});
+exports.deleteEmailDomain = deleteEmailDomain;
+/**
+ * Verify a sending domain.
+ *
+ * Re-checks the domain's DNS records and updates its verification state.
+ * Verifying a domain proves ownership; it does not by itself enable delivery.
+ * Requires the `email:send` scope.
+ */
+const verifyEmailDomain = (options) => (options.client ?? client_gen_js_1.client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/domains/{id}/verify',
+    ...options
+});
+exports.verifyEmailDomain = verifyEmailDomain;
+/**
+ * List delivery events.
+ *
+ * Returns recent per-message delivery events (delivered, bounced, opened,
+ * clicked). Requires the `email:read` scope.
+ */
+const listEmailEvents = (options) => (options?.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/events',
+    ...options
+});
+exports.listEmailEvents = listEmailEvents;
+/**
+ * Send a raw email.
+ *
+ * Sends an HTML email without a stored template. Requires the `email:send`
+ * scope.
+ */
+const sendRawEmail = (options) => (options.client ?? client_gen_js_1.client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/send/raw',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.sendRawEmail = sendRawEmail;
+/**
+ * Send a templated email.
+ *
+ * Renders `template` with `data` and sends it to `to`. Requires the
+ * `email:send` scope.
+ */
+const sendTransactionalEmail = (options) => (options.client ?? client_gen_js_1.client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/send/tx',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.sendTransactionalEmail = sendTransactionalEmail;
+/**
+ * Get email settings.
+ *
+ * Returns the org's sender identity and delivery configuration, including
+ * whether bring-your-own delivery is enabled. Requires the `email:read` scope.
+ */
+const getEmailSettings = (options) => (options?.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/settings',
+    ...options
+});
+exports.getEmailSettings = getEmailSettings;
+/**
+ * Update email settings.
+ *
+ * Updates the org's sender identity and delivery configuration. Requires the
+ * `email:send` scope.
+ */
+const updateEmailSettings = (options) => (options.client ?? client_gen_js_1.client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/settings',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.updateEmailSettings = updateEmailSettings;
+/**
+ * Get email stats.
+ *
+ * Returns send counts and delivery health for the org. Requires the
+ * `email:read` scope.
+ */
+const getEmailStats = (options) => (options?.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/stats',
+    ...options
+});
+exports.getEmailStats = getEmailStats;
+/**
+ * List suppressed addresses.
+ *
+ * Returns addresses excluded from sending after a hard bounce or complaint.
+ * Requires the `email:read` scope.
+ */
+const listEmailSuppression = (options) => (options?.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/suppression',
+    ...options
+});
+exports.listEmailSuppression = listEmailSuppression;
+/**
+ * List email templates.
+ *
+ * Returns the org's stored templates. Requires the `email:read` scope.
+ */
+const listEmailTemplates = (options) => (options?.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/templates',
+    ...options
+});
+exports.listEmailTemplates = listEmailTemplates;
+/**
+ * Create an email template.
+ *
+ * Stores a new template for the org. Requires the `email:write` scope.
+ */
+const createEmailTemplate = (options) => (options.client ?? client_gen_js_1.client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/templates',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.createEmailTemplate = createEmailTemplate;
+/**
+ * Delete an email template.
+ *
+ * Removes a stored template. Requires the `email:write` scope.
+ */
+const deleteEmailTemplate = (options) => (options.client ?? client_gen_js_1.client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/templates/{id}',
+    ...options
+});
+exports.deleteEmailTemplate = deleteEmailTemplate;
+/**
+ * Update an email template.
+ *
+ * Replaces a stored template. Requires the `email:write` scope.
+ */
+const updateEmailTemplate = (options) => (options.client ?? client_gen_js_1.client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/templates/{id}',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.updateEmailTemplate = updateEmailTemplate;
 /**
  * List environment variables.
  *
@@ -2917,8 +3162,12 @@ exports.listShieldEvents = listShieldEvents;
 /**
  * Generate robots.txt.
  *
- * Returns a `robots.txt` file generated from the project's Shield crawler
- * policies.
+ * Returns a `robots.txt` generated from the project's Shield crawler policies.
+ *
+ * This is what Shield serves for apps that have NO robots.txt of their own.
+ * An app that ships one has it served verbatim with these crawler rules
+ * appended instead, so this is not necessarily the file a crawler receives.
+ * You do not need to copy this into your project.
  */
 const getShieldRobotsTxt = (options) => (options?.client ?? client_gen_js_1.client).get({
     security: [{ scheme: 'bearer', type: 'http' }],