tccli 3.0.1405.1__py2.py3-none-any.whl → 3.0.1407.1__py2.py3-none-any.whl

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 (70) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/autoscaling/v20180419/api.json +1 -1
  3. tccli/services/batch/v20170312/api.json +1 -1
  4. tccli/services/cdb/v20170320/api.json +31 -21
  5. tccli/services/cdn/v20180606/api.json +1 -1
  6. tccli/services/cloudhsm/v20191112/api.json +10 -10
  7. tccli/services/cls/v20201016/api.json +40 -31
  8. tccli/services/cls/v20201016/examples.json +8 -2
  9. tccli/services/ctem/v20231128/api.json +30 -0
  10. tccli/services/dbbrain/v20210527/api.json +17 -7
  11. tccli/services/dbbrain/v20210527/examples.json +1 -1
  12. tccli/services/dts/v20211206/api.json +16 -6
  13. tccli/services/emr/v20190103/api.json +9 -0
  14. tccli/services/es/es_client.py +57 -4
  15. tccli/services/es/v20250101/api.json +133 -0
  16. tccli/services/es/v20250101/examples.json +8 -0
  17. tccli/services/ess/ess_client.py +212 -0
  18. tccli/services/ess/v20201111/api.json +508 -24
  19. tccli/services/ess/v20201111/examples.json +41 -3
  20. tccli/services/essbasic/v20210526/api.json +12 -3
  21. tccli/services/essbasic/v20210526/examples.json +2 -2
  22. tccli/services/gwlb/gwlb_client.py +53 -0
  23. tccli/services/gwlb/v20240906/api.json +80 -0
  24. tccli/services/gwlb/v20240906/examples.json +8 -0
  25. tccli/services/hunyuan/v20230901/api.json +2 -2
  26. tccli/services/ioa/ioa_client.py +220 -8
  27. tccli/services/ioa/v20220601/api.json +559 -0
  28. tccli/services/ioa/v20220601/examples.json +38 -0
  29. tccli/services/iotexplorer/iotexplorer_client.py +220 -8
  30. tccli/services/iotexplorer/v20190423/api.json +959 -12
  31. tccli/services/iotexplorer/v20190423/examples.json +68 -0
  32. tccli/services/lcic/v20220817/api.json +2 -2
  33. tccli/services/lke/v20231130/api.json +1 -1
  34. tccli/services/lke/v20231130/examples.json +2 -2
  35. tccli/services/lkeap/v20240522/api.json +1 -1
  36. tccli/services/lkeap/v20240522/examples.json +7 -1
  37. tccli/services/monitor/monitor_client.py +53 -0
  38. tccli/services/monitor/v20180724/api.json +248 -0
  39. tccli/services/monitor/v20180724/examples.json +8 -0
  40. tccli/services/mps/v20190612/api.json +384 -2
  41. tccli/services/mqtt/v20240516/api.json +10 -0
  42. tccli/services/mqtt/v20240516/examples.json +3 -9
  43. tccli/services/nlp/v20190408/api.json +6 -6
  44. tccli/services/oceanus/oceanus_client.py +110 -4
  45. tccli/services/oceanus/v20190422/api.json +152 -8
  46. tccli/services/oceanus/v20190422/examples.json +16 -0
  47. tccli/services/ocr/v20181119/api.json +10 -0
  48. tccli/services/privatedns/privatedns_client.py +641 -58
  49. tccli/services/privatedns/v20201028/api.json +923 -12
  50. tccli/services/privatedns/v20201028/examples.json +88 -0
  51. tccli/services/redis/v20180412/api.json +1 -1
  52. tccli/services/teo/v20220901/api.json +206 -66
  53. tccli/services/teo/v20220901/examples.json +32 -8
  54. tccli/services/tione/v20211111/api.json +1 -1
  55. tccli/services/tke/v20180525/api.json +23 -14
  56. tccli/services/tke/v20180525/examples.json +1 -1
  57. tccli/services/trtc/v20190722/api.json +9 -9
  58. tccli/services/trtc/v20190722/examples.json +1 -1
  59. tccli/services/tse/v20201207/api.json +30 -1
  60. tccli/services/vpc/v20170312/api.json +11 -2
  61. tccli/services/wedata/v20210820/api.json +1281 -601
  62. tccli/services/wedata/v20210820/examples.json +127 -157
  63. tccli/services/wedata/v20250806/api.json +480 -18
  64. tccli/services/wedata/v20250806/examples.json +38 -6
  65. tccli/services/wedata/wedata_client.py +216 -4
  66. {tccli-3.0.1405.1.dist-info → tccli-3.0.1407.1.dist-info}/METADATA +2 -2
  67. {tccli-3.0.1405.1.dist-info → tccli-3.0.1407.1.dist-info}/RECORD +70 -70
  68. {tccli-3.0.1405.1.dist-info → tccli-3.0.1407.1.dist-info}/WHEEL +0 -0
  69. {tccli-3.0.1405.1.dist-info → tccli-3.0.1407.1.dist-info}/entry_points.txt +0 -0
  70. {tccli-3.0.1405.1.dist-info → tccli-3.0.1407.1.dist-info}/license_files/LICENSE +0 -0
@@ -91,6 +91,13 @@
91
91
  "output": "CreateBatchSignUrlResponse",
92
92
  "status": "online"
93
93
  },
94
+ "CreateContractComparisonTask": {
95
+ "document": "此接口(CreateContractComparisonTask)用于创建合同对比任务。\n适用场景:对比两份合同中字段(如:金额、日期、甲方名称等)的内容差异。",
96
+ "input": "CreateContractComparisonTaskRequest",
97
+ "name": "创建合同对比任务",
98
+ "output": "CreateContractComparisonTaskResponse",
99
+ "status": "online"
100
+ },
94
101
  "CreateContractDiffTaskWebUrl": {
95
102
  "document": "接口(CreateContractDiffTaskWebUrl)用于创建合同对比的可嵌入web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。\n注:本接口生成的web页面暂不支持<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreateWebThemeConfig\" target=\"_blank\">设置本企业嵌入式页面主题配置</a>\n\n未跳过上传确认的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/32f3526ad7152757202a7e4e760356db.jpg)\n跳过上传确认的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/c68047feddbc106e261870687b6ab89d.jpg)",
96
103
  "input": "CreateContractDiffTaskWebUrlRequest",
@@ -245,6 +252,13 @@
245
252
  "output": "CreateFlowSignUrlResponse",
246
253
  "status": "online"
247
254
  },
255
+ "CreateInformationExtractionWebUrl": {
256
+ "document": "此接口(CreateInformationExtractionWebUrl)用来创建合同信息提取web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。\n\n注: \n1. pdf、word格式限制大小为10M以下\n2. pdg、jpeg、jpg格式限制大小为5M以下",
257
+ "input": "CreateInformationExtractionWebUrlRequest",
258
+ "name": "创建合同智能提取web页面",
259
+ "output": "CreateInformationExtractionWebUrlResponse",
260
+ "status": "online"
261
+ },
248
262
  "CreateIntegrationDepartment": {
249
263
  "document": "此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。",
250
264
  "input": "CreateIntegrationDepartmentRequest",
@@ -637,6 +651,13 @@
637
651
  "output": "DescribeInformationExtractionTaskResponse",
638
652
  "status": "online"
639
653
  },
654
+ "DescribeInformationExtractionWebUrl": {
655
+ "document": "此接口(DescribeInformationExtractionWebUrl)用来获取合同信息提取web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。",
656
+ "input": "DescribeInformationExtractionWebUrlRequest",
657
+ "name": "获取合同智能提取结果web页面",
658
+ "output": "DescribeInformationExtractionWebUrlResponse",
659
+ "status": "online"
660
+ },
640
661
  "DescribeIntegrationDepartments": {
641
662
  "document": "此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。",
642
663
  "input": "DescribeIntegrationDepartmentsRequest",
@@ -742,6 +763,13 @@
742
763
  "output": "DisableUserAutoSignResponse",
743
764
  "status": "online"
744
765
  },
766
+ "ExportContractComparisonTask": {
767
+ "document": "本接口(ExportContractComparisonTask)用于导出指定的合同对比任务的结果文件。任务完成后,用户可根据不同的使用场景,选择导出可视化对比报告(PDF)或结构化差异明细(EXCEL)。",
768
+ "input": "ExportContractComparisonTaskRequest",
769
+ "name": "导出合同对比任务详情",
770
+ "output": "ExportContractComparisonTaskResponse",
771
+ "status": "online"
772
+ },
745
773
  "GetTaskResultApi": {
746
774
  "document": "此接口(GetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行资源文件的转换操作<br />\n前提条件:已调用 <a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />\n\n适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />\n注:\n1. `大文件转换所需的时间可能会比较长`\n2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`",
747
775
  "input": "GetTaskResultApiRequest",
@@ -885,7 +913,7 @@
885
913
  {
886
914
  "disabled": false,
887
915
  "document": "超管手机号,打码显示\n示例值:138****1569\n",
888
- "example": "18888888888",
916
+ "example": "1888****888",
889
917
  "member": "string",
890
918
  "name": "Mobile",
891
919
  "output_required": true,
@@ -2130,7 +2158,7 @@
2130
2158
  {
2131
2159
  "disabled": false,
2132
2160
  "document": "被抄送方手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。",
2133
- "example": "13200000000",
2161
+ "example": "1320****000",
2134
2162
  "member": "string",
2135
2163
  "name": "Mobile",
2136
2164
  "required": false,
@@ -2175,6 +2203,52 @@
2175
2203
  ],
2176
2204
  "usage": "in"
2177
2205
  },
2206
+ "ComparisonDetail": {
2207
+ "document": "合同对比差异结果详情。",
2208
+ "members": [
2209
+ {
2210
+ "disabled": false,
2211
+ "document": "对比前后差异类型,具体如下:\n<ul><li> **add**:新增</li>\n<li> **change**:变更</li>\n<li> **delete**:删除</li>\n</ul>",
2212
+ "example": "add",
2213
+ "member": "string",
2214
+ "name": "ComparisonType",
2215
+ "output_required": false,
2216
+ "type": "string",
2217
+ "value_allowed_null": false
2218
+ },
2219
+ {
2220
+ "disabled": false,
2221
+ "document": "对比内容类型,具体如下:\n<ul><li> **text**:文本</li>\n<li> **table**:表格</li>\n<li> **picture**:图片</li>\n</ul>",
2222
+ "example": "text",
2223
+ "member": "string",
2224
+ "name": "ContentType",
2225
+ "output_required": false,
2226
+ "type": "string",
2227
+ "value_allowed_null": false
2228
+ },
2229
+ {
2230
+ "disabled": false,
2231
+ "document": "原文文本。",
2232
+ "example": "******",
2233
+ "member": "string",
2234
+ "name": "OriginText",
2235
+ "output_required": false,
2236
+ "type": "string",
2237
+ "value_allowed_null": false
2238
+ },
2239
+ {
2240
+ "disabled": false,
2241
+ "document": "对比文本。",
2242
+ "example": "-----",
2243
+ "member": "string",
2244
+ "name": "DiffText",
2245
+ "output_required": false,
2246
+ "type": "string",
2247
+ "value_allowed_null": false
2248
+ }
2249
+ ],
2250
+ "usage": "out"
2251
+ },
2178
2252
  "Component": {
2179
2253
  "document": "此结构体 (Component) 用于描述控件属性。\n\n在通过文件发起合同时,对应的component有三种定位方式\n1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)\n2. 表单域(FIELD)定位方式\n3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找",
2180
2254
  "members": [
@@ -2876,7 +2950,7 @@
2876
2950
  {
2877
2951
  "disabled": false,
2878
2952
  "document": "组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。",
2879
- "example": "13200000000",
2953
+ "example": "1320****000",
2880
2954
  "member": "string",
2881
2955
  "name": "AdminMobile",
2882
2956
  "required": true,
@@ -3133,7 +3207,7 @@
3133
3207
  {
3134
3208
  "disabled": false,
3135
3209
  "document": "生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:\n<ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>\n<li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>\n注:\n`不指定该值时,默认为签署方自行选择。`",
3136
- "example": "LoginWithoutMobile ",
3210
+ "example": "0",
3137
3211
  "member": "uint64",
3138
3212
  "name": "SignTypeSelector",
3139
3213
  "required": false,
@@ -3168,7 +3242,7 @@
3168
3242
  },
3169
3243
  {
3170
3244
  "disabled": false,
3171
- "document": "是否允许此链接中签署方批量拒签。\n <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>\n\n注:`合同组暂不支持批量拒签功能。`\n",
3245
+ "document": "是否允许此链接中签署方批量拒签。\n <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>\n\n注:`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。`\n",
3172
3246
  "example": "false",
3173
3247
  "member": "bool",
3174
3248
  "name": "CanBatchReject",
@@ -3340,7 +3414,7 @@
3340
3414
  },
3341
3415
  {
3342
3416
  "disabled": false,
3343
- "document": "是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>\n注:`1. 合同组暂不支持批量拒签功能。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能`",
3417
+ "document": "是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>\n注:`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能`",
3344
3418
  "example": "false",
3345
3419
  "member": "bool",
3346
3420
  "name": "CanBatchReject",
@@ -3401,6 +3475,98 @@
3401
3475
  ],
3402
3476
  "type": "object"
3403
3477
  },
3478
+ "CreateContractComparisonTaskRequest": {
3479
+ "document": "CreateContractComparisonTask请求参数结构体",
3480
+ "members": [
3481
+ {
3482
+ "disabled": false,
3483
+ "document": "执行合同审查任务的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
3484
+ "example": "无",
3485
+ "member": "UserInfo",
3486
+ "name": "Operator",
3487
+ "required": true,
3488
+ "type": "object"
3489
+ },
3490
+ {
3491
+ "disabled": false,
3492
+ "document": "原版文件ID,对比基准的旧版本文件唯一标识,通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。",
3493
+ "example": "yD*******************Cj",
3494
+ "member": "string",
3495
+ "name": "OriginFileResourceId",
3496
+ "required": true,
3497
+ "type": "string"
3498
+ },
3499
+ {
3500
+ "disabled": false,
3501
+ "document": "新版文件ID,与旧版进行对比的新版本文件唯一标识,通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。",
3502
+ "example": "yD*******************Ed",
3503
+ "member": "string",
3504
+ "name": "DiffFileResourceId",
3505
+ "required": true,
3506
+ "type": "string"
3507
+ },
3508
+ {
3509
+ "disabled": false,
3510
+ "document": "对比任务备注,长度不能超过50个字符。",
3511
+ "example": "这是一项对比任务",
3512
+ "member": "string",
3513
+ "name": "Comment",
3514
+ "required": false,
3515
+ "type": "string"
3516
+ },
3517
+ {
3518
+ "disabled": false,
3519
+ "document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
3520
+ "example": "QmFzZTY0IEJhc2U2NCA",
3521
+ "member": "string",
3522
+ "name": "UserData",
3523
+ "required": false,
3524
+ "type": "string"
3525
+ },
3526
+ {
3527
+ "disabled": false,
3528
+ "document": "标签列表,用户自定义的键值对(Key-Value),可绑定到资源上,用于资源的分类、管理和访问控制。",
3529
+ "example": "无",
3530
+ "member": "Tag",
3531
+ "name": "Tags",
3532
+ "required": false,
3533
+ "type": "list"
3534
+ }
3535
+ ],
3536
+ "type": "object"
3537
+ },
3538
+ "CreateContractComparisonTaskResponse": {
3539
+ "document": "CreateContractComparisonTask返回参数结构体",
3540
+ "members": [
3541
+ {
3542
+ "disabled": false,
3543
+ "document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。",
3544
+ "example": "QmFzZTY0IEJhc2U2NCA",
3545
+ "member": "string",
3546
+ "name": "UserData",
3547
+ "output_required": false,
3548
+ "type": "string",
3549
+ "value_allowed_null": false
3550
+ },
3551
+ {
3552
+ "disabled": false,
3553
+ "document": "合同对比任务ID,可以调用接口<a href=\"https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/DescribeContractComparisonTask\" target=\"_blank\">查询合同对比任务结果</a>查看对比任务的结果。",
3554
+ "example": "yD*******************Qi",
3555
+ "member": "string",
3556
+ "name": "TaskId",
3557
+ "output_required": false,
3558
+ "type": "string",
3559
+ "value_allowed_null": false
3560
+ },
3561
+ {
3562
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3563
+ "member": "string",
3564
+ "name": "RequestId",
3565
+ "type": "string"
3566
+ }
3567
+ ],
3568
+ "type": "object"
3569
+ },
3404
3570
  "CreateContractDiffTaskWebUrlRequest": {
3405
3571
  "document": "CreateContractDiffTaskWebUrl请求参数结构体",
3406
3572
  "members": [
@@ -3439,6 +3605,24 @@
3439
3605
  "name": "DiffFileResourceId",
3440
3606
  "required": false,
3441
3607
  "type": "string"
3608
+ },
3609
+ {
3610
+ "disabled": false,
3611
+ "document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
3612
+ "example": "QmFzZTY0IEJhc2U2NCA",
3613
+ "member": "string",
3614
+ "name": "UserData",
3615
+ "required": false,
3616
+ "type": "string"
3617
+ },
3618
+ {
3619
+ "disabled": false,
3620
+ "document": "标签列表,用户自定义的键值对(Key-Value),可绑定到资源上,用于资源的分类、管理和访问控制。",
3621
+ "example": "无",
3622
+ "member": "Tag",
3623
+ "name": "Tags",
3624
+ "required": false,
3625
+ "type": "list"
3442
3626
  }
3443
3627
  ],
3444
3628
  "type": "object"
@@ -3466,6 +3650,16 @@
3466
3650
  "type": "string",
3467
3651
  "value_allowed_null": false
3468
3652
  },
3653
+ {
3654
+ "disabled": false,
3655
+ "document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。",
3656
+ "example": "QmFzZTY0IEJhc2U2NCA",
3657
+ "member": "string",
3658
+ "name": "UserData",
3659
+ "output_required": false,
3660
+ "type": "string",
3661
+ "value_allowed_null": false
3662
+ },
3469
3663
  {
3470
3664
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3471
3665
  "member": "string",
@@ -5623,6 +5817,70 @@
5623
5817
  ],
5624
5818
  "type": "object"
5625
5819
  },
5820
+ "CreateInformationExtractionWebUrlRequest": {
5821
+ "document": "CreateInformationExtractionWebUrl请求参数结构体",
5822
+ "members": [
5823
+ {
5824
+ "disabled": false,
5825
+ "document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
5826
+ "example": "无",
5827
+ "member": "UserInfo",
5828
+ "name": "Operator",
5829
+ "required": true,
5830
+ "type": "object"
5831
+ },
5832
+ {
5833
+ "disabled": false,
5834
+ "document": "需要提取的合同文件资源ID,可通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。\n\n注: \n- `word、pdf文件每个文件限制在10M以下`\n- `png、jpg、jpeg文件每个限制在5M以下`",
5835
+ "example": "[\"yDtGEUUgydz\"]",
5836
+ "member": "string",
5837
+ "name": "ResourceIds",
5838
+ "required": false,
5839
+ "type": "list"
5840
+ },
5841
+ {
5842
+ "disabled": false,
5843
+ "document": "调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
5844
+ "example": "5rWL6K+V5pWw5o2u",
5845
+ "member": "string",
5846
+ "name": "UserData",
5847
+ "required": false,
5848
+ "type": "string"
5849
+ },
5850
+ {
5851
+ "disabled": false,
5852
+ "document": "个性化参数,用于控制页面展示内容",
5853
+ "example": "无",
5854
+ "member": "WebUrlOption",
5855
+ "name": "Option",
5856
+ "required": false,
5857
+ "type": "object"
5858
+ }
5859
+ ],
5860
+ "type": "object"
5861
+ },
5862
+ "CreateInformationExtractionWebUrlResponse": {
5863
+ "document": "CreateInformationExtractionWebUrl返回参数结构体",
5864
+ "members": [
5865
+ {
5866
+ "disabled": false,
5867
+ "document": "合同信息提取嵌入式web页面链接。\n\n注意:`链接有效期为5分钟,且链接仅能使用一次。`",
5868
+ "example": "https://embed.test.qian.tencent.cn/ai-contract-info-extract-embed?embed=1&code=xxx&channel=TENCENTCLOUD&embedType=CONTRACT_EXTRACTION&shortKey=xx",
5869
+ "member": "string",
5870
+ "name": "Url",
5871
+ "output_required": true,
5872
+ "type": "string",
5873
+ "value_allowed_null": false
5874
+ },
5875
+ {
5876
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
5877
+ "member": "string",
5878
+ "name": "RequestId",
5879
+ "type": "string"
5880
+ }
5881
+ ],
5882
+ "type": "object"
5883
+ },
5626
5884
  "CreateIntegrationDepartmentRequest": {
5627
5885
  "document": "CreateIntegrationDepartment请求参数结构体",
5628
5886
  "members": [
@@ -6881,7 +7139,7 @@
6881
7139
  {
6882
7140
  "disabled": false,
6883
7141
  "document": "为签署方经办人在签署合同中的参与方ID,必须与参数FlowIds数组一一对应。\n您可以通过查询合同接口(DescribeFlowInfo)查询此参数。\n若传了此参数,则可以不传 UserId, Name, Mobile等参数",
6884
- "example": "yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E",
7142
+ "example": "[\"yDwcCUUgyg3tgmwcUEVzyNaupO7DiB3E\"]",
6885
7143
  "member": "string",
6886
7144
  "name": "RecipientIds",
6887
7145
  "required": false,
@@ -6895,6 +7153,15 @@
6895
7153
  "name": "FlowGroupId",
6896
7154
  "required": false,
6897
7155
  "type": "string"
7156
+ },
7157
+ {
7158
+ "disabled": false,
7159
+ "document": "是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注:`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。`",
7160
+ "example": "false",
7161
+ "member": "bool",
7162
+ "name": "CanBatchReject",
7163
+ "required": false,
7164
+ "type": "bool"
6898
7165
  }
6899
7166
  ],
6900
7167
  "type": "object"
@@ -10070,6 +10337,15 @@
10070
10337
  "name": "TaskId",
10071
10338
  "required": true,
10072
10339
  "type": "string"
10340
+ },
10341
+ {
10342
+ "disabled": false,
10343
+ "document": "是否返回详细的对比结果。为 true时,响应中将包含详细的对比信息,如相似度、文本差异具体内容等;为 false时,仅返回任务基本状态信息。\n注:`详细结果数据量可能较大,请按需开启。`",
10344
+ "example": "true",
10345
+ "member": "bool",
10346
+ "name": "ShowDetail",
10347
+ "required": false,
10348
+ "type": "bool"
10073
10349
  }
10074
10350
  ],
10075
10351
  "type": "object"
@@ -10197,6 +10473,16 @@
10197
10473
  "type": "int",
10198
10474
  "value_allowed_null": false
10199
10475
  },
10476
+ {
10477
+ "disabled": false,
10478
+ "document": "对比差异详情,请求参数ShowDetail为true时返回。",
10479
+ "example": "无",
10480
+ "member": "ComparisonDetail",
10481
+ "name": "ComparisonDetail",
10482
+ "output_required": false,
10483
+ "type": "list",
10484
+ "value_allowed_null": false
10485
+ },
10200
10486
  {
10201
10487
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
10202
10488
  "member": "string",
@@ -11313,6 +11599,52 @@
11313
11599
  ],
11314
11600
  "type": "object"
11315
11601
  },
11602
+ "DescribeInformationExtractionWebUrlRequest": {
11603
+ "document": "DescribeInformationExtractionWebUrl请求参数结构体",
11604
+ "members": [
11605
+ {
11606
+ "disabled": false,
11607
+ "document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。\n\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
11608
+ "example": "无",
11609
+ "member": "UserInfo",
11610
+ "name": "Operator",
11611
+ "required": true,
11612
+ "type": "object"
11613
+ },
11614
+ {
11615
+ "disabled": false,
11616
+ "document": "合同信息提取任务ID,该参数可通过回调事件[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)获取或者从控制台信息提取任务列表获取。\n\n注意:`不填写任务ID时返回信息提取任务列表URL,填写任务ID时返回信息提取任务详情URL`",
11617
+ "example": "yDtGEUUgydjcwqRz",
11618
+ "member": "string",
11619
+ "name": "TaskId",
11620
+ "required": false,
11621
+ "type": "string"
11622
+ }
11623
+ ],
11624
+ "type": "object"
11625
+ },
11626
+ "DescribeInformationExtractionWebUrlResponse": {
11627
+ "document": "DescribeInformationExtractionWebUrl返回参数结构体",
11628
+ "members": [
11629
+ {
11630
+ "disabled": false,
11631
+ "document": "合同信息提取嵌入式web页面链接。\n注意:`链接有效期为5分钟,且链接仅能使用一次。`",
11632
+ "example": "https://embed.test.qian.tencent.cn/ai-contract-info-extract-e",
11633
+ "member": "string",
11634
+ "name": "Url",
11635
+ "output_required": true,
11636
+ "type": "string",
11637
+ "value_allowed_null": false
11638
+ },
11639
+ {
11640
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
11641
+ "member": "string",
11642
+ "name": "RequestId",
11643
+ "type": "string"
11644
+ }
11645
+ ],
11646
+ "type": "object"
11647
+ },
11316
11648
  "DescribeIntegrationDepartmentsRequest": {
11317
11649
  "document": "DescribeIntegrationDepartments请求参数结构体",
11318
11650
  "members": [
@@ -11877,8 +12209,8 @@
11877
12209
  },
11878
12210
  {
11879
12211
  "disabled": false,
11880
- "document": "印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>ORGANIZATION_SEAL</strong>:企业印章(通过图片上传创建);</li> <li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li> </ul>",
11881
- "example": "OFFICIAL",
12212
+ "document": "印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>FINANCE</strong>:财务专用章;</li> <li><strong>PERSONNEL</strong>:人事专用章;</li><li><strong>INVOICE</strong>:发票专用章;</li><li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li> </ul>",
12213
+ "example": "[\"OFFICIAL\"]",
11882
12214
  "member": "string",
11883
12215
  "name": "SealTypes",
11884
12216
  "required": false,
@@ -11896,7 +12228,7 @@
11896
12228
  {
11897
12229
  "disabled": false,
11898
12230
  "document": "需查询的印章状态列表。\n<ul>\n<li>空:(默认)仅查询启用状态的印章;</li>\n<li><strong>ALL</strong>:查询所有状态的印章;</li>\n<li><strong>CHECKING</strong>:查询待审核的印章;</li>\n<li><strong>SUCCESS</strong>:查询启用状态的印章;</li>\n<li><strong>FAIL</strong>:查询印章审核拒绝的印章;</li>\n<li><strong>DISABLE</strong>:查询已停用的印章;</li>\n<li><strong>STOPPED</strong>:查询已终止的印章;</li>\n<li><strong>VOID</strong>:查询已作废的印章;</li>\n<li><strong>INVALID</strong>:查询已失效的印章。</li>\n</ul>",
11899
- "example": "ALL",
12231
+ "example": "[\"ALL\"]",
11900
12232
  "member": "string",
11901
12233
  "name": "SealStatuses",
11902
12234
  "required": false,
@@ -12669,6 +13001,80 @@
12669
13001
  ],
12670
13002
  "usage": "in"
12671
13003
  },
13004
+ "ExportContractComparisonTaskRequest": {
13005
+ "document": "ExportContractComparisonTask请求参数结构体",
13006
+ "members": [
13007
+ {
13008
+ "disabled": false,
13009
+ "document": "执行合同审查任务的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
13010
+ "example": "无",
13011
+ "member": "UserInfo",
13012
+ "name": "Operator",
13013
+ "required": true,
13014
+ "type": "object"
13015
+ },
13016
+ {
13017
+ "disabled": false,
13018
+ "document": "合同对比任务ID,该参数通过调用接口CreateContractComparisonTask获取。",
13019
+ "example": "yD*******************ob",
13020
+ "member": "string",
13021
+ "name": "TaskId",
13022
+ "required": true,
13023
+ "type": "string"
13024
+ },
13025
+ {
13026
+ "disabled": false,
13027
+ "document": "导出对比结果文件类型。\n类型如下:\n<ul>\n<li> **0**:【PDF】以新合同文件为基础,导出带有可视化对比点标注的PDF文件。</li>\n<li> **1**:【EXCEL】导出结构化的对比点明细表格,以列表形式罗列每一个差异点,包含改动位置、类型、标签及修改前后的完整内容。</li>\n</ul>",
13028
+ "example": "1",
13029
+ "member": "int64",
13030
+ "name": "ExportType",
13031
+ "required": false,
13032
+ "type": "int"
13033
+ },
13034
+ {
13035
+ "disabled": false,
13036
+ "document": "是否忽略,适用于PDF。\n<ul>\n<li> **true**:导出文件标注去掉忽略项。</li>\n<li> **false**:导出文件包含所有对比点。</li>\n</ul>",
13037
+ "example": "true",
13038
+ "member": "bool",
13039
+ "name": "Ignore",
13040
+ "required": false,
13041
+ "type": "bool"
13042
+ }
13043
+ ],
13044
+ "type": "object"
13045
+ },
13046
+ "ExportContractComparisonTaskResponse": {
13047
+ "document": "ExportContractComparisonTask返回参数结构体",
13048
+ "members": [
13049
+ {
13050
+ "disabled": false,
13051
+ "document": "对比任务详情下载链接。",
13052
+ "example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF",
13053
+ "member": "string",
13054
+ "name": "ResourceUrl",
13055
+ "output_required": false,
13056
+ "type": "string",
13057
+ "value_allowed_null": false
13058
+ },
13059
+ {
13060
+ "disabled": false,
13061
+ "document": "下载链接有效截止时间。",
13062
+ "example": "1760009219",
13063
+ "member": "int64",
13064
+ "name": "ExpireTime",
13065
+ "output_required": false,
13066
+ "type": "int",
13067
+ "value_allowed_null": false
13068
+ },
13069
+ {
13070
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
13071
+ "member": "string",
13072
+ "name": "RequestId",
13073
+ "type": "string"
13074
+ }
13075
+ ],
13076
+ "type": "object"
13077
+ },
12672
13078
  "ExtendAuthInfo": {
12673
13079
  "document": "扩展服务开通和授权的详细信息",
12674
13080
  "members": [
@@ -12807,7 +13213,7 @@
12807
13213
  },
12808
13214
  {
12809
13215
  "disabled": false,
12810
- "document": "用于描述字段信息。\n\n注意:\n1、`如果Type值为OPTION时,需要在字段描述中填写选项值,用,分隔`\n2、描述字段不能超过100个字符",
13216
+ "document": "用于描述字段信息。\n\n注意:\n1、描述字段不能超过100个字符",
12811
13217
  "example": "字段描述",
12812
13218
  "member": "string",
12813
13219
  "name": "Description",
@@ -12826,6 +13232,17 @@
12826
13232
  "required": false,
12827
13233
  "type": "list",
12828
13234
  "value_allowed_null": false
13235
+ },
13236
+ {
13237
+ "disabled": false,
13238
+ "document": "当字段类型`Type`为OPTION时为必输项,输入选项值",
13239
+ "example": "[\"选项值1\"]",
13240
+ "member": "string",
13241
+ "name": "ChoiceList",
13242
+ "output_required": false,
13243
+ "required": false,
13244
+ "type": "list",
13245
+ "value_allowed_null": false
12829
13246
  }
12830
13247
  ],
12831
13248
  "usage": "both"
@@ -13445,7 +13862,7 @@
13445
13862
  {
13446
13863
  "disabled": true,
13447
13864
  "document": "模板配置中的参与方ID,与控件绑定",
13448
- "example": "",
13865
+ "example": "1",
13449
13866
  "member": "string",
13450
13867
  "name": "ReceiptId",
13451
13868
  "output_required": true,
@@ -13465,7 +13882,7 @@
13465
13882
  {
13466
13883
  "disabled": false,
13467
13884
  "document": "签署人手机号",
13468
- "example": "13200000000",
13885
+ "example": "1320****000",
13469
13886
  "member": "string",
13470
13887
  "name": "Mobile",
13471
13888
  "output_required": true,
@@ -13611,7 +14028,7 @@
13611
14028
  {
13612
14029
  "disabled": false,
13613
14030
  "document": "签署人手机号。",
13614
- "example": "13200000000",
14031
+ "example": "1320****000",
13615
14032
  "member": "string",
13616
14033
  "name": "ApproverMobile",
13617
14034
  "output_required": true,
@@ -16295,7 +16712,7 @@
16295
16712
  {
16296
16713
  "disabled": false,
16297
16714
  "document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。",
16298
- "example": "37000019890303000X",
16715
+ "example": "370000****0303000X",
16299
16716
  "member": "string",
16300
16717
  "name": "UniformSocialCreditCode",
16301
16718
  "output_required": false,
@@ -16328,7 +16745,7 @@
16328
16745
  {
16329
16746
  "disabled": false,
16330
16747
  "document": "组织机构法人的证件号码",
16331
- "example": "37000019890303000X",
16748
+ "example": "370000****0303000X",
16332
16749
  "member": "string",
16333
16750
  "name": "LegalIdCardNumber",
16334
16751
  "output_required": false,
@@ -16350,7 +16767,7 @@
16350
16767
  {
16351
16768
  "disabled": false,
16352
16769
  "document": "组织机构超管手机号。\n",
16353
- "example": "18888888888",
16770
+ "example": "1888****888",
16354
16771
  "member": "string",
16355
16772
  "name": "AdminMobile",
16356
16773
  "output_required": false,
@@ -16372,7 +16789,7 @@
16372
16789
  {
16373
16790
  "disabled": false,
16374
16791
  "document": "组织机构超管证件号码\n",
16375
- "example": "37000019890303000X",
16792
+ "example": "370000****0303000X",
16376
16793
  "member": "string",
16377
16794
  "name": "AdminIdCardNumber",
16378
16795
  "output_required": false,
@@ -16394,7 +16811,7 @@
16394
16811
  {
16395
16812
  "disabled": false,
16396
16813
  "document": "原超管手机号",
16397
- "example": "15100000000",
16814
+ "example": "1510****000",
16398
16815
  "member": "string",
16399
16816
  "name": "OldAdminMobile",
16400
16817
  "output_required": false,
@@ -16416,7 +16833,7 @@
16416
16833
  {
16417
16834
  "disabled": false,
16418
16835
  "document": "原超管证件号码",
16419
- "example": "65000019870404000X",
16836
+ "example": "650000****0404000X",
16420
16837
  "member": "string",
16421
16838
  "name": "OldAdminIdCardNumber",
16422
16839
  "output_required": false,
@@ -17435,7 +17852,7 @@
17435
17852
  {
17436
17853
  "disabled": false,
17437
17854
  "document": "签署人手机号。",
17438
- "example": "13200000000",
17855
+ "example": "1320****000",
17439
17856
  "member": "string",
17440
17857
  "name": "Mobile",
17441
17858
  "required": true,
@@ -17444,7 +17861,7 @@
17444
17861
  {
17445
17862
  "disabled": true,
17446
17863
  "document": "要更换的原合同参与人RecipientId编号。(可通过接口<a href=\"https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/\">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>",
17447
- "example": "",
17864
+ "example": "1",
17448
17865
  "member": "string",
17449
17866
  "name": "RelievedApproverReceiptId",
17450
17867
  "required": false,
@@ -17974,7 +18391,7 @@
17974
18391
  {
17975
18392
  "disabled": false,
17976
18393
  "document": "用户手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。",
17977
- "example": "13200000000",
18394
+ "example": "1320****000",
17978
18395
  "member": "string",
17979
18396
  "name": "Mobile",
17980
18397
  "output_required": true,
@@ -18377,7 +18794,7 @@
18377
18794
  {
18378
18795
  "disabled": false,
18379
18796
  "document": "传入的手机号,没有打码",
18380
- "example": "13200000000",
18797
+ "example": "1320****000",
18381
18798
  "member": "string",
18382
18799
  "name": "Mobile",
18383
18800
  "output_required": true,
@@ -18407,6 +18824,34 @@
18407
18824
  ],
18408
18825
  "usage": "out"
18409
18826
  },
18827
+ "Tag": {
18828
+ "document": "标签",
18829
+ "members": [
18830
+ {
18831
+ "disabled": false,
18832
+ "document": "标签键,最大长度不超过50字符。",
18833
+ "example": "Key",
18834
+ "member": "string",
18835
+ "name": "TagKey",
18836
+ "output_required": false,
18837
+ "required": false,
18838
+ "type": "string",
18839
+ "value_allowed_null": false
18840
+ },
18841
+ {
18842
+ "disabled": false,
18843
+ "document": "标签值,最大长度不超过50字符。",
18844
+ "example": "Value",
18845
+ "member": "string",
18846
+ "name": "TagValue",
18847
+ "output_required": false,
18848
+ "required": false,
18849
+ "type": "string",
18850
+ "value_allowed_null": false
18851
+ }
18852
+ ],
18853
+ "usage": "both"
18854
+ },
18410
18855
  "TemplateInfo": {
18411
18856
  "document": "此结构体 (TemplateInfo) 用于描述模板的信息。\n\n> **模板组成** \n>\n> 一个模板通常会包含以下结构信息\n>- 模板基本信息\n>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方\n>- 填写控件 Components\n>- 签署控件 SignComponents\n>- 生成模板的文件基础信息 FileInfos",
18412
18857
  "members": [
@@ -19437,6 +19882,45 @@
19437
19882
  }
19438
19883
  ],
19439
19884
  "usage": "in"
19885
+ },
19886
+ "WebUrlOption": {
19887
+ "document": "提取web嵌入页面个性化设置",
19888
+ "members": [
19889
+ {
19890
+ "disabled": false,
19891
+ "document": "禁用链接预览",
19892
+ "example": "false",
19893
+ "member": "bool",
19894
+ "name": "DisableLinkPreview",
19895
+ "output_required": false,
19896
+ "required": false,
19897
+ "type": "bool",
19898
+ "value_allowed_null": false
19899
+ },
19900
+ {
19901
+ "disabled": false,
19902
+ "document": "禁用任务编辑",
19903
+ "example": "false",
19904
+ "member": "bool",
19905
+ "name": "DisableTaskEditing",
19906
+ "output_required": false,
19907
+ "required": false,
19908
+ "type": "bool",
19909
+ "value_allowed_null": false
19910
+ },
19911
+ {
19912
+ "disabled": false,
19913
+ "document": "禁用任务结果编辑",
19914
+ "example": "false",
19915
+ "member": "bool",
19916
+ "name": "DisableTaskResultEditing",
19917
+ "output_required": false,
19918
+ "required": false,
19919
+ "type": "bool",
19920
+ "value_allowed_null": false
19921
+ }
19922
+ ],
19923
+ "usage": "both"
19440
19924
  }
19441
19925
  },
19442
19926
  "version": "1.0"