tccli 3.0.1315.1__py2.py3-none-any.whl → 3.0.1317.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 (62) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/batch/v20170312/api.json +1 -1
  3. tccli/services/bh/v20230418/api.json +2 -2
  4. tccli/services/cbs/v20170312/api.json +108 -98
  5. tccli/services/cbs/v20170312/examples.json +12 -12
  6. tccli/services/cdb/v20170320/api.json +41 -28
  7. tccli/services/cdb/v20170320/examples.json +12 -0
  8. tccli/services/cdwdoris/v20211228/api.json +20 -0
  9. tccli/services/cfs/v20190719/api.json +39 -39
  10. tccli/services/cfs/v20190719/examples.json +10 -10
  11. tccli/services/cfw/v20190904/api.json +4 -4
  12. tccli/services/cvm/v20170312/api.json +22 -22
  13. tccli/services/cvm/v20170312/examples.json +1 -1
  14. tccli/services/cynosdb/v20190107/api.json +163 -4
  15. tccli/services/dnspod/v20210323/api.json +102 -82
  16. tccli/services/dnspod/v20210323/examples.json +28 -28
  17. tccli/services/domain/v20180808/api.json +10 -10
  18. tccli/services/domain/v20180808/examples.json +1 -1
  19. tccli/services/emr/v20190103/api.json +10 -0
  20. tccli/services/es/v20180416/api.json +49 -0
  21. tccli/services/ess/ess_client.py +53 -0
  22. tccli/services/ess/v20201111/api.json +111 -11
  23. tccli/services/ess/v20201111/examples.json +9 -1
  24. tccli/services/essbasic/v20210526/api.json +25 -7
  25. tccli/services/essbasic/v20210526/examples.json +10 -4
  26. tccli/services/gs/v20191118/api.json +22 -0
  27. tccli/services/hai/v20230812/api.json +59 -59
  28. tccli/services/hai/v20230812/examples.json +6 -6
  29. tccli/services/lke/v20231130/api.json +412 -18
  30. tccli/services/lkeap/lkeap_client.py +53 -53
  31. tccli/services/lkeap/v20240522/api.json +90 -70
  32. tccli/services/lkeap/v20240522/examples.json +8 -8
  33. tccli/services/mps/v20190612/api.json +163 -0
  34. tccli/services/mps/v20190612/examples.json +1 -1
  35. tccli/services/mrs/v20200910/api.json +30 -0
  36. tccli/services/postgres/postgres_client.py +24 -183
  37. tccli/services/postgres/v20170312/api.json +0 -157
  38. tccli/services/postgres/v20170312/examples.json +0 -36
  39. tccli/services/privatedns/v20201028/api.json +6 -6
  40. tccli/services/privatedns/v20201028/examples.json +2 -2
  41. tccli/services/pts/v20210728/api.json +10 -0
  42. tccli/services/ssl/v20191205/api.json +4 -4
  43. tccli/services/tbaas/v20180416/api.json +3 -3
  44. tccli/services/tbaas/v20180416/examples.json +1 -1
  45. tccli/services/tcbr/v20220217/api.json +16 -16
  46. tccli/services/teo/v20220901/api.json +39 -11
  47. tccli/services/teo/v20220901/examples.json +1 -1
  48. tccli/services/tke/tke_client.py +8 -61
  49. tccli/services/tke/v20180525/api.json +16 -114
  50. tccli/services/tke/v20180525/examples.json +0 -8
  51. tccli/services/tke/v20220501/api.json +61 -1
  52. tccli/services/tke/v20220501/examples.json +1 -1
  53. tccli/services/tms/v20201229/api.json +27 -8
  54. tccli/services/tms/v20201229/examples.json +2 -2
  55. tccli/services/vpc/v20170312/api.json +12 -12
  56. tccli/services/vpc/v20170312/examples.json +2 -2
  57. tccli/services/waf/v20180125/api.json +78 -22
  58. {tccli-3.0.1315.1.dist-info → tccli-3.0.1317.1.dist-info}/METADATA +2 -2
  59. {tccli-3.0.1315.1.dist-info → tccli-3.0.1317.1.dist-info}/RECORD +62 -62
  60. {tccli-3.0.1315.1.dist-info → tccli-3.0.1317.1.dist-info}/WHEEL +0 -0
  61. {tccli-3.0.1315.1.dist-info → tccli-3.0.1317.1.dist-info}/entry_points.txt +0 -0
  62. {tccli-3.0.1315.1.dist-info → tccli-3.0.1317.1.dist-info}/license_files/LICENSE +0 -0
@@ -385,6 +385,13 @@
385
385
  "output": "CreateUserMobileChangeUrlResponse",
386
386
  "status": "online"
387
387
  },
388
+ "CreateUserNameChangeUrl": {
389
+ "document": "生成个人用户实名更名链接,个人用户点击此链接进入更名流程(若用户未完成实名认证,则直接进入实名页面实名后再进行更名)。此链接为通用链接,任何点击生成链接的用户将会被引导至小程序个人更名页面完成更名。\n\n注: 调用此接口需要购买<font color=\"red\"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。",
390
+ "input": "CreateUserNameChangeUrlRequest",
391
+ "name": "生成个人更名链接",
392
+ "output": "CreateUserNameChangeUrlResponse",
393
+ "status": "online"
394
+ },
388
395
  "CreateUserVerifyUrl": {
389
396
  "document": "生成个人用户实名认证链接,个人用户点击此链接进入实名流程(若用户已完成实名认证,则直接进入成功页面)。\n\n注: 调用此接口需要购买<font color=\"red\"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。",
390
397
  "input": "CreateUserVerifyUrlRequest",
@@ -923,7 +930,7 @@
923
930
  },
924
931
  {
925
932
  "disabled": false,
926
- "document": "<font coloe=\"red\">【已废弃】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别\n\n注: 将要废弃, ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
933
+ "document": "<font color=\"red\">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别\n\n注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
927
934
  "example": "[\"WEIXINAPP\"]",
928
935
  "member": "string",
929
936
  "name": "VerifyChannel",
@@ -3191,8 +3198,8 @@
3191
3198
  },
3192
3199
  {
3193
3200
  "disabled": false,
3194
- "document": "已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符",
3195
- "example": "yDSLMUUckpotxh18UEnJP33SwMj5LRdW",
3201
+ "document": "该字段已不再使用",
3202
+ "example": "该字段已不再使用",
3196
3203
  "member": "string",
3197
3204
  "name": "ClientToken",
3198
3205
  "required": false,
@@ -4685,6 +4692,15 @@
4685
4692
  "name": "SignComponentConfig",
4686
4693
  "required": false,
4687
4694
  "type": "object"
4695
+ },
4696
+ {
4697
+ "disabled": false,
4698
+ "document": "是否禁止编辑(展示)水印控件属性\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>",
4699
+ "example": "true",
4700
+ "member": "bool",
4701
+ "name": "ForbidEditWatermark",
4702
+ "required": false,
4703
+ "type": "bool"
4688
4704
  }
4689
4705
  ],
4690
4706
  "usage": "in"
@@ -4794,8 +4810,8 @@
4794
4810
  },
4795
4811
  {
4796
4812
  "disabled": false,
4797
- "document": "已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符",
4798
- "example": "cdMyoi1W6hm99",
4813
+ "document": "该字段已不再使用",
4814
+ "example": "该字段已不再使用",
4799
4815
  "member": "string",
4800
4816
  "name": "ClientToken",
4801
4817
  "required": false,
@@ -6643,7 +6659,7 @@
6643
6659
  },
6644
6660
  {
6645
6661
  "disabled": false,
6646
- "document": "该字段已废弃,请使用InitiatorComponents",
6662
+ "document": "该字段已不再使用,请使用InitiatorComponents",
6647
6663
  "example": "无",
6648
6664
  "member": "Component",
6649
6665
  "name": "Components",
@@ -6733,7 +6749,7 @@
6733
6749
  },
6734
6750
  {
6735
6751
  "disabled": true,
6736
- "document": "<font color=\"red\">此参数已经废弃,请使用 CreateFlowOption 里面的 SignComponentConfig</font>\n签署控件的配置信息,用在嵌入式发起的页面配置,\n包括 \n\n- 签署控件 是否默认展示日期.",
6752
+ "document": "<font color=\"red\">此字段已不再使用,请使用 CreateFlowOption 里面的 SignComponentConfig</font>\n签署控件的配置信息,用在嵌入式发起的页面配置,\n包括 \n\n- 签署控件 是否默认展示日期.",
6737
6753
  "example": "无",
6738
6754
  "member": "SignComponentConfig",
6739
6755
  "name": "SignComponentConfig",
@@ -6825,8 +6841,8 @@
6825
6841
  },
6826
6842
  {
6827
6843
  "disabled": true,
6828
- "document": "印章图片的base64\n注:已废弃\n请先通过UploadFiles接口上传文件,获取 FileId",
6829
- "example": "已废弃",
6844
+ "document": "该字段已不再使用",
6845
+ "example": "该字段已不再使用",
6830
6846
  "member": "string",
6831
6847
  "name": "SealImage",
6832
6848
  "required": false,
@@ -6852,7 +6868,7 @@
6852
6868
  },
6853
6869
  {
6854
6870
  "disabled": false,
6855
- "document": "此字段已废弃,请勿继续使用。",
6871
+ "document": "该字段已不再使用",
6856
6872
  "example": "false",
6857
6873
  "member": "bool",
6858
6874
  "name": "EnableAutoSign",
@@ -7942,6 +7958,81 @@
7942
7958
  ],
7943
7959
  "type": "object"
7944
7960
  },
7961
+ "CreateUserNameChangeUrlRequest": {
7962
+ "document": "CreateUserNameChangeUrl请求参数结构体",
7963
+ "members": [
7964
+ {
7965
+ "disabled": false,
7966
+ "document": "操作人信息",
7967
+ "example": "无",
7968
+ "member": "UserInfo",
7969
+ "name": "Operator",
7970
+ "required": true,
7971
+ "type": "object"
7972
+ },
7973
+ {
7974
+ "disabled": false,
7975
+ "document": "要跳转的链接类型\n\n<ul>\n<li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>\n<li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>\n<li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>\n</ul>\n\n注:如果不传递,默认值是 <font color=\"red\"> HTTP </font>",
7976
+ "example": "APP",
7977
+ "member": "string",
7978
+ "name": "Endpoint",
7979
+ "required": false,
7980
+ "type": "string"
7981
+ },
7982
+ {
7983
+ "disabled": false,
7984
+ "document": "在用户完成改名后,其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。",
7985
+ "example": "MTIzNDU2Nzg5",
7986
+ "member": "string",
7987
+ "name": "UserData",
7988
+ "required": false,
7989
+ "type": "string"
7990
+ }
7991
+ ],
7992
+ "type": "object"
7993
+ },
7994
+ "CreateUserNameChangeUrlResponse": {
7995
+ "document": "CreateUserNameChangeUrl返回参数结构体",
7996
+ "members": [
7997
+ {
7998
+ "disabled": false,
7999
+ "document": "腾讯电子签小程序的个人更名链接。\n如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。\n\n<strong>1.如果EndPoint是APP</strong>:\n得到的链接类似于<a href=\"\">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n<strong>2.如果EndPoint是HTTP</strong>:\n得到的链接类似于 <a href=\"\">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n\n`注:` <font color=\"red\">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>",
8000
+ "example": "https://essurl.cn/2n**42Nd",
8001
+ "member": "string",
8002
+ "name": "UserVerifyUrl",
8003
+ "output_required": true,
8004
+ "type": "string",
8005
+ "value_allowed_null": false
8006
+ },
8007
+ {
8008
+ "disabled": false,
8009
+ "document": "链接过期时间,为Unix时间戳(单位为秒)。",
8010
+ "example": "1736416390",
8011
+ "member": "int64",
8012
+ "name": "ExpireTime",
8013
+ "output_required": true,
8014
+ "type": "int",
8015
+ "value_allowed_null": false
8016
+ },
8017
+ {
8018
+ "disabled": false,
8019
+ "document": "小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回",
8020
+ "example": "gh_da88f6188665",
8021
+ "member": "string",
8022
+ "name": "MiniAppId",
8023
+ "output_required": true,
8024
+ "type": "string",
8025
+ "value_allowed_null": false
8026
+ },
8027
+ {
8028
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
8029
+ "member": "string",
8030
+ "name": "RequestId",
8031
+ "type": "string"
8032
+ }
8033
+ ],
8034
+ "type": "object"
8035
+ },
7945
8036
  "CreateUserVerifyUrlRequest": {
7946
8037
  "document": "CreateUserVerifyUrl请求参数结构体",
7947
8038
  "members": [
@@ -10882,6 +10973,15 @@
10882
10973
  "name": "SkipUploadFile",
10883
10974
  "required": false,
10884
10975
  "type": "bool"
10976
+ },
10977
+ {
10978
+ "disabled": false,
10979
+ "document": "是否禁止编辑(展示)水印控件属性\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>\n",
10980
+ "example": "true",
10981
+ "member": "bool",
10982
+ "name": "ForbidEditWatermark",
10983
+ "required": false,
10984
+ "type": "bool"
10885
10985
  }
10886
10986
  ],
10887
10987
  "usage": "in"
@@ -16136,7 +16236,7 @@
16136
16236
  },
16137
16237
  {
16138
16238
  "disabled": false,
16139
- "document": "用户自定义ID数组,与上传文件一一对应\n\n注: `历史遗留问题,已经废弃,调用接口时不用赋值`",
16239
+ "document": "该字段已不再使用",
16140
16240
  "example": "9b337a42",
16141
16241
  "member": "string",
16142
16242
  "name": "CustomIds",
@@ -1037,7 +1037,7 @@
1037
1037
  "CreatePrepareFlowGroup": [
1038
1038
  {
1039
1039
  "document": "",
1040
- "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlowGroup\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf3UUckps8dvypUEfH3DjwIpMfa0uw\"\n },\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDCWiUUckpv6iggyUyuqIrwyppQVS7TR\"\n ],\n \"FlowName\": \"预发起合同\",\n \"FlowType\": \"嵌入式文件发起合同\",\n \"FlowDescription\": \"描述\",\n \"Deadline\": 1757034793,\n \"Unordered\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"OrganizationName\": \"\",\n \"ApproverName\": \"典子签\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"ApproverMobile\": \"18700000000\",\n \"SignComponents\": [\n {\n \"ChannelComponentId\": \"\",\n \"ChannelComponentSource\": 0,\n \"ComponentDateFontSize\": 0,\n \"ComponentExtra\": \"\",\n \"ComponentHeight\": 100,\n \"ComponentId\": \"\",\n \"ComponentName\": \"\",\n \"ComponentPage\": 3,\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentRecipientId\": \"\",\n \"ComponentRequired\": false,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentValue\": \"\",\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ForbidMoveAndDelete\": true,\n \"GenerateMode\": \"\",\n \"IsFormType\": false,\n \"KeywordIndexes\": [],\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"LockComponentValue\": false,\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"FlowGroupName\": \"group\",\n \"ResourceType\": 2\n}",
1040
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlowGroup\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf3UUckps8dvypUEfH3DjwIpMfa0uw\"\n },\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDCWiUUckpv6iggyUyuqIrwyppQVS7TR\"\n ],\n \"FlowName\": \"预发起合同\",\n \"FlowType\": \"嵌入式文件发起合同\",\n \"FlowDescription\": \"这是2025年购买食物的合同\",\n \"Deadline\": 1757034793,\n \"Unordered\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"OrganizationName\": \"\",\n \"ApproverName\": \"典子签\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"ApproverMobile\": \"18700000000\",\n \"SignComponents\": [\n {\n \"ChannelComponentId\": \"\",\n \"ChannelComponentSource\": 0,\n \"ComponentDateFontSize\": 0,\n \"ComponentExtra\": \"\",\n \"ComponentHeight\": 100,\n \"ComponentId\": \"\",\n \"ComponentName\": \"\",\n \"ComponentPage\": 3,\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentRecipientId\": \"\",\n \"ComponentRequired\": false,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentValue\": \"\",\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ForbidMoveAndDelete\": true,\n \"GenerateMode\": \"\",\n \"IsFormType\": false,\n \"KeywordIndexes\": [],\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"LockComponentValue\": false,\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"FlowGroupName\": \"group\",\n \"ResourceType\": 2\n}",
1041
1041
  "output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDttAUUckpxbcziqUySqdD5Eugn0LPHo\",\n \"RequestId\": \"s1747034803503801327\",\n \"PrepareUrl\": \"https://embed.test.qian.tencent.cn/contract-create?embed=1&expiredOn=1747035103&code=yDttAUUckpxbcHI&businessId=yDttAUUckpxbcziqUySqdD5o&channel=TENCENTCLOUD&operateSource=byFileGroup&themeId=saas_web_theme_yDhk9nE0qLixm\"\n }\n}",
1042
1042
  "title": "文件发起嵌入式合同组"
1043
1043
  }
@@ -1256,6 +1256,14 @@
1256
1256
  "title": "使用二要素生成修改员工手机号链接"
1257
1257
  }
1258
1258
  ],
1259
+ "CreateUserNameChangeUrl": [
1260
+ {
1261
+ "document": "生成个人通用更名链接",
1262
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserNameChangeUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"19561039c9***********32520fde6a\",\n \"ClientIp\": \"8.8.8.8\"\n },\n \"Endpoint\": \"HTTP\",\n \"UserData\": \"TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5LCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=\"\n}",
1263
+ "output": "{\n \"Response\": {\n \"ExpireTime\": 1748247333,\n \"MiniAppId\": \"\",\n \"RequestId\": \"s1747642533895017639\",\n \"UserVerifyUrl\": \"https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=MP_PERSONAL_VERIFY&shortKey=yDttYU******bLXcb\"\n }\n}",
1264
+ "title": "生成个人更名链接"
1265
+ }
1266
+ ],
1259
1267
  "CreateUserVerifyUrl": [
1260
1268
  {
1261
1269
  "document": "获取c端用户实名链接",
@@ -610,7 +610,7 @@
610
610
  "status": "online"
611
611
  },
612
612
  "PrepareFlows": {
613
- "document": "该接口 (PrepareFlows) 用于创建待发起文件\n用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。\n目前该接口只支持B2C,<font color='red'> **不建议使用,将会废弃**</font>。",
613
+ "document": "该接口 (PrepareFlows) 用于创建待发起文件\n用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。\n目前该接口只支持B2C,<font color='red'> **不建议使用**</font>。",
614
614
  "input": "PrepareFlowsRequest",
615
615
  "name": "准备待发起文件",
616
616
  "output": "PrepareFlowsResponse",
@@ -1798,7 +1798,7 @@
1798
1798
  "members": [
1799
1799
  {
1800
1800
  "disabled": false,
1801
- "document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n<ul>\n<li>若为个人参与方:ApproverType:\"PERSON\"</li>\n<li>若为企业参与方:ApproverType:\"ORGANIZATION\"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>\n</ul>\n\n注:\n`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`\n`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`",
1801
+ "document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n<ul>\n<li>若为个人参与方:ApproverType:\"PERSON\"</li>\n<li>若为企业参与方:ApproverType:\"ORGANIZATION\"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。(如果OrganizationOpenId对应子客企业已经认证激活,则可以省略OrganizationName参数)</li>\n</ul>\n\n注:\n`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`\n`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`",
1802
1802
  "example": "无",
1803
1803
  "member": "FlowApproverInfo",
1804
1804
  "name": "FlowApproverInfo",
@@ -3068,7 +3068,7 @@
3068
3068
  },
3069
3069
  {
3070
3070
  "disabled": false,
3071
- "document": "流程签署人列表,其中结构体的ApproverType必传。\n若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。\n若为子客企业签署方则需传OpenId、OrganizationOpenId,OrganizationName 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)\n\n此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:\n1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。\n2. ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。\n3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。\n4. Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`",
3071
+ "document": "流程签署人列表,其中结构体的ApproverType必传。\n若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。\n若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)\n\n此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:\n1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。\n2. ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。\n3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。\n4. Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`",
3072
3072
  "example": "无",
3073
3073
  "member": "FlowApproverInfo",
3074
3074
  "name": "FlowApproverInfos",
@@ -3737,8 +3737,8 @@
3737
3737
  },
3738
3738
  {
3739
3739
  "disabled": false,
3740
- "document": "此字段已废弃,请勿继续使用。",
3741
- "example": "字段已废弃",
3740
+ "document": "该字段已不再使用",
3741
+ "example": "该字段已不再使用",
3742
3742
  "member": "bool",
3743
3743
  "name": "EnableAutoSign",
3744
3744
  "required": false,
@@ -7656,6 +7656,15 @@
7656
7656
  "name": "SignComponentConfig",
7657
7657
  "required": false,
7658
7658
  "type": "object"
7659
+ },
7660
+ {
7661
+ "disabled": false,
7662
+ "document": "是否禁止编辑(展示)水印控件属性\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>",
7663
+ "example": "true",
7664
+ "member": "bool",
7665
+ "name": "ForbidEditWatermark",
7666
+ "required": false,
7667
+ "type": "bool"
7659
7668
  }
7660
7669
  ],
7661
7670
  "usage": "in"
@@ -9712,6 +9721,15 @@
9712
9721
  "name": "SkipUploadFile",
9713
9722
  "required": false,
9714
9723
  "type": "string"
9724
+ },
9725
+ {
9726
+ "disabled": false,
9727
+ "document": "是否禁止编辑(展示)水印控件属性\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>",
9728
+ "example": "true",
9729
+ "member": "bool",
9730
+ "name": "ForbidEditWatermark",
9731
+ "required": false,
9732
+ "type": "bool"
9715
9733
  }
9716
9734
  ],
9717
9735
  "usage": "in"
@@ -9812,7 +9830,7 @@
9812
9830
  },
9813
9831
  {
9814
9832
  "disabled": false,
9815
- "document": "指定企业经办签署人OpenId",
9833
+ "document": "指定企业经办签署人OpenId\n\n注: `签署人OpenId未实名时,需要传入签署人姓名以及手机号码。`",
9816
9834
  "example": "n9527",
9817
9835
  "member": "string",
9818
9836
  "name": "OpenId",
@@ -13430,7 +13448,7 @@
13430
13448
  },
13431
13449
  {
13432
13450
  "disabled": false,
13433
- "document": "二维码,在生成动态签署人跳转封面页链接时返回",
13451
+ "document": "二维码,在生成动态签署人跳转封面页链接时返回\n\n注:`此二维码下载链接有效期为5分钟,可下载二维码后本地保存。`",
13434
13452
  "example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d**2f0db15e6b",
13435
13453
  "member": "string",
13436
13454
  "name": "SignQrcodeUrl",
@@ -236,10 +236,10 @@
236
236
  ],
237
237
  "ChannelCreateFlowApprovers": [
238
238
  {
239
- "document": "在B2C签署中,双方签署方未指定具体签署人时,需要进行补充。 \n注:`补充动态签署人时FillApproverType传值为1 `",
240
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowApprovers\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"Agent\": {\n \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n },\n \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n },\n \"FlowId\": \"111111***22222\",\n \"FillApproverType\": 1,\n \"Approvers\": [\n {\n \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OrganizationName\": \"***有限公司\",\n \"OrganizationOpenId\": \"org_diziqian\"\n },\n {\n \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"ApproverName\": \"张三\",\n \"ApproverMobile\": \"18888888888\"\n }\n ]\n}",
239
+ "document": "在B2C签署中,双方签署方未指定具体签署人时,需要进行补充。 \n注:\n`补充动态签署人时FillApproverType传值为1 `\n`子客企业签署人OpenId未实名的情况下,需要传入签署人姓名和手机号码(ApproverName和ApproverMobile)`",
240
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowApprovers\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"Agent\": {\n \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n },\n \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n },\n \"FlowId\": \"111111***22222\",\n \"FillApproverType\": 1,\n \"Approvers\": [\n {\n \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n \"ApproverName\": \"典子谦\",\n \"ApproverMobile\": \"13200000000\",\n \"OpenId\": \"zhangsan\",\n \"OrganizationName\": \"***有限公司\",\n \"OrganizationOpenId\": \"org_diziqian\"\n },\n {\n \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"ApproverName\": \"张三\",\n \"ApproverMobile\": \"18888888888\"\n }\n ]\n}",
241
241
  "output": "{\n \"Response\": {\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\"\n }\n}",
242
- "title": "B2C签署,批量补充两方动态签署人信息"
242
+ "title": "B2C签署,批量补充两方动态签署人信息,子客企业签署人未实名"
243
243
  },
244
244
  {
245
245
  "document": "在B2C签署中,双方签署方未指定具体签署人时,需要进行补充。 \n注:`补充动态签署人时FillApproverType传值为1 `",
@@ -258,6 +258,12 @@
258
258
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowApprovers\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"Agent\": {\n \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n },\n \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n },\n \"FlowId\": \"111111***22222\",\n \"FillApproverType\": 1,\n \"Approvers\": [\n {\n \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"ApproverName\": \"张三\",\n \"ApproverIdCardType\": \"ID_CARD\",\n \"ApproverIdCardNumber\": \"620000198802020000\"\n }\n ]\n}",
259
259
  "output": "{\n \"Response\": {\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\"\n }\n}",
260
260
  "title": "B2C签署,通过姓名和证件类型、证件号码补充已实名个人用户"
261
+ },
262
+ {
263
+ "document": "在B2C签署中,双方签署方未指定具体签署人时,需要进行补充。 \n注:\n`补充动态签署人时FillApproverType传值为1 `",
264
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowApprovers\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"Agent\": {\n \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n },\n \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n },\n \"FlowId\": \"111111***22222\",\n \"FillApproverType\": 1,\n \"Approvers\": [\n {\n \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n \"OpenId\": \"zhangsan\",\n \"OrganizationName\": \"***有限公司\",\n \"OrganizationOpenId\": \"org_diziqian\"\n },\n {\n \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"ApproverName\": \"张三\",\n \"ApproverMobile\": \"18888888888\"\n }\n ]\n}",
265
+ "output": "{\n \"Response\": {\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\"\n }\n}",
266
+ "title": "B2C签署,批量补充两方动态签署人信息,子客企业签署人已实名"
261
267
  }
262
268
  ],
263
269
  "ChannelCreateFlowByFiles": [
@@ -481,7 +487,7 @@
481
487
  "ChannelCreatePrepareFlowGroup": [
482
488
  {
483
489
  "document": "",
484
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlowGroup\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2\",\n \"ProxyOrganizationOpenId\": \"kevinlcheng_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"kevinlcheng_1\"\n }\n },\n \"FlowGroupName\": \"group\",\n \"ResourceType\": 2,\n \"BaseFlowInfos\": [\n {\n \"FlowName\": \"第三方预发起合同\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FileIds\": [\n \"yDCWiUUckpv6iggyUyuqIrwyppQVS7TR\"\n ],\n \"FlowDescription\": \"描述\",\n \"Deadline\": 1757034793,\n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": [],\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"OrganizationName\": \"\",\n \"NotChannelOrganization\": false,\n \"ApproverName\": \"张轩\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"IsFullText\": true,\n \"ApproverMobile\": \"18729585347\",\n \"SignComponents\": [\n {\n \"ChannelComponentId\": \"\",\n \"ComponentDateFontSize\": 0,\n \"ComponentDescription\": \"\",\n \"ComponentExtra\": \"\",\n \"ComponentHeight\": 100,\n \"ComponentId\": \"\",\n \"ComponentName\": \"\",\n \"ComponentPage\": 3,\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentRecipientId\": \"\",\n \"ComponentRequired\": false,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentValue\": \"\",\n \"ComponentWidth\": 100,\n \"DocumentId\": \"\",\n \"FileIndex\": 0,\n \"ForbidMoveAndDelete\": true,\n \"GenerateMode\": \"\",\n \"KeywordIndexes\": [],\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"LockComponentValue\": false,\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"Placeholder\": \"\",\n \"RelativeLocation\": \"\"\n }\n ]\n }\n ]\n }\n ]\n}",
490
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlowGroup\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2\",\n \"ProxyOrganizationOpenId\": \"kevinlcheng_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"kevinlcheng_1\"\n }\n },\n \"FlowGroupName\": \"group\",\n \"ResourceType\": 2,\n \"BaseFlowInfos\": [\n {\n \"FlowName\": \"第三方预发起合同\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FileIds\": [\n \"yDCWiUUckpv6iggyUyuqIrwyppQVS7TR\"\n ],\n \"FlowDescription\": \"这是2025年购买食物的合同\",\n \"Deadline\": 1757034793,\n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": [],\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"OrganizationName\": \"\",\n \"NotChannelOrganization\": false,\n \"ApproverName\": \"典子签\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"IsFullText\": true,\n \"ApproverMobile\": \"18700000000\",\n \"SignComponents\": [\n {\n \"ChannelComponentId\": \"\",\n \"ComponentDateFontSize\": 0,\n \"ComponentDescription\": \"\",\n \"ComponentExtra\": \"\",\n \"ComponentHeight\": 100,\n \"ComponentId\": \"\",\n \"ComponentName\": \"\",\n \"ComponentPage\": 3,\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentRecipientId\": \"\",\n \"ComponentRequired\": false,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentValue\": \"\",\n \"ComponentWidth\": 100,\n \"DocumentId\": \"\",\n \"FileIndex\": 0,\n \"ForbidMoveAndDelete\": true,\n \"GenerateMode\": \"\",\n \"KeywordIndexes\": [],\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"LockComponentValue\": false,\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"Placeholder\": \"\",\n \"RelativeLocation\": \"\"\n }\n ]\n }\n ]\n }\n ]\n}",
485
491
  "output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDttAUUckpxbcz9uUySqdD58t8bwneLp\",\n \"PrepareUrl\": \"https://embed.test.qian.tencent.cn/contract-create?embed=1&expiredOn=1747036582&code=yDttAUUckpxbcz9vUySqdD5u3jnsKVT6&businessId=yDttAUUckpxbcz9uUySqdD58t8bwneLp&channel=PROXYCHANNEL&operateSource=byFileGroup&themeId=channel_web_theme_yDSLbUUckpo3e14eUEK7ajSyPX7g3kIc\",\n \"RequestId\": \"s1747036282702037847\"\n }\n}",
486
492
  "title": "嵌入式文件发起合同组"
487
493
  }
@@ -712,6 +712,28 @@
712
712
  "required": false,
713
713
  "type": "string",
714
714
  "value_allowed_null": false
715
+ },
716
+ {
717
+ "disabled": false,
718
+ "document": "创建时间",
719
+ "example": "2021-07-02T10:15:36Z",
720
+ "member": "string",
721
+ "name": "CreateTime",
722
+ "output_required": false,
723
+ "required": false,
724
+ "type": "string",
725
+ "value_allowed_null": false
726
+ },
727
+ {
728
+ "disabled": false,
729
+ "document": "机箱 ID",
730
+ "example": "U12",
731
+ "member": "string",
732
+ "name": "HostServerSerialNumber",
733
+ "output_required": false,
734
+ "required": false,
735
+ "type": "string",
736
+ "value_allowed_null": false
715
737
  }
716
738
  ],
717
739
  "usage": "both"