tccli 3.0.1033.1__py2.py3-none-any.whl → 3.0.1035.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (60) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/cwp/v20180228/SyncBaselineDetectSummary.md +28 -0
  3. tccli/examples/dnspod/v20210323/DescribeRecordList.md +4 -2
  4. tccli/examples/ess/v20201111/ModifyExtendedService.md +79 -0
  5. tccli/examples/oceanus/v20190422/CreateFolder.md +3 -50
  6. tccli/examples/oceanus/v20190422/DescribeWorkSpaces.md +6 -3
  7. tccli/examples/oceanus/v20190422/GetMetaTable.md +29 -0
  8. tccli/examples/omics/v20221128/RetryRuns.md +50 -4
  9. tccli/examples/tcss/v20201101/DescribeAssetHostList.md +3 -1
  10. tccli/examples/trp/v20210515/DescribeProducts.md +6 -3
  11. tccli/examples/tse/v20201207/CreateCloudNativeAPIGatewayPublicNetwork.md +26 -0
  12. tccli/examples/tse/v20201207/DeleteCloudNativeAPIGatewayPublicNetwork.md +23 -0
  13. tccli/examples/tse/v20201207/ModifyConsoleNetwork.md +22 -0
  14. tccli/examples/tse/v20201207/ModifyNetworkAccessStrategy.md +26 -0
  15. tccli/examples/tse/v20201207/ModifyNetworkBasicInfo.md +25 -0
  16. tccli/examples/tsf/v20180326/ContinueRunFailedTaskBatch.md +2 -1
  17. tccli/examples/wedata/v20210820/DescribeFieldBasicInfo.md +103 -0
  18. tccli/examples/wedata/v20210820/DescribeTableBasicInfo.md +93 -0
  19. tccli/examples/wedata/v20210820/DescribeTableLineageInfo.md +135 -0
  20. tccli/services/aiart/v20221229/api.json +2 -2
  21. tccli/services/cat/v20180409/api.json +3 -3
  22. tccli/services/cfw/v20190904/api.json +7 -7
  23. tccli/services/csip/v20221121/api.json +8 -8
  24. tccli/services/cwp/v20180228/api.json +22 -12
  25. tccli/services/cwp/v20180228/examples.json +6 -0
  26. tccli/services/dbbrain/v20191016/api.json +3 -1
  27. tccli/services/dnspod/v20210323/api.json +5 -3
  28. tccli/services/dnspod/v20210323/examples.json +1 -1
  29. tccli/services/ess/ess_client.py +53 -0
  30. tccli/services/ess/v20201111/api.json +99 -19
  31. tccli/services/ess/v20201111/examples.json +20 -0
  32. tccli/services/essbasic/v20210526/api.json +18 -18
  33. tccli/services/ivld/v20210903/api.json +3 -3
  34. tccli/services/oceanus/oceanus_client.py +53 -0
  35. tccli/services/oceanus/v20190422/api.json +124 -1
  36. tccli/services/oceanus/v20190422/examples.json +11 -15
  37. tccli/services/omics/v20221128/api.json +41 -4
  38. tccli/services/omics/v20221128/examples.json +16 -4
  39. tccli/services/scf/v20180416/api.json +11 -2
  40. tccli/services/ssm/v20190923/api.json +6 -2
  41. tccli/services/tcss/v20201101/api.json +35 -5
  42. tccli/services/tcss/v20201101/examples.json +1 -1
  43. tccli/services/teo/v20220901/api.json +5 -5
  44. tccli/services/tiw/v20190919/api.json +21 -2
  45. tccli/services/trp/v20210515/api.json +63 -5
  46. tccli/services/trp/v20210515/examples.json +2 -2
  47. tccli/services/tse/tse_client.py +281 -16
  48. tccli/services/tse/v20201207/api.json +323 -0
  49. tccli/services/tse/v20201207/examples.json +40 -0
  50. tccli/services/tsf/v20180326/api.json +41 -30
  51. tccli/services/tsf/v20180326/examples.json +1 -1
  52. tccli/services/vod/v20180717/api.json +19 -6
  53. tccli/services/wedata/v20210820/api.json +1018 -80
  54. tccli/services/wedata/v20210820/examples.json +54 -0
  55. tccli/services/wedata/wedata_client.py +167 -8
  56. {tccli-3.0.1033.1.dist-info → tccli-3.0.1035.1.dist-info}/METADATA +2 -2
  57. {tccli-3.0.1033.1.dist-info → tccli-3.0.1035.1.dist-info}/RECORD +60 -50
  58. {tccli-3.0.1033.1.dist-info → tccli-3.0.1035.1.dist-info}/WHEEL +0 -0
  59. {tccli-3.0.1033.1.dist-info → tccli-3.0.1035.1.dist-info}/entry_points.txt +0 -0
  60. {tccli-3.0.1033.1.dist-info → tccli-3.0.1035.1.dist-info}/license_files/LICENSE +0 -0
@@ -693,6 +693,58 @@ def doVerifyPdf(args, parsed_globals):
693
693
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
694
694
 
695
695
 
696
+ def doModifyExtendedService(args, parsed_globals):
697
+ g_param = parse_global_arg(parsed_globals)
698
+
699
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
700
+ cred = credential.CVMRoleCredential()
701
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
702
+ cred = credential.STSAssumeRoleCredential(
703
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
704
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')]
705
+ )
706
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
707
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
708
+ else:
709
+ cred = credential.Credential(
710
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
711
+ )
712
+ http_profile = HttpProfile(
713
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
714
+ reqMethod="POST",
715
+ endpoint=g_param[OptionsDefine.Endpoint],
716
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
717
+ )
718
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
719
+ if g_param[OptionsDefine.Language]:
720
+ profile.language = g_param[OptionsDefine.Language]
721
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
722
+ client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile)
723
+ client._sdkVersion += ("_CLI_" + __version__)
724
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
725
+ model = models.ModifyExtendedServiceRequest()
726
+ model.from_json_string(json.dumps(args))
727
+ start_time = time.time()
728
+ while True:
729
+ rsp = client.ModifyExtendedService(model)
730
+ result = rsp.to_json_string()
731
+ try:
732
+ json_obj = json.loads(result)
733
+ except TypeError as e:
734
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
735
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
736
+ break
737
+ cur_time = time.time()
738
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
739
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
740
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
741
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
742
+ else:
743
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
744
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
745
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
746
+
747
+
696
748
  def doUnbindEmployeeUserIdWithClientOpenId(args, parsed_globals):
697
749
  g_param = parse_global_arg(parsed_globals)
698
750
 
@@ -3681,6 +3733,7 @@ ACTION_MAP = {
3681
3733
  "CreateFlowGroupSignReview": doCreateFlowGroupSignReview,
3682
3734
  "CreateEmbedWebUrl": doCreateEmbedWebUrl,
3683
3735
  "VerifyPdf": doVerifyPdf,
3736
+ "ModifyExtendedService": doModifyExtendedService,
3684
3737
  "UnbindEmployeeUserIdWithClientOpenId": doUnbindEmployeeUserIdWithClientOpenId,
3685
3738
  "CreateBatchCancelFlowUrl": doCreateBatchCancelFlowUrl,
3686
3739
  "DeleteIntegrationDepartment": doDeleteIntegrationDepartment,
@@ -225,7 +225,7 @@
225
225
  "status": "online"
226
226
  },
227
227
  "CreateSchemeUrl": {
228
- "document": "获取跳转至腾讯电子签小程序的签署链接\n\n适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。\n\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n\n注:\n`1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`\n\n`2. 签署链接的有效期为90天,超过有效期链接不可用`\n\n`3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接`\n\n其中小程序的原始Id如下,或者查看小程序信息自助获取。\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
228
+ "document": "获取跳转至腾讯电子签小程序的签署链接\n\n适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。\n\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n\n注:\n<ul><li>1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署</li>\n<li>2. 签署链接的有效期为<font color=\"red\">90天</font>,超过有效期链接不可用</li>\n<li>3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接</li>\n<li>4. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ul>\n\n其中小程序的原始Id如下,或者查看小程序信息自助获取。\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
229
229
  "input": "CreateSchemeUrlRequest",
230
230
  "name": "获取跳转至腾讯电子签小程序的签署链接",
231
231
  "output": "CreateSchemeUrlResponse",
@@ -316,7 +316,7 @@
316
316
  "status": "online"
317
317
  },
318
318
  "DescribeExtendedServiceAuthInfos": {
319
- "document": "查询企业扩展服务的开通和授权情况,当前支持查询以下内容:\n1. 企业自动签\n2. 企业与港澳台居民签署合同\n3. 使用手机号验证签署方身份\n4. 骑缝章\n5. 批量签署能力\n6. 拓宽签署方年龄限制",
319
+ "document": "查询企业扩展服务的开通和授权情况,当前支持查询以下内容:\n\n1. **企业自动签署**\n2. **批量签署授权**\n3. **企业与港澳台居民签署合同**\n4. **拓宽签署方年龄限制**\n5. **个人签署方仅校验手机号**\n6. **隐藏合同经办人姓名**\n7. **正楷临摹签名失败后更换其他签名类型**\n8. **短信通知签署方**\n9. **个人签署方手动签字**\n10. **骑缝章**\n11. **签署密码开通引导**\n\n\n对应能力开通页面在Web控制台-更多-企业设置-拓展服务,如下图所示:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/7d79746ecca1c5fe878a2ec36ed69c23.jpg)\n\n注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId需要传递超管或者法人的UserId)",
320
320
  "input": "DescribeExtendedServiceAuthInfosRequest",
321
321
  "name": "查询企业扩展服务授权信息",
322
322
  "output": "DescribeExtendedServiceAuthInfosResponse",
@@ -441,6 +441,13 @@
441
441
  "output": "ModifyApplicationCallbackInfoResponse",
442
442
  "status": "online"
443
443
  },
444
+ "ModifyExtendedService": {
445
+ "document": "管理企业扩展服务 ,企业经办人需要是企业超管或者法人。\n\n跳转小程序的几种方式:主要是设置不同的EndPoint\n1. 通过链接Url直接跳转到小程序,不需要返回\n设置EndPoint为WEIXINAPP,得到链接打开即可。\n\n2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App\n跳转到小程序的实现,参考官方文档<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html\">打开 App</a>\n设置EndPoint为APP,得到path。\n\n3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序\n跳转到小程序的实现,参考官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n设置EndPoint为APP,得到path。\n\n4.其中小程序的原始Id如下,或者查看小程序信息自助获取。\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
446
+ "input": "ModifyExtendedServiceRequest",
447
+ "name": "管理企业扩展服务",
448
+ "output": "ModifyExtendedServiceResponse",
449
+ "status": "online"
450
+ },
444
451
  "ModifyIntegrationDepartment": {
445
452
  "document": "此接口(ModifyIntegrationDepartment)用于更新企业的部门信息,支持更新部门名称、客户系统部门ID和部门序号等信息。",
446
453
  "input": "ModifyIntegrationDepartmentRequest",
@@ -2139,7 +2146,7 @@
2139
2146
  "members": [
2140
2147
  {
2141
2148
  "disabled": false,
2142
- "document": "批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。\n\n注: `非小程序和APP集成使用`",
2149
+ "document": "批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。\n\n注: \n1. 非小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
2143
2150
  "example": "无",
2144
2151
  "member": "string",
2145
2152
  "name": "SignUrl",
@@ -2159,7 +2166,7 @@
2159
2166
  },
2160
2167
  {
2161
2168
  "disabled": false,
2162
- "document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径\n\n注: `小程序和APP集成使用`",
2169
+ "document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径\n\n注: \n1. 小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
2163
2170
  "example": "无",
2164
2171
  "member": "string",
2165
2172
  "name": "MiniAppPath",
@@ -4976,7 +4983,7 @@
4976
4983
  "members": [
4977
4984
  {
4978
4985
  "disabled": false,
4979
- "document": "腾讯电子签小程序的签署链接。\n\n<ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的\"跳转到小程序的实现\"</li>\n<li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>\n<li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>",
4986
+ "document": "腾讯电子签小程序的签署链接。\n\n<ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的\"跳转到小程序的实现\"</li>\n<li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>\n<li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>\n\n\n注: <font color=\"red\">生成的链路后面不能再增加参数</font>",
4980
4987
  "example": "https://essurl.cn/2n**42Nd",
4981
4988
  "member": "string",
4982
4989
  "name": "SchemeUrl",
@@ -6141,8 +6148,8 @@
6141
6148
  },
6142
6149
  {
6143
6150
  "disabled": false,
6144
- "document": "要查询的扩展服务类型。\n默认为空,即查询当前支持的所有扩展服务信息。\n若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:\n<ul><li>OPEN_SERVER_SIGN:企业静默签署</li>\n<li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>\n<li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>\n<li>PAGING_SEAL:骑缝章</li>\n<li>BATCH_SIGN:批量签署</li>\n<li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li></ul>\n",
6145
- "example": "\"\"",
6151
+ "document": "要查询的扩展服务类型。\n默认为空,即查询当前支持的所有扩展服务信息。\n若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:\n<ul><li>OPEN_SERVER_SIGN:企业自动签署</li>\n<li>BATCH_SIGN:批量签署</li>\n<li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>\n<li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>\n<li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>\n<li>HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名</li>\n<li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>\n<li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>\n<li>HIDE_ONE_KEY_SIGN:个人签署方手动签字</li>\n<li>PAGING_SEAL:骑缝章</li>\n<li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li></ul>",
6152
+ "example": "OPEN_SERVER_SIGN",
6146
6153
  "member": "string",
6147
6154
  "name": "ExtendServiceType",
6148
6155
  "required": false,
@@ -7541,7 +7548,7 @@
7541
7548
  "members": [
7542
7549
  {
7543
7550
  "disabled": false,
7544
- "document": "扩展服务的类型,可能是以下值:\n<ul><li>OPEN_SERVER_SIGN:企业静默签署</li>\n<li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>\n<li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>\n<li>PAGING_SEAL:骑缝章</li>\n<li>BATCH_SIGN:批量签署</li></ul>",
7551
+ "document": "扩展服务的类型,可能是以下值:\n<ul><li>OPEN_SERVER_SIGN:企业自动签署</li>\n<li>BATCH_SIGN:批量签署</li>\n<li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>\n<li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>\n<li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>\n<li>HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名</li>\n<li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>\n<li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>\n<li>HIDE_ONE_KEY_SIGN:个人签署方手动签字</li>\n<li>PAGING_SEAL:骑缝章</li>\n<li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li></ul>",
7545
7552
  "example": "BATCH_SIGN",
7546
7553
  "member": "string",
7547
7554
  "name": "Type",
@@ -7563,7 +7570,7 @@
7563
7570
  },
7564
7571
  {
7565
7572
  "disabled": false,
7566
- "document": "扩展服务的开通状态:\nENABLE:开通\nDISABLE:未开通",
7573
+ "document": "扩展服务的开通状态:\n<ul>\n<li>ENABLE : 已开通</li>\n<li>DISABLE : 未开通</li>\n</ul>",
7567
7574
  "example": "ENABLE",
7568
7575
  "member": "string",
7569
7576
  "name": "Status",
@@ -8187,53 +8194,53 @@
8187
8194
  "members": [
8188
8195
  {
8189
8196
  "disabled": false,
8190
- "document": "签署短链接。</br>\n注意:\n- 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。\n- 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。\n注意:此字段可能返回 null,表示取不到有效值。",
8197
+ "document": "签署短链接。\n注意:\n1. 该链接有效期为<b>30分钟</b>,同时需要注意保密,不要外泄给无关用户。\n2. 该链接不支持小程序嵌入,仅支持<b>移动端浏览器</b>打开。\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
8191
8198
  "example": "https://essurl.cn/M**XE",
8192
8199
  "member": "string",
8193
8200
  "name": "SignUrl",
8194
8201
  "output_required": true,
8195
8202
  "type": "string",
8196
- "value_allowed_null": true
8203
+ "value_allowed_null": false
8197
8204
  },
8198
8205
  {
8199
8206
  "disabled": false,
8200
- "document": "签署人类型。\n- **1**: 个人\n注意:此字段可能返回 null,表示取不到有效值。",
8207
+ "document": "签署人类型。\n- **1**: 个人",
8201
8208
  "example": "1",
8202
8209
  "member": "int64",
8203
8210
  "name": "ApproverType",
8204
8211
  "output_required": true,
8205
8212
  "type": "int",
8206
- "value_allowed_null": true
8213
+ "value_allowed_null": false
8207
8214
  },
8208
8215
  {
8209
8216
  "disabled": false,
8210
- "document": "签署人姓名。\n注意:此字段可能返回 null,表示取不到有效值。",
8217
+ "document": "签署人姓名。",
8211
8218
  "example": "典子谦",
8212
8219
  "member": "string",
8213
8220
  "name": "ApproverName",
8214
8221
  "output_required": true,
8215
8222
  "type": "string",
8216
- "value_allowed_null": true
8223
+ "value_allowed_null": false
8217
8224
  },
8218
8225
  {
8219
8226
  "disabled": false,
8220
- "document": "签署人手机号。\n注意:此字段可能返回 null,表示取不到有效值。",
8227
+ "document": "签署人手机号。",
8221
8228
  "example": "13200000000",
8222
8229
  "member": "string",
8223
8230
  "name": "ApproverMobile",
8224
8231
  "output_required": true,
8225
8232
  "type": "string",
8226
- "value_allowed_null": true
8233
+ "value_allowed_null": false
8227
8234
  },
8228
8235
  {
8229
8236
  "disabled": false,
8230
- "document": "签署长链接。</br>\n注意:\n- 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。\n- 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。\n注意:此字段可能返回 null,表示取不到有效值。",
8237
+ "document": "签署长链接。\n注意:\n1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。\n2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
8231
8238
  "example": "https://quick.qian.tencent.cn/home?ApproverIdCardNumber=MioqK**Kio2&ApproverMobile=MTkx**%3D&ApproverName=%25E**2A&ApproverType=1&Code=yDS**w3u2Mg8q&CodeType=QUICK&FlowId=yDSLVUU**MszDy&ShowHeader=1&shortKey=yDwq5U**GlG1c&token=M**XE",
8232
8239
  "member": "string",
8233
8240
  "name": "LongUrl",
8234
8241
  "output_required": true,
8235
8242
  "type": "string",
8236
- "value_allowed_null": true
8243
+ "value_allowed_null": false
8237
8244
  }
8238
8245
  ],
8239
8246
  "usage": "out"
@@ -9393,6 +9400,79 @@
9393
9400
  ],
9394
9401
  "type": "object"
9395
9402
  },
9403
+ "ModifyExtendedServiceRequest": {
9404
+ "document": "ModifyExtendedService请求参数结构体",
9405
+ "members": [
9406
+ {
9407
+ "disabled": false,
9408
+ "document": "执行本接口操作的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
9409
+ "example": "yDAVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
9410
+ "member": "UserInfo",
9411
+ "name": "Operator",
9412
+ "required": true,
9413
+ "type": "object"
9414
+ },
9415
+ {
9416
+ "disabled": false,
9417
+ "document": "要管理的拓展服务类型。\n<ul><li>OPEN_SERVER_SIGN:企业自动签署</li>\n<li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>\n<li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>\n<li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>\n<li>HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名</li>\n<li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>\n<li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>\n<li>HIDE_ONE_KEY_SIGN:个人签署方手动签字</li>\n<li>PAGING_SEAL:骑缝章</li>\n<li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li></ul>",
9418
+ "example": "MOBILE_CHECK_APPROVER",
9419
+ "member": "string",
9420
+ "name": "ServiceType",
9421
+ "required": true,
9422
+ "type": "string"
9423
+ },
9424
+ {
9425
+ "disabled": false,
9426
+ "document": "操作类型\n<ul>\n<li>OPEN : 开通</li>\n<li>CLOSE : 关闭</li>\n</ul>",
9427
+ "example": "OPEN",
9428
+ "member": "string",
9429
+ "name": "Operate",
9430
+ "required": true,
9431
+ "type": "string"
9432
+ },
9433
+ {
9434
+ "disabled": false,
9435
+ "document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
9436
+ "example": "无",
9437
+ "member": "Agent",
9438
+ "name": "Agent",
9439
+ "required": false,
9440
+ "type": "object"
9441
+ },
9442
+ {
9443
+ "disabled": false,
9444
+ "document": "链接跳转类型,支持以下类型\n<ul>\n<li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>\n<li>APP : 第三方APP或小程序跳转电子签小程序</li>\n</ul>",
9445
+ "example": "APP",
9446
+ "member": "string",
9447
+ "name": "Endpoint",
9448
+ "required": false,
9449
+ "type": "string"
9450
+ }
9451
+ ],
9452
+ "type": "object"
9453
+ },
9454
+ "ModifyExtendedServiceResponse": {
9455
+ "document": "ModifyExtendedService返回参数结构体",
9456
+ "members": [
9457
+ {
9458
+ "disabled": false,
9459
+ "document": "操作跳转链接,有效期24小时\n若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。\n\n当操作类型是 OPEN 且 扩展服务类型是 OPEN_SERVER_SIGN 或者 OVERSEA_SIGN 时返回操作链接,\n返回的链接当前操作人(超管或法人)点击链接完成服务开通操作。",
9460
+ "example": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=xxxxx&organizationId=xxxxx&channelType=xxxxx&expired_time=1673428532&login=1&verify=1",
9461
+ "member": "string",
9462
+ "name": "OperateUrl",
9463
+ "output_required": true,
9464
+ "type": "string",
9465
+ "value_allowed_null": false
9466
+ },
9467
+ {
9468
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
9469
+ "member": "string",
9470
+ "name": "RequestId",
9471
+ "type": "string"
9472
+ }
9473
+ ],
9474
+ "type": "object"
9475
+ },
9396
9476
  "ModifyIntegrationDepartmentRequest": {
9397
9477
  "document": "ModifyIntegrationDepartment请求参数结构体",
9398
9478
  "members": [
@@ -1272,6 +1272,26 @@
1272
1272
  "title": "新增应用回调配置"
1273
1273
  }
1274
1274
  ],
1275
+ "ModifyExtendedService": [
1276
+ {
1277
+ "document": "",
1278
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyExtendedService\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ClientIp\": \"8.8.8.8\",\n \"UserId\": \"yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl\"\n },\n \"ServiceType\": \"OPEN_SERVER_SIGN\",\n \"Operate\": \"CLOSE\",\n \"Endpoint\": \"WEIXINAPP\"\n}",
1279
+ "output": "{\n \"Response\": {\n \"OperateUrl\": \"\",\n \"RequestId\": \"s1703747615889528031\"\n }\n}",
1280
+ "title": "关闭自动签署"
1281
+ },
1282
+ {
1283
+ "document": "1.开通企业自动签署(ServiceType 设置为WEIXINAPP)\n2.设置Endpoint 为WEIXINAPP ,得到小程序链接,操作人可拿链接签署协议开通自动签署",
1284
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyExtendedService\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ClientIp\": \"8.8.8.8\",\n \"UserId\": \"yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl\"\n },\n \"ServiceType\": \"OPEN_SERVER_SIGN\",\n \"Operate\": \"OPEN\",\n \"Endpoint\": \"WEIXINAPP\"\n}",
1285
+ "output": "{\n \"Response\": {\n \"OperateUrl\": \"https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=yAABVUUckpt7e9gdUEcsWM19s3pglRL2&organizationId=yDxjOUUgydjf7zv3ACO4zjEC0AKihrfi&channelType=TENCENTCLOUD&expired_time=1703834015&login=1&verify=1\",\n \"RequestId\": \"s1703747615889528031\"\n }\n}",
1286
+ "title": "开通自动签署"
1287
+ },
1288
+ {
1289
+ "document": "",
1290
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyExtendedService\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ClientIp\": \"8.8.8.8\",\n \"UserId\": \"yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl\"\n },\n \"ServiceType\": \"OPEN_SERVER\",\n \"Operate\": \"CLOSE\",\n \"Endpoint\": \"WEIXINAPP\"\n}",
1291
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.ParamError\",\n \"Message\": \"非法的扩展服务类型OPEN_SERVER,请确认后重试\"\n },\n \"RequestId\": \"s1703747916297948958\"\n }\n}",
1292
+ "title": "管理不支持的扩展服务"
1293
+ }
1294
+ ],
1275
1295
  "ModifyIntegrationDepartment": [
1276
1296
  {
1277
1297
  "document": "更新部门ID对应部门的部门名称、客户系统部门ID和排序号。",
@@ -358,7 +358,7 @@
358
358
  "status": "online"
359
359
  },
360
360
  "CreateSignUrls": {
361
- "document": "创建跳转小程序查看或签署的链接\n\n**腾讯电子签小程序的AppID 和 原始Id如下:**\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |\n\n**主要使用场景可以更加EndPoint分类如下**\n\n|EndPoint| 场景| 说明和示例|\n| ---- | ---- | --- |\n| WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|\n| LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|\n| CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个\"前往小程序\"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |\n|APP| 贵方App跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html\" target=\"_blank\">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |\n|APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\" target=\"_blank\">全屏方式</a>和<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html \" target=\"_blank\">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |",
361
+ "document": "创建跳转小程序查看或签署的链接\n\n**腾讯电子签小程序的AppID 和 原始Id如下:**\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |\n\n**主要使用场景可以更加EndPoint分类如下**\n\n|EndPoint| 场景| 说明和示例|\n| ---- | ---- | --- |\n| WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|\n| LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|\n| CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个\"前往小程序\"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |\n|APP| <font color=\"red\">贵方APP</font>跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html\" target=\"_blank\">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |\n|APP| <font color=\"red\">贵方小程序</font>跳转腾讯电子签小程序签署场景| 贵方小程序直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\" target=\"_blank\">全屏方式</a>和<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html \" target=\"_blank\">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |",
362
362
  "input": "CreateSignUrlsRequest",
363
363
  "name": "获取跳转至腾讯电子签小程序的签署链接",
364
364
  "output": "CreateSignUrlsResponse",
@@ -407,7 +407,7 @@
407
407
  "status": "online"
408
408
  },
409
409
  "DescribeExtendedServiceAuthInfo": {
410
- "document": "查询企业扩展服务的开通和授权情况,当前支持查询以下内容:\n1. 企业自动签\n2. 企业与港澳台居民签署合同\n3. 使用手机号验证签署方身份\n4. 骑缝章\n5. 拓宽签署方年龄限制\n6. 下载企业合同/文件\n\n注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId",
410
+ "document": "查询企业扩展服务的开通和授权情况,当前支持查询以下内容:\n\n1. **企业自动签**\n2. **企业与港澳台居民签署合同**\n3. **使用手机号验证签署方身份**\n4. **骑缝章**\n5. **拓宽签署方年龄限制**\n6. **下载企业合同/文件**\n7. **隐藏合同经办人姓名**\n\n对应能力开通页面在子客控制台-企业中心-拓展服务,如下图所示:\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/931a1e02955ab36e5cc69a489af10352.jpg)\n\n注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)",
411
411
  "input": "DescribeExtendedServiceAuthInfoRequest",
412
412
  "name": "查询企业扩展服务授权信息",
413
413
  "output": "DescribeExtendedServiceAuthInfoResponse",
@@ -449,9 +449,9 @@
449
449
  "status": "online"
450
450
  },
451
451
  "ModifyExtendedService": {
452
- "document": "修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。\n\n跳转小程序的几种方式:主要是设置不同的EndPoint\n1. 通过链接Url直接跳转到小程序,不需要返回\n设置EndPoint为WEIXINAPP,得到链接打开即可。\n\n2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App\n跳转到小程序的实现,参考官方文档\nhttps://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html\n其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。\n设置EndPoint为APP,得到path。\n\n4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序\n跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)\n全屏方式:\n(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)\n半屏方式:\n(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)\n其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。\n设置EndPoint为APP,得到path。\n\n其中小程序的原始Id如下,或者查看小程序信息自助获取。\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
452
+ "document": "管理企业扩展服务 ,企业经办人需要是企业超管或者法人。\n\n跳转小程序的几种方式:主要是设置不同的EndPoint\n1. 通过链接Url直接跳转到小程序,不需要返回\n设置EndPoint为WEIXINAPP,得到链接打开即可。\n\n2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App\n跳转到小程序的实现,参考官方文档<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html\">打开 App</a>\n设置EndPoint为APP,得到path。\n\n3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序\n跳转到小程序的实现,参考官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>\n设置EndPoint为APP,得到path。\n\n4.其中小程序的原始Id如下,或者查看小程序信息自助获取。\n\n| 小程序 | AppID | 原始ID |\n| ------------ | ------------ | ------------ |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
453
453
  "input": "ModifyExtendedServiceRequest",
454
- "name": "修改企业扩展服务",
454
+ "name": "管理企业扩展服务",
455
455
  "output": "ModifyExtendedServiceResponse",
456
456
  "status": "online"
457
457
  },
@@ -1554,7 +1554,7 @@
1554
1554
  "members": [
1555
1555
  {
1556
1556
  "disabled": false,
1557
- "document": "批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时",
1557
+ "document": "批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时\n\n注:<font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
1558
1558
  "example": "https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?to=BATCH_REVOKE_FLOW&tokenId=y*Y&userId=y*G&expireOn=1699011136&login=1&verify=1",
1559
1559
  "member": "string",
1560
1560
  "name": "BatchCancelFlowUrl",
@@ -1792,7 +1792,7 @@
1792
1792
  "members": [
1793
1793
  {
1794
1794
  "disabled": false,
1795
- "document": "批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。\n\n注: `非小程序和APP集成使用`",
1795
+ "document": "批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。\n\n注: \n1. 非小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
1796
1796
  "example": "无",
1797
1797
  "member": "string",
1798
1798
  "name": "SignUrl",
@@ -1812,7 +1812,7 @@
1812
1812
  },
1813
1813
  {
1814
1814
  "disabled": false,
1815
- "document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径\n\n注: `小程序和APP集成使用`",
1815
+ "document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径\n\n注: \n1. 小程序和APP集成使用\n2. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
1816
1816
  "example": "无",
1817
1817
  "member": "string",
1818
1818
  "name": "MiniAppPath",
@@ -5883,7 +5883,7 @@
5883
5883
  },
5884
5884
  {
5885
5885
  "disabled": false,
5886
- "document": "生成链接的类型:\n<ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>\n<li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>**SHORT_URL**:H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>",
5886
+ "document": "生成链接的类型:\n<ul><li>**PC**:(默认)<font color=\"red\">web控制台</font>链接, 需要在PC浏览器中打开</li>\n<li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>**SHORT_URL**:<font color=\"red\">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>**APP**:<font color=\"red\">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>",
5887
5887
  "example": "PC",
5888
5888
  "member": "string",
5889
5889
  "name": "Endpoint",
@@ -5925,7 +5925,7 @@
5925
5925
  "members": [
5926
5926
  {
5927
5927
  "disabled": false,
5928
- "document": "跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表\n<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table>\n注: \n`1.链接仅单次有效,每次登录需要需要重新创建新的链接`\n`2.创建的链接应避免被转义,如:&被转义为\\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`\n",
5928
+ "document": "跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表\n<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table>\n\n注: \n1. <font color=\"red\">链接仅单次有效</font>,每次登录需要需要重新创建新的链接\n2. 创建的链接应避免被转义,如:&被转义为\\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)\n",
5929
5929
  "example": "无",
5930
5930
  "member": "string",
5931
5931
  "name": "ConsoleUrl",
@@ -7076,7 +7076,7 @@
7076
7076
  "members": [
7077
7077
  {
7078
7078
  "disabled": false,
7079
- "document": "关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>\n<li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>\n<li>第三方平台子客企业中的员工标识: Agent.AppId</li>\n</ul>",
7079
+ "document": "关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.AppId</li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>\n<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>\n</ul>\n第三方平台子客企业和员工必须已经经过实名认证",
7080
7080
  "example": "无",
7081
7081
  "member": "Agent",
7082
7082
  "name": "Agent",
@@ -7575,7 +7575,7 @@
7575
7575
  "members": [
7576
7576
  {
7577
7577
  "disabled": false,
7578
- "document": "扩展服务类型\n<ul>\n<li>AUTO_SIGN 企业自动签(自动签署)</li>\n<li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>\n<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>\n<li> PAGING_SEAL 骑缝章</li>\n<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>\n<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>\n</ul>",
7578
+ "document": "扩展服务类型\n<ul>\n<li>AUTO_SIGN 企业自动签(自动签署)</li>\n<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>\n<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>\n<li> PAGING_SEAL 骑缝章</li>\n<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>\n<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>\n<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>\n</ul>",
7579
7579
  "example": "AUTO_SIGN",
7580
7580
  "member": "string",
7581
7581
  "name": "Type",
@@ -8217,7 +8217,7 @@
8217
8217
  "members": [
8218
8218
  {
8219
8219
  "disabled": false,
8220
- "document": "签署短链接。</br>\n注意:\n- 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。\n- 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。",
8220
+ "document": "签署短链接。\n\n注意:\n1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。\n2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)",
8221
8221
  "example": "https://essurl.cn/M**XE",
8222
8222
  "member": "string",
8223
8223
  "name": "SignUrl",
@@ -8257,7 +8257,7 @@
8257
8257
  },
8258
8258
  {
8259
8259
  "disabled": false,
8260
- "document": "签署长链接。</br>\n注意:\n- 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。\n- 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。\n注意:此字段可能返回 null,表示取不到有效值。",
8260
+ "document": "签署长链接。\n\n注意:\n1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。\n2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。\n3. <font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)\n注意:此字段可能返回 null,表示取不到有效值。",
8261
8261
  "example": "https://quick.qian.tencent.cn/home?ApproverIdCardNumber=MioqK**Kio2&ApproverMobile=MTkx**%3D&ApproverName=%25E**2A&ApproverType=1&Code=yDS**w3u2Mg8q&CodeType=QUICK&FlowId=yDSLVUU**MszDy&ShowHeader=1&shortKey=yDwq5U**GlG1c&token=M**XE\"",
8262
8262
  "member": "string",
8263
8263
  "name": "LongUrl",
@@ -8877,7 +8877,7 @@
8877
8877
  },
8878
8878
  {
8879
8879
  "disabled": false,
8880
- "document": " 扩展服务类型\n<ul>\n<li>AUTO_SIGN 企业自动签(自动签署)</li>\n<li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>\n<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>\n<li> PAGING_SEAL 骑缝章</li>\n<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>\n<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>\n</ul>",
8880
+ "document": " 扩展服务类型\n<ul>\n<li>AUTO_SIGN 企业自动签(自动签署)</li>\n<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>\n<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>\n<li> PAGING_SEAL 骑缝章</li>\n<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>\n<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>\n<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>\n</ul>",
8881
8881
  "example": "AUTO_SIGN",
8882
8882
  "member": "string",
8883
8883
  "name": "ServiceType",
@@ -8886,7 +8886,7 @@
8886
8886
  },
8887
8887
  {
8888
8888
  "disabled": false,
8889
- "document": "操作类型 \nOPEN:开通 \nCLOSE:关闭",
8889
+ "document": "操作类型\n<ul>\n<li>OPEN : 开通</li>\n<li>CLOSE : 关闭</li>\n</ul>",
8890
8890
  "example": "OPEN",
8891
8891
  "member": "string",
8892
8892
  "name": "Operate",
@@ -8910,7 +8910,7 @@
8910
8910
  "members": [
8911
8911
  {
8912
8912
  "disabled": false,
8913
- "document": "操作跳转链接,有效期24小时\n若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。\n\n当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,\n返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。",
8913
+ "document": "操作跳转链接,有效期24小时\n若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。\n\n当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,\n返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作",
8914
8914
  "example": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=xxxxx&organizationId=xxxxx&channelType=xxxxx&expired_time=1673428532&login=1&verify=1",
8915
8915
  "member": "string",
8916
8916
  "name": "OperateUrl",
@@ -10343,7 +10343,7 @@
10343
10343
  "members": [
10344
10344
  {
10345
10345
  "disabled": false,
10346
- "document": "签署链接,过期时间为90天\n注意:此字段可能返回 null,表示取不到有效值。",
10346
+ "document": "签署链接,过期时间为90天\n\n注:<font color=\"red\">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)\n注意:此字段可能返回 null,表示取不到有效值。",
10347
10347
  "example": "https://essurl.cn/hJi85U8ewE",
10348
10348
  "member": "string",
10349
10349
  "name": "SignUrl",
@@ -10906,7 +10906,7 @@
10906
10906
  },
10907
10907
  {
10908
10908
  "disabled": false,
10909
- "document": "此模版中的签署控件列表",
10909
+ "document": "此模板中的签署控件列表",
10910
10910
  "example": "无",
10911
10911
  "member": "Component",
10912
10912
  "name": "SignComponents",
@@ -257,17 +257,17 @@
257
257
  "example": "1",
258
258
  "member": "int64",
259
259
  "name": "AppearIndex",
260
- "required": true,
260
+ "output_required": true,
261
261
  "type": "int",
262
262
  "value_allowed_null": false
263
263
  },
264
264
  {
265
265
  "disabled": false,
266
- "document": "AppearInfo中AppearIndex对应元素的第Index元素,从0开始技术",
266
+ "document": "AppearInfo中AppearIndex对应元素的第Index元素,从0开始计数",
267
267
  "example": "50",
268
268
  "member": "int64",
269
269
  "name": "Index",
270
- "required": true,
270
+ "output_required": true,
271
271
  "type": "int",
272
272
  "value_allowed_null": false
273
273
  }
@@ -1889,6 +1889,58 @@ def doDescribeSystemResources(args, parsed_globals):
1889
1889
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1890
1890
 
1891
1891
 
1892
+ def doGetMetaTable(args, parsed_globals):
1893
+ g_param = parse_global_arg(parsed_globals)
1894
+
1895
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
1896
+ cred = credential.CVMRoleCredential()
1897
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
1898
+ cred = credential.STSAssumeRoleCredential(
1899
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
1900
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')]
1901
+ )
1902
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
1903
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
1904
+ else:
1905
+ cred = credential.Credential(
1906
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
1907
+ )
1908
+ http_profile = HttpProfile(
1909
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
1910
+ reqMethod="POST",
1911
+ endpoint=g_param[OptionsDefine.Endpoint],
1912
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
1913
+ )
1914
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
1915
+ if g_param[OptionsDefine.Language]:
1916
+ profile.language = g_param[OptionsDefine.Language]
1917
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
1918
+ client = mod.OceanusClient(cred, g_param[OptionsDefine.Region], profile)
1919
+ client._sdkVersion += ("_CLI_" + __version__)
1920
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
1921
+ model = models.GetMetaTableRequest()
1922
+ model.from_json_string(json.dumps(args))
1923
+ start_time = time.time()
1924
+ while True:
1925
+ rsp = client.GetMetaTable(model)
1926
+ result = rsp.to_json_string()
1927
+ try:
1928
+ json_obj = json.loads(result)
1929
+ except TypeError as e:
1930
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
1931
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
1932
+ break
1933
+ cur_time = time.time()
1934
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
1935
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
1936
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
1937
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
1938
+ else:
1939
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
1940
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
1941
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1942
+
1943
+
1892
1944
  def doDescribeJobConfigs(args, parsed_globals):
1893
1945
  g_param = parse_global_arg(parsed_globals)
1894
1946
 
@@ -1988,6 +2040,7 @@ ACTION_MAP = {
1988
2040
  "ModifyJob": doModifyJob,
1989
2041
  "CreateResource": doCreateResource,
1990
2042
  "DescribeSystemResources": doDescribeSystemResources,
2043
+ "GetMetaTable": doGetMetaTable,
1991
2044
  "DescribeJobConfigs": doDescribeJobConfigs,
1992
2045
 
1993
2046
  }