tccli 3.0.966.1__py2.py3-none-any.whl → 3.0.968.1__py2.py3-none-any.whl

tccli/services/essbasic/v20210526/api.json

@@ -351,7 +351,7 @@
       "status": "online"
     },
     "ModifyExtendedService": {
-      "document": "修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人",
+      "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 |",
       "input": "ModifyExtendedServiceRequest",
       "name": "修改企业扩展服务",
       "output": "ModifyExtendedServiceResponse",
@@ -475,6 +475,42 @@
       ],
       "usage": "in"
     },
+    "ApproverItem": {
+      "document": "签署方信息，发起合同后可获取到对应的签署方信息，如角色ID，角色名称",
+      "members": [
+        {
+          "disabled": false,
+          "document": "签署方唯一编号\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "SignId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "签署方角色编号\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "RecipientId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "签署方角色名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "ApproverRoleName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "ApproverOption": {
       "document": "签署人个性化能力信息",
       "members": [
@@ -486,6 +522,15 @@
           "name": "HideOneKeySign",
           "required": false,
           "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "签署人信息补充类型，默认无需补充。\n\n<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）</li>\n</ul>",
+          "example": "无",
+          "member": "int64",
+          "name": "FillType",
+          "required": false,
+          "type": "int"
         }
       ],
       "usage": "in"
@@ -1645,6 +1690,16 @@
           "type": "string",
           "value_allowed_null": true
         },
+        {
+          "disabled": false,
+          "document": "签署方信息，如角色ID、角色名称等\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "ApproverItem",
+          "name": "Approvers",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
         {
           "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
           "member": "string",
@@ -4868,6 +4923,16 @@
           "type": "list",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "签署方信息，如角色ID、角色名称等",
+          "example": "无",
+          "member": "FlowApproverItem",
+          "name": "FlowApprovers",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
         {
           "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
           "member": "string",
@@ -5124,6 +5189,15 @@
           "name": "Hides",
           "required": false,
           "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致",
+          "example": "无",
+          "member": "string",
+          "name": "RecipientIds",
+          "required": false,
+          "type": "list"
         }
       ],
       "type": "object"
@@ -6017,12 +6091,22 @@
           "output_required": true,
           "type": "string",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "自定义签署人角色\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "ApproverRoleName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"
     },
     "FlowApproverInfo": {
-      "document": "创建签署流程签署人入参。\n\n其中签署方FlowApproverInfo需要传递的参数\n非单C、单B、B2C合同，ApproverType、RecipientId（模板发起合同时）必传，建议都传。其他身份标识\n1-个人：Name、Mobile必传\n2-第三方平台子客企业指定经办人：OpenId必传，OrgName必传、OrgOpenId必传；\n3-第三方平台子客企业不指定经办人：OrgName必传、OrgOpenId必传；\n4-非第三方平台子客企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。\n\nRecipientId参数：\n从DescribeTemplates接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId。",
+      "document": "创建签署流程签署人入参。\n\n其中签署方FlowApproverInfo需要传递的参数\n非单C、单B、B2C合同，ApproverType、RecipientId（模板发起合同时）必传，建议都传。\n\n其他身份标识\n\n<ul><li>1-个人：Name、Mobile必传</li>\n<li>2-第三方平台子客企业指定经办人：OpenId必传，OrgName必传、OrgOpenId必传；</li>\n<li>3-第三方平台子客企业不指定经办人：OrgName必传、OrgOpenId必传；</li>\n<li>4-非第三方平台子客企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。</li></ul>\n\nRecipientId参数：\n从DescribeTemplates接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId。",
       "members": [
         {
           "disabled": false,
@@ -6230,10 +6314,45 @@
           "name": "AddSignComponentsLimits",
           "required": false,
           "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "自定义签署方角色名称",
+          "example": "无",
+          "member": "string",
+          "name": "ApproverRoleName",
+          "required": false,
+          "type": "string"
         }
       ],
       "usage": "in"
     },
+    "FlowApproverItem": {
+      "document": "签署方信息，如角色ID、角色名称等",
+      "members": [
+        {
+          "disabled": false,
+          "document": "合同编号\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "FlowId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "签署方信息，如角色ID、角色名称等\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "ApproverItem",
+          "name": "Approvers",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "FlowApproverUrlInfo": {
       "document": "签署人签署链接信息",
       "members": [
@@ -6850,6 +6969,15 @@
           "name": "Operate",
           "required": true,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "链接跳转类型，支持以下类型\n<ul><li>WEIXINAPP : 短链直接跳转到电子签小程序  (默认值)</li>\n<li>APP : 第三方APP或小程序跳转电子签小程序</li></ul>",
+          "example": "APP",
+          "member": "string",
+          "name": "Endpoint",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -8230,6 +8358,16 @@
           "output_required": true,
           "type": "string",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "二维码，在生成动态签署人跳转封面页链接时返回\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "SignQrcodeUrl",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"

tccli/services/lcic/v20220817/api.json

@@ -232,9 +232,9 @@
       "status": "online"
     },
     "DescribeRoom": {
-      "document": "获取房间信息",
+      "document": "获取房间配置信息",
       "input": "DescribeRoomRequest",
-      "name": "获取房间信息",
+      "name": "获取房间配置信息",
       "output": "DescribeRoomResponse",
       "status": "online"
     },
@@ -1380,8 +1380,8 @@
         },
         {
           "disabled": false,
-          "document": "最大连麦人数（不包括老师）。取值范围[0, 16]",
-          "example": "1",
+          "document": "设置房间/课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。取值范围[0,16]，当取值为0时表示当前课堂/直播，不支持连麦互动。",
+          "example": "0",
           "member": "uint64",
           "name": "MaxMicNumber",
           "required": true,
@@ -2973,7 +2973,7 @@
         },
         {
           "disabled": false,
-          "document": "开启课后评分。 0：不开启(默认)  1：开启",
+          "document": "该房间是否开启了课后评分功能。0：未开启  1：开启",
           "example": "0",
           "member": "int64",
           "name": "IsGradingRequiredPostClass",
@@ -4697,7 +4697,7 @@
         },
         {
           "disabled": false,
-          "document": "最大连麦人数（不包括老师）。取值范围[0, 17)\n直播开始后不允许修改。",
+          "document": "设置房间/课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。\n取值范围[0,16]，当取值为0时表示当前课堂/直播，不支持连麦互动。",
           "example": "1",
           "member": "uint64",
           "name": "MaxMicNumber",
@@ -4796,7 +4796,7 @@
         },
         {
           "disabled": false,
-          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展)",
+          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 （预留参数、暂未开放)",
           "example": "0",
           "member": "uint64",
           "name": "RoomType",

tccli/services/lighthouse/v20200324/api.json

@@ -3864,8 +3864,8 @@
       "members": [
         {
           "disabled": false,
-          "document": "资源名列表，可取值:\n- GENERAL_BUNDLE_INSTANCE 通用型套餐实例\n- STORAGE_BUNDLE_INSTANCE 存储型套餐实例 \n- ENTERPRISE_BUNDLE_INSTANCE 企业型套餐实例 \n- EXCLUSIVE_BUNDLE_INSTANCE 专属型套餐实例\n- BEFAST_BUNDLE_INSTANCE 蜂驰型套餐实例\n- USER_KEY_PAIR 密钥对\n- SNAPSHOT 快照\n- BLUEPRINT 自定义镜像\n- FREE_BLUEPRINT 免费自定义镜像\n- DATA_DISK 数据盘\n- FIREWALL_RULE 防火墙规则",
-          "example": "[\"GENERAL_BUNDLE_INSTANCE\\n\"]",
+          "document": "资源名列表，可取值:\n- GENERAL_BUNDLE_INSTANCE 通用型套餐实例\n- STORAGE_BUNDLE_INSTANCE 存储型套餐实例 \n- ENTERPRISE_BUNDLE_INSTANCE 企业型套餐实例 \n- EXCLUSIVE_BUNDLE_INSTANCE 专属型套餐实例\n- BEFAST_BUNDLE_INSTANCE 蜂驰型套餐实例\n- STARTER_BUNDLE_INSTANCE 入门型套餐实例\n- HK_EXCLUSIVE_BUNDLE_INSTANCE 香港专属型套餐实例\n- CAREFREE_BUNDLE_INSTANCE 无忧型套餐实例\n- USER_KEY_PAIR 密钥对\n- SNAPSHOT 快照\n- BLUEPRINT 自定义镜像\n- FREE_BLUEPRINT 免费自定义镜像\n- DATA_DISK 数据盘\n- FIREWALL_RULE 防火墙规则",
+          "example": "[\"GENERAL_BUNDLE_INSTANCE\"]",
           "member": "string",
           "name": "ResourceNames",
           "required": true,
@@ -3883,7 +3883,7 @@
           "example": "无",
           "member": "GeneralResourceQuota",
           "name": "GeneralResourceQuotaSet",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },

tccli/services/mps/v20190612/api.json

@@ -2992,6 +2992,7 @@
           "example": "10",
           "member": "uint64",
           "name": "Definition",
+          "output_required": true,
           "required": true,
           "type": "int",
           "value_allowed_null": false
@@ -20530,7 +20531,7 @@
         },
         {
           "disabled": false,
-          "document": "事件通知安全签名 Sign = MD5（NotifyKey + Timestamp）。说明：媒体处理把 TaskNotifyConfig 里面的NotifyKey 和 Timestamp 进行字符串拼接后通过 MD5 计算得出 Sign 值，并将其放在通知消息里，您的后台服务器在收到通知消息后可以根据同样的算法确认 Sign 是否正确，进而确认消息是否确实来自媒体处理后台。",
+          "document": "事件通知安全签名 Sign = MD5（Timestamp + NotifyKey）。说明：媒体处理把Timestamp 和 TaskNotifyConfig 里面的NotifyKey 进行字符串拼接后通过 MD5 计算得出 Sign 值，并将其放在通知消息里，您的后台服务器在收到通知消息后可以根据同样的算法确认 Sign 是否正确，进而确认消息是否确实来自媒体处理后台。",
           "example": "无",
           "member": "string",
           "name": "Sign",

tccli/services/ocr/v20181119/api.json

@@ -463,7 +463,7 @@
       "status": "online"
     },
     "SmartStructuralOCRV2": {
-      "document": "本接口支持智能提取各类证照、票据、表单、合同等结构化场景的key:value字段信息，并支持提取表格信息的key:value组的结构化，灵活高效，适用于各类非标准材料的信息录入场景，点击[立即体验](https://cloud.tencent.com/product/smart-ocr)。\n\n默认接口请求频率限制：10次/秒。",
+      "document": "本接口支持智能提取各类证照、票据、表单、合同等结构化场景的key:value字段信息，并支持提取表格信息的key:value组的结构化，灵活高效，适用于各类非标准材料的信息录入场景，点击[立即体验](https://cloud.tencent.com/product/smart-ocr)。\n\n默认接口请求频率限制：5次/秒。",
       "input": "SmartStructuralOCRV2Request",
       "name": "智能结构化识别V2",
       "output": "SmartStructuralOCRV2Response",