# Notification (*notification*) ## Overview ### Available Operations * [createSlack](#createslack) * [updateSlack](#updateslack) * [testSlackConnection](#testslackconnection) * [createTelegram](#createtelegram) * [updateTelegram](#updatetelegram) * [testTelegramConnection](#testtelegramconnection) * [createDiscord](#creatediscord) * [updateDiscord](#updatediscord) * [testDiscordConnection](#testdiscordconnection) * [createEmail](#createemail) * [updateEmail](#updateemail) * [testEmailConnection](#testemailconnection) * [remove](#remove) * [getAll](#getall) ## createSlack ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.createSlack({ appBuildError: true, databaseBackup: true, dokployRestart: false, name: "", appDeploy: false, dockerCleanup: false, webhookUrl: "https://familiar-custody.name", channel: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationCreateSlack } from "dokploy/funcs/notificationCreateSlack.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationCreateSlack(dokploy, { appBuildError: true, databaseBackup: true, dokployRestart: false, name: "", appDeploy: false, dockerCleanup: false, webhookUrl: "https://familiar-custody.name", channel: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationCreateSlack failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationCreateSlackRequest](../../models/operations/notificationcreateslackrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateSlack ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.updateSlack({ notificationId: "", slackId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationUpdateSlack } from "dokploy/funcs/notificationUpdateSlack.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationUpdateSlack(dokploy, { notificationId: "", slackId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationUpdateSlack failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationUpdateSlackRequest](../../models/operations/notificationupdateslackrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## testSlackConnection ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.testSlackConnection({ webhookUrl: "https://pointed-institute.com", channel: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationTestSlackConnection } from "dokploy/funcs/notificationTestSlackConnection.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationTestSlackConnection(dokploy, { webhookUrl: "https://pointed-institute.com", channel: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationTestSlackConnection failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationTestSlackConnectionRequest](../../models/operations/notificationtestslackconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## createTelegram ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.createTelegram({ appBuildError: false, databaseBackup: true, dokployRestart: false, name: "", appDeploy: true, dockerCleanup: true, botToken: "", chatId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationCreateTelegram } from "dokploy/funcs/notificationCreateTelegram.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationCreateTelegram(dokploy, { appBuildError: false, databaseBackup: true, dokployRestart: false, name: "", appDeploy: true, dockerCleanup: true, botToken: "", chatId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationCreateTelegram failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationCreateTelegramRequest](../../models/operations/notificationcreatetelegramrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateTelegram ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.updateTelegram({ notificationId: "", telegramId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationUpdateTelegram } from "dokploy/funcs/notificationUpdateTelegram.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationUpdateTelegram(dokploy, { notificationId: "", telegramId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationUpdateTelegram failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationUpdateTelegramRequest](../../models/operations/notificationupdatetelegramrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## testTelegramConnection ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.testTelegramConnection({ botToken: "", chatId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationTestTelegramConnection } from "dokploy/funcs/notificationTestTelegramConnection.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationTestTelegramConnection(dokploy, { botToken: "", chatId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationTestTelegramConnection failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationTestTelegramConnectionRequest](../../models/operations/notificationtesttelegramconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## createDiscord ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.createDiscord({ appBuildError: false, databaseBackup: true, dokployRestart: false, name: "", appDeploy: false, dockerCleanup: true, webhookUrl: "https://present-sport.net/", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationCreateDiscord } from "dokploy/funcs/notificationCreateDiscord.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationCreateDiscord(dokploy, { appBuildError: false, databaseBackup: true, dokployRestart: false, name: "", appDeploy: false, dockerCleanup: true, webhookUrl: "https://present-sport.net/", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationCreateDiscord failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationCreateDiscordRequest](../../models/operations/notificationcreatediscordrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateDiscord ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.updateDiscord({ notificationId: "", discordId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationUpdateDiscord } from "dokploy/funcs/notificationUpdateDiscord.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationUpdateDiscord(dokploy, { notificationId: "", discordId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationUpdateDiscord failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationUpdateDiscordRequest](../../models/operations/notificationupdatediscordrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## testDiscordConnection ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.testDiscordConnection({ webhookUrl: "https://radiant-fireplace.net", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationTestDiscordConnection } from "dokploy/funcs/notificationTestDiscordConnection.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationTestDiscordConnection(dokploy, { webhookUrl: "https://radiant-fireplace.net", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationTestDiscordConnection failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationTestDiscordConnectionRequest](../../models/operations/notificationtestdiscordconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## createEmail ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.createEmail({ appBuildError: false, databaseBackup: false, dokployRestart: true, name: "", appDeploy: false, dockerCleanup: false, smtpServer: "", smtpPort: 8149.3, username: "Krystal95", password: "LGAnX2vuZKQTVc9", fromAddress: "", toAddresses: [], }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationCreateEmail } from "dokploy/funcs/notificationCreateEmail.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationCreateEmail(dokploy, { appBuildError: false, databaseBackup: false, dokployRestart: true, name: "", appDeploy: false, dockerCleanup: false, smtpServer: "", smtpPort: 8149.3, username: "Krystal95", password: "LGAnX2vuZKQTVc9", fromAddress: "", toAddresses: [], }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationCreateEmail failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationCreateEmailRequest](../../models/operations/notificationcreateemailrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateEmail ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.updateEmail({ notificationId: "", emailId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationUpdateEmail } from "dokploy/funcs/notificationUpdateEmail.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationUpdateEmail(dokploy, { notificationId: "", emailId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationUpdateEmail failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationUpdateEmailRequest](../../models/operations/notificationupdateemailrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## testEmailConnection ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.testEmailConnection({ smtpServer: "", smtpPort: 4799.46, username: "Rollin96", password: "xHtlQtIjbn2x0yV", toAddresses: [ "", "", ], fromAddress: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationTestEmailConnection } from "dokploy/funcs/notificationTestEmailConnection.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationTestEmailConnection(dokploy, { smtpServer: "", smtpPort: 4799.46, username: "Rollin96", password: "xHtlQtIjbn2x0yV", toAddresses: [ "", "", ], fromAddress: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationTestEmailConnection failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationTestEmailConnectionRequest](../../models/operations/notificationtestemailconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## remove ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.remove({ notificationId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationRemove } from "dokploy/funcs/notificationRemove.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationRemove(dokploy, { notificationId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationRemove failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.NotificationRemoveRequest](../../models/operations/notificationremoverequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## getAll ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.notification.getAll(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { notificationGetAll } from "dokploy/funcs/notificationGetAll.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await notificationGetAll(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("notificationGetAll failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* |