tccli 3.0.908.1__py2.py3-none-any.whl → 3.0.910.1__py2.py3-none-any.whl

tccli/services/ess/v20201111/examples.json

@@ -120,18 +120,34 @@
         "title": "创建并返回出证报告"
       }
     ],
+    "CreateFlowGroupByFiles": [
+      {
+        "document": "合同组示例",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByFiles\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"****************\"\n    },\n    \"FlowGroupName\": \"合同组\",\n    \"FlowGroupInfos\": [\n        {\n            \"FileIds\": [\n                \"*************\"\n            ],\n            \"FlowName\": \"B2B手动签署合同\",\n            \"FlowType\": \"合同组\",\n            \"FlowDescription\": \"B2B手动签署合同\",\n            \"Deadline\": 0,\n            \"Approvers\": [\n                {\n                    \"ApproverType\": 0,\n                    \"OrganizationName\": \"企业公司名称\",\n                    \"ApproverName\": \"企业方签署人姓名\",\n                    \"ApproverMobile\": \"企业方签署人手机号\",\n                    \"SignComponents\": [\n                        {\n                            \"ComponentType\": \"SIGN_SEAL\",\n                            \"ComponentRequired\": true,\n                            \"FileIndex\": 0,\n                            \"ComponentHeight\": 100,\n                            \"ComponentWidth\": 100,\n                            \"ComponentPage\": 1,\n                            \"ComponentPosX\": 100,\n                            \"ComponentPosY\": 100,\n                            \"ComponentValue\": \"\"\n                        }\n                    ]\n                },\n                {\n                    \"ApproverType\": 0,\n                    \"OrganizationName\": \"企业公司名称\",\n                    \"ApproverName\": \"企业方签署人姓名\",\n                    \"ApproverMobile\": \"企业方签署人手机号\",\n                    \"SignComponents\": [\n                        {\n                            \"ComponentType\": \"SIGN_SEAL\",\n                            \"ComponentRequired\": true,\n                            \"FileIndex\": 0,\n                            \"ComponentHeight\": 100,\n                            \"ComponentWidth\": 100,\n                            \"ComponentPage\": 1,\n                            \"ComponentPosX\": 100,\n                            \"ComponentPosY\": 200\n                        }\n                    ],\n                    \"NotifyType\": \"SMS\"\n                }\n            ],\n            \"CallbackUrl\": \"\"\n        },\n        {\n            \"FileIds\": [\n                \"************\"\n            ],\n            \"FlowName\": \"公司自动签\",\n            \"FlowType\": \"合同组\",\n            \"FlowDescription\": \"公司自动签\",\n            \"Deadline\": 0,\n            \"Approvers\": [\n                {\n                    \"ApproverType\": 3,\n                    \"OrganizationName\": \"发起方公司名称\",\n                    \"ApproverName\": \"发起人姓名\",\n                    \"ApproverMobile\": \"发起人手机号\",\n                    \"SignComponents\": [\n                        {\n                            \"ComponentType\": \"SIGN_SEAL\",\n                            \"ComponentRequired\": true,\n                            \"FileIndex\": 0,\n                            \"ComponentHeight\": 100,\n                            \"ComponentWidth\": 100,\n                            \"ComponentPage\": 1,\n                            \"ComponentPosX\": 100,\n                            \"ComponentPosY\": 100,\n                            \"ComponentValue\": \"\"\n                        }\n                    ],\n                    \"NotifyType\": \"SMS\"\n                },\n                {\n                    \"ApproverType\": 0,\n                    \"OrganizationName\": \"企业公司名称\",\n                    \"ApproverName\": \"企业签署人姓名\",\n                    \"ApproverMobile\": \"企业签署人手机号\",\n                    \"SignComponents\": [\n                        {\n                            \"ComponentType\": \"SIGN_SEAL\",\n                            \"ComponentRequired\": true,\n                            \"FileIndex\": 0,\n                            \"ComponentHeight\": 100,\n                            \"ComponentWidth\": 100,\n                            \"ComponentPage\": 1,\n                            \"ComponentPosX\": 100,\n                            \"ComponentPosY\": 200\n                        }\n                    ],\n                    \"NotifyType\": \"SMS\"\n                }\n            ],\n            \"CallbackUrl\": \"\"\n        },\n        {\n            \"FileIds\": [\n                \"**************\"\n            ],\n            \"FlowName\": \"B2C发起\",\n            \"FlowType\": \"合同组\",\n            \"FlowDescription\": \"B2C发起\",\n            \"Deadline\": 0,\n            \"Approvers\": [\n                {\n                    \"ApproverType\": 0,\n                    \"OrganizationName\": \"企业签署方公司名称\",\n                    \"ApproverName\": \"企业签署方姓名\",\n                    \"ApproverMobile\": \"企业签署方手机号\",\n                    \"SignComponents\": [\n                        {\n                            \"ComponentType\": \"SIGN_SEAL\",\n                            \"ComponentRequired\": true,\n                            \"FileIndex\": 0,\n                            \"ComponentHeight\": 100,\n                            \"ComponentWidth\": 100,\n                            \"ComponentPage\": 1,\n                            \"ComponentPosX\": 100,\n                            \"ComponentPosY\": 100,\n                            \"ComponentValue\": \"\"\n                        }\n                    ],\n                    \"NotifyType\": \"SMS\"\n                },\n                {\n                    \"ApproverType\": 1,\n                    \"ApproverName\": \"个人签署方姓名\",\n                    \"ApproverMobile\": \"个人签署方手机号\",\n                    \"SignComponents\": [\n                        {\n                            \"ComponentType\": \"SIGN_SIGNATURE\",\n                            \"ComponentRequired\": true,\n                            \"FileIndex\": 0,\n                            \"ComponentHeight\": 100,\n                            \"ComponentWidth\": 100,\n                            \"ComponentPage\": 1,\n                            \"ComponentPosX\": 100,\n                            \"ComponentPosY\": 200\n                        }\n                    ],\n                    \"NotifyType\": \"SMS\"\n                }\n            ],\n            \"CallbackUrl\": \"\"\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"6ee9f545-96d8-4f3b-b382-917dc17089f4\"\n    }\n}",
+        "title": "合同组"
+      }
+    ],
+    "CreateFlowGroupByTemplates": [
+      {
+        "document": "合同组发起示例,此示例, 第一份子合同 为单个自动签\n第二份子合同为B2C自动签, 其中B端为自动签\n第三份子合同为B2B 经办签署",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowGroupByTemplates\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"*****************\"\n    },\n    \"FlowGroupName\": \"合同组自动签模板发起\",\n    \"FlowGroupInfos\": [\n        {\n            \"TemplateId\": \"**********\",\n            \"FlowName\": \"单B自动签\",\n            \"FlowType\": \"合同组\",\n            \"FlowDescription\": \"单B自动签\",\n            \"Approvers\": [\n                {\n                    \"ApproverType\": 3,\n                    \"OrganizationName\": \"发起方公司名称\",\n                    \"ApproverName\": \"本方发起人\",\n                    \"ApproverMobile\": \"本方发起人电话\"\n                }\n            ],\n            \"Unordered\": false\n        },\n        {\n            \"TemplateId\": \"yDwXJ************************ZMMtV\",\n            \"FlowName\": \"自动签B2C\",\n            \"FlowType\": \"合同组\",\n            \"FlowDescription\": \"自动签B2C\",\n            \"Approvers\": [\n                {\n                    \"ApproverType\": 0,\n                    \"OrganizationName\": \"发起方公司名称\",\n                    \"ApproverName\": \"本方发起人\",\n                    \"ApproverMobile\": \"本方发起人电话\"\n                },\n                {\n                    \"ApproverType\": 1,\n                    \"ApproverName\": \"个人签署人\",\n                    \"ApproverMobile\": \"个人签署人电话\"\n                }\n            ]\n        },\n        {\n            \"TemplateId\": \"yDw**********************nGBhHG\",\n            \"FlowName\": \"B2B手动签\",\n            \"FlowType\": \"合同组\",\n            \"FlowDescription\": \"B2B手动签\",\n            \"Approvers\": [\n                {\n                    \"ApproverType\": 0,\n                    \"OrganizationName\": \"经办人公司名称\",\n                    \"ApproverName\": \"经办人\",\n                    \"ApproverMobile\": \"经办人电话\"\n                },\n                {\n                    \"ApproverType\": 0,\n                    \"OrganizationName\": \"签署方公司\",\n                    \"ApproverName\": \"签署方经办人\",\n                    \"ApproverMobile\": \"签署方经办人电话\"\n                }\n            ]\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowGroupId\": \"********************\",\n        \"FlowIds\": [\n            \"*****************\",\n            \"*****************\",\n            \"*****************\"\n        ],\n        \"RequestId\": \"********\"\n    }\n}",
+        "title": "合同组示例"
+      }
+    ],
     "CreateFlowReminds": [
       {
         "document": "对合同中尚未完成的用户推送催办",
-        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowReminds\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"xxx\"\n    },\n    \"FlowIds\": [\n        \"xxx\"\n    ]\n}",
-        "output": "{\n    \"Response\": {\n        \"RemindFlowRecords\": [\n            {\n                \"CanRemind\": true,\n                \"FlowId\": \"xxx\",\n                \"RemindMessage\": \"签署人 xxx: 此签署人已催办过；\"\n            }\n        ],\n        \"RequestId\": \"s1675154686215203499\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowReminds\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDxMkUyxxxxxxxxxxxVI2JmKxPkk\"\n    },\n    \"FlowIds\": [\n        \"yDwXiUUcxxxxxxxxxxSZ0uIW72Qaxm\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RemindFlowRecords\": [\n            {\n                \"CanRemind\": true,\n                \"FlowId\": \"yDwxxxxxxxW72Qaxm\",\n                \"RemindMessage\": \"签署人 xxx: 此签署人已催办过；\"\n            }\n        ],\n        \"RequestId\": \"s1675154686215203499\"\n    }\n}",
         "title": "合同催办"
       }
     ],
     "CreateFlowSignReview": [
       {
         "document": "提交企业签署流程审批结果",
-        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowSignReview\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"1956103********520fde6a\"\n    },\n    \"FlowId\": \"xxxx\",\n    \"ReviewType\": \"PASS\",\n    \"ReviewMessage\": \"企业内部审核通过，允许签署\"\n}",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowSignReview\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDxMkUy************8VI2JmKxPkk\"\n    },\n    \"FlowId\": \"yDwXiUUc***********uIW72Qaxm\",\n    \"ReviewType\": \"PASS\",\n    \"ReviewMessage\": \"企业内部审核通过，允许签署\"\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"s1234345677xxxx\"\n    }\n}",
         "title": "提交企业签署流程审批结果"
       }

tccli/services/essbasic/essbasic_client.py

@@ -4595,6 +4595,58 @@ def doModifyUser(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doChannelCreateFlowGroupByTemplates(args, parsed_globals):
+    g_param = parse_global_arg(parsed_globals)
+
+    if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
+        cred = credential.CVMRoleCredential()
+    elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
+        cred = credential.STSAssumeRoleCredential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
+            g_param[OptionsDefine.RoleSessionName.replace('-', '_')]
+        )
+    elif os.getenv(OptionsDefine.ENV_TKE_REGION)             and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID)             and os.getenv(OptionsDefine.ENV_TKE_IDENTITY_TOKEN_FILE)             and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
+        cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
+    else:
+        cred = credential.Credential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
+        )
+    http_profile = HttpProfile(
+        reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
+        reqMethod="POST",
+        endpoint=g_param[OptionsDefine.Endpoint],
+        proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
+    )
+    profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
+    if g_param[OptionsDefine.Language]:
+        profile.language = g_param[OptionsDefine.Language]
+    mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
+    client = mod.EssbasicClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.ChannelCreateFlowGroupByTemplatesRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.ChannelCreateFlowGroupByTemplates(model)
+        result = rsp.to_json_string()
+        try:
+            json_obj = json.loads(result)
+        except TypeError as e:
+            json_obj = json.loads(result.decode('utf-8'))  # python3.3
+        if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
+            break
+        cur_time = time.time()
+        if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
+            raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
+            (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
+            search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
+        else:
+            print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
+        time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
+    FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
+
+
 def doCheckBankCardVerification(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -5112,6 +5164,7 @@ ACTION_MAP = {
     "ChannelCreateUserRoles": doChannelCreateUserRoles,
     "RejectFlow": doRejectFlow,
     "ModifyUser": doModifyUser,
+    "ChannelCreateFlowGroupByTemplates": doChannelCreateFlowGroupByTemplates,
     "CheckBankCardVerification": doCheckBankCardVerification,
     "DescribeChannelFlowEvidenceReport": doDescribeChannelFlowEvidenceReport,
     "OperateChannelTemplate": doOperateChannelTemplate,

tccli/services/essbasic/v20210526/api.json

@@ -63,6 +63,13 @@
       "output": "ChannelCreateFlowGroupByFilesResponse",
       "status": "online"
     },
+    "ChannelCreateFlowGroupByTemplates": {
+      "document": "接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。",
+      "input": "ChannelCreateFlowGroupByTemplatesRequest",
+      "name": "通过多模板创建合同组签署流程",
+      "output": "ChannelCreateFlowGroupByTemplatesResponse",
+      "status": "online"
+    },
     "ChannelCreateFlowReminds": {
       "document": "指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息\n注意:\n该接口不可直接调用，请联系客户经理申请使用\n仅能催办当前状态为“待签署”的签署人，且只能催办一次",
       "input": "ChannelCreateFlowRemindsRequest",
@@ -155,9 +162,9 @@
       "status": "online"
     },
     "ChannelDescribeRoles": {
-      "document": "查询用户角色",
+      "document": "查询角色列表，支持根据类型和状态过滤角色列表",
       "input": "ChannelDescribeRolesRequest",
-      "name": "查询用户角色",
+      "name": "查询角色列表",
       "output": "ChannelDescribeRolesResponse",
       "status": "online"
     },
@@ -1292,7 +1299,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "每个子合同的发起所需的信息，数量限制2-100",
+          "document": "每个子合同的发起所需的信息，数量限制2-50",
           "example": "无",
           "member": "FlowFileInfo",
           "name": "FlowFileInfos",
@@ -1370,6 +1377,81 @@
       ],
       "type": "object"
     },
+    "ChannelCreateFlowGroupByTemplatesRequest": {
+      "document": "ChannelCreateFlowGroupByTemplates请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。",
+          "example": "无",
+          "member": "Agent",
+          "name": "Agent",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "每个子合同的发起所需的信息，数量限制2-50（合同组暂不支持抄送功能）",
+          "example": "无",
+          "member": "FlowInfo",
+          "name": "FlowInfos",
+          "required": true,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "合同组名称，长度不超过200个字符",
+          "example": "\"xxx\"",
+          "member": "string",
+          "name": "FlowGroupName",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "ChannelCreateFlowGroupByTemplatesResponse": {
+      "document": "ChannelCreateFlowGroupByTemplates返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "合同组ID",
+          "example": "xxx",
+          "member": "string",
+          "name": "FlowGroupId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "子合同ID列表",
+          "example": "[\"xx\",\"yy\"]",
+          "member": "string",
+          "name": "FlowIds",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；\n如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；",
+          "example": "无",
+          "member": "TaskInfo",
+          "name": "TaskInfos",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "ChannelCreateFlowRemindsRequest": {
       "document": "ChannelCreateFlowReminds请求参数结构体",
       "members": [
@@ -4860,6 +4942,15 @@
           "name": "SignId",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "SMS: 短信; NONE: 不发信息\n默认为SMS(该字段对子客无效)",
+          "example": "SMS",
+          "member": "string",
+          "name": "NotifyType",
+          "required": false,
+          "type": "string"
         }
       ],
       "usage": "in"
@@ -5120,6 +5211,15 @@
           "required": false,
           "type": "bool"
         },
+        {
+          "disabled": false,
+          "document": "签署文件中的发起方的填写控件，需要在发起的时候进行填充",
+          "example": "无",
+          "member": "Component",
+          "name": "Components",
+          "required": false,
+          "type": "list"
+        },
         {
           "disabled": false,
           "document": "合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始",
@@ -6869,6 +6969,7 @@
           "example": "1",
           "member": "int64",
           "name": "Status",
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -6878,6 +6979,7 @@
           "example": "无",
           "member": "SyncFailReason",
           "name": "FailedList",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },

tccli/services/essbasic/v20210526/examples.json

@@ -72,6 +72,14 @@
         "title": "通过多文件创建合同组签署流程"
       }
     ],
+    "ChannelCreateFlowGroupByTemplates": [
+      {
+        "document": "通过多模板创建合同组签署流程",
+        "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByTemplates\n<公共请求参数>\n\n{\n    \"Agent\": {\n        \"ProxyOrganizationOpenId\": \"test\",\n        \"ProxyOperator\": {\n            \"OpenId\": \"test\"\n        },\n        \"AppId\": \"test\"\n    },\n    \"FlowGroupName\": \"testx\",\n    \"FlowInfos\": [\n        {\n            \"FlowName\": \"testx\",\n            \"TemplateId\": \"testx\",\n            \"FlowDescription\": \"testx\",\n            \"Deadline\": 1604910797,\n            \"CallbackUrl\": \"testx\",\n            \"FormFields\": [\n                {\n                    \"ComponentName\": \"testx\",\n                    \"ComponentValue\": \"testx\"\n                }\n            ],\n            \"FlowApprovers\": [\n                {\n                    \"ApproverType\": \"PERSON\",\n                    \"Name\": \"testx\",\n                    \"Mobile\": \"testx\",\n                    \"RecipientId\": \"testx\"\n                },\n                {\n                    \"ApproverType\": \"ORGANIZATION\",\n                    \"OpenId\": \"testx\",\n                    \"OrganizationOpenId\": \"testx\",\n                    \"OrganizationName\": \"testx\",\n                    \"RecipientId\": \"testx\"\n                }\n            ]\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowGroupId\": \"test\",\n        \"FlowIds\": [\n            \"test\"\n        ],\n        \"TaskInfos\": [\n            {\n                \"TaskId\": \"test\",\n                \"TaskStatus\": \"test\"\n            }\n        ],\n        \"RequestId\": \"test\"\n    }\n}",
+        "title": "通过多模板创建合同组签署流程"
+      }
+    ],
     "ChannelCreateFlowReminds": [
       {
         "document": "对合同中尚未完成的用户推送催办",

tccli/services/lcic/v20220817/api.json

@@ -185,7 +185,7 @@
     "DescribeDocuments": {
       "document": "有新接口替换\n\n批量获取文档信息（已废弃，替代接口BatchDescribeDocument）",
       "input": "DescribeDocumentsRequest",
-      "name": "批量获取文档信息",
+      "name": "批量获取文档信息【已废弃】",
       "output": "DescribeDocumentsResponse",
       "status": "deprecated"
     },
@@ -2033,7 +2033,6 @@
       "document": "DescribeDocument请求参数结构体",
       "members": [
         {
-          "default": "",
           "disabled": false,
           "document": "文档Id（唯一id）",
           "example": "abc",
@@ -2054,7 +2053,7 @@
           "example": "abc",
           "member": "string",
           "name": "DocumentId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2064,7 +2063,7 @@
           "example": "abc",
           "member": "string",
           "name": "DocumentUrl",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2074,7 +2073,7 @@
           "example": "abc",
           "member": "string",
           "name": "DocumentName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2084,7 +2083,7 @@
           "example": "abc",
           "member": "string",
           "name": "Owner",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2094,7 +2093,7 @@
           "example": "123",
           "member": "uint64",
           "name": "SdkAppId",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -2104,7 +2103,7 @@
           "example": "1",
           "member": "uint64",
           "name": "Permission",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -2114,7 +2113,7 @@
           "example": "xx",
           "member": "string",
           "name": "TranscodeResult",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2124,7 +2123,7 @@
           "example": "1",
           "member": "uint64",
           "name": "TranscodeType",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -2134,7 +2133,7 @@
           "example": "1",
           "member": "uint64",
           "name": "TranscodeProgress",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -2144,7 +2143,7 @@
           "example": "1",
           "member": "uint64",
           "name": "TranscodeState",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -2154,7 +2153,7 @@
           "example": "abc",
           "member": "string",
           "name": "TranscodeInfo",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2164,7 +2163,7 @@
           "example": "abc",
           "member": "string",
           "name": "DocumentType",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2174,7 +2173,7 @@
           "example": "1",
           "member": "uint64",
           "name": "DocumentSize",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -2184,7 +2183,17 @@
           "example": "1",
           "member": "uint64",
           "name": "UpdateTime",
-          "required": true,
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "课件页数",
+          "example": "1",
+          "member": "uint64",
+          "name": "Pages",
+          "output_required": false,
           "type": "int",
           "value_allowed_null": false
         },
@@ -2365,6 +2374,7 @@
           "example": "无",
           "member": "int64",
           "name": "Total",
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -2374,6 +2384,7 @@
           "example": "无",
           "member": "DocumentInfo",
           "name": "Documents",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },

tccli/services/lcic/v20220817/examples.json

@@ -202,10 +202,16 @@
     ],
     "DescribeDocument": [
       {
-        "document": "",
-        "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDocument\n<公共请求参数>\n\n{\n    \"DocumentId\": \"xx\"\n}",
-        "output": "{\n    \"Response\": {\n        \"UpdateTime\": 1,\n        \"DocumentUrl\": \"xx\",\n        \"TranscodeState\": 1,\n        \"Permission\": 1,\n        \"TranscodeType\": 1,\n        \"DocumentName\": \"xx\",\n        \"TranscodeInfo\": \"xx\",\n        \"DocumentSize\": 1,\n        \"TranscodeResult\": \"xx\",\n        \"SdkAppId\": 1,\n        \"DocumentType\": \"xx\",\n        \"Owner\": \"xx\",\n        \"TranscodeProgress\": 1,\n        \"DocumentId\": \"xx\",\n        \"RequestId\": \"xx\"\n    }\n}",
-        "title": "获取文档信息"
+        "document": "pdf 示例",
+        "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDocument\n<公共请求参数>\n\n{\n    \"DocumentId\": \"omxxxsdc\"\n}",
+        "output": "{\n    \"Response\": {\n        \"DocumentId\": \"omxxxsdc\",\n        \"DocumentName\": \"滴滴电子发票 (1).pdf\",\n        \"DocumentSize\": 38673,\n        \"DocumentType\": \"pdf\",\n        \"DocumentUrl\": \"https://tcic-source.qcloudclass.com/uploads/5390248a-5eb7-4fe8-be27-c43dbad1380f/3520371/1679021408_KzpMGD38.pdf\",\n        \"Owner\": \"2N1zP0mW7E3Vr3xJ2ZQ9GeFDK4t\",\n        \"Pages\": 1,\n        \"Permission\": 0,\n        \"RequestId\": \"ee3fdca0-c88c-43f1-81b4-4f51f9e50521\",\n        \"SdkAppId\": 3520371,\n        \"TranscodeInfo\": \"\",\n        \"TranscodeProgress\": 100,\n        \"TranscodeResult\": \"https://tcic-test-1257307760.qcloudclass.com/doc/01aq2v7djsh31noat9gc_tiw/picture/\",\n        \"TranscodeState\": 3,\n        \"TranscodeType\": 1,\n        \"UpdateTime\": 1679021410\n    }\n}",
+        "title": "测试示例"
+      },
+      {
+        "document": "示例",
+        "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDocument\n<公共请求参数>\n\n{\n    \"DocumentId\": \"ntxsfrzk\"\n}",
+        "output": "{\n    \"Response\": {\n        \"DocumentId\": \"ntxsfrzk\",\n        \"DocumentName\": \"test.pptx\",\n        \"DocumentSize\": 15814364,\n        \"DocumentType\": \"pptx\",\n        \"DocumentUrl\": \"https://tcic-source.qcloudclass.com/uploads/5390248a-5eb7-4fe8-be27-c43dbad1380f/3520371/1677202414_85bt9f0X.pptx\",\n        \"Owner\": \"2M04q0j5mhsbq1lAEbCW1dhRvA2\",\n        \"Pages\": 0,\n        \"Permission\": 0,\n        \"RequestId\": \"d97f98d7-de89-455a-a1f3-b9dae84d84bb\",\n        \"SdkAppId\": 3520371,\n        \"TranscodeInfo\": \"Microsoft Macintosh PowerPoint\",\n        \"TranscodeProgress\": 100,\n        \"TranscodeResult\": \"https://tcic-test-1257307760.qcloudclass.com/doc/gsutgbm7ssh31ns71sfc_tiw/h5/index.html\",\n        \"TranscodeState\": 3,\n        \"TranscodeType\": 1,\n        \"UpdateTime\": 1677202419\n    }\n}",
+        "title": "获取文档详情"
       }
     ],
     "DescribeDocuments": [

tccli/services/live/v20180801/api.json

@@ -2899,7 +2899,7 @@
         },
         {
           "disabled": false,
-          "document": "完整目标 URL 地址。\n用法注意：如果使用该参数来传完整目标地址，则 DomainName, AppName, StreamName 需要传入空字符串，任务将会使用该 ToUrl 参数指定的目标地址。\n\n注意：签名时间需要超过任务结束时间，避免因签名过期造成任务失败。",
+          "document": "完整目标 URL 地址。\n用法注意：如果使用该参数来传完整目标地址，则 DomainName, AppName, StreamName 需要传入空字符串，任务将会使用该 ToUrl 参数指定的目标地址。\n\n使用该方式传入目标地址支持的协议有：\nrtmp、rtmps、rtsp、rtp、srt。\n\n注意：签名时间需要超过任务结束时间，避免因签名过期造成任务失败。",
           "example": "无",
           "member": "string",
           "name": "ToUrl",
@@ -2963,6 +2963,7 @@
           "example": "无",
           "member": "string",
           "name": "TaskId",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -5123,9 +5124,8 @@
       "document": "DeleteLiveTranscodeTemplate请求参数结构体",
       "members": [
         {
-          "default": "",
           "disabled": false,
-          "document": "模板 ID。\n1. 在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。\n2. 可以从接口 [DescribeLiveTranscodeTemplates](/document/product/267/32641) 查询已经创建的过的模板列表。",
+          "document": "模板 ID。\n1. 在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。\n2. 可以从接口 [DescribeLiveTranscodeTemplates](/document/product/267/32641) 查询已经创建过的模板列表。",
           "example": "1000",
           "member": "int64",
           "name": "TemplateId",

tccli/services/live/v20180801/examples.json

@@ -346,7 +346,7 @@
     ],
     "DeleteLiveTranscodeTemplate": [
       {
-        "document": "",
+        "document": "请求示例。",
         "input": "https://live.tencentcloudapi.com/?Action=DeleteLiveTranscodeTemplate\n&TemplateId=1000\n&<公共请求参数>",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n    }\n}",
         "title": "请求示例"