tccli 3.0.1203.1__py2.py3-none-any.whl → 3.0.1205.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/apm/v20210622/api.json +17 -17
  3. tccli/services/apm/v20210622/examples.json +1 -1
  4. tccli/services/cls/v20201016/api.json +12 -0
  5. tccli/services/cvm/v20170312/api.json +13 -1
  6. tccli/services/cynosdb/cynosdb_client.py +53 -0
  7. tccli/services/cynosdb/v20190107/api.json +108 -0
  8. tccli/services/cynosdb/v20190107/examples.json +8 -0
  9. tccli/services/ess/ess_client.py +106 -0
  10. tccli/services/ess/v20201111/api.json +239 -1
  11. tccli/services/ess/v20201111/examples.json +58 -0
  12. tccli/services/essbasic/essbasic_client.py +53 -0
  13. tccli/services/essbasic/v20210526/api.json +74 -0
  14. tccli/services/essbasic/v20210526/examples.json +14 -0
  15. tccli/services/lke/v20231130/api.json +1 -1
  16. tccli/services/mariadb/mariadb_client.py +57 -4
  17. tccli/services/mariadb/v20170312/api.json +64 -0
  18. tccli/services/mariadb/v20170312/examples.json +8 -0
  19. tccli/services/redis/v20180412/api.json +1 -1
  20. tccli/services/scf/v20180416/api.json +17 -7
  21. tccli/services/scf/v20180416/examples.json +3 -3
  22. tccli/services/sqlserver/v20180328/api.json +1 -1
  23. tccli/services/tcss/v20201101/api.json +9 -0
  24. tccli/services/vclm/v20240523/api.json +19 -0
  25. tccli/services/vpc/v20170312/api.json +7 -5
  26. tccli/services/vpc/v20170312/examples.json +1 -1
  27. tccli/services/waf/v20180125/api.json +336 -13
  28. tccli/services/waf/v20180125/examples.json +1 -1
  29. {tccli-3.0.1203.1.dist-info → tccli-3.0.1205.1.dist-info}/METADATA +2 -2
  30. {tccli-3.0.1203.1.dist-info → tccli-3.0.1205.1.dist-info}/RECORD +33 -33
  31. {tccli-3.0.1203.1.dist-info → tccli-3.0.1205.1.dist-info}/WHEEL +0 -0
  32. {tccli-3.0.1203.1.dist-info → tccli-3.0.1205.1.dist-info}/entry_points.txt +0 -0
  33. {tccli-3.0.1203.1.dist-info → tccli-3.0.1205.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,5 +1,12 @@
1
1
  {
2
2
  "actions": {
3
+ "ArchiveDynamicFlow": {
4
+ "document": "该接口用于结束动态签署流程,若当前合同还存在签署方未签署,无法结束。",
5
+ "input": "ArchiveDynamicFlowRequest",
6
+ "name": "结束动态签署合同",
7
+ "output": "ArchiveDynamicFlowResponse",
8
+ "status": "online"
9
+ },
3
10
  "BindEmployeeUserIdWithClientOpenId": {
4
11
  "document": "此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。\n\n此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用",
5
12
  "input": "BindEmployeeUserIdWithClientOpenIdRequest",
@@ -84,6 +91,13 @@
84
91
  "output": "CreateDocumentResponse",
85
92
  "status": "online"
86
93
  },
94
+ "CreateDynamicFlowApprover": {
95
+ "document": "此接口(CreateDynamicFlowApprover)用来补充动态合同的签署人信息。<br/>\n适用场景:使用CreateFlowByFiles指定:OpenDynamicSignFlow=true发起的合同,可以使用该接口补充后续签署人。<br/>",
96
+ "input": "CreateDynamicFlowApproverRequest",
97
+ "name": "补充动态签署合同的签署人信息",
98
+ "output": "CreateDynamicFlowApproverResponse",
99
+ "status": "online"
100
+ },
87
101
  "CreateEmbedWebUrl": {
88
102
  "document": "本接口(CreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:\n1. 创建印章\n2. 创建模板\n3. 修改模板\n4. 预览模板\n5. 预览合同流程\n\n预览模板的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)\n\n预览合同流程的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)",
89
103
  "input": "CreateEmbedWebUrlRequest",
@@ -787,7 +801,7 @@
787
801
  },
788
802
  {
789
803
  "disabled": false,
790
- "document": "签署方经办人的证件类型,支持以下类型,样式可以参考<a href=\"https://qian.tencent.com/developers/partner/id_card_support/\" target=\"_blank\">常见个人证件类型介绍</a>\n<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n\n\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
804
+ "document": "签署方经办人的证件类型,支持以下类型,样式可以参考<a href=\"https://qian.tencent.com/developers/partner/id_card_support/\" target=\"_blank\">常见个人证件类型介绍</a>\n<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n\n\n\n注: \n1. <b>其他证件类型为白名单功能</b>,使用前请联系对接的客户经理沟通。\n2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。",
791
805
  "example": "ID_CARD",
792
806
  "member": "string",
793
807
  "name": "ApproverIdCardType",
@@ -1083,6 +1097,99 @@
1083
1097
  ],
1084
1098
  "usage": "in"
1085
1099
  },
1100
+ "ArchiveDynamicApproverData": {
1101
+ "document": "动态签署2.0合同参与人信息",
1102
+ "members": [
1103
+ {
1104
+ "disabled": false,
1105
+ "document": "签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。 注意:不指定该字段时默认为发起方\n注意:此字段可能返回 null,表示取不到有效值。",
1106
+ "example": "06f2bc0f1772d8deac2f92b5df61a5ac",
1107
+ "member": "string",
1108
+ "name": "SignId",
1109
+ "output_required": false,
1110
+ "required": false,
1111
+ "type": "string",
1112
+ "value_allowed_null": true
1113
+ },
1114
+ {
1115
+ "disabled": false,
1116
+ "document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。 模板发起合同时,该参数为必填项。 文件发起合同是,该参数无需传值。 如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。\n注意:此字段可能返回 null,表示取不到有效值。",
1117
+ "example": "yDwhSUUckp3lqxlpUu6Ni3SvjJPoxxxx",
1118
+ "member": "string",
1119
+ "name": "RecipientId",
1120
+ "output_required": false,
1121
+ "required": false,
1122
+ "type": "string",
1123
+ "value_allowed_null": true
1124
+ }
1125
+ ],
1126
+ "usage": "both"
1127
+ },
1128
+ "ArchiveDynamicFlowRequest": {
1129
+ "document": "ArchiveDynamicFlow请求参数结构体",
1130
+ "members": [
1131
+ {
1132
+ "disabled": false,
1133
+ "document": "执行本接口操作的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
1134
+ "example": "无",
1135
+ "member": "UserInfo",
1136
+ "name": "Operator",
1137
+ "required": true,
1138
+ "type": "object"
1139
+ },
1140
+ {
1141
+ "disabled": false,
1142
+ "document": "合同流程ID, 为32位字符串。\n\n可登录腾讯电子签控制台,[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
1143
+ "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
1144
+ "member": "string",
1145
+ "name": "FlowId",
1146
+ "required": true,
1147
+ "type": "string"
1148
+ },
1149
+ {
1150
+ "disabled": false,
1151
+ "document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
1152
+ "example": "无",
1153
+ "member": "Agent",
1154
+ "name": "Agent",
1155
+ "required": false,
1156
+ "type": "object"
1157
+ }
1158
+ ],
1159
+ "type": "object"
1160
+ },
1161
+ "ArchiveDynamicFlowResponse": {
1162
+ "document": "ArchiveDynamicFlow返回参数结构体",
1163
+ "members": [
1164
+ {
1165
+ "disabled": false,
1166
+ "document": "合同流程ID",
1167
+ "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
1168
+ "member": "string",
1169
+ "name": "FlowId",
1170
+ "output_required": false,
1171
+ "type": "string",
1172
+ "value_allowed_null": false
1173
+ },
1174
+ {
1175
+ "disabled": false,
1176
+ "document": "动态签署人的参与人信息",
1177
+ "example": "无",
1178
+ "member": "ArchiveDynamicApproverData",
1179
+ "name": "Approvers",
1180
+ "output_required": false,
1181
+ "type": "list",
1182
+ "value_allowed_null": false
1183
+ },
1184
+ {
1185
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1186
+ "member": "string",
1187
+ "name": "RequestId",
1188
+ "type": "string"
1189
+ }
1190
+ ],
1191
+ "type": "object"
1192
+ },
1086
1193
  "AuthInfoDetail": {
1087
1194
  "document": "企业扩展服务授权列表详情",
1088
1195
  "members": [
@@ -2960,6 +3067,89 @@
2960
3067
  ],
2961
3068
  "type": "object"
2962
3069
  },
3070
+ "CreateDynamicFlowApproverRequest": {
3071
+ "document": "CreateDynamicFlowApprover请求参数结构体",
3072
+ "members": [
3073
+ {
3074
+ "disabled": false,
3075
+ "document": "执行本接口操作的员工信息。使用此接口时,必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
3076
+ "example": "无",
3077
+ "member": "UserInfo",
3078
+ "name": "Operator",
3079
+ "required": true,
3080
+ "type": "object"
3081
+ },
3082
+ {
3083
+ "disabled": false,
3084
+ "document": "合同流程ID,为32位字符串",
3085
+ "example": "无",
3086
+ "member": "string",
3087
+ "name": "FlowId",
3088
+ "required": true,
3089
+ "type": "string"
3090
+ },
3091
+ {
3092
+ "disabled": false,
3093
+ "document": "合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。",
3094
+ "example": "无",
3095
+ "member": "ApproverInfo",
3096
+ "name": "Approvers",
3097
+ "required": true,
3098
+ "type": "list"
3099
+ },
3100
+ {
3101
+ "disabled": false,
3102
+ "document": "代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
3103
+ "example": "无",
3104
+ "member": "Agent",
3105
+ "name": "Agent",
3106
+ "required": false,
3107
+ "type": "object"
3108
+ },
3109
+ {
3110
+ "disabled": false,
3111
+ "document": "个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`",
3112
+ "example": "E_PRESCRIPTION_AUTO_SIGN",
3113
+ "member": "string",
3114
+ "name": "AutoSignScene",
3115
+ "required": false,
3116
+ "type": "string"
3117
+ }
3118
+ ],
3119
+ "type": "object"
3120
+ },
3121
+ "CreateDynamicFlowApproverResponse": {
3122
+ "document": "CreateDynamicFlowApprover返回参数结构体",
3123
+ "members": [
3124
+ {
3125
+ "disabled": false,
3126
+ "document": "合同流程ID,为32位字符串",
3127
+ "example": "无",
3128
+ "member": "string",
3129
+ "name": "FlowId",
3130
+ "output_required": false,
3131
+ "type": "string",
3132
+ "value_allowed_null": false
3133
+ },
3134
+ {
3135
+ "disabled": false,
3136
+ "document": "补充动态合同签署人的结果数组",
3137
+ "example": "无",
3138
+ "member": "DynamicFlowApproverResult",
3139
+ "name": "DynamicFlowApproverList",
3140
+ "output_required": false,
3141
+ "type": "list",
3142
+ "value_allowed_null": false
3143
+ },
3144
+ {
3145
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3146
+ "member": "string",
3147
+ "name": "RequestId",
3148
+ "type": "string"
3149
+ }
3150
+ ],
3151
+ "type": "object"
3152
+ },
2963
3153
  "CreateEmbedWebUrlRequest": {
2964
3154
  "document": "CreateEmbedWebUrl请求参数结构体",
2965
3155
  "members": [
@@ -3535,6 +3725,15 @@
3535
3725
  "name": "FlowDisplayType",
3536
3726
  "required": false,
3537
3727
  "type": "int"
3728
+ },
3729
+ {
3730
+ "disabled": false,
3731
+ "document": "是否开启动态签署合同:\n<ul><li> **true**:开启动态签署合同,可在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力) 。</li>\n<li> **false**:不开启动态签署合同。</li></ul>",
3732
+ "example": "true",
3733
+ "member": "bool",
3734
+ "name": "OpenDynamicSignFlow",
3735
+ "required": false,
3736
+ "type": "bool"
3538
3737
  }
3539
3738
  ],
3540
3739
  "type": "object"
@@ -9657,6 +9856,45 @@
9657
9856
  ],
9658
9857
  "type": "object"
9659
9858
  },
9859
+ "DynamicFlowApproverResult": {
9860
+ "document": "动态添加签署人的结果信息",
9861
+ "members": [
9862
+ {
9863
+ "disabled": false,
9864
+ "document": "签署方角色编号\n注意:此字段可能返回 null,表示取不到有效值。",
9865
+ "example": "无",
9866
+ "member": "string",
9867
+ "name": "RecipientId",
9868
+ "output_required": false,
9869
+ "required": false,
9870
+ "type": "string",
9871
+ "value_allowed_null": true
9872
+ },
9873
+ {
9874
+ "disabled": false,
9875
+ "document": "签署方唯一编号\n注意:此字段可能返回 null,表示取不到有效值。",
9876
+ "example": "无",
9877
+ "member": "string",
9878
+ "name": "SignId",
9879
+ "output_required": false,
9880
+ "required": false,
9881
+ "type": "string",
9882
+ "value_allowed_null": true
9883
+ },
9884
+ {
9885
+ "disabled": false,
9886
+ "document": "签署方当前状态\n注意:此字段可能返回 null,表示取不到有效值。",
9887
+ "example": "无",
9888
+ "member": "int64",
9889
+ "name": "ApproverStatus",
9890
+ "output_required": false,
9891
+ "required": false,
9892
+ "type": "int",
9893
+ "value_allowed_null": true
9894
+ }
9895
+ ],
9896
+ "usage": "both"
9897
+ },
9660
9898
  "EmbedUrlOption": {
9661
9899
  "document": "个性化参数",
9662
9900
  "members": [
@@ -1,5 +1,25 @@
1
1
  {
2
2
  "actions": {
3
+ "ArchiveDynamicFlow": [
4
+ {
5
+ "document": "所有签署方都签署完成,并且不再新增签署方时,结束该动态签署合同",
6
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ArchiveDynamicFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ClientIp\": \"1.1.1.1\",\n \"UserId\": \"yDxZtUyKQD2JuqUuO4zjERYGxxxxxxxx\"\n },\n \"FlowId\": \"yDCmVUUckpufezuiUxQQFiT8Exxxxxxxx\"\n}",
7
+ "output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"SignId\": \"yDCmDUUckpuf0hsfUuvalvQtaxxxxxxx\",\n \"RecipientId\": \"yDCmDUUckpuf0hseUuvalvQRmxxxxxx\"\n }\n ],\n \"FlowId\": \"yDCmDUUckpuf0hsmUuvalvQyxxxxxxxxx\",\n \"RequestId\": \"abc\"\n }\n}",
8
+ "title": "结束动态签署合同"
9
+ },
10
+ {
11
+ "document": "未签署完成前归档",
12
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ArchiveDynamicFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf3UUckps8dvveUEfH3DjvMmg3ZkjQ\"\n },\n \"FlowId\": \"yDCjFUUckp4jkz76UoofpTx3iZ3A3C3x\"\n}",
13
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"OperationDenied\",\n \"Message\": \"当前合同状态不支持归档合同,请检查后重试\"\n },\n \"RequestId\": \"34ded0a6-e679-4af7-a07e-ca457e388499\"\n }\n}",
14
+ "title": "归档失败"
15
+ },
16
+ {
17
+ "document": "所有签署方签署完成后,结束动态合同",
18
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ArchiveDynamicFlow\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf3UUckps8dvveUEfH3DjvMmg3ZkjQ\"\n },\n \"FlowId\": \"yDCjFUUckp48fiwyUyh7ukYEdXdSyJps\"\n}",
19
+ "output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"RecipientId\": \"yDCjFUUckp48fiwbUyh7ukYE1kRDNNN4\",\n \"SignId\": \"yDCjFUUckp48fiwwUyh7ukYvjx5PR1e2\"\n }\n ],\n \"FlowId\": \"yDCjFUUckp48fiwyUyh7ukYEdXdSyJps\",\n \"RequestId\": \"ca0fd107-4337-4650-8236-aa3e4561f7ef\"\n }\n}",
20
+ "title": "归档合同"
21
+ }
22
+ ],
3
23
  "BindEmployeeUserIdWithClientOpenId": [
4
24
  {
5
25
  "document": "传入UserId和OpenId,绑定成功。",
@@ -234,6 +254,44 @@
234
254
  "title": "创建电子文档并填充图片控件"
235
255
  }
236
256
  ],
257
+ "CreateDynamicFlowApprover": [
258
+ {
259
+ "document": "补充企业自动签签署人",
260
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDynamicFlowApprover\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"操作人id\"\n },\n \"FlowId\": \"合同id\",\n \"AutoSignScene\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 3,\n \"OrganizationName\": \"发起方企业\",\n \"PreReadTime\": 3,\n \"SignComponents\": [\n {\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 160,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentValue\": \"yDCHZUUckpa9v4i1UuSIlP8KougrzLuQ\",\n \"ComponentPage\": 1\n }\n ]\n }\n ]\n}",
261
+ "output": "{\n \"Response\": {\n \"DynamicFlowApproverList\": [\n {\n \"ApproverStatus\": 1,\n \"RecipientId\": \"yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR\",\n \"SignId\": \"yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB\"\n }\n ],\n \"FlowId\": \"yDCjFUUckp48f680Uyh7ukYy5JFb80ux\",\n \"RequestId\": \"s1728544317709049372\"\n }\n}",
262
+ "title": "补充企业自动签签署人"
263
+ },
264
+ {
265
+ "document": "二要素形式补充签署人",
266
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDynamicFlowApprover\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"操作人id\"\n },\n \"FlowId\": \"合同id\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"企业名称\",\n \"ApproverName\": \"签署人姓名\",\n \"ApproverMobile\": \"签署人手机号\",\n \"PreReadTime\": 3,\n \"SignComponents\": [\n {\n \"ComponentPosX\": 260,\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1\n }\n ]\n }\n ]\n}",
267
+ "output": "{\n \"Response\": {\n \"DynamicFlowApproverList\": [\n {\n \"ApproverStatus\": 1,\n \"RecipientId\": \"yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR\",\n \"SignId\": \"yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB\"\n }\n ],\n \"FlowId\": \"yDCjFUUckp48f680Uyh7ukYy5JFb80ux\",\n \"RequestId\": \"s1728544317709049372\"\n }\n}",
268
+ "title": "二要素形式补充企业签署人"
269
+ },
270
+ {
271
+ "document": "二要素补充个人签署人",
272
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDynamicFlowApprover\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"操作人id\"\n },\n \"FlowId\": \"合同id\",\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"ApproverName\": \"签署人姓名\",\n \"ApproverMobile\": \"签署人手机号\",\n \"PreReadTime\": 3,\n \"SignComponents\": [\n {\n \"ComponentPosX\": 260,\n \"ComponentPosY\": 260,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1\n }\n ]\n }\n ]\n}",
273
+ "output": "{\n \"Response\": {\n \"DynamicFlowApproverList\": [\n {\n \"ApproverStatus\": 1,\n \"RecipientId\": \"yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR\",\n \"SignId\": \"yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB\"\n }\n ],\n \"FlowId\": \"合同id\",\n \"RequestId\": \"s1728544317709049372\"\n }\n}",
274
+ "title": "二要素补充个人签署人"
275
+ },
276
+ {
277
+ "document": "补充个人自动签签署人",
278
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDynamicFlowApprover\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"操作人id\"\n },\n \"FlowId\": \"合同id\",\n \"AutoSignScene\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Approvers\": [\n {\n \"ApproverType\": 7,\n \"ApproverName\": \"签署人姓名\",\n \"ApproverMobile\": \"签署人手机号\",\n \"PreReadTime\": 3,\n \"SignComponents\": [\n {\n \"ComponentPosX\": 360,\n \"ComponentPosY\": 360,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1\n }\n ]\n }\n ]\n}",
279
+ "output": "{\n \"Response\": {\n \"DynamicFlowApproverList\": [\n {\n \"ApproverStatus\": 1,\n \"RecipientId\": \"yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR\",\n \"SignId\": \"yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB\"\n }\n ],\n \"FlowId\": \"合同id\",\n \"RequestId\": \"s1728544317709049372\"\n }\n}",
280
+ "title": "补充个人自动签签署人"
281
+ },
282
+ {
283
+ "document": "补充或签签署人",
284
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDynamicFlowApprover\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"操作人id\"\n },\n \"FlowId\": \"合同id\",\n \"AutoSignScene\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"OrganizationName\": \"企业名称\",\n \"CustomApproverTag\": \"唯一标志\",\n \"PreReadTime\": 3,\n \"SignComponents\": [\n {\n \"ComponentPosX\": 333,\n \"ComponentPosY\": 333,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1\n }\n ]\n }\n ]\n}",
285
+ "output": "{\n \"Response\": {\n \"DynamicFlowApproverList\": [\n {\n \"ApproverStatus\": 1,\n \"RecipientId\": \"yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR\",\n \"SignId\": \"yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB\"\n }\n ],\n \"FlowId\": \"合同id\",\n \"RequestId\": \"s1728544317709049372\"\n }\n}",
286
+ "title": "补充或签签署人"
287
+ },
288
+ {
289
+ "document": "补充动态签署人",
290
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDynamicFlowApprover\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"操作人id\"\n },\n \"FlowId\": \"合同id\",\n \"AutoSignScene\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 0,\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"PreReadTime\": 3,\n \"SignComponents\": [\n {\n \"ComponentPosX\": 60,\n \"ComponentPosY\": 360,\n \"ComponentWidth\": 100,\n \"ComponentHeight\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1\n }\n ]\n }\n ]\n}",
291
+ "output": "{\n \"Response\": {\n \"DynamicFlowApproverList\": [\n {\n \"ApproverStatus\": 1,\n \"RecipientId\": \"yDCjFUUckp48f6hcUyh7ukYyfaIqHqnR\",\n \"SignId\": \"yDCjFUUckp48f6hiUyh7ukYBjxSiGXzB\"\n }\n ],\n \"FlowId\": \"合同id\",\n \"RequestId\": \"s1728544317709049372\"\n }\n}",
292
+ "title": "补充动态签署人"
293
+ }
294
+ ],
237
295
  "CreateEmbedWebUrl": [
238
296
  {
239
297
  "document": "\t\n获取合同详情嵌入WEB链接",
@@ -3867,6 +3867,58 @@ def doChannelCreateUserAutoSignSealUrl(args, parsed_globals):
3867
3867
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
3868
3868
 
3869
3869
 
3870
+ def doCreateChannelSubOrganizationActive(args, parsed_globals):
3871
+ g_param = parse_global_arg(parsed_globals)
3872
+
3873
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
3874
+ cred = credential.CVMRoleCredential()
3875
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
3876
+ cred = credential.STSAssumeRoleCredential(
3877
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
3878
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
3879
+ )
3880
+ 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):
3881
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
3882
+ else:
3883
+ cred = credential.Credential(
3884
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
3885
+ )
3886
+ http_profile = HttpProfile(
3887
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
3888
+ reqMethod="POST",
3889
+ endpoint=g_param[OptionsDefine.Endpoint],
3890
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
3891
+ )
3892
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
3893
+ if g_param[OptionsDefine.Language]:
3894
+ profile.language = g_param[OptionsDefine.Language]
3895
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
3896
+ client = mod.EssbasicClient(cred, g_param[OptionsDefine.Region], profile)
3897
+ client._sdkVersion += ("_CLI_" + __version__)
3898
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
3899
+ model = models.CreateChannelSubOrganizationActiveRequest()
3900
+ model.from_json_string(json.dumps(args))
3901
+ start_time = time.time()
3902
+ while True:
3903
+ rsp = client.CreateChannelSubOrganizationActive(model)
3904
+ result = rsp.to_json_string()
3905
+ try:
3906
+ json_obj = json.loads(result)
3907
+ except TypeError as e:
3908
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
3909
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
3910
+ break
3911
+ cur_time = time.time()
3912
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
3913
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
3914
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
3915
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
3916
+ else:
3917
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
3918
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
3919
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
3920
+
3921
+
3870
3922
  def doGenerateOrganizationSeal(args, parsed_globals):
3871
3923
  g_param = parse_global_arg(parsed_globals)
3872
3924
 
@@ -6866,6 +6918,7 @@ ACTION_MAP = {
6866
6918
  "ChannelGetTaskResultApi": doChannelGetTaskResultApi,
6867
6919
  "DescribeSubOrganizations": doDescribeSubOrganizations,
6868
6920
  "ChannelCreateUserAutoSignSealUrl": doChannelCreateUserAutoSignSealUrl,
6921
+ "CreateChannelSubOrganizationActive": doCreateChannelSubOrganizationActive,
6869
6922
  "GenerateOrganizationSeal": doGenerateOrganizationSeal,
6870
6923
  "DescribeFileIdsByCustomIds": doDescribeFileIdsByCustomIds,
6871
6924
  "DescribeTemplates": doDescribeTemplates,
@@ -343,6 +343,13 @@
343
343
  "output": "CreateChannelOrganizationInfoChangeUrlResponse",
344
344
  "status": "online"
345
345
  },
346
+ "CreateChannelSubOrganizationActive": {
347
+ "document": "激活或续期子客企业, 在激活状态下,企业可以正常发起合同;在非激活状态下,企业仅能查看和签署合同。\n\n**1. 激活**:使用一个许可证将子客企业从未激活状态转变为激活状态。**激活状态的有效期为一年,一年后将自动回到未激活状态**。\n\n**2. 续期**:使用一个许可证将已激活的子客企业的有效期延长一年。只有处于激活状态的子企业才能进行续期操作(**若处于非激活状态,则需先激活**)。您可以使用多个许可证对同一子客企业进行多次续费。\n\n\n该接口的效果同:**【企业应用管理】 -> 【子客企业管理】 -> 【激活】或者【续期】**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/cd63761ca6e814c64b4ecf131555b74e.png)\n\n\n如果不想调用此接口或者页面点击进行激活或续期,可以在【应用扩展服务】中打开自动激活或续期,在许可证充足的情况下会自动激活或续期子客企业\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/2ccb37ef6bde463c15c39fdda789216f.png)",
348
+ "input": "CreateChannelSubOrganizationActiveRequest",
349
+ "name": "激活或者续期子企业",
350
+ "output": "CreateChannelSubOrganizationActiveResponse",
351
+ "status": "online"
352
+ },
346
353
  "CreateConsoleLoginUrl": {
347
354
  "document": "此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。\n\nWeb链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:\n<table>\n<thead>\n<tr>\n<th>子客企业状态</th>\n<th>子客企业员工状态</th>\n<th>点击链接进入的流程</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>企业未激活</td>\n<td>员工未认证</td>\n<td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工未认证</td>\n<td>进入员工认证并加入企业流程</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工已认证</td>\n<td>进入子客企业Web控制台</td>\n</tr>\n</tbody>\n</table>\n如果是企业激活流程,需要注意如下情况:\n\n1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。\n2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。\n\n系统的渠道企业, 应用, 子客企业, 子客员工的组织形式\n![image](https://qcloudimg.tencent-cloud.cn/raw/77677faeea26c9d7f37474597c81fe01.png)\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4\" target=\"_blank\">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>",
348
355
  "input": "CreateConsoleLoginUrlRequest",
@@ -5110,6 +5117,28 @@
5110
5117
  "required": false,
5111
5118
  "type": "string",
5112
5119
  "value_allowed_null": false
5120
+ },
5121
+ {
5122
+ "disabled": false,
5123
+ "document": "子企业激活状态。值如下:\n<ul>\n <li>**0**: 未激活</li>\n <li>**1**: 已激活</li>\n</ul>",
5124
+ "example": "0",
5125
+ "member": "int64",
5126
+ "name": "ActiveStatus",
5127
+ "output_required": false,
5128
+ "required": false,
5129
+ "type": "int",
5130
+ "value_allowed_null": false
5131
+ },
5132
+ {
5133
+ "disabled": false,
5134
+ "document": "账号过期时间,时间戳",
5135
+ "example": "无",
5136
+ "member": "int64",
5137
+ "name": "LicenseExpireTime",
5138
+ "output_required": false,
5139
+ "required": false,
5140
+ "type": "int",
5141
+ "value_allowed_null": false
5113
5142
  }
5114
5143
  ],
5115
5144
  "usage": "both"
@@ -6191,6 +6220,51 @@
6191
6220
  ],
6192
6221
  "type": "object"
6193
6222
  },
6223
+ "CreateChannelSubOrganizationActiveRequest": {
6224
+ "document": "CreateChannelSubOrganizationActive请求参数结构体",
6225
+ "members": [
6226
+ {
6227
+ "disabled": false,
6228
+ "document": "关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。\n\n此接口下面信息必填。\n<ul>\n<li>渠道应用标识: Agent.AppId</li>\n<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>\n<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>\n</ul>\n第三方平台子客企业和员工必须已经经过实名认证",
6229
+ "example": "无",
6230
+ "member": "Agent",
6231
+ "name": "Agent",
6232
+ "required": true,
6233
+ "type": "object"
6234
+ },
6235
+ {
6236
+ "disabled": false,
6237
+ "document": "要进行激活或者续期的子客企业OrganizationOpenId列表,请确保所有列出的子客企业均已完成认证。",
6238
+ "example": "无",
6239
+ "member": "string",
6240
+ "name": "SubOrganizationOpenIds",
6241
+ "required": false,
6242
+ "type": "list"
6243
+ },
6244
+ {
6245
+ "disabled": false,
6246
+ "document": "操作类型,可以选择如下:\n\n**false**:(默认)激活子客企业\n**true**:续期子客企业\n",
6247
+ "example": "无",
6248
+ "member": "bool",
6249
+ "name": "Renew",
6250
+ "required": false,
6251
+ "type": "bool"
6252
+ }
6253
+ ],
6254
+ "type": "object"
6255
+ },
6256
+ "CreateChannelSubOrganizationActiveResponse": {
6257
+ "document": "CreateChannelSubOrganizationActive返回参数结构体",
6258
+ "members": [
6259
+ {
6260
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
6261
+ "member": "string",
6262
+ "name": "RequestId",
6263
+ "type": "string"
6264
+ }
6265
+ ],
6266
+ "type": "object"
6267
+ },
6194
6268
  "CreateConsoleLoginUrlRequest": {
6195
6269
  "document": "CreateConsoleLoginUrl请求参数结构体",
6196
6270
  "members": [
@@ -782,6 +782,20 @@
782
782
  "title": "创建超管变更链接(小程序链接)"
783
783
  }
784
784
  ],
785
+ "CreateChannelSubOrganizationActive": [
786
+ {
787
+ "document": "org_zhangsan和org_lisi两个企业已经是激活态,现在花费两个许可证给两个子客企业分别再续期1年",
788
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateChannelSubOrganizationActive\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n }\n },\n \"SubOrganizationOpenIds\": [\n \"org_zhangsan\",\n \"org_lisi\"\n ],\n \"Renew\": true\n}",
789
+ "output": "{\n \"Response\": {\n \"RequestId\": \"00f08f1c-3823-44c3-8cd1-4e66a0587ab4\"\n }\n}",
790
+ "title": "子客续期"
791
+ },
792
+ {
793
+ "document": "org_zhangsan和org_lisi两个企业现在是非激活态(可能是过期,也可能是没有激活过),现在花费两个许可证激活这两个子客企业",
794
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateChannelSubOrganizationActive\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n }\n },\n \"SubOrganizationOpenIds\": [\n \"org_zhangsan\",\n \"org_lisi\"\n ]\n}",
795
+ "output": "{\n \"Response\": {\n \"RequestId\": \"00f08f1c-3823-44c3-8cd1-4e66a0587ab4\"\n }\n}",
796
+ "title": "子客激活"
797
+ }
798
+ ],
785
799
  "CreateConsoleLoginUrl": [
786
800
  {
787
801
  "document": "如果<b>典子谦示例企业的员工张三已经完成了认证和加入企业</b>, 此时给典子谦示例企业的员工张三生成登录的PC控制台的链接\n\n典子谦示例企业的定义标识为:org_dianziqian\n员工张三定义员工标识为:n9527\n",
@@ -1975,7 +1975,7 @@
1975
1975
  "members": [
1976
1976
  {
1977
1977
  "disabled": false,
1978
- "document": "文件类型。支持的文件类型:PDF、DOCX、DOC、XLS、XLSX、PPTPPTX、PNG、JPG、JPEG、CSV",
1978
+ "document": "文件类型。支持的文件类型:PDF、DOC、DOCX、PPTPPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2",
1979
1979
  "example": "PDF",
1980
1980
  "member": "string",
1981
1981
  "name": "FileType",