tencentcloud-sdk-nodejs-essbasic 4.0.551 → 4.0.554
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/CHANGELOG.md +516 -0
- package/SERVICE_CHANGELOG.md +467 -77
- package/package.json +1 -1
- package/products.md +35 -35
- package/src/services/essbasic/v20210526/essbasic_client.ts +29 -13
- package/src/services/essbasic/v20210526/essbasic_models.ts +317 -70
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +16 -12
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +17 -11
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +279 -70
|
@@ -72,7 +72,7 @@ export interface ChannelBatchCancelFlowsResponse {
|
|
|
72
72
|
RequestId?: string;
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
75
|
+
* 第三方应用集成员工部门信息
|
|
76
76
|
*/
|
|
77
77
|
export interface Department {
|
|
78
78
|
/**
|
|
@@ -86,6 +86,16 @@ export interface Department {
|
|
|
86
86
|
*/
|
|
87
87
|
DepartmentName: string;
|
|
88
88
|
}
|
|
89
|
+
/**
|
|
90
|
+
* 签署人配置信息
|
|
91
|
+
*/
|
|
92
|
+
export interface CommonApproverOption {
|
|
93
|
+
/**
|
|
94
|
+
* 是否允许修改签署人信息
|
|
95
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
96
|
+
*/
|
|
97
|
+
CanEditApprover?: boolean;
|
|
98
|
+
}
|
|
89
99
|
/**
|
|
90
100
|
* ChannelCreateFlowSignReview请求参数结构体
|
|
91
101
|
*/
|
|
@@ -225,13 +235,17 @@ export interface ChannelCreateFlowSignUrlResponse {
|
|
|
225
235
|
RequestId?: string;
|
|
226
236
|
}
|
|
227
237
|
/**
|
|
228
|
-
*
|
|
238
|
+
* ChannelCreatePrepareFlow返回参数结构体
|
|
229
239
|
*/
|
|
230
|
-
export interface
|
|
240
|
+
export interface ChannelCreatePrepareFlowResponse {
|
|
231
241
|
/**
|
|
232
|
-
*
|
|
242
|
+
* 预发起的合同链接
|
|
233
243
|
*/
|
|
234
|
-
|
|
244
|
+
PrepareFlowUrl?: string;
|
|
245
|
+
/**
|
|
246
|
+
* 合同发起后预览链接
|
|
247
|
+
*/
|
|
248
|
+
PreviewFlowUrl?: string;
|
|
235
249
|
/**
|
|
236
250
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
237
251
|
*/
|
|
@@ -242,12 +256,12 @@ export interface CreateSealByImageResponse {
|
|
|
242
256
|
*/
|
|
243
257
|
export interface OperateChannelTemplateResponse {
|
|
244
258
|
/**
|
|
245
|
-
*
|
|
259
|
+
* 腾讯电子签颁发给第三方应用平台的应用ID
|
|
246
260
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
247
261
|
*/
|
|
248
262
|
AppId?: string;
|
|
249
263
|
/**
|
|
250
|
-
*
|
|
264
|
+
* 第三方应用平台模板库模板唯一标识
|
|
251
265
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
252
266
|
*/
|
|
253
267
|
TemplateId?: string;
|
|
@@ -309,7 +323,7 @@ export interface FlowFileInfo {
|
|
|
309
323
|
*/
|
|
310
324
|
CallbackUrl?: string;
|
|
311
325
|
/**
|
|
312
|
-
*
|
|
326
|
+
* 第三方应用的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
313
327
|
*/
|
|
314
328
|
CustomerData?: string;
|
|
315
329
|
/**
|
|
@@ -325,6 +339,61 @@ export interface FlowFileInfo {
|
|
|
325
339
|
*/
|
|
326
340
|
NeedSignReview?: boolean;
|
|
327
341
|
}
|
|
342
|
+
/**
|
|
343
|
+
* 创建合同配置信息
|
|
344
|
+
*/
|
|
345
|
+
export interface CreateFlowOption {
|
|
346
|
+
/**
|
|
347
|
+
* 是否允许修改合同信息
|
|
348
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
349
|
+
*/
|
|
350
|
+
CanEditFlow?: boolean;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* 基础流程信息
|
|
354
|
+
*/
|
|
355
|
+
export interface BaseFlowInfo {
|
|
356
|
+
/**
|
|
357
|
+
* 合同流程名称
|
|
358
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
359
|
+
*/
|
|
360
|
+
FlowName: string;
|
|
361
|
+
/**
|
|
362
|
+
* 合同流程类型
|
|
363
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
364
|
+
*/
|
|
365
|
+
FlowType: string;
|
|
366
|
+
/**
|
|
367
|
+
* 合同流程描述信息
|
|
368
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
369
|
+
*/
|
|
370
|
+
FlowDescription: string;
|
|
371
|
+
/**
|
|
372
|
+
* 合同流程截止时间,unix时间戳
|
|
373
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
374
|
+
*/
|
|
375
|
+
Deadline: number;
|
|
376
|
+
/**
|
|
377
|
+
* 是否顺序签署(true:无序签,false:顺序签)
|
|
378
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
379
|
+
*/
|
|
380
|
+
Unordered?: boolean;
|
|
381
|
+
/**
|
|
382
|
+
* 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
|
|
383
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
384
|
+
*/
|
|
385
|
+
IntelligentStatus?: string;
|
|
386
|
+
/**
|
|
387
|
+
* 填写控件内容
|
|
388
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
389
|
+
*/
|
|
390
|
+
FormFields?: Array<FormField>;
|
|
391
|
+
/**
|
|
392
|
+
* 本企业(发起方企业)是否需要签署审批,true:开启本企业签署审批
|
|
393
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
394
|
+
*/
|
|
395
|
+
NeedSignReview?: boolean;
|
|
396
|
+
}
|
|
328
397
|
/**
|
|
329
398
|
* CreateConsoleLoginUrl返回参数结构体
|
|
330
399
|
*/
|
|
@@ -361,7 +430,7 @@ export interface SyncProxyOrganizationRequest {
|
|
|
361
430
|
*/
|
|
362
431
|
Agent: Agent;
|
|
363
432
|
/**
|
|
364
|
-
*
|
|
433
|
+
* 第三方平台子客企业名称,最大长度64个字符
|
|
365
434
|
*/
|
|
366
435
|
ProxyOrganizationName: string;
|
|
367
436
|
/**
|
|
@@ -369,11 +438,11 @@ export interface SyncProxyOrganizationRequest {
|
|
|
369
438
|
*/
|
|
370
439
|
BusinessLicense?: string;
|
|
371
440
|
/**
|
|
372
|
-
*
|
|
441
|
+
* 第三方平台子客企业统一社会信用代码,最大长度200个字符
|
|
373
442
|
*/
|
|
374
443
|
UniformSocialCreditCode?: string;
|
|
375
444
|
/**
|
|
376
|
-
*
|
|
445
|
+
* 第三方平台子客企业法人/负责人姓名
|
|
377
446
|
*/
|
|
378
447
|
ProxyLegalName?: string;
|
|
379
448
|
/**
|
|
@@ -382,23 +451,47 @@ export interface SyncProxyOrganizationRequest {
|
|
|
382
451
|
Operator?: UserInfo;
|
|
383
452
|
}
|
|
384
453
|
/**
|
|
385
|
-
*
|
|
454
|
+
* ChannelCreatePrepareFlow请求参数结构体
|
|
386
455
|
*/
|
|
387
|
-
export interface
|
|
456
|
+
export interface ChannelCreatePrepareFlowRequest {
|
|
388
457
|
/**
|
|
389
|
-
*
|
|
458
|
+
* 资源id,与ResourceType对应
|
|
390
459
|
*/
|
|
391
|
-
|
|
460
|
+
ResourceId: string;
|
|
392
461
|
/**
|
|
393
|
-
*
|
|
462
|
+
* 资源类型,1:模版,目前仅支持模版,与ResourceId对应
|
|
394
463
|
*/
|
|
395
|
-
|
|
464
|
+
ResourceType: number;
|
|
396
465
|
/**
|
|
397
|
-
*
|
|
466
|
+
* 合同流程基础信息
|
|
398
467
|
*/
|
|
399
|
-
|
|
468
|
+
FlowInfo: BaseFlowInfo;
|
|
400
469
|
/**
|
|
401
|
-
*
|
|
470
|
+
* 合同签署人信息
|
|
471
|
+
*/
|
|
472
|
+
FlowApproverList: Array<CommonFlowApprover>;
|
|
473
|
+
/**
|
|
474
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
475
|
+
*/
|
|
476
|
+
Agent?: Agent;
|
|
477
|
+
/**
|
|
478
|
+
* 合同流程配置信息
|
|
479
|
+
*/
|
|
480
|
+
FlowOption?: CreateFlowOption;
|
|
481
|
+
/**
|
|
482
|
+
* 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
|
|
483
|
+
*/
|
|
484
|
+
FlowId?: string;
|
|
485
|
+
/**
|
|
486
|
+
* 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
|
|
487
|
+
*/
|
|
488
|
+
NeedPreview?: boolean;
|
|
489
|
+
/**
|
|
490
|
+
* 企业机构信息,不用传
|
|
491
|
+
*/
|
|
492
|
+
Organization?: OrganizationInfo;
|
|
493
|
+
/**
|
|
494
|
+
* 操作人(用户)信息,不用传
|
|
402
495
|
*/
|
|
403
496
|
Operator?: UserInfo;
|
|
404
497
|
}
|
|
@@ -549,7 +642,7 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
549
642
|
*/
|
|
550
643
|
CustomShowMap?: string;
|
|
551
644
|
/**
|
|
552
|
-
*
|
|
645
|
+
* 业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
553
646
|
*/
|
|
554
647
|
CustomerData?: string;
|
|
555
648
|
/**
|
|
@@ -581,15 +674,15 @@ export interface Agent {
|
|
|
581
674
|
*/
|
|
582
675
|
AppId: string;
|
|
583
676
|
/**
|
|
584
|
-
*
|
|
677
|
+
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
585
678
|
*/
|
|
586
679
|
ProxyOrganizationOpenId?: string;
|
|
587
680
|
/**
|
|
588
|
-
*
|
|
681
|
+
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
589
682
|
*/
|
|
590
683
|
ProxyOperator?: UserInfo;
|
|
591
684
|
/**
|
|
592
|
-
*
|
|
685
|
+
* 在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
593
686
|
*/
|
|
594
687
|
ProxyAppId?: string;
|
|
595
688
|
/**
|
|
@@ -606,16 +699,16 @@ export interface FlowApproverDetail {
|
|
|
606
699
|
*/
|
|
607
700
|
ReceiptId: string;
|
|
608
701
|
/**
|
|
609
|
-
*
|
|
702
|
+
* 平台企业的第三方id
|
|
610
703
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
611
704
|
*/
|
|
612
705
|
ProxyOrganizationOpenId: string;
|
|
613
706
|
/**
|
|
614
|
-
*
|
|
707
|
+
* 平台企业操作人的第三方id
|
|
615
708
|
*/
|
|
616
709
|
ProxyOperatorOpenId: string;
|
|
617
710
|
/**
|
|
618
|
-
*
|
|
711
|
+
* 平台企业名称
|
|
619
712
|
*/
|
|
620
713
|
ProxyOrganizationName: string;
|
|
621
714
|
/**
|
|
@@ -709,11 +802,11 @@ export interface ChannelCreateFlowGroupByFilesRequest {
|
|
|
709
802
|
*/
|
|
710
803
|
export interface DescribeFlowDetailInfoResponse {
|
|
711
804
|
/**
|
|
712
|
-
*
|
|
805
|
+
* 第三方平台应用号Id
|
|
713
806
|
*/
|
|
714
807
|
ApplicationId?: string;
|
|
715
808
|
/**
|
|
716
|
-
*
|
|
809
|
+
* 第三方平台子客企业OpenId
|
|
717
810
|
*/
|
|
718
811
|
ProxyOrganizationOpenId?: string;
|
|
719
812
|
/**
|
|
@@ -762,9 +855,9 @@ export interface ResourceUrlInfo {
|
|
|
762
855
|
其中签署方FlowApproverInfo需要传递的参数
|
|
763
856
|
非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
|
|
764
857
|
1-个人:Name、Mobile必传
|
|
765
|
-
2
|
|
766
|
-
3
|
|
767
|
-
4
|
|
858
|
+
2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
859
|
+
3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;
|
|
860
|
+
4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
768
861
|
|
|
769
862
|
RecipientId参数:
|
|
770
863
|
从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
|
|
@@ -794,17 +887,17 @@ export interface FlowApproverInfo {
|
|
|
794
887
|
*/
|
|
795
888
|
OrganizationName?: string;
|
|
796
889
|
/**
|
|
797
|
-
*
|
|
798
|
-
默认为false
|
|
890
|
+
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
891
|
+
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
799
892
|
*/
|
|
800
893
|
NotChannelOrganization?: boolean;
|
|
801
894
|
/**
|
|
802
895
|
* 用户侧第三方id,最大长度64个字符
|
|
803
|
-
|
|
896
|
+
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
804
897
|
*/
|
|
805
898
|
OpenId?: string;
|
|
806
899
|
/**
|
|
807
|
-
*
|
|
900
|
+
* 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
808
901
|
*/
|
|
809
902
|
OrganizationOpenId?: string;
|
|
810
903
|
/**
|
|
@@ -916,21 +1009,21 @@ export interface TemplateInfo {
|
|
|
916
1009
|
*/
|
|
917
1010
|
PreviewUrl: string;
|
|
918
1011
|
/**
|
|
919
|
-
*
|
|
1012
|
+
* 第三方应用集成-模板PDF文件链接
|
|
920
1013
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
921
1014
|
*/
|
|
922
1015
|
PdfUrl: string;
|
|
923
1016
|
/**
|
|
924
|
-
*
|
|
1017
|
+
* 关联的平台企业模板ID
|
|
925
1018
|
*/
|
|
926
1019
|
ChannelTemplateId: string;
|
|
927
1020
|
/**
|
|
928
|
-
*
|
|
1021
|
+
* 关联的平台企业模板名称
|
|
929
1022
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
930
1023
|
*/
|
|
931
1024
|
ChannelTemplateName: string;
|
|
932
1025
|
/**
|
|
933
|
-
* 0
|
|
1026
|
+
* 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
|
|
934
1027
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
935
1028
|
*/
|
|
936
1029
|
ChannelAutoSave: number;
|
|
@@ -1020,7 +1113,7 @@ export interface DescribeTemplatesResponse {
|
|
|
1020
1113
|
RequestId?: string;
|
|
1021
1114
|
}
|
|
1022
1115
|
/**
|
|
1023
|
-
*
|
|
1116
|
+
* 第三方应用集成员工角色信息
|
|
1024
1117
|
*/
|
|
1025
1118
|
export interface StaffRole {
|
|
1026
1119
|
/**
|
|
@@ -1161,6 +1254,81 @@ export interface OrganizationInfo {
|
|
|
1161
1254
|
*/
|
|
1162
1255
|
Channel?: string;
|
|
1163
1256
|
}
|
|
1257
|
+
/**
|
|
1258
|
+
* 通用签署人信息
|
|
1259
|
+
*/
|
|
1260
|
+
export interface CommonFlowApprover {
|
|
1261
|
+
/**
|
|
1262
|
+
* 指定当前签署人为第三方应用集成子客,默认false:当前签署人为第三方应用集成子客,true:当前签署人为saas企业用户
|
|
1263
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1264
|
+
*/
|
|
1265
|
+
NotChannelOrganization: boolean;
|
|
1266
|
+
/**
|
|
1267
|
+
* 签署人类型,目前支持:0-企业签署人,1-个人签署人,3-企业静默签署人
|
|
1268
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1269
|
+
*/
|
|
1270
|
+
ApproverType?: number;
|
|
1271
|
+
/**
|
|
1272
|
+
* 企业id
|
|
1273
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1274
|
+
*/
|
|
1275
|
+
OrganizationId?: string;
|
|
1276
|
+
/**
|
|
1277
|
+
* 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同毕传
|
|
1278
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1279
|
+
*/
|
|
1280
|
+
OrganizationOpenId?: string;
|
|
1281
|
+
/**
|
|
1282
|
+
* 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
|
|
1283
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1284
|
+
*/
|
|
1285
|
+
OrganizationName?: string;
|
|
1286
|
+
/**
|
|
1287
|
+
* 用户id
|
|
1288
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1289
|
+
*/
|
|
1290
|
+
UserId?: string;
|
|
1291
|
+
/**
|
|
1292
|
+
* 用户openId,第三方应用集成非静默签子客企业签署人必传
|
|
1293
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1294
|
+
*/
|
|
1295
|
+
OpenId?: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* 签署人名称,saas企业签署人,个人签署人必传
|
|
1298
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1299
|
+
*/
|
|
1300
|
+
ApproverName?: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* 签署人手机号,saas企业签署人,个人签署人必传
|
|
1303
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1304
|
+
*/
|
|
1305
|
+
ApproverMobile?: string;
|
|
1306
|
+
/**
|
|
1307
|
+
* 签署人Id,使用模版发起是,对应模版配置中的签署人RecipientId
|
|
1308
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1309
|
+
*/
|
|
1310
|
+
RecipientId?: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* 签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s
|
|
1313
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1314
|
+
*/
|
|
1315
|
+
PreReadTime?: number;
|
|
1316
|
+
/**
|
|
1317
|
+
* 签署前置条件:阅读全文限制
|
|
1318
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1319
|
+
*/
|
|
1320
|
+
IsFullText?: boolean;
|
|
1321
|
+
/**
|
|
1322
|
+
* 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
|
|
1323
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1324
|
+
*/
|
|
1325
|
+
NotifyType?: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* 签署人配置
|
|
1328
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1329
|
+
*/
|
|
1330
|
+
ApproverOption?: CommonApproverOption;
|
|
1331
|
+
}
|
|
1164
1332
|
/**
|
|
1165
1333
|
* 合同文件验签单个结果结构体
|
|
1166
1334
|
*/
|
|
@@ -1244,7 +1412,7 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
|
1244
1412
|
*/
|
|
1245
1413
|
export interface UploadFilesRequest {
|
|
1246
1414
|
/**
|
|
1247
|
-
*
|
|
1415
|
+
* 应用相关信息,若是第三方应用集成调用 appid 和proxyappid 必填
|
|
1248
1416
|
*/
|
|
1249
1417
|
Agent: Agent;
|
|
1250
1418
|
/**
|
|
@@ -1316,8 +1484,8 @@ export interface DescribeUsageRequest {
|
|
|
1316
1484
|
EndDate: string;
|
|
1317
1485
|
/**
|
|
1318
1486
|
* 是否汇总数据,默认不汇总。
|
|
1319
|
-
|
|
1320
|
-
|
|
1487
|
+
不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
1488
|
+
汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
|
|
1321
1489
|
*/
|
|
1322
1490
|
NeedAggregate?: boolean;
|
|
1323
1491
|
/**
|
|
@@ -1376,7 +1544,7 @@ export interface FormField {
|
|
|
1376
1544
|
* 此结构体 (FlowInfo) 用于描述签署流程信息。
|
|
1377
1545
|
|
|
1378
1546
|
【数据表格传参说明】
|
|
1379
|
-
当模板的 ComponentType='DYNAMIC_TABLE'
|
|
1547
|
+
当模板的 ComponentType='DYNAMIC_TABLE'时( 第三方应用集成或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
|
|
1380
1548
|
输入示例1:
|
|
1381
1549
|
|
|
1382
1550
|
```
|
|
@@ -1487,7 +1655,6 @@ export interface FormField {
|
|
|
1487
1655
|
| ------------------- | ------- | ------------------------------------------------- |
|
|
1488
1656
|
| widthPercent | Integer | 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35 |
|
|
1489
1657
|
| content | String | 表头单元格内容,字数不超过100 |
|
|
1490
|
-
|
|
1491
1658
|
*/
|
|
1492
1659
|
export interface FlowInfo {
|
|
1493
1660
|
/**
|
|
@@ -1523,7 +1690,7 @@ export interface FlowInfo {
|
|
|
1523
1690
|
*/
|
|
1524
1691
|
FlowDescription?: string;
|
|
1525
1692
|
/**
|
|
1526
|
-
*
|
|
1693
|
+
* 第三方应用平台的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
1527
1694
|
*/
|
|
1528
1695
|
CustomerData?: string;
|
|
1529
1696
|
/**
|
|
@@ -1547,7 +1714,7 @@ export interface FlowInfo {
|
|
|
1547
1714
|
*/
|
|
1548
1715
|
export interface UserInfo {
|
|
1549
1716
|
/**
|
|
1550
|
-
*
|
|
1717
|
+
* 第三方应用平台自定义,对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
|
|
1551
1718
|
*/
|
|
1552
1719
|
OpenId?: string;
|
|
1553
1720
|
/**
|
|
@@ -1769,14 +1936,14 @@ export interface CreateSignUrlsRequest {
|
|
|
1769
1936
|
/**
|
|
1770
1937
|
* 签署链接生成类型,默认是 "ALL";
|
|
1771
1938
|
"ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
|
|
1772
|
-
"CHANNEL"
|
|
1773
|
-
"NOT_CHANNEL"
|
|
1939
|
+
"CHANNEL":第三方平台子客企业企业;
|
|
1940
|
+
"NOT_CHANNEL":非第三方平台子客企业企业;
|
|
1774
1941
|
"PERSON":个人;
|
|
1775
1942
|
"FOLLOWER":关注方,目前是合同抄送方;
|
|
1776
1943
|
*/
|
|
1777
1944
|
GenerateType?: string;
|
|
1778
1945
|
/**
|
|
1779
|
-
*
|
|
1946
|
+
* 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
|
|
1780
1947
|
*/
|
|
1781
1948
|
OrganizationName?: string;
|
|
1782
1949
|
/**
|
|
@@ -1789,11 +1956,11 @@ export interface CreateSignUrlsRequest {
|
|
|
1789
1956
|
*/
|
|
1790
1957
|
Mobile?: string;
|
|
1791
1958
|
/**
|
|
1792
|
-
*
|
|
1959
|
+
* 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
|
|
1793
1960
|
*/
|
|
1794
1961
|
OrganizationOpenId?: string;
|
|
1795
1962
|
/**
|
|
1796
|
-
*
|
|
1963
|
+
* 第三方平台子客企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
|
|
1797
1964
|
*/
|
|
1798
1965
|
OpenId?: string;
|
|
1799
1966
|
/**
|
|
@@ -1844,7 +2011,7 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
1844
2011
|
Restrictions?: Array<ApproverRestriction>;
|
|
1845
2012
|
/**
|
|
1846
2013
|
* 回调地址,最大长度1000个字符
|
|
1847
|
-
|
|
2014
|
+
不传默认使用第三方应用号配置的回调地址
|
|
1848
2015
|
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
1849
2016
|
*/
|
|
1850
2017
|
CallbackUrl?: string;
|
|
@@ -1945,7 +2112,7 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
1945
2112
|
*/
|
|
1946
2113
|
FlowIds?: Array<string>;
|
|
1947
2114
|
/**
|
|
1948
|
-
*
|
|
2115
|
+
* 业务信息,限制1024字符
|
|
1949
2116
|
*/
|
|
1950
2117
|
CustomerData?: Array<string>;
|
|
1951
2118
|
/**
|
|
@@ -2159,8 +2326,8 @@ export interface Filter {
|
|
|
2159
2326
|
如果需要指定B端(机构身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
|
|
2160
2327
|
ApproverNumber, OrganizationName, ApproverType必传。
|
|
2161
2328
|
对于其他身份标识
|
|
2162
|
-
-
|
|
2163
|
-
-
|
|
2329
|
+
- 子客企业指定经办人:OpenId必传,OrganizationOpenId必传;
|
|
2330
|
+
- 非子客企业:Name、Mobile必传。
|
|
2164
2331
|
*/
|
|
2165
2332
|
export interface ReleasedApprover {
|
|
2166
2333
|
/**
|
|
@@ -2196,12 +2363,12 @@ export interface ReleasedApprover {
|
|
|
2196
2363
|
*/
|
|
2197
2364
|
Mobile?: string;
|
|
2198
2365
|
/**
|
|
2199
|
-
*
|
|
2366
|
+
* 企业签署方在同一第三方应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符
|
|
2200
2367
|
*/
|
|
2201
2368
|
OrganizationOpenId?: string;
|
|
2202
2369
|
/**
|
|
2203
2370
|
* 用户侧第三方id,最大长度64个字符
|
|
2204
|
-
|
|
2371
|
+
当签署方为同一第三方应用下的员工时,该字必传
|
|
2205
2372
|
*/
|
|
2206
2373
|
OpenId?: string;
|
|
2207
2374
|
}
|
|
@@ -2229,15 +2396,15 @@ export interface UploadFilesResponse {
|
|
|
2229
2396
|
/**
|
|
2230
2397
|
* 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
|
|
2231
2398
|
*/
|
|
2232
|
-
FileIds
|
|
2399
|
+
FileIds?: Array<string>;
|
|
2233
2400
|
/**
|
|
2234
2401
|
* 上传成功文件数量
|
|
2235
2402
|
*/
|
|
2236
|
-
TotalCount
|
|
2403
|
+
TotalCount?: number;
|
|
2237
2404
|
/**
|
|
2238
2405
|
* 文件Url
|
|
2239
2406
|
*/
|
|
2240
|
-
FileUrls
|
|
2407
|
+
FileUrls?: Array<string>;
|
|
2241
2408
|
/**
|
|
2242
2409
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2243
2410
|
*/
|
|
@@ -2342,6 +2509,19 @@ export interface ChannelDescribeOrganizationSealsResponse {
|
|
|
2342
2509
|
*/
|
|
2343
2510
|
RequestId?: string;
|
|
2344
2511
|
}
|
|
2512
|
+
/**
|
|
2513
|
+
* CreateSealByImage返回参数结构体
|
|
2514
|
+
*/
|
|
2515
|
+
export interface CreateSealByImageResponse {
|
|
2516
|
+
/**
|
|
2517
|
+
* 印章id
|
|
2518
|
+
*/
|
|
2519
|
+
SealId?: string;
|
|
2520
|
+
/**
|
|
2521
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2522
|
+
*/
|
|
2523
|
+
RequestId?: string;
|
|
2524
|
+
}
|
|
2345
2525
|
/**
|
|
2346
2526
|
* ChannelCancelMultiFlowSignQRCode返回参数结构体
|
|
2347
2527
|
*/
|
|
@@ -2443,7 +2623,7 @@ export interface ChannelCreateBoundFlowsResponse {
|
|
|
2443
2623
|
*/
|
|
2444
2624
|
export interface ProxyOrganizationOperator {
|
|
2445
2625
|
/**
|
|
2446
|
-
* 对应Agent-ProxyOperator-OpenId
|
|
2626
|
+
* 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
|
|
2447
2627
|
*/
|
|
2448
2628
|
Id: string;
|
|
2449
2629
|
/**
|
|
@@ -2465,6 +2645,14 @@ export interface ProxyOrganizationOperator {
|
|
|
2465
2645
|
* 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
|
|
2466
2646
|
*/
|
|
2467
2647
|
Mobile?: string;
|
|
2648
|
+
/**
|
|
2649
|
+
* 默认角色,值为以下三个对应的英文:
|
|
2650
|
+
业务管理员:admin
|
|
2651
|
+
经办人:channel-normal-operator
|
|
2652
|
+
业务员:channel-sales-man
|
|
2653
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2654
|
+
*/
|
|
2655
|
+
DefaultRole?: string;
|
|
2468
2656
|
}
|
|
2469
2657
|
/**
|
|
2470
2658
|
* ModifyExtendedService返回参数结构体
|
|
@@ -2756,8 +2944,8 @@ export interface Component {
|
|
|
2756
2944
|
*/
|
|
2757
2945
|
OffsetY?: number;
|
|
2758
2946
|
/**
|
|
2759
|
-
*
|
|
2760
|
-
|
|
2947
|
+
* 平台企业控件ID。
|
|
2948
|
+
如果不为空,属于平台企业预设控件;
|
|
2761
2949
|
*/
|
|
2762
2950
|
ChannelComponentId?: string;
|
|
2763
2951
|
/**
|
|
@@ -2936,11 +3124,11 @@ export interface DescribeTemplatesRequest {
|
|
|
2936
3124
|
*/
|
|
2937
3125
|
WithPreviewUrl?: boolean;
|
|
2938
3126
|
/**
|
|
2939
|
-
* 是否获取模板的PDF
|
|
3127
|
+
* 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
|
|
2940
3128
|
*/
|
|
2941
3129
|
WithPdfUrl?: boolean;
|
|
2942
3130
|
/**
|
|
2943
|
-
*
|
|
3131
|
+
* 模板ID
|
|
2944
3132
|
*/
|
|
2945
3133
|
ChannelTemplateId?: string;
|
|
2946
3134
|
}
|
|
@@ -3051,11 +3239,11 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
3051
3239
|
*/
|
|
3052
3240
|
export interface UsageDetail {
|
|
3053
3241
|
/**
|
|
3054
|
-
*
|
|
3242
|
+
* 子客企业唯一标识
|
|
3055
3243
|
*/
|
|
3056
3244
|
ProxyOrganizationOpenId: string;
|
|
3057
3245
|
/**
|
|
3058
|
-
*
|
|
3246
|
+
* 子客企业名
|
|
3059
3247
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3060
3248
|
*/
|
|
3061
3249
|
ProxyOrganizationName: string;
|
|
@@ -3113,7 +3301,7 @@ export interface OperateChannelTemplateRequest {
|
|
|
3113
3301
|
*/
|
|
3114
3302
|
OperateType: string;
|
|
3115
3303
|
/**
|
|
3116
|
-
*
|
|
3304
|
+
* 第三方应用平台模板库模板唯一标识
|
|
3117
3305
|
*/
|
|
3118
3306
|
TemplateId: string;
|
|
3119
3307
|
/**
|
|
@@ -3229,6 +3417,27 @@ export interface DescribeChannelFlowEvidenceReportResponse {
|
|
|
3229
3417
|
*/
|
|
3230
3418
|
RequestId?: string;
|
|
3231
3419
|
}
|
|
3420
|
+
/**
|
|
3421
|
+
* CreateSealByImage请求参数结构体
|
|
3422
|
+
*/
|
|
3423
|
+
export interface CreateSealByImageRequest {
|
|
3424
|
+
/**
|
|
3425
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
3426
|
+
*/
|
|
3427
|
+
Agent: Agent;
|
|
3428
|
+
/**
|
|
3429
|
+
* 印章名称,最大长度不超过50字符
|
|
3430
|
+
*/
|
|
3431
|
+
SealName: string;
|
|
3432
|
+
/**
|
|
3433
|
+
* 印章图片base64,大小不超过10M(原始图片不超过7.6M)
|
|
3434
|
+
*/
|
|
3435
|
+
SealImage: string;
|
|
3436
|
+
/**
|
|
3437
|
+
* 操作者的信息
|
|
3438
|
+
*/
|
|
3439
|
+
Operator?: UserInfo;
|
|
3440
|
+
}
|
|
3232
3441
|
/**
|
|
3233
3442
|
* ChannelUpdateSealStatus返回参数结构体
|
|
3234
3443
|
*/
|