tencentcloud-sdk-nodejs 4.0.667 → 4.0.669

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 (88) hide show
  1. package/CHANGELOG.md +339 -0
  2. package/SERVICE_CHANGELOG.md +329 -66
  3. package/package.json +1 -1
  4. package/products.md +24 -24
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cam/v20190116/cam_models.ts +11 -11
  7. package/src/services/cdb/v20170320/cdb_client.ts +13 -30
  8. package/src/services/cdb/v20170320/cdb_models.ts +0 -54
  9. package/src/services/cdn/v20180606/cdn_models.ts +4 -0
  10. package/src/services/cls/v20201016/cls_client.ts +4 -2
  11. package/src/services/cls/v20201016/cls_models.ts +1 -1
  12. package/src/services/cwp/v20180228/cwp_models.ts +5 -3
  13. package/src/services/cynosdb/v20190107/cynosdb_client.ts +1 -1
  14. package/src/services/cynosdb/v20190107/cynosdb_models.ts +17 -13
  15. package/src/services/dts/v20211206/dts_client.ts +30 -6
  16. package/src/services/dts/v20211206/dts_models.ts +80 -0
  17. package/src/services/ecm/v20190719/ecm_models.ts +4 -0
  18. package/src/services/ess/v20201111/ess_client.ts +2 -3
  19. package/src/services/ess/v20201111/ess_models.ts +135 -143
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +16 -7
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +108 -34
  22. package/src/services/iotvideo/v20211125/iotvideo_client.ts +24 -12
  23. package/src/services/iotvideo/v20211125/iotvideo_models.ts +42 -0
  24. package/src/services/lcic/v20220817/lcic_client.ts +15 -3
  25. package/src/services/lcic/v20220817/lcic_models.ts +32 -12
  26. package/src/services/mps/v20190612/mps_client.ts +1 -0
  27. package/src/services/mps/v20190612/mps_models.ts +45 -13
  28. package/src/services/nlp/v20190408/nlp_client.ts +15 -0
  29. package/src/services/nlp/v20190408/nlp_models.ts +117 -0
  30. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  31. package/src/services/privatedns/v20201028/privatedns_models.ts +5 -5
  32. package/src/services/tcb/v20180608/tcb_models.ts +19 -14
  33. package/src/services/tdmq/v20200217/tdmq_models.ts +1 -1
  34. package/src/services/tse/v20201207/tse_client.ts +152 -33
  35. package/src/services/tse/v20201207/tse_models.ts +792 -121
  36. package/src/services/tts/v20190823/tts_client.ts +0 -1
  37. package/src/services/vpc/v20170312/vpc_models.ts +5 -1
  38. package/tencentcloud/common/sdk_version.d.ts +1 -1
  39. package/tencentcloud/common/sdk_version.js +1 -1
  40. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +11 -11
  41. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +5 -13
  42. package/tencentcloud/services/cdb/v20170320/cdb_client.js +6 -16
  43. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +0 -51
  44. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +4 -0
  45. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +2 -0
  46. package/tencentcloud/services/cls/v20201016/cls_client.js +2 -0
  47. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  48. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +5 -3
  49. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +1 -1
  50. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +1 -1
  51. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +17 -13
  52. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +11 -3
  53. package/tencentcloud/services/dts/v20211206/dts_client.js +15 -3
  54. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +76 -0
  55. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +4 -0
  56. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +0 -1
  57. package/tencentcloud/services/ess/v20201111/ess_client.js +0 -1
  58. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +135 -143
  59. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +14 -6
  60. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +13 -5
  61. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +107 -34
  62. package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.d.ts +9 -5
  63. package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.js +12 -6
  64. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +40 -0
  65. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +5 -1
  66. package/tencentcloud/services/lcic/v20220817/lcic_client.js +6 -0
  67. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +30 -12
  68. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +44 -13
  69. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +5 -1
  70. package/tencentcloud/services/nlp/v20190408/nlp_client.js +6 -0
  71. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +112 -0
  72. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  73. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  74. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +5 -5
  75. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +19 -14
  76. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +1 -1
  77. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +45 -9
  78. package/tencentcloud/services/tse/v20201207/tse_client.js +66 -12
  79. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +770 -128
  80. package/tencentcloud/services/tts/v20190823/tts_client.d.ts +0 -1
  81. package/tencentcloud/services/tts/v20190823/tts_client.js +0 -1
  82. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +5 -1
  83. package/test/cdb.v20170320.test.js +4 -14
  84. package/test/dts.v20211206.test.js +22 -2
  85. package/test/iotvideo.v20211125.test.js +14 -4
  86. package/test/lcic.v20220817.test.js +10 -0
  87. package/test/nlp.v20190408.test.js +10 -0
  88. package/test/tse.v20201207.test.js +98 -8
@@ -55,6 +55,16 @@ export interface ModifyMigrationJobResponse {
55
55
  RequestId?: string
56
56
  }
57
57
 
58
+ /**
59
+ * ModifyMigrateRateLimit返回参数结构体
60
+ */
61
+ export interface ModifyMigrateRateLimitResponse {
62
+ /**
63
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
64
+ */
65
+ RequestId?: string
66
+ }
67
+
58
68
  /**
59
69
  * ModifyMigrateJobSpec请求参数结构体
60
70
  */
@@ -110,6 +120,16 @@ export interface StepTip {
110
120
  SkipInfo?: string
111
121
  }
112
122
 
123
+ /**
124
+ * ModifySyncRateLimit返回参数结构体
125
+ */
126
+ export interface ModifySyncRateLimitResponse {
127
+ /**
128
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
129
+ */
130
+ RequestId?: string
131
+ }
132
+
113
133
  /**
114
134
  * DestroyMigrateJob请求参数结构体
115
135
  */
@@ -261,6 +281,36 @@ export interface ContinueMigrateJobRequest {
261
281
  JobId: string
262
282
  }
263
283
 
284
+ /**
285
+ * ModifySyncRateLimit请求参数结构体
286
+ */
287
+ export interface ModifySyncRateLimitRequest {
288
+ /**
289
+ * 迁移任务ID
290
+ */
291
+ JobId: string
292
+ /**
293
+ * 同步任务全量导出线程数、有效值为 1-16
294
+ */
295
+ DumpThread?: number
296
+ /**
297
+ * 同步任务全量导出的 Rps 限制、需要大于 0
298
+ */
299
+ DumpRps?: number
300
+ /**
301
+ * 同步任务全量导入线程数、有效值为 1-16
302
+ */
303
+ LoadThread?: number
304
+ /**
305
+ * 同步任务增量导入线程数、有效值为 1-128
306
+ */
307
+ SinkerThread?: number
308
+ /**
309
+ * 同步任务全量导入的Rps
310
+ */
311
+ LoadRps?: number
312
+ }
313
+
264
314
  /**
265
315
  * DescribeCheckSyncJobResult请求参数结构体
266
316
  */
@@ -2333,6 +2383,36 @@ export interface ResumeSyncJobRequest {
2333
2383
  JobId: string
2334
2384
  }
2335
2385
 
2386
+ /**
2387
+ * ModifyMigrateRateLimit请求参数结构体
2388
+ */
2389
+ export interface ModifyMigrateRateLimitRequest {
2390
+ /**
2391
+ * 迁移任务ID
2392
+ */
2393
+ JobId: string
2394
+ /**
2395
+ * 迁移任务全量导出线程数、有效值为 1-16
2396
+ */
2397
+ DumpThread?: number
2398
+ /**
2399
+ * 迁移全量导出的 Rps 限制、需要大于 0
2400
+ */
2401
+ DumpRps?: number
2402
+ /**
2403
+ * 迁移任务全量导入线程数、有效值为 1-16
2404
+ */
2405
+ LoadThread?: number
2406
+ /**
2407
+ * 迁移任务增量导入线程数、有效值为 1-128
2408
+ */
2409
+ SinkerThread?: number
2410
+ /**
2411
+ * 全量导入Rps限制
2412
+ */
2413
+ LoadRps?: number
2414
+ }
2415
+
2336
2416
  /**
2337
2417
  * 用于一致性校验的表配置
2338
2418
  */
@@ -7832,6 +7832,10 @@ export interface CreateVpcRequest {
7832
7832
  * 描述信息
7833
7833
  */
7834
7834
  Description?: string
7835
+ /**
7836
+ * 网络运营商类型 取值范围:'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调
7837
+ */
7838
+ ISPTypes?: Array<ISPTypeItem>
7835
7839
  }
7836
7840
 
7837
7841
  /**
@@ -759,9 +759,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
759
759
  }
760
760
 
761
761
  /**
762
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
763
- 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
764
- */
762
+ * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
763
+ */
765
764
  async DescribeFlowComponents(
766
765
  req: DescribeFlowComponentsRequest,
767
766
  cb?: (error: string, rep: DescribeFlowComponentsResponse) => void
@@ -832,7 +832,7 @@ export interface CreateConvertTaskApiRequest {
832
832
  */
833
833
  ResourceName: string
834
834
  /**
835
- * 资源Id,通过UploadFiles获取
835
+ * 文件Id,通过UploadFiles获取
836
836
  */
837
837
  ResourceId: string
838
838
  /**
@@ -1596,13 +1596,19 @@ export interface BindEmployeeUserIdWithClientOpenIdRequest {
1596
1596
  */
1597
1597
  export interface DescribeIntegrationDepartmentsRequest {
1598
1598
  /**
1599
- * 操作人信息,UserId必填且需拥有组织架构管理权限
1599
+ * 执行本接口操作的员工信息。
1600
+ 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
1600
1601
  */
1601
1602
  Operator: UserInfo
1602
1603
  /**
1603
1604
  * 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
1604
1605
  */
1605
1606
  QueryType: number
1607
+ /**
1608
+ * 代理企业和员工的信息。
1609
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1610
+ */
1611
+ Agent?: Agent
1606
1612
  /**
1607
1613
  * 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
1608
1614
  */
@@ -2778,13 +2784,19 @@ export interface DescribeFlowComponentsRequest {
2778
2784
  */
2779
2785
  export interface CreateIntegrationDepartmentRequest {
2780
2786
  /**
2781
- * 操作人信息,UserId必填且需拥有组织架构管理权限
2787
+ * 执行本接口操作的员工信息。
2788
+ 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
2782
2789
  */
2783
2790
  Operator: UserInfo
2784
2791
  /**
2785
2792
  * 部门名称,不超过50个字符
2786
2793
  */
2787
2794
  DeptName: string
2795
+ /**
2796
+ * 代理企业和员工的信息。
2797
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2798
+ */
2799
+ Agent?: Agent
2788
2800
  /**
2789
2801
  * 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
2790
2802
  */
@@ -3234,24 +3246,28 @@ export interface DeleteIntegrationRoleUsersRequest {
3234
3246
  */
3235
3247
  export interface CreateFlowByFilesRequest {
3236
3248
  /**
3237
- * 执行本接口操作的员工信息。
3238
- 使用此接口时,必须填写userId。
3239
- 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3249
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
3240
3250
  支持填入集团子公司经办人 userId 代发合同。
3251
+
3252
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3241
3253
  */
3242
3254
  Operator: UserInfo
3243
3255
  /**
3244
3256
  * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
3257
+
3245
3258
  该名称还将用于合同签署完成后的下载文件名。
3246
3259
  */
3247
3260
  FlowName: string
3248
3261
  /**
3249
3262
  * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
3263
+
3250
3264
  如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
3251
3265
  */
3252
3266
  Approvers: Array<ApproverInfo>
3253
3267
  /**
3254
- * 本合同流程需包含的PDF文件资源编号列表,通过UploadFiles接口获取PDF文件资源编号。目前,此接口仅支持单个文件发起。
3268
+ * 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
3269
+
3270
+ 注: `目前,此接口仅支持单个文件发起。`
3255
3271
  */
3256
3272
  FileIds: Array<string>
3257
3273
  /**
@@ -3264,43 +3280,38 @@ export interface CreateFlowByFilesRequest {
3264
3280
  FlowType?: string
3265
3281
  /**
3266
3282
  * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
3267
- - 单行文本控件
3268
- - 多行文本控件
3269
- - 勾选框控件
3270
- - 数字控件
3271
- - 图片控件
3272
- - 动态表格等填写控件
3283
+ <ul><li> 单行文本控件 </li>
3284
+ <li> 多行文本控件 </li>
3285
+ <li> 勾选框控件 </li>
3286
+ <li> 数字控件 </li>
3287
+ <li> 图片控件 </li>
3288
+ <li> 动态表格等填写控件</li></ul>
3273
3289
  */
3274
3290
  Components?: Array<Component>
3275
3291
  /**
3276
3292
  * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
3277
- 注:此功能为白名单功能,使用前请联系对接的客户经理沟通。
3293
+
3294
+ 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
3278
3295
  */
3279
3296
  CcInfos?: Array<CcInfo>
3280
3297
  /**
3281
3298
  * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
3282
-
3283
- - 0:合同发起时通知(默认值)
3284
- - 1:签署完成后通知
3299
+ <ul><li> **0**:合同发起时通知(默认值)</li>
3300
+ <li> **1**:签署完成后通知</li></ul>
3285
3301
  */
3286
3302
  CcNotifyType?: number
3287
3303
  /**
3288
3304
  * 是否为预览模式,取值如下:
3289
-
3290
- false:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId
3291
-
3292
- true:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。
3305
+ <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
3306
+ <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
3293
3307
  */
3294
3308
  NeedPreview?: boolean
3295
3309
  /**
3296
- *
3297
- 预览模式下产生的预览链接类型
3298
-
3299
- - 0 :(默认) 文件流 ,点开后后下载预览的合同PDF文件
3300
-
3301
- - 1 :H5链接 ,点开后在浏览器中展示合同的样子
3310
+ * 预览模式下产生的预览链接类型
3311
+ <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
3312
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
3313
+ 注: `此参数在NeedPreview 为true时有效`
3302
3314
 
3303
- 注意: 此参数在NeedPreview 为true时有效
3304
3315
  */
3305
3316
  PreviewType?: number
3306
3317
  /**
@@ -3310,71 +3321,60 @@ true:预览模式,不产生合同流程,不返回合同流程编号FlowId
3310
3321
  Deadline?: number
3311
3322
  /**
3312
3323
  * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
3324
+
3313
3325
  到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
3314
3326
  */
3315
3327
  RemindedOn?: number
3316
3328
  /**
3317
- *
3318
- 合同流程的签署顺序类型:
3319
- - false:(默认)有序签署, 本合同多个参与人需要依次签署
3320
- - true:无序签署, 本合同多个参与人没有先后签署限制
3329
+ * 合同流程的签署顺序类型:
3330
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
3331
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
3321
3332
  */
3322
3333
  Unordered?: boolean
3323
3334
  /**
3324
3335
  * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
3325
-
3326
- - {合同名称}
3327
- - {发起方企业}
3328
- - {发起方姓名}
3329
- - {签署方N企业}
3330
- - {签署方N姓名}
3331
-
3336
+ <ul><li>{合同名称} </li>
3337
+ <li>{发起方企业} </li>
3338
+ <li>{发起方姓名} </li>
3339
+ <li>{签署方N企业}</li>
3340
+ <li>{签署方N姓名}</li></ul>
3332
3341
  其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
3333
3342
 
3334
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:
3335
- 合同名称:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`
3343
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
3336
3344
 
3337
- 则小程序中列表页展示此合同为以下样子
3338
- ```
3339
3345
  合同名称:租房合同
3340
3346
  发起方:腾讯公司(张三)
3341
3347
  签署方:李四
3342
- ```
3348
+
3349
+
3343
3350
  */
3344
3351
  CustomShowMap?: string
3345
3352
  /**
3346
- *
3347
- 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3348
-
3349
- - false:(默认)不需要审批,直接签署。
3350
- - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
3351
-
3353
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3354
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
3355
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
3352
3356
  企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3353
-
3354
- - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
3355
- - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
3356
-
3357
- 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
3357
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
3358
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
3359
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
3358
3360
  */
3359
3361
  NeedSignReview?: boolean
3360
3362
  /**
3361
3363
  * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
3362
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
3363
- 回调的相关说明可参考开发者中心的"回调通知"模块。
3364
+
3365
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3364
3366
  */
3365
3367
  UserData?: string
3366
3368
  /**
3367
3369
  * 指定个人签署方查看合同的校验方式
3368
-
3369
- - VerifyCheck :(默认)人脸识别,人脸识别后才能合同内容
3370
- - MobileCheck: 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
3370
+ <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
3371
+ <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容</li></ul>
3371
3372
  */
3372
3373
  ApproverVerifyType?: string
3373
3374
  /**
3374
3375
  * 签署方签署控件(印章/签名等)的生成方式:
3375
-
3376
- - 0:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。
3377
- - 1:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
3376
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
3377
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
3378
3378
  */
3379
3379
  SignBeanTag?: number
3380
3380
  /**
@@ -3384,10 +3384,8 @@ true:预览模式,不产生合同流程,不返回合同流程编号FlowId
3384
3384
  Agent?: Agent
3385
3385
  /**
3386
3386
  * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
3387
-
3388
- - E_PRESCRIPTION_AUTO_SIGN:处方单(医疗自动签)
3389
-
3390
- 注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。
3387
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
3388
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
3391
3389
  */
3392
3390
  AutoSignScene?: string
3393
3391
  }
@@ -3716,12 +3714,12 @@ export interface FailedCreateRoleData {
3716
3714
  export interface ApproverInfo {
3717
3715
  /**
3718
3716
  * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
3719
- 0:企业
3720
- 1:个人
3721
- 3:企业静默签署
3722
- 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
3723
- 7: 个人自动签署,适用于个人自动签场景。
3724
- 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
3717
+ **0**:企业
3718
+ **1**:个人
3719
+ **3**:企业静默签署
3720
+ 注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
3721
+ **7**: 个人自动签署,适用于个人自动签场景。
3722
+ 注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`
3725
3723
  */
3726
3724
  ApproverType: number
3727
3725
  /**
@@ -3731,57 +3729,54 @@ export interface ApproverInfo {
3731
3729
  ApproverName: string
3732
3730
  /**
3733
3731
  * 本企业的签署方经办人的员工UserId
3734
-
3735
3732
  可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3736
3733
 
3737
- 注: 若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。
3734
+ 注: `若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。`
3738
3735
  */
3739
3736
  ApproverMobile: string
3740
3737
  /**
3741
3738
  * 组织机构名称。
3742
3739
  如果签署方是企业签署方(approverType = 1 或者 approverType = 3), 则企业名称必填。
3743
3740
 
3744
- 注: 请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。
3741
+ 注: `请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。`
3745
3742
  */
3746
3743
  OrganizationName?: string
3747
3744
  /**
3748
3745
  * 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
3749
- - 个人签名/印章
3750
- - 企业印章
3751
- - 骑缝章等签署控件
3746
+ <ul><li> 个人签名/印章</li>
3747
+ <li> 企业印章</li>
3748
+ <li> 骑缝章等签署控件</li></ul>
3752
3749
  */
3753
3750
  SignComponents?: Array<Component>
3754
3751
  /**
3755
3752
  * 签署方经办人的证件类型,支持以下类型
3756
- - ID_CARD 居民身份证 (默认值)
3757
- - HONGKONG_AND_MACAO 港澳居民来往内地通行证
3758
- - HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3759
- - OTHER_CARD_TYPE 其他证件
3753
+ <ul><li>ID_CARD 居民身份证 (默认值)</li>
3754
+ <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
3755
+ <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
3756
+ <li>OTHER_CARD_TYPE 其他证件</li></ul>
3760
3757
 
3761
- 注: 其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
3758
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
3762
3759
  */
3763
3760
  ApproverIdCardType?: string
3764
3761
  /**
3765
3762
  * 签署方经办人的证件号码,应符合以下规则
3766
- - 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
3767
- - 港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。
3768
- - 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
3763
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
3764
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
3765
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3769
3766
  */
3770
3767
  ApproverIdCardNumber?: string
3771
3768
  /**
3772
3769
  * 通知签署方经办人的方式, 有以下途径:
3773
-
3774
- - sms: (默认)短信
3775
- - none: 不通知
3770
+ <ul><li> **sms** : (默认)短信</li>
3771
+ <li> **none** : 不通知</li></ul>
3776
3772
  */
3777
3773
  NotifyType?: string
3778
3774
  /**
3779
- * 收据场景设置签署人角色类型, 可以设置如下类型:
3780
- - 1:收款人
3781
- - 2:开具人
3782
- - 3:见证人
3783
-
3784
- 注: 收据场景为白名单功能,使用前请联系对接的客户经理沟通。
3775
+ * 收据场景设置签署人角色类型, 可以设置如下****类型****:
3776
+ <ul><li> **1** :收款人</li>
3777
+ <li> **2** :开具人</li>
3778
+ <li> **3** :见证人</li></ul>
3779
+ 注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
3785
3780
  */
3786
3781
  ApproverRole?: number
3787
3782
  /**
@@ -3794,20 +3789,19 @@ export interface ApproverInfo {
3794
3789
  * 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
3795
3790
 
3796
3791
  若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
3797
-
3798
- - 合同页数少于等于2页,阅读时间为3秒;
3799
- - 合同页数为3到5页,阅读时间为5秒;
3800
- - 合同页数大于等于6页,阅读时间为10秒。
3792
+ <ul><li>合同页数少于等于2页,阅读时间为3秒;</li>
3793
+ <li>合同页数为3到5页,阅读时间为5秒;</li>
3794
+ <li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
3801
3795
  */
3802
3796
  PreReadTime?: number
3803
3797
  /**
3804
3798
  * 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
3805
3799
 
3806
- 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
3800
+ 注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
3807
3801
  */
3808
3802
  UserId?: string
3809
3803
  /**
3810
- * 在企微场景下使用,需设置参数为WEWORKAPP,以表明合同来源于企微。
3804
+ * 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
3811
3805
  */
3812
3806
  ApproverSource?: string
3813
3807
  /**
@@ -3824,43 +3818,32 @@ export interface ApproverInfo {
3824
3818
  ApproverOption?: ApproverOption
3825
3819
  /**
3826
3820
  * 指定个人签署方查看合同的校验方式,可以传值如下:
3827
-
3828
- - 1 : (默认)人脸识别,人脸识别后才能合同内容
3829
- - 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
3830
-
3821
+ <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
3822
+ <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容</li></ul>
3831
3823
  注:
3832
-
3833
- - 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
3834
- - 此字段不可传多个校验方式
3824
+ <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
3825
+ <li>此字段不可传多个校验方式</li></ul>
3835
3826
  */
3836
3827
  ApproverVerifyTypes?: Array<number>
3837
3828
  /**
3838
3829
  * 您可以指定签署方签署合同的认证校验方式,可传递以下值:
3839
-
3840
- - 1:人脸认证,需进行人脸识别成功后才能签署合同;
3841
- - 2:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
3842
- - 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
3843
-
3830
+ <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
3831
+ <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
3832
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
3844
3833
  注:
3845
-
3846
- - 默认情况下,认证校验方式为人脸认证和签署密码两种形式;
3847
- - 您可以传递多种值,表示可用多种认证校验方式。
3848
-
3834
+ <ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
3835
+ <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
3849
3836
  */
3850
3837
  ApproverSignTypes?: Array<number>
3851
3838
  /**
3852
- *
3853
- 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3854
-
3855
- - false:(默认)不需要审批,直接签署。
3856
- - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
3857
-
3839
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3840
+ <ul><li>**false**:(默认)不需要审批,直接签署。</li>
3841
+ <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
3858
3842
  企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3843
+ <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
3844
+ <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
3859
3845
 
3860
- - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
3861
- - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
3862
-
3863
- 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
3846
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
3864
3847
  */
3865
3848
  ApproverNeedSignReview?: boolean
3866
3849
  }
@@ -3880,13 +3863,19 @@ export interface CreateFlowSignReviewResponse {
3880
3863
  */
3881
3864
  export interface ModifyIntegrationDepartmentRequest {
3882
3865
  /**
3883
- * 操作人信息,UserId必填且需拥有组织架构管理权限
3866
+ * 执行本接口操作的员工信息。
3867
+ 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
3884
3868
  */
3885
3869
  Operator: UserInfo
3886
3870
  /**
3887
3871
  * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
3888
3872
  */
3889
3873
  DeptId: string
3874
+ /**
3875
+ * 代理企业和员工的信息。
3876
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3877
+ */
3878
+ Agent?: Agent
3890
3879
  /**
3891
3880
  * 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
3892
3881
  */
@@ -4275,13 +4264,19 @@ export interface CancelMultiFlowSignQRCodeRequest {
4275
4264
  */
4276
4265
  export interface DeleteIntegrationDepartmentRequest {
4277
4266
  /**
4278
- * 操作人信息,UserId必填且需拥有组织架构管理权限
4267
+ * 执行本接口操作的员工信息。
4268
+ 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
4279
4269
  */
4280
4270
  Operator: UserInfo
4281
4271
  /**
4282
4272
  * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
4283
4273
  */
4284
4274
  DeptId: string
4275
+ /**
4276
+ * 代理企业和员工的信息。
4277
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4278
+ */
4279
+ Agent?: Agent
4285
4280
  /**
4286
4281
  * 交接部门ID。待删除部门中的合同、印章和模板数据,交接至该部门ID下,未填写交接至公司根部门。
4287
4282
  */
@@ -4496,15 +4491,15 @@ export interface ApproverOption {
4496
4491
  /**
4497
4492
  * 签署方是否可以拒签
4498
4493
 
4499
- - false: ( 默认)可以拒签
4500
- - true:不可以拒签
4494
+ <ul><li> **false** : ( 默认)可以拒签</li>
4495
+ <li> **true** :不可以拒签</li></ul>
4501
4496
  */
4502
4497
  NoRefuse?: boolean
4503
4498
  /**
4504
4499
  * 签署方是否可以转他人处理
4505
4500
 
4506
- - false: ( 默认)可以转他人处理
4507
- - true:不可以转他人处理
4501
+ <ul><li> **false** : ( 默认)可以转他人处理</li>
4502
+ <li> **true** :不可以转他人处理</li></ul>
4508
4503
  */
4509
4504
  NoTransfer?: boolean
4510
4505
  }
@@ -5670,23 +5665,20 @@ export interface CcInfo {
5670
5665
  Name?: string
5671
5666
  /**
5672
5667
  * 被抄送方类型, 可设置以下类型:
5673
-
5674
- - 0:个人抄送方
5675
- - 1:企业员工抄送方
5668
+ <ul><li> **0** :个人抄送方</li>
5669
+ <li> **1** :企业员工抄送方</li></ul>
5676
5670
  */
5677
5671
  CcType?: number
5678
5672
  /**
5679
5673
  * 被抄送方权限, 可设置如下权限:
5680
-
5681
- - 0:可查看合同内容
5682
- - 1:可查看合同内容也可下载原文
5674
+ <ul><li> **0** :可查看合同内容</li>
5675
+ <li> **1** :可查看合同内容也可下载原文</li></ul>
5683
5676
  */
5684
5677
  CcPermission?: number
5685
5678
  /**
5686
5679
  * 通知签署方经办人的方式, 有以下途径:
5687
-
5688
- - sms: (默认)短信
5689
- - none: 不通知
5680
+ <ul><li> **sms** : (默认)短信</li>
5681
+ <li> **none** : 不通知</li></ul>
5690
5682
  */
5691
5683
  NotifyType?: string
5692
5684
  }