# @deliverart/sdk-js-email-notification-configuration 中文文档

规范地址：https://npmcn.com/package/%40deliverart/sdk-js-email-notification-configuration/

版本：3\.0\.1
npm 元数据更新时间：2026-11-10T20:26:32.968Z
中文译文更新时间：2026-11-12T03:45:05.267Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40deliverart/sdk-js-email-notification-configuration
原文对照：https://npmcn.com/package/%40deliverart/sdk-js-email-notification-configuration/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：308 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-01-07T22:03:10.250Z
- 最新版本发布：2026-11-10T20:26:32.755Z
- 近 30 天下载量：3031（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：152（近 12 个月 152 个）

## 中文简介

传送 JavaScript SDK 电子邮件通知配置

## 安装

```sh
npm install @deliverart/sdk-js-email-notification-configuration
```

也可以使用：`pnpm add @deliverart/sdk-js-email-notification-configuration`、`yarn add @deliverart/sdk-js-email-notification-configuration`、`bun add @deliverart/sdk-js-email-notification-configuration`

## README

# @deliverart/sdk-js-电子邮件-通知-配置

交付艺术JavaScript SDK的电子邮件通知配置管理软件包.

## 安装

```bash
npm install @deliverart/sdk-js-email-notification-configuration @deliverart/sdk-js-core
```

## 导出类型

### 核心类型

-   `EmailNotificationConfiguration` - 带有所有细节的电子邮件通知配置
-   `EmailNotificationConfigurationListItem` - 电子邮件通知配置列表项目
-   `EmailNotificationConfigurationConfig` - 包含通知设置的配置对象
-   `WritableEmailNotificationConfiguration` - 可写入电子邮件通知配置
-   `WritableCreateEmailNotificationConfiguration` - 可创建电子邮件通知配置

### 模板密钥

可用的电子邮件模板密钥 :

-   `delivery_started` - 交货开始时通知
-   `delivery_taken_over` - 接收交货时的通知
-   `order_created` - 建立命令时的通知
-   `order_amended` - 向最初的电子商务买方或经审查的枢纽联系人发出材料修正通知;适用源过滤器
-   `order_delivered` - 发出命令的通知
-   `order_in_preparation` - 命令准备时通知
-   `order_preparation_done` - 完成订货准备后发出通知
-   `subscription_expiring` - 提醒时间订阅即将到期
-   `subscription_low_credits` - 提醒信贷的消费认购率低时
-   `subscription_pending_renewal` - 当订阅需要续签时提醒
-   `subscription_payment_pending_verification` - 需要中央管理人员核查的订阅费通知

### 排序来源

配置支持以下顺序源 :

-   `application` - 来自移动/网络应用程序的命令
-   `ecommerce` - 电子商务平台的命令
-   `partner` - 伙伴一体化的命令

### IRI 类型

-   `EmailNotificationConfigurationIri` - 电子邮件通知配置IRI(`/email_notification_configurations/:id`(中文(简体) )

## 配置结构

每个电子邮件通知配置包含一个 `config` 带有模板特定设置的对象。 结构取决于模板键.

### 配置对象

顺序和交付模板的使用:

```typescript
{
  sourcesEnabled: string[]
}
```

订阅提醒模板的使用 :

```typescript
{}
```

同样的空配置也用于订阅帐单核查通知.

**字段 :**

-   `sourcesEnabled?: string[]` - 应按订单和交付模板发送通知的订单来源序列

## 可用请求

### 创建电子邮件通知配置

```typescript
import { CreateEmailNotificationConfiguration } from '@deliverart/sdk-js-email-notification-configuration';

const config = await sdk.call(new CreateEmailNotificationConfiguration({
  pointOfSale: '/point_of_sales/123',
  templateKey: 'order_preparation_done',
  isActive: true,
  config: {
    sourcesEnabled: ['application']
  }
}));
```

订阅提醒示例 :

```typescript
const config = await sdk.call(new CreateEmailNotificationConfiguration({
  pointOfSale: '/point_of_sales/123',
  templateKey: 'subscription_low_credits',
  isActive: true,
  config: {}
}));
```

订阅帐单核查示例 :

```typescript
const config = await sdk.call(new CreateEmailNotificationConfiguration({
  pointOfSale: '/point_of_sales/123',
  templateKey: 'subscription_payment_pending_verification',
  isActive: true,
  config: {}
}));
```

**输入参数:**

-   `pointOfSale: string` (需要) - 销售点
-   `templateKey: string` (需要) - 电子邮件模板密钥
-   `isActive: boolean` (要求) - 启用/失效通知
-   `config: object` (需要) - 有源的配置对象

* * *

### 获取电子邮件通知

```typescript
import { GetEmailNotificationConfigurations } from '@deliverart/sdk-js-email-notification-configuration';

const configs = await sdk.call(new GetEmailNotificationConfigurations({
  query: {
    templateKey: 'order_created',
    page: 1
  }
}));
```

**查询参数:**

-   `id?: string | string[]` - 通过配置标识过滤
-   `templateKey?: string | string[]` - 通过模板键过滤
-   `order[createdAt]?: string` - 按创建日期排序
-   `order[updatedAt]?: string` - 按更新日期排序
-   `page?: number` - 页号
-   `createdAtFrom?: string` - 通过创建日期过滤(从)
-   `createdAtTo?: string` - 按创建日期过滤(至)
-   `updatedAtFrom?: string` - 按更新日期过滤(从)
-   `updatedAtTo?: string` - 按更新日期过滤(至)

* * *

### 获取电子邮件通知

```typescript
import { GetEmailNotificationConfigurationDetails } from '@deliverart/sdk-js-email-notification-configuration';

const config = await sdk.call(new GetEmailNotificationConfigurationDetails('config-123'));
```

* * *

### 更新电子邮件通知

```typescript
import { UpdateEmailNotificationConfiguration } from '@deliverart/sdk-js-email-notification-configuration';

const updated = await sdk.call(new UpdateEmailNotificationConfiguration('config-123', {
  templateKey: 'order_preparation_done',
  isActive: false,
  config: {
    sourcesEnabled: ['application', 'ecommerce']
  }
}));
```

**输入参数:**

-   `templateKey: string` (需要) - 电子邮件模板密钥
-   `isActive: boolean` (要求) - 启用/失效通知
-   `config: object` (需要) - 配置对象
    -   命令/交付模板 : `sourcesEnabled: string[]`
    -   订阅提醒模板: 空对象 `{}`

* * *

### 删除电子邮件通知

```typescript
import { DeleteEmailNotificationConfiguration } from '@deliverart/sdk-js-email-notification-configuration';

await sdk.call(new DeleteEmailNotificationConfiguration('config-123'));
```

* * *

## 许可证

这个包是"交付艺术"JavaScript SDK的一部分.

## 常见问题

### @deliverart/sdk-js-email-notification-configuration 是什么？

传送 JavaScript SDK 电子邮件通知配置

### 如何安装 @deliverart/sdk-js-email-notification-configuration？

在项目目录运行 npm install @deliverart/sdk-js-email-notification-configuration，或使用 pnpm add / yarn add / bun add。

### @deliverart/sdk-js-email-notification-configuration 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @deliverart/sdk-js-email-notification-configuration 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @deliverart/sdk-js-email-notification-configuration 可以商用吗？

@deliverart/sdk-js-email-notification-configuration 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @deliverart/sdk-js-email-notification-configuration 的下载量有多少？

根据 npm 官方下载统计，@deliverart/sdk-js-email-notification-configuration 在 2026/10/12 – 2026/11/10 这 30 天内被下载 3,031 次，日均约 101 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @deliverart/sdk-js-email-notification-configuration 还在维护吗？

最新版本 3\.0\.1 发布于 2026/11/11（1 天前）；至今共发布 152 个版本，其中过去 12 个月发布了 152 个；首次发布于 2026/01/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。