tccli 3.0.990.1__py2.py3-none-any.whl → 3.0.992.1__py2.py3-none-any.whl

tccli/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.990.1'
+__version__ = '3.0.992.1'

tccli/examples/car/v20220110/DestroySession.md

@@ -6,7 +6,7 @@ Input:
 
 ```
 tccli car DestroySession --cli-unfold-argument  \
-    --UserId cg_user
+    --UserId abc
 ```
 
 Output: 

tccli/examples/cls/v20201016/CheckFunction.md

@@ -0,0 +1,25 @@
+**Example 1: 校验数据加工函数语法**
+
+校验数据加工函数的语法
+
+Input: 
+
+```
+tccli cls CheckFunction --cli-unfold-argument  \
+    --EtlContent fields_set() \
+    --DstResources.0.TopicId x56493046-XXXX-4194-81f6-c2e75569b031 \
+    --DstResources.0.Alias example \
+    --FuncType 1
+```
+
+Output: 
+```
+{
+    "Response": {
+        "ErrorCode": 0,
+        "ErrorMsg": "",
+        "RequestId": "x56493046-XXXX-4194-81f6-c2e75569b031"
+    }
+}
+```
+

tccli/examples/ess/v20201111/DescribeBillUsageDetail.md

@@ -0,0 +1,108 @@
+**Example 1: 查询全部消耗途径**
+
+
+
+Input: 
+
+```
+tccli ess DescribeBillUsageDetail --cli-unfold-argument  \
+    --StartTime 20230902 \
+    --EndTime 20230930 \
+    --Offset 0 \
+    --Limit 50
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Details": [
+            {
+                "CostTime": 1695037514,
+                "CostType": 1,
+                "FlowId": "yDwJOU5e7ikveIUxMW0p2uJxxxxxxxxxx",
+                "FlowName": "腾讯电子签xxxxx合同",
+                "OperatorName": "张三;李斯",
+                "QuotaName": "签署报告（出证服务）",
+                "QuotaType": "CloudProve",
+                "Remark": "",
+                "Status": 4,
+                "UseCount": 1
+            }
+        ],
+        "RequestId": "s16992572741898xxxx",
+        "Total": 1
+    }
+}
+```
+
+**Example 2: 查询失败样例**
+
+
+
+Input: 
+
+```
+tccli ess DescribeBillUsageDetail --cli-unfold-argument  \
+    --StartTime 20230902 \
+    --EndTime 20230930 \
+    --Offset 0 \
+    --Limit 1000
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "InvalidParameter.Limit",
+            "Message": "分页参数不合法"
+        },
+        "RequestId": "s169935778xxxxxxx"
+    }
+}
+```
+
+**Example 3: 查询渠道客户消耗**
+
+
+
+Input: 
+
+```
+tccli ess DescribeBillUsageDetail --cli-unfold-argument  \
+    --StartTime abc \
+    --EndTime abc \
+    --Offset 0 \
+    --Limit 0 \
+    --QuotaType abc \
+    --Agent.AppId abc \
+    --Agent.ProxyAppId abc \
+    --Agent.ProxyOrganizationId abc \
+    --Agent.ProxyOperator abc
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Details": [
+            {
+                "CostTime": 1695037514,
+                "CostType": 1,
+                "FlowId": "yDwJOU5e7ikveIUxMW0p2uJxxxxxxxxxx",
+                "FlowName": "腾讯电子签xxxxx合同",
+                "OperatorName": "张三;李斯",
+                "QuotaName": "签署报告（出证服务）",
+                "QuotaType": "CloudProve",
+                "Remark": "",
+                "Status": 4,
+                "UseCount": 1
+            }
+        ],
+        "RequestId": "s16992572741898xxxx",
+        "Total": 1
+    }
+}
+```
+

tccli/examples/essbasic/v20210526/ChannelCreatePreparedPersonalEsign.md

@@ -39,3 +39,95 @@ Output:
 }
 ```
 
+**Example 2: 参数IdCardNumber不能为空**
+
+参数IdCardNumber不能为空
+
+Input: 
+
+```
+tccli essbasic ChannelCreatePreparedPersonalEsign --cli-unfold-argument  \
+    --Operator.OpenId abc \
+    --Operator.Channel abc \
+    --Operator.CustomUserId abc \
+    --Operator.ClientIp abc \
+    --Operator.ProxyIp abc \
+    --Agent.AppId abc \
+    --Agent.ProxyOrganizationOpenId abc \
+    --Agent.ProxyOperator.OpenId abc \
+    --Agent.ProxyOperator.Channel abc \
+    --Agent.ProxyOperator.CustomUserId abc \
+    --Agent.ProxyOperator.ClientIp abc \
+    --Agent.ProxyOperator.ProxyIp abc \
+    --Agent.ProxyAppId abc \
+    --Agent.ProxyOrganizationId abc \
+    --UserName abc \
+    --IdCardType abc \
+    --IdCardNumber  \
+    --SealName abc \
+    --SealImage abc \
+    --SealImageCompress True \
+    --Mobile abc \
+    --EnableAutoSign True \
+    --LicenseType 0
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "InvalidParameterValue",
+            "Message": "参数IdCardNumber不能为空"
+        },
+        "RequestId": "abc"
+    }
+}
+```
+
+**Example 3: 参数UserName不能为空**
+
+参数UserName不能为空
+
+Input: 
+
+```
+tccli essbasic ChannelCreatePreparedPersonalEsign --cli-unfold-argument  \
+    --Operator.OpenId abc \
+    --Operator.Channel abc \
+    --Operator.CustomUserId abc \
+    --Operator.ClientIp abc \
+    --Operator.ProxyIp abc \
+    --Agent.AppId abc \
+    --Agent.ProxyOrganizationOpenId abc \
+    --Agent.ProxyOperator.OpenId abc \
+    --Agent.ProxyOperator.Channel abc \
+    --Agent.ProxyOperator.CustomUserId abc \
+    --Agent.ProxyOperator.ClientIp abc \
+    --Agent.ProxyOperator.ProxyIp abc \
+    --Agent.ProxyAppId abc \
+    --Agent.ProxyOrganizationId abc \
+    --UserName  \
+    --IdCardType abc \
+    --IdCardNumber abc \
+    --SealName abc \
+    --SealImage abc \
+    --SealImageCompress True \
+    --Mobile abc \
+    --EnableAutoSign True \
+    --LicenseType 0
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "InvalidParameterValue",
+            "Message": "参数UserName不能为空"
+        },
+        "RequestId": "xxxx111xxxx"
+    }
+}
+```
+

tccli/examples/essbasic/v20210526/ChannelCreateReleaseFlow.md

@@ -1,7 +1,15 @@
-**Example 1: 发起解除协议（默认情况，使用原流程的签署人）**
+**Example 1: 发起解除协议(使用本企业的签署人，替换用原流程中本企业的签署人)**
 
-1. 使用原流程的签署人
+1. 使用本企业的签署人
 2. 包含了详细的解除内容
+3. 替换原流程中本企业的签署人
+4. 被替换的原流程中的签署人ApproverNumber=1(即第二个签署人，在原流程签署人列表中的第二位)
+
+扩展信息：
+针对ApproverNumber举个例子，
+例如在原流程中共有三个签署人(a, b, c)，
+那么a是第一位(ApproverNumber=0)，b是第二位(ApproverNumber=1)，c是第三位(ApproverNumber=2)，
+注意这里的顺序不是签署顺序，仅仅是签署人列表中的自然顺序，签署人列表的获取可以参考DescribeFlowDetailInfo接口。
 
 Input: 
 
@@ -11,6 +19,11 @@ tccli essbasic ChannelCreateReleaseFlow --cli-unfold-argument  \
     --Agent.ProxyOperator.OpenId n9527 \
     --Agent.AppId yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT \
     --NeedRelievedFlowId yDwFmUUckpst10i3UubBSat8PWOt2iQF \
+    --ReleasedApprovers.0.ApproverNumber 1 \
+    --ReleasedApprovers.0.Name 典子谦 \
+    --ReleasedApprovers.0.Mobile 13200000000 \
+    --ReleasedApprovers.0.ApproverType ORGANIZATION \
+    --ReleasedApprovers.0.OrganizationName 典子谦示例企业 \
     --ReliveInfo.Reason 因为业务调整, 结束合作。 \
     --ReliveInfo.RemainInForceItem 在业务结束前已产生的订单依旧有效。 \
     --ReliveInfo.OriginalExpenseSettlement 甲方需付给乙方xxxx以作赔偿。 \
@@ -22,38 +35,63 @@ Output:
 ```
 {
     "Response": {
-        "FlowId": "yDwFdUUckps******xAhL7zuaIwkMth",
+        "FlowId": "yDwFdUUckps******xAhL7zuaIwkMth4",
         "RequestId": "s1669**2203341"
     }
 }
 ```
 
-**Example 2: 发起解除协议(使用本企业的签署人，替换用原流程中本企业的签署人)**
-
-1. 使用本企业的签署人
-2. 包含了详细的解除内容
-3. 替换原流程中本企业的签署人
-4. 被替换的原流程中的签署人ApproverNumber=1(即第二个签署人，在原流程签署人列表中的第二位)
+**Example 2: 发起解除协议(替换原流程中本企业的参与人并指定签署人角色、签署控件)**
 
-扩展信息：
-针对ApproverNumber举个例子，
-例如在原流程中共有三个签署人(a, b, c)，
-那么a是第一位(ApproverNumber=0)，b是第二位(ApproverNumber=1)，c是第三位(ApproverNumber=2)，
-注意这里的顺序不是签署顺序，仅仅是签署人列表中的自然顺序，签署人列表的获取可以参考DescribeFlowDetailInfo接口。
+1. 更换原合同中本方企业的参与人
+2. 给该企业参与人指定自定义的角色名称(通过设置ApproverSignRole)
+3. 给该企业参与人指定签署控件类型为手写签名(通过设置ApproverSignComponentType)
 
 Input: 
 
 ```
 tccli essbasic ChannelCreateReleaseFlow --cli-unfold-argument  \
-    --Agent.ProxyOrganizationOpenId org_dianziqian \
-    --Agent.ProxyOperator.OpenId n9527 \
     --Agent.AppId yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT \
+    --Agent.ProxyOperator.OpenId n9527 \
+    --Agent.ProxyOrganizationOpenId org_dianziqian \
     --NeedRelievedFlowId yDwFmUUckpst10i3UubBSat8PWOt2iQF \
     --ReleasedApprovers.0.ApproverNumber 1 \
-    --ReleasedApprovers.0.Name 典子谦 \
-    --ReleasedApprovers.0.Mobile 13200000000 \
+    --ReleasedApprovers.0.ApproverSignComponentType SIGN_SIGNATURE \
+    --ReleasedApprovers.0.ApproverSignRole 自定义的签署方角色(供应商) \
     --ReleasedApprovers.0.ApproverType ORGANIZATION \
+    --ReleasedApprovers.0.Mobile 13200000000 \
+    --ReleasedApprovers.0.Name 典子谦 \
     --ReleasedApprovers.0.OrganizationName 典子谦示例企业 \
+    --ReliveInfo.OriginalExpenseSettlement 甲方需付给乙方xxxx以作赔偿。 \
+    --ReliveInfo.OriginalOtherSettlement 无 \
+    --ReliveInfo.OtherDeals 无 \
+    --ReliveInfo.Reason 因为业务调整, 结束合作。 \
+    --ReliveInfo.RemainInForceItem 在业务结束前已产生的订单依旧有效。
+```
+
+Output: 
+```
+{
+    "Response": {
+        "FlowId": "yDwgkUU7y***********zWBfv",
+        "RequestId": "s168809**839"
+    }
+}
+```
+
+**Example 3: 发起解除协议(默认情况，使用原流程的签署人)**
+
+1. 使用原流程的签署人
+2. 包含了详细的解除内容
+
+Input: 
+
+```
+tccli essbasic ChannelCreateReleaseFlow --cli-unfold-argument  \
+    --Agent.ProxyOrganizationOpenId org_dianziqian \
+    --Agent.ProxyOperator.OpenId n9527 \
+    --Agent.AppId yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT \
+    --NeedRelievedFlowId yDwFmUUckpst10i3UubBSat8PWOt2iQF \
     --ReliveInfo.Reason 因为业务调整, 结束合作。 \
     --ReliveInfo.RemainInForceItem 在业务结束前已产生的订单依旧有效。 \
     --ReliveInfo.OriginalExpenseSettlement 甲方需付给乙方xxxx以作赔偿。 \
@@ -65,9 +103,46 @@ Output:
 ```
 {
     "Response": {
-        "FlowId": "yDwFdUUckps******xAhL7zuaIwkMth4",
+        "FlowId": "yDwFdUUckps******xAhL7zuaIwkMth",
         "RequestId": "s1669**2203341"
     }
 }
 ```
 
+**Example 4: 错误示例-解除协议中更换原合同个人类型的参与人**
+
+1. 解除某个包含个人类型签署人的合同
+2. 更换其他个人类型签署人作为解除协议的参与人
+
+Input: 
+
+```
+tccli essbasic ChannelCreateReleaseFlow --cli-unfold-argument  \
+    --Agent.AppId yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT \
+    --Agent.ProxyOperator.OpenId n9527 \
+    --Agent.ProxyOrganizationOpenId org_dianziqian \
+    --NeedRelievedFlowId yDR1AUUgygjazuesUuO4zjESPW4PkfNi \
+    --ReleasedApprovers.0.ApproverNumber 2 \
+    --ReleasedApprovers.0.ApproverType PERSON \
+    --ReleasedApprovers.0.Mobile 15100000000 \
+    --ReleasedApprovers.0.Name 李四 \
+    --ReliveInfo.OriginalExpenseSettlement 甲方需付给乙方xxxx以作赔偿 \
+    --ReliveInfo.OriginalOtherSettlement 无 \
+    --ReliveInfo.OtherDeals 无 \
+    --ReliveInfo.Reason 因为业务调整, 结束合作。 \
+    --ReliveInfo.RemainInForceItem 在业务结束前已产生的订单依旧有效。
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "FailedOperation",
+            "Message": "不能更换非企业签署人身份信息"
+        },
+        "RequestId": "s16939***23898"
+    }
+}
+```
+

tccli/examples/essbasic/v20210526/ChannelCreateSealPolicy.md

@@ -25,3 +25,91 @@ Output:
 }
 ```
 
+**Example 2: 授权时，找不到对应的 UserId**
+
+授权时，找不到对应的 UserId
+
+Input: 
+
+```
+tccli essbasic ChannelCreateSealPolicy --cli-unfold-argument  \
+    --Agent.AppId abc \
+    --Agent.ProxyOrganizationOpenId abc \
+    --Agent.ProxyOperator.OpenId abc \
+    --Agent.ProxyOperator.Channel abc \
+    --Agent.ProxyOperator.CustomUserId abc \
+    --Agent.ProxyOperator.ClientIp abc \
+    --Agent.ProxyOperator.ProxyIp abc \
+    --Agent.ProxyAppId abc \
+    --Agent.ProxyOrganizationId abc \
+    --SealId abc \
+    --UserIds abc xxxid \
+    --Operator.OpenId abc \
+    --Operator.Channel abc \
+    --Operator.CustomUserId abc \
+    --Operator.ClientIp abc \
+    --Operator.ProxyIp abc \
+    --Organization.OrganizationId abc \
+    --Organization.Channel abc \
+    --Organization.OrganizationOpenId abc \
+    --Organization.ClientIp abc \
+    --Organization.ProxyIp abc
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "InvalidParameter.ParamError",
+            "Message": "无效的授权用户Id"
+        },
+        "RequestId": "abc"
+    }
+}
+```
+
+**Example 3: 授权时，缺少印章ID**
+
+授权时，缺少印章ID
+
+Input: 
+
+```
+tccli essbasic ChannelCreateSealPolicy --cli-unfold-argument  \
+    --Agent.AppId abc \
+    --Agent.ProxyOrganizationOpenId abc \
+    --Agent.ProxyOperator.OpenId abc \
+    --Agent.ProxyOperator.Channel abc \
+    --Agent.ProxyOperator.CustomUserId abc \
+    --Agent.ProxyOperator.ClientIp abc \
+    --Agent.ProxyOperator.ProxyIp abc \
+    --Agent.ProxyAppId abc \
+    --Agent.ProxyOrganizationId abc \
+    --SealId  \
+    --UserIds abc \
+    --Operator.OpenId abc \
+    --Operator.Channel abc \
+    --Operator.CustomUserId abc \
+    --Operator.ClientIp abc \
+    --Operator.ProxyIp abc \
+    --Organization.OrganizationId abc \
+    --Organization.Channel abc \
+    --Organization.OrganizationOpenId abc \
+    --Organization.ClientIp abc \
+    --Organization.ProxyIp abc
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "InvalidParameter.ParamError",
+            "Message": "缺失印章ID"
+        },
+        "RequestId": "abc"
+    }
+}
+```
+

tccli/examples/essbasic/v20210526/ChannelDescribeEmployees.md

@@ -1,21 +1,19 @@
-**Example 1: 查询员工列表（查询已实名员工列表）**
+**Example 1: 查询已实名员工列表**
 
-查询已实名员工列表
-1. Filter参数Key设置为"Status";
-2. Filter参数Values设置为"IsVerified"，表示查询已实名员工；
-3. 设置Limit和Offset参数，从首页开始，每页查询20条数据返回。
+Filter参数Key设置为"Status",Values设置为"IsVerified"表示查询已实名员工
 
 Input: 
 
 ```
 tccli essbasic ChannelDescribeEmployees --cli-unfold-argument  \
+    --Agent.AppId yDwhxUUckp3gl8j5UuFX33LSNozpRsbi \
     --Agent.ProxyOrganizationOpenId org_dianziqian \
     --Agent.ProxyOperator.OpenId n9527 \
-    --Agent.AppId yDxbWUyKxxxxxxxxxxxzjEB8mxCcDjAyF \
+    --Agent.ProxyAppId  \
     --Filters.0.Key Status \
     --Filters.0.Values IsVerified \
-    --Limit 20 \
-    --Offset 0
+    --Offset 0 \
+    --Limit 20
 ```
 
 Output: 
@@ -24,74 +22,116 @@ Output:
     "Response": {
         "Employees": [
             {
-                "CreatedOn": 1658114069,
+                "UserId": "yDSLNUUckpossi8fUy98I4ESq4EmlpEd",
+                "DisplayName": "张三",
+                "Mobile": "18888888888",
+                "Email": "",
+                "OpenId": "n02468",
+                "Roles": [
+                    {
+                        "RoleId": "yDSLOUUckpojqpkmUEJmzYK68ctIyPFp",
+                        "RoleName": "业务员"
+                    }
+                ],
                 "Department": {
-                    "DepartmentId": "dp-8a801d51****820e2aed8155f2",
-                    "DepartmentName": "test企业"
+                    "DepartmentId": "",
+                    "DepartmentName": ""
                 },
-                "DisplayName": "test",
+                "Verified": true,
+                "CreatedOn": 1699087891,
+                "VerifiedOn": 1699088080,
+                "QuiteJob": 0
+            },
+            {
+                "UserId": "yDwi0UUckpohyi32UEdhBFEEbigdd0Dd",
+                "DisplayName": "李四",
+                "Mobile": "15100000000",
                 "Email": "",
-                "Mobile": "123****4567",
-                "OpenId": "",
+                "OpenId": "n123456",
                 "Roles": [
                     {
-                        "RoleId": "ea4ab302****80dd388e6da6902",
-                        "RoleName": "法人"
-                    },
-                    {
-                        "RoleId": "4fcbf3624****df77e30ea6c63",
+                        "RoleId": "69997f600a7c8e9accc71f4241a8a091",
                         "RoleName": "超级管理员"
-                    },
-                    {
-                        "RoleId": "9b7dcf74ab****b57c9fecf8e9",
-                        "RoleName": "业务员"
-                    },
-                    {
-                        "RoleId": "4dff1cea****6fc061010b",
-                        "RoleName": "企业员工"
                     }
                 ],
-                "UserId": "yDRtvUUgygq****O4zjESsMBKpnZs",
+                "Department": {
+                    "DepartmentId": "",
+                    "DepartmentName": ""
+                },
                 "Verified": true,
-                "VerifiedOn": 1658114065,
+                "CreatedOn": 1698814301,
+                "VerifiedOn": 1698814443,
                 "QuiteJob": 0
             }
         ],
-        "Limit": 20,
         "Offset": 0,
-        "RequestId": "s16635***97576195",
-        "TotalCount": 1
+        "Limit": 20,
+        "TotalCount": 2,
+        "RequestId": "e0461ce0-455c-410b-873b-f33de95f281f"
     }
 }
 ```
 
-**Example 2: 错误示例-参数不合法**
+**Example 2: 查询某几个员工列表**
 
-在使用此接口时，需要按照入参描述进行相应的设置，以确保参数的合法性。如果参数设置不合法，此接口将返回错误信息。
-1. 将Limit参数设置为21，超过最大值20。
+Filter参数Key设置为"StaffOpenId",Values设置为员工的OpenId列表
 
 Input: 
 
 ```
 tccli essbasic ChannelDescribeEmployees --cli-unfold-argument  \
+    --Agent.AppId yDwhxUUckp3gl8j5UuFX33LSNozpRsbi \
     --Agent.ProxyOrganizationOpenId org_dianziqian \
     --Agent.ProxyOperator.OpenId n9527 \
-    --Agent.AppId yDxbWUyKxxxxxxxxxxxzjEB8mxCcDjAyF \
-    --Filters.0.Key Status \
-    --Filters.0.Values IsVerified \
-    --Limit 21 \
-    --Offset 0
+    --Agent.ProxyAppId  \
+    --Filters.0.Key StaffOpenId \
+    --Filters.0.Values n02468 n123456 \
+    --Offset 0 \
+    --Limit 20
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "InvalidParameter.ParamError",
-            "Message": "参数Limit不正确"
-        },
-        "RequestId": "3b506b8a-xxxx-xxxx-xxxx-xxxxx9eaaadd"
+        "Employees": [
+            {
+                "UserId": "",
+                "DisplayName": "张三",
+                "Mobile": "18888888888",
+                "Email": "",
+                "OpenId": "n02468",
+                "Roles": [],
+                "Department": {
+                    "DepartmentId": "",
+                    "DepartmentName": ""
+                },
+                "Verified": false,
+                "CreatedOn": 1699095474,
+                "VerifiedOn": 0,
+                "QuiteJob": 0
+            },
+            {
+                "UserId": "",
+                "DisplayName": "李四",
+                "Mobile": "15100000000",
+                "Email": "",
+                "OpenId": "n123456",
+                "Roles": [],
+                "Department": {
+                    "DepartmentId": "",
+                    "DepartmentName": ""
+                },
+                "Verified": false,
+                "CreatedOn": 1699095486,
+                "VerifiedOn": 0,
+                "QuiteJob": 1
+            }
+        ],
+        "Offset": 0,
+        "Limit": 20,
+        "TotalCount": 2,
+        "RequestId": "4ab55898-527c-47d1-a2bd-79b81471b563"
     }
 }
 ```