tencentcloud-sdk-nodejs 4.0.665 → 4.0.666

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/CHANGELOG.md +154 -0
  2. package/SERVICE_CHANGELOG.md +183 -114
  3. package/package.json +1 -1
  4. package/products.md +13 -13
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apigateway/v20180808/apigateway_models.ts +2 -2
  7. package/src/services/cdb/v20170320/cdb_models.ts +3 -3
  8. package/src/services/cynosdb/v20190107/cynosdb_models.ts +33 -3
  9. package/src/services/dasb/v20191018/dasb_client.ts +5 -3
  10. package/src/services/dasb/v20191018/dasb_models.ts +153 -73
  11. package/src/services/emr/v20190103/emr_client.ts +23 -10
  12. package/src/services/emr/v20190103/emr_models.ts +129 -52
  13. package/src/services/ess/v20201111/ess_models.ts +214 -85
  14. package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
  15. package/src/services/live/v20180801/live_models.ts +9 -5
  16. package/src/services/ssl/v20191205/ssl_models.ts +9 -0
  17. package/src/services/teo/v20220901/teo_models.ts +12 -3
  18. package/src/services/tke/v20180525/tke_models.ts +1 -1
  19. package/src/services/vpc/v20170312/vpc_models.ts +2 -2
  20. package/src/services/waf/v20180125/waf_models.ts +1 -1
  21. package/tencentcloud/common/sdk_version.d.ts +1 -1
  22. package/tencentcloud/common/sdk_version.js +1 -1
  23. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +2 -2
  24. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +3 -3
  25. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +33 -3
  26. package/tencentcloud/services/dasb/v20191018/dasb_client.d.ts +1 -1
  27. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +150 -72
  28. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +7 -3
  29. package/tencentcloud/services/emr/v20190103/emr_client.js +9 -3
  30. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +126 -52
  31. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +214 -85
  32. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  33. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  34. package/tencentcloud/services/live/v20180801/live_models.d.ts +9 -5
  35. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +9 -0
  36. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +12 -3
  37. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +1 -1
  38. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +2 -2
  39. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +1 -1
  40. package/test/emr.v20190103.test.js +12 -2
@@ -3045,7 +3045,7 @@ export interface CreateEmbedWebUrlRequest {
3045
3045
  /**
3046
3046
  * WEB嵌入的业务资源ID
3047
3047
  <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
3048
- <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模版id
3048
+ <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
3049
3049
  <br/>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id
3050
3050
  */
3051
3051
  BusinessId?: string
@@ -3234,101 +3234,160 @@ export interface DeleteIntegrationRoleUsersRequest {
3234
3234
  */
3235
3235
  export interface CreateFlowByFilesRequest {
3236
3236
  /**
3237
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
3237
+ * 执行本接口操作的员工信息。
3238
+ 使用此接口时,必须填写userId。
3239
+ 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3240
+ 支持填入集团子公司经办人 userId 代发合同。
3238
3241
  */
3239
3242
  Operator: UserInfo
3240
3243
  /**
3241
- * 签署流程名称,最大长度200个字符
3244
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
3245
+ 该名称还将用于合同签署完成后的下载文件名。
3242
3246
  */
3243
3247
  FlowName: string
3244
3248
  /**
3245
- * 签署参与者信息,最大限制50
3249
+ * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
3250
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
3246
3251
  */
3247
3252
  Approvers: Array<ApproverInfo>
3248
3253
  /**
3249
- * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
3254
+ * 本合同流程需包含的PDF文件资源编号列表,通过UploadFiles接口获取PDF文件资源编号。目前,此接口仅支持单个文件发起。
3250
3255
  */
3251
3256
  FileIds: Array<string>
3252
3257
  /**
3253
- * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
3258
+ * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
3259
+ */
3260
+ FlowDescription?: string
3261
+ /**
3262
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
3254
3263
  */
3255
3264
  FlowType?: string
3256
3265
  /**
3257
- * 经办人内容控件配置
3266
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
3267
+ - 单行文本控件
3268
+ - 多行文本控件
3269
+ - 勾选框控件
3270
+ - 数字控件
3271
+ - 图片控件
3272
+ - 动态表格等填写控件
3258
3273
  */
3259
3274
  Components?: Array<Component>
3260
3275
  /**
3261
- * 被抄送人的信息列表。
3262
- 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
3276
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
3277
+ 注:此功能为白名单功能,使用前请联系对接的客户经理沟通。
3263
3278
  */
3264
3279
  CcInfos?: Array<CcInfo>
3265
3280
  /**
3266
- * 是否需要预览,true:预览模式,false:非预览(默认);
3267
- 预览链接有效期300秒;
3281
+ * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
3268
3282
 
3269
- 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
3283
+ - 0:合同发起时通知(默认值)
3284
+ - 1:签署完成后通知
3285
+ */
3286
+ CcNotifyType?: number
3287
+ /**
3288
+ * 是否为预览模式,取值如下:
3289
+
3290
+ false:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。
3291
+
3292
+ true:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。
3270
3293
  */
3271
3294
  NeedPreview?: boolean
3272
3295
  /**
3273
- * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
3296
+ *
3297
+ 预览模式下产生的预览链接类型
3298
+
3299
+ - 0 :(默认) 文件流 ,点开后后下载预览的合同PDF文件
3300
+
3301
+ - 1 :H5链接 ,点开后在浏览器中展示合同的样子
3302
+
3303
+ 注意: 此参数在NeedPreview 为true时有效
3274
3304
  */
3275
3305
  PreviewType?: number
3276
3306
  /**
3277
- * 签署流程的签署截止时间。
3278
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
3307
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
3308
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3279
3309
  */
3280
3310
  Deadline?: number
3281
3311
  /**
3282
- * 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
3312
+ * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
3313
+ 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
3283
3314
  */
3284
3315
  RemindedOn?: number
3285
3316
  /**
3286
- * 发送类型:
3287
- true:无序签
3288
- false:有序签
3289
- 注:默认为false(有序签)
3317
+ *
3318
+ 合同流程的签署顺序类型:
3319
+ - false:(默认)有序签署, 本合同多个参与人需要依次签署
3320
+ - true:无序签署, 本合同多个参与人没有先后签署限制
3290
3321
  */
3291
3322
  Unordered?: boolean
3292
3323
  /**
3293
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
3324
+ * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
3325
+
3326
+ - {合同名称}
3327
+ - {发起方企业}
3328
+ - {发起方姓名}
3329
+ - {签署方N企业}
3330
+ - {签署方N姓名}
3331
+
3332
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
3333
+
3334
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:
3335
+ 合同名称:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`
3336
+
3337
+ 则小程序中列表页展示此合同为以下样子
3338
+ ```
3339
+ 合同名称:租房合同
3340
+ 发起方:腾讯公司(张三)
3341
+ 签署方:李四
3342
+ ```
3294
3343
  */
3295
3344
  CustomShowMap?: string
3296
3345
  /**
3297
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3298
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
3346
+ *
3347
+ 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3299
3348
 
3300
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
3349
+ - false:(默认)不需要审批,直接签署。
3350
+ - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
3351
+
3352
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3353
+
3354
+ - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
3355
+ - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
3356
+
3357
+ 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
3301
3358
  */
3302
3359
  NeedSignReview?: boolean
3303
3360
  /**
3304
- * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
3361
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
3362
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
3363
+ 回调的相关说明可参考开发者中心的"回调通知"模块。
3305
3364
  */
3306
3365
  UserData?: string
3307
3366
  /**
3308
- * 签署人校验方式
3309
- VerifyCheck: 人脸识别(默认)
3310
- MobileCheck:手机号验证
3311
- 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
3367
+ * 指定个人签署方查看合同的校验方式
3368
+
3369
+ - VerifyCheck :(默认)人脸识别,人脸识别后才能合同内容
3370
+ - MobileCheck: 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
3312
3371
  */
3313
3372
  ApproverVerifyType?: string
3314
3373
  /**
3315
- * 签署流程描述,最大长度1000个字符
3316
- */
3317
- FlowDescription?: string
3318
- /**
3319
- * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
3374
+ * 签署方签署控件(印章/签名等)的生成方式:
3375
+
3376
+ - 0:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。
3377
+ - 1:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
3320
3378
  */
3321
3379
  SignBeanTag?: number
3322
3380
  /**
3323
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3381
+ * 代理企业和员工的信息。
3382
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3324
3383
  */
3325
3384
  Agent?: Agent
3326
3385
  /**
3327
- * 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
3328
- */
3329
- CcNotifyType?: number
3330
- /**
3331
- * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
3386
+ * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
3387
+
3388
+ - E_PRESCRIPTION_AUTO_SIGN:处方单(医疗自动签)
3389
+
3390
+ 注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。
3332
3391
  */
3333
3392
  AutoSignScene?: string
3334
3393
  }
@@ -3488,15 +3547,17 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3488
3547
  */
3489
3548
  export interface CreateFlowByFilesResponse {
3490
3549
  /**
3491
- * 签署流程编号。
3550
+ * 合同流程ID,为32位字符串。
3551
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3552
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3492
3553
 
3493
- 注:如入参 是否需要预览 NeedPreview 设置为 true,不会正式发起合同,此处不会有值返回;如入参 是否需要预览 NeedPreview 设置为 false,此处会正常返回签署流程编号 FlowId。
3554
+ 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
3494
3555
  */
3495
3556
  FlowId?: string
3496
3557
  /**
3497
- * 合同预览链接。
3558
+ * 合同预览链接URL。
3498
3559
 
3499
- 注:如入参 是否需要预览 NeedPreview 设置为 true,会开启“预览模式”,此处会返回预览链接;如入参 是否需要预览 NeedPreview 设置为 false,此处不会有值返回。
3560
+ 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
3500
3561
  注意:此字段可能返回 null,表示取不到有效值。
3501
3562
  */
3502
3563
  PreviewUrl?: string
@@ -3654,59 +3715,89 @@ export interface FailedCreateRoleData {
3654
3715
  */
3655
3716
  export interface ApproverInfo {
3656
3717
  /**
3657
- * 参与者类型:
3718
+ * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
3658
3719
  0:企业
3659
3720
  1:个人
3660
3721
  3:企业静默签署
3661
3722
  注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
3662
3723
  7: 个人自动签署,适用于个人自动签场景。
3663
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
3724
+ 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
3664
3725
  */
3665
3726
  ApproverType: number
3666
3727
  /**
3667
- * 签署人的姓名
3728
+ * 签署方经办人的姓名。
3729
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
3668
3730
  */
3669
3731
  ApproverName: string
3670
3732
  /**
3671
- * 签署人的手机号,11位数字
3733
+ * 本企业的签署方经办人的员工UserId
3734
+
3735
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3736
+
3737
+ 注: 若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。
3672
3738
  */
3673
3739
  ApproverMobile: string
3674
3740
  /**
3675
- * 如果签署方是企业签署方(approverType = 1 或者 approverType = 3),
3741
+ * 组织机构名称。
3742
+ 如果签署方是企业签署方(approverType = 1 或者 approverType = 3), 则企业名称必填。
3676
3743
 
3677
- 则企业名称必填
3744
+ 注: 请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。
3678
3745
  */
3679
3746
  OrganizationName?: string
3680
3747
  /**
3681
- * 签署人的签署控件列表
3748
+ * 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
3749
+ - 个人签名/印章
3750
+ - 企业印章
3751
+ - 骑缝章等签署控件
3682
3752
  */
3683
3753
  SignComponents?: Array<Component>
3684
3754
  /**
3685
- * 签署人的证件类型
3686
- ID_CARD 身份证
3687
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
3688
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3689
- OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
3755
+ * 签署方经办人的证件类型,支持以下类型
3756
+ - ID_CARD 居民身份证 (默认值)
3757
+ - HONGKONG_AND_MACAO 港澳居民来往内地通行证
3758
+ - HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3759
+ - OTHER_CARD_TYPE 其他证件
3760
+
3761
+ 注: 其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
3690
3762
  */
3691
3763
  ApproverIdCardType?: string
3692
3764
  /**
3693
- * 签署人证件号(长度不超过18位)
3765
+ * 签署方经办人的证件号码,应符合以下规则
3766
+ - 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
3767
+ - 港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。
3768
+ - 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
3694
3769
  */
3695
3770
  ApproverIdCardNumber?: string
3696
3771
  /**
3697
- * 签署通知类型:sms--短信,none--不通知
3772
+ * 通知签署方经办人的方式, 有以下途径:
3773
+
3774
+ - sms: (默认)短信
3775
+ - none: 不通知
3698
3776
  */
3699
3777
  NotifyType?: string
3700
3778
  /**
3701
- * 签署人角色类型:1--收款人、2--开具人、3--见证人
3779
+ * 收据场景设置签署人角色类型, 可以设置如下类型:
3780
+ - 1:收款人
3781
+ - 2:开具人
3782
+ - 3:见证人
3783
+
3784
+ 注: 收据场景为白名单功能,使用前请联系对接的客户经理沟通。
3702
3785
  */
3703
3786
  ApproverRole?: number
3704
3787
  /**
3705
3788
  * 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
3789
+
3790
+ 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
3706
3791
  */
3707
3792
  VerifyChannel?: Array<string>
3708
3793
  /**
3709
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
3794
+ * 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
3795
+
3796
+ 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
3797
+
3798
+ - 合同页数少于等于2页,阅读时间为3秒;
3799
+ - 合同页数为3到5页,阅读时间为5秒;
3800
+ - 合同页数大于等于6页,阅读时间为10秒。
3710
3801
  */
3711
3802
  PreReadTime?: number
3712
3803
  /**
@@ -3716,35 +3807,60 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
3716
3807
  */
3717
3808
  UserId?: string
3718
3809
  /**
3719
- * 签署人用户来源,此参数仅针对企微用户开放
3720
-
3721
- 企微侧用户请传入:WEWORKAPP
3810
+ * 在企微场景下使用,需设置参数为WEWORKAPP,以表明合同来源于企微。
3722
3811
  */
3723
3812
  ApproverSource?: string
3724
3813
  /**
3725
- * 企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
3814
+ * 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
3815
+ 所有参与或签的人员均需具备该标识。
3816
+ 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
3817
+ 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
3726
3818
  */
3727
3819
  CustomApproverTag?: string
3728
3820
  /**
3729
- * 签署人个性化能力值
3821
+ * 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
3822
+ 详细操作可以参考开发者中心的ApproverOption结构体。
3730
3823
  */
3731
3824
  ApproverOption?: ApproverOption
3732
3825
  /**
3733
- * 签署人查看合同时认证方式,
3734
- 1-实名查看 2-短信验证码查看(企业签署方不支持该方式)
3735
- 如果不传默认为1
3736
- 模板发起的时候,认证方式以模板配置为主
3826
+ * 指定个人签署方查看合同的校验方式,可以传值如下:
3827
+
3828
+ - 1 : (默认)人脸识别,人脸识别后才能合同内容
3829
+ - 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
3830
+
3831
+ 注:
3832
+
3833
+ - 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
3834
+ - 此字段不可传多个校验方式
3737
3835
  */
3738
3836
  ApproverVerifyTypes?: Array<number>
3739
3837
  /**
3740
- * 签署人签署合同时的认证方式
3741
- 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
3742
- 合同签署认证方式的优先级 verifyChannel>approverSignTypes
3743
- 模板发起的时候,认证方式以模板配置为主
3838
+ * 您可以指定签署方签署合同的认证校验方式,可传递以下值:
3839
+
3840
+ - 1:人脸认证,需进行人脸识别成功后才能签署合同;
3841
+ - 2:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
3842
+ - 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
3843
+
3844
+ 注:
3845
+
3846
+ - 默认情况下,认证校验方式为人脸认证和签署密码两种形式;
3847
+ - 您可以传递多种值,表示可用多种认证校验方式。
3848
+
3744
3849
  */
3745
3850
  ApproverSignTypes?: Array<number>
3746
3851
  /**
3747
- * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要。为个人签署方时则由发起方企业审核。
3852
+ *
3853
+ 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3854
+
3855
+ - false:(默认)不需要审批,直接签署。
3856
+ - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
3857
+
3858
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3859
+
3860
+ - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
3861
+ - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
3862
+
3863
+ 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
3748
3864
  */
3749
3865
  ApproverNeedSignReview?: boolean
3750
3866
  }
@@ -4378,11 +4494,17 @@ false:不开启发起方发起合同审核
4378
4494
  */
4379
4495
  export interface ApproverOption {
4380
4496
  /**
4381
- * 是否可以拒签 默认false-可以拒签 true-不可以拒签
4497
+ * 签署方是否可以拒签
4498
+
4499
+ - false: ( 默认)可以拒签
4500
+ - true:不可以拒签
4382
4501
  */
4383
4502
  NoRefuse?: boolean
4384
4503
  /**
4385
- * 是否可以转发 默认false-可以转发 true-不可以转发
4504
+ * 签署方是否可以转他人处理
4505
+
4506
+ - false: ( 默认)可以转他人处理
4507
+ - true:不可以转他人处理
4386
4508
  */
4387
4509
  NoTransfer?: boolean
4388
4510
  }
@@ -5537,27 +5659,34 @@ export interface DescribeExtendedServiceAuthInfosResponse {
5537
5659
  */
5538
5660
  export interface CcInfo {
5539
5661
  /**
5540
- * 被抄送人手机号,11位数字
5662
+ * 被抄送方手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
5663
+ 请确认手机号所有方为此业务通知方。
5541
5664
  */
5542
5665
  Mobile?: string
5543
5666
  /**
5544
- * 被抄送人姓名
5667
+ * 被抄送方姓名。
5668
+ 抄送方的姓名将用于身份认证,请确保填写的姓名为抄送方的真实姓名,而非昵称等代名。
5545
5669
  */
5546
5670
  Name?: string
5547
5671
  /**
5548
- * 被抄送人类型,
5549
- 0--个人
5550
- 1--员工
5672
+ * 被抄送方类型, 可设置以下类型:
5673
+
5674
+ - 0:个人抄送方
5675
+ - 1:企业员工抄送方
5551
5676
  */
5552
5677
  CcType?: number
5553
5678
  /**
5554
- * 被抄送人权限
5555
- 0--可查看
5556
- 1--可查看也可下载
5679
+ * 被抄送方权限, 可设置如下权限:
5680
+
5681
+ - 0:可查看合同内容
5682
+ - 1:可查看合同内容也可下载原文
5557
5683
  */
5558
5684
  CcPermission?: number
5559
5685
  /**
5560
- * 关注方通知类型:sms--短信,none--不通知
5686
+ * 通知签署方经办人的方式, 有以下途径:
5687
+
5688
+ - sms: (默认)短信
5689
+ - none: 不通知
5561
5690
  */
5562
5691
  NotifyType?: string
5563
5692
  }
@@ -745,7 +745,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
745
745
  >
746
746
  > 3:取消部分子客授权 OperateType=DELETE
747
747
  > - 对子客企业进行模板库中模板可见性的进行删除操作。
748
- > - 主要对于手动领取的模板,去除授权后子客在在模板库中看不到,就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
748
+ > - 主要对于手动领取的模板,去除授权后子客在模板库中看不到,就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
749
749
  > - 对于自动领取的模板,由于已经下发,更改授权不会影响。
750
750
  > - 如果要同步删除子客自有模板库中的模板,请使用OperateType=UPDATE+Available参数处理。
751
751
  */
@@ -706,13 +706,13 @@ export interface ResumeDelayLiveStreamRequest {
706
706
  export interface DescribeCallbackRecordsListRequest {
707
707
  /**
708
708
  * 起始时间点,接口查询支持两种时间格式:
709
- 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
709
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)
710
710
  2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。
711
711
  */
712
712
  StartTime: string
713
713
  /**
714
714
  * 结束时间点,接口查询支持两种时间格式:
715
- 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
715
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)
716
716
  2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。
717
717
 
718
718
  查询的起始和结束时间跨度不支持超过1天。仅支持查询最近14天的数据。
@@ -751,8 +751,8 @@ export interface DescribeCallbackRecordsListRequest {
751
751
  export interface CallbackEventInfo {
752
752
  /**
753
753
  * 事件时间。
754
- 数据时间点,接口返回支持两种时间格式:
755
- 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见ISO日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
754
+ 接口返回支持两种时间格式:
755
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)
756
756
  2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
757
757
  接口返回的时间格式和查询请求传入的时间格式一致。
758
758
  */
@@ -770,7 +770,11 @@ export interface CallbackEventInfo {
770
770
  */
771
771
  Response?: string
772
772
  /**
773
- * 客户接口响应时间
773
+ * 客户接口响应时间。
774
+ 接口返回支持两种时间格式:
775
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)
776
+ 2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
777
+ 接口返回的时间格式和查询请求传入的时间格式一致。
774
778
  */
775
779
  ResponseTime?: string
776
780
  /**
@@ -2751,6 +2751,15 @@ export interface ReplaceCertificateRequest {
2751
2751
  * 重颁发原因。
2752
2752
  */
2753
2753
  Reason?: string
2754
+ /**
2755
+ * CSR加密方式,可选:RSA、ECC、SM2
2756
+ (CsrType为Online才可选), 默认为RSA
2757
+ */
2758
+ CertCSREncryptAlgo?: string
2759
+ /**
2760
+ * CSR加密参数,CsrEncryptAlgo为RSA时, 可选2048、4096等默认为2048;CsrEncryptAlgo为ECC时,可选prime256v1,secp384r1等,默认为prime256v1;
2761
+ */
2762
+ CertCSRKeyParameter?: string
2754
2763
  }
2755
2764
 
2756
2765
  /**
@@ -1804,6 +1804,11 @@ export interface ApplicationProxyRule {
1804
1804
  <li>端口段:81-82,表示81,82两个端口。</li>
1805
1805
  */
1806
1806
  OriginPort?: string
1807
+ /**
1808
+ * 规则标签。
1809
+ 注意:此字段可能返回 null,表示取不到有效值。
1810
+ */
1811
+ RuleTag?: string
1807
1812
  }
1808
1813
 
1809
1814
  /**
@@ -2714,11 +2719,11 @@ export interface DescribeApplicationProxiesResponse {
2714
2719
  /**
2715
2720
  * 应用代理列表。
2716
2721
  */
2717
- ApplicationProxies: Array<ApplicationProxy>
2722
+ ApplicationProxies?: Array<ApplicationProxy>
2718
2723
  /**
2719
2724
  * 记录总数。
2720
2725
  */
2721
- TotalCount: number
2726
+ TotalCount?: number
2722
2727
  /**
2723
2728
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2724
2729
  */
@@ -3846,6 +3851,10 @@ export interface CreateApplicationProxyRuleRequest {
3846
3851
  <li>端口段:81-90,81至90端口。</li>
3847
3852
  */
3848
3853
  OriginPort?: string
3854
+ /**
3855
+ * 规则标签。默认值为空字符串。
3856
+ */
3857
+ RuleTag?: string
3849
3858
  }
3850
3859
 
3851
3860
  /**
@@ -4255,7 +4264,7 @@ export interface DescribeApplicationProxiesRequest {
4255
4264
  */
4256
4265
  Limit?: number
4257
4266
  /**
4258
- * 过滤条件,Filters.Values的上限为20。详细的过滤条件如下:<li>proxy-id<br>   按照【<strong>代理ID</strong>】进行过滤。代理ID形如:proxy-ev2sawbwfd。<br>   类型:String<br>   必选:否</li><li>zone-id<br>   按照【<strong>站点ID</strong>】进行过滤。站点ID形如:zone-vawer2vadg。<br>   类型:String<br>   必选:否</li>
4267
+ * 过滤条件,Filters.Values的上限为20。详细的过滤条件如下:<li>proxy-id<br>   按照【<strong>代理ID</strong>】进行过滤。代理ID形如:proxy-ev2sawbwfd。<br>   类型:String<br>   必选:否</li><li>zone-id<br>   按照【<strong>站点ID</strong>】进行过滤。站点ID形如:zone-vawer2vadg。<br>   类型:String<br>   必选:否</li><li>rule-tag<br>   按照【<strong>规则标签</strong>】对应用代理下的规则进行过滤。规则标签形如:rule-service-1。<br>   类型:String<br>   必选:否</li>
4259
4268
  */
4260
4269
  Filters?: Array<Filter>
4261
4270
  }
@@ -3367,7 +3367,7 @@ export interface DeleteEdgeCVMInstancesResponse {
3367
3367
  */
3368
3368
  export interface DescribeClusterKubeconfigResponse {
3369
3369
  /**
3370
- * 子账户kubeconfig文件,可用于直接访问集群kube-apiserver
3370
+ * 子账户kubeconfig文件,可用于直接访问集群kube-apiserver(入参IsExtranet为false,返回内网访问的kubeconfig,没开内网的情况下server会是一个默认域名;入参IsExtranet为true,返回外网的kubeconfig,没开外网的情况下server会是一个默认域名。默认域名默认不可达,需要自行处理)
3371
3371
  */
3372
3372
  Kubeconfig?: string
3373
3373
  /**
@@ -2858,8 +2858,8 @@ export interface DescribeSecurityGroupsRequest {
2858
2858
  <li>security-group-id - String - (过滤条件)安全组ID。</li>
2859
2859
  <li>project-id - Integer - (过滤条件)项目ID。</li>
2860
2860
  <li>security-group-name - String - (过滤条件)安全组名称。</li>
2861
- <li>tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。使用请参考示例2。</li>
2862
- <li>tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例3。</li>
2861
+ <li>tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。</li>
2862
+ <li>tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 其中 tag-key 请使用具体的标签键进行替换。</li>
2863
2863
  */
2864
2864
  Filters?: Array<Filter>
2865
2865
  /**
@@ -1134,7 +1134,7 @@ export interface CreateHostResponse {
1134
1134
  /**
1135
1135
  * 新增防护域名ID
1136
1136
  */
1137
- DomainId: string
1137
+ DomainId?: string
1138
1138
  /**
1139
1139
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1140
1140
  */
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.665";
1
+ export declare const sdkVersion = "4.0.666";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.665";
4
+ exports.sdkVersion = "4.0.666";
@@ -3598,7 +3598,7 @@ export interface CreateApiRequest {
3598
3598
  */
3599
3599
  ServiceId: string;
3600
3600
  /**
3601
- * API 的后端服务类型。支持HTTP、MOCK、TSF、SCF、WEBSOCKET、TARGET(内测)。
3601
+ * API 的后端服务类型。支持HTTP、MOCK、TSF、SCF、EB、TARGET、VPC、UPSTREAM、GRPC、COS、WEBSOCKET。
3602
3602
  */
3603
3603
  ServiceType: string;
3604
3604
  /**
@@ -5781,7 +5781,7 @@ export interface AttachPluginResponse {
5781
5781
  /**
5782
5782
  * 绑定操作是否成功。
5783
5783
  */
5784
- Result: boolean;
5784
+ Result?: boolean;
5785
5785
  /**
5786
5786
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5787
5787
  */