tccli 3.0.1376.1__py2.py3-none-any.whl → 3.0.1377.1__py2.py3-none-any.whl

tccli/services/ess/v20201111/api.json

@@ -98,6 +98,13 @@
       "output": "CreateContractDiffTaskWebUrlResponse",
       "status": "online"
     },
+    "CreateContractReviewWebUrl": {
+      "document": "此接口（CreateContractReviewWebUrl）用来创建合同审查web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。\n\n适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。\n\n注: \n1. pdf、word格式限制大小为10M以下\n2. 如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开",
+      "input": "CreateContractReviewWebUrlRequest",
+      "name": "创建合同审查web页面",
+      "output": "CreateContractReviewWebUrlResponse",
+      "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",
@@ -532,6 +539,13 @@
       "output": "DescribeContractReviewTaskResponse",
       "status": "online"
     },
+    "DescribeContractReviewWebUrl": {
+      "document": "此接口（DescribeContractReviewWebUrl）用来创建合同审查web页面链接（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。\n\n适用场景：根据合同内容识别出合同的风险信息。审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。\n\n注意:  `如果文件资源为word类型生成的链接不能进行iframe嵌入，需要在单独窗口打开`",
+      "input": "DescribeContractReviewWebUrlRequest",
+      "name": "获取合同审查结果web页面",
+      "output": "DescribeContractReviewWebUrlResponse",
+      "status": "online"
+    },
     "DescribeExtendedServiceAuthDetail": {
       "document": "查询企业扩展服务的授权详情（列表），当前支持查询以下内容：\n1. 企业自动签（本企业授权、集团企业授权、合作企业授权）\n2. 批量签署能力\n\n\n注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)",
       "input": "DescribeExtendedServiceAuthDetailRequest",
@@ -3399,6 +3413,71 @@
       ],
       "type": "object"
     },
+    "CreateContractReviewWebUrlRequest": {
+      "document": "CreateContractReviewWebUrl请求参数结构体",
+      "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/templatesAndFiles/UploadFiles\" target=\"_blank\">UploadFiles</a>接口获取文件资源ID。\n\n注:  `目前，每个文件限制在10M以下，文件仅支持pdf、doc、docx格式`",
+          "example": "yDttXUUckpx90i1xUxPpcHHyPdyqVErm",
+          "member": "string",
+          "name": "ResourceId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。\n\n在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。",
+          "example": "QmFzZTY0IEJhc2U2NCA=",
+          "member": "string",
+          "name": "UserData",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "CreateContractReviewWebUrlResponse": {
+      "document": "CreateContractReviewWebUrl返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "接口返回的合同审查任务ID，可以调用接口<a href=\"https://qian.tencent.com/developers/companyApis/embedPages/DescribeContractReviewWebUrl\" target=\"_blank\">获取合同审查结果web页面</a>查看审查任务的结果。\n\n注意： `当ResourceId参数不为空时才会返回此值。`",
+          "example": "yDt4mUUckp9snk1mUugsjbKuk19M9oKP",
+          "member": "string",
+          "name": "TaskId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "合同审查嵌入式web页面链接。\n\n注意：`链接有效期为5分钟，且链接仅能使用一次。如果上传的合同文件为word时不能进行iframe方式嵌入到贵方系统的网页中，需要单独页面打开此链接显示`",
+          "example": "https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4mUUckp9s5rksUJaGnr8TvzvPZQYt&channel=TENCENTCLOUD&embedType=CONTRACT_REVIEW",
+          "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": [
@@ -9886,6 +9965,62 @@
       ],
       "type": "object"
     },
+    "DescribeContractReviewWebUrlRequest": {
+      "document": "DescribeContractReviewWebUrl请求参数结构体",
+      "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/CreateContractReviewWebUrl\" target=\"_blank\">创建合同审查web页面</a>获取。",
+          "example": "yDt4MUUckp9j4zj5UugsjbKvB0vibmas",
+          "member": "string",
+          "name": "TaskId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeContractReviewWebUrlResponse": {
+      "document": "DescribeContractReviewWebUrl返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "合同审查嵌入式web页面链接。\n注意：`链接有效期为5分钟，且链接仅能使用一次。如果上传的合同文件为word时不能进行iframe方式嵌入到贵方系统的网页中，需要单独页面打开此链接显示`",
+          "example": "https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4AUUckp9qgovnUy2vfEF8hYOjMMYZ&channel=TENCENTCLOUD&embedType=CONTRACT_REVIE",
+          "member": "string",
+          "name": "WebUrl",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "合同审查任务状态。任务状态为`5`时没有WebUrl链接。\n状态如下：\n<ul>\n    <li>**1** - 合同审查任务创建成功</li>   \n    <li>**2** - 合同审查任务排队中</li>  \n    <li>**3** - 合同审查任务执行中</li>   \n    <li>**4** - 合同审查任务执行成功</li>\n    <li>**5** - 合同审查任务执行失败</li>\n</ul>",
+          "example": "4",
+          "member": "int64",
+          "name": "Status",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeExtendedServiceAuthDetailRequest": {
       "document": "DescribeExtendedServiceAuthDetail请求参数结构体",
       "members": [
@@ -11972,10 +12107,10 @@
           "disabled": false,
           "document": "是否禁止编辑印章描述内容\n<ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>",
           "example": "true",
-          "member": "string",
+          "member": "bool",
           "name": "ForbidEditSealDescription",
           "required": false,
-          "type": "string"
+          "type": "bool"
         }
       ],
       "usage": "in"

tccli/services/ess/v20201111/examples.json

@@ -268,6 +268,14 @@
         "title": "创建合同对比web页面 - 跳过文件上传确认页"
       }
     ],
+    "CreateContractReviewWebUrl": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateContractReviewWebUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDwqbUUckp3oxxo7\"\n    },\n    \"ResourceId\": \"yDt4oUUcxxxqVZx\",\n    \"UserData\": \"5rWL6K+V5pWw5o2u\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"s1755568206750403220\",\n        \"TaskId\": \"yDt4mUUckp9sgohiUugsjbKR241Yq5F7\",\n        \"WebUrl\": \"https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4oUUckp9sdhe2UugPqwK8NOCXY1Rg&channel=TENCENTCLOUD&embedType=CONTRACT_REVIEW&shortKey=yDt4mUjbKxHBzcYpadbe\"\n    }\n}",
+        "title": "创建合同审查web页面"
+      }
+    ],
     "CreateConvertTaskApi": [
       {
         "document": "适用场景：将jpg文件转换为pdf",
@@ -1484,6 +1492,14 @@
         "title": "查询合同审查任务详情"
       }
     ],
+    "DescribeContractReviewWebUrl": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeContractReviewWebUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDwqbUUckp3o2rzmUxHsV0j1FlhYIKo7\"\n    },\n    \"TaskId\": \"yDt4MUUckp9j4zj5UugsjbKvB0vibmas\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"s1755602790251475316\",\n        \"Status\": 1,\n        \"WebUrl\": \"https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4mUUckp9shfedUx7mkC9zwLgqGdH6&channel=TENCENTCLOUD&embedType=CONTRACT_REVIEW&taskId=yDt4mUUckp9sgohiUugsjbKR241Yq5F7&preTaskId=yDt4mUUckp9sgoh6UugsjbKsbOWqWA2o\"\n    }\n}",
+        "title": "获取合同审查结果web页面"
+      }
+    ],
     "DescribeExtendedServiceAuthDetail": [
       {
         "document": "",

tccli/services/essbasic/v20210526/api.json

@@ -1273,7 +1273,7 @@
       "usage": "in"
     },
     "BatchOrganizationRegistrationTasksDetails": {
-      "document": "批量认证企业任务详情信息，其中包括 TaskId，状态信息等等",
+      "document": "批量认证企业任务详情信息，其中包括 TaskId，状态信息等",
       "members": [
         {
           "disabled": false,
@@ -9992,10 +9992,10 @@
           "disabled": false,
           "document": "是否禁止编辑印章描述内容\n<ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>",
           "example": "true",
-          "member": "string",
+          "member": "bool",
           "name": "ForbidEditSealDescription",
           "required": false,
-          "type": "string"
+          "type": "bool"
         }
       ],
       "usage": "in"
@@ -14492,7 +14492,7 @@
         },
         {
           "disabled": false,
-          "document": "模版的用户合同类型",
+          "document": "模板的用户合同类型",
           "example": "无",
           "member": "UserFlowType",
           "name": "UserFlowType",
@@ -14504,7 +14504,7 @@
       "usage": "out"
     },
     "TemplateUserFlowType": {
-      "document": "模版对应的合同类型",
+      "document": "模板对应的合同类型",
       "members": [
         {
           "disabled": false,
@@ -14528,7 +14528,7 @@
         },
         {
           "disabled": false,
-          "document": "每个合同类型绑定的模版数量\t",
+          "document": "每个合同类型绑定的模板数量\t",
           "example": "10",
           "member": "int64",
           "name": "TemplateNum",

tccli/services/faceid/v20180301/api.json

@@ -5297,7 +5297,7 @@
         },
         {
           "disabled": false,
-          "document": "本token收费次数",
+          "document": "本token收费次数。（说明：一次核身过程用户可能会重试多次，因此一个biztoken可能会对应多次计费，如需配置重试上限，请[联系我们](https://cloud.tencent.com/document/product/1007/56130)配置。）",
           "example": "0",
           "member": "uint64",
           "name": "ChargeCount",

tccli/services/ioa/ioa_client.py

@@ -173,6 +173,58 @@ def doDescribeVirtualDevices(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doDescribeAggrSoftCategorySoftList(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('-', '_')], endpoint=g_param["sts_cred_endpoint"]
+        )
+    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):
+        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.IoaClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeAggrSoftCategorySoftListRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeAggrSoftCategorySoftList(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 doDescribeDevices(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -745,6 +797,58 @@ def doDescribeDLPFileDetectResult(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doDescribeDeviceChildGroups(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('-', '_')], endpoint=g_param["sts_cred_endpoint"]
+        )
+    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):
+        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.IoaClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeDeviceChildGroupsRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeDeviceChildGroups(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 doCreateDeviceTask(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -863,6 +967,7 @@ ACTION_MAP = {
     "CreateDeviceVirtualGroup": doCreateDeviceVirtualGroup,
     "DescribeLocalAccounts": doDescribeLocalAccounts,
     "DescribeVirtualDevices": doDescribeVirtualDevices,
+    "DescribeAggrSoftCategorySoftList": doDescribeAggrSoftCategorySoftList,
     "DescribeDevices": doDescribeDevices,
     "DescribeDeviceVirtualGroups": doDescribeDeviceVirtualGroups,
     "CreateDLPFileDetectionTask": doCreateDLPFileDetectionTask,
@@ -874,6 +979,7 @@ ACTION_MAP = {
     "ModifyVirtualDeviceGroups": doModifyVirtualDeviceGroups,
     "DescribeRootAccountGroup": doDescribeRootAccountGroup,
     "DescribeDLPFileDetectResult": doDescribeDLPFileDetectResult,
+    "DescribeDeviceChildGroups": doDescribeDeviceChildGroups,
     "CreateDeviceTask": doCreateDeviceTask,
     "DescribeAccountGroups": doDescribeAccountGroups,