tccli 3.0.1327.1__py2.py3-none-any.whl → 3.0.1328.1__py2.py3-none-any.whl

tccli/services/ess/v20201111/api.json

@@ -77,6 +77,13 @@
       "output": "CreateBatchSignUrlResponse",
       "status": "online"
     },
+    "CreateContractDiffTaskWebUrl": {
+      "document": "接口（CreateContractDiffTaskWebUrl）用于创建合同对比的可嵌入web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。\n注：本接口生成的web页面暂不支持<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreateWebThemeConfig\" target=\"_blank\">设置本企业嵌入式页面主题配置</a>\n\n未跳过上传确认的嵌入页面长相如下：\n![image](https://qcloudimg.tencent-cloud.cn/raw/32f3526ad7152757202a7e4e760356db.jpg)\n跳过上传确认的嵌入页面长相如下：\n![image](https://qcloudimg.tencent-cloud.cn/raw/c68047feddbc106e261870687b6ab89d.jpg)",
+      "input": "CreateContractDiffTaskWebUrlRequest",
+      "name": "创建合同对比web页面",
+      "output": "CreateContractDiffTaskWebUrlResponse",
+      "status": "online"
+    },
     "CreateConvertTaskApi": {
       "document": "此接口（CreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />\n前提条件：源文件已经通过 <a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />\n适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同\n适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />\n转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi\" target=\"_blank\">查询转换任务状态</a>接口获取任务状态。<br />\n注: \n1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`\n2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`",
       "input": "CreateConvertTaskApiRequest",
@@ -476,6 +483,13 @@
       "output": "DescribeCancelFlowsTaskResponse",
       "status": "online"
     },
+    "DescribeContractDiffTaskWebUrl": {
+      "document": "接口（DescribeContractDiffTaskWebUrl）用于获取合同对比结果可嵌入的web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。\n注：本接口生成的web页面暂不支持<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreateWebThemeConfig\" target=\"_blank\">设置本企业嵌入式页面主题配置</a>\n\n嵌入页面长相如下：\n![image](https://qcloudimg.tencent-cloud.cn/raw/c68047feddbc106e261870687b6ab89d.jpg)",
+      "input": "DescribeContractDiffTaskWebUrlRequest",
+      "name": "获取合同对比结果web页面",
+      "output": "DescribeContractDiffTaskWebUrlResponse",
+      "status": "online"
+    },
     "DescribeExtendedServiceAuthDetail": {
       "document": "查询企业扩展服务的授权详情（列表），当前支持查询以下内容：\n1. 企业自动签（本企业授权、集团企业授权、合作企业授权）\n2. 批量签署能力\n\n\n注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)",
       "input": "DescribeExtendedServiceAuthDetailRequest",
@@ -3039,6 +3053,80 @@
       ],
       "type": "object"
     },
+    "CreateContractDiffTaskWebUrlRequest": {
+      "document": "CreateContractDiffTaskWebUrl请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "执行本接口操作的员工信息。使用此接口时，必须填写userId。\n\n注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
+          "example": "无",
+          "member": "UserInfo",
+          "name": "Operator",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "是否跳过文件上传确认页。\n当该参数值为`false`时，`OriginalFileResourceId`和`DiffFileResourceId`参数不需要传值，需要在生成的web页面中上传对比文件；\n当该参数值为`true`时，`OriginalFileResourceId`和`DiffFileResourceId`参数必填，生成的web页面将跳过上传页面显示对比结果。",
+          "example": "false",
+          "member": "bool",
+          "name": "SkipFileUpload",
+          "required": true,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "需要对比的原合同文件资源ID，通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。",
+          "example": "yDttXUUckpx90i17UxPpcHHE1VDpNJPW",
+          "member": "string",
+          "name": "OriginalFileResourceId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "需要对比的新合同文件资源ID，通过<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。",
+          "example": "yDttXUUckpx90i1xUxPpcHHyPdyqVErm",
+          "member": "string",
+          "name": "DiffFileResourceId",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "CreateContractDiffTaskWebUrlResponse": {
+      "document": "CreateContractDiffTaskWebUrl返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "接口返回的合同对比任务ID，可以调用接口<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/DescribeContractDiffTaskWebUrl\" target=\"_blank\">获取合同对比结果web页面</a>查看对比任务的结果。\n当`SkipFileUpload`参数为`true`时才会返回值，否则为空。",
+          "example": "yDt31UUckpx91cypUyoAic6wP2oyarMN",
+          "member": "string",
+          "name": "TaskId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "合同对比嵌入式web页面链接，有效期：5分钟\n链接仅能使用一次",
+          "example": "https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDtthUUckpx9l14eUy8nTBEypH6h1yKt&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF",
+          "member": "string",
+          "name": "WebUrl",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "CreateConvertTaskApiRequest": {
       "document": "CreateConvertTaskApi请求参数结构体",
       "members": [
@@ -8985,6 +9073,52 @@
       ],
       "type": "object"
     },
+    "DescribeContractDiffTaskWebUrlRequest": {
+      "document": "DescribeContractDiffTaskWebUrl请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "执行本接口操作的员工信息。使用此接口时，必须填写userId。\n\n注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`",
+          "example": "无",
+          "member": "UserInfo",
+          "name": "Operator",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "合同对比任务ID，该参数通过调用接口<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/CreateContractDiffTaskWebUrl\" target=\"_blank\">创建合同对比web页面</a>获取。",
+          "example": "yDt3wUUckpx9w197UyoAic68BmF35hFu",
+          "member": "string",
+          "name": "TaskId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeContractDiffTaskWebUrlResponse": {
+      "document": "DescribeContractDiffTaskWebUrl返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "合同对比嵌入式web页面链接，有效期：5分钟\n链接仅能使用一次",
+          "example": "https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDt3RUUckpx9s4h8UuFSuGdR9VDNF2lh&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF&businessType=TASK_ID&businessId=yDttgUUckpxxat41UyoAic6CrjE7K0x2",
+          "member": "string",
+          "name": "WebUrl",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeExtendedServiceAuthDetailRequest": {
       "document": "DescribeExtendedServiceAuthDetail请求参数结构体",
       "members": [

tccli/services/ess/v20201111/examples.json

@@ -238,6 +238,20 @@
         "title": "生成动态签署人批量领取链接-并且预设企业名称"
       }
     ],
+    "CreateContractDiffTaskWebUrl": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateContractDiffTaskWebUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDw9iUUgyg36ykr3Ux4GQpt1FPWYQOZC\"\n    },\n    \"SkipFileUpload\": true\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"s1748574341239597750\",\n        \"TaskId\": \"\",\n        \"WebUrl\": \"https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDtthUUckpx9l14eUy8nTBEypH6h1yKt&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF\"\n    }\n}",
+        "title": "创建合同对比web页面"
+      },
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateContractDiffTaskWebUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDw9iUUgyg36ykr3Ux4GQpt1FPWYQOZC\"\n    },\n    \"OriginalFileResourceId\": \"yDttXUUckpx90i17UxPpcHHE1VDpNJPW\",\n    \"DiffFileResourceId\": \"yDttXUUckpx90i1xUxPpcHHyPdyqVErm\",\n    \"SkipFileUpload\": true\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"s1748937464610832514\",\n        \"TaskId\": \"yDt31UUckpx91cypUyoAic6wP2oyarMN\",\n        \"WebUrl\": \"https://embed.qian.tencent.cn/contract-compare?embed=1&code=yDt31UUckpx9196lUxKwEYgzw4fEWCom&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF&businessType=TASK_ID&businessId=yDt31UUckpx91cypUyoAic6wP2oyarMN\"\n    }\n}",
+        "title": "创建合同对比web页面 - 跳过文件上传确认页"
+      }
+    ],
     "CreateConvertTaskApi": [
       {
         "document": "适用场景：将jpg文件转换为pdf",
@@ -1414,6 +1428,14 @@
         "title": "查询批量撤销任务结果"
       }
     ],
+    "DescribeContractDiffTaskWebUrl": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeContractDiffTaskWebUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDw9iUUgyg36ykr3Ux4GQpt1FPWYQOZC\"\n    },\n    \"TaskId\": \"yDttgUUckpxxat41UyoAic6CrjE7K0x2\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"s1748918302614730295\",\n        \"WebUrl\": \"https://embed.test.qian.tencent.cn/contract-compare?embed=1&code=yDt3RUUckpx9s4h8UuFSuGdR9VDNF2lh&channel=TENCENTCLOUD&embedType=CONTRACT_DIFF&businessType=TASK_ID&businessId=yDttgUUckpxxat41UyoAic6CrjE7K0x2\"\n    }\n}",
+        "title": "获取合同对比结果web页面"
+      }
+    ],
     "DescribeExtendedServiceAuthDetail": [
       {
         "document": "",

tccli/services/essbasic/v20210526/api.json

@@ -13457,7 +13457,7 @@
         },
         {
           "disabled": false,
-          "document": "二维码，在生成动态签署人跳转封面页链接时返回\n\n注：`此二维码下载链接有效期为5分钟，可下载二维码后本地保存。`",
+          "document": "二维码，在生成动态签署人跳转封面页链接时返回\n\n注：`此二维码下载链接有效期为5分钟，可下载二维码后本地保存，二维码有效期为90天。`",
           "example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d**2f0db15e6b",
           "member": "string",
           "name": "SignQrcodeUrl",