tccli 3.0.923.1__py2.py3-none-any.whl → 3.0.924.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 (57) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/apigateway/v20180808/DescribeServicesStatus.md +33 -19
  3. tccli/examples/clb/v20180317/CloneLoadBalancer.md +3 -3
  4. tccli/examples/clb/v20180317/DescribeListeners.md +49 -127
  5. tccli/examples/clb/v20180317/DescribeLoadBalancers.md +578 -158
  6. tccli/examples/cls/v20201016/DescribeConfigs.md +2 -1
  7. tccli/examples/cls/v20201016/DescribeKafkaConsumer.md +23 -0
  8. tccli/examples/cls/v20201016/ModifyKafkaConsumer.md +21 -0
  9. tccli/examples/cynosdb/v20190107/DescribeAccounts.md +10 -10
  10. tccli/examples/cynosdb/v20190107/DescribeClusterDetail.md +77 -65
  11. tccli/examples/essbasic/v20210526/DescribeTemplates.md +13 -4
  12. tccli/examples/essbasic/v20210526/OperateChannelTemplate.md +2 -2
  13. tccli/examples/mna/v20210119/GetDevices.md +9 -16
  14. tccli/examples/mna/v20210119/UpdateDevice.md +7 -10
  15. tccli/examples/ms/v20180408/CreateEncryptInstance.md +30 -30
  16. tccli/examples/ms/v20180408/CreateOrderInstance.md +2 -2
  17. tccli/examples/ms/v20180408/DescribeEncryptInstances.md +73 -65
  18. tccli/examples/ms/v20180408/DescribeEncryptPlan.md +34 -34
  19. tccli/examples/ms/v20180408/DescribeOrderInstances.md +1 -1
  20. tccli/examples/oceanus/v20190422/CreateJobConfig.md +1 -1
  21. tccli/examples/tdmq/v20200217/CreateRocketMQVipInstance.md +28 -0
  22. tccli/examples/vpc/v20170312/CreateVpnGateway.md +20 -26
  23. tccli/services/apigateway/v20180808/api.json +119 -12
  24. tccli/services/apigateway/v20180808/examples.json +4 -4
  25. tccli/services/asr/v20190614/api.json +1 -1
  26. tccli/services/clb/v20180317/api.json +190 -60
  27. tccli/services/clb/v20180317/examples.json +10 -10
  28. tccli/services/cls/cls_client.py +110 -4
  29. tccli/services/cls/v20201016/api.json +277 -55
  30. tccli/services/cls/v20201016/examples.json +17 -1
  31. tccli/services/cynosdb/v20190107/api.json +82 -31
  32. tccli/services/cynosdb/v20190107/examples.json +3 -3
  33. tccli/services/dlc/v20210125/api.json +11 -11
  34. tccli/services/emr/v20190103/api.json +10 -0
  35. tccli/services/ess/v20201111/api.json +416 -91
  36. tccli/services/essbasic/v20210526/api.json +113 -78
  37. tccli/services/essbasic/v20210526/examples.json +5 -5
  38. tccli/services/faceid/v20180301/api.json +21 -16
  39. tccli/services/live/v20180801/api.json +42 -22
  40. tccli/services/mna/v20210119/api.json +11 -12
  41. tccli/services/mna/v20210119/examples.json +4 -4
  42. tccli/services/mps/v20190612/api.json +142 -61
  43. tccli/services/ms/v20180408/api.json +92 -19
  44. tccli/services/ms/v20180408/examples.json +31 -31
  45. tccli/services/oceanus/v20190422/api.json +355 -41
  46. tccli/services/oceanus/v20190422/examples.json +1 -1
  47. tccli/services/tdmq/tdmq_client.py +53 -0
  48. tccli/services/tdmq/v20200217/api.json +126 -0
  49. tccli/services/tdmq/v20200217/examples.json +8 -0
  50. tccli/services/tts/v20190823/api.json +1 -1
  51. tccli/services/vpc/v20170312/api.json +45 -65
  52. tccli/services/vpc/v20170312/examples.json +3 -3
  53. {tccli-3.0.923.1.dist-info → tccli-3.0.924.1.dist-info}/METADATA +2 -2
  54. {tccli-3.0.923.1.dist-info → tccli-3.0.924.1.dist-info}/RECORD +57 -54
  55. {tccli-3.0.923.1.dist-info → tccli-3.0.924.1.dist-info}/WHEEL +0 -0
  56. {tccli-3.0.923.1.dist-info → tccli-3.0.924.1.dist-info}/entry_points.txt +0 -0
  57. {tccli-3.0.923.1.dist-info → tccli-3.0.924.1.dist-info}/license_files/LICENSE +0 -0
@@ -162,7 +162,7 @@
162
162
  "status": "online"
163
163
  },
164
164
  "CreatePrepareFlow": {
165
- "document": "创建快速发起流程\n适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.\n注:该接口文件的resourceId 是通过上传文件之后获取的。",
165
+ "document": "创建快速发起流程\n<br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.\n<br/>注:该接口文件的resourceId 是通过上传文件之后获取的。",
166
166
  "input": "CreatePrepareFlowRequest",
167
167
  "name": "获取发起合同web页面",
168
168
  "output": "CreatePrepareFlowResponse",
@@ -393,7 +393,7 @@
393
393
  "status": "online"
394
394
  },
395
395
  "UpdateIntegrationEmployees": {
396
- "document": "更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号",
396
+ "document": "更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。\n可进行批量操作,Employees中的userID与openID二选一必填",
397
397
  "input": "UpdateIntegrationEmployeesRequest",
398
398
  "name": "更新企业员工信息",
399
399
  "output": "UpdateIntegrationEmployeesResponse",
@@ -1178,12 +1178,13 @@
1178
1178
  "usage": "in"
1179
1179
  },
1180
1180
  "Component": {
1181
- "document": "模板控件信息",
1181
+ "document": "模板/流程中控件信息,可以是填充控件或签署控件",
1182
1182
  "members": [
1183
1183
  {
1184
1184
  "disabled": false,
1185
1185
  "document": "如果是Component填写控件类型,则可选的字段为:\nTEXT - 普通文本控件,输入文本字符串;\nMULTI_LINE_TEXT - 多行文本控件,输入文本字符串;\nCHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;\nFILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;\nDYNAMIC_TABLE - 动态表格控件;\nATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;\nSELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;\nDATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;\nDISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;\n\n如果是SignComponent签署控件类型,则可选的字段为\nSIGN_SEAL - 签署印章控件;\nSIGN_DATE - 签署日期控件;\nSIGN_SIGNATURE - 用户签名控件;\nSIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);\nSIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight\nSIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;\nSIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。\n\n表单域的控件不能作为印章和签名控件",
1186
1186
  "example": "无",
1187
+ "is_base64": false,
1187
1188
  "member": "string",
1188
1189
  "name": "ComponentType",
1189
1190
  "output_required": true,
@@ -1193,7 +1194,7 @@
1193
1194
  },
1194
1195
  {
1195
1196
  "disabled": false,
1196
- "document": "控件所属文件的序号(取值为:0-N)。目前单文件的情况下,值是0",
1197
+ "document": "控件所属文件的序号(取值为:0-N)。\n目前单文件的情况下,值是0",
1197
1198
  "example": "无",
1198
1199
  "member": "int64",
1199
1200
  "name": "FileIndex",
@@ -1259,8 +1260,9 @@
1259
1260
  },
1260
1261
  {
1261
1262
  "disabled": false,
1262
- "document": "查询时返回控件唯一Id。使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字",
1263
+ "document": "控件唯一ID。\n或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字",
1263
1264
  "example": "无",
1265
+ "is_base64": false,
1264
1266
  "member": "string",
1265
1267
  "name": "ComponentId",
1266
1268
  "output_required": true,
@@ -1270,8 +1272,9 @@
1270
1272
  },
1271
1273
  {
1272
1274
  "disabled": false,
1273
- "document": "查询时返回控件名。使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称",
1275
+ "document": "控件名。\n或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称",
1274
1276
  "example": "无",
1277
+ "is_base64": false,
1275
1278
  "member": "string",
1276
1279
  "name": "ComponentName",
1277
1280
  "output_required": true,
@@ -1281,7 +1284,7 @@
1281
1284
  },
1282
1285
  {
1283
1286
  "disabled": false,
1284
- "document": "是否必选,默认为false",
1287
+ "document": "是否必选,默认为false-非必选",
1285
1288
  "example": "无",
1286
1289
  "member": "bool",
1287
1290
  "name": "ComponentRequired",
@@ -1292,8 +1295,9 @@
1292
1295
  },
1293
1296
  {
1294
1297
  "disabled": false,
1295
- "document": "控件关联的签署人ID",
1298
+ "document": "控件关联的参与方ID,对应Recipient结构体中的RecipientId",
1296
1299
  "example": "无",
1300
+ "is_base64": false,
1297
1301
  "member": "string",
1298
1302
  "name": "ComponentRecipientId",
1299
1303
  "output_required": true,
@@ -1305,6 +1309,7 @@
1305
1309
  "disabled": false,
1306
1310
  "document": "扩展参数:\n为JSON格式。\n\nComponentType为FILL_IMAGE时,支持以下参数:\nNotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中\nFillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放\n\nComponentType为SIGN_SIGNATURE类型可以控制签署方式\n{“ComponentTypeLimit”: [“xxx”]}\nxxx可以为:\nHANDWRITE – 手写签名\nOCR_ESIGN -- AI智能识别手写签名\nESIGN -- 个人印章类型\nSYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)\n如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}\n\nComponentType为SIGN_DATE时,支持以下参数:\n1 Font:字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"\n2 FontSize: 数字类型,范围6-72,默认值为12\n3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐\n4 Format: 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。\n5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n参数样例: \"ComponentExtra\": \"{\\\"Format\\\":“yyyy m d”,\\\"FontSize\\\":12,\\\"Gaps\\\":\\\"2,2\\\", \\\"FontAlign\\\":\\\"Right\\\"}\"\n\nComponentType为SIGN_SEAL类型时,支持以下参数:\n1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)\n参数样例:\"ComponentExtra\":\"{\\\"PageRanges\\\":[{\\\"BeginPage\\\":1,\\\"EndPage\\\":-1}]}\"",
1307
1311
  "example": "无",
1312
+ "is_base64": false,
1308
1313
  "member": "string",
1309
1314
  "name": "ComponentExtra",
1310
1315
  "output_required": true,
@@ -1314,7 +1319,7 @@
1314
1319
  },
1315
1320
  {
1316
1321
  "disabled": false,
1317
- "document": "是否是表单域类型,默认不false-不是\n注意:此字段可能返回 null,表示取不到有效值。",
1322
+ "document": "是否是表单域类型,默认false-不是\n注意:此字段可能返回 null,表示取不到有效值。",
1318
1323
  "example": "无",
1319
1324
  "member": "bool",
1320
1325
  "name": "IsFormType",
@@ -1327,6 +1332,7 @@
1327
1332
  "disabled": false,
1328
1333
  "document": "控件填充vaule,ComponentType和传入值类型对应关系:\nTEXT - 文本内容\nMULTI_LINE_TEXT - 文本内容\nCHECK_BOX - true/false\nFILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取\nSELECTOR - 选项值\nDYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo\nDATE - 默认是格式化为xxxx年xx月xx日\nSIGN_SEAL - 印章ID,于控制台查询获取\nSIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取\n\n控件值约束说明:\n企业全称控件:\n 约束:企业名称中文字符中文括号\n 检查正则表达式:/^[\\u3400-\\u4dbf\\u4e00-\\u9fa5()]+$/\n\n统一社会信用代码控件:\n 检查正则表达式:/^[A-Z0-9]{1,18}$/\n\n法人名称控件:\n 约束:最大50个字符,2到25个汉字或者1到50个字母\n 检查正则表达式:/^([\\u3400-\\u4dbf\\u4e00-\\u9fa5.·]{2,25}|[a-zA-Z·,\\s-]{1,50})$/\n\n签署意见控件:\n 约束:签署意见最大长度为50字符\n\n签署人手机号控件:\n 约束:国内手机号 13,14,15,16,17,18,19号段长度11位\n\n签署人身份证控件:\n 约束:合法的身份证号码检查\n\n控件名称:\n 约束:控件名称最大长度为20字符\n\n单行文本控件:\n 约束:只允许输入中文,英文,数字,中英文标点符号\n\n多行文本控件:\n 约束:只允许输入中文,英文,数字,中英文标点符号\n\n勾选框控件:\n 约束:选择填字符串true,不选填字符串false\n\n选择器控件:\n 约束:同单行文本控件约束,填写选择值中的字符串\n\n数字控件:\n 约束:请输入有效的数字(可带小数点) \n 检查正则表达式:/^(-|\\+)?\\d+(\\.\\d+)?$/\n\n日期控件:\n 约束:格式:yyyy年mm月dd日\n\n附件控件:\n 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件\n\n图片控件:\n 约束:JPG或PNG图片,填写上传的图片资源ID\n\n邮箱控件:\n 约束:请输入有效的邮箱地址, w3c标准\n 检查正则表达式:/^([A-Za-z0-9_\\-.!#$%&])+@([A-Za-z0-9_\\-.])+\\.([A-Za-z]{2,4})$/\n 参考:https://emailregex.com/\n\n地址控件:\n 同单行文本控件约束\n\n省市区控件:\n 同单行文本控件约束\n\n性别控件:\n 同单行文本控件约束,填写选择值中的字符串\n\n学历控件:\n 同单行文本控件约束,填写选择值中的字符串",
1329
1334
  "example": "无",
1335
+ "is_base64": false,
1330
1336
  "member": "string",
1331
1337
  "name": "ComponentValue",
1332
1338
  "output_required": true,
@@ -1338,6 +1344,7 @@
1338
1344
  "disabled": false,
1339
1345
  "document": "NORMAL 正常模式,使用坐标制定签署控件位置\nFIELD 表单域,需使用ComponentName指定表单域名称\nKEYWORD 关键字,使用ComponentId指定关键字",
1340
1346
  "example": "无",
1347
+ "is_base64": false,
1341
1348
  "member": "string",
1342
1349
  "name": "GenerateMode",
1343
1350
  "output_required": true,
@@ -1358,8 +1365,9 @@
1358
1365
  },
1359
1366
  {
1360
1367
  "disabled": false,
1361
- "document": "第三方应用集成平台模板控件 id 标识",
1368
+ "document": "第三方应用集成平台模板控件 ID 标识",
1362
1369
  "example": "无",
1370
+ "is_base64": false,
1363
1371
  "member": "string",
1364
1372
  "name": "ChannelComponentId",
1365
1373
  "output_required": true,
@@ -1391,7 +1399,7 @@
1391
1399
  },
1392
1400
  {
1393
1401
  "disabled": false,
1394
- "document": "第三方应用集成中子客企业控件来源。0-平台指定;1-用户自定义",
1402
+ "document": "第三方应用集成中子客企业控件来源。\n0-平台指定;\n1-用户自定义",
1395
1403
  "example": "无",
1396
1404
  "member": "uint64",
1397
1405
  "name": "ChannelComponentSource",
@@ -1402,8 +1410,9 @@
1402
1410
  },
1403
1411
  {
1404
1412
  "disabled": false,
1405
- "document": "指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。\n传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。",
1413
+ "document": "指定关键字排序规则,Positive-正序,Reverse-倒序。\n传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。\n传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。",
1406
1414
  "example": "Positive\\Reverse",
1415
+ "is_base64": false,
1407
1416
  "member": "string",
1408
1417
  "name": "KeywordOrder",
1409
1418
  "output_required": true,
@@ -1413,7 +1422,7 @@
1413
1422
  },
1414
1423
  {
1415
1424
  "disabled": false,
1416
- "document": "指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来",
1425
+ "document": "指定关键字页码。\n指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来",
1417
1426
  "example": "无",
1418
1427
  "member": "int64",
1419
1428
  "name": "KeywordPage",
@@ -1424,8 +1433,9 @@
1424
1433
  },
1425
1434
  {
1426
1435
  "disabled": false,
1427
- "document": "关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方",
1436
+ "document": "关键字位置模式,\nMiddle-居中,\nBelow-正下方,\nRight-正右方,\nLowerRight-右上角,\nUpperRight-右下角。\n示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方",
1428
1437
  "example": "无",
1438
+ "is_base64": false,
1429
1439
  "member": "string",
1430
1440
  "name": "RelativeLocation",
1431
1441
  "output_required": true,
@@ -1435,7 +1445,7 @@
1435
1445
  },
1436
1446
  {
1437
1447
  "disabled": false,
1438
- "document": "关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。",
1448
+ "document": "关键字索引。\n如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。\n示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。",
1439
1449
  "example": "无",
1440
1450
  "member": "int64",
1441
1451
  "name": "KeywordIndexes",
@@ -1443,6 +1453,28 @@
1443
1453
  "required": false,
1444
1454
  "type": "list",
1445
1455
  "value_allowed_null": false
1456
+ },
1457
+ {
1458
+ "disabled": false,
1459
+ "document": "是否锁定控件值不允许编辑(嵌入式发起使用)\n<br/>默认false:不锁定控件值,允许在页面编辑控件值\n注意:此字段可能返回 null,表示取不到有效值。",
1460
+ "example": "无",
1461
+ "member": "bool",
1462
+ "name": "LockComponentValue",
1463
+ "output_required": false,
1464
+ "required": false,
1465
+ "type": "bool",
1466
+ "value_allowed_null": true
1467
+ },
1468
+ {
1469
+ "disabled": false,
1470
+ "document": "是否禁止移动和删除控件\n<br/>默认false,不禁止移动和删除控件\n注意:此字段可能返回 null,表示取不到有效值。",
1471
+ "example": "无",
1472
+ "member": "bool",
1473
+ "name": "ForbidMoveAndDelete",
1474
+ "output_required": false,
1475
+ "required": false,
1476
+ "type": "bool",
1477
+ "value_allowed_null": true
1446
1478
  }
1447
1479
  ],
1448
1480
  "usage": "both"
@@ -1792,7 +1824,7 @@
1792
1824
  },
1793
1825
  {
1794
1826
  "disabled": false,
1795
- "document": "WEB嵌入资源类型。\n<br/>CREATE_SEAL: 创建印章\n<br/>PREVIEW_SEAL_LIST:预览印章列表\n<br/>PREVIEW_SEAL_DETAIL:预览印章详情\n<br/>EXTEND_SERVICE:拓展服务\n",
1827
+ "document": "WEB嵌入资源类型。\n<br/>CREATE_SEAL: 创建印章\n<br/>PREVIEW_SEAL_LIST:预览印章列表\n<br/>PREVIEW_SEAL_DETAIL:预览印章详情\n<br/>EXTEND_SERVICE:拓展服务\n<br/>PREVIEW_FLOW:预览合同\n<br/>PREVIEW_FLOW_DETAIL:查看合同详情",
1796
1828
  "example": "无",
1797
1829
  "is_base64": false,
1798
1830
  "member": "string",
@@ -1829,6 +1861,16 @@
1829
1861
  "name": "Reviewer",
1830
1862
  "required": false,
1831
1863
  "type": "object"
1864
+ },
1865
+ {
1866
+ "disabled": false,
1867
+ "document": "个性化参数",
1868
+ "example": "无",
1869
+ "is_base64": false,
1870
+ "member": "EmbedUrlOption",
1871
+ "name": "Option",
1872
+ "required": false,
1873
+ "type": "object"
1832
1874
  }
1833
1875
  ],
1834
1876
  "type": "object"
@@ -2391,6 +2433,94 @@
2391
2433
  ],
2392
2434
  "type": "object"
2393
2435
  },
2436
+ "CreateFlowOption": {
2437
+ "document": "创建合同个性化参数",
2438
+ "members": [
2439
+ {
2440
+ "disabled": false,
2441
+ "document": "是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。\n<br/>true:允许编辑(默认),<br/>false:不允许编辑<br/>默认:false:不允许编辑",
2442
+ "example": "true",
2443
+ "member": "bool",
2444
+ "name": "CanEditFlow",
2445
+ "required": false,
2446
+ "type": "bool"
2447
+ },
2448
+ {
2449
+ "disabled": false,
2450
+ "document": "是否允许编辑模版控件\n<br/>true:允许编辑模版控件信息\n<br/>false:不允许编辑模版控件信息\n<br/>默认false:不允许编辑模版控件信息",
2451
+ "example": "true",
2452
+ "member": "bool",
2453
+ "name": "CanEditFormField",
2454
+ "required": false,
2455
+ "type": "bool"
2456
+ },
2457
+ {
2458
+ "disabled": false,
2459
+ "document": "发起页面隐藏合同名称展示\n<br/>true:发起页面隐藏合同名称展示\n<br/>false:发起页面不隐藏合同名称展示\n<br/>默认false:发起页面不隐藏合同名称展示",
2460
+ "example": "true",
2461
+ "member": "bool",
2462
+ "name": "HideShowFlowName",
2463
+ "required": false,
2464
+ "type": "bool"
2465
+ },
2466
+ {
2467
+ "disabled": false,
2468
+ "document": "发起页面隐藏合同类型展示\n<br/>true:发起页面隐藏合同类型展示\n<br/>false:发起页面不隐藏合同类型展示\n<br/>默认false:发起页面不隐藏合同类型展示\n",
2469
+ "example": "true",
2470
+ "member": "bool",
2471
+ "name": "HideShowFlowType",
2472
+ "required": false,
2473
+ "type": "bool"
2474
+ },
2475
+ {
2476
+ "disabled": false,
2477
+ "document": "发起页面隐藏合同截止日期展示\n<br/>true:发起页面隐藏合同截止日期展示\n<br/>false:发起页面不隐藏合同截止日期展示\n<br/>默认false:发起页面不隐藏合同截止日期展示",
2478
+ "example": "true",
2479
+ "member": "bool",
2480
+ "name": "HideShowDeadline",
2481
+ "required": false,
2482
+ "type": "bool"
2483
+ },
2484
+ {
2485
+ "disabled": false,
2486
+ "document": "发起页面允许跳过添加签署人环节\n<br/>true:发起页面允许跳过添加签署人环节\n<br/>false:发起页面不允许跳过添加签署人环节\n<br/>默认false:发起页面不允许跳过添加签署人环节\n",
2487
+ "example": "true",
2488
+ "member": "bool",
2489
+ "name": "CanSkipAddApprover",
2490
+ "required": false,
2491
+ "type": "bool"
2492
+ },
2493
+ {
2494
+ "disabled": false,
2495
+ "document": "文件发起页面跳过文件上传步骤\n<br/>true:文件发起页面跳过文件上传步骤\n<br/>false:文件发起页面不跳过文件上传步骤\n<br/>默认false:文件发起页面不跳过文件上传步骤",
2496
+ "example": "true",
2497
+ "member": "bool",
2498
+ "name": "SkipUploadFile",
2499
+ "required": false,
2500
+ "type": "bool"
2501
+ },
2502
+ {
2503
+ "disabled": false,
2504
+ "document": "禁止编辑填写控件\n<br/>true:禁止编辑填写控件\n<br/>false:允许编辑填写控件\n<br/>默认false:允许编辑填写控件",
2505
+ "example": "true",
2506
+ "member": "bool",
2507
+ "name": "ForbidEditFillComponent",
2508
+ "required": false,
2509
+ "type": "bool"
2510
+ },
2511
+ {
2512
+ "disabled": false,
2513
+ "document": "定制化发起合同弹窗的描述信息,描述信息最长500\n",
2514
+ "example": "“”",
2515
+ "is_base64": false,
2516
+ "member": "string",
2517
+ "name": "CustomCreateFlowDescription",
2518
+ "required": false,
2519
+ "type": "string"
2520
+ }
2521
+ ],
2522
+ "usage": "in"
2523
+ },
2394
2524
  "CreateFlowRemindsRequest": {
2395
2525
  "document": "CreateFlowReminds请求参数结构体",
2396
2526
  "members": [
@@ -3262,7 +3392,7 @@
3262
3392
  },
3263
3393
  {
3264
3394
  "disabled": false,
3265
- "document": "是否顺序签署(true:无序签,false:顺序签)",
3395
+ "document": "是否顺序签署\ntrue:无序签\nfalse:顺序签",
3266
3396
  "example": "true",
3267
3397
  "is_base64": false,
3268
3398
  "member": "bool",
@@ -3272,7 +3402,7 @@
3272
3402
  },
3273
3403
  {
3274
3404
  "disabled": false,
3275
- "document": "签署流程的签署截止时间。\n值为unix时间戳,精确到秒,不传默认为当前时间一年后",
3405
+ "document": "签署流程的签署截止时间。\n值为unix时间戳,精确到秒\n不传默认为当前时间一年后",
3276
3406
  "example": "无",
3277
3407
  "is_base64": false,
3278
3408
  "member": "int64",
@@ -3282,7 +3412,7 @@
3282
3412
  },
3283
3413
  {
3284
3414
  "disabled": false,
3285
- "document": "用户自定义合同类型",
3415
+ "document": "用户自定义合同类型Id\n该id为电子签企业内的合同类型id",
3286
3416
  "example": "无",
3287
3417
  "is_base64": false,
3288
3418
  "member": "string",
@@ -3302,7 +3432,7 @@
3302
3432
  },
3303
3433
  {
3304
3434
  "disabled": false,
3305
- "document": "打开智能添加填写区(默认开启,打开:\"OPEN\" 关闭:\"CLOSE\")",
3435
+ "document": "打开智能添加填写区\n(默认开启,打开:\"OPEN\"\n 关闭:\"CLOSE\"",
3306
3436
  "example": "OPEN",
3307
3437
  "is_base64": false,
3308
3438
  "member": "string",
@@ -3310,6 +3440,86 @@
3310
3440
  "required": false,
3311
3441
  "type": "string"
3312
3442
  },
3443
+ {
3444
+ "disabled": false,
3445
+ "document": "资源类型,\n1:文件,\n2:模板\n不传默认为1:文件\n目前仅支持文件",
3446
+ "example": "1",
3447
+ "is_base64": false,
3448
+ "member": "int64",
3449
+ "name": "ResourceType",
3450
+ "required": false,
3451
+ "type": "int"
3452
+ },
3453
+ {
3454
+ "disabled": false,
3455
+ "document": "发起方填写控件\n该类型控件由发起方完成填写",
3456
+ "example": "无",
3457
+ "is_base64": false,
3458
+ "member": "Component",
3459
+ "name": "Components",
3460
+ "required": false,
3461
+ "type": "object"
3462
+ },
3463
+ {
3464
+ "disabled": false,
3465
+ "document": "发起合同个性化参数\n用于满足创建及页面操作过程中的个性化要求\n具体定制化内容详见数据接口说明",
3466
+ "example": "无",
3467
+ "is_base64": false,
3468
+ "member": "CreateFlowOption",
3469
+ "name": "FlowOption",
3470
+ "required": false,
3471
+ "type": "object"
3472
+ },
3473
+ {
3474
+ "disabled": false,
3475
+ "document": "是否开启发起方签署审核\ntrue:开启发起方签署审核\nfalse:不开启发起方签署审核\n默认false:不开启发起方签署审核",
3476
+ "example": "无",
3477
+ "is_base64": false,
3478
+ "member": "bool",
3479
+ "name": "NeedSignReview",
3480
+ "required": false,
3481
+ "type": "bool"
3482
+ },
3483
+ {
3484
+ "disabled": false,
3485
+ "document": "开启发起方发起合同审核\ntrue:开启发起方发起合同审核\nfalse:不开启发起方发起合同审核\n默认false:不开启发起方发起合同审核",
3486
+ "example": "无",
3487
+ "is_base64": false,
3488
+ "member": "bool",
3489
+ "name": "NeedCreateReview",
3490
+ "required": false,
3491
+ "type": "bool"
3492
+ },
3493
+ {
3494
+ "disabled": false,
3495
+ "document": "用户自定义参数",
3496
+ "example": "无",
3497
+ "is_base64": false,
3498
+ "member": "string",
3499
+ "name": "UserData",
3500
+ "required": false,
3501
+ "type": "string"
3502
+ },
3503
+ {
3504
+ "disabled": false,
3505
+ "document": "合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接",
3506
+ "example": "无",
3507
+ "is_base64": false,
3508
+ "member": "string",
3509
+ "name": "FlowId",
3510
+ "required": false,
3511
+ "type": "string"
3512
+ },
3513
+ {
3514
+ "disabled": false,
3515
+ "document": "合同类型名称\n该字段用于客户自定义合同类型\n建议使用时指定合同类型,便于之后合同分类以及查看",
3516
+ "example": "\"劳动合同\"",
3517
+ "is_base64": false,
3518
+ "member": "string",
3519
+ "name": "FlowType",
3520
+ "required": false,
3521
+ "type": "string"
3522
+ },
3313
3523
  {
3314
3524
  "disabled": false,
3315
3525
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填\t",
@@ -4455,29 +4665,31 @@
4455
4665
  "document": "集成版员工部门信息",
4456
4666
  "members": [
4457
4667
  {
4458
- "default": "",
4459
4668
  "disabled": false,
4460
4669
  "document": "部门id",
4461
4670
  "example": "无",
4671
+ "is_base64": false,
4462
4672
  "member": "string",
4463
4673
  "name": "DepartmentId",
4464
- "required": true,
4674
+ "output_required": true,
4675
+ "required": false,
4465
4676
  "type": "string",
4466
4677
  "value_allowed_null": false
4467
4678
  },
4468
4679
  {
4469
- "default": "",
4470
4680
  "disabled": false,
4471
4681
  "document": "部门名称",
4472
4682
  "example": "无",
4683
+ "is_base64": false,
4473
4684
  "member": "string",
4474
4685
  "name": "DepartmentName",
4475
- "required": true,
4686
+ "output_required": true,
4687
+ "required": false,
4476
4688
  "type": "string",
4477
4689
  "value_allowed_null": false
4478
4690
  }
4479
4691
  ],
4480
- "usage": "out"
4692
+ "usage": "both"
4481
4693
  },
4482
4694
  "DescribeExtendedServiceAuthInfosRequest": {
4483
4695
  "document": "DescribeExtendedServiceAuthInfos请求参数结构体",
@@ -4943,7 +5155,7 @@
4943
5155
  "members": [
4944
5156
  {
4945
5157
  "disabled": false,
4946
- "document": "调用方员工/经办人信息\nUserId 必填,在企业控制台组织架构中可以查到员工的UserId\n注:请保证对应",
5158
+ "document": "调用方员工/经办人信息\nUserId 必填,在企业控制台组织架构中可以查到员工的UserId\n注:请保证员工有相关的角色权限",
4947
5159
  "example": "无",
4948
5160
  "is_base64": false,
4949
5161
  "member": "UserInfo",
@@ -5799,6 +6011,30 @@
5799
6011
  ],
5800
6012
  "type": "object"
5801
6013
  },
6014
+ "EmbedUrlOption": {
6015
+ "document": "个性化参数",
6016
+ "members": [
6017
+ {
6018
+ "disabled": false,
6019
+ "document": "合同详情预览,允许展示控件信息\n<br/>true:允许在合同详情页展示控件\n<br/>false:不允许在合同详情页展示控件\n<br/>默认false,合同详情页不展示控件",
6020
+ "example": "true",
6021
+ "member": "bool",
6022
+ "name": "ShowFlowDetailComponent",
6023
+ "required": false,
6024
+ "type": "bool"
6025
+ },
6026
+ {
6027
+ "disabled": false,
6028
+ "document": "模版预览,允许展示模版控件信息\n<br/>true:允许在模版预览页展示控件\n<br/>false:不允许在模版预览页展示控件\n<br/>默认false,模版预览页不展示控件",
6029
+ "example": "true",
6030
+ "member": "bool",
6031
+ "name": "ShowTemplateComponent",
6032
+ "required": false,
6033
+ "type": "bool"
6034
+ }
6035
+ ],
6036
+ "usage": "in"
6037
+ },
5802
6038
  "ExtendAuthInfo": {
5803
6039
  "document": "授权服务信息",
5804
6040
  "members": [
@@ -6037,7 +6273,7 @@
6037
6273
  "members": [
6038
6274
  {
6039
6275
  "disabled": false,
6040
- "document": "文件Id",
6276
+ "document": "文件ID",
6041
6277
  "example": "无",
6042
6278
  "is_base64": false,
6043
6279
  "member": "string",
@@ -6072,7 +6308,7 @@
6072
6308
  },
6073
6309
  {
6074
6310
  "disabled": false,
6075
- "document": "文件上传时间,10位时间戳(精确到秒)",
6311
+ "document": "文件上传时间,格式为Unix标准时间戳(秒)",
6076
6312
  "example": "无",
6077
6313
  "member": "int64",
6078
6314
  "name": "CreatedOn",
@@ -6111,7 +6347,7 @@
6111
6347
  "usage": "out"
6112
6348
  },
6113
6349
  "FillApproverInfo": {
6114
- "document": "补充签署人信息\n- RecipientId 必须指定\n- 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填\n- 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填",
6350
+ "document": "补充签署人信息\n- RecipientId 必须指定\n- 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP\n- 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空",
6115
6351
  "members": [
6116
6352
  {
6117
6353
  "disabled": false,
@@ -6125,7 +6361,7 @@
6125
6361
  },
6126
6362
  {
6127
6363
  "disabled": false,
6128
- "document": "签署人来源\nWEWORKAPP: 企业微信",
6364
+ "document": "签署人来源\nWEWORKAPP: 企业微信\n<br/>仅【企微或签】时指定WEWORKAPP",
6129
6365
  "example": "WEWORKAPP",
6130
6366
  "is_base64": false,
6131
6367
  "member": "string",
@@ -6135,7 +6371,7 @@
6135
6371
  },
6136
6372
  {
6137
6373
  "disabled": false,
6138
- "document": "企业自定义账号ID\nWEWORKAPP场景下指企业自有应用获取企微明文的userid",
6374
+ "document": "企业自定义账号ID\n<br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid",
6139
6375
  "example": "zhangsan",
6140
6376
  "is_base64": false,
6141
6377
  "member": "string",
@@ -6560,7 +6796,7 @@
6560
6796
  },
6561
6797
  {
6562
6798
  "disabled": false,
6563
- "document": "如果签署方为企业,需要填入企业全称",
6799
+ "document": "签署人企业名称\n<br/>当approverType=1 或 approverType=3时,必须指定\n\n",
6564
6800
  "example": "无",
6565
6801
  "is_base64": false,
6566
6802
  "member": "string",
@@ -6570,7 +6806,7 @@
6570
6806
  },
6571
6807
  {
6572
6808
  "disabled": false,
6573
- "document": "签署方经办人姓名",
6809
+ "document": "签署方经办人姓名\n<br/>在未指定签署人电子签UserId情况下,为必填参数",
6574
6810
  "example": "无",
6575
6811
  "is_base64": false,
6576
6812
  "member": "string",
@@ -6580,7 +6816,7 @@
6580
6816
  },
6581
6817
  {
6582
6818
  "disabled": false,
6583
- "document": "签署方经办人手机号码",
6819
+ "document": "签署方经办人手机号码\n<br/>在未指定签署人电子签UserId情况下,为必填参数\n",
6584
6820
  "example": "无",
6585
6821
  "is_base64": false,
6586
6822
  "member": "string",
@@ -6610,7 +6846,7 @@
6610
6846
  },
6611
6847
  {
6612
6848
  "disabled": false,
6613
- "document": "签署方经办人在模板中的参与方ID",
6849
+ "document": "签署方经办人在模板中的参与方ID\n<br/>模版发起合同时,该参数为必填项\n<br/>文件发起合同是,该参数无序传值\n",
6614
6850
  "example": "无",
6615
6851
  "is_base64": false,
6616
6852
  "member": "string",
@@ -6630,7 +6866,7 @@
6630
6866
  },
6631
6867
  {
6632
6868
  "disabled": false,
6633
- "document": "是否发送短信,sms--短信通知,none--不通知,默认为sms;发起方=签署方时不发送短信",
6869
+ "document": "是否发送短信\n<br/>sms--短信通知\n<br/>none--不通知\n<br/>默认为sms\n<br/>发起方=签署方时不发送短信",
6634
6870
  "example": "无",
6635
6871
  "is_base64": false,
6636
6872
  "member": "string",
@@ -6658,7 +6894,7 @@
6658
6894
  },
6659
6895
  {
6660
6896
  "disabled": false,
6661
- "document": "签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。",
6897
+ "document": "签署方经办人的电子签用户ID\n<br/>当未指定签署人姓名+手机号的情况下,该字段毕传\n",
6662
6898
  "example": "无",
6663
6899
  "is_base64": false,
6664
6900
  "member": "string",
@@ -6677,7 +6913,7 @@
6677
6913
  },
6678
6914
  {
6679
6915
  "disabled": false,
6680
- "document": "签署人用户来源,企微侧用户请传入:WEWORKAPP",
6916
+ "document": "签署人用户来源\n<br/>企微侧用户请传入:WEWORKAPP",
6681
6917
  "example": "无",
6682
6918
  "is_base64": false,
6683
6919
  "member": "string",
@@ -6687,7 +6923,7 @@
6687
6923
  },
6688
6924
  {
6689
6925
  "disabled": false,
6690
- "document": "企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP",
6926
+ "document": "企业签署方或签标识,客户自定义,64位长度\n<br>用于发起含有或签签署人的合同。或签参与人必须有此字段。\n<br/>合同内不同或签参与人CustomApproverTag需要保证唯一。\n<br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP",
6691
6927
  "example": "无",
6692
6928
  "is_base64": false,
6693
6929
  "member": "string",
@@ -6735,7 +6971,7 @@
6735
6971
  },
6736
6972
  {
6737
6973
  "disabled": false,
6738
- "document": "当前签署方进行签署操作是否需要企业内部审批,true 则为需要。为个人签署方时则由发起方企业审核。",
6974
+ "document": "当前签署方进行签署操作是否需要企业内部审批\n<br>true 则为需要\n<br/>false,无序企业内部审批(默认)\n<br/>为个人签署方时则由发起方企业审核。",
6739
6975
  "example": "无",
6740
6976
  "member": "bool",
6741
6977
  "name": "ApproverNeedSignReview",
@@ -6744,7 +6980,7 @@
6744
6980
  },
6745
6981
  {
6746
6982
  "disabled": false,
6747
- "document": "签署人签署控件",
6983
+ "document": "签署人签署控件\n<br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置",
6748
6984
  "example": "无",
6749
6985
  "member": "Component",
6750
6986
  "name": "SignComponents",
@@ -6753,7 +6989,7 @@
6753
6989
  },
6754
6990
  {
6755
6991
  "disabled": false,
6756
- "document": "签署人填写控件",
6992
+ "document": "签署人填写控件\n<br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置",
6757
6993
  "example": "无",
6758
6994
  "member": "Component",
6759
6995
  "name": "Components",
@@ -7798,7 +8034,7 @@
7798
8034
  "example": "无",
7799
8035
  "member": "int64",
7800
8036
  "name": "VerifyResult",
7801
- "required": true,
8037
+ "output_required": true,
7802
8038
  "type": "int",
7803
8039
  "value_allowed_null": false
7804
8040
  },
@@ -7808,7 +8044,7 @@
7808
8044
  "example": "无",
7809
8045
  "member": "string",
7810
8046
  "name": "SignPlatform",
7811
- "required": true,
8047
+ "output_required": true,
7812
8048
  "type": "string",
7813
8049
  "value_allowed_null": false
7814
8050
  },
@@ -7818,7 +8054,7 @@
7818
8054
  "example": "无",
7819
8055
  "member": "string",
7820
8056
  "name": "SignerName",
7821
- "required": true,
8057
+ "output_required": true,
7822
8058
  "type": "string",
7823
8059
  "value_allowed_null": false
7824
8060
  },
@@ -7828,7 +8064,7 @@
7828
8064
  "example": "无",
7829
8065
  "member": "int64",
7830
8066
  "name": "SignTime",
7831
- "required": true,
8067
+ "output_required": true,
7832
8068
  "type": "int",
7833
8069
  "value_allowed_null": false
7834
8070
  },
@@ -7838,7 +8074,7 @@
7838
8074
  "example": "无",
7839
8075
  "member": "string",
7840
8076
  "name": "SignAlgorithm",
7841
- "required": true,
8077
+ "output_required": true,
7842
8078
  "type": "string",
7843
8079
  "value_allowed_null": false
7844
8080
  },
@@ -7848,27 +8084,27 @@
7848
8084
  "example": "无",
7849
8085
  "member": "string",
7850
8086
  "name": "CertSn",
7851
- "required": true,
8087
+ "output_required": true,
7852
8088
  "type": "string",
7853
8089
  "value_allowed_null": false
7854
8090
  },
7855
8091
  {
7856
8092
  "disabled": false,
7857
- "document": "证书起始时间戳,单位秒",
8093
+ "document": "证书起始时间戳,单位毫秒",
7858
8094
  "example": "无",
7859
8095
  "member": "int64",
7860
8096
  "name": "CertNotBefore",
7861
- "required": true,
8097
+ "output_required": true,
7862
8098
  "type": "int",
7863
8099
  "value_allowed_null": false
7864
8100
  },
7865
8101
  {
7866
8102
  "disabled": false,
7867
- "document": "证书过期时间戳,单位秒",
8103
+ "document": "证书过期时间戳,单位毫秒",
7868
8104
  "example": "无",
7869
8105
  "member": "int64",
7870
8106
  "name": "CertNotAfter",
7871
- "required": true,
8107
+ "output_required": true,
7872
8108
  "type": "int",
7873
8109
  "value_allowed_null": false
7874
8110
  },
@@ -7878,7 +8114,7 @@
7878
8114
  "example": "无",
7879
8115
  "member": "float",
7880
8116
  "name": "ComponentPosX",
7881
- "required": true,
8117
+ "output_required": true,
7882
8118
  "type": "float",
7883
8119
  "value_allowed_null": false
7884
8120
  },
@@ -7888,7 +8124,7 @@
7888
8124
  "example": "无",
7889
8125
  "member": "float",
7890
8126
  "name": "ComponentPosY",
7891
- "required": true,
8127
+ "output_required": true,
7892
8128
  "type": "float",
7893
8129
  "value_allowed_null": false
7894
8130
  },
@@ -7898,7 +8134,7 @@
7898
8134
  "example": "无",
7899
8135
  "member": "float",
7900
8136
  "name": "ComponentWidth",
7901
- "required": true,
8137
+ "output_required": true,
7902
8138
  "type": "float",
7903
8139
  "value_allowed_null": false
7904
8140
  },
@@ -7908,7 +8144,7 @@
7908
8144
  "example": "无",
7909
8145
  "member": "float",
7910
8146
  "name": "ComponentHeight",
7911
- "required": true,
8147
+ "output_required": true,
7912
8148
  "type": "float",
7913
8149
  "value_allowed_null": false
7914
8150
  },
@@ -7918,7 +8154,7 @@
7918
8154
  "example": "无",
7919
8155
  "member": "int64",
7920
8156
  "name": "ComponentPage",
7921
- "required": true,
8157
+ "output_required": true,
7922
8158
  "type": "int",
7923
8159
  "value_allowed_null": false
7924
8160
  }
@@ -7926,24 +8162,28 @@
7926
8162
  "usage": "out"
7927
8163
  },
7928
8164
  "Recipient": {
7929
- "document": "签署参与者信息",
8165
+ "document": "流程中参与方的信息结构",
7930
8166
  "members": [
7931
8167
  {
7932
8168
  "disabled": false,
7933
- "document": "签署参与者ID",
8169
+ "document": "签署参与者ID,唯一标识",
7934
8170
  "example": "无",
8171
+ "is_base64": false,
7935
8172
  "member": "string",
7936
8173
  "name": "RecipientId",
8174
+ "output_required": true,
7937
8175
  "required": false,
7938
8176
  "type": "string",
7939
8177
  "value_allowed_null": false
7940
8178
  },
7941
8179
  {
7942
8180
  "disabled": false,
7943
- "document": "参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方",
8181
+ "document": "参与者类型。\n默认为空。\nENTERPRISE-企业;\nINDIVIDUAL-个人;\nPROMOTER-发起方",
7944
8182
  "example": "ENTERPRISE",
8183
+ "is_base64": false,
7945
8184
  "member": "string",
7946
8185
  "name": "RecipientType",
8186
+ "output_required": true,
7947
8187
  "required": false,
7948
8188
  "type": "string",
7949
8189
  "value_allowed_null": false
@@ -7952,8 +8192,10 @@
7952
8192
  "disabled": false,
7953
8193
  "document": "描述信息",
7954
8194
  "example": "无",
8195
+ "is_base64": false,
7955
8196
  "member": "string",
7956
8197
  "name": "Description",
8198
+ "output_required": true,
7957
8199
  "required": false,
7958
8200
  "type": "string",
7959
8201
  "value_allowed_null": false
@@ -7962,48 +8204,54 @@
7962
8204
  "disabled": false,
7963
8205
  "document": "角色名称",
7964
8206
  "example": "无",
8207
+ "is_base64": false,
7965
8208
  "member": "string",
7966
8209
  "name": "RoleName",
8210
+ "output_required": true,
7967
8211
  "required": false,
7968
8212
  "type": "string",
7969
8213
  "value_allowed_null": false
7970
8214
  },
7971
8215
  {
7972
8216
  "disabled": false,
7973
- "document": "是否需要验证,默认为false",
8217
+ "document": "是否需要验证,\n默认为false-不需要验证",
7974
8218
  "example": "无",
7975
8219
  "member": "bool",
7976
8220
  "name": "RequireValidation",
8221
+ "output_required": true,
7977
8222
  "required": false,
7978
8223
  "type": "bool",
7979
8224
  "value_allowed_null": false
7980
8225
  },
7981
8226
  {
7982
8227
  "disabled": false,
7983
- "document": "是否需要签署,默认为true",
8228
+ "document": "是否需要签署,\n默认为true-需要签署",
7984
8229
  "example": "无",
7985
8230
  "member": "bool",
7986
8231
  "name": "RequireSign",
8232
+ "output_required": true,
7987
8233
  "required": false,
7988
8234
  "type": "bool",
7989
8235
  "value_allowed_null": false
7990
8236
  },
7991
8237
  {
7992
8238
  "disabled": false,
7993
- "document": "添加序列,0~N",
8239
+ "document": "此参与方添加的顺序,从0~N",
7994
8240
  "example": "无",
7995
8241
  "member": "int64",
7996
8242
  "name": "RoutingOrder",
8243
+ "output_required": true,
7997
8244
  "required": false,
7998
8245
  "type": "int",
7999
8246
  "value_allowed_null": false
8000
8247
  },
8001
8248
  {
8002
8249
  "disabled": false,
8003
- "document": "是否需要发送,默认为true",
8250
+ "document": "是否需要发送,\n默认为true-需要发送",
8004
8251
  "example": "无",
8005
8252
  "member": "bool",
8006
8253
  "name": "RequireDelivery",
8254
+ "output_required": true,
8007
8255
  "required": false,
8008
8256
  "type": "bool",
8009
8257
  "value_allowed_null": false
@@ -8012,8 +8260,10 @@
8012
8260
  "disabled": false,
8013
8261
  "document": "邮箱地址",
8014
8262
  "example": "无",
8263
+ "is_base64": false,
8015
8264
  "member": "string",
8016
8265
  "name": "Email",
8266
+ "output_required": true,
8017
8267
  "required": false,
8018
8268
  "type": "string",
8019
8269
  "value_allowed_null": false
@@ -8022,38 +8272,46 @@
8022
8272
  "disabled": false,
8023
8273
  "document": "电话号码",
8024
8274
  "example": "无",
8275
+ "is_base64": false,
8025
8276
  "member": "string",
8026
8277
  "name": "Mobile",
8278
+ "output_required": true,
8027
8279
  "required": false,
8028
8280
  "type": "string",
8029
8281
  "value_allowed_null": false
8030
8282
  },
8031
8283
  {
8032
8284
  "disabled": false,
8033
- "document": "关联的用户ID",
8285
+ "document": "关联的用户ID,电子签系统的用户ID",
8034
8286
  "example": "无",
8287
+ "is_base64": false,
8035
8288
  "member": "string",
8036
8289
  "name": "UserId",
8290
+ "output_required": true,
8037
8291
  "required": false,
8038
8292
  "type": "string",
8039
8293
  "value_allowed_null": false
8040
8294
  },
8041
8295
  {
8042
8296
  "disabled": false,
8043
- "document": "发送方式。默认为EMAIL。EMAIL-邮件;MOBILE-手机短信;WECHAT-微信通知",
8297
+ "document": "发送方式,默认为EMAIL。\nEMAIL-邮件;\nMOBILE-手机短信;\nWECHAT-微信通知",
8044
8298
  "example": "EMAIL",
8299
+ "is_base64": false,
8045
8300
  "member": "string",
8046
8301
  "name": "DeliveryMethod",
8302
+ "output_required": true,
8047
8303
  "required": false,
8048
8304
  "type": "string",
8049
8305
  "value_allowed_null": false
8050
8306
  },
8051
8307
  {
8052
8308
  "disabled": false,
8053
- "document": "附属信息",
8309
+ "document": "参与方的一些附属信息,json格式",
8054
8310
  "example": "无",
8311
+ "is_base64": false,
8055
8312
  "member": "string",
8056
8313
  "name": "RecipientExtra",
8314
+ "output_required": true,
8057
8315
  "required": false,
8058
8316
  "type": "string",
8059
8317
  "value_allowed_null": false
@@ -8326,8 +8584,39 @@
8326
8584
  "usage": "in"
8327
8585
  },
8328
8586
  "SealInfo": {
8329
- "document": "模板结构体中的印章信息",
8330
- "members": [],
8587
+ "document": "模板中指定的印章信息",
8588
+ "members": [
8589
+ {
8590
+ "disabled": false,
8591
+ "document": "印章ID\n注意:此字段可能返回 null,表示取不到有效值。",
8592
+ "example": "无",
8593
+ "member": "string",
8594
+ "name": "SealId",
8595
+ "output_required": true,
8596
+ "type": "string",
8597
+ "value_allowed_null": true
8598
+ },
8599
+ {
8600
+ "disabled": false,
8601
+ "document": "印章类型。LEGAL_PERSON_SEAL: 法定代表人章;\nORGANIZATIONSEAL:企业印章;\nOFFICIAL:企业公章;\nCONTRACT:合同专用章\n注意:此字段可能返回 null,表示取不到有效值。",
8602
+ "example": "无",
8603
+ "member": "string",
8604
+ "name": "SealType",
8605
+ "output_required": true,
8606
+ "type": "string",
8607
+ "value_allowed_null": true
8608
+ },
8609
+ {
8610
+ "disabled": false,
8611
+ "document": "印章名称\n注意:此字段可能返回 null,表示取不到有效值。",
8612
+ "example": "无",
8613
+ "member": "string",
8614
+ "name": "SealName",
8615
+ "output_required": true,
8616
+ "type": "string",
8617
+ "value_allowed_null": true
8618
+ }
8619
+ ],
8331
8620
  "usage": "out"
8332
8621
  },
8333
8622
  "SignQrCode": {
@@ -8569,29 +8858,31 @@
8569
8858
  "document": "集成版企业角色信息",
8570
8859
  "members": [
8571
8860
  {
8572
- "default": "",
8573
8861
  "disabled": false,
8574
8862
  "document": "角色id\n注意:此字段可能返回 null,表示取不到有效值。",
8575
8863
  "example": "无",
8864
+ "is_base64": false,
8576
8865
  "member": "string",
8577
8866
  "name": "RoleId",
8578
- "required": true,
8867
+ "output_required": true,
8868
+ "required": false,
8579
8869
  "type": "string",
8580
8870
  "value_allowed_null": true
8581
8871
  },
8582
8872
  {
8583
- "default": "",
8584
8873
  "disabled": false,
8585
8874
  "document": "角色名称\n注意:此字段可能返回 null,表示取不到有效值。",
8586
8875
  "example": "无",
8876
+ "is_base64": false,
8587
8877
  "member": "string",
8588
8878
  "name": "RoleName",
8589
- "required": true,
8879
+ "output_required": true,
8880
+ "required": false,
8590
8881
  "type": "string",
8591
8882
  "value_allowed_null": true
8592
8883
  }
8593
8884
  ],
8594
- "usage": "out"
8885
+ "usage": "both"
8595
8886
  },
8596
8887
  "StartFlowRequest": {
8597
8888
  "document": "StartFlow请求参数结构体",
@@ -8797,24 +9088,28 @@
8797
9088
  "usage": "out"
8798
9089
  },
8799
9090
  "TemplateInfo": {
8800
- "document": "企业模板的信息结构",
9091
+ "document": "此结构体 (TemplateInfo) 用于描述模板的信息。\n\n> **模板组成** \n>\n> 一个模板通常会包含以下结构信息\n>- 模板基本信息\n>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方\n>- 填写控件 Components\n>- 签署控件 SignComponents\n>- 生成模板的文件基础信息 FileInfos",
8801
9092
  "members": [
8802
9093
  {
8803
9094
  "disabled": false,
8804
- "document": "模板ID",
9095
+ "document": "模板ID,模板的唯一标识",
8805
9096
  "example": "无",
9097
+ "is_base64": false,
8806
9098
  "member": "string",
8807
9099
  "name": "TemplateId",
9100
+ "output_required": true,
8808
9101
  "required": false,
8809
9102
  "type": "string",
8810
9103
  "value_allowed_null": false
8811
9104
  },
8812
9105
  {
8813
9106
  "disabled": false,
8814
- "document": "模板名字",
9107
+ "document": "模板名",
8815
9108
  "example": "无",
9109
+ "is_base64": false,
8816
9110
  "member": "string",
8817
9111
  "name": "TemplateName",
9112
+ "output_required": true,
8818
9113
  "required": false,
8819
9114
  "type": "string",
8820
9115
  "value_allowed_null": false
@@ -8823,8 +9118,10 @@
8823
9118
  "disabled": false,
8824
9119
  "document": "模板描述信息",
8825
9120
  "example": "无",
9121
+ "is_base64": false,
8826
9122
  "member": "string",
8827
9123
  "name": "Description",
9124
+ "output_required": true,
8828
9125
  "required": false,
8829
9126
  "type": "string",
8830
9127
  "value_allowed_null": false
@@ -8833,18 +9130,21 @@
8833
9130
  "disabled": false,
8834
9131
  "document": "模板关联的资源ID列表",
8835
9132
  "example": "无",
9133
+ "is_base64": false,
8836
9134
  "member": "string",
8837
9135
  "name": "DocumentResourceIds",
9136
+ "output_required": true,
8838
9137
  "required": false,
8839
9138
  "type": "list",
8840
9139
  "value_allowed_null": false
8841
9140
  },
8842
9141
  {
8843
9142
  "disabled": false,
8844
- "document": "返回的文件信息结构",
9143
+ "document": "生成模板的文件基础信息",
8845
9144
  "example": "无",
8846
9145
  "member": "FileInfo",
8847
9146
  "name": "FileInfos",
9147
+ "output_required": true,
8848
9148
  "required": false,
8849
9149
  "type": "list",
8850
9150
  "value_allowed_null": false
@@ -8853,118 +9153,133 @@
8853
9153
  "disabled": false,
8854
9154
  "document": "附件关联的资源ID",
8855
9155
  "example": "无",
9156
+ "is_base64": false,
8856
9157
  "member": "string",
8857
9158
  "name": "AttachmentResourceIds",
9159
+ "output_required": true,
8858
9160
  "required": false,
8859
9161
  "type": "list",
8860
9162
  "value_allowed_null": false
8861
9163
  },
8862
9164
  {
8863
9165
  "disabled": false,
8864
- "document": "签署顺序",
9166
+ "document": "签署顺序\n无序 -1\n有序为序列数字 0,1,2",
8865
9167
  "example": "无",
8866
9168
  "member": "int64",
8867
9169
  "name": "SignOrder",
9170
+ "output_required": true,
8868
9171
  "required": false,
8869
9172
  "type": "list",
8870
9173
  "value_allowed_null": false
8871
9174
  },
8872
9175
  {
8873
9176
  "disabled": false,
8874
- "document": "签署参与者的信息",
9177
+ "document": "模板中的签署参与方列表",
8875
9178
  "example": "无",
8876
9179
  "member": "Recipient",
8877
9180
  "name": "Recipients",
9181
+ "output_required": true,
8878
9182
  "required": false,
8879
9183
  "type": "list",
8880
9184
  "value_allowed_null": false
8881
9185
  },
8882
9186
  {
8883
9187
  "disabled": false,
8884
- "document": "模板信息结构",
9188
+ "document": "模板的填充控件列表",
8885
9189
  "example": "无",
8886
9190
  "member": "Component",
8887
9191
  "name": "Components",
9192
+ "output_required": true,
8888
9193
  "required": false,
8889
9194
  "type": "list",
8890
9195
  "value_allowed_null": false
8891
9196
  },
8892
9197
  {
8893
9198
  "disabled": false,
8894
- "document": "签署区模板信息结构",
9199
+ "document": "模板中的签署控件列表",
8895
9200
  "example": "无",
8896
9201
  "member": "Component",
8897
9202
  "name": "SignComponents",
9203
+ "output_required": true,
8898
9204
  "required": false,
8899
9205
  "type": "list",
8900
9206
  "value_allowed_null": false
8901
9207
  },
8902
9208
  {
8903
9209
  "disabled": false,
8904
- "document": "模板状态(-1:不可用;0:草稿态;1:正式态)",
9210
+ "document": "模板状态\n-1:不可用\n0:草稿态\n1:正式态,可以正常使用",
8905
9211
  "example": "无",
8906
9212
  "member": "int64",
8907
9213
  "name": "Status",
9214
+ "output_required": true,
8908
9215
  "required": false,
8909
9216
  "type": "int",
8910
9217
  "value_allowed_null": false
8911
9218
  },
8912
9219
  {
8913
9220
  "disabled": false,
8914
- "document": "模板的创建人UserId",
9221
+ "document": "模板的创建者信息,电子签系统用户ID",
8915
9222
  "example": "无",
9223
+ "is_base64": false,
8916
9224
  "member": "string",
8917
9225
  "name": "Creator",
9226
+ "output_required": true,
8918
9227
  "required": false,
8919
9228
  "type": "string",
8920
9229
  "value_allowed_null": false
8921
9230
  },
8922
9231
  {
8923
9232
  "disabled": false,
8924
- "document": "模板创建的时间戳,单位秒",
9233
+ "document": "模板创建的时间戳,格式为Unix标准时间戳(秒)",
8925
9234
  "example": "无",
8926
9235
  "member": "int64",
8927
9236
  "name": "CreatedOn",
9237
+ "output_required": true,
8928
9238
  "required": false,
8929
9239
  "type": "int",
8930
9240
  "value_allowed_null": false
8931
9241
  },
8932
9242
  {
8933
9243
  "disabled": false,
8934
- "document": "发起人角色信息",
9244
+ "document": "发起方参与信息Promoter",
8935
9245
  "example": "无",
8936
9246
  "member": "Recipient",
8937
9247
  "name": "Promoter",
9248
+ "output_required": true,
8938
9249
  "required": false,
8939
9250
  "type": "object",
8940
9251
  "value_allowed_null": false
8941
9252
  },
8942
9253
  {
8943
9254
  "disabled": false,
8944
- "document": "模板类型\n取值:\n1 静默签,\n3 普通模板",
9255
+ "document": "模板类型:\n1 静默签,\n3 普通模板",
8945
9256
  "example": "无",
8946
9257
  "member": "int64",
8947
9258
  "name": "TemplateType",
9259
+ "output_required": true,
8948
9260
  "required": false,
8949
9261
  "type": "int",
8950
9262
  "value_allowed_null": false
8951
9263
  },
8952
9264
  {
8953
9265
  "disabled": false,
8954
- "document": "模板可用状态,取值:1启用(默认),2停用",
9266
+ "document": "模板可用状态:\n1 启用(默认)\n2 停用",
8955
9267
  "example": "无",
8956
9268
  "member": "int64",
8957
9269
  "name": "Available",
9270
+ "output_required": true,
8958
9271
  "required": false,
8959
9272
  "type": "int",
8960
9273
  "value_allowed_null": false
8961
9274
  },
8962
9275
  {
8963
9276
  "disabled": false,
8964
- "document": "创建模板的机构id",
9277
+ "document": "创建模板的企业ID,电子签的机构ID",
8965
9278
  "example": "无",
9279
+ "is_base64": false,
8966
9280
  "member": "string",
8967
9281
  "name": "OrganizationId",
9282
+ "output_required": true,
8968
9283
  "required": false,
8969
9284
  "type": "string",
8970
9285
  "value_allowed_null": false
@@ -8973,8 +9288,10 @@
8973
9288
  "disabled": false,
8974
9289
  "document": "模板预览链接,有效时间5分钟\n注意:此字段可能返回 null,表示取不到有效值。",
8975
9290
  "example": "无",
9291
+ "is_base64": false,
8976
9292
  "member": "string",
8977
9293
  "name": "PreviewUrl",
9294
+ "output_required": true,
8978
9295
  "required": false,
8979
9296
  "type": "string",
8980
9297
  "value_allowed_null": true
@@ -8983,18 +9300,21 @@
8983
9300
  "disabled": false,
8984
9301
  "document": "模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。\n注意:此字段可能返回 null,表示取不到有效值。",
8985
9302
  "example": "无",
9303
+ "is_base64": false,
8986
9304
  "member": "string",
8987
9305
  "name": "TemplateVersion",
9306
+ "output_required": true,
8988
9307
  "required": false,
8989
9308
  "type": "string",
8990
9309
  "value_allowed_null": true
8991
9310
  },
8992
9311
  {
8993
9312
  "disabled": false,
8994
- "document": "模板是否已发布。true-已发布;false-未发布\n注意:此字段可能返回 null,表示取不到有效值。",
9313
+ "document": "模板是否已发布:\ntrue-已发布\nfalse-未发布\n注意:此字段可能返回 null,表示取不到有效值。",
8995
9314
  "example": "无",
8996
9315
  "member": "bool",
8997
9316
  "name": "Published",
9317
+ "output_required": true,
8998
9318
  "required": false,
8999
9319
  "type": "bool",
9000
9320
  "value_allowed_null": true
@@ -9005,6 +9325,7 @@
9005
9325
  "example": "无",
9006
9326
  "member": "SealInfo",
9007
9327
  "name": "TemplateSeals",
9328
+ "output_required": true,
9008
9329
  "required": false,
9009
9330
  "type": "list",
9010
9331
  "value_allowed_null": true
@@ -9015,6 +9336,7 @@
9015
9336
  "example": "无",
9016
9337
  "member": "SealInfo",
9017
9338
  "name": "Seals",
9339
+ "output_required": true,
9018
9340
  "required": false,
9019
9341
  "type": "list",
9020
9342
  "value_allowed_null": true
@@ -9095,8 +9417,9 @@
9095
9417
  "members": [
9096
9418
  {
9097
9419
  "disabled": false,
9098
- "document": "操作人信息,userId必填",
9420
+ "document": "当前用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为YUFU;",
9099
9421
  "example": "无",
9422
+ "is_base64": false,
9100
9423
  "member": "UserInfo",
9101
9424
  "name": "Operator",
9102
9425
  "required": true,
@@ -9106,6 +9429,7 @@
9106
9429
  "disabled": false,
9107
9430
  "document": "员工信息,不超过100个。\n根据UserId或OpenId更新员工,必填一个,优先UserId。\n可更新Mobile、DisplayName、Email和Department.DepartmentId字段,其他字段暂不支持",
9108
9431
  "example": "无",
9432
+ "is_base64": false,
9109
9433
  "member": "Staff",
9110
9434
  "name": "Employees",
9111
9435
  "required": true,
@@ -9115,6 +9439,7 @@
9115
9439
  "disabled": false,
9116
9440
  "document": "代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id",
9117
9441
  "example": "无",
9442
+ "is_base64": false,
9118
9443
  "member": "Agent",
9119
9444
  "name": "Agent",
9120
9445
  "required": false,