tencentcloud-sdk-nodejs-ses 4.0.273 → 4.0.277

package/tencentcloud/services/ses/v20201002/ses_client.js

@@ -28,22 +28,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         super("ses.tencentcloudapi.com", "2020-10-02", clientConfig);
     }
     /**
-     * 获取发信地址列表
-     */
-    async ListEmailAddress(req, cb) {
-        return this.request("ListEmailAddress", req, cb);
-    }
-    /**
-     * 在使用身份发送电子邮件之前，您需要有一个电子邮件域名，该域名可以是您的网站或者移动应用的域名。您首先必须进行验证，证明自己是该域名的所有者，并且授权给腾讯云SES发送许可，才可以从该域名发送电子邮件。
-     */
-    async CreateEmailIdentity(req, cb) {
-        return this.request("CreateEmailIdentity", req, cb);
-    }
-    /**
-     * 邮箱被拉黑之后，用户如果确认收件邮箱有效或者已经处于激活状态，可以从腾讯云地址库中删除该黑名单之后继续投递。
+     * 获取当前发信域名列表，包含已验证通过与未验证的域名
      */
-    async DeleteBlackList(req, cb) {
-        return this.request("DeleteBlackList", req, cb);
+    async ListEmailIdentities(req, cb) {
+        return this.request("ListEmailIdentities", req, cb);
     }
     /**
      * 在验证了发信域名之后，您需要一个发信地址来发送邮件。例如发信域名是mail.qcloud.com，那么发信地址可以为 service@mail.qcloud.com。如果您想要收件人在收件箱列表中显示您的别名，例如"腾讯云邮件通知"。那么发信地址为： 别名 空格 尖括号 邮箱地址。请注意中间需要有空格
@@ -52,29 +40,28 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateEmailAddress", req, cb);
     }
     /**
-       * 创建模板，该模板可以是TXT或者HTML，请注意如果HTML不要包含外部文件的CSS。模板中的变量使用 {{变量名}} 表示。
-  注意：模版需要审核通过才可以使用。
-       */
-    async CreateEmailTemplate(req, cb) {
-        return this.request("CreateEmailTemplate", req, cb);
+     * 获取邮件发送状态。仅支持查询180天之内的数据
+     */
+    async GetSendEmailStatus(req, cb) {
+        return this.request("GetSendEmailStatus", req, cb);
     }
     /**
-     * 您可以通过此API批量发送TEXT或者HTML邮件，适用于营销类、通知类邮件。默认仅支持使用模板发送邮件，如需发送自定义内容，请单独联系商务开通此功能。批量发送之前，需先创建收件人列表，和收件人地址，并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送，定时发送需传TimedParam，周期重复发送需传CycleParam
+     * 创建收件人列表，收件人列表是发送批量邮件的目标邮件地址列表。创建列表后，需要上传收件人邮箱地址。之后创建发送任务，关联列表，便可以实现批量发送邮件的功能
      */
-    async BatchSendEmail(req, cb) {
-        return this.request("BatchSendEmail", req, cb);
+    async CreateReceiver(req, cb) {
+        return this.request("CreateReceiver", req, cb);
     }
     /**
-     * 您可以通过此API发送TEXT或者HTML邮件，适用于触发类邮件（验证码、交易类）。默认仅支持使用模板发送邮件，如需发送自定义内容，请单独联系商务开通此功能。
+     * 获取某个发信域名的配置详情
      */
-    async SendEmail(req, cb) {
-        return this.request("SendEmail", req, cb);
+    async GetEmailIdentity(req, cb) {
+        return this.request("GetEmailIdentity", req, cb);
     }
     /**
-     * 获取当前发信域名列表，包含已验证通过与未验证的域名
+     * 根据模板ID获取模板详情
      */
-    async ListEmailIdentities(req, cb) {
-        return this.request("ListEmailIdentities", req, cb);
+    async GetEmailTemplate(req, cb) {
+        return this.request("GetEmailTemplate", req, cb);
     }
     /**
      * 获取近期发送的统计情况，包含发送量、送达率、打开率、退信率等一系列数据。
@@ -83,34 +70,47 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("GetStatisticsReport", req, cb);
     }
     /**
-     * 获取邮件发送状态。仅支持查询180天之内的数据
+     * 更新邮件模板，更新后需再次审核
      */
-    async GetSendEmailStatus(req, cb) {
-        return this.request("GetSendEmailStatus", req, cb);
+    async UpdateEmailTemplate(req, cb) {
+        return this.request("UpdateEmailTemplate", req, cb);
     }
     /**
-     * 腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce)，腾讯云会拉黑该地址，并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判，可以从黑名单中删除。
+     * 您已经成功配置好了您的DNS，接下来请求腾讯云验证您的DNS配置是否正确
      */
-    async ListBlackEmailAddress(req, cb) {
-        return this.request("ListBlackEmailAddress", req, cb);
+    async UpdateEmailIdentity(req, cb) {
+        return this.request("UpdateEmailIdentity", req, cb);
     }
     /**
-     * 删除发信模板
+     * 删除发信域名，删除后，将不可再使用该域名进行发信
      */
-    async DeleteEmailTemplate(req, cb) {
-        return this.request("DeleteEmailTemplate", req, cb);
+    async DeleteEmailIdentity(req, cb) {
+        return this.request("DeleteEmailIdentity", req, cb);
     }
     /**
-     * 更新邮件模板，更新后需再次审核
+     * 获取发信地址列表
      */
-    async UpdateEmailTemplate(req, cb) {
-        return this.request("UpdateEmailTemplate", req, cb);
+    async ListEmailAddress(req, cb) {
+        return this.request("ListEmailAddress", req, cb);
     }
     /**
-     * 获取某个发信域名的配置详情
+       * 创建模板，该模板可以是TXT或者HTML，请注意如果HTML不要包含外部文件的CSS。模板中的变量使用 {{变量名}} 表示。
+  注意：模版需要审核通过才可以使用。
+       */
+    async CreateEmailTemplate(req, cb) {
+        return this.request("CreateEmailTemplate", req, cb);
+    }
+    /**
+     * 您可以通过此API批量发送TEXT或者HTML邮件，适用于营销类、通知类邮件。默认仅支持使用模板发送邮件，如需发送自定义内容，请单独联系商务开通此功能。批量发送之前，需先创建收件人列表，和收件人地址，并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送，定时发送需传TimedParam，周期重复发送需传CycleParam
      */
-    async GetEmailIdentity(req, cb) {
-        return this.request("GetEmailIdentity", req, cb);
+    async BatchSendEmail(req, cb) {
+        return this.request("BatchSendEmail", req, cb);
+    }
+    /**
+     * 删除发信模板
+     */
+    async DeleteEmailTemplate(req, cb) {
+        return this.request("DeleteEmailTemplate", req, cb);
     }
     /**
      * 获取当前邮件模板列表
@@ -119,22 +119,46 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ListEmailTemplates", req, cb);
     }
     /**
-     * 您已经成功配置好了您的DNS，接下来请求腾讯云验证您的DNS配置是否正确
+     * 分页查询批量发送邮件任务，包含即时发送任务，定时发送任务，周期重复发送任务，查询发送情况，包括请求数量，已发数量，缓存数量，任务状态等信息
      */
-    async UpdateEmailIdentity(req, cb) {
-        return this.request("UpdateEmailIdentity", req, cb);
+    async ListSendTasks(req, cb) {
+        return this.request("ListSendTasks", req, cb);
     }
     /**
-     * 根据模板ID获取模板详情
+     * 在使用身份发送电子邮件之前，您需要有一个电子邮件域名，该域名可以是您的网站或者移动应用的域名。您首先必须进行验证，证明自己是该域名的所有者，并且授权给腾讯云SES发送许可，才可以从该域名发送电子邮件。
      */
-    async GetEmailTemplate(req, cb) {
-        return this.request("GetEmailTemplate", req, cb);
+    async CreateEmailIdentity(req, cb) {
+        return this.request("CreateEmailIdentity", req, cb);
     }
     /**
-     * 删除发信域名，删除后，将不可再使用该域名进行发信
+     * 邮箱被拉黑之后，用户如果确认收件邮箱有效或者已经处于激活状态，可以从腾讯云地址库中删除该黑名单之后继续投递。
      */
-    async DeleteEmailIdentity(req, cb) {
-        return this.request("DeleteEmailIdentity", req, cb);
+    async DeleteBlackList(req, cb) {
+        return this.request("DeleteBlackList", req, cb);
+    }
+    /**
+     * 您可以通过此API发送TEXT或者HTML邮件，适用于触发类邮件（验证码、交易类）。默认仅支持使用模板发送邮件，如需发送自定义内容，请单独联系商务开通此功能。
+     */
+    async SendEmail(req, cb) {
+        return this.request("SendEmail", req, cb);
+    }
+    /**
+     * 腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce)，腾讯云会拉黑该地址，并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判，可以从黑名单中删除。
+     */
+    async ListBlackEmailAddress(req, cb) {
+        return this.request("ListBlackEmailAddress", req, cb);
+    }
+    /**
+     * 在创建完收件人列表后，向这个收件人列表中批量增加收件人邮箱地址，一次最大支持10W，异步完成处理。收件人列表只可以上传一次，不可追加上传。数据量比较大的时候，上传可能需要一点时间，可以通过查询收件人列表了解上传状态和上传数量
+     */
+    async CreateReceiverDetail(req, cb) {
+        return this.request("CreateReceiverDetail", req, cb);
+    }
+    /**
+     * 根据条件查询收件人列表，支持分页，模糊查询，状态查询
+     */
+    async ListReceivers(req, cb) {
+        return this.request("ListReceivers", req, cb);
     }
     /**
      * 删除发信人地址

package/tencentcloud/services/ses/v20201002/ses_models.d.ts

@@ -44,6 +44,10 @@ export interface BatchSendEmailRequest {
      * 定时发送任务的必要参数
      */
     TimedParam?: TimedEmailParam;
+    /**
+     * 退订选项 1: 加入退订链接 0: 不加入退订链接
+     */
+    Unsubscribe?: string;
 }
 /**
  * GetEmailTemplate请求参数结构体
@@ -54,6 +58,36 @@ export interface GetEmailTemplateRequest {
      */
     TemplateID: number;
 }
+/**
+ * ListSendTasks返回参数结构体
+ */
+export interface ListSendTasksResponse {
+    /**
+     * 总数
+     */
+    TotalCount: number;
+    /**
+     * 数据记录
+     */
+    Data: Array<SendTaskData>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * CreateReceiver返回参数结构体
+ */
+export interface CreateReceiverResponse {
+    /**
+     * 收件人列表id，后续根据收件人列表id上传收件人地址
+     */
+    ReceiverId: number;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateEmailTemplate请求参数结构体
  */
@@ -96,6 +130,27 @@ export interface TemplatesMetadata {
  * ListEmailAddress请求参数结构体
  */
 export declare type ListEmailAddressRequest = null;
+/**
+ * ListReceivers请求参数结构体
+ */
+export interface ListReceiversRequest {
+    /**
+     * 偏移量，整型，从0开始
+     */
+    Offset: number;
+    /**
+     * 限制数目，整型，不超过100
+     */
+    Limit: number;
+    /**
+     * 列表状态(1 待上传 2 上传中  3传完成)，若查询所有就不传这个字段
+     */
+    Status?: number;
+    /**
+     * 列表名称的关键字，模糊查询
+     */
+    KeyWord?: string;
+}
 /**
  * GetEmailIdentity返回参数结构体
  */
@@ -174,6 +229,31 @@ export interface Template {
         */
     TemplateData: string;
 }
+/**
+ * ListSendTasks请求参数结构体
+ */
+export interface ListSendTasksRequest {
+    /**
+     * 偏移量，整型，从0开始，0代表跳过0行
+     */
+    Offset: number;
+    /**
+     * 限制数目，整型,不超过100
+     */
+    Limit: number;
+    /**
+     * 任务状态 1 待开始 5 发送中 6 今日暂停发送  7 发信异常 10 发送完成。查询所有状态，则不传这个字段
+     */
+    Status?: number;
+    /**
+     * 收件人列表ID
+     */
+    ReceiverId?: number;
+    /**
+     * 任务类型 1即时 2定时 3周期，查询所有类型则不传这个字段
+     */
+    TaskType?: number;
+}
 /**
  * GetSendEmailStatus返回参数结构体
  */
@@ -222,7 +302,7 @@ export interface SendEmailRequest {
      */
     Attachments?: Array<Attachment>;
     /**
-     * 是否加入退订链接
+     * 退订选项 1: 加入退订链接 0: 不加入退订链接
      */
     Unsubscribe?: string;
 }
@@ -315,6 +395,88 @@ export interface GetStatisticsReportRequest {
      */
     ReceivingMailboxType?: string;
 }
+/**
+ * DeleteBlackList请求参数结构体
+ */
+export interface DeleteBlackListRequest {
+    /**
+     * 需要清除的黑名单邮箱列表，数组长度至少为1
+     */
+    EmailAddressList: Array<string>;
+}
+/**
+ * 发送任务数据
+ */
+export interface SendTaskData {
+    /**
+     * 任务id
+     */
+    TaskId: number;
+    /**
+     * 发信地址
+     */
+    FromEmailAddress: string;
+    /**
+     * 收件人列表Id
+     */
+    ReceiverId: number;
+    /**
+     * 任务状态 1 待开始 5 发送中 6 今日暂停发送  7 发信异常 10 发送完成
+     */
+    TaskStatus: number;
+    /**
+     * 任务类型 1 即时 2 定时 3 周期
+     */
+    TaskType: number;
+    /**
+     * 任务请求发信数量
+     */
+    RequestCount: number;
+    /**
+     * 已经发送数量
+     */
+    SendCount: number;
+    /**
+     * 缓存数量
+     */
+    CacheCount: number;
+    /**
+     * 任务创建时间
+     */
+    CreateTime: string;
+    /**
+     * 任务更新时间
+     */
+    UpdateTime: string;
+    /**
+     * 邮件主题
+     */
+    Subject: string;
+    /**
+        * 模板和模板数据
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Template: Template;
+    /**
+        * 周期任务参数
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    CycleParam: CycleEmailParam;
+    /**
+        * 定时任务参数
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    TimedParam: TimedEmailParam;
+    /**
+        * 任务异常信息
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ErrMsg: string;
+    /**
+     * 收件人列表名称
+     */
+    ReceiversName: string;
+}
 /**
  * DeleteEmailTemplate返回参数结构体
  */
@@ -373,21 +535,35 @@ export interface CreateEmailIdentityRequest {
     EmailIdentity: string;
 }
 /**
- * UpdateEmailTemplate请求参数结构体
+ * 收件人列表数据类型
  */
-export interface UpdateEmailTemplateRequest {
+export interface ReceiverData {
     /**
-     * 模板内容
+     * 收件人列表ID
      */
-    TemplateContent: TemplateContent;
+    ReceiverId: number;
     /**
-     * 模板ID
+     * 收件人列表名称
      */
-    TemplateID: number;
+    ReceiversName: string;
     /**
-     * 模版名字
+     * 收件人地址总数
      */
-    TemplateName: string;
+    Count: number;
+    /**
+        * 收件人列表描述
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Desc: string;
+    /**
+        * 列表状态(1 待上传 2 上传中 3 上传完成)
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ReceiversStatus: number;
+    /**
+     * 创建时间,如:2021-09-28 16:40:35
+     */
+    CreateTime: string;
 }
 /**
  * UpdateEmailIdentity返回参数结构体
@@ -428,6 +604,23 @@ export interface DeleteBlackListResponse {
      */
     RequestId?: string;
 }
+/**
+ * UpdateEmailTemplate请求参数结构体
+ */
+export interface UpdateEmailTemplateRequest {
+    /**
+     * 模板内容
+     */
+    TemplateContent: TemplateContent;
+    /**
+     * 模板ID
+     */
+    TemplateID: number;
+    /**
+     * 模版名字
+     */
+    TemplateName: string;
+}
 /**
  * 描述邮件发送状态
  */
@@ -522,13 +715,26 @@ export interface ListEmailTemplatesRequest {
     Offset: number;
 }
 /**
- * DeleteBlackList请求参数结构体
+ * CreateReceiver请求参数结构体
  */
-export interface DeleteBlackListRequest {
+export interface CreateReceiverRequest {
     /**
-     * 需要清除的黑名单邮箱列表，数组长度至少为1
+     * 收件人列表名称
      */
-    EmailAddressList: Array<string>;
+    ReceiversName: string;
+    /**
+     * 收件人列表描述
+     */
+    Desc?: string;
+}
+/**
+ * CreateReceiverDetail返回参数结构体
+ */
+export interface CreateReceiverDetailResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
 }
 /**
  * ListEmailTemplates返回参数结构体
@@ -767,6 +973,19 @@ export interface CreateEmailAddressRequest {
      */
     EmailSenderName?: string;
 }
+/**
+ * CreateReceiverDetail请求参数结构体
+ */
+export interface CreateReceiverDetailRequest {
+    /**
+     * 收件人列表ID
+     */
+    ReceiverId: number;
+    /**
+     * 邮箱
+     */
+    Emails: Array<string>;
+}
 /**
  * CreateEmailTemplate返回参数结构体
  */
@@ -776,6 +995,23 @@ export interface CreateEmailTemplateResponse {
      */
     RequestId?: string;
 }
+/**
+ * ListReceivers返回参数结构体
+ */
+export interface ListReceiversResponse {
+    /**
+     * 总数
+     */
+    TotalCount: number;
+    /**
+     * 数据记录
+     */
+    Data: Array<ReceiverData>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateEmailAddress返回参数结构体
  */