tencentcloud-sdk-nodejs-essbasic 4.0.745 → 4.0.747
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/products.md +29 -29
- package/src/services/essbasic/v20210526/essbasic_client.ts +32 -20
- package/src/services/essbasic/v20210526/essbasic_models.ts +243 -200
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +20 -16
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +22 -16
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +241 -200
|
@@ -1370,6 +1370,217 @@ export interface ChannelCreateSealPolicyResponse {
|
|
|
1370
1370
|
RequestId?: string
|
|
1371
1371
|
}
|
|
1372
1372
|
|
|
1373
|
+
/**
|
|
1374
|
+
* 电子文档的控件填充信息。按照控件类型进行相应的填充。
|
|
1375
|
+
|
|
1376
|
+
当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
|
|
1377
|
+
```
|
|
1378
|
+
FormField输入示例:
|
|
1379
|
+
{
|
|
1380
|
+
"ComponentId": "componentId1",
|
|
1381
|
+
"ComponentValue": "文本内容"
|
|
1382
|
+
}
|
|
1383
|
+
```
|
|
1384
|
+
当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
|
|
1385
|
+
```
|
|
1386
|
+
FormField输入示例:
|
|
1387
|
+
{
|
|
1388
|
+
"ComponentId": "componentId1",
|
|
1389
|
+
"ComponentValue": "多行文本内容"
|
|
1390
|
+
}
|
|
1391
|
+
```
|
|
1392
|
+
当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
|
|
1393
|
+
```
|
|
1394
|
+
FormField输入示例:
|
|
1395
|
+
{
|
|
1396
|
+
"ComponentId": "componentId1",
|
|
1397
|
+
"ComponentValue": "true"
|
|
1398
|
+
}
|
|
1399
|
+
```
|
|
1400
|
+
当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
|
|
1401
|
+
```
|
|
1402
|
+
FormField输入示例:
|
|
1403
|
+
{
|
|
1404
|
+
"ComponentId": "componentId1",
|
|
1405
|
+
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
1406
|
+
}
|
|
1407
|
+
```
|
|
1408
|
+
当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
|
|
1409
|
+
```
|
|
1410
|
+
FormField输入示例:
|
|
1411
|
+
{
|
|
1412
|
+
"ComponentId": "componentId1",
|
|
1413
|
+
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
|
|
1414
|
+
}
|
|
1415
|
+
```
|
|
1416
|
+
当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
|
|
1417
|
+
```
|
|
1418
|
+
FormField输入示例:
|
|
1419
|
+
{
|
|
1420
|
+
"ComponentId": "componentId1",
|
|
1421
|
+
"ComponentValue": "选择的内容"
|
|
1422
|
+
}
|
|
1423
|
+
```
|
|
1424
|
+
当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
|
|
1425
|
+
```
|
|
1426
|
+
FormField输入示例:
|
|
1427
|
+
{
|
|
1428
|
+
"ComponentId": "componentId1",
|
|
1429
|
+
"ComponentValue": "2023年01月01日"
|
|
1430
|
+
}
|
|
1431
|
+
```
|
|
1432
|
+
当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
|
|
1433
|
+
```
|
|
1434
|
+
FormField输入示例:
|
|
1435
|
+
{
|
|
1436
|
+
"ComponentId": "componentId1",
|
|
1437
|
+
"ComponentValue": "广东省深圳市福田区"
|
|
1438
|
+
}
|
|
1439
|
+
```
|
|
1440
|
+
【数据表格传参说明】
|
|
1441
|
+
当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
|
|
1442
|
+
输入示例1:
|
|
1443
|
+
|
|
1444
|
+
```
|
|
1445
|
+
{
|
|
1446
|
+
"headers":[
|
|
1447
|
+
{
|
|
1448
|
+
"content":"head1"
|
|
1449
|
+
},
|
|
1450
|
+
{
|
|
1451
|
+
"content":"head2"
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"content":"head3"
|
|
1455
|
+
}
|
|
1456
|
+
],
|
|
1457
|
+
"rowCount":3,
|
|
1458
|
+
"body":{
|
|
1459
|
+
"cells":[
|
|
1460
|
+
{
|
|
1461
|
+
"rowStart":1,
|
|
1462
|
+
"rowEnd":1,
|
|
1463
|
+
"columnStart":1,
|
|
1464
|
+
"columnEnd":1,
|
|
1465
|
+
"content":"123"
|
|
1466
|
+
},
|
|
1467
|
+
{
|
|
1468
|
+
"rowStart":2,
|
|
1469
|
+
"rowEnd":3,
|
|
1470
|
+
"columnStart":1,
|
|
1471
|
+
"columnEnd":2,
|
|
1472
|
+
"content":"456"
|
|
1473
|
+
},
|
|
1474
|
+
{
|
|
1475
|
+
"rowStart":3,
|
|
1476
|
+
"rowEnd":3,
|
|
1477
|
+
"columnStart":3,
|
|
1478
|
+
"columnEnd":3,
|
|
1479
|
+
"content":"789"
|
|
1480
|
+
}
|
|
1481
|
+
]
|
|
1482
|
+
}
|
|
1483
|
+
}
|
|
1484
|
+
|
|
1485
|
+
```
|
|
1486
|
+
|
|
1487
|
+
输入示例2(表格表头宽度比例配置):
|
|
1488
|
+
|
|
1489
|
+
```
|
|
1490
|
+
{
|
|
1491
|
+
"headers":[
|
|
1492
|
+
{
|
|
1493
|
+
"content":"head1",
|
|
1494
|
+
"widthPercent": 30
|
|
1495
|
+
},
|
|
1496
|
+
{
|
|
1497
|
+
"content":"head2",
|
|
1498
|
+
"widthPercent": 30
|
|
1499
|
+
},
|
|
1500
|
+
{
|
|
1501
|
+
"content":"head3",
|
|
1502
|
+
"widthPercent": 40
|
|
1503
|
+
}
|
|
1504
|
+
],
|
|
1505
|
+
"rowCount":3,
|
|
1506
|
+
"body":{
|
|
1507
|
+
"cells":[
|
|
1508
|
+
{
|
|
1509
|
+
"rowStart":1,
|
|
1510
|
+
"rowEnd":1,
|
|
1511
|
+
"columnStart":1,
|
|
1512
|
+
"columnEnd":1,
|
|
1513
|
+
"content":"123"
|
|
1514
|
+
},
|
|
1515
|
+
{
|
|
1516
|
+
"rowStart":2,
|
|
1517
|
+
"rowEnd":3,
|
|
1518
|
+
"columnStart":1,
|
|
1519
|
+
"columnEnd":2,
|
|
1520
|
+
"content":"456"
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"rowStart":3,
|
|
1524
|
+
"rowEnd":3,
|
|
1525
|
+
"columnStart":3,
|
|
1526
|
+
"columnEnd":3,
|
|
1527
|
+
"content":"789"
|
|
1528
|
+
}
|
|
1529
|
+
]
|
|
1530
|
+
}
|
|
1531
|
+
}
|
|
1532
|
+
|
|
1533
|
+
```
|
|
1534
|
+
表格参数说明
|
|
1535
|
+
|
|
1536
|
+
| 名称 | 类型 | 描述 |
|
|
1537
|
+
| ------------------- | ------- | ------------------------------------------------- |
|
|
1538
|
+
| headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
|
|
1539
|
+
| rowCount | Integer | 表格内容最大行数 |
|
|
1540
|
+
| cells.N.rowStart | Integer | 单元格坐标:行起始index |
|
|
1541
|
+
| cells.N.rowEnd | Integer | 单元格坐标:行结束index |
|
|
1542
|
+
| cells.N.columnStart | Integer | 单元格坐标:列起始index |
|
|
1543
|
+
| cells.N.columnEnd | Integer | 单元格坐标:列结束index |
|
|
1544
|
+
| cells.N.content | String | 单元格内容,字数不超过100 |
|
|
1545
|
+
|
|
1546
|
+
表格参数headers说明
|
|
1547
|
+
widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
|
|
1548
|
+
content String 表头单元格内容,字数不超过100
|
|
1549
|
+
*/
|
|
1550
|
+
export interface FormField {
|
|
1551
|
+
/**
|
|
1552
|
+
* 控件填充值,ComponentType和传入值格式对应关系如下:
|
|
1553
|
+
<ul>
|
|
1554
|
+
<li>TEXT - 普通文本控件,需输入文本字符串;</li>
|
|
1555
|
+
<li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
|
|
1556
|
+
<li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
|
|
1557
|
+
<li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
|
|
1558
|
+
<li>DYNAMIC_TABLE - 动态表格控件;</li>
|
|
1559
|
+
<li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
|
|
1560
|
+
<li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
|
|
1561
|
+
<li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
|
|
1562
|
+
</ul>
|
|
1563
|
+
|
|
1564
|
+
*/
|
|
1565
|
+
ComponentValue: string
|
|
1566
|
+
/**
|
|
1567
|
+
* 表单域或控件的ID,跟ComponentName二选一,不能全为空;
|
|
1568
|
+
CreateFlowsByTemplates 接口不使用此字段。
|
|
1569
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1570
|
+
*/
|
|
1571
|
+
ComponentId?: string
|
|
1572
|
+
/**
|
|
1573
|
+
* 控件的名字,跟ComponentId二选一,不能全为空
|
|
1574
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1575
|
+
*/
|
|
1576
|
+
ComponentName?: string
|
|
1577
|
+
/**
|
|
1578
|
+
* 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
|
|
1579
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1580
|
+
*/
|
|
1581
|
+
LockComponentValue?: boolean
|
|
1582
|
+
}
|
|
1583
|
+
|
|
1373
1584
|
/**
|
|
1374
1585
|
* ChannelCancelFlow返回参数结构体
|
|
1375
1586
|
*/
|
|
@@ -3476,214 +3687,32 @@ export interface DescribeExtendedServiceAuthInfoRequest {
|
|
|
3476
3687
|
}
|
|
3477
3688
|
|
|
3478
3689
|
/**
|
|
3479
|
-
*
|
|
3480
|
-
|
|
3481
|
-
当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
|
|
3482
|
-
```
|
|
3483
|
-
FormField输入示例:
|
|
3484
|
-
{
|
|
3485
|
-
"ComponentId": "componentId1",
|
|
3486
|
-
"ComponentValue": "文本内容"
|
|
3487
|
-
}
|
|
3488
|
-
```
|
|
3489
|
-
当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
|
|
3490
|
-
```
|
|
3491
|
-
FormField输入示例:
|
|
3492
|
-
{
|
|
3493
|
-
"ComponentId": "componentId1",
|
|
3494
|
-
"ComponentValue": "多行文本内容"
|
|
3495
|
-
}
|
|
3496
|
-
```
|
|
3497
|
-
当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
|
|
3498
|
-
```
|
|
3499
|
-
FormField输入示例:
|
|
3500
|
-
{
|
|
3501
|
-
"ComponentId": "componentId1",
|
|
3502
|
-
"ComponentValue": "true"
|
|
3503
|
-
}
|
|
3504
|
-
```
|
|
3505
|
-
当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
|
|
3506
|
-
```
|
|
3507
|
-
FormField输入示例:
|
|
3508
|
-
{
|
|
3509
|
-
"ComponentId": "componentId1",
|
|
3510
|
-
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
3511
|
-
}
|
|
3512
|
-
```
|
|
3513
|
-
当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
|
|
3514
|
-
```
|
|
3515
|
-
FormField输入示例:
|
|
3516
|
-
{
|
|
3517
|
-
"ComponentId": "componentId1",
|
|
3518
|
-
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
|
|
3519
|
-
}
|
|
3520
|
-
```
|
|
3521
|
-
当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
|
|
3522
|
-
```
|
|
3523
|
-
FormField输入示例:
|
|
3524
|
-
{
|
|
3525
|
-
"ComponentId": "componentId1",
|
|
3526
|
-
"ComponentValue": "选择的内容"
|
|
3527
|
-
}
|
|
3528
|
-
```
|
|
3529
|
-
当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
|
|
3530
|
-
```
|
|
3531
|
-
FormField输入示例:
|
|
3532
|
-
{
|
|
3533
|
-
"ComponentId": "componentId1",
|
|
3534
|
-
"ComponentValue": "2023年01月01日"
|
|
3535
|
-
}
|
|
3536
|
-
```
|
|
3537
|
-
当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
|
|
3538
|
-
```
|
|
3539
|
-
FormField输入示例:
|
|
3540
|
-
{
|
|
3541
|
-
"ComponentId": "componentId1",
|
|
3542
|
-
"ComponentValue": "广东省深圳市福田区"
|
|
3543
|
-
}
|
|
3544
|
-
```
|
|
3545
|
-
【数据表格传参说明】
|
|
3546
|
-
当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
|
|
3547
|
-
输入示例1:
|
|
3548
|
-
|
|
3549
|
-
```
|
|
3550
|
-
{
|
|
3551
|
-
"headers":[
|
|
3552
|
-
{
|
|
3553
|
-
"content":"head1"
|
|
3554
|
-
},
|
|
3555
|
-
{
|
|
3556
|
-
"content":"head2"
|
|
3557
|
-
},
|
|
3558
|
-
{
|
|
3559
|
-
"content":"head3"
|
|
3560
|
-
}
|
|
3561
|
-
],
|
|
3562
|
-
"rowCount":3,
|
|
3563
|
-
"body":{
|
|
3564
|
-
"cells":[
|
|
3565
|
-
{
|
|
3566
|
-
"rowStart":1,
|
|
3567
|
-
"rowEnd":1,
|
|
3568
|
-
"columnStart":1,
|
|
3569
|
-
"columnEnd":1,
|
|
3570
|
-
"content":"123"
|
|
3571
|
-
},
|
|
3572
|
-
{
|
|
3573
|
-
"rowStart":2,
|
|
3574
|
-
"rowEnd":3,
|
|
3575
|
-
"columnStart":1,
|
|
3576
|
-
"columnEnd":2,
|
|
3577
|
-
"content":"456"
|
|
3578
|
-
},
|
|
3579
|
-
{
|
|
3580
|
-
"rowStart":3,
|
|
3581
|
-
"rowEnd":3,
|
|
3582
|
-
"columnStart":3,
|
|
3583
|
-
"columnEnd":3,
|
|
3584
|
-
"content":"789"
|
|
3585
|
-
}
|
|
3586
|
-
]
|
|
3587
|
-
}
|
|
3588
|
-
}
|
|
3589
|
-
|
|
3590
|
-
```
|
|
3591
|
-
|
|
3592
|
-
输入示例2(表格表头宽度比例配置):
|
|
3593
|
-
|
|
3594
|
-
```
|
|
3595
|
-
{
|
|
3596
|
-
"headers":[
|
|
3597
|
-
{
|
|
3598
|
-
"content":"head1",
|
|
3599
|
-
"widthPercent": 30
|
|
3600
|
-
},
|
|
3601
|
-
{
|
|
3602
|
-
"content":"head2",
|
|
3603
|
-
"widthPercent": 30
|
|
3604
|
-
},
|
|
3605
|
-
{
|
|
3606
|
-
"content":"head3",
|
|
3607
|
-
"widthPercent": 40
|
|
3608
|
-
}
|
|
3609
|
-
],
|
|
3610
|
-
"rowCount":3,
|
|
3611
|
-
"body":{
|
|
3612
|
-
"cells":[
|
|
3613
|
-
{
|
|
3614
|
-
"rowStart":1,
|
|
3615
|
-
"rowEnd":1,
|
|
3616
|
-
"columnStart":1,
|
|
3617
|
-
"columnEnd":1,
|
|
3618
|
-
"content":"123"
|
|
3619
|
-
},
|
|
3620
|
-
{
|
|
3621
|
-
"rowStart":2,
|
|
3622
|
-
"rowEnd":3,
|
|
3623
|
-
"columnStart":1,
|
|
3624
|
-
"columnEnd":2,
|
|
3625
|
-
"content":"456"
|
|
3626
|
-
},
|
|
3627
|
-
{
|
|
3628
|
-
"rowStart":3,
|
|
3629
|
-
"rowEnd":3,
|
|
3630
|
-
"columnStart":3,
|
|
3631
|
-
"columnEnd":3,
|
|
3632
|
-
"content":"789"
|
|
3633
|
-
}
|
|
3634
|
-
]
|
|
3635
|
-
}
|
|
3636
|
-
}
|
|
3637
|
-
|
|
3638
|
-
```
|
|
3639
|
-
表格参数说明
|
|
3640
|
-
|
|
3641
|
-
| 名称 | 类型 | 描述 |
|
|
3642
|
-
| ------------------- | ------- | ------------------------------------------------- |
|
|
3643
|
-
| headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
|
|
3644
|
-
| rowCount | Integer | 表格内容最大行数 |
|
|
3645
|
-
| cells.N.rowStart | Integer | 单元格坐标:行起始index |
|
|
3646
|
-
| cells.N.rowEnd | Integer | 单元格坐标:行结束index |
|
|
3647
|
-
| cells.N.columnStart | Integer | 单元格坐标:列起始index |
|
|
3648
|
-
| cells.N.columnEnd | Integer | 单元格坐标:列结束index |
|
|
3649
|
-
| cells.N.content | String | 单元格内容,字数不超过100 |
|
|
3650
|
-
|
|
3651
|
-
表格参数headers说明
|
|
3652
|
-
widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
|
|
3653
|
-
content String 表头单元格内容,字数不超过100
|
|
3690
|
+
* DescribeChannelSealPolicyWorkflowUrl请求参数结构体
|
|
3654
3691
|
*/
|
|
3655
|
-
export interface
|
|
3692
|
+
export interface DescribeChannelSealPolicyWorkflowUrlRequest {
|
|
3656
3693
|
/**
|
|
3657
|
-
*
|
|
3658
|
-
<ul>
|
|
3659
|
-
<li>TEXT - 普通文本控件,需输入文本字符串;</li>
|
|
3660
|
-
<li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
|
|
3661
|
-
<li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
|
|
3662
|
-
<li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
|
|
3663
|
-
<li>DYNAMIC_TABLE - 动态表格控件;</li>
|
|
3664
|
-
<li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
|
|
3665
|
-
<li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
|
|
3666
|
-
<li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
|
|
3667
|
-
</ul>
|
|
3694
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3668
3695
|
|
|
3696
|
+
此接口下面信息必填。
|
|
3697
|
+
|
|
3698
|
+
渠道应用标识: Agent.AppId
|
|
3699
|
+
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
|
|
3700
|
+
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
|
|
3701
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
3669
3702
|
*/
|
|
3670
|
-
|
|
3671
|
-
/**
|
|
3672
|
-
* 表单域或控件的ID,跟ComponentName二选一,不能全为空;
|
|
3673
|
-
CreateFlowsByTemplates 接口不使用此字段。
|
|
3674
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3675
|
-
*/
|
|
3676
|
-
ComponentId?: string
|
|
3703
|
+
Agent: Agent
|
|
3677
3704
|
/**
|
|
3678
|
-
*
|
|
3679
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3705
|
+
* 用印审批单的ID,可通过用印申请回调获取。
|
|
3680
3706
|
*/
|
|
3681
|
-
|
|
3707
|
+
WorkflowInstanceId: string
|
|
3682
3708
|
/**
|
|
3683
|
-
*
|
|
3684
|
-
|
|
3709
|
+
* 生成链接的类型:
|
|
3710
|
+
生成链接的类型
|
|
3711
|
+
<ul><li>**LongLink**:(默认)长链接,H5跳转到电子签小程序链接,链接有效期为1年</li>
|
|
3712
|
+
<li>**ShortLink**:H5跳转到电子签小程序链接,一般用于发送短信中带的链接,打开后进入腾讯电子签小程序,链接有效期为7天</li>
|
|
3713
|
+
<li>**App**:第三方APP或小程序跳转电子签小程序链接,一般用于贵方小程序或者APP跳转过来,打开后进入腾讯电子签小程序,链接有效期为1年</li></ul>
|
|
3685
3714
|
*/
|
|
3686
|
-
|
|
3715
|
+
Endpoint?: string
|
|
3687
3716
|
}
|
|
3688
3717
|
|
|
3689
3718
|
/**
|
|
@@ -6609,6 +6638,20 @@ export interface OperateChannelTemplateRequest {
|
|
|
6609
6638
|
Operator?: UserInfo
|
|
6610
6639
|
}
|
|
6611
6640
|
|
|
6641
|
+
/**
|
|
6642
|
+
* DescribeChannelSealPolicyWorkflowUrl返回参数结构体
|
|
6643
|
+
*/
|
|
6644
|
+
export interface DescribeChannelSealPolicyWorkflowUrlResponse {
|
|
6645
|
+
/**
|
|
6646
|
+
* 用印审批小程序链接,链接类型(通过H5唤起小程序或通过APP跳转方式查看)。
|
|
6647
|
+
*/
|
|
6648
|
+
WorkflowUrl?: string
|
|
6649
|
+
/**
|
|
6650
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6651
|
+
*/
|
|
6652
|
+
RequestId?: string
|
|
6653
|
+
}
|
|
6654
|
+
|
|
6612
6655
|
/**
|
|
6613
6656
|
* CreateChannelFlowEvidenceReport返回参数结构体
|
|
6614
6657
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeTemplatesRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, ChannelCreateBatchQuickSignUrlResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
|
|
2
|
+
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeTemplatesRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeChannelSealPolicyWorkflowUrlRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, ChannelCreateBatchQuickSignUrlResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
|
|
3
3
|
/**
|
|
4
4
|
* essbasic client
|
|
5
5
|
* @class
|
|
@@ -342,6 +342,22 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
342
342
|
>2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
|
|
343
343
|
*/
|
|
344
344
|
DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
|
|
345
|
+
/**
|
|
346
|
+
* 此接口(UploadFiles)文件上传。<br/>
|
|
347
|
+
|
|
348
|
+
适用场景:用于合同,印章的文件上传。文件上传以后,
|
|
349
|
+
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
350
|
+
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
351
|
+
|
|
352
|
+
注:
|
|
353
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
354
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
|
|
355
|
+
```
|
|
356
|
+
HttpProfile httpProfile = new HttpProfile();
|
|
357
|
+
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
358
|
+
```
|
|
359
|
+
*/
|
|
360
|
+
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
345
361
|
/**
|
|
346
362
|
* 创建跳转小程序查看或签署的链接
|
|
347
363
|
|
|
@@ -622,21 +638,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
622
638
|
*/
|
|
623
639
|
ChannelCancelUserAutoSignEnableUrl(req: ChannelCancelUserAutoSignEnableUrlRequest, cb?: (error: string, rep: ChannelCancelUserAutoSignEnableUrlResponse) => void): Promise<ChannelCancelUserAutoSignEnableUrlResponse>;
|
|
624
640
|
/**
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
629
|
-
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
630
|
-
|
|
631
|
-
注:
|
|
632
|
-
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
633
|
-
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
|
|
634
|
-
```
|
|
635
|
-
HttpProfile httpProfile = new HttpProfile();
|
|
636
|
-
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
637
|
-
```
|
|
638
|
-
*/
|
|
639
|
-
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
641
|
+
* 生成渠道子客用印申请审批小程序链接,链接类型(通过H5唤起小程序或通过APP跳转的方式查看)
|
|
642
|
+
*/
|
|
643
|
+
DescribeChannelSealPolicyWorkflowUrl(req: DescribeChannelSealPolicyWorkflowUrlRequest, cb?: (error: string, rep: DescribeChannelSealPolicyWorkflowUrlResponse) => void): Promise<DescribeChannelSealPolicyWorkflowUrlResponse>;
|
|
640
644
|
/**
|
|
641
645
|
* 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办
|
|
642
646
|
1. 合同中当前状态为 **待签署** 的签署人是催办的对象
|
|
@@ -405,6 +405,24 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
405
405
|
async DescribeTemplates(req, cb) {
|
|
406
406
|
return this.request("DescribeTemplates", req, cb);
|
|
407
407
|
}
|
|
408
|
+
/**
|
|
409
|
+
* 此接口(UploadFiles)文件上传。<br/>
|
|
410
|
+
|
|
411
|
+
适用场景:用于合同,印章的文件上传。文件上传以后,
|
|
412
|
+
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
413
|
+
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
414
|
+
|
|
415
|
+
注:
|
|
416
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
417
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
|
|
418
|
+
```
|
|
419
|
+
HttpProfile httpProfile = new HttpProfile();
|
|
420
|
+
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
421
|
+
```
|
|
422
|
+
*/
|
|
423
|
+
async UploadFiles(req, cb) {
|
|
424
|
+
return this.request("UploadFiles", req, cb);
|
|
425
|
+
}
|
|
408
426
|
/**
|
|
409
427
|
* 创建跳转小程序查看或签署的链接
|
|
410
428
|
|
|
@@ -737,22 +755,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
737
755
|
return this.request("ChannelCancelUserAutoSignEnableUrl", req, cb);
|
|
738
756
|
}
|
|
739
757
|
/**
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
745
|
-
|
|
746
|
-
注:
|
|
747
|
-
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
748
|
-
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
|
|
749
|
-
```
|
|
750
|
-
HttpProfile httpProfile = new HttpProfile();
|
|
751
|
-
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
752
|
-
```
|
|
753
|
-
*/
|
|
754
|
-
async UploadFiles(req, cb) {
|
|
755
|
-
return this.request("UploadFiles", req, cb);
|
|
758
|
+
* 生成渠道子客用印申请审批小程序链接,链接类型(通过H5唤起小程序或通过APP跳转的方式查看)
|
|
759
|
+
*/
|
|
760
|
+
async DescribeChannelSealPolicyWorkflowUrl(req, cb) {
|
|
761
|
+
return this.request("DescribeChannelSealPolicyWorkflowUrl", req, cb);
|
|
756
762
|
}
|
|
757
763
|
/**
|
|
758
764
|
* 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办
|