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

tccli/examples/ess/v20201111/CreateFlowSignUrl.md

@@ -31,20 +31,19 @@ Output:
 }
 ```
 
-**Example 2: 创建个人用户H5签署链接(签署完成后跳转到指定地址)**
+**Example 2: 创建企业用户H5签署链接**
 
-1. 给个人用户创建签署链接
-2. 签署完成后跳转到指定页面地址(设置跳转地址JumpUrl)
+发起流程后，给其中的B端签署人创建签署链接
 
 Input: 
 
 ```
 tccli ess CreateFlowSignUrl --cli-unfold-argument  \
     --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj \
-    --FlowApproverInfos.0.ApproverType 1 \
+    --FlowApproverInfos.0.ApproverType 0 \
     --FlowApproverInfos.0.ApproverMobile 13200000000 \
     --FlowApproverInfos.0.ApproverName 典子谦 \
-    --JumpUrl https://www.example.com \
+    --FlowApproverInfos.0.OrganizationName ***有限公司 \
     --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
 ```
 
@@ -56,8 +55,8 @@ Output:
             {
                 "ApproverMobile": "13200000000",
                 "ApproverName": "典子谦",
-                "ApproverType": 1,
-                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=MioqKi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=1&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
+                "ApproverType": 0,
+                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=0&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
                 "SignUrl": "https://essurl.cn/bR8**HA"
             }
         ],
@@ -66,19 +65,20 @@ Output:
 }
 ```
 
-**Example 3: 错误示例-创建个人用户签署链接，传错签署人姓名**
+**Example 3: 创建企业用户H5预览链接**
 
-1. 给个人用户创建签署链接
-2. 用户姓名不是合同的参与人
+发起流程后，给其中的B端签署人创建预览链接
 
 Input: 
 
 ```
 tccli ess CreateFlowSignUrl --cli-unfold-argument  \
     --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj \
-    --FlowApproverInfos.0.ApproverType 1 \
+    --FlowApproverInfos.0.ApproverType 0 \
     --FlowApproverInfos.0.ApproverMobile 13200000000 \
-    --FlowApproverInfos.0.ApproverName 张三 \
+    --FlowApproverInfos.0.ApproverName 典子谦 \
+    --FlowApproverInfos.0.OrganizationName ***有限公司 \
+    --UrlType 1 \
     --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
 ```
 
@@ -86,28 +86,30 @@ Output:
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "ResourceNotFound",
-            "Message": "无法找到参与人"
-        },
-        "RequestId": "s1693832578941223891"
+        "FlowApproverUrlInfos": [
+            {
+                "ApproverMobile": "13200000000",
+                "ApproverName": "典子谦",
+                "ApproverType": 0,
+                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=0&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
+                "SignUrl": "https://essurl.cn/bR8**HA"
+            }
+        ],
+        "RequestId": "s1693832180480950012"
     }
 }
 ```
 
-**Example 4: 错误示例-创建个人用户签署链接，该用户还有些控件需要填写**
+**Example 4: 创建合同发起方预览链接**
 
-1. 给个人用户创建签署链接
-2. 该个人用户除了签署控件，还有填写控件需要补充
+发起流程后，给其中的合同发起方创建预览链接
 
 Input: 
 
 ```
 tccli ess CreateFlowSignUrl --cli-unfold-argument  \
     --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj \
-    --FlowApproverInfos.0.ApproverType 1 \
-    --FlowApproverInfos.0.ApproverMobile 13200000000 \
-    --FlowApproverInfos.0.ApproverName 典子谦 \
+    --UrlType 1 \
     --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
 ```
 
@@ -115,28 +117,36 @@ Output:
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "FailedOperation",
-            "Message": "该用户有暂不支持H5端的控件，请删除后重新发起流程"
-        },
-        "RequestId": "s1693901602090298421"
+        "FlowApproverUrlInfos": [
+            {
+                "ApproverMobile": "",
+                "ApproverName": "",
+                "ApproverType": 0,
+                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&PreviewType=2&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
+                "SignUrl": "https://essurl.cn/bR8**HA"
+            }
+        ],
+        "RequestId": "s1693832180480950012"
     }
 }
 ```
 
-**Example 5: 创建企业用户H5签署链接**
+**Example 5: 创建个人用户H5签署链接，使用视频认证方式**
 
-发起流程后，给其中的B端签署人创建签署链接
+发起流程后，给其中的C端签署人创建签署链接，并且使用视频认证方式
 
 Input: 
 
 ```
 tccli ess CreateFlowSignUrl --cli-unfold-argument  \
     --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj \
-    --FlowApproverInfos.0.ApproverType 0 \
+    --FlowApproverInfos.0.ApproverType 1 \
     --FlowApproverInfos.0.ApproverMobile 13200000000 \
     --FlowApproverInfos.0.ApproverName 典子谦 \
-    --FlowApproverInfos.0.OrganizationName ***有限公司 \
+    --FlowApproverInfos.0.ApproverSignTypes 1 \
+    --FlowApproverInfos.0.Intention.IntentionType 1 \
+    --FlowApproverInfos.0.Intention.IntentionQuestions.0.Question 请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。 \
+    --FlowApproverInfos.0.Intention.IntentionQuestions.0.Answers 同意 我同意 \
     --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
 ```
 
@@ -148,8 +158,8 @@ Output:
             {
                 "ApproverMobile": "13200000000",
                 "ApproverName": "典子谦",
-                "ApproverType": 0,
-                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=0&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
+                "ApproverType": 1,
+                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=1&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
                 "SignUrl": "https://essurl.cn/bR8**HA"
             }
         ],
@@ -158,20 +168,19 @@ Output:
 }
 ```
 
-**Example 6: 创建企业用户H5预览链接**
+**Example 6: 错误示例-创建个人用户签署链接，传错签署人姓名**
 
-发起流程后，给其中的B端签署人创建预览链接
+1. 给个人用户创建签署链接
+2. 用户姓名不是合同的参与人
 
 Input: 
 
 ```
 tccli ess CreateFlowSignUrl --cli-unfold-argument  \
     --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj \
-    --FlowApproverInfos.0.ApproverType 0 \
+    --FlowApproverInfos.0.ApproverType 1 \
     --FlowApproverInfos.0.ApproverMobile 13200000000 \
-    --FlowApproverInfos.0.ApproverName 典子谦 \
-    --FlowApproverInfos.0.OrganizationName ***有限公司 \
-    --UrlType 1 \
+    --FlowApproverInfos.0.ApproverName 张三 \
     --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
 ```
 
@@ -179,30 +188,29 @@ Output:
 ```
 {
     "Response": {
-        "FlowApproverUrlInfos": [
-            {
-                "ApproverMobile": "13200000000",
-                "ApproverName": "典子谦",
-                "ApproverType": 0,
-                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=0&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
-                "SignUrl": "https://essurl.cn/bR8**HA"
-            }
-        ],
-        "RequestId": "s1693832180480950012"
+        "Error": {
+            "Code": "ResourceNotFound",
+            "Message": "无法找到参与人"
+        },
+        "RequestId": "s1693832578941223891"
     }
 }
 ```
 
-**Example 7: 创建合同发起方预览链接**
+**Example 7: 创建个人用户H5签署链接(签署完成后跳转到指定地址)**
 
-发起流程后，给其中的合同发起方创建预览链接
+1. 给个人用户创建签署链接
+2. 签署完成后跳转到指定页面地址(设置跳转地址JumpUrl)
 
 Input: 
 
 ```
 tccli ess CreateFlowSignUrl --cli-unfold-argument  \
     --Operator.UserId yDRCLUUgygq2xun5UuO4zjEwg0vjoimj \
-    --UrlType 1 \
+    --FlowApproverInfos.0.ApproverType 1 \
+    --FlowApproverInfos.0.ApproverMobile 13200000000 \
+    --FlowApproverInfos.0.ApproverName 典子谦 \
+    --JumpUrl https://www.example.com \
     --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
 ```
 
@@ -212,10 +220,10 @@ Output:
     "Response": {
         "FlowApproverUrlInfos": [
             {
-                "ApproverMobile": "",
-                "ApproverName": "",
-                "ApproverType": 0,
-                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&PreviewType=2&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
+                "ApproverMobile": "13200000000",
+                "ApproverName": "典子谦",
+                "ApproverType": 1,
+                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=MioqKi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=1&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
                 "SignUrl": "https://essurl.cn/bR8**HA"
             }
         ],
@@ -224,9 +232,10 @@ Output:
 }
 ```
 
-**Example 8: 创建个人用户H5签署链接，使用视频认证方式**
+**Example 8: 错误示例-创建个人用户签署链接，该用户还有些控件需要填写**
 
-发起流程后，给其中的C端签署人创建签署链接，并且使用视频认证方式
+1. 给个人用户创建签署链接
+2. 该个人用户除了签署控件，还有填写控件需要补充
 
 Input: 
 
@@ -236,10 +245,6 @@ tccli ess CreateFlowSignUrl --cli-unfold-argument  \
     --FlowApproverInfos.0.ApproverType 1 \
     --FlowApproverInfos.0.ApproverMobile 13200000000 \
     --FlowApproverInfos.0.ApproverName 典子谦 \
-    --FlowApproverInfos.0.ApproverSignTypes 1 \
-    --FlowApproverInfos.0.Intention.IntentionType 1 \
-    --FlowApproverInfos.0.Intention.IntentionQuestions.0.Question 请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。 \
-    --FlowApproverInfos.0.Intention.IntentionQuestions.0.Answers 同意 我同意 \
     --FlowId yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
 ```
 
@@ -247,16 +252,11 @@ Output:
 ```
 {
     "Response": {
-        "FlowApproverUrlInfos": [
-            {
-                "ApproverMobile": "13200000000",
-                "ApproverName": "典子谦",
-                "ApproverType": 1,
-                "LongUrl": "https://quick.test.qian.tencent.cn/home?ApproverIdCardNumber=Mi**Kio2&ApproverMobile=MTk***NjA%3D&ApproverName=%25**A&ApproverType=1&Code=yDwJCUUck****V2R5K&CodeType=QUICK&FlowId=yDwF**1f3cqjkGm&ShowHeader=1&shortKey=yDwq5**M5GlG1c&token=bR8**HA",
-                "SignUrl": "https://essurl.cn/bR8**HA"
-            }
-        ],
-        "RequestId": "s1693832180480950012"
+        "Error": {
+            "Code": "FailedOperation",
+            "Message": "该用户有暂不支持H5端的控件，请删除后重新发起流程"
+        },
+        "RequestId": "s1693901602090298421"
     }
 }
 ```

tccli/examples/ess/v20201111/CreateIntegrationDepartment.md

@@ -23,16 +23,17 @@ Output:
 }
 ```
 
-**Example 2: 创建部门-不指定父部门ID**
+**Example 2: 错误示例-参数不合法**
 
-创建部门，不指定父部门ID，部门被创建至根部门节点下。
+调用此接口时，需要按照入参描述进行相应的设置，以确保参数的合法性。如果参数设置不合法，接口将返回错误信息。
 
 Input: 
 
 ```
 tccli ess CreateIntegrationDepartment --cli-unfold-argument  \
     --Operator.UserId yDwgKUUc************QZDRuD \
-    --DeptName 运营部 \
+    --DeptName 运营部11111111111111111111111111111111111111111111111111111 \
+    --ParentDeptId yDwgIUUckp1g**********E8xOm12b9 \
     --DeptOpenId open_dept2 \
     --OrderNo 1
 ```
@@ -41,15 +42,18 @@ Output:
 ```
 {
     "Response": {
-        "DeptId": "yDwgIUUckp1g********E8xOm1567",
-        "RequestId": "s1679*****21175"
+        "Error": {
+            "Code": "InvalidParameter.ParamError",
+            "Message": "部门名称请控制在50个字符以内"
+        },
+        "RequestId": "914axxxx-xxxx-xxxx-xxxx-xxxxxxxx70123"
     }
 }
 ```
 
-**Example 3: 创建部门-同时指定第三方平台与电子签父部门ID**
+**Example 3: 创建部门-不指定父部门ID**
 
-创建部门，同时指定第三方平台与电子签父部门ID，系统优先使用电子签平台部门ID。
+创建部门，不指定父部门ID，部门被创建至根部门节点下。
 
 Input: 
 
@@ -57,8 +61,6 @@ Input:
 tccli ess CreateIntegrationDepartment --cli-unfold-argument  \
     --Operator.UserId yDwgKUUc************QZDRuD \
     --DeptName 运营部 \
-    --ParentDeptId yDwgIUUckp1g**********E8xOm12b9 \
-    --ParentDeptOpenId dept_1 \
     --DeptOpenId open_dept2 \
     --OrderNo 1
 ```
@@ -73,17 +75,18 @@ Output:
 }
 ```
 
-**Example 4: 错误示例-参数不合法**
+**Example 4: 创建部门-同时指定第三方平台与电子签父部门ID**
 
-调用此接口时，需要按照入参描述进行相应的设置，以确保参数的合法性。如果参数设置不合法，接口将返回错误信息。
+创建部门，同时指定第三方平台与电子签父部门ID，系统优先使用电子签平台部门ID。
 
 Input: 
 
 ```
 tccli ess CreateIntegrationDepartment --cli-unfold-argument  \
     --Operator.UserId yDwgKUUc************QZDRuD \
-    --DeptName 运营部11111111111111111111111111111111111111111111111111111 \
+    --DeptName 运营部 \
     --ParentDeptId yDwgIUUckp1g**********E8xOm12b9 \
+    --ParentDeptOpenId dept_1 \
     --DeptOpenId open_dept2 \
     --OrderNo 1
 ```
@@ -92,11 +95,8 @@ Output:
 ```
 {
     "Response": {
-        "Error": {
-            "Code": "InvalidParameter.ParamError",
-            "Message": "部门名称请控制在50个字符以内"
-        },
-        "RequestId": "914axxxx-xxxx-xxxx-xxxx-xxxxxxxx70123"
+        "DeptId": "yDwgIUUckp1g********E8xOm1567",
+        "RequestId": "s1679*****21175"
     }
 }
 ```

tccli/examples/ess/v20201111/CreateIntegrationEmployees.md

@@ -1,4 +1,42 @@
-**Example 1: 创建员工-企微员工**
+**Example 1: H5端添加企业员工**
+
+企业员工未认证， 在H5端， 用户通过生成链接嵌入到小程序，进行加入，实名
+
+Input: 
+
+```
+tccli ess CreateIntegrationEmployees --cli-unfold-argument  \
+    --Operator.UserId yDwf3UUckps8dvypUEfH3DjwIpMfa0uw \
+    --Employees.0.DisplayName 典子谦 \
+    --Employees.0.Mobile 13200000000 \
+    --Employees.0.OpenId n9527 \
+    --InvitationNotifyType H5 \
+    --JumpUrl https://www.qq.com
+```
+
+Output: 
+```
+{
+    "Response": {
+        "CreateEmployeeResult": {
+            "FailedEmployeeData": [],
+            "SuccessEmployeeData": [
+                {
+                    "DisplayName": "典子谦",
+                    "Mobile": "13200000000",
+                    "Note": "",
+                    "UserId": "yDCNCUUckpv0ox66UC7yFOvFzax82lgp",
+                    "Url": "https://test.essurl.cn/TxHxUBCx0G",
+                    "WeworkOpenId": ""
+                }
+            ]
+        },
+        "RequestId": "e01a9584-4b91-45dd-9a7b-46d32c4099fd"
+    }
+}
+```
+
+**Example 2: 创建员工-企微员工**
 
 创建企微企业员工，只需传入WeworkOpenId参数即可。
 
@@ -31,7 +69,7 @@ Output:
 }
 ```
 
-**Example 2: 创建员工-非企微员工**
+**Example 3: 创建员工-非企微员工**
 
 创建非企微企业的员工，传入必填参数即可。
 
@@ -64,7 +102,7 @@ Output:
 }
 ```
 
-**Example 3: 错误示例-入参不合法**
+**Example 4: 错误示例-入参不合法**
 
 调用此接口时，需要按照入参描述进行相应的设置，以确保参数的合法性。如果参数设置不正确，会返回创建失败结果及原因。
 
@@ -98,41 +136,3 @@ Output:
 }
 ```
 
-**Example 4: H5端添加企业员工**
-
-企业员工未认证， 在H5端， 用户通过生成链接嵌入到小程序，进行加入，实名
-
-Input: 
-
-```
-tccli ess CreateIntegrationEmployees --cli-unfold-argument  \
-    --Operator.UserId yDwf3UUckps8dvypUEfH3DjwIpMfa0uw \
-    --Employees.0.DisplayName 典子谦 \
-    --Employees.0.Mobile 13200000000 \
-    --Employees.0.OpenId n9527 \
-    --InvitationNotifyType H5 \
-    --JumpUrl https://www.qq.com
-```
-
-Output: 
-```
-{
-    "Response": {
-        "CreateEmployeeResult": {
-            "FailedEmployeeData": [],
-            "SuccessEmployeeData": [
-                {
-                    "DisplayName": "典子谦",
-                    "Mobile": "13200000000",
-                    "Note": "",
-                    "UserId": "yDCNCUUckpv0ox66UC7yFOvFzax82lgp",
-                    "Url": "https://test.essurl.cn/TxHxUBCx0G",
-                    "WeworkOpenId": ""
-                }
-            ]
-        },
-        "RequestId": "e01a9584-4b91-45dd-9a7b-46d32c4099fd"
-    }
-}
-```
-

tccli/examples/ess/v20201111/CreateIntegrationRole.md

@@ -23,31 +23,7 @@ Output:
 }
 ```
 
-**Example 2: 示例-普通企业创建角色（不带权限树参数）**
-
-示例-普通企业创建角色（不带权限树参数）
-
-Input: 
-
-```
-tccli ess CreateIntegrationRole --cli-unfold-argument  \
-    --Name 业务员角色 \
-    --Description 这是角色描述信息 \
-    --IsGroupRole 0 \
-    --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 CreateIntegrationRole --cli-unfold-argument  \
+    --Name 业务员角色 \
+    --Description 这是角色描述信息 \
+    --IsGroupRole 0 \
+    --Operator.UserId y******************5
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RoleId": "abc",
+        "RequestId": "abc"
+    }
+}
+```
+