tccli 3.0.1089.1__py2.py3-none-any.whl → 3.0.1091.1__py2.py3-none-any.whl

tccli/services/essbasic/v20210526/api.json

@@ -906,6 +906,15 @@
           "name": "LicenseType",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。\n\n注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`\n\n跳转场景：\n<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li>\n<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>\n\n成功结果返回：\n若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，比如 qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess",
+          "example": "无",
+          "member": "string",
+          "name": "JumpUrl",
+          "required": false,
+          "type": "string"
         }
       ],
       "usage": "in"
@@ -3527,6 +3536,15 @@
           "name": "ExpiredTime",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。 ",
+          "example": "无",
+          "member": "string",
+          "name": "UserData",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -5425,7 +5443,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "控件唯一ID。\n\n**在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例：\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >，则会在PDF文件中有且仅有\"甲方签署\"关键字的地方（<font color=\"red\">前后不能有其他字符</font >）进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">前后可以有其他字符</font >）都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"^甲方签署</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">前面不能有其他字符</font >）都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署^</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">后面不能有其他字符</font >）都会执行相应操作。\n\n\n注：`控件ID可以在一个PDF中不可重复`\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentId在模板页面的位置</a>\n",
+          "document": "控件唯一ID。\n\n**在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例：\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >，则会在PDF文件中有且仅有\"甲方签署\"关键字的地方（<font color=\"red\">前后不能有其他字符</font >）进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">前后可以有其他字符</font >）都会执行相应操作。\n\n\n注：`控件ID可以在一个PDF中不可重复`\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentId在模板页面的位置</a>\n",
           "example": "ComponentId",
           "member": "string",
           "name": "ComponentId",
@@ -9500,7 +9518,7 @@
           "example": "无",
           "member": "string",
           "name": "SealId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -9510,7 +9528,7 @@
           "example": "无",
           "member": "string",
           "name": "SealName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -9520,7 +9538,7 @@
           "example": "无",
           "member": "int64",
           "name": "CreateOn",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -9530,7 +9548,7 @@
           "example": "无",
           "member": "string",
           "name": "Creator",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -9540,7 +9558,7 @@
           "example": "无",
           "member": "string",
           "name": "SealPolicyId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -9550,7 +9568,7 @@
           "example": "无",
           "member": "string",
           "name": "SealStatus",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -9560,7 +9578,7 @@
           "example": "无",
           "member": "string",
           "name": "FailReason",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -9570,17 +9588,17 @@
           "example": "无",
           "member": "string",
           "name": "Url",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "印章类型，OFFICIAL-企业公章，CONTRACT-合同专用章，LEGAL_PERSON_SEAL-法人章",
+          "document": "电子印章类型 , 可选类型如下: \n<ul><li>**OFFICIAL**: (默认)公章</li>\n<li>**CONTRACT**: 合同专用章;</li>\n<li>**FINANCE**: 财务专用章;</li>\n<li>**PERSONNEL**: 人事专用章</li>\n<li>**INVOICE**: 发票专用章</li>\n</ul>",
           "example": "无",
           "member": "string",
           "name": "SealType",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -9590,7 +9608,7 @@
           "example": "无",
           "member": "bool",
           "name": "IsAllTime",
-          "required": true,
+          "output_required": true,
           "type": "bool",
           "value_allowed_null": false
         },
@@ -9600,7 +9618,7 @@
           "example": "无",
           "member": "AuthorizedUser",
           "name": "AuthorizedUsers",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         }

tccli/services/faceid/v20180301/api.json

@@ -50,7 +50,7 @@
       "status": "online"
     },
     "CheckPhoneAndName": {
-      "document": "手机号二要素核验接口用于校验手机号和姓名的真实性和一致性，支持的手机号段详情请查阅<a href=\"https://cloud.tencent.com/document/product/1007/46063\">运营商类</a>文档。\n",
+      "document": "手机号二要素核验接口用于校验手机号和姓名的真实性和一致性，支持的手机号段详情请查阅<a href=\"https://cloud.tencent.com/document/product/1007/46063\">运营商类</a>文档。",
       "input": "CheckPhoneAndNameRequest",
       "name": "手机号二要素核验",
       "output": "CheckPhoneAndNameResponse",
@@ -1043,11 +1043,11 @@
       "members": [
         {
           "disabled": false,
-          "document": "认证结果码，收费情况如下。\n收费结果码：\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码：\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常",
+          "document": "认证结果码，收费情况如下。\n收费结果码：\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码：\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常\n-4:姓名校验不通过\n-5:手机号码不合法",
           "example": "0",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -1057,7 +1057,7 @@
           "example": "验证结果一致",
           "member": "string",
           "name": "Description",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },

tccli/services/gs/gs_client.py

@@ -225,6 +225,58 @@ def doSaveGameArchive(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doStartPublishStreamToCSS(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.GsClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.StartPublishStreamToCSSRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.StartPublishStreamToCSS(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 doCreateSession(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -448,6 +500,7 @@ ACTION_MAP = {
     "TrylockWorker": doTrylockWorker,
     "StopGame": doStopGame,
     "SaveGameArchive": doSaveGameArchive,
+    "StartPublishStreamToCSS": doStartPublishStreamToCSS,
     "CreateSession": doCreateSession,
     "StartPublishStream": doStartPublishStream,
     "StopPublishStream": doStopPublishStream,

tccli/services/gs/v20191118/api.json

@@ -28,6 +28,13 @@
       "output": "StartPublishStreamResponse",
       "status": "online"
     },
+    "StartPublishStreamToCSS": {
+      "document": "开始云端推流",
+      "input": "StartPublishStreamToCSSRequest",
+      "name": "开始云端推流到云直播",
+      "output": "StartPublishStreamToCSSResponse",
+      "status": "online"
+    },
     "StopGame": {
       "document": "强制退出游戏",
       "input": "StopGameRequest",
@@ -415,6 +422,42 @@
       ],
       "type": "object"
     },
+    "StartPublishStreamToCSSRequest": {
+      "document": "StartPublishStreamToCSS请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）",
+          "example": "abc123",
+          "member": "string",
+          "name": "UserId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "推流参数，推流时携带自定义参数。",
+          "example": "bar=1&foo=2",
+          "member": "string",
+          "name": "PublishStreamArgs",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "StartPublishStreamToCSSResponse": {
+      "document": "StartPublishStreamToCSS返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "StopGameRequest": {
       "document": "StopGame请求参数结构体",
       "members": [

tccli/services/gs/v20191118/examples.json

@@ -32,6 +32,14 @@
         "title": "开始云端推流"
       }
     ],
+    "StartPublishStreamToCSS": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: gs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishStreamToCSS\n<公共请求参数>\n\n{\n    \"UserId\": \"abc123\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"4eb17e58-68da-4e9a-b298-0894723c9022\"\n    }\n}",
+        "title": "StartPublishStreamToCSS 示例"
+      }
+    ],
     "StopGame": [
       {
         "document": "",

tccli/services/iss/v20230517/api.json

@@ -3806,6 +3806,26 @@
           "output_required": true,
           "type": "string",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "音频关开（0：关闭；1：开启）关闭时丢弃音频\t\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0",
+          "member": "int64",
+          "name": "AudioSwitch",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "订阅开关（0：关闭；1：开启）默认开启，开启状态下会订阅设备通道变化，仅国标NVR设备有效\t\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "int64",
+          "name": "SubscribeSwitch",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"
@@ -10173,6 +10193,24 @@
           "name": "ProtocolType",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "音频关开（0：关闭；1：开启）默认开启，关闭时丢弃音频",
+          "example": "1",
+          "member": "int64",
+          "name": "AudioSwitch",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "订阅开关（0：关闭；1：开启）默认开启，开启状态下会订阅设备通道变化，仅国标NVR设备有效",
+          "example": "1",
+          "member": "int64",
+          "name": "SubscribeSwitch",
+          "required": false,
+          "type": "int"
         }
       ],
       "type": "object"

tccli/services/lcic/v20220817/api.json

@@ -1688,7 +1688,7 @@
         },
         {
           "disabled": false,
-          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (预留参数，暂未开放)",
+          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (预留参数，暂未开放)\n注：大班课的布局(layout)只有三分屏",
           "example": "0",
           "member": "int64",
           "name": "RoomType",
@@ -3319,7 +3319,7 @@
         },
         {
           "disabled": false,
-          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展)",
+          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展)\n注：大班课的布局(layout)只有三分屏",
           "example": "0",
           "member": "int64",
           "name": "RoomType",
@@ -5476,7 +5476,7 @@
         },
         {
           "disabled": false,
-          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 （预留参数、暂未开放)",
+          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 （预留参数、暂未开放)\n注：大班课的布局(layout)只有三分屏",
           "example": "0",
           "member": "uint64",
           "name": "RoomType",
@@ -5998,7 +5998,7 @@
         },
         {
           "disabled": false,
-          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展)",
+          "document": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展)\n注：大班课的布局(layout)只有三分屏",
           "example": "0",
           "member": "int64",
           "name": "RoomType",
@@ -6236,7 +6236,7 @@
         },
         {
           "disabled": false,
-          "document": "房间类型。0:小班课（默认值）；1:大班课；2:1V1（后续扩展）\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "房间类型。0:小班课（默认值）；1:大班课；2:1V1（后续扩展）\n注：大班课的布局(layout)只有三分屏\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "0",
           "member": "int64",
           "name": "RoomType",

tccli/services/lighthouse/v20200324/api.json

@@ -8095,7 +8095,7 @@
         },
         {
           "disabled": false,
-          "document": "自动续费标识。取值范围：<br><li>NOTIFY_AND_AUTO_RENEW：通知过期且自动续费<br><li>NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费<br><br>若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。",
+          "document": "自动续费标识。取值范围：\n\n- NOTIFY_AND_AUTO_RENEW：通知过期且自动续费\n- NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费\n- DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费\n\n若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。",
           "example": "NOTIFY_AND_AUTO_RENEW",
           "member": "string",
           "name": "RenewFlag",

tccli/services/live/v20180801/api.json

@@ -10905,7 +10905,7 @@
           "example": "abc.com",
           "member": "string",
           "name": "Name",
-          "required": false,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -10915,7 +10915,7 @@
           "example": "1",
           "member": "uint64",
           "name": "Type",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -10925,7 +10925,7 @@
           "example": "1",
           "member": "uint64",
           "name": "Status",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -10935,7 +10935,7 @@
           "example": "2011-09-09 11:11:11",
           "member": "string",
           "name": "CreateTime",
-          "required": false,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -10945,7 +10945,7 @@
           "example": "1",
           "member": "uint64",
           "name": "BCName",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -10955,7 +10955,7 @@
           "example": "abc.com",
           "member": "string",
           "name": "TargetDomain",
-          "required": false,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -10965,7 +10965,7 @@
           "example": "2",
           "member": "int64",
           "name": "PlayType",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -10975,7 +10975,7 @@
           "example": "0",
           "member": "int64",
           "name": "IsDelayLive",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -10985,7 +10985,7 @@
           "example": "abc.com",
           "member": "string",
           "name": "CurrentCName",
-          "required": false,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -10995,7 +10995,7 @@
           "example": "a",
           "member": "int64",
           "name": "RentTag",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -11005,7 +11005,7 @@
           "example": "2011-09-09 11:11:11",
           "member": "string",
           "name": "RentExpireTime",
-          "required": false,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -11015,7 +11015,7 @@
           "example": "0",
           "member": "int64",
           "name": "IsMiniProgramLive",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         }