tccli 3.0.1086.1__py2.py3-none-any.whl → 3.0.1088.1__py2.py3-none-any.whl

tccli/examples/ess/v20201111/DescribeIntegrationEmployees.md

@@ -1,9 +1,7 @@
-**Example 1: 查询员工列表（查询已实名员工列表）**
+**Example 1: 错误示例-参数不合法**
 
-查询已实名员工列表
-1. Filter参数Key设置为"Status";
-2. Filter参数Values设置为"IsVerified"，表示查询已实名员工；
-3. 设置Limit和Offset参数，从首页开始，每页查询20条数据返回。
+在使用此接口时，需要按照入参描述进行相应的设置，以确保参数的合法性。如果参数设置不合法，此接口将返回错误信息。
+1. 将Limit参数设置为21，超过最大值20。
 
 Input: 
 
@@ -12,7 +10,7 @@ tccli ess DescribeIntegrationEmployees --cli-unfold-argument  \
     --Operator.UserId 11234********************678901 \
     --Filters.0.Key Status \
     --Filters.0.Values IsVerified \
-    --Limit 20 \
+    --Limit 21 \
     --Offset 0
 ```
 
@@ -20,68 +18,11 @@ Output:
 ```
 {
     "Response": {
-        "Employees": [
-            {
-                "CreatedOn": 1658114069,
-                "Department": {
-                    "DepartmentId": "dp**********************155f2",
-                    "DepartmentName": "测试企业"
-                },
-                "DisplayName": "张三",
-                "Email": "",
-                "Mobile": "13300001233",
-                "OpenId": "",
-                "QuiteJob": 0,
-                "ReceiveOpenId": "",
-                "ReceiveUserId": "",
-                "Roles": [
-                    {
-                        "RoleId": "ea4ab3******************a6902",
-                        "RoleName": "法人"
-                    },
-                    {
-                        "RoleId": "9b7d******************cf8e9",
-                        "RoleName": "业务员"
-                    },
-                    {
-                        "RoleId": "4dff1******************10b",
-                        "RoleName": "企业员工"
-                    }
-                ],
-                "UserId": "yDRt******************BKpnZs",
-                "Verified": true,
-                "VerifiedOn": 1658114065,
-                "WeworkOpenId": ""
-            },
-            {
-                "CreatedOn": 1658114000,
-                "Department": {
-                    "DepartmentId": "dp**********************155f2",
-                    "DepartmentName": "测试企业"
-                },
-                "DisplayName": "李四",
-                "Email": "",
-                "Mobile": "13500001234",
-                "OpenId": "",
-                "QuiteJob": 0,
-                "ReceiveOpenId": "",
-                "ReceiveUserId": "",
-                "Roles": [
-                    {
-                        "RoleId": "4fcbf3******************ea6c63",
-                        "RoleName": "超级管理员"
-                    }
-                ],
-                "UserId": "yDwJ******************BGQyov",
-                "Verified": true,
-                "VerifiedOn": 1658114066,
-                "WeworkOpenId": ""
-            }
-        ],
-        "Limit": 20,
-        "Offset": 0,
-        "RequestId": "s1663******************195",
-        "TotalCount": 2
+        "Error": {
+            "Code": "InvalidParameter.ParamError",
+            "Message": "参数Limit不正确"
+        },
+        "RequestId": "3b506b8a-xxxx-xxxx-xxxx-xxxxx9eaaadd"
     }
 }
 ```
@@ -154,10 +95,12 @@ Output:
 }
 ```
 
-**Example 3: 错误示例-参数不合法**
+**Example 3: 查询员工列表（查询已实名员工列表）**
 
-在使用此接口时，需要按照入参描述进行相应的设置，以确保参数的合法性。如果参数设置不合法，此接口将返回错误信息。
-1. 将Limit参数设置为21，超过最大值20。
+查询已实名员工列表
+1. Filter参数Key设置为"Status";
+2. Filter参数Values设置为"IsVerified"，表示查询已实名员工；
+3. 设置Limit和Offset参数，从首页开始，每页查询20条数据返回。
 
 Input: 
 
@@ -166,7 +109,7 @@ tccli ess DescribeIntegrationEmployees --cli-unfold-argument  \
     --Operator.UserId 11234********************678901 \
     --Filters.0.Key Status \
     --Filters.0.Values IsVerified \
-    --Limit 21 \
+    --Limit 20 \
     --Offset 0
 ```
 
@@ -174,11 +117,68 @@ Output:
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "InvalidParameter.ParamError",
-            "Message": "参数Limit不正确"
-        },
-        "RequestId": "3b506b8a-xxxx-xxxx-xxxx-xxxxx9eaaadd"
+        "Employees": [
+            {
+                "CreatedOn": 1658114069,
+                "Department": {
+                    "DepartmentId": "dp**********************155f2",
+                    "DepartmentName": "测试企业"
+                },
+                "DisplayName": "张三",
+                "Email": "",
+                "Mobile": "13300001233",
+                "OpenId": "",
+                "QuiteJob": 0,
+                "ReceiveOpenId": "",
+                "ReceiveUserId": "",
+                "Roles": [
+                    {
+                        "RoleId": "ea4ab3******************a6902",
+                        "RoleName": "法人"
+                    },
+                    {
+                        "RoleId": "9b7d******************cf8e9",
+                        "RoleName": "业务员"
+                    },
+                    {
+                        "RoleId": "4dff1******************10b",
+                        "RoleName": "企业员工"
+                    }
+                ],
+                "UserId": "yDRt******************BKpnZs",
+                "Verified": true,
+                "VerifiedOn": 1658114065,
+                "WeworkOpenId": ""
+            },
+            {
+                "CreatedOn": 1658114000,
+                "Department": {
+                    "DepartmentId": "dp**********************155f2",
+                    "DepartmentName": "测试企业"
+                },
+                "DisplayName": "李四",
+                "Email": "",
+                "Mobile": "13500001234",
+                "OpenId": "",
+                "QuiteJob": 0,
+                "ReceiveOpenId": "",
+                "ReceiveUserId": "",
+                "Roles": [
+                    {
+                        "RoleId": "4fcbf3******************ea6c63",
+                        "RoleName": "超级管理员"
+                    }
+                ],
+                "UserId": "yDwJ******************BGQyov",
+                "Verified": true,
+                "VerifiedOn": 1658114066,
+                "WeworkOpenId": ""
+            }
+        ],
+        "Limit": 20,
+        "Offset": 0,
+        "RequestId": "s1663******************195",
+        "TotalCount": 2
     }
 }
 ```

tccli/examples/ess/v20201111/ModifyApplicationCallbackInfo.md

@@ -1,13 +1,13 @@
-**Example 1: 删除不存在的应用回调配置失败**
+**Example 1: 删除应用回调配置**
 
-删除应用回调配置，对应的回调地址不存在，返回失败
+删除应用回调配置，成功只会返回RequestId
 
 Input: 
 
 ```
 tccli ess ModifyApplicationCallbackInfo --cli-unfold-argument  \
     --Operator.UserId y******************g \
-    --CallbackInfo.CallbackUrl https://yy.qq.com/ \
+    --CallbackInfo.CallbackUrl https://y.qq.com/ \
     --OperateType 2
 ```
 
@@ -15,18 +15,14 @@ Output:
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "FailedOperation",
-            "Message": "当前配置不存在"
-        },
-        "RequestId": "s169*****2"
+        "RequestId": "s1*****9"
     }
 }
 ```
 
-**Example 2: 删除应用回调配置**
+**Example 2: 新增应用回调配置**
 
-删除应用回调配置，成功只会返回RequestId
+新增一条应用回调配置，成功只会返回RequestId
 
 Input: 
 
@@ -34,7 +30,9 @@ Input:
 tccli ess ModifyApplicationCallbackInfo --cli-unfold-argument  \
     --Operator.UserId y******************g \
     --CallbackInfo.CallbackUrl https://y.qq.com/ \
-    --OperateType 2
+    --CallbackInfo.CallbackKey A******************B \
+    --CallbackInfo.CallbackToken A********C \
+    --OperateType 1
 ```
 
 Output: 
@@ -46,26 +44,28 @@ Output:
 }
 ```
 
-**Example 3: 新增应用回调配置**
+**Example 3: 删除不存在的应用回调配置失败**
 
-新增一条应用回调配置，成功只会返回RequestId
+删除应用回调配置，对应的回调地址不存在，返回失败
 
 Input: 
 
 ```
 tccli ess ModifyApplicationCallbackInfo --cli-unfold-argument  \
     --Operator.UserId y******************g \
-    --CallbackInfo.CallbackUrl https://y.qq.com/ \
-    --CallbackInfo.CallbackKey A******************B \
-    --CallbackInfo.CallbackToken A********C \
-    --OperateType 1
+    --CallbackInfo.CallbackUrl https://yy.qq.com/ \
+    --OperateType 2
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "RequestId": "s1*****9"
+        "Error": {
+            "Code": "FailedOperation",
+            "Message": "当前配置不存在"
+        },
+        "RequestId": "s169*****2"
     }
 }
 ```

tccli/examples/ess/v20201111/ModifyFlowDeadline.md

@@ -1,98 +1,98 @@
-**Example 1: 延期整个合同-合同发起时有签署人单独设置了签署截止时间**
+**Example 1: 延期签署方的签署截止时间**
 
-1.合同发起时设置合同截止时间为1704988032，该合同有3个签署人A，B，C
-2.合同发起时A签署人设置签署截止时间为1704978032，B，C签署人未单独设置签署人截止时间（默认和合同保持一致）
-3.通过接口对整个合同延期后，A签署人截止时间不变（还是1704978032），B，C签署人的签署截止时间和合同截止时间延期为1705977064
+1.将签署流程yDCNtUUckpvrezq3UudRJ1LEXDLa8Lga 中 签署人角色编号 yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw7 对应的签署人设置的签署截止时间延长到1705976964
 
 Input: 
 
 ```
 tccli ess ModifyFlowDeadline --cli-unfold-argument  \
     --Operator.UserId yDRt2UUgygqxyp7yUuO5zjEwqXwsIljA \
-    --FlowId yDCNtUUckpvrcvf4UELZnZDvMStFgT7K \
-    --Deadline 1705977064
+    --FlowId yDCNtUUckpvrezq3UudRJ1LEXDLa8Lga \
+    --Deadline 1705976964 \
+    --RecipientId yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw7
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "RequestId": "s1705924585583461781"
+        "RequestId": "s1705924585583461780"
     }
 }
 ```
 
-**Example 2: 延期整个合同-合同发起时没有签署人设置签署人签署截止时间**
+**Example 2: 延期签署方的签署截止时间失败-签署流程已过期**
 
-1.合同发起时设置合同截止时间为1704988032，该合同有3个签署人A，B，C
-2.合同发起时并未为签署人未单独设置签署人截止时间（默认和合同保持一致）
-3.通过接口对整个合同延期后，A，B，C签署人的签署截止时间和合同截止时间延期为1705977064
+1.将签署流程yDCNtUUckpvrezq3UudRJ1LEXDLa9Lga中 签署人角色编号yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw8 对应的签署人设置的签署截止时间延长到1705976980
+2.此时合同已经过期，无法操作
 
 Input: 
 
 ```
 tccli ess ModifyFlowDeadline --cli-unfold-argument  \
     --Operator.UserId yDRt2UUgygqxyp7yUuO5zjEwqXwsIljA \
-    --FlowId yDCNtUUckpvrcvf4UELZnZDvMStFgT7K \
-    --Deadline 1705977064
+    --FlowId yDCNtUUckpvrezq3UudRJ1LEXDLa9Lga \
+    --Deadline 1705976980 \
+    --RecipientId yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw8
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "RequestId": "s1705924585583461781"
+        "Error": {
+            "Code": "FailedOperation",
+            "Message": "此签署流程已经终止，当前处于流程已经过期状态，无法进行延期操作，请确认后重试"
+        },
+        "RequestId": "s1705991274996790452"
     }
 }
 ```
 
-**Example 3: 延期签署方的签署截止时间**
+**Example 3: 延期整个合同-合同发起时有签署人单独设置了签署截止时间**
 
-1.将签署流程yDCNtUUckpvrezq3UudRJ1LEXDLa8Lga 中 签署人角色编号 yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw7 对应的签署人设置的签署截止时间延长到1705976964
+1.合同发起时设置合同截止时间为1704988032，该合同有3个签署人A，B，C
+2.合同发起时A签署人设置签署截止时间为1704978032，B，C签署人未单独设置签署人截止时间（默认和合同保持一致）
+3.通过接口对整个合同延期后，A签署人截止时间不变（还是1704978032），B，C签署人的签署截止时间和合同截止时间延期为1705977064
 
 Input: 
 
 ```
 tccli ess ModifyFlowDeadline --cli-unfold-argument  \
     --Operator.UserId yDRt2UUgygqxyp7yUuO5zjEwqXwsIljA \
-    --FlowId yDCNtUUckpvrezq3UudRJ1LEXDLa8Lga \
-    --Deadline 1705976964 \
-    --RecipientId yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw7
+    --FlowId yDCNtUUckpvrcvf4UELZnZDvMStFgT7K \
+    --Deadline 1705977064
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "RequestId": "s1705924585583461780"
+        "RequestId": "s1705924585583461781"
     }
 }
 ```
 
-**Example 4: 延期签署方的签署截止时间失败-签署流程已过期**
+**Example 4: 延期整个合同-合同发起时没有签署人设置签署人签署截止时间**
 
-1.将签署流程yDCNtUUckpvrezq3UudRJ1LEXDLa9Lga中 签署人角色编号yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw8 对应的签署人设置的签署截止时间延长到1705976980
-2.此时合同已经过期，无法操作
+1.合同发起时设置合同截止时间为1704988032，该合同有3个签署人A，B，C
+2.合同发起时并未为签署人未单独设置签署人截止时间（默认和合同保持一致）
+3.通过接口对整个合同延期后，A，B，C签署人的签署截止时间和合同截止时间延期为1705977064
 
 Input: 
 
 ```
 tccli ess ModifyFlowDeadline --cli-unfold-argument  \
     --Operator.UserId yDRt2UUgygqxyp7yUuO5zjEwqXwsIljA \
-    --FlowId yDCNtUUckpvrezq3UudRJ1LEXDLa9Lga \
-    --Deadline 1705976980 \
-    --RecipientId yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw8
+    --FlowId yDCNtUUckpvrcvf4UELZnZDvMStFgT7K \
+    --Deadline 1705977064
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "FailedOperation",
-            "Message": "此签署流程已经终止，当前处于流程已经过期状态，无法进行延期操作，请确认后重试"
-        },
-        "RequestId": "s1705991274996790452"
+        "RequestId": "s1705924585583461781"
     }
 }
 ```

tccli/examples/ess/v20201111/ModifyIntegrationRole.md

@@ -23,31 +23,7 @@ Output:
 }
 ```
 
-**Example 2: 示例-普通企业更新角色（不带权限树参数）**
-
-示例-普通企业更新角色（不带权限树参数）
-
-Input: 
-
-```
-tccli ess ModifyIntegrationRole --cli-unfold-argument  \
-    --RoleId abc \
-    --Name 业务员角色 \
-    --Description 这是角色描述信息 \
-    --Operator.UserId y******************5
-```
-
-Output: 
-```
-{
-    "Response": {
-        "RoleId": "abc",
-        "RequestId": "abc"
-    }
-}
-```
-
-**Example 3: 示例-普通企业更新角色（带权限树参数）**
+**Example 2: 示例-普通企业更新角色（带权限树参数）**
 
 更新角色并同时设置角色中的权限内容，设置权限树参数 PermissionGroups ，PermissionGroups 展开为树形结构，可以需要的权限节点下将 IsChecked 属性设置为true。
 注意：父权限节点 IsChecked 属性为true，则需要将其下所有子节点的 IsChecked属性同时设置为true，否则校验不通过。
@@ -1242,3 +1218,27 @@ Output:
 }
 ```
 
+**Example 3: 示例-普通企业更新角色（不带权限树参数）**
+
+示例-普通企业更新角色（不带权限树参数）
+
+Input: 
+
+```
+tccli ess ModifyIntegrationRole --cli-unfold-argument  \
+    --RoleId abc \
+    --Name 业务员角色 \
+    --Description 这是角色描述信息 \
+    --Operator.UserId y******************5
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RoleId": "abc",
+        "RequestId": "abc"
+    }
+}
+```
+

tccli/examples/ess/v20201111/StartFlow.md

@@ -1,48 +1,48 @@
-**Example 1: 启动签署流程-电子文档尚未准备好**
+**Example 1: 正常启动签署流程**
 
-在调用此接口时，若流程电子文档尚未准备就绪，将返回相关错误信息。
-在此状态下，可以进行重试。
-通常建议在调用创建签署流程电子文档接口后等待3秒，再调用此接口以启动签署流程。
+启动签署流程
 
 Input: 
 
 ```
 tccli ess StartFlow --cli-unfold-argument  \
-    --Operator.UserId yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc \
-    --FlowId yDRS4UUgygqdcjjtUuO4zjESYiOVONL1
+    --Operator.UserId yDxZ1UyKQDSIMaUuO5zjEypPWudeHbnG \
+    --FlowId yDwJ0UUckpk2071xUxgm9jJEvuhEhqD7
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "OperationDenied.DocumentNoAvailable",
-            "Message": "电子文档不可用，请稍后重试。"
-        },
-        "RequestId": "uO4zjEwxRFIf8q1"
+        "Status": "START",
+        "RequestId": "xgm9jJv5GGyJXCh"
     }
 }
 ```
 
-**Example 2: 正常启动签署流程**
+**Example 2: 启动签署流程-电子文档尚未准备好**
 
-启动签署流程
+在调用此接口时，若流程电子文档尚未准备就绪，将返回相关错误信息。
+在此状态下，可以进行重试。
+通常建议在调用创建签署流程电子文档接口后等待3秒，再调用此接口以启动签署流程。
 
 Input: 
 
 ```
 tccli ess StartFlow --cli-unfold-argument  \
-    --Operator.UserId yDxZ1UyKQDSIMaUuO5zjEypPWudeHbnG \
-    --FlowId yDwJ0UUckpk2071xUxgm9jJEvuhEhqD7
+    --Operator.UserId yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc \
+    --FlowId yDRS4UUgygqdcjjtUuO4zjESYiOVONL1
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "Status": "START",
-        "RequestId": "xgm9jJv5GGyJXCh"
+        "Error": {
+            "Code": "OperationDenied.DocumentNoAvailable",
+            "Message": "电子文档不可用，请稍后重试。"
+        },
+        "RequestId": "uO4zjEwxRFIf8q1"
     }
 }
 ```

tccli/examples/ess/v20201111/UnbindEmployeeUserIdWithClientOpenId.md

@@ -1,13 +1,13 @@
-**Example 1: 解除员工UserId与客户系统OpenId的绑定**
+**Example 1: 错误示例-OpenId未经过绑定**
 
-传入经过绑定的员工UserId与客户系统OpenId，调用此接口解绑成功，返回值Status为1。
+在调用此接口时，需确保OpenId已通过调用<a href="https://qian.tencent.com/developers/companyApis/staffs/BindEmployeeUserIdWithClientOpenId" target="_blank">BindEmployeeUserIdWithClientOpenId</a>接口与电子签系统的UserId绑定过。
 
 Input: 
 
 ```
 tccli ess UnbindEmployeeUserIdWithClientOpenId --cli-unfold-argument  \
     --Operator.UserId yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc \
-    --UserId yDxbNUyKQDxGYNUuO4zjEwvl3XYQmAcO \
+    --UserId yDwJ0UUckpk2077eUxgm9jJv5GGyJXCh \
     --OpenId n9527
 ```
 
@@ -15,22 +15,25 @@ Output:
 ```
 {
     "Response": {
-        "RequestId": "s1665674603446404796",
-        "Status": 1
+        "Error": {
+            "Code": "InvalidParameter",
+            "Message": "该openId并未绑定企业员工"
+        },
+        "RequestId": "s1615674603446404796"
     }
 }
 ```
 
-**Example 2: 错误示例-OpenId未经过绑定**
+**Example 2: 解除员工UserId与客户系统OpenId的绑定**
 
-在调用此接口时，需确保OpenId已通过调用<a href="https://qian.tencent.com/developers/companyApis/staffs/BindEmployeeUserIdWithClientOpenId" target="_blank">BindEmployeeUserIdWithClientOpenId</a>接口与电子签系统的UserId绑定过。
+传入经过绑定的员工UserId与客户系统OpenId，调用此接口解绑成功，返回值Status为1。
 
 Input: 
 
 ```
 tccli ess UnbindEmployeeUserIdWithClientOpenId --cli-unfold-argument  \
     --Operator.UserId yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc \
-    --UserId yDwJ0UUckpk2077eUxgm9jJv5GGyJXCh \
+    --UserId yDxbNUyKQDxGYNUuO4zjEwvl3XYQmAcO \
     --OpenId n9527
 ```
 
@@ -38,11 +41,8 @@ Output:
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "InvalidParameter",
-            "Message": "该openId并未绑定企业员工"
-        },
-        "RequestId": "s1615674603446404796"
+        "RequestId": "s1665674603446404796",
+        "Status": 1
     }
 }
 ```