tencentcloud-sdk-nodejs 4.0.884 → 4.0.886

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

@@ -76,10 +76,16 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("GetEmailTemplate", req, cb);
     }
     /**
-     * 获取近期发送的统计情况，包含发送量、送达率、打开率、退信率等一系列数据。
+     * 更新自定义黑名单
      */
-    async GetStatisticsReport(req, cb) {
-        return this.request("GetStatisticsReport", req, cb);
+    async UpdateCustomBlackList(req, cb) {
+        return this.request("UpdateCustomBlackList", req, cb);
+    }
+    /**
+     * 腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce)，腾讯云会拉黑该地址，并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判，可以从黑名单中删除。
+     */
+    async ListBlackEmailAddress(req, cb) {
+        return this.request("ListBlackEmailAddress", req, cb);
     }
     /**
      * 更新邮件模板，更新后需再次审核
@@ -130,6 +136,12 @@ class Client extends abstract_client_1.AbstractClient {
     async UpdateEmailSmtpPassWord(req, cb) {
         return this.request("UpdateEmailSmtpPassWord", req, cb);
     }
+    /**
+     * 添加自定义黑名单
+     */
+    async CreateCustomBlacklist(req, cb) {
+        return this.request("CreateCustomBlacklist", req, cb);
+    }
     /**
      * 删除发信模板
      */
@@ -154,6 +166,12 @@ class Client extends abstract_client_1.AbstractClient {
     async CreateEmailIdentity(req, cb) {
         return this.request("CreateEmailIdentity", req, cb);
     }
+    /**
+     * 删除自定义黑名单邮箱地址
+     */
+    async DeleteCustomBlackList(req, cb) {
+        return this.request("DeleteCustomBlackList", req, cb);
+    }
     /**
      * 邮箱被拉黑之后，用户如果确认收件邮箱有效或者已经处于激活状态，可以从腾讯云地址库中删除该黑名单之后继续投递。
      */
@@ -167,10 +185,16 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("SendEmail", req, cb);
     }
     /**
-     * 腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce)，腾讯云会拉黑该地址，并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判，可以从黑名单中删除。
+     * 获取自定义黑名单列表
      */
-    async ListBlackEmailAddress(req, cb) {
-        return this.request("ListBlackEmailAddress", req, cb);
+    async ListCustomBlacklist(req, cb) {
+        return this.request("ListCustomBlacklist", req, cb);
+    }
+    /**
+     * 获取近期发送的统计情况，包含发送量、送达率、打开率、退信率等一系列数据。
+     */
+    async GetStatisticsReport(req, cb) {
+        return this.request("GetStatisticsReport", req, cb);
     }
     /**
      * 在创建完收件人列表后，向这个收件人列表中批量增加收件人邮箱地址，一次最大支持2万，异步完成处理。数据量比较大的时候，上传可能需要一点时间，可以通过查询收件人列表了解上传状态和上传数量。本接口与接口CreateReceiverDetailWithData的功能特性基本一致，只是不支持上传发信时的模板参数。用户首先调用创建收件人列表接口-CreateReceiver后，然后调用本接口传入收件人地址，最后使用批量发送邮件接口-BatchSendEmail，即可完成批量发信。本接口也支持追加收件人地址，也不支持去重，需要用户自己保证收件人地址不重复。本接口一次请求的收件人地址数量限制为2W条，但收件人列表中收件人地址的总量不能超过一定的数量，目前是限制5万条。

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

@@ -96,17 +96,17 @@ export interface CreateReceiverResponse {
     RequestId?: string;
 }
 /**
- * CreateEmailTemplate请求参数结构体
+ * CreateCustomBlacklist请求参数结构体
  */
-export interface CreateEmailTemplateRequest {
+export interface CreateCustomBlacklistRequest {
     /**
-     * 模板名称
+     * 添加到黑名单的邮件地址
      */
-    TemplateName: string;
+    Emails: Array<string>;
     /**
-     * 模板内容
+     * 过期日期
      */
-    TemplateContent: TemplateContent;
+    ExpireDate?: string;
 }
 /**
  * ListEmailAddress返回参数结构体
@@ -126,6 +126,15 @@ export interface ListEmailAddressResponse {
  * ListEmailAddress请求参数结构体
  */
 export declare type ListEmailAddressRequest = null;
+/**
+ * UpdateCustomBlackList返回参数结构体
+ */
+export interface UpdateCustomBlackListResponse {
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * UpdateEmailSmtpPassWord返回参数结构体
  */
@@ -273,64 +282,46 @@ export interface GetSendEmailStatusResponse {
     RequestId?: string;
 }
 /**
- * SendEmail请求参数结构体
+ * 模板列表结构
  */
-export interface SendEmailRequest {
-    /**
-     * 发件人邮箱地址。不使用别名时请直接填写发件人邮箱地址，例如：noreply@mail.qcloud.com
-  如需填写发件人别名时，请按照如下方式（注意别名与邮箱地址之间必须使用一个空格隔开）：别名+一个空格+<邮箱地址>
-     */
-    FromEmailAddress: string;
-    /**
-     * 收信人邮箱地址，最多支持群发50人。注意：邮件内容会显示所有收件人地址，非群发邮件请多次调用API发送。
-     */
-    Destination: Array<string>;
-    /**
-     * 邮件主题
-     */
-    Subject: string;
-    /**
-     * 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址，可以是个人邮箱。如果不填，收件人的回复邮件将会发送失败。
-     */
-    ReplyToAddresses?: string;
-    /**
-     * 抄送人邮箱地址，最多支持抄送20人。
-     */
-    Cc?: Array<string>;
+export interface TemplatesMetadata {
     /**
-     * 密送人邮箱地址，最多支持抄送20人。
+     * 创建时间
      */
-    Bcc?: Array<string>;
+    CreatedTimestamp: number;
     /**
-     * 使用模板发送时，填写模板相关参数。
-  <dx-alert infotype="notice" title="注意"> 如您未申请过特殊配置，则该字段为必填 </dx-alert>
+     * 模板名称
      */
-    Template?: Template;
+    TemplateName: string;
     /**
-     * 已废弃
-  <dx-alert infotype="notice" title="说明"> 仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置，则不存在该字段。</dx-alert>
+     * 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用
      */
-    Simple?: Simple;
+    TemplateStatus: number;
     /**
-     * 需要发送附件时，填写附件相关参数。腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍，应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 时接口会返回错误
+     * 模板ID
      */
-    Attachments?: Array<Attachment>;
+    TemplateID: number;
     /**
-     * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
+     * 审核原因
      */
-    Unsubscribe?: string;
+    ReviewReason: string;
+}
+/**
+ * 收件人列表详情
+ */
+export interface ReceiverDetail {
     /**
-     * 邮件触发类型 0:非触发类，默认类型，营销类邮件、非即时类邮件等选择此类型  1:触发类，验证码等即时发送类邮件，若邮件超过一定大小，系统会自动选择非触发类型通道
+     * 收件人地址
      */
-    TriggerType?: number;
+    Email: string;
     /**
-     * smtp头中的Message-Id字段
+     * 创建时间
      */
-    SmtpMessageId?: string;
+    CreateTime: string;
     /**
-     * smtp头中可以设置的其它字段
+     * 模板参数
      */
-    SmtpHeaders?: string;
+    TemplateData: string;
 }
 /**
  * DeleteBlackList请求参数结构体
@@ -382,6 +373,45 @@ export interface DeleteEmailIdentityRequest {
      */
     EmailIdentity: string;
 }
+/**
+ * 统计数据的结构体
+ */
+export interface Volume {
+    /**
+     * 日期
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    SendDate: string;
+    /**
+     * 邮件请求数量
+     */
+    RequestCount: number;
+    /**
+     * 腾讯云通过数量
+     */
+    AcceptedCount: number;
+    /**
+     * 送达数量
+     */
+    DeliveredCount: number;
+    /**
+     * 打开邮件的用户数量，根据收件人去重
+     */
+    OpenedCount: number;
+    /**
+     * 点击了邮件中的链接数量用户数量
+     */
+    ClickedCount: number;
+    /**
+     * 退信数量
+     */
+    BounceCount: number;
+    /**
+     * 取消订阅的用户数量
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    UnsubscribeCount: number;
+}
 /**
  * UpdateEmailIdentity请求参数结构体
  */
@@ -430,6 +460,15 @@ export interface GetStatisticsReportRequest {
      */
     ReceivingMailboxType?: string;
 }
+/**
+ * CreateCustomBlacklist返回参数结构体
+ */
+export interface CreateCustomBlacklistResponse {
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateReceiver请求参数结构体
  */
@@ -517,29 +556,21 @@ export interface SendTaskData {
     ReceiversName: string;
 }
 /**
- * 模板列表结构
+ * ListReceiverDetails返回参数结构体
  */
-export interface TemplatesMetadata {
-    /**
-     * 创建时间
-     */
-    CreatedTimestamp: number;
-    /**
-     * 模板名称
-     */
-    TemplateName: string;
+export interface ListReceiverDetailsResponse {
     /**
-     * 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用
+     * 总数
      */
-    TemplateStatus: number;
+    TotalCount: number;
     /**
-     * 模板ID
+     * 数据记录
      */
-    TemplateID: number;
+    Data: Array<ReceiverDetail>;
     /**
-     * 审核原因
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
-    ReviewReason: string;
+    RequestId?: string;
 }
 /**
  * DeleteEmailTemplate返回参数结构体
@@ -551,52 +582,51 @@ export interface DeleteEmailTemplateResponse {
     RequestId?: string;
 }
 /**
- * 统计数据的结构体
+ * UpdateCustomBlackList请求参数结构体
  */
-export interface Volume {
+export interface UpdateCustomBlackListRequest {
     /**
-     * 日期
-  注意：此字段可能返回 null，表示取不到有效值。
+     * 需要更改的黑名单id
      */
-    SendDate: string;
+    Id: number;
     /**
-     * 邮件请求数量
-     */
-    RequestCount: number;
-    /**
-     * 腾讯云通过数量
+     * 修改后的邮件地址
      */
-    AcceptedCount: number;
+    Email: string;
     /**
-     * 送达数量
+     * 过期时间，为空则表示永久有效
      */
-    DeliveredCount: number;
+    ExpireDate?: string;
+}
+/**
+ * CreateEmailIdentity请求参数结构体
+ */
+export interface CreateEmailIdentityRequest {
     /**
-     * 打开邮件的用户数量，根据收件人去重
+     * 您的发信域名，建议使用三级以上域名。例如：mail.qcloud.com。
      */
-    OpenedCount: number;
+    EmailIdentity: string;
+}
+/**
+ * ListCustomBlacklist请求参数结构体
+ */
+export interface ListCustomBlacklistRequest {
     /**
-     * 点击了邮件中的链接数量用户数量
+     * 偏移量，整型，从0开始
      */
-    ClickedCount: number;
+    Offset: number;
     /**
-     * 退信数量
+     * 限制数目，整型,不超过100
      */
-    BounceCount: number;
+    Limit: number;
     /**
-     * 取消订阅的用户数量
-  注意：此字段可能返回 null，表示取不到有效值。
+     * 筛选黑名单的状态，0:已过期，1:生效中, 2:全部
      */
-    UnsubscribeCount: number;
-}
-/**
- * CreateEmailIdentity请求参数结构体
- */
-export interface CreateEmailIdentityRequest {
+    Status: number;
     /**
-     * 您的发信域名，建议使用三级以上域名。例如：mail.qcloud.com。
+     * 黑名单中的邮箱地址
      */
-    EmailIdentity: string;
+    Email?: string;
 }
 /**
  * UpdateEmailSmtpPassWord请求参数结构体
@@ -664,13 +694,17 @@ export interface UpdateEmailIdentityResponse {
     RequestId?: string;
 }
 /**
- * DeleteEmailTemplate请求参数结构体
+ * CreateEmailTemplate请求参数结构体
  */
-export interface DeleteEmailTemplateRequest {
+export interface CreateEmailTemplateRequest {
     /**
-     * 模板ID
+     * 模板名称
      */
-    TemplateID: number;
+    TemplateName: string;
+    /**
+     * 模板内容
+     */
+    TemplateContent: TemplateContent;
 }
 /**
  * DeleteBlackList返回参数结构体
@@ -682,21 +716,13 @@ export interface DeleteBlackListResponse {
     RequestId?: string;
 }
 /**
- * ListReceiverDetails返回参数结构体
+ * DeleteCustomBlackList请求参数结构体
  */
-export interface ListReceiverDetailsResponse {
-    /**
-     * 总数
-     */
-    TotalCount: number;
-    /**
-     * 数据记录
-     */
-    Data: Array<ReceiverDetail>;
+export interface DeleteCustomBlackListRequest {
     /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     * 需要删除的邮箱地址
      */
-    RequestId?: string;
+    Emails: Array<string>;
 }
 /**
  * UpdateEmailTemplate请求参数结构体
@@ -715,6 +741,23 @@ export interface UpdateEmailTemplateRequest {
      */
     TemplateName: string;
 }
+/**
+ * ListCustomBlacklist返回参数结构体
+ */
+export interface ListCustomBlacklistResponse {
+    /**
+     * 列表总数
+     */
+    TotalCount?: number;
+    /**
+     * 黑名单列表详情
+     */
+    Data?: Array<BlackAddressDetail>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 描述邮件发送状态
  */
@@ -843,21 +886,13 @@ export interface CreateReceiverDetailResponse {
     RequestId?: string;
 }
 /**
- * 收件人列表详情
+ * DeleteReceiver返回参数结构体
  */
-export interface ReceiverDetail {
-    /**
-     * 收件人地址
-     */
-    Email: string;
-    /**
-     * 创建时间
-     */
-    CreateTime: string;
+export interface DeleteReceiverResponse {
     /**
-     * 模板参数
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
-    TemplateData: string;
+    RequestId?: string;
 }
 /**
  * ListEmailTemplates返回参数结构体
@@ -889,6 +924,66 @@ export interface SendEmailResponse {
      */
     RequestId?: string;
 }
+/**
+ * SendEmail请求参数结构体
+ */
+export interface SendEmailRequest {
+    /**
+     * 发件人邮箱地址。不使用别名时请直接填写发件人邮箱地址，例如：noreply@mail.qcloud.com
+  如需填写发件人别名时，请按照如下方式（注意别名与邮箱地址之间必须使用一个空格隔开）：别名+一个空格+<邮箱地址>
+     */
+    FromEmailAddress: string;
+    /**
+     * 收信人邮箱地址，最多支持群发50人。注意：邮件内容会显示所有收件人地址，非群发邮件请多次调用API发送。
+     */
+    Destination: Array<string>;
+    /**
+     * 邮件主题
+     */
+    Subject: string;
+    /**
+     * 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址，可以是个人邮箱。如果不填，收件人的回复邮件将会发送失败。
+     */
+    ReplyToAddresses?: string;
+    /**
+     * 抄送人邮箱地址，最多支持抄送20人。
+     */
+    Cc?: Array<string>;
+    /**
+     * 密送人邮箱地址，最多支持抄送20人。
+     */
+    Bcc?: Array<string>;
+    /**
+     * 使用模板发送时，填写模板相关参数。
+  <dx-alert infotype="notice" title="注意"> 如您未申请过特殊配置，则该字段为必填 </dx-alert>
+     */
+    Template?: Template;
+    /**
+     * 已废弃
+  <dx-alert infotype="notice" title="说明"> 仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置，则不存在该字段。</dx-alert>
+     */
+    Simple?: Simple;
+    /**
+     * 需要发送附件时，填写附件相关参数。腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍，应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 时接口会返回错误
+     */
+    Attachments?: Array<Attachment>;
+    /**
+     * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
+     */
+    Unsubscribe?: string;
+    /**
+     * 邮件触发类型 0:非触发类，默认类型，营销类邮件、非即时类邮件等选择此类型  1:触发类，验证码等即时发送类邮件，若邮件超过一定大小，系统会自动选择非触发类型通道
+     */
+    TriggerType?: number;
+    /**
+     * smtp头中的Message-Id字段
+     */
+    SmtpMessageId?: string;
+    /**
+     * smtp头中可以设置的其它字段
+     */
+    SmtpHeaders?: string;
+}
 /**
  * ListBlackEmailAddress返回参数结构体
  */
@@ -975,13 +1070,13 @@ export interface ListEmailIdentitiesResponse {
     RequestId?: string;
 }
 /**
- * DeleteReceiver返回参数结构体
+ * DeleteEmailTemplate请求参数结构体
  */
-export interface DeleteReceiverResponse {
+export interface DeleteEmailTemplateRequest {
     /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     * 模板ID
      */
-    RequestId?: string;
+    TemplateID: number;
 }
 /**
  * 模板内容，TEXT和HTML必须至少存在一项，建议使用TEXT和HTML的组合
@@ -1022,6 +1117,36 @@ export interface DeleteEmailAddressRequest {
      */
     EmailAddress: string;
 }
+/**
+ * 黑名单详情
+ */
+export interface BlackAddressDetail {
+    /**
+     * 黑名单地址id
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Id?: number;
+    /**
+     * 邮箱地址
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Email?: string;
+    /**
+     * 创建时间
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    CreateTime?: string;
+    /**
+     * 过期时间
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ExpireDate?: string;
+    /**
+     * 黑名单状态，0:已过期，1:生效中
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Status?: number;
+}
 /**
  * 发信域名验证列表结构体
  */
@@ -1065,6 +1190,15 @@ export interface BlackEmailAddress {
      */
     IspDesc?: string;
 }
+/**
+ * DeleteEmailAddress返回参数结构体
+ */
+export interface DeleteEmailAddressResponse {
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 创建重复周期发送邮件任务的参数
  */
@@ -1082,15 +1216,6 @@ export interface CycleEmailParam {
      */
     TermCycle?: number;
 }
-/**
- * DeleteEmailAddress返回参数结构体
- */
-export interface DeleteEmailAddressResponse {
-    /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
-     */
-    RequestId?: string;
-}
 /**
  * CreateEmailIdentity返回参数结构体
  */
@@ -1146,6 +1271,15 @@ export interface CreateEmailAddressRequest {
      */
     EmailSenderName?: string;
 }
+/**
+ * DeleteCustomBlackList返回参数结构体
+ */
+export interface DeleteCustomBlackListResponse {
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateReceiverDetail请求参数结构体
  */