tencentcloud-sdk-nodejs-ses 4.0.618 → 4.0.619

package/src/services/ses/v20201002/ses_models.ts

@@ -20,62 +20,51 @@
  */
 export interface BatchSendEmailRequest {
   /**
-      * 发信邮件地址。请填写发件人邮箱地址，例如：noreply@mail.qcloud.com。如需填写发件人说明，请按照
+   * 发信邮件地址。请填写发件人邮箱地址，例如：noreply@mail.qcloud.com。如需填写发件人说明，请按照
 发信人 <邮件地址> 的方式填写，例如：
 腾讯云团队 <noreply@mail.qcloud.com>
-      */
+   */
   FromEmailAddress: string
-
   /**
    * 收件人列表ID
    */
   ReceiverId: number
-
   /**
    * 邮件主题
    */
   Subject: string
-
   /**
    * 任务类型 1: 立即发送 2: 定时发送 3: 周期（频率）发送
    */
   TaskType: number
-
   /**
    * 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址，可以是个人邮箱。如果不填，收件人的回复邮件将会发送失败。
    */
   ReplyToAddresses?: string
-
   /**
    * 使用模板发送时，填写的模板相关参数
    */
   Template?: Template
-
   /**
    * 已废弃
    */
   Simple?: Simple
-
   /**
    * 需要发送附件时，填写附件相关参数（暂未支持）
    */
   Attachments?: Array<Attachment>
-
   /**
    * 周期发送任务的必要参数
    */
   CycleParam?: CycleEmailParam
-
   /**
    * 定时发送任务的必要参数
    */
   TimedParam?: TimedEmailParam
-
   /**
    * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
    */
   Unsubscribe?: string
-
   /**
    * 是否添加广告标识 0:不添加 1:添加到subject前面，2:添加到subject后面
    */
@@ -100,12 +89,10 @@ export interface ListSendTasksResponse {
    * 总数
    */
   TotalCount: number
-
   /**
    * 数据记录
    */
   Data: Array<SendTaskData>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -120,7 +107,6 @@ export interface CreateReceiverResponse {
    * 收件人列表id，后续根据收件人列表id上传收件人地址
    */
   ReceiverId: number
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -135,7 +121,6 @@ export interface CreateEmailTemplateRequest {
    * 模板名称
    */
   TemplateName: string
-
   /**
    * 模板内容
    */
@@ -147,11 +132,10 @@ export interface CreateEmailTemplateRequest {
  */
 export interface ListEmailAddressResponse {
   /**
-      * 发信地址列表详情
+   * 发信地址列表详情
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   EmailSenders?: Array<EmailSender>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -181,17 +165,14 @@ export interface ListReceiversRequest {
    * 偏移量，整型，从0开始
    */
   Offset: number
-
   /**
    * 限制数目，整型，不超过100
    */
   Limit: number
-
   /**
    * 列表状态(1 待上传 2 上传中  3传完成)，若查询所有就不传这个字段
    */
   Status?: number
-
   /**
    * 列表名称的关键字，模糊查询
    */
@@ -206,17 +187,14 @@ export interface GetEmailIdentityResponse {
    * 验证类型。固定值：DOMAIN
    */
   IdentityType?: string
-
   /**
    * 是否已通过验证
    */
   VerifiedForSendingStatus?: boolean
-
   /**
    * DNS配置详情
    */
   Attributes?: Array<DNSAttributes>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -231,27 +209,22 @@ export interface ListBlackEmailAddressRequest {
    * 开始日期，格式为YYYY-MM-DD
    */
   StartDate: string
-
   /**
    * 结束日期，格式为YYYY-MM-DD
    */
   EndDate: string
-
   /**
    * 规范，配合Offset使用
    */
   Limit: number
-
   /**
    * 规范，配合Limit使用，Limit最大取值为100
    */
   Offset: number
-
   /**
    * 可以指定邮箱进行查询
    */
   EmailAddress?: string
-
   /**
    * 可以指定任务ID进行查询
    */
@@ -266,7 +239,6 @@ export interface Attachment {
    * 附件名称，最大支持255个字符长度，不支持部分附件类型，详情请参考[附件类型](https://cloud.tencent.com/document/product/1288/51951)。
    */
   FileName: string
-
   /**
    * Base64之后的附件内容，你可以发送的附件大小上限为4M。注意：腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍。应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 接口会返回错误。
    */
@@ -281,12 +253,11 @@ export interface Template {
    * 模板ID。如果没有模板，请先新建一个
    */
   TemplateID: number
-
   /**
-      * 模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。
+   * 模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。
 注意：参数值不能是html等复杂类型的数据。
 示例：{"name":"xxx","age":"xx"}
-      */
+   */
   TemplateData: string
 }
 
@@ -298,22 +269,18 @@ export interface ListSendTasksRequest {
    * 偏移量，整型，从0开始，0代表跳过0行
    */
   Offset: number
-
   /**
    * 限制数目，整型,不超过100
    */
   Limit: number
-
   /**
    * 任务状态 1 待开始 5 发送中 6 今日暂停发送  7 发信异常 10 发送完成。查询所有状态，则不传这个字段
    */
   Status?: number
-
   /**
    * 收件人列表ID
    */
   ReceiverId?: number
-
   /**
    * 任务类型 1即时 2定时 3周期，查询所有类型则不传这个字段
    */
@@ -328,7 +295,6 @@ export interface GetSendEmailStatusResponse {
    * 邮件发送状态列表
    */
   EmailStatusList?: Array<SendEmailStatus>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -340,57 +306,47 @@ export interface GetSendEmailStatusResponse {
  */
 export interface SendEmailRequest {
   /**
-      * 发信邮件地址。请填写发件人邮箱地址，例如：noreply@mail.qcloud.com
+   * 发信邮件地址。请填写发件人邮箱地址，例如：noreply@mail.qcloud.com
 如需填写发件人说明，请按照如下方式： 
 别名 <邮箱地址>
-      */
+   */
   FromEmailAddress: string
-
   /**
    * 收信人邮箱地址，最多支持群发50人。注意：邮件内容会显示所有收件人地址，非群发邮件请多次调用API发送。
    */
   Destination: Array<string>
-
   /**
    * 邮件主题
    */
   Subject: string
-
   /**
    * 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址，可以是个人邮箱。如果不填，收件人的回复邮件将会发送失败。
    */
   ReplyToAddresses?: string
-
   /**
    * 抄送人邮箱地址，最多支持抄送20人。
    */
   Cc?: Array<string>
-
   /**
    * 密送人邮箱地址，最多支持抄送20人。
    */
   Bcc?: Array<string>
-
   /**
    * 使用模板发送时，填写的模板相关参数。因 Simple 已经废除使用，Template 为必填项
    */
   Template?: Template
-
   /**
    * 已废弃
    */
   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:触发类，验证码等即时发送类邮件，若邮件超过一定大小，系统会自动选择非触发类型通道
    */
@@ -415,17 +371,15 @@ export interface EmailSender {
    * 发信地址
    */
   EmailAddress: string
-
   /**
-      * 发信人别名
+   * 发信人别名
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   EmailSenderName: string
-
   /**
-      * 创建时间
+   * 创建时间
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   CreatedTimestamp: number
 }
 
@@ -437,7 +391,6 @@ export interface BatchSendEmailResponse {
    * 发送任务ID
    */
   TaskId?: number
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -492,17 +445,14 @@ export interface GetStatisticsReportRequest {
    * 开始日期
    */
   StartDate: string
-
   /**
    * 结束日期
    */
   EndDate: string
-
   /**
    * 发信域名
    */
   Domain?: string
-
   /**
    * 收件方邮箱类型，例如gmail.com
    */
@@ -517,7 +467,6 @@ export interface CreateReceiverRequest {
    * 收件人列表名称
    */
   ReceiversName: string
-
   /**
    * 收件人列表描述
    */
@@ -532,81 +481,66 @@ 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
-
   /**
    * 收件人列表名称
    */
@@ -621,22 +555,18 @@ export interface TemplatesMetadata {
    * 创建时间
    */
   CreatedTimestamp: number
-
   /**
    * 模板名称
    */
   TemplateName: string
-
   /**
    * 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用
    */
   TemplateStatus: number
-
   /**
    * 模板ID
    */
   TemplateID: number
-
   /**
    * 审核原因
    */
@@ -658,45 +588,38 @@ export interface DeleteEmailTemplateResponse {
  */
 export interface Volume {
   /**
-      * 日期
+   * 日期
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   SendDate: string
-
   /**
    * 邮件请求数量
    */
   RequestCount: number
-
   /**
    * 腾讯云通过数量
    */
   AcceptedCount: number
-
   /**
    * 送达数量
    */
   DeliveredCount: number
-
   /**
    * 打开邮件的用户数量，根据收件人去重
    */
   OpenedCount: number
-
   /**
    * 点击了邮件中的链接数量用户数量
    */
   ClickedCount: number
-
   /**
    * 退信数量
    */
   BounceCount: number
-
   /**
-      * 取消订阅的用户数量
+   * 取消订阅的用户数量
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   UnsubscribeCount: number
 }
 
@@ -718,7 +641,6 @@ export interface UpdateEmailSmtpPassWordRequest {
    * smtp密码，长度限制64
    */
   Password: string
-
   /**
    * 发信邮箱,长度限制128
    */
@@ -733,29 +655,24 @@ export interface ReceiverData {
    * 收件人列表ID
    */
   ReceiverId: number
-
   /**
    * 收件人列表名称
    */
   ReceiversName: string
-
   /**
    * 收件人地址总数
    */
   Count: number
-
   /**
-      * 收件人列表描述
+   * 收件人列表描述
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   Desc: string
-
   /**
-      * 列表状态(1 待上传 2 上传中 3 上传完成)
+   * 列表状态(1 待上传 2 上传中 3 上传完成)
 注意：此字段可能返回 null，表示取不到有效值。
-      */
+   */
   ReceiversStatus: number
-
   /**
    * 创建时间,如:2021-09-28 16:40:35
    */
@@ -770,17 +687,14 @@ export interface UpdateEmailIdentityResponse {
    * 验证类型。固定值：DOMAIN
    */
   IdentityType?: string
-
   /**
    * 是否已通过验证
    */
   VerifiedForSendingStatus?: boolean
-
   /**
    * 需要配置的DNS信息
    */
   Attributes?: Array<DNSAttributes>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -815,12 +729,10 @@ export interface UpdateEmailTemplateRequest {
    * 模板内容
    */
   TemplateContent: TemplateContent
-
   /**
    * 模板ID
    */
   TemplateID: number
-
   /**
    * 模板名字
    */
@@ -835,19 +747,16 @@ export interface SendEmailStatus {
    * SendEmail返回的MessageId
    */
   MessageId: string
-
   /**
    * 收件人邮箱
    */
   ToEmailAddress: string
-
   /**
    * 发件人邮箱
    */
   FromEmailAddress: string
-
   /**
-      * 腾讯云处理状态
+   * 腾讯云处理状态
 0: 处理成功
 1001: 内部系统异常
 1002: 内部系统异常
@@ -872,49 +781,41 @@ export interface SendEmailStatus {
 3024: 邮箱地址格式预检查失败
 3030: 退信率过高，临时限制发送
 3033: 余额不足，账号欠费等
-      */
+   */
   SendStatus: number
-
   /**
-      * 收件方处理状态
+   * 收件方处理状态
 0: 请求成功被腾讯云接受，进入发送队列
 1: 邮件递送成功，DeliverTime表示递送成功的时间
 2: 邮件因某种原因被丢弃，DeliverMessage表示丢弃原因
 3: 收件方ESP拒信，一般原因为邮箱地址不存在，或其它原因
 8: 邮件被ESP因某些原因延迟递送，DeliverMessage表示延迟原因
-      */
+   */
   DeliverStatus: number
-
   /**
    * 收件方处理状态描述
    */
   DeliverMessage: string
-
   /**
    * 请求到达腾讯云时间戳
    */
   RequestTime: number
-
   /**
    * 腾讯云执行递送时间戳
    */
   DeliverTime: number
-
   /**
    * 用户是否打开该邮件
    */
   UserOpened: boolean
-
   /**
    * 用户是否点击该邮件中的链接
    */
   UserClicked: boolean
-
   /**
    * 用户是否取消该发送者的订阅
    */
   UserUnsubscribed: boolean
-
   /**
    * 用户是否举报该发送者
    */
@@ -929,7 +830,6 @@ export interface ListEmailTemplatesRequest {
    * 获取模板数据量，用于分页
    */
   Limit: number
-
   /**
    * 获取模板偏移值，用于分页
    */
@@ -954,11 +854,10 @@ export interface ReceiverInputData {
    * 收件人邮箱
    */
   Email: string
-
   /**
-      * 模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。
+   * 模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。
 注意：参数值不能是html等复杂类型的数据。TemplateData (整个 JSON 结构) 总长度限制为 800 bytes。
-      */
+   */
   TemplateData: string
 }
 
@@ -980,12 +879,10 @@ export interface ListEmailTemplatesResponse {
    * 邮件模板列表
    */
   TemplatesMetadata: Array<TemplatesMetadata>
-
   /**
    * 模板总数量
    */
   TotalCount: number
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1000,7 +897,6 @@ export interface SendEmailResponse {
    * 接受消息生成的唯一消息标识符。
    */
   MessageId?: string
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1015,12 +911,10 @@ export interface ListBlackEmailAddressResponse {
    * 黑名单列表
    */
   BlackList?: Array<BlackEmailAddress>
-
   /**
    * 黑名单总数
    */
   TotalCount?: number
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1035,22 +929,18 @@ export interface GetSendEmailStatusRequest {
    * 发送的日期，必填。仅支持查询某个日期，不支持范围查询。
    */
   RequestDate: string
-
   /**
    * 偏移量。默认为0
    */
   Offset: number
-
   /**
    * 拉取最大条数，最多 100。
    */
   Limit: number
-
   /**
    * SendMail接口返回的MessageId字段。
    */
   MessageId?: string
-
   /**
    * 收件人邮箱。
    */
@@ -1065,7 +955,6 @@ export interface Simple {
    * base64之后的Html代码。需要包含所有的代码信息，不要包含外部css，否则会导致显示格式错乱
    */
   Html?: string
-
   /**
    * base64之后的纯文本信息，如果没有Html，邮件中会直接显示纯文本；如果有Html，它代表邮件的纯文本样式
    */
@@ -1090,17 +979,14 @@ export interface ListEmailIdentitiesResponse {
    * 发信域名列表
    */
   EmailIdentities: Array<EmailIdentity>
-
   /**
    * 最大信誉等级
    */
   MaxReputationLevel: number
-
   /**
    * 单域名最高日发送量
    */
   MaxDailyQuota: number
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1125,7 +1011,6 @@ export interface TemplateContent {
    * base64之后的Html代码
    */
   Html?: string
-
   /**
    * base64之后的文本内容
    */
@@ -1140,12 +1025,10 @@ export interface GetStatisticsReportResponse {
    * 发信统计报告，按天
    */
   DailyVolumes: Array<Volume>
-
   /**
    * 发信统计报告，总览
    */
   OverallVolume: Volume
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1170,22 +1053,18 @@ export interface EmailIdentity {
    * 发信域名
    */
   IdentityName: string
-
   /**
    * 验证类型，固定为DOMAIN
    */
   IdentityType: string
-
   /**
    * 是否已通过验证
    */
   SendingEnabled: boolean
-
   /**
    * 当前信誉等级
    */
   CurrentReputationLevel: number
-
   /**
    * 当日最高发信量
    */
@@ -1200,7 +1079,6 @@ export interface BlackEmailAddress {
    * 邮箱被拉黑时间
    */
   BounceTime: string
-
   /**
    * 被拉黑的邮箱地址
    */
@@ -1215,12 +1093,10 @@ export interface CycleEmailParam {
    * 任务开始时间
    */
   BeginTime: string
-
   /**
    * 任务周期 小时维度
    */
   IntervalTime: number
-
   /**
    * 是否终止周期，用于任务更新 0否1是
    */
@@ -1245,17 +1121,14 @@ export interface CreateEmailIdentityResponse {
    * 验证类型。固定值：DOMAIN
    */
   IdentityType?: string
-
   /**
    * 是否已通过验证
    */
   VerifiedForSendingStatus?: boolean
-
   /**
    * 需要配置的DNS信息
    */
   Attributes?: Array<DNSAttributes>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1270,7 +1143,6 @@ export interface CreateEmailAddressRequest {
    * 您的发信地址（发信地址总数上限为10个）
    */
   EmailAddress: string
-
   /**
    * 发件人别名
    */
@@ -1285,7 +1157,6 @@ export interface CreateReceiverDetailRequest {
    * 收件人列表ID
    */
   ReceiverId: number
-
   /**
    * 邮箱
    */
@@ -1300,7 +1171,6 @@ export interface CreateEmailTemplateResponse {
    * 模板id
    */
   TemplateID: number
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1315,12 +1185,10 @@ export interface ListReceiversResponse {
    * 总数
    */
   TotalCount: number
-
   /**
    * 数据记录
    */
   Data: Array<ReceiverData>
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1355,7 +1223,6 @@ export interface CreateReceiverDetailWithDataRequest {
    * 收件人列表ID
    */
   ReceiverId: number
-
   /**
    * 收信人邮箱以及模板参数，数组形式。收件人个数限制20000个以内。
    */
@@ -1380,22 +1247,18 @@ export interface DNSAttributes {
    * 记录类型 CNAME | A | TXT | MX
    */
   Type: string
-
   /**
    * 域名
    */
   SendDomain: string
-
   /**
    * 需要配置的值
    */
   ExpectedValue: string
-
   /**
    * 腾讯云目前检测到的值
    */
   CurrentValue: string
-
   /**
    * 检测是否通过，创建时默认为false
    */
@@ -1410,17 +1273,14 @@ export interface GetEmailTemplateResponse {
    * 模板内容数据
    */
   TemplateContent: TemplateContent
-
   /**
    * 模板状态 0-审核通过 1-待审核 2-审核拒绝
    */
   TemplateStatus: number
-
   /**
    * 模板名称
    */
   TemplateName: string
-
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */