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.
@@ -1317,6 +1317,216 @@ export interface ChannelCreateSealPolicyResponse {
1317
1317
  */
1318
1318
  RequestId?: string;
1319
1319
  }
1320
+ /**
1321
+ * 电子文档的控件填充信息。按照控件类型进行相应的填充。
1322
+
1323
+ 当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
1324
+ ```
1325
+ FormField输入示例:
1326
+ {
1327
+ "ComponentId": "componentId1",
1328
+ "ComponentValue": "文本内容"
1329
+ }
1330
+ ```
1331
+ 当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
1332
+ ```
1333
+ FormField输入示例:
1334
+ {
1335
+ "ComponentId": "componentId1",
1336
+ "ComponentValue": "多行文本内容"
1337
+ }
1338
+ ```
1339
+ 当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
1340
+ ```
1341
+ FormField输入示例:
1342
+ {
1343
+ "ComponentId": "componentId1",
1344
+ "ComponentValue": "true"
1345
+ }
1346
+ ```
1347
+ 当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
1348
+ ```
1349
+ FormField输入示例:
1350
+ {
1351
+ "ComponentId": "componentId1",
1352
+ "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
1353
+ }
1354
+ ```
1355
+ 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
1356
+ ```
1357
+ FormField输入示例:
1358
+ {
1359
+ "ComponentId": "componentId1",
1360
+ "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
1361
+ }
1362
+ ```
1363
+ 当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
1364
+ ```
1365
+ FormField输入示例:
1366
+ {
1367
+ "ComponentId": "componentId1",
1368
+ "ComponentValue": "选择的内容"
1369
+ }
1370
+ ```
1371
+ 当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
1372
+ ```
1373
+ FormField输入示例:
1374
+ {
1375
+ "ComponentId": "componentId1",
1376
+ "ComponentValue": "2023年01月01日"
1377
+ }
1378
+ ```
1379
+ 当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
1380
+ ```
1381
+ FormField输入示例:
1382
+ {
1383
+ "ComponentId": "componentId1",
1384
+ "ComponentValue": "广东省深圳市福田区"
1385
+ }
1386
+ ```
1387
+ 【数据表格传参说明】
1388
+ 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
1389
+ 输入示例1:
1390
+
1391
+ ```
1392
+ {
1393
+ "headers":[
1394
+ {
1395
+ "content":"head1"
1396
+ },
1397
+ {
1398
+ "content":"head2"
1399
+ },
1400
+ {
1401
+ "content":"head3"
1402
+ }
1403
+ ],
1404
+ "rowCount":3,
1405
+ "body":{
1406
+ "cells":[
1407
+ {
1408
+ "rowStart":1,
1409
+ "rowEnd":1,
1410
+ "columnStart":1,
1411
+ "columnEnd":1,
1412
+ "content":"123"
1413
+ },
1414
+ {
1415
+ "rowStart":2,
1416
+ "rowEnd":3,
1417
+ "columnStart":1,
1418
+ "columnEnd":2,
1419
+ "content":"456"
1420
+ },
1421
+ {
1422
+ "rowStart":3,
1423
+ "rowEnd":3,
1424
+ "columnStart":3,
1425
+ "columnEnd":3,
1426
+ "content":"789"
1427
+ }
1428
+ ]
1429
+ }
1430
+ }
1431
+
1432
+ ```
1433
+
1434
+ 输入示例2(表格表头宽度比例配置):
1435
+
1436
+ ```
1437
+ {
1438
+ "headers":[
1439
+ {
1440
+ "content":"head1",
1441
+ "widthPercent": 30
1442
+ },
1443
+ {
1444
+ "content":"head2",
1445
+ "widthPercent": 30
1446
+ },
1447
+ {
1448
+ "content":"head3",
1449
+ "widthPercent": 40
1450
+ }
1451
+ ],
1452
+ "rowCount":3,
1453
+ "body":{
1454
+ "cells":[
1455
+ {
1456
+ "rowStart":1,
1457
+ "rowEnd":1,
1458
+ "columnStart":1,
1459
+ "columnEnd":1,
1460
+ "content":"123"
1461
+ },
1462
+ {
1463
+ "rowStart":2,
1464
+ "rowEnd":3,
1465
+ "columnStart":1,
1466
+ "columnEnd":2,
1467
+ "content":"456"
1468
+ },
1469
+ {
1470
+ "rowStart":3,
1471
+ "rowEnd":3,
1472
+ "columnStart":3,
1473
+ "columnEnd":3,
1474
+ "content":"789"
1475
+ }
1476
+ ]
1477
+ }
1478
+ }
1479
+
1480
+ ```
1481
+ 表格参数说明
1482
+
1483
+ | 名称 | 类型 | 描述 |
1484
+ | ------------------- | ------- | ------------------------------------------------- |
1485
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
1486
+ | rowCount | Integer | 表格内容最大行数 |
1487
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
1488
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
1489
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
1490
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
1491
+ | cells.N.content | String | 单元格内容,字数不超过100 |
1492
+
1493
+ 表格参数headers说明
1494
+ widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
1495
+ content String 表头单元格内容,字数不超过100
1496
+ */
1497
+ export interface FormField {
1498
+ /**
1499
+ * 控件填充值,ComponentType和传入值格式对应关系如下:
1500
+ <ul>
1501
+ <li>TEXT - 普通文本控件,需输入文本字符串;</li>
1502
+ <li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
1503
+ <li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
1504
+ <li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
1505
+ <li>DYNAMIC_TABLE - 动态表格控件;</li>
1506
+ <li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
1507
+ <li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
1508
+ <li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
1509
+ </ul>
1510
+
1511
+ */
1512
+ ComponentValue: string;
1513
+ /**
1514
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1515
+ CreateFlowsByTemplates 接口不使用此字段。
1516
+ 注意:此字段可能返回 null,表示取不到有效值。
1517
+ */
1518
+ ComponentId?: string;
1519
+ /**
1520
+ * 控件的名字,跟ComponentId二选一,不能全为空
1521
+ 注意:此字段可能返回 null,表示取不到有效值。
1522
+ */
1523
+ ComponentName?: string;
1524
+ /**
1525
+ * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
1526
+ 注意:此字段可能返回 null,表示取不到有效值。
1527
+ */
1528
+ LockComponentValue?: boolean;
1529
+ }
1320
1530
  /**
1321
1531
  * ChannelCancelFlow返回参数结构体
1322
1532
  */
@@ -3373,214 +3583,32 @@ export interface DescribeExtendedServiceAuthInfoRequest {
3373
3583
  Agent: Agent;
3374
3584
  }
3375
3585
  /**
3376
- * 电子文档的控件填充信息。按照控件类型进行相应的填充。
3377
-
3378
- 当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
3379
- ```
3380
- FormField输入示例:
3381
- {
3382
- "ComponentId": "componentId1",
3383
- "ComponentValue": "文本内容"
3384
- }
3385
- ```
3386
- 当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
3387
- ```
3388
- FormField输入示例:
3389
- {
3390
- "ComponentId": "componentId1",
3391
- "ComponentValue": "多行文本内容"
3392
- }
3393
- ```
3394
- 当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
3395
- ```
3396
- FormField输入示例:
3397
- {
3398
- "ComponentId": "componentId1",
3399
- "ComponentValue": "true"
3400
- }
3401
- ```
3402
- 当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
3403
- ```
3404
- FormField输入示例:
3405
- {
3406
- "ComponentId": "componentId1",
3407
- "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
3408
- }
3409
- ```
3410
- 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
3411
- ```
3412
- FormField输入示例:
3413
- {
3414
- "ComponentId": "componentId1",
3415
- "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
3416
- }
3417
- ```
3418
- 当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
3419
- ```
3420
- FormField输入示例:
3421
- {
3422
- "ComponentId": "componentId1",
3423
- "ComponentValue": "选择的内容"
3424
- }
3425
- ```
3426
- 当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
3427
- ```
3428
- FormField输入示例:
3429
- {
3430
- "ComponentId": "componentId1",
3431
- "ComponentValue": "2023年01月01日"
3432
- }
3433
- ```
3434
- 当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
3435
- ```
3436
- FormField输入示例:
3437
- {
3438
- "ComponentId": "componentId1",
3439
- "ComponentValue": "广东省深圳市福田区"
3440
- }
3441
- ```
3442
- 【数据表格传参说明】
3443
- 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
3444
- 输入示例1:
3445
-
3446
- ```
3447
- {
3448
- "headers":[
3449
- {
3450
- "content":"head1"
3451
- },
3452
- {
3453
- "content":"head2"
3454
- },
3455
- {
3456
- "content":"head3"
3457
- }
3458
- ],
3459
- "rowCount":3,
3460
- "body":{
3461
- "cells":[
3462
- {
3463
- "rowStart":1,
3464
- "rowEnd":1,
3465
- "columnStart":1,
3466
- "columnEnd":1,
3467
- "content":"123"
3468
- },
3469
- {
3470
- "rowStart":2,
3471
- "rowEnd":3,
3472
- "columnStart":1,
3473
- "columnEnd":2,
3474
- "content":"456"
3475
- },
3476
- {
3477
- "rowStart":3,
3478
- "rowEnd":3,
3479
- "columnStart":3,
3480
- "columnEnd":3,
3481
- "content":"789"
3482
- }
3483
- ]
3484
- }
3485
- }
3486
-
3487
- ```
3488
-
3489
- 输入示例2(表格表头宽度比例配置):
3490
-
3491
- ```
3492
- {
3493
- "headers":[
3494
- {
3495
- "content":"head1",
3496
- "widthPercent": 30
3497
- },
3498
- {
3499
- "content":"head2",
3500
- "widthPercent": 30
3501
- },
3502
- {
3503
- "content":"head3",
3504
- "widthPercent": 40
3505
- }
3506
- ],
3507
- "rowCount":3,
3508
- "body":{
3509
- "cells":[
3510
- {
3511
- "rowStart":1,
3512
- "rowEnd":1,
3513
- "columnStart":1,
3514
- "columnEnd":1,
3515
- "content":"123"
3516
- },
3517
- {
3518
- "rowStart":2,
3519
- "rowEnd":3,
3520
- "columnStart":1,
3521
- "columnEnd":2,
3522
- "content":"456"
3523
- },
3524
- {
3525
- "rowStart":3,
3526
- "rowEnd":3,
3527
- "columnStart":3,
3528
- "columnEnd":3,
3529
- "content":"789"
3530
- }
3531
- ]
3532
- }
3533
- }
3534
-
3535
- ```
3536
- 表格参数说明
3537
-
3538
- | 名称 | 类型 | 描述 |
3539
- | ------------------- | ------- | ------------------------------------------------- |
3540
- | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
3541
- | rowCount | Integer | 表格内容最大行数 |
3542
- | cells.N.rowStart | Integer | 单元格坐标:行起始index |
3543
- | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
3544
- | cells.N.columnStart | Integer | 单元格坐标:列起始index |
3545
- | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
3546
- | cells.N.content | String | 单元格内容,字数不超过100 |
3547
-
3548
- 表格参数headers说明
3549
- widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
3550
- content String 表头单元格内容,字数不超过100
3586
+ * DescribeChannelSealPolicyWorkflowUrl请求参数结构体
3551
3587
  */
3552
- export interface FormField {
3588
+ export interface DescribeChannelSealPolicyWorkflowUrlRequest {
3553
3589
  /**
3554
- * 控件填充值,ComponentType和传入值格式对应关系如下:
3555
- <ul>
3556
- <li>TEXT - 普通文本控件,需输入文本字符串;</li>
3557
- <li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
3558
- <li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
3559
- <li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
3560
- <li>DYNAMIC_TABLE - 动态表格控件;</li>
3561
- <li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
3562
- <li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
3563
- <li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
3564
- </ul>
3590
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3565
3591
 
3592
+ 此接口下面信息必填。
3593
+
3594
+ 渠道应用标识: Agent.AppId
3595
+ 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
3596
+ 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
3597
+ 第三方平台子客企业和员工必须已经经过实名认证
3566
3598
  */
3567
- ComponentValue: string;
3568
- /**
3569
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
3570
- CreateFlowsByTemplates 接口不使用此字段。
3571
- 注意:此字段可能返回 null,表示取不到有效值。
3572
- */
3573
- ComponentId?: string;
3599
+ Agent: Agent;
3574
3600
  /**
3575
- * 控件的名字,跟ComponentId二选一,不能全为空
3576
- 注意:此字段可能返回 null,表示取不到有效值。
3601
+ * 用印审批单的ID,可通过用印申请回调获取。
3577
3602
  */
3578
- ComponentName?: string;
3603
+ WorkflowInstanceId: string;
3579
3604
  /**
3580
- * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
3581
- 注意:此字段可能返回 null,表示取不到有效值。
3605
+ * 生成链接的类型:
3606
+ 生成链接的类型
3607
+ <ul><li>**LongLink**:(默认)长链接,H5跳转到电子签小程序链接,链接有效期为1年</li>
3608
+ <li>**ShortLink**:H5跳转到电子签小程序链接,一般用于发送短信中带的链接,打开后进入腾讯电子签小程序,链接有效期为7天</li>
3609
+ <li>**App**:第三方APP或小程序跳转电子签小程序链接,一般用于贵方小程序或者APP跳转过来,打开后进入腾讯电子签小程序,链接有效期为1年</li></ul>
3582
3610
  */
3583
- LockComponentValue?: boolean;
3611
+ Endpoint?: string;
3584
3612
  }
3585
3613
  /**
3586
3614
  * 此结构体 (FlowInfo) 用于描述签署流程信息。
@@ -6419,6 +6447,19 @@ export interface OperateChannelTemplateRequest {
6419
6447
  */
6420
6448
  Operator?: UserInfo;
6421
6449
  }
6450
+ /**
6451
+ * DescribeChannelSealPolicyWorkflowUrl返回参数结构体
6452
+ */
6453
+ export interface DescribeChannelSealPolicyWorkflowUrlResponse {
6454
+ /**
6455
+ * 用印审批小程序链接,链接类型(通过H5唤起小程序或通过APP跳转方式查看)。
6456
+ */
6457
+ WorkflowUrl?: string;
6458
+ /**
6459
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6460
+ */
6461
+ RequestId?: string;
6462
+ }
6422
6463
  /**
6423
6464
  * CreateChannelFlowEvidenceReport返回参数结构体
6424
6465
  */