tencentcloud-sdk-nodejs-essbasic 4.0.397 → 4.0.433

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.
@@ -105,45 +105,46 @@ export interface FlowApproverInfo {
105
105
  JumpUrl?: string;
106
106
  }
107
107
  /**
108
- * PrepareFlows返回参数结构体
108
+ * ChannelCreateConvertTaskApi返回参数结构体
109
109
  */
110
- export interface PrepareFlowsResponse {
110
+ export interface ChannelCreateConvertTaskApiResponse {
111
111
  /**
112
- * 待发起文件确认页
112
+ * 任务id
113
113
  */
114
- ConfirmUrl: string;
114
+ TaskId: string;
115
115
  /**
116
116
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
117
117
  */
118
118
  RequestId?: string;
119
119
  }
120
120
  /**
121
- * 合作企业经办人列表信息
121
+ * OperateChannelTemplate请求参数结构体
122
122
  */
123
- export interface ProxyOrganizationOperator {
123
+ export interface OperateChannelTemplateRequest {
124
124
  /**
125
- * 经办人ID(渠道颁发),最大长度64个字符
125
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
126
126
  */
127
- Id: string;
127
+ Agent: Agent;
128
128
  /**
129
- * 经办人姓名,最大长度50个字符
129
+ * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
130
130
  */
131
- Name?: string;
131
+ OperateType: string;
132
132
  /**
133
- * 经办人身份证件类型
134
- 1.ID_CARD 居民身份证
135
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
136
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
137
- */
138
- IdCardType?: string;
133
+ * 渠道方模板库模板唯一标识
134
+ */
135
+ TemplateId: string;
139
136
  /**
140
- * 经办人证件号
137
+ * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
141
138
  */
142
- IdCardNumber?: string;
139
+ ProxyOrganizationOpenIds?: string;
143
140
  /**
144
- * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
141
+ * 模板可见性, 全部可见-"all", 部分可见-"part"
145
142
  */
146
- Mobile?: string;
143
+ AuthTag?: string;
144
+ /**
145
+ * 操作者的信息
146
+ */
147
+ Operator?: UserInfo;
147
148
  }
148
149
  /**
149
150
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
@@ -190,6 +191,29 @@ export interface TemplateInfo {
190
191
  */
191
192
  CreatedOn: number;
192
193
  }
194
+ /**
195
+ * UploadFiles请求参数结构体
196
+ */
197
+ export interface UploadFilesRequest {
198
+ /**
199
+ * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
200
+ */
201
+ Agent: Agent;
202
+ /**
203
+ * 文件对应业务类型,用于区分文件存储路径:
204
+ 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
205
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
206
+ */
207
+ BusinessType: string;
208
+ /**
209
+ * 上传文件内容数组,最多支持20个文件
210
+ */
211
+ FileInfos?: Array<UploadFile>;
212
+ /**
213
+ * 操作者的信息
214
+ */
215
+ Operator?: UserInfo;
216
+ }
193
217
  /**
194
218
  * GetDownloadFlowUrl返回参数结构体
195
219
  */
@@ -229,6 +253,10 @@ export interface ChannelCreateMultiFlowSignQRCodeResponse {
229
253
  * 签署二维码对象
230
254
  */
231
255
  QrCode: SignQrCode;
256
+ /**
257
+ * 签署链接对象
258
+ */
259
+ SignUrls: SignUrl;
232
260
  /**
233
261
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
234
262
  */
@@ -339,6 +367,23 @@ export interface OperateChannelTemplateResponse {
339
367
  */
340
368
  RequestId?: string;
341
369
  }
370
+ /**
371
+ * CreateSignUrls返回参数结构体
372
+ */
373
+ export interface CreateSignUrlsResponse {
374
+ /**
375
+ * 签署参与者签署H5链接信息数组
376
+ */
377
+ SignUrlInfos: Array<SignUrlInfo>;
378
+ /**
379
+ * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
380
+ */
381
+ ErrorMessages: Array<string>;
382
+ /**
383
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
384
+ */
385
+ RequestId?: string;
386
+ }
342
387
  /**
343
388
  * CreateSignUrls请求参数结构体
344
389
  */
@@ -433,6 +478,10 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
433
478
  回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
434
479
  */
435
480
  CallbackUrl?: string;
481
+ /**
482
+ * 限制二维码用户条件
483
+ */
484
+ ApproverRestrictions?: ApproverRestriction;
436
485
  /**
437
486
  * 用户信息
438
487
  */
@@ -451,6 +500,23 @@ export interface AuthFailMessage {
451
500
  */
452
501
  Message: string;
453
502
  }
503
+ /**
504
+ * CreateChannelFlowEvidenceReport请求参数结构体
505
+ */
506
+ export interface CreateChannelFlowEvidenceReportRequest {
507
+ /**
508
+ * 签署流程编号
509
+ */
510
+ FlowId: string;
511
+ /**
512
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
513
+ */
514
+ Agent: Agent;
515
+ /**
516
+ * 操作者的信息
517
+ */
518
+ Operator?: UserInfo;
519
+ }
454
520
  /**
455
521
  * DescribeFlowDetailInfo请求参数结构体
456
522
  */
@@ -469,62 +535,95 @@ export interface DescribeFlowDetailInfoRequest {
469
535
  Operator?: UserInfo;
470
536
  }
471
537
  /**
472
- * 一码多扫签署二维码对象
538
+ * ChannelGetTaskResultApi返回参数结构体
473
539
  */
474
- export interface SignQrCode {
540
+ export interface ChannelGetTaskResultApiResponse {
475
541
  /**
476
- * 二维码id
542
+ * 任务Id
477
543
  */
478
- QrCodeId: string;
544
+ TaskId: string;
479
545
  /**
480
- * 二维码url
546
+ * 任务状态,需要关注的状态
547
+ 0 :NeedTranform - 任务已提交
548
+ 4 :Processing - 文档转换中
549
+ 8 :TaskEnd - 任务处理完成
550
+ -2 :DownloadFailed - 下载失败
551
+ -6 :ProcessFailed - 转换失败
552
+ -13:ProcessTimeout - 转换文件超时
553
+ */
554
+ TaskStatus: number;
555
+ /**
556
+ * 状态描述,需要关注的状态
557
+ NeedTranform - 任务已提交
558
+ Processing - 文档转换中
559
+ TaskEnd - 任务处理完成
560
+ DownloadFailed - 下载失败
561
+ ProcessFailed - 转换失败
562
+ ProcessTimeout - 转换文件超时
563
+ */
564
+ TaskMessage: string;
565
+ /**
566
+ * 资源Id,也是FileId,用于文件发起使用
481
567
  */
482
- QrCodeUrl: string;
568
+ ResourceId: string;
483
569
  /**
484
- * 二维码过期时间
570
+ * 预览文件Url,有效期30分钟
571
+ 注意:此字段可能返回 null,表示取不到有效值。
572
+ */
573
+ PreviewUrl: string;
574
+ /**
575
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
485
576
  */
486
- ExpiredTime: number;
577
+ RequestId?: string;
487
578
  }
488
579
  /**
489
- * UploadFiles请求参数结构体
580
+ * 合作企业经办人列表信息
490
581
  */
491
- export interface UploadFilesRequest {
582
+ export interface ProxyOrganizationOperator {
492
583
  /**
493
- * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
584
+ * 经办人ID(渠道颁发),最大长度64个字符
494
585
  */
495
- Agent: Agent;
586
+ Id: string;
496
587
  /**
497
- * 文件对应业务类型,用于区分文件存储路径:
498
- 1. TEMPLATE - 模板; 文件类型:.pdf
499
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
588
+ * 经办人姓名,最大长度50个字符
589
+ */
590
+ Name?: string;
591
+ /**
592
+ * 经办人身份证件类型
593
+ 1.ID_CARD 居民身份证
594
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
595
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
500
596
  */
501
- BusinessType: string;
597
+ IdCardType?: string;
502
598
  /**
503
- * 上传文件内容数组,最多支持20个文件
599
+ * 经办人证件号
504
600
  */
505
- FileInfos?: Array<UploadFile>;
601
+ IdCardNumber?: string;
506
602
  /**
507
- * 操作者的信息
603
+ * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
508
604
  */
509
- Operator?: UserInfo;
605
+ Mobile?: string;
510
606
  }
511
607
  /**
512
- * DescribeResourceUrlsByFlows请求参数结构体
608
+ * ChannelGetTaskResultApi请求参数结构体
513
609
  */
514
- export interface DescribeResourceUrlsByFlowsRequest {
610
+ export interface ChannelGetTaskResultApiRequest {
515
611
  /**
516
- * 渠道应用相关信息。
517
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
518
- */
612
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
613
+ */
519
614
  Agent: Agent;
520
615
  /**
521
- * 查询资源所对应的签署流程Id,最多支持50个。
616
+ * 任务Id,通过ChannelCreateConvertTaskApi接口获得
522
617
  */
523
- FlowIds?: Array<string>;
618
+ TaskId: string;
524
619
  /**
525
620
  * 操作者的信息
526
621
  */
527
622
  Operator?: UserInfo;
623
+ /**
624
+ * 暂未开放
625
+ */
626
+ Organization?: OrganizationInfo;
528
627
  }
529
628
  /**
530
629
  * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
@@ -541,6 +640,7 @@ export interface UploadFile {
541
640
  }
542
641
  /**
543
642
  * 此结构体 (Component) 用于描述控件属性。
643
+
544
644
  */
545
645
  export interface Component {
546
646
  /**
@@ -559,12 +659,18 @@ export interface Component {
559
659
  /**
560
660
  * 如果是Component控件类型,则可选的字段为:
561
661
  TEXT - 普通文本控件;
562
- DATE - 普通日期控件;跟TEXT相比会有校验逻辑
662
+ MULTI_LINE_TEXT - 多行文本控件;
663
+ CHECK_BOX - 勾选框控件;
664
+ FILL_IMAGE - 图片控件;
665
+ DYNAMIC_TABLE - 动态表格控件;
666
+ ATTACHMENT - 附件控件;
667
+ SELECTOR - 选择器控件;
668
+
563
669
  如果是SignComponent控件类型,则可选的字段为
564
670
  SIGN_SEAL - 签署印章控件;
565
671
  SIGN_DATE - 签署日期控件;
566
672
  SIGN_SIGNATURE - 用户签名控件;
567
- SIGN_PERSONAL_SEAL - 个人签署印章控件;
673
+ SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
568
674
 
569
675
  表单域的控件不能作为印章和签名控件
570
676
  */
@@ -618,8 +724,13 @@ export interface Component {
618
724
  */
619
725
  ComponentExtra?: string;
620
726
  /**
621
- * 印章 ID,传参 DEFAULT_COMPANY_SEAL 表示使用默认印章。
622
- 控件填入内容,印章控件里面,如果是手写签名内容为PNG图片格式的base64编码
727
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
728
+ TEXT - 文本内容
729
+ MULTI_LINE_TEXT - 文本内容
730
+ CHECK_BOX - true/false
731
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
732
+ SELECTOR - 选项值
733
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
623
734
  */
624
735
  ComponentValue?: string;
625
736
  /**
@@ -741,6 +852,31 @@ export interface CreateConsoleLoginUrlRequest {
741
852
  */
742
853
  Operator?: UserInfo;
743
854
  }
855
+ /**
856
+ * 机构信息
857
+ */
858
+ export interface OrganizationInfo {
859
+ /**
860
+ * 用户在渠道的机构编号
861
+ */
862
+ OrganizationOpenId: string;
863
+ /**
864
+ * 用户真实的IP
865
+ */
866
+ ClientIp: string;
867
+ /**
868
+ * 机构的代理IP
869
+ */
870
+ ProxyIp: string;
871
+ /**
872
+ * 机构在平台的编号
873
+ */
874
+ OrganizationId?: string;
875
+ /**
876
+ * 用户渠道
877
+ */
878
+ Channel?: string;
879
+ }
744
880
  /**
745
881
  * CreateFlowsByTemplates返回参数结构体
746
882
  */
@@ -762,11 +898,39 @@ export interface CreateFlowsByTemplatesResponse {
762
898
  * 预览模式下返回的预览文件url数组
763
899
  */
764
900
  PreviewUrls: Array<string>;
901
+ /**
902
+ * 复杂文档合成任务的任务信息数组
903
+ */
904
+ TaskInfos: Array<TaskInfo>;
765
905
  /**
766
906
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
767
907
  */
768
908
  RequestId?: string;
769
909
  }
910
+ /**
911
+ * ChannelCreateFlowSignReview请求参数结构体
912
+ */
913
+ export interface ChannelCreateFlowSignReviewRequest {
914
+ /**
915
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
916
+ */
917
+ Agent: Agent;
918
+ /**
919
+ * 签署流程编号
920
+ */
921
+ FlowId: string;
922
+ /**
923
+ * 企业内部审核结果
924
+ PASS: 通过
925
+ REJECT: 拒绝
926
+ */
927
+ ReviewType: string;
928
+ /**
929
+ * 审核原因
930
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
931
+ */
932
+ ReviewMessage?: string;
933
+ }
770
934
  /**
771
935
  * PrepareFlows请求参数结构体
772
936
  */
@@ -822,6 +986,23 @@ export interface CreateSealByImageResponse {
822
986
  */
823
987
  RequestId?: string;
824
988
  }
989
+ /**
990
+ * 一码多扫签署二维码签署信息
991
+ */
992
+ export interface SignUrl {
993
+ /**
994
+ * 小程序签署链接
995
+ */
996
+ AppSignUrl: string;
997
+ /**
998
+ * 签署链接有效时间
999
+ */
1000
+ EffectiveTime: string;
1001
+ /**
1002
+ * 移动端签署链接
1003
+ */
1004
+ HttpSignUrl: string;
1005
+ }
825
1006
  /**
826
1007
  * 流程对应资源链接信息
827
1008
  */
@@ -975,29 +1156,21 @@ export interface CreateSealByImageRequest {
975
1156
  Operator?: UserInfo;
976
1157
  }
977
1158
  /**
978
- * 接口调用者信息
1159
+ * 一码多扫签署二维码对象
979
1160
  */
980
- export interface UserInfo {
981
- /**
982
- * 用户在渠道的编号
983
- */
984
- OpenId?: string;
985
- /**
986
- * 用户的来源渠道
987
- */
988
- Channel?: string;
1161
+ export interface SignQrCode {
989
1162
  /**
990
- * 自定义用户编号
1163
+ * 二维码id
991
1164
  */
992
- CustomUserId?: string;
1165
+ QrCodeId: string;
993
1166
  /**
994
- * 用户真实IP
1167
+ * 二维码url
995
1168
  */
996
- ClientIp?: string;
1169
+ QrCodeUrl: string;
997
1170
  /**
998
- * 用户代理IP
1171
+ * 二维码过期时间
999
1172
  */
1000
- ProxyIp?: string;
1173
+ ExpiredTime: number;
1001
1174
  }
1002
1175
  /**
1003
1176
  * DescribeUsage返回参数结构体
@@ -1046,46 +1219,39 @@ export interface UsageDetail {
1046
1219
  Cancel: number;
1047
1220
  }
1048
1221
  /**
1049
- * CreateSignUrls返回参数结构体
1222
+ * ChannelCreateBatchCancelFlowUrl返回参数结构体
1050
1223
  */
1051
- export interface CreateSignUrlsResponse {
1224
+ export interface ChannelCreateBatchCancelFlowUrlResponse {
1052
1225
  /**
1053
- * 签署参与者签署H5链接信息数组
1226
+ * 批量撤销url
1054
1227
  */
1055
- SignUrlInfos: Array<SignUrlInfo>;
1228
+ BatchCancelFlowUrl: string;
1056
1229
  /**
1057
- * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
1230
+ * 签署流程批量撤销失败原因
1058
1231
  */
1059
- ErrorMessages: Array<string>;
1232
+ FailMessages: Array<string>;
1233
+ /**
1234
+ * 签署撤销url过期时间-年月日-时分秒
1235
+ */
1236
+ UrlExpireOn: string;
1060
1237
  /**
1061
1238
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1062
1239
  */
1063
1240
  RequestId?: string;
1064
1241
  }
1065
1242
  /**
1066
- * OperateChannelTemplate请求参数结构体
1243
+ * DescribeResourceUrlsByFlows请求参数结构体
1067
1244
  */
1068
- export interface OperateChannelTemplateRequest {
1245
+ export interface DescribeResourceUrlsByFlowsRequest {
1069
1246
  /**
1070
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1071
- */
1247
+ * 渠道应用相关信息。
1248
+ 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1249
+ */
1072
1250
  Agent: Agent;
1073
1251
  /**
1074
- * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
1075
- */
1076
- OperateType: string;
1077
- /**
1078
- * 渠道方模板库模板唯一标识
1079
- */
1080
- TemplateId: string;
1081
- /**
1082
- * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
1083
- */
1084
- ProxyOrganizationOpenIds?: string;
1085
- /**
1086
- * 模板可见性, 全部可见-"all", 部分可见-"part"
1252
+ * 查询资源所对应的签署流程Id,最多支持50个。
1087
1253
  */
1088
- AuthTag?: string;
1254
+ FlowIds?: Array<string>;
1089
1255
  /**
1090
1256
  * 操作者的信息
1091
1257
  */
@@ -1121,6 +1287,19 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
1121
1287
  */
1122
1288
  Operator?: UserInfo;
1123
1289
  }
1290
+ /**
1291
+ * CreateChannelFlowEvidenceReport返回参数结构体
1292
+ */
1293
+ export interface CreateChannelFlowEvidenceReportResponse {
1294
+ /**
1295
+ * 出证报告 URL(有效五分钟)
1296
+ */
1297
+ ReportUrl: string;
1298
+ /**
1299
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1300
+ */
1301
+ RequestId?: string;
1302
+ }
1124
1303
  /**
1125
1304
  * 同步经办人失败原因
1126
1305
  */
@@ -1136,6 +1315,19 @@ export interface SyncFailReason {
1136
1315
  */
1137
1316
  Message: string;
1138
1317
  }
1318
+ /**
1319
+ * PrepareFlows返回参数结构体
1320
+ */
1321
+ export interface PrepareFlowsResponse {
1322
+ /**
1323
+ * 待发起文件确认页
1324
+ */
1325
+ ConfirmUrl: string;
1326
+ /**
1327
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1328
+ */
1329
+ RequestId?: string;
1330
+ }
1139
1331
  /**
1140
1332
  * DescribeUsage请求参数结构体
1141
1333
  */
@@ -1172,12 +1364,50 @@ export interface DescribeUsageRequest {
1172
1364
  */
1173
1365
  Operator?: UserInfo;
1174
1366
  }
1367
+ /**
1368
+ * ChannelCreateBatchCancelFlowUrl请求参数结构体
1369
+ */
1370
+ export interface ChannelCreateBatchCancelFlowUrlRequest {
1371
+ /**
1372
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1373
+ */
1374
+ Agent: Agent;
1375
+ /**
1376
+ * 签署流程Id数组
1377
+ */
1378
+ FlowIds: Array<string>;
1379
+ /**
1380
+ * 操作人信息
1381
+ */
1382
+ Operator?: UserInfo;
1383
+ }
1384
+ /**
1385
+ * 指定签署人限制项
1386
+ */
1387
+ export interface ApproverRestriction {
1388
+ /**
1389
+ * 指定签署人名字
1390
+ */
1391
+ Name?: string;
1392
+ /**
1393
+ * 指定签署人手机号
1394
+ */
1395
+ Mobile?: string;
1396
+ /**
1397
+ * 指定签署人证件类型
1398
+ */
1399
+ IdCardType?: string;
1400
+ /**
1401
+ * 指定签署人证件号码
1402
+ */
1403
+ IdCardNumber?: string;
1404
+ }
1175
1405
  /**
1176
1406
  * ChannelCreateFlowByFiles请求参数结构体
1177
1407
  */
1178
1408
  export interface ChannelCreateFlowByFilesRequest {
1179
1409
  /**
1180
- * 渠道应用相关信息
1410
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1181
1411
  */
1182
1412
  Agent?: Agent;
1183
1413
  /**
@@ -1193,7 +1423,7 @@ export interface ChannelCreateFlowByFilesRequest {
1193
1423
  */
1194
1424
  FileIds?: Array<string>;
1195
1425
  /**
1196
- * 签署文件中的控件,如:填写控件等
1426
+ * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
1197
1427
  */
1198
1428
  Components?: Array<Component>;
1199
1429
  /**
@@ -1224,6 +1454,10 @@ export interface ChannelCreateFlowByFilesRequest {
1224
1454
  * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1225
1455
  */
1226
1456
  CustomerData?: string;
1457
+ /**
1458
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1459
+ */
1460
+ NeedSignReview?: boolean;
1227
1461
  /**
1228
1462
  * 操作者的信息
1229
1463
  */
@@ -1264,6 +1498,15 @@ export interface UploadFilesResponse {
1264
1498
  */
1265
1499
  RequestId?: string;
1266
1500
  }
1501
+ /**
1502
+ * ChannelCreateFlowSignReview返回参数结构体
1503
+ */
1504
+ export interface ChannelCreateFlowSignReviewResponse {
1505
+ /**
1506
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1507
+ */
1508
+ RequestId?: string;
1509
+ }
1267
1510
  /**
1268
1511
  * 应用相关信息
1269
1512
  */
@@ -1273,7 +1516,7 @@ export interface Agent {
1273
1516
  */
1274
1517
  AppId: string;
1275
1518
  /**
1276
- * 渠道/平台合作企业的企业ID
1519
+ * 渠道/平台合作企业的企业ID,最大64位字符串
1277
1520
  */
1278
1521
  ProxyOrganizationOpenId?: string;
1279
1522
  /**
@@ -1285,20 +1528,28 @@ export interface Agent {
1285
1528
  */
1286
1529
  ProxyAppId?: string;
1287
1530
  /**
1288
- * 腾讯电子签颁发给渠道侧合作企业的企业ID
1531
+ * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
1289
1532
  */
1290
1533
  ProxyOrganizationId?: string;
1291
1534
  }
1292
1535
  /**
1293
1536
  * 此结构 (FormField) 用于描述内容控件填充结构。
1537
+
1294
1538
  */
1295
1539
  export interface FormField {
1296
1540
  /**
1297
- * 表单域或控件的Value
1298
- */
1541
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
1542
+ TEXT - 文本内容
1543
+ MULTI_LINE_TEXT - 文本内容
1544
+ CHECK_BOX - true/false
1545
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1546
+ SELECTOR - 选项值
1547
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1548
+ */
1299
1549
  ComponentValue: string;
1300
1550
  /**
1301
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空
1551
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1552
+ CreateFlowsByTemplates 接口不使用此字段。
1302
1553
  注意:此字段可能返回 null,表示取不到有效值。
1303
1554
  */
1304
1555
  ComponentId?: string;
@@ -1308,6 +1559,60 @@ export interface FormField {
1308
1559
  */
1309
1560
  ComponentName?: string;
1310
1561
  }
1562
+ /**
1563
+ * 接口调用者信息
1564
+ */
1565
+ export interface UserInfo {
1566
+ /**
1567
+ * 用户在渠道的编号,最大64位字符串
1568
+ */
1569
+ OpenId?: string;
1570
+ /**
1571
+ * 用户的来源渠道
1572
+ */
1573
+ Channel?: string;
1574
+ /**
1575
+ * 自定义用户编号
1576
+ */
1577
+ CustomUserId?: string;
1578
+ /**
1579
+ * 用户真实IP
1580
+ */
1581
+ ClientIp?: string;
1582
+ /**
1583
+ * 用户代理IP
1584
+ */
1585
+ ProxyIp?: string;
1586
+ }
1587
+ /**
1588
+ * ChannelCreateConvertTaskApi请求参数结构体
1589
+ */
1590
+ export interface ChannelCreateConvertTaskApiRequest {
1591
+ /**
1592
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1593
+ */
1594
+ Agent: Agent;
1595
+ /**
1596
+ * 资源类型 取值范围doc,docx,html之一
1597
+ */
1598
+ ResourceType: string;
1599
+ /**
1600
+ * 资源名称,长度限制为256字符
1601
+ */
1602
+ ResourceName: string;
1603
+ /**
1604
+ * 资源Id,通过UploadFiles获取
1605
+ */
1606
+ ResourceId: string;
1607
+ /**
1608
+ * 操作者信息
1609
+ */
1610
+ Operator?: UserInfo;
1611
+ /**
1612
+ * 暂未开放
1613
+ */
1614
+ Organization?: OrganizationInfo;
1615
+ }
1311
1616
  /**
1312
1617
  * 签署人的流程信息明细
1313
1618
  */
@@ -1364,6 +1669,66 @@ export interface FlowApproverDetail {
1364
1669
  }
1365
1670
  /**
1366
1671
  * 此结构体 (FlowInfo) 用于描述签署流程信息。
1672
+
1673
+ 【动态表格传参说明】
1674
+ 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
1675
+ 输入示例
1676
+
1677
+ ```
1678
+ {
1679
+ "headers":[
1680
+ {
1681
+ "content":"head1"
1682
+ },
1683
+ {
1684
+ "content":"head2"
1685
+ },
1686
+ {
1687
+ "content":"head3"
1688
+ }
1689
+ ],
1690
+ "rowCount":3,
1691
+ "body":{
1692
+ "cells":[
1693
+ {
1694
+ "rowStart":1,
1695
+ "rowEnd":1,
1696
+ "columnStart":1,
1697
+ "columnEnd":1,
1698
+ "content":"123"
1699
+ },
1700
+ {
1701
+ "rowStart":2,
1702
+ "rowEnd":3,
1703
+ "columnStart":1,
1704
+ "columnEnd":2,
1705
+ "content":"456"
1706
+ },
1707
+ {
1708
+ "rowStart":3,
1709
+ "rowEnd":3,
1710
+ "columnStart":3,
1711
+ "columnEnd":3,
1712
+ "content":"789"
1713
+ }
1714
+ ]
1715
+ }
1716
+ }
1717
+
1718
+ ```
1719
+
1720
+ 表格参数说明
1721
+
1722
+ | 名称 | 类型 | 描述 |
1723
+ | ------------------- | ------- | ------------------------------------------------- |
1724
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
1725
+ | rowCount | Integer | 表格内容最大行数 |
1726
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
1727
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
1728
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
1729
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
1730
+ | cells.N.content | String | 单元格内容,字数不超过100 |
1731
+
1367
1732
  */
1368
1733
  export interface FlowInfo {
1369
1734
  /**
@@ -1410,6 +1775,13 @@ export interface FlowInfo {
1410
1775
  * 被抄送人的信息列表,抄送功能暂不开放
1411
1776
  */
1412
1777
  CcInfos?: Array<CcInfo>;
1778
+ /**
1779
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
1780
+ 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1781
+
1782
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1783
+ */
1784
+ NeedSignReview?: boolean;
1413
1785
  }
1414
1786
  /**
1415
1787
  * 签署链接内容
@@ -1478,6 +1850,21 @@ export interface SignUrlInfo {
1478
1850
  */
1479
1851
  OpenId: string;
1480
1852
  }
1853
+ /**
1854
+ * 复杂文档合成任务的任务信息
1855
+ */
1856
+ export interface TaskInfo {
1857
+ /**
1858
+ * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
1859
+ 注意:此字段可能返回 null,表示取不到有效值。
1860
+ */
1861
+ TaskId: string;
1862
+ /**
1863
+ * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
1864
+ 注意:此字段可能返回 null,表示取不到有效值。
1865
+ */
1866
+ TaskStatus: string;
1867
+ }
1481
1868
  /**
1482
1869
  * 抄送信息
1483
1870
  */