tencentcloud-sdk-nodejs-ess 4.0.617 → 4.0.619
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 +556 -0
- package/SERVICE_CHANGELOG.md +677 -22
- package/package.json +1 -1
- package/products.md +33 -33
- package/src/services/ess/v20201111/ess_client.ts +15 -3
- package/src/services/ess/v20201111/ess_models.ts +392 -877
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +6 -2
- package/tencentcloud/services/ess/v20201111/ess_client.js +7 -1
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +390 -331
|
@@ -80,19 +80,19 @@ export interface CreatePreparedPersonalEsignRequest {
|
|
|
80
80
|
*/
|
|
81
81
|
Operator?: UserInfo;
|
|
82
82
|
/**
|
|
83
|
-
|
|
83
|
+
* 身份证件类型:
|
|
84
84
|
ID_CARD 身份证
|
|
85
85
|
PASSPORT 护照
|
|
86
86
|
HONGKONG_AND_MACAO 中国香港
|
|
87
87
|
FOREIGN_ID_CARD 境外身份
|
|
88
88
|
HONGKONG_MACAO_AND_TAIWAN 中国台湾
|
|
89
|
-
|
|
89
|
+
*/
|
|
90
90
|
IdCardType?: string;
|
|
91
91
|
/**
|
|
92
|
-
|
|
92
|
+
* 印章图片的base64
|
|
93
93
|
注:已废弃
|
|
94
94
|
请先通过UploadFiles接口上传文件,获取 FileId
|
|
95
|
-
|
|
95
|
+
*/
|
|
96
96
|
SealImage?: string;
|
|
97
97
|
/**
|
|
98
98
|
* 是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。
|
|
@@ -107,26 +107,26 @@ export interface CreatePreparedPersonalEsignRequest {
|
|
|
107
107
|
*/
|
|
108
108
|
EnableAutoSign?: boolean;
|
|
109
109
|
/**
|
|
110
|
-
|
|
110
|
+
* 印章颜色(参数ProcessSeal=true时生效)
|
|
111
111
|
默认值:BLACK黑色
|
|
112
112
|
取值:
|
|
113
113
|
BLACK 黑色,
|
|
114
114
|
RED 红色,
|
|
115
115
|
BLUE 蓝色。
|
|
116
|
-
|
|
116
|
+
*/
|
|
117
117
|
SealColor?: string;
|
|
118
118
|
/**
|
|
119
|
-
|
|
119
|
+
* 是否处理印章
|
|
120
120
|
默认不做印章处理。
|
|
121
121
|
取值:false:不做任何处理;
|
|
122
122
|
true:做透明化处理和颜色增强。
|
|
123
|
-
|
|
123
|
+
*/
|
|
124
124
|
ProcessSeal?: boolean;
|
|
125
125
|
/**
|
|
126
|
-
|
|
126
|
+
* 印章图片文件 id
|
|
127
127
|
取值:
|
|
128
128
|
填写的FileId通过UploadFiles接口上传文件获取。
|
|
129
|
-
|
|
129
|
+
*/
|
|
130
130
|
FileId?: string;
|
|
131
131
|
}
|
|
132
132
|
/**
|
|
@@ -212,12 +212,12 @@ export interface CreateMultiFlowSignQRCodeResponse {
|
|
|
212
212
|
*/
|
|
213
213
|
export interface FlowCreateApprover {
|
|
214
214
|
/**
|
|
215
|
-
|
|
215
|
+
* 参与者类型:
|
|
216
216
|
0:企业
|
|
217
217
|
1:个人
|
|
218
218
|
3:企业静默签署
|
|
219
219
|
注:类型为3(企业静默签署)时,会默认完成该签署方的签署。静默签署仅进行盖章操作,不能是手写签名。
|
|
220
|
-
|
|
220
|
+
*/
|
|
221
221
|
ApproverType: number;
|
|
222
222
|
/**
|
|
223
223
|
* 如果签署方为企业,需要填入企业全称
|
|
@@ -232,10 +232,10 @@ export interface FlowCreateApprover {
|
|
|
232
232
|
*/
|
|
233
233
|
ApproverMobile?: string;
|
|
234
234
|
/**
|
|
235
|
-
|
|
235
|
+
* 签署方经办人证件类型ID_CARD 身份证
|
|
236
236
|
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
237
237
|
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
238
|
-
|
|
238
|
+
*/
|
|
239
239
|
ApproverIdCardType?: string;
|
|
240
240
|
/**
|
|
241
241
|
* 签署方经办人证件号码
|
|
@@ -287,13 +287,14 @@ export interface FlowCreateApprover {
|
|
|
287
287
|
ApproverOption?: ApproverOption;
|
|
288
288
|
/**
|
|
289
289
|
* 签署完前端跳转的url,暂未使用
|
|
290
|
+
* @deprecated
|
|
290
291
|
*/
|
|
291
292
|
JumpUrl?: string;
|
|
292
293
|
/**
|
|
293
|
-
|
|
294
|
+
* 签署ID
|
|
294
295
|
- 发起流程时系统自动补充
|
|
295
296
|
- 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
|
296
|
-
|
|
297
|
+
*/
|
|
297
298
|
SignId?: string;
|
|
298
299
|
}
|
|
299
300
|
/**
|
|
@@ -318,6 +319,15 @@ export interface DisableUserAutoSignResponse {
|
|
|
318
319
|
*/
|
|
319
320
|
RequestId?: string;
|
|
320
321
|
}
|
|
322
|
+
/**
|
|
323
|
+
* CancelUserAutoSignEnableUrl返回参数结构体
|
|
324
|
+
*/
|
|
325
|
+
export interface CancelUserAutoSignEnableUrlResponse {
|
|
326
|
+
/**
|
|
327
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
328
|
+
*/
|
|
329
|
+
RequestId?: string;
|
|
330
|
+
}
|
|
321
331
|
/**
|
|
322
332
|
* BindEmployeeUserIdWithClientOpenId返回参数结构体
|
|
323
333
|
*/
|
|
@@ -365,11 +375,11 @@ export interface DescribeIntegrationRolesRequest {
|
|
|
365
375
|
*/
|
|
366
376
|
Agent?: Agent;
|
|
367
377
|
/**
|
|
368
|
-
|
|
378
|
+
* 查询的关键字段:
|
|
369
379
|
Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
|
|
370
380
|
Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
|
|
371
381
|
Key:"IsGroupRole",Values:["0"],查询非集团角色,Values:["1"]表示查询集团角色
|
|
372
|
-
|
|
382
|
+
*/
|
|
373
383
|
Filters?: Array<Filter>;
|
|
374
384
|
/**
|
|
375
385
|
* 偏移量,默认为0,最大为2000
|
|
@@ -407,14 +417,14 @@ export interface StartFlowResponse {
|
|
|
407
417
|
*/
|
|
408
418
|
export interface StaffRole {
|
|
409
419
|
/**
|
|
410
|
-
|
|
420
|
+
* 角色id
|
|
411
421
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
412
|
-
|
|
422
|
+
*/
|
|
413
423
|
RoleId: string;
|
|
414
424
|
/**
|
|
415
|
-
|
|
425
|
+
* 角色名称
|
|
416
426
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
417
|
-
|
|
427
|
+
*/
|
|
418
428
|
RoleName: string;
|
|
419
429
|
}
|
|
420
430
|
/**
|
|
@@ -422,29 +432,29 @@ export interface StaffRole {
|
|
|
422
432
|
*/
|
|
423
433
|
export interface FlowApproverUrlInfo {
|
|
424
434
|
/**
|
|
425
|
-
|
|
435
|
+
* 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
|
|
426
436
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
427
|
-
|
|
437
|
+
*/
|
|
428
438
|
SignUrl?: string;
|
|
429
439
|
/**
|
|
430
|
-
|
|
440
|
+
* 签署人类型 1-个人
|
|
431
441
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
432
|
-
|
|
442
|
+
*/
|
|
433
443
|
ApproverType?: number;
|
|
434
444
|
/**
|
|
435
|
-
|
|
445
|
+
* 签署人姓名
|
|
436
446
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
437
|
-
|
|
447
|
+
*/
|
|
438
448
|
ApproverName?: string;
|
|
439
449
|
/**
|
|
440
|
-
|
|
450
|
+
* 签署人手机号
|
|
441
451
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
442
|
-
|
|
452
|
+
*/
|
|
443
453
|
ApproverMobile?: string;
|
|
444
454
|
/**
|
|
445
|
-
|
|
455
|
+
* 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
|
|
446
456
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
447
|
-
|
|
457
|
+
*/
|
|
448
458
|
LongUrl?: string;
|
|
449
459
|
}
|
|
450
460
|
/**
|
|
@@ -461,7 +471,7 @@ export interface AuthorizedUser {
|
|
|
461
471
|
*/
|
|
462
472
|
export interface CreateConvertTaskApiRequest {
|
|
463
473
|
/**
|
|
464
|
-
* 资源类型
|
|
474
|
+
* 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
|
|
465
475
|
*/
|
|
466
476
|
ResourceType: string;
|
|
467
477
|
/**
|
|
@@ -478,10 +488,12 @@ export interface CreateConvertTaskApiRequest {
|
|
|
478
488
|
Operator?: UserInfo;
|
|
479
489
|
/**
|
|
480
490
|
* 应用号信息
|
|
491
|
+
* @deprecated
|
|
481
492
|
*/
|
|
482
493
|
Agent?: Agent;
|
|
483
494
|
/**
|
|
484
495
|
* 暂未开放
|
|
496
|
+
* @deprecated
|
|
485
497
|
*/
|
|
486
498
|
Organization?: OrganizationInfo;
|
|
487
499
|
}
|
|
@@ -537,10 +549,12 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
|
|
|
537
549
|
export interface Agent {
|
|
538
550
|
/**
|
|
539
551
|
* 代理机构的应用编号,32位字符串,一般不用传
|
|
552
|
+
* @deprecated
|
|
540
553
|
*/
|
|
541
554
|
AppId?: string;
|
|
542
555
|
/**
|
|
543
556
|
* 被代理机构的应用号,一般不用传
|
|
557
|
+
* @deprecated
|
|
544
558
|
*/
|
|
545
559
|
ProxyAppId?: string;
|
|
546
560
|
/**
|
|
@@ -549,6 +563,7 @@ export interface Agent {
|
|
|
549
563
|
ProxyOrganizationId?: string;
|
|
550
564
|
/**
|
|
551
565
|
* 被代理机构的经办人,一般不用传
|
|
566
|
+
* @deprecated
|
|
552
567
|
*/
|
|
553
568
|
ProxyOperator?: string;
|
|
554
569
|
}
|
|
@@ -557,16 +572,16 @@ export interface Agent {
|
|
|
557
572
|
*/
|
|
558
573
|
export interface FlowApproverDetail {
|
|
559
574
|
/**
|
|
560
|
-
|
|
575
|
+
* 签署时的相关信息
|
|
561
576
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
562
|
-
|
|
577
|
+
*/
|
|
563
578
|
ApproveMessage?: string;
|
|
564
579
|
/**
|
|
565
580
|
* 签署方姓名
|
|
566
581
|
*/
|
|
567
582
|
ApproveName: string;
|
|
568
583
|
/**
|
|
569
|
-
|
|
584
|
+
* 签署方的签署状态
|
|
570
585
|
0:还没有发起
|
|
571
586
|
1:流程中 没有开始处理
|
|
572
587
|
2:待签署
|
|
@@ -580,16 +595,16 @@ export interface FlowApproverDetail {
|
|
|
580
595
|
10:填写完成
|
|
581
596
|
15:已解除
|
|
582
597
|
19:转他人处理
|
|
583
|
-
|
|
598
|
+
*/
|
|
584
599
|
ApproveStatus: number;
|
|
585
600
|
/**
|
|
586
601
|
* 模板配置中的参与方ID,与控件绑定
|
|
587
602
|
*/
|
|
588
603
|
ReceiptId: string;
|
|
589
604
|
/**
|
|
590
|
-
|
|
605
|
+
* 客户自定义的用户ID
|
|
591
606
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
592
|
-
|
|
607
|
+
*/
|
|
593
608
|
CustomUserId: string;
|
|
594
609
|
/**
|
|
595
610
|
* 签署人手机号
|
|
@@ -604,29 +619,29 @@ export interface FlowApproverDetail {
|
|
|
604
619
|
*/
|
|
605
620
|
ApproveTime: number;
|
|
606
621
|
/**
|
|
607
|
-
|
|
622
|
+
* 签署方类型,ORGANIZATION-企业员工,PERSON-个人,ENTERPRISESERVER-企业静默签
|
|
608
623
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
609
|
-
|
|
624
|
+
*/
|
|
610
625
|
ApproveType: string;
|
|
611
626
|
/**
|
|
612
|
-
|
|
627
|
+
* 签署方侧用户来源,如WEWORKAPP-企业微信等
|
|
613
628
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
614
|
-
|
|
629
|
+
*/
|
|
615
630
|
ApproverSource: string;
|
|
616
631
|
/**
|
|
617
|
-
|
|
632
|
+
* 客户自定义签署方标识
|
|
618
633
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
619
|
-
|
|
634
|
+
*/
|
|
620
635
|
CustomApproverTag: string;
|
|
621
636
|
/**
|
|
622
|
-
|
|
637
|
+
* 签署方企业Id
|
|
623
638
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
624
|
-
|
|
639
|
+
*/
|
|
625
640
|
OrganizationId: string;
|
|
626
641
|
/**
|
|
627
|
-
|
|
642
|
+
* 签署方企业名称
|
|
628
643
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
629
|
-
|
|
644
|
+
*/
|
|
630
645
|
OrganizationName: string;
|
|
631
646
|
}
|
|
632
647
|
/**
|
|
@@ -658,23 +673,25 @@ export interface DescribeFlowTemplatesRequest {
|
|
|
658
673
|
*/
|
|
659
674
|
Limit?: number;
|
|
660
675
|
/**
|
|
661
|
-
|
|
676
|
+
* 这个参数跟下面的IsChannel参数配合使用。
|
|
662
677
|
IsChannel=false时,ApplicationId参数不起任何作用。
|
|
663
678
|
IsChannel=true时,ApplicationId为空,查询所有第三方应用集成平台企业模板列表;ApplicationId不为空,查询指定应用下的模板列表
|
|
664
679
|
ApplicationId为空,查询所有应用下的模板列表
|
|
665
|
-
|
|
680
|
+
*/
|
|
666
681
|
ApplicationId?: string;
|
|
667
682
|
/**
|
|
668
|
-
|
|
683
|
+
* 默认为false,查询SaaS模板库列表;
|
|
669
684
|
为true,查询第三方应用集成平台企业模板库管理列表
|
|
670
|
-
|
|
685
|
+
*/
|
|
671
686
|
IsChannel?: boolean;
|
|
672
687
|
/**
|
|
673
688
|
* 暂未开放
|
|
689
|
+
* @deprecated
|
|
674
690
|
*/
|
|
675
691
|
Organization?: OrganizationInfo;
|
|
676
692
|
/**
|
|
677
693
|
* 暂未开放
|
|
694
|
+
* @deprecated
|
|
678
695
|
*/
|
|
679
696
|
GenerateSource?: number;
|
|
680
697
|
}
|
|
@@ -683,15 +700,15 @@ export interface DescribeFlowTemplatesRequest {
|
|
|
683
700
|
*/
|
|
684
701
|
export interface DescribeFlowEvidenceReportResponse {
|
|
685
702
|
/**
|
|
686
|
-
|
|
703
|
+
* 报告 URL
|
|
687
704
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
688
|
-
|
|
705
|
+
*/
|
|
689
706
|
ReportUrl: string;
|
|
690
707
|
/**
|
|
691
|
-
|
|
708
|
+
* 执行中:EvidenceStatusExecuting
|
|
692
709
|
成功:EvidenceStatusSuccess
|
|
693
710
|
失败:EvidenceStatusFailed
|
|
694
|
-
|
|
711
|
+
*/
|
|
695
712
|
Status: string;
|
|
696
713
|
/**
|
|
697
714
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -708,6 +725,7 @@ export interface CallbackInfo {
|
|
|
708
725
|
CallbackUrl: string;
|
|
709
726
|
/**
|
|
710
727
|
* 回调加密key,已废弃
|
|
728
|
+
* @deprecated
|
|
711
729
|
*/
|
|
712
730
|
Token?: string;
|
|
713
731
|
/**
|
|
@@ -780,11 +798,11 @@ export interface TemplateInfo {
|
|
|
780
798
|
*/
|
|
781
799
|
Promoter?: Recipient;
|
|
782
800
|
/**
|
|
783
|
-
|
|
801
|
+
* 模板类型
|
|
784
802
|
取值:
|
|
785
803
|
1 静默签,
|
|
786
804
|
3 普通模板
|
|
787
|
-
|
|
805
|
+
*/
|
|
788
806
|
TemplateType?: number;
|
|
789
807
|
/**
|
|
790
808
|
* 模板可用状态,取值:1启用(默认),2停用
|
|
@@ -795,19 +813,19 @@ export interface TemplateInfo {
|
|
|
795
813
|
*/
|
|
796
814
|
OrganizationId?: string;
|
|
797
815
|
/**
|
|
798
|
-
|
|
816
|
+
* 模板预览链接,有效时间5分钟
|
|
799
817
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
800
|
-
|
|
818
|
+
*/
|
|
801
819
|
PreviewUrl?: string;
|
|
802
820
|
/**
|
|
803
|
-
|
|
821
|
+
* 模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。
|
|
804
822
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
805
|
-
|
|
823
|
+
*/
|
|
806
824
|
TemplateVersion?: string;
|
|
807
825
|
/**
|
|
808
|
-
|
|
826
|
+
* 模板是否已发布。true-已发布;false-未发布
|
|
809
827
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
810
|
-
|
|
828
|
+
*/
|
|
811
829
|
Published?: boolean;
|
|
812
830
|
}
|
|
813
831
|
/**
|
|
@@ -819,9 +837,9 @@ export interface CreateDocumentResponse {
|
|
|
819
837
|
*/
|
|
820
838
|
DocumentId?: string;
|
|
821
839
|
/**
|
|
822
|
-
|
|
840
|
+
* 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
|
|
823
841
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
824
|
-
|
|
842
|
+
*/
|
|
825
843
|
PreviewFileUrl?: string;
|
|
826
844
|
/**
|
|
827
845
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -845,9 +863,9 @@ export interface DescribeIntegrationEmployeesRequest {
|
|
|
845
863
|
*/
|
|
846
864
|
Agent?: Agent;
|
|
847
865
|
/**
|
|
848
|
-
|
|
866
|
+
* 查询过滤实名用户,Key为Status,Values为["IsVerified"]
|
|
849
867
|
根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
|
|
850
|
-
|
|
868
|
+
*/
|
|
851
869
|
Filters?: Array<Filter>;
|
|
852
870
|
/**
|
|
853
871
|
* 偏移量,默认为0,最大为20000
|
|
@@ -893,12 +911,13 @@ export interface CreateFlowRequest {
|
|
|
893
911
|
ClientToken?: string;
|
|
894
912
|
/**
|
|
895
913
|
* 暂未开放
|
|
914
|
+
* @deprecated
|
|
896
915
|
*/
|
|
897
916
|
RelatedFlowId?: string;
|
|
898
917
|
/**
|
|
899
|
-
|
|
918
|
+
* 签署流程的签署截止时间。
|
|
900
919
|
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
901
|
-
|
|
920
|
+
*/
|
|
902
921
|
DeadLine?: number;
|
|
903
922
|
/**
|
|
904
923
|
* 用户自定义字段,回调的时候会进行透传,长度需要小于20480
|
|
@@ -909,25 +928,26 @@ export interface CreateFlowRequest {
|
|
|
909
928
|
*/
|
|
910
929
|
FlowDescription?: string;
|
|
911
930
|
/**
|
|
912
|
-
|
|
931
|
+
* 发送类型:
|
|
913
932
|
true:无序签
|
|
914
933
|
false:有序签
|
|
915
934
|
注:默认为false(有序签),请和模板中的配置保持一致
|
|
916
|
-
|
|
935
|
+
*/
|
|
917
936
|
Unordered?: boolean;
|
|
918
937
|
/**
|
|
919
938
|
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
920
939
|
*/
|
|
921
940
|
CustomShowMap?: string;
|
|
922
941
|
/**
|
|
923
|
-
|
|
942
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
924
943
|
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
925
944
|
|
|
926
945
|
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
927
|
-
|
|
946
|
+
*/
|
|
928
947
|
NeedSignReview?: boolean;
|
|
929
948
|
/**
|
|
930
949
|
* 暂未开放
|
|
950
|
+
* @deprecated
|
|
931
951
|
*/
|
|
932
952
|
CallbackUrl?: string;
|
|
933
953
|
/**
|
|
@@ -935,9 +955,9 @@ export interface CreateFlowRequest {
|
|
|
935
955
|
*/
|
|
936
956
|
Agent?: Agent;
|
|
937
957
|
/**
|
|
938
|
-
|
|
958
|
+
* 被抄送人的信息列表。
|
|
939
959
|
注: 此功能为白名单功能,若有需要,请联系电子签客服开白使用。
|
|
940
|
-
|
|
960
|
+
*/
|
|
941
961
|
CcInfos?: Array<CcInfo>;
|
|
942
962
|
/**
|
|
943
963
|
* 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
@@ -965,11 +985,11 @@ export interface CreateSchemeUrlRequest {
|
|
|
965
985
|
*/
|
|
966
986
|
Mobile?: string;
|
|
967
987
|
/**
|
|
968
|
-
|
|
988
|
+
* 链接类型
|
|
969
989
|
HTTP:跳转电子签小程序的http_url,
|
|
970
990
|
APP:第三方APP或小程序跳转电子签小程序的path。
|
|
971
991
|
默认为HTTP类型
|
|
972
|
-
|
|
992
|
+
*/
|
|
973
993
|
EndPoint?: string;
|
|
974
994
|
/**
|
|
975
995
|
* 签署流程编号 (PathType=1时必传)
|
|
@@ -1053,9 +1073,9 @@ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
|
|
|
1053
1073
|
*/
|
|
1054
1074
|
export interface CreateReleaseFlowResponse {
|
|
1055
1075
|
/**
|
|
1056
|
-
|
|
1076
|
+
* 解除协议流程编号
|
|
1057
1077
|
|
|
1058
|
-
|
|
1078
|
+
*/
|
|
1059
1079
|
FlowId?: string;
|
|
1060
1080
|
/**
|
|
1061
1081
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1128,22 +1148,27 @@ export interface DeleteSealPoliciesResponse {
|
|
|
1128
1148
|
export interface OrganizationInfo {
|
|
1129
1149
|
/**
|
|
1130
1150
|
* 机构在平台的编号,内部字段,暂未开放
|
|
1151
|
+
* @deprecated
|
|
1131
1152
|
*/
|
|
1132
1153
|
OrganizationId?: string;
|
|
1133
1154
|
/**
|
|
1134
1155
|
* 用户渠道,内部字段,暂未开放
|
|
1156
|
+
* @deprecated
|
|
1135
1157
|
*/
|
|
1136
1158
|
Channel?: string;
|
|
1137
1159
|
/**
|
|
1138
1160
|
* 用户在渠道的机构编号,内部字段,暂未开放
|
|
1161
|
+
* @deprecated
|
|
1139
1162
|
*/
|
|
1140
1163
|
OrganizationOpenId?: string;
|
|
1141
1164
|
/**
|
|
1142
1165
|
* 用户真实的IP,内部字段,暂未开放
|
|
1166
|
+
* @deprecated
|
|
1143
1167
|
*/
|
|
1144
1168
|
ClientIp?: string;
|
|
1145
1169
|
/**
|
|
1146
1170
|
* 机构的代理IP,内部字段,暂未开放
|
|
1171
|
+
* @deprecated
|
|
1147
1172
|
*/
|
|
1148
1173
|
ProxyIp?: string;
|
|
1149
1174
|
}
|
|
@@ -1177,14 +1202,14 @@ export interface FillApproverInfo {
|
|
|
1177
1202
|
*/
|
|
1178
1203
|
RecipientId: string;
|
|
1179
1204
|
/**
|
|
1180
|
-
|
|
1205
|
+
* 签署人来源
|
|
1181
1206
|
WEWORKAPP: 企业微信
|
|
1182
|
-
|
|
1207
|
+
*/
|
|
1183
1208
|
ApproverSource: string;
|
|
1184
1209
|
/**
|
|
1185
|
-
|
|
1210
|
+
* 企业自定义账号ID
|
|
1186
1211
|
WEWORKAPP场景下指企业自有应用获取企微明文的userid
|
|
1187
|
-
|
|
1212
|
+
*/
|
|
1188
1213
|
CustomUserId: string;
|
|
1189
1214
|
}
|
|
1190
1215
|
/**
|
|
@@ -1216,9 +1241,9 @@ export interface OccupiedSeal {
|
|
|
1216
1241
|
*/
|
|
1217
1242
|
SealStatus: string;
|
|
1218
1243
|
/**
|
|
1219
|
-
|
|
1244
|
+
* 审核失败原因
|
|
1220
1245
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1221
|
-
|
|
1246
|
+
*/
|
|
1222
1247
|
FailReason: string;
|
|
1223
1248
|
/**
|
|
1224
1249
|
* 印章图片url,5分钟内有效
|
|
@@ -1233,9 +1258,9 @@ export interface OccupiedSeal {
|
|
|
1233
1258
|
*/
|
|
1234
1259
|
IsAllTime: boolean;
|
|
1235
1260
|
/**
|
|
1236
|
-
|
|
1261
|
+
* 授权人列表
|
|
1237
1262
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1238
|
-
|
|
1263
|
+
*/
|
|
1239
1264
|
AuthorizedUsers: Array<AuthorizedUser>;
|
|
1240
1265
|
}
|
|
1241
1266
|
/**
|
|
@@ -1243,14 +1268,14 @@ export interface OccupiedSeal {
|
|
|
1243
1268
|
*/
|
|
1244
1269
|
export interface FailedDeleteStaffData {
|
|
1245
1270
|
/**
|
|
1246
|
-
|
|
1271
|
+
* 员工在电子签的userId
|
|
1247
1272
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1248
|
-
|
|
1273
|
+
*/
|
|
1249
1274
|
UserId: string;
|
|
1250
1275
|
/**
|
|
1251
|
-
|
|
1276
|
+
* 员工在第三方平台的openId
|
|
1252
1277
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1253
|
-
|
|
1278
|
+
*/
|
|
1254
1279
|
OpenId: string;
|
|
1255
1280
|
/**
|
|
1256
1281
|
* 失败原因
|
|
@@ -1344,11 +1369,11 @@ export interface UserThreeFactor {
|
|
|
1344
1369
|
*/
|
|
1345
1370
|
Name: string;
|
|
1346
1371
|
/**
|
|
1347
|
-
|
|
1372
|
+
* 证件类型:
|
|
1348
1373
|
ID_CARD 身份证
|
|
1349
1374
|
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
1350
1375
|
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
1351
|
-
|
|
1376
|
+
*/
|
|
1352
1377
|
IdCardType: string;
|
|
1353
1378
|
/**
|
|
1354
1379
|
* 证件号,如果有 X 请大写
|
|
@@ -1394,9 +1419,9 @@ export interface DisableUserAutoSignRequest {
|
|
|
1394
1419
|
*/
|
|
1395
1420
|
Operator: UserInfo;
|
|
1396
1421
|
/**
|
|
1397
|
-
|
|
1422
|
+
* 自动签场景:
|
|
1398
1423
|
E_PRESCRIPTION_AUTO_SIGN 电子处方
|
|
1399
|
-
|
|
1424
|
+
*/
|
|
1400
1425
|
SceneKey: string;
|
|
1401
1426
|
/**
|
|
1402
1427
|
* 关闭自动签的个人的三要素
|
|
@@ -1408,14 +1433,14 @@ export interface DisableUserAutoSignRequest {
|
|
|
1408
1433
|
*/
|
|
1409
1434
|
export interface DescribeIntegrationEmployeesResponse {
|
|
1410
1435
|
/**
|
|
1411
|
-
|
|
1436
|
+
* 员工数据列表
|
|
1412
1437
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1413
|
-
|
|
1438
|
+
*/
|
|
1414
1439
|
Employees?: Array<Staff>;
|
|
1415
1440
|
/**
|
|
1416
|
-
|
|
1441
|
+
* 偏移量,默认为0,最大为20000
|
|
1417
1442
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1418
|
-
|
|
1443
|
+
*/
|
|
1419
1444
|
Offset?: number;
|
|
1420
1445
|
/**
|
|
1421
1446
|
* 返回最大数量,最大为20
|
|
@@ -1473,15 +1498,15 @@ export interface CreateFlowSignReviewRequest {
|
|
|
1473
1498
|
*/
|
|
1474
1499
|
FlowId: string;
|
|
1475
1500
|
/**
|
|
1476
|
-
|
|
1501
|
+
* 企业内部审核结果
|
|
1477
1502
|
PASS: 通过
|
|
1478
1503
|
REJECT: 拒绝
|
|
1479
|
-
|
|
1504
|
+
*/
|
|
1480
1505
|
ReviewType: string;
|
|
1481
1506
|
/**
|
|
1482
|
-
|
|
1507
|
+
* 审核原因
|
|
1483
1508
|
当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
|
|
1484
|
-
|
|
1509
|
+
*/
|
|
1485
1510
|
ReviewMessage?: string;
|
|
1486
1511
|
/**
|
|
1487
1512
|
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
|
@@ -1573,17 +1598,17 @@ export interface DescribeFileUrlsRequest {
|
|
|
1573
1598
|
*/
|
|
1574
1599
|
Operator: UserInfo;
|
|
1575
1600
|
/**
|
|
1576
|
-
|
|
1601
|
+
* 文件对应的业务类型,目前支持:
|
|
1577
1602
|
- 流程 "FLOW",如需下载合同文件请选择此项
|
|
1578
1603
|
- 模板 "TEMPLATE"
|
|
1579
1604
|
- 文档 "DOCUMENT"
|
|
1580
1605
|
- 印章 “SEAL”
|
|
1581
|
-
|
|
1606
|
+
*/
|
|
1582
1607
|
BusinessType: string;
|
|
1583
1608
|
/**
|
|
1584
|
-
|
|
1609
|
+
* 业务编号的数组,如流程编号、模板编号、文档编号、印章编号。如需下载合同文件请传入FlowId
|
|
1585
1610
|
最大支持20个资源
|
|
1586
|
-
|
|
1611
|
+
*/
|
|
1587
1612
|
BusinessIds: Array<string>;
|
|
1588
1613
|
/**
|
|
1589
1614
|
* 下载后的文件命名,只有FileType为zip的时候生效
|
|
@@ -1607,14 +1632,17 @@ export interface DescribeFileUrlsRequest {
|
|
|
1607
1632
|
UrlTtl?: number;
|
|
1608
1633
|
/**
|
|
1609
1634
|
* 暂不开放
|
|
1635
|
+
* @deprecated
|
|
1610
1636
|
*/
|
|
1611
1637
|
CcToken?: string;
|
|
1612
1638
|
/**
|
|
1613
1639
|
* 暂不开放
|
|
1640
|
+
* @deprecated
|
|
1614
1641
|
*/
|
|
1615
1642
|
Scene?: string;
|
|
1616
1643
|
/**
|
|
1617
1644
|
* 应用相关信息
|
|
1645
|
+
* @deprecated
|
|
1618
1646
|
*/
|
|
1619
1647
|
Agent?: Agent;
|
|
1620
1648
|
}
|
|
@@ -1733,14 +1761,14 @@ content String 表头单元格内容,字数不超过100
|
|
|
1733
1761
|
*/
|
|
1734
1762
|
export interface FormField {
|
|
1735
1763
|
/**
|
|
1736
|
-
|
|
1764
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
1737
1765
|
TEXT - 文本内容
|
|
1738
1766
|
MULTI_LINE_TEXT - 文本内容
|
|
1739
1767
|
CHECK_BOX - true/false
|
|
1740
1768
|
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
1741
1769
|
SELECTOR - 选项值
|
|
1742
1770
|
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
1743
|
-
|
|
1771
|
+
*/
|
|
1744
1772
|
ComponentValue: string;
|
|
1745
1773
|
/**
|
|
1746
1774
|
* 控件id,和ComponentName选择一项传入即可
|
|
@@ -1774,18 +1802,22 @@ export interface UserInfo {
|
|
|
1774
1802
|
UserId?: string;
|
|
1775
1803
|
/**
|
|
1776
1804
|
* 用户的来源渠道,一般不用传,特定场景根据接口说明传值
|
|
1805
|
+
* @deprecated
|
|
1777
1806
|
*/
|
|
1778
1807
|
Channel?: string;
|
|
1779
1808
|
/**
|
|
1780
1809
|
* 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
|
|
1810
|
+
* @deprecated
|
|
1781
1811
|
*/
|
|
1782
1812
|
OpenId?: string;
|
|
1783
1813
|
/**
|
|
1784
1814
|
* 用户真实IP,内部字段,暂未开放
|
|
1815
|
+
* @deprecated
|
|
1785
1816
|
*/
|
|
1786
1817
|
ClientIp?: string;
|
|
1787
1818
|
/**
|
|
1788
1819
|
* 用户代理IP,内部字段,暂未开放
|
|
1820
|
+
* @deprecated
|
|
1789
1821
|
*/
|
|
1790
1822
|
ProxyIp?: string;
|
|
1791
1823
|
}
|
|
@@ -1827,24 +1859,24 @@ export interface Staff {
|
|
|
1827
1859
|
*/
|
|
1828
1860
|
Mobile?: string;
|
|
1829
1861
|
/**
|
|
1830
|
-
|
|
1862
|
+
* 用户邮箱
|
|
1831
1863
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1832
|
-
|
|
1864
|
+
*/
|
|
1833
1865
|
Email?: string;
|
|
1834
1866
|
/**
|
|
1835
|
-
|
|
1867
|
+
* 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
|
|
1836
1868
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1837
|
-
|
|
1869
|
+
*/
|
|
1838
1870
|
OpenId?: string;
|
|
1839
1871
|
/**
|
|
1840
|
-
|
|
1872
|
+
* 员工角色
|
|
1841
1873
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1842
|
-
|
|
1874
|
+
*/
|
|
1843
1875
|
Roles?: Array<StaffRole>;
|
|
1844
1876
|
/**
|
|
1845
|
-
|
|
1877
|
+
* 员工部门
|
|
1846
1878
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1847
|
-
|
|
1879
|
+
*/
|
|
1848
1880
|
Department?: Department;
|
|
1849
1881
|
/**
|
|
1850
1882
|
* 员工是否实名
|
|
@@ -1855,14 +1887,14 @@ export interface Staff {
|
|
|
1855
1887
|
*/
|
|
1856
1888
|
CreatedOn?: number;
|
|
1857
1889
|
/**
|
|
1858
|
-
|
|
1890
|
+
* 员工实名时间戳,单位秒
|
|
1859
1891
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1860
|
-
|
|
1892
|
+
*/
|
|
1861
1893
|
VerifiedOn?: number;
|
|
1862
1894
|
/**
|
|
1863
|
-
|
|
1895
|
+
* 员工是否离职:0-未离职,1-离职
|
|
1864
1896
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1865
|
-
|
|
1897
|
+
*/
|
|
1866
1898
|
QuiteJob?: number;
|
|
1867
1899
|
/**
|
|
1868
1900
|
* 员工离职交接人用户id
|
|
@@ -1878,20 +1910,20 @@ export interface Staff {
|
|
|
1878
1910
|
*/
|
|
1879
1911
|
export interface CreateFlowEvidenceReportResponse {
|
|
1880
1912
|
/**
|
|
1881
|
-
|
|
1913
|
+
* 出证报告 ID,用于查询出证报告DescribeFlowEvidenceReport接口时用到
|
|
1882
1914
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1883
|
-
|
|
1915
|
+
*/
|
|
1884
1916
|
ReportId?: string;
|
|
1885
1917
|
/**
|
|
1886
|
-
|
|
1918
|
+
* 执行中:EvidenceStatusExecuting
|
|
1887
1919
|
成功:EvidenceStatusSuccess
|
|
1888
1920
|
失败:EvidenceStatusFailed
|
|
1889
|
-
|
|
1921
|
+
*/
|
|
1890
1922
|
Status?: string;
|
|
1891
1923
|
/**
|
|
1892
|
-
|
|
1924
|
+
* 废除,字段无效
|
|
1893
1925
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1894
|
-
|
|
1926
|
+
*/
|
|
1895
1927
|
ReportUrl?: string;
|
|
1896
1928
|
/**
|
|
1897
1929
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1903,9 +1935,9 @@ export interface CreateFlowEvidenceReportResponse {
|
|
|
1903
1935
|
*/
|
|
1904
1936
|
export interface DescribeFileUrlsResponse {
|
|
1905
1937
|
/**
|
|
1906
|
-
|
|
1938
|
+
* 文件URL信息;
|
|
1907
1939
|
链接不是永久链接,有效期5分钟后链接失效。
|
|
1908
|
-
|
|
1940
|
+
*/
|
|
1909
1941
|
FileUrls?: Array<FileUrl>;
|
|
1910
1942
|
/**
|
|
1911
1943
|
* URL数量
|
|
@@ -1950,64 +1982,64 @@ export interface CreateIntegrationDepartmentRequest {
|
|
|
1950
1982
|
*/
|
|
1951
1983
|
export interface GroupOrganization {
|
|
1952
1984
|
/**
|
|
1953
|
-
|
|
1985
|
+
* 成员企业名
|
|
1954
1986
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1955
|
-
|
|
1987
|
+
*/
|
|
1956
1988
|
Name?: string;
|
|
1957
1989
|
/**
|
|
1958
|
-
|
|
1990
|
+
* 成员企业别名
|
|
1959
1991
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1960
|
-
|
|
1992
|
+
*/
|
|
1961
1993
|
Alias?: string;
|
|
1962
1994
|
/**
|
|
1963
|
-
|
|
1995
|
+
* 成员企业id
|
|
1964
1996
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1965
|
-
|
|
1997
|
+
*/
|
|
1966
1998
|
OrganizationId?: string;
|
|
1967
1999
|
/**
|
|
1968
|
-
|
|
2000
|
+
* 更新时间,时间戳,单位秒
|
|
1969
2001
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1970
|
-
|
|
2002
|
+
*/
|
|
1971
2003
|
UpdateTime?: number;
|
|
1972
2004
|
/**
|
|
1973
|
-
|
|
2005
|
+
* 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
|
|
1974
2006
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1975
|
-
|
|
2007
|
+
*/
|
|
1976
2008
|
Status?: number;
|
|
1977
2009
|
/**
|
|
1978
|
-
|
|
2010
|
+
* 是否为集团主企业
|
|
1979
2011
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1980
|
-
|
|
2012
|
+
*/
|
|
1981
2013
|
IsMainOrganization?: boolean;
|
|
1982
2014
|
/**
|
|
1983
|
-
|
|
2015
|
+
* 企业社会信用代码
|
|
1984
2016
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1985
|
-
|
|
2017
|
+
*/
|
|
1986
2018
|
IdCardNumber?: string;
|
|
1987
2019
|
/**
|
|
1988
|
-
|
|
2020
|
+
* 企业超管信息
|
|
1989
2021
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1990
|
-
|
|
2022
|
+
*/
|
|
1991
2023
|
AdminInfo?: Admin;
|
|
1992
2024
|
/**
|
|
1993
|
-
|
|
2025
|
+
* 企业许可证
|
|
1994
2026
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1995
|
-
|
|
2027
|
+
*/
|
|
1996
2028
|
License?: string;
|
|
1997
2029
|
/**
|
|
1998
|
-
|
|
2030
|
+
* 企业许可证过期时间,时间戳,单位秒
|
|
1999
2031
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2000
|
-
|
|
2032
|
+
*/
|
|
2001
2033
|
LicenseExpireTime?: number;
|
|
2002
2034
|
/**
|
|
2003
|
-
|
|
2035
|
+
* 成员企业加入集团时间,时间戳,单位秒
|
|
2004
2036
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2005
|
-
|
|
2037
|
+
*/
|
|
2006
2038
|
JoinTime?: number;
|
|
2007
2039
|
/**
|
|
2008
|
-
|
|
2040
|
+
* 是否使用审批流引擎,true-是,false-否
|
|
2009
2041
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2010
|
-
|
|
2042
|
+
*/
|
|
2011
2043
|
FlowEngineEnable?: boolean;
|
|
2012
2044
|
}
|
|
2013
2045
|
/**
|
|
@@ -2048,9 +2080,9 @@ export interface CreateDocumentRequest {
|
|
|
2048
2080
|
*/
|
|
2049
2081
|
FormFields?: Array<FormField>;
|
|
2050
2082
|
/**
|
|
2051
|
-
|
|
2083
|
+
* 是否需要生成预览文件 默认不生成;
|
|
2052
2084
|
预览链接有效期300秒;
|
|
2053
|
-
|
|
2085
|
+
*/
|
|
2054
2086
|
NeedPreview?: boolean;
|
|
2055
2087
|
/**
|
|
2056
2088
|
* 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
|
|
@@ -2078,12 +2110,12 @@ export interface FlowDetailInfo {
|
|
|
2078
2110
|
*/
|
|
2079
2111
|
FlowName: string;
|
|
2080
2112
|
/**
|
|
2081
|
-
|
|
2113
|
+
* 合同(流程)的类型
|
|
2082
2114
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2083
|
-
|
|
2115
|
+
*/
|
|
2084
2116
|
FlowType: string;
|
|
2085
2117
|
/**
|
|
2086
|
-
|
|
2118
|
+
* 流程状态
|
|
2087
2119
|
- 0 还没有发起
|
|
2088
2120
|
- 1 待签署
|
|
2089
2121
|
- 2 部分签署
|
|
@@ -2096,17 +2128,17 @@ export interface FlowDetailInfo {
|
|
|
2096
2128
|
- 9 部分填写
|
|
2097
2129
|
- 10 拒填
|
|
2098
2130
|
- 21 已解除
|
|
2099
|
-
|
|
2131
|
+
*/
|
|
2100
2132
|
FlowStatus: number;
|
|
2101
2133
|
/**
|
|
2102
|
-
|
|
2134
|
+
* 合同(流程)的信息
|
|
2103
2135
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2104
|
-
|
|
2136
|
+
*/
|
|
2105
2137
|
FlowMessage: string;
|
|
2106
2138
|
/**
|
|
2107
|
-
|
|
2139
|
+
* 流程的描述
|
|
2108
2140
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2109
|
-
|
|
2141
|
+
*/
|
|
2110
2142
|
FlowDescription: string;
|
|
2111
2143
|
/**
|
|
2112
2144
|
* 合同(流程)的创建时间戳,单位秒
|
|
@@ -2121,9 +2153,9 @@ export interface FlowDetailInfo {
|
|
|
2121
2153
|
*/
|
|
2122
2154
|
CcInfos?: Array<FlowApproverDetail>;
|
|
2123
2155
|
/**
|
|
2124
|
-
|
|
2156
|
+
* 合同发起人UserId
|
|
2125
2157
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2126
|
-
|
|
2158
|
+
*/
|
|
2127
2159
|
Creator?: string;
|
|
2128
2160
|
}
|
|
2129
2161
|
/**
|
|
@@ -2212,10 +2244,12 @@ export interface GetTaskResultApiRequest {
|
|
|
2212
2244
|
Operator?: UserInfo;
|
|
2213
2245
|
/**
|
|
2214
2246
|
* 应用号信息
|
|
2247
|
+
* @deprecated
|
|
2215
2248
|
*/
|
|
2216
2249
|
Agent?: Agent;
|
|
2217
2250
|
/**
|
|
2218
2251
|
* 暂未开放
|
|
2252
|
+
* @deprecated
|
|
2219
2253
|
*/
|
|
2220
2254
|
Organization?: OrganizationInfo;
|
|
2221
2255
|
}
|
|
@@ -2288,6 +2322,7 @@ export interface CreateFlowSignUrlRequest {
|
|
|
2288
2322
|
Agent?: Agent;
|
|
2289
2323
|
/**
|
|
2290
2324
|
* 机构信息,暂未开放
|
|
2325
|
+
* @deprecated
|
|
2291
2326
|
*/
|
|
2292
2327
|
Organization?: OrganizationInfo;
|
|
2293
2328
|
}
|
|
@@ -2308,10 +2343,10 @@ export interface CreateReleaseFlowRequest {
|
|
|
2308
2343
|
*/
|
|
2309
2344
|
ReliveInfo: RelieveInfo;
|
|
2310
2345
|
/**
|
|
2311
|
-
|
|
2346
|
+
* 非必须,解除协议的本企业签署人列表,
|
|
2312
2347
|
默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
|
|
2313
2348
|
解除协议的签署人数量不能多于原流程的签署人数量
|
|
2314
|
-
|
|
2349
|
+
*/
|
|
2315
2350
|
ReleasedApprovers?: Array<ReleasedApprover>;
|
|
2316
2351
|
}
|
|
2317
2352
|
/**
|
|
@@ -2374,17 +2409,17 @@ export interface SuccessUpdateStaffData {
|
|
|
2374
2409
|
*/
|
|
2375
2410
|
export interface CreateFlowByFilesResponse {
|
|
2376
2411
|
/**
|
|
2377
|
-
|
|
2412
|
+
* 签署流程编号。
|
|
2378
2413
|
|
|
2379
2414
|
注:如入参 是否需要预览 NeedPreview 设置为 true,不会正式发起合同,此处不会有值返回;如入参 是否需要预览 NeedPreview 设置为 false,此处会正常返回签署流程编号 FlowId。
|
|
2380
|
-
|
|
2415
|
+
*/
|
|
2381
2416
|
FlowId?: string;
|
|
2382
2417
|
/**
|
|
2383
|
-
|
|
2418
|
+
* 合同预览链接。
|
|
2384
2419
|
|
|
2385
2420
|
注:如入参 是否需要预览 NeedPreview 设置为 true,会开启“预览模式”,此处会返回预览链接;如入参 是否需要预览 NeedPreview 设置为 false,此处不会有值返回。
|
|
2386
2421
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2387
|
-
|
|
2422
|
+
*/
|
|
2388
2423
|
PreviewUrl?: string;
|
|
2389
2424
|
/**
|
|
2390
2425
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2425,9 +2460,9 @@ export interface SuccessCreateStaffData {
|
|
|
2425
2460
|
*/
|
|
2426
2461
|
UserId: string;
|
|
2427
2462
|
/**
|
|
2428
|
-
|
|
2463
|
+
* 提示,当创建已存在未实名用户时,改字段有值
|
|
2429
2464
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2430
|
-
|
|
2465
|
+
*/
|
|
2431
2466
|
Note?: string;
|
|
2432
2467
|
}
|
|
2433
2468
|
/**
|
|
@@ -2505,14 +2540,14 @@ export interface VerifyPdfRequest {
|
|
|
2505
2540
|
*/
|
|
2506
2541
|
export interface FailedCreateRoleData {
|
|
2507
2542
|
/**
|
|
2508
|
-
|
|
2543
|
+
* 用户userId
|
|
2509
2544
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2510
|
-
|
|
2545
|
+
*/
|
|
2511
2546
|
UserId?: string;
|
|
2512
2547
|
/**
|
|
2513
|
-
|
|
2548
|
+
* 角色id列表
|
|
2514
2549
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2515
|
-
|
|
2550
|
+
*/
|
|
2516
2551
|
RoleIds?: Array<string>;
|
|
2517
2552
|
}
|
|
2518
2553
|
/**
|
|
@@ -2520,12 +2555,12 @@ export interface FailedCreateRoleData {
|
|
|
2520
2555
|
*/
|
|
2521
2556
|
export interface ApproverInfo {
|
|
2522
2557
|
/**
|
|
2523
|
-
|
|
2558
|
+
* 参与者类型:
|
|
2524
2559
|
0:企业
|
|
2525
2560
|
1:个人
|
|
2526
2561
|
3:企业静默签署
|
|
2527
2562
|
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
|
|
2528
|
-
|
|
2563
|
+
*/
|
|
2529
2564
|
ApproverType: number;
|
|
2530
2565
|
/**
|
|
2531
2566
|
* 签署人的姓名
|
|
@@ -2548,11 +2583,11 @@ export interface ApproverInfo {
|
|
|
2548
2583
|
*/
|
|
2549
2584
|
ApproverIdCardNumber?: string;
|
|
2550
2585
|
/**
|
|
2551
|
-
|
|
2586
|
+
* 签署人的身份证件类型
|
|
2552
2587
|
ID_CARD 身份证
|
|
2553
2588
|
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2554
2589
|
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
2555
|
-
|
|
2590
|
+
*/
|
|
2556
2591
|
ApproverIdCardType?: string;
|
|
2557
2592
|
/**
|
|
2558
2593
|
* 签署通知类型:sms--短信,none--不通知
|
|
@@ -2587,16 +2622,16 @@ export interface ApproverInfo {
|
|
|
2587
2622
|
*/
|
|
2588
2623
|
ApproverOption?: ApproverOption;
|
|
2589
2624
|
/**
|
|
2590
|
-
|
|
2625
|
+
* 签署人查看合同时认证方式,
|
|
2591
2626
|
1-实名查看 2-短信验证码查看(企业签署方不支持该方式)
|
|
2592
2627
|
如果不传默认为1
|
|
2593
|
-
|
|
2628
|
+
*/
|
|
2594
2629
|
ApproverVerifyTypes?: Array<number>;
|
|
2595
2630
|
/**
|
|
2596
|
-
|
|
2631
|
+
* 签署人签署合同时的认证方式
|
|
2597
2632
|
1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
|
|
2598
2633
|
合同签署认证方式的优先级 verifyChannel>approverSignTypes
|
|
2599
|
-
|
|
2634
|
+
*/
|
|
2600
2635
|
ApproverSignTypes?: Array<number>;
|
|
2601
2636
|
}
|
|
2602
2637
|
/**
|
|
@@ -2655,14 +2690,14 @@ export interface Filter {
|
|
|
2655
2690
|
*/
|
|
2656
2691
|
export interface CreateStaffResult {
|
|
2657
2692
|
/**
|
|
2658
|
-
|
|
2693
|
+
* 创建员工的成功列表
|
|
2659
2694
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2660
|
-
|
|
2695
|
+
*/
|
|
2661
2696
|
SuccessEmployeeData: Array<SuccessCreateStaffData>;
|
|
2662
2697
|
/**
|
|
2663
|
-
|
|
2698
|
+
* 创建员工的失败列表
|
|
2664
2699
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2665
|
-
|
|
2700
|
+
*/
|
|
2666
2701
|
FailedEmployeeData: Array<FailedCreateStaffData>;
|
|
2667
2702
|
}
|
|
2668
2703
|
/**
|
|
@@ -2674,9 +2709,9 @@ export interface CreateUserAutoSignEnableUrlRequest {
|
|
|
2674
2709
|
*/
|
|
2675
2710
|
Operator: UserInfo;
|
|
2676
2711
|
/**
|
|
2677
|
-
|
|
2712
|
+
* 自动签场景:
|
|
2678
2713
|
E_PRESCRIPTION_AUTO_SIGN 电子处方
|
|
2679
|
-
|
|
2714
|
+
*/
|
|
2680
2715
|
SceneKey: string;
|
|
2681
2716
|
/**
|
|
2682
2717
|
* 自动签开通,签署相关配置
|
|
@@ -2704,9 +2739,9 @@ export interface CreateUserAutoSignEnableUrlRequest {
|
|
|
2704
2739
|
*/
|
|
2705
2740
|
export interface DescribeIntegrationMainOrganizationUserResponse {
|
|
2706
2741
|
/**
|
|
2707
|
-
|
|
2742
|
+
* 主企业员工账号信息
|
|
2708
2743
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2709
|
-
|
|
2744
|
+
*/
|
|
2710
2745
|
IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser;
|
|
2711
2746
|
/**
|
|
2712
2747
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2730,6 +2765,24 @@ export interface RemindFlowRecords {
|
|
|
2730
2765
|
*/
|
|
2731
2766
|
RemindMessage: string;
|
|
2732
2767
|
}
|
|
2768
|
+
/**
|
|
2769
|
+
* CancelUserAutoSignEnableUrl请求参数结构体
|
|
2770
|
+
*/
|
|
2771
|
+
export interface CancelUserAutoSignEnableUrlRequest {
|
|
2772
|
+
/**
|
|
2773
|
+
* 操作人信息,UseId必填
|
|
2774
|
+
*/
|
|
2775
|
+
Operator: UserInfo;
|
|
2776
|
+
/**
|
|
2777
|
+
* 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
|
|
2778
|
+
*/
|
|
2779
|
+
SceneKey: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
|
|
2782
|
+
|
|
2783
|
+
*/
|
|
2784
|
+
UserInfo: UserThreeFactor;
|
|
2785
|
+
}
|
|
2733
2786
|
/**
|
|
2734
2787
|
* 创建员工的失败数据
|
|
2735
2788
|
*/
|
|
@@ -2822,54 +2875,54 @@ export interface CreateFlowByFilesRequest {
|
|
|
2822
2875
|
*/
|
|
2823
2876
|
Components?: Array<Component>;
|
|
2824
2877
|
/**
|
|
2825
|
-
|
|
2878
|
+
* 被抄送人的信息列表。
|
|
2826
2879
|
注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
|
|
2827
|
-
|
|
2880
|
+
*/
|
|
2828
2881
|
CcInfos?: Array<CcInfo>;
|
|
2829
2882
|
/**
|
|
2830
|
-
|
|
2883
|
+
* 是否需要预览,true:预览模式,false:非预览(默认);
|
|
2831
2884
|
预览链接有效期300秒;
|
|
2832
2885
|
|
|
2833
2886
|
注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
|
|
2834
|
-
|
|
2887
|
+
*/
|
|
2835
2888
|
NeedPreview?: boolean;
|
|
2836
2889
|
/**
|
|
2837
2890
|
* 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
|
|
2838
2891
|
*/
|
|
2839
2892
|
PreviewType?: number;
|
|
2840
2893
|
/**
|
|
2841
|
-
|
|
2894
|
+
* 签署流程的签署截止时间。
|
|
2842
2895
|
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
2843
|
-
|
|
2896
|
+
*/
|
|
2844
2897
|
Deadline?: number;
|
|
2845
2898
|
/**
|
|
2846
|
-
|
|
2899
|
+
* 发送类型:
|
|
2847
2900
|
true:无序签
|
|
2848
2901
|
false:有序签
|
|
2849
2902
|
注:默认为false(有序签)
|
|
2850
|
-
|
|
2903
|
+
*/
|
|
2851
2904
|
Unordered?: boolean;
|
|
2852
2905
|
/**
|
|
2853
2906
|
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
2854
2907
|
*/
|
|
2855
2908
|
CustomShowMap?: string;
|
|
2856
2909
|
/**
|
|
2857
|
-
|
|
2910
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
2858
2911
|
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
2859
2912
|
|
|
2860
2913
|
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
2861
|
-
|
|
2914
|
+
*/
|
|
2862
2915
|
NeedSignReview?: boolean;
|
|
2863
2916
|
/**
|
|
2864
2917
|
* 用户自定义字段,回调的时候会进行透传,长度需要小于20480
|
|
2865
2918
|
*/
|
|
2866
2919
|
UserData?: string;
|
|
2867
2920
|
/**
|
|
2868
|
-
|
|
2921
|
+
* 签署人校验方式
|
|
2869
2922
|
VerifyCheck: 人脸识别(默认)
|
|
2870
2923
|
MobileCheck:手机号验证
|
|
2871
2924
|
参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
2872
|
-
|
|
2925
|
+
*/
|
|
2873
2926
|
ApproverVerifyType?: string;
|
|
2874
2927
|
/**
|
|
2875
2928
|
* 签署流程描述,最大长度1000个字符
|
|
@@ -2897,29 +2950,29 @@ export interface CreateFlowByFilesRequest {
|
|
|
2897
2950
|
*/
|
|
2898
2951
|
export interface IntegrateRole {
|
|
2899
2952
|
/**
|
|
2900
|
-
|
|
2953
|
+
* 角色id
|
|
2901
2954
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2902
|
-
|
|
2955
|
+
*/
|
|
2903
2956
|
RoleId?: string;
|
|
2904
2957
|
/**
|
|
2905
|
-
|
|
2958
|
+
* 角色名
|
|
2906
2959
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2907
|
-
|
|
2960
|
+
*/
|
|
2908
2961
|
RoleName?: string;
|
|
2909
2962
|
/**
|
|
2910
|
-
|
|
2963
|
+
* 角色状态,1-启用,2-禁用
|
|
2911
2964
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2912
|
-
|
|
2965
|
+
*/
|
|
2913
2966
|
RoleStatus?: number;
|
|
2914
2967
|
/**
|
|
2915
|
-
|
|
2968
|
+
* 是否是集团角色,true-是,false-否
|
|
2916
2969
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2917
|
-
|
|
2970
|
+
*/
|
|
2918
2971
|
IsGroupRole?: boolean;
|
|
2919
2972
|
/**
|
|
2920
|
-
|
|
2973
|
+
* 管辖的子企业列表
|
|
2921
2974
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2922
|
-
|
|
2975
|
+
*/
|
|
2923
2976
|
SubOrgIdList?: Array<string>;
|
|
2924
2977
|
}
|
|
2925
2978
|
/**
|
|
@@ -2944,24 +2997,24 @@ export interface GetTaskResultApiResponse {
|
|
|
2944
2997
|
*/
|
|
2945
2998
|
TaskId?: string;
|
|
2946
2999
|
/**
|
|
2947
|
-
|
|
3000
|
+
* 任务状态,需要关注的状态
|
|
2948
3001
|
0 :NeedTranform - 任务已提交
|
|
2949
3002
|
4 :Processing - 文档转换中
|
|
2950
3003
|
8 :TaskEnd - 任务处理完成
|
|
2951
3004
|
-2 :DownloadFailed - 下载失败
|
|
2952
3005
|
-6 :ProcessFailed - 转换失败
|
|
2953
3006
|
-13:ProcessTimeout - 转换文件超时
|
|
2954
|
-
|
|
3007
|
+
*/
|
|
2955
3008
|
TaskStatus?: number;
|
|
2956
3009
|
/**
|
|
2957
|
-
|
|
3010
|
+
* 状态描述,需要关注的状态
|
|
2958
3011
|
NeedTranform - 任务已提交
|
|
2959
3012
|
Processing - 文档转换中
|
|
2960
3013
|
TaskEnd - 任务处理完成
|
|
2961
3014
|
DownloadFailed - 下载失败
|
|
2962
3015
|
ProcessFailed - 转换失败
|
|
2963
3016
|
ProcessTimeout - 转换文件超时
|
|
2964
|
-
|
|
3017
|
+
*/
|
|
2965
3018
|
TaskMessage?: string;
|
|
2966
3019
|
/**
|
|
2967
3020
|
* 资源Id,也是FileId,用于文件发起使用
|
|
@@ -3028,19 +3081,19 @@ export interface ModifyApplicationCallbackInfoRequest {
|
|
|
3028
3081
|
*/
|
|
3029
3082
|
export interface IntegrationMainOrganizationUser {
|
|
3030
3083
|
/**
|
|
3031
|
-
|
|
3084
|
+
* 主企业id
|
|
3032
3085
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3033
|
-
|
|
3086
|
+
*/
|
|
3034
3087
|
MainOrganizationId?: string;
|
|
3035
3088
|
/**
|
|
3036
|
-
|
|
3089
|
+
* 主企业员工UserId
|
|
3037
3090
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3038
|
-
|
|
3091
|
+
*/
|
|
3039
3092
|
MainUserId?: string;
|
|
3040
3093
|
/**
|
|
3041
|
-
|
|
3094
|
+
* 主企业员工名
|
|
3042
3095
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3043
|
-
|
|
3096
|
+
*/
|
|
3044
3097
|
UserName?: string;
|
|
3045
3098
|
}
|
|
3046
3099
|
/**
|
|
@@ -3089,9 +3142,9 @@ export interface CreatePrepareFlowRequest {
|
|
|
3089
3142
|
*/
|
|
3090
3143
|
Unordered?: boolean;
|
|
3091
3144
|
/**
|
|
3092
|
-
|
|
3145
|
+
* 签署流程的签署截止时间。
|
|
3093
3146
|
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
3094
|
-
|
|
3147
|
+
*/
|
|
3095
3148
|
Deadline?: number;
|
|
3096
3149
|
/**
|
|
3097
3150
|
* 用户自定义合同类型
|
|
@@ -3128,9 +3181,9 @@ export interface FileUrl {
|
|
|
3128
3181
|
*/
|
|
3129
3182
|
Url: string;
|
|
3130
3183
|
/**
|
|
3131
|
-
|
|
3184
|
+
* 下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
|
|
3132
3185
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3133
|
-
|
|
3186
|
+
*/
|
|
3134
3187
|
Option: string;
|
|
3135
3188
|
}
|
|
3136
3189
|
/**
|
|
@@ -3191,14 +3244,14 @@ export interface DescribeOrganizationSealsRequest {
|
|
|
3191
3244
|
*/
|
|
3192
3245
|
SealId?: string;
|
|
3193
3246
|
/**
|
|
3194
|
-
|
|
3247
|
+
* 印章类型列表(都是组织机构印章)。
|
|
3195
3248
|
为空时查询所有类型的印章。
|
|
3196
3249
|
目前支持以下类型:
|
|
3197
3250
|
OFFICIAL:企业公章;
|
|
3198
3251
|
CONTRACT:合同专用章;
|
|
3199
3252
|
ORGANIZATION_SEAL:企业印章(图片上传创建);
|
|
3200
3253
|
LEGAL_PERSON_SEAL:法定代表人章
|
|
3201
|
-
|
|
3254
|
+
*/
|
|
3202
3255
|
SealTypes?: Array<string>;
|
|
3203
3256
|
/**
|
|
3204
3257
|
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
|
@@ -3244,7 +3297,7 @@ export interface UploadFile {
|
|
|
3244
3297
|
*/
|
|
3245
3298
|
export interface Component {
|
|
3246
3299
|
/**
|
|
3247
|
-
|
|
3300
|
+
* 如果是Component填写控件类型,则可选的字段为:
|
|
3248
3301
|
TEXT - 普通文本控件,输入文本字符串;
|
|
3249
3302
|
MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
|
|
3250
3303
|
CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
|
|
@@ -3265,7 +3318,7 @@ export interface Component {
|
|
|
3265
3318
|
SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
|
|
3266
3319
|
|
|
3267
3320
|
表单域的控件不能作为印章和签名控件
|
|
3268
|
-
|
|
3321
|
+
*/
|
|
3269
3322
|
ComponentType: string;
|
|
3270
3323
|
/**
|
|
3271
3324
|
* 控件所属文件的序号(取值为:0-N)。目前单文件的情况下,值是0
|
|
@@ -3308,7 +3361,7 @@ export interface Component {
|
|
|
3308
3361
|
*/
|
|
3309
3362
|
ComponentRecipientId?: string;
|
|
3310
3363
|
/**
|
|
3311
|
-
|
|
3364
|
+
* 扩展参数:
|
|
3312
3365
|
为JSON格式。
|
|
3313
3366
|
|
|
3314
3367
|
ComponentType为FILL_IMAGE时,支持以下参数:
|
|
@@ -3334,14 +3387,14 @@ export interface Component {
|
|
|
3334
3387
|
如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
|
|
3335
3388
|
特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
|
|
3336
3389
|
参数样例: "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
|
|
3337
|
-
|
|
3390
|
+
*/
|
|
3338
3391
|
ComponentExtra?: string;
|
|
3339
3392
|
/**
|
|
3340
3393
|
* 是否是表单域类型,默认不false-不是
|
|
3341
3394
|
*/
|
|
3342
3395
|
IsFormType?: boolean;
|
|
3343
3396
|
/**
|
|
3344
|
-
|
|
3397
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
3345
3398
|
TEXT - 文本内容
|
|
3346
3399
|
MULTI_LINE_TEXT - 文本内容
|
|
3347
3400
|
CHECK_BOX - true/false
|
|
@@ -3417,13 +3470,13 @@ export interface Component {
|
|
|
3417
3470
|
|
|
3418
3471
|
学历控件:
|
|
3419
3472
|
同单行文本控件约束,填写选择值中的字符串
|
|
3420
|
-
|
|
3473
|
+
*/
|
|
3421
3474
|
ComponentValue?: string;
|
|
3422
3475
|
/**
|
|
3423
|
-
|
|
3476
|
+
* NORMAL 正常模式,使用坐标制定签署控件位置
|
|
3424
3477
|
FIELD 表单域,需使用ComponentName指定表单域名称
|
|
3425
3478
|
KEYWORD 关键字,使用ComponentId指定关键字
|
|
3426
|
-
|
|
3479
|
+
*/
|
|
3427
3480
|
GenerateMode?: string;
|
|
3428
3481
|
/**
|
|
3429
3482
|
* 日期签署控件的字号,默认为 12
|
|
@@ -3446,9 +3499,9 @@ export interface Component {
|
|
|
3446
3499
|
*/
|
|
3447
3500
|
ChannelComponentSource?: number;
|
|
3448
3501
|
/**
|
|
3449
|
-
|
|
3502
|
+
* 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
|
|
3450
3503
|
传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
|
|
3451
|
-
|
|
3504
|
+
*/
|
|
3452
3505
|
KeywordOrder?: string;
|
|
3453
3506
|
/**
|
|
3454
3507
|
* 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
|
|
@@ -3468,29 +3521,29 @@ export interface Component {
|
|
|
3468
3521
|
*/
|
|
3469
3522
|
export interface IntegrationDepartment {
|
|
3470
3523
|
/**
|
|
3471
|
-
|
|
3524
|
+
* 部门ID
|
|
3472
3525
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3473
|
-
|
|
3526
|
+
*/
|
|
3474
3527
|
DeptId?: string;
|
|
3475
3528
|
/**
|
|
3476
|
-
|
|
3529
|
+
* 部门名
|
|
3477
3530
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3478
|
-
|
|
3531
|
+
*/
|
|
3479
3532
|
DeptName?: string;
|
|
3480
3533
|
/**
|
|
3481
|
-
|
|
3534
|
+
* 父部门ID
|
|
3482
3535
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3483
|
-
|
|
3536
|
+
*/
|
|
3484
3537
|
ParentDeptId?: string;
|
|
3485
3538
|
/**
|
|
3486
|
-
|
|
3539
|
+
* 客户系统部门ID
|
|
3487
3540
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3488
|
-
|
|
3541
|
+
*/
|
|
3489
3542
|
DeptOpenId?: string;
|
|
3490
3543
|
/**
|
|
3491
|
-
|
|
3544
|
+
* 序列号
|
|
3492
3545
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3493
|
-
|
|
3546
|
+
*/
|
|
3494
3547
|
OrderNo?: number;
|
|
3495
3548
|
}
|
|
3496
3549
|
/**
|
|
@@ -3621,14 +3674,14 @@ export interface VerifyPdfResponse {
|
|
|
3621
3674
|
*/
|
|
3622
3675
|
export interface DeleteStaffsResult {
|
|
3623
3676
|
/**
|
|
3624
|
-
|
|
3677
|
+
* 删除员工的成功数据
|
|
3625
3678
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3626
|
-
|
|
3679
|
+
*/
|
|
3627
3680
|
SuccessEmployeeData: Array<SuccessDeleteStaffData>;
|
|
3628
3681
|
/**
|
|
3629
|
-
|
|
3682
|
+
* 删除员工的失败数据
|
|
3630
3683
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3631
|
-
|
|
3684
|
+
*/
|
|
3632
3685
|
FailedEmployeeData: Array<FailedDeleteStaffData>;
|
|
3633
3686
|
}
|
|
3634
3687
|
/**
|
|
@@ -3649,14 +3702,14 @@ export interface DescribeFlowBriefsResponse {
|
|
|
3649
3702
|
*/
|
|
3650
3703
|
export interface Admin {
|
|
3651
3704
|
/**
|
|
3652
|
-
|
|
3705
|
+
* 超管名
|
|
3653
3706
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3654
|
-
|
|
3707
|
+
*/
|
|
3655
3708
|
Name?: string;
|
|
3656
3709
|
/**
|
|
3657
|
-
|
|
3710
|
+
* 超管手机号
|
|
3658
3711
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3659
|
-
|
|
3712
|
+
*/
|
|
3660
3713
|
Mobile?: string;
|
|
3661
3714
|
}
|
|
3662
3715
|
/**
|
|
@@ -3665,10 +3718,12 @@ export interface Admin {
|
|
|
3665
3718
|
export interface Caller {
|
|
3666
3719
|
/**
|
|
3667
3720
|
* 应用号
|
|
3721
|
+
* @deprecated
|
|
3668
3722
|
*/
|
|
3669
3723
|
ApplicationId?: string;
|
|
3670
3724
|
/**
|
|
3671
3725
|
* 主机构ID
|
|
3726
|
+
* @deprecated
|
|
3672
3727
|
*/
|
|
3673
3728
|
OrganizationId?: string;
|
|
3674
3729
|
/**
|
|
@@ -3677,6 +3732,7 @@ export interface Caller {
|
|
|
3677
3732
|
OperatorId?: string;
|
|
3678
3733
|
/**
|
|
3679
3734
|
* 下属机构ID
|
|
3735
|
+
* @deprecated
|
|
3680
3736
|
*/
|
|
3681
3737
|
SubOrganizationId?: string;
|
|
3682
3738
|
}
|
|
@@ -3702,11 +3758,11 @@ export interface DescribeFlowTemplatesResponse {
|
|
|
3702
3758
|
*/
|
|
3703
3759
|
export interface UploadFilesRequest {
|
|
3704
3760
|
/**
|
|
3705
|
-
|
|
3761
|
+
* 文件对应业务类型
|
|
3706
3762
|
1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
|
|
3707
3763
|
2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
|
|
3708
3764
|
3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
|
|
3709
|
-
|
|
3765
|
+
*/
|
|
3710
3766
|
BusinessType: string;
|
|
3711
3767
|
/**
|
|
3712
3768
|
* 调用方信息,其中OperatorId为必填字段,即用户的UserId
|
|
@@ -3717,15 +3773,15 @@ export interface UploadFilesRequest {
|
|
|
3717
3773
|
*/
|
|
3718
3774
|
FileInfos?: Array<UploadFile>;
|
|
3719
3775
|
/**
|
|
3720
|
-
|
|
3776
|
+
* 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
|
|
3721
3777
|
如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
|
|
3722
|
-
|
|
3778
|
+
*/
|
|
3723
3779
|
FileType?: string;
|
|
3724
3780
|
/**
|
|
3725
|
-
|
|
3781
|
+
* 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
|
|
3726
3782
|
true--是,处理置白
|
|
3727
3783
|
默认为false--否,不处理
|
|
3728
|
-
|
|
3784
|
+
*/
|
|
3729
3785
|
CoverRect?: boolean;
|
|
3730
3786
|
/**
|
|
3731
3787
|
* 用户自定义ID数组,与上传文件一一对应
|
|
@@ -3733,6 +3789,7 @@ export interface UploadFilesRequest {
|
|
|
3733
3789
|
CustomIds?: Array<string>;
|
|
3734
3790
|
/**
|
|
3735
3791
|
* 不再使用,上传文件链接数组,最多支持20个URL
|
|
3792
|
+
* @deprecated
|
|
3736
3793
|
*/
|
|
3737
3794
|
FileUrls?: string;
|
|
3738
3795
|
}
|
|
@@ -3745,24 +3802,24 @@ export interface RelieveInfo {
|
|
|
3745
3802
|
*/
|
|
3746
3803
|
Reason: string;
|
|
3747
3804
|
/**
|
|
3748
|
-
|
|
3805
|
+
* 解除后仍然有效的条款,保留条款,最大支持200个字
|
|
3749
3806
|
|
|
3750
|
-
|
|
3807
|
+
*/
|
|
3751
3808
|
RemainInForceItem?: string;
|
|
3752
3809
|
/**
|
|
3753
|
-
|
|
3810
|
+
* 原合同事项处理-费用结算,最大支持200个字
|
|
3754
3811
|
|
|
3755
|
-
|
|
3812
|
+
*/
|
|
3756
3813
|
OriginalExpenseSettlement?: string;
|
|
3757
3814
|
/**
|
|
3758
|
-
|
|
3815
|
+
* 原合同事项处理-其他事项,最大支持200个字
|
|
3759
3816
|
|
|
3760
|
-
|
|
3817
|
+
*/
|
|
3761
3818
|
OriginalOtherSettlement?: string;
|
|
3762
3819
|
/**
|
|
3763
|
-
|
|
3820
|
+
* 其他约定,最大支持200个字
|
|
3764
3821
|
|
|
3765
|
-
|
|
3822
|
+
*/
|
|
3766
3823
|
OtherDeals?: string;
|
|
3767
3824
|
}
|
|
3768
3825
|
/**
|
|
@@ -3795,9 +3852,9 @@ export interface CreateMultiFlowSignQRCodeRequest {
|
|
|
3795
3852
|
*/
|
|
3796
3853
|
FlowName: string;
|
|
3797
3854
|
/**
|
|
3798
|
-
|
|
3855
|
+
* 最大可发起签署流程份数,默认5份
|
|
3799
3856
|
发起流程数量超过此上限后二维码自动失效
|
|
3800
|
-
|
|
3857
|
+
*/
|
|
3801
3858
|
MaxFlowNum?: number;
|
|
3802
3859
|
/**
|
|
3803
3860
|
* 签署流程有效天数 默认7天 最高设置不超过30天
|
|
@@ -3816,17 +3873,19 @@ export interface CreateMultiFlowSignQRCodeRequest {
|
|
|
3816
3873
|
*/
|
|
3817
3874
|
UserData?: string;
|
|
3818
3875
|
/**
|
|
3819
|
-
|
|
3876
|
+
* 回调地址,最大长度1000字符串
|
|
3820
3877
|
回调时机:
|
|
3821
3878
|
用户通过签署二维码发起签署流程时,企业额度不足导致失败
|
|
3822
|
-
|
|
3879
|
+
*/
|
|
3823
3880
|
CallbackUrl?: string;
|
|
3824
3881
|
/**
|
|
3825
3882
|
* 应用信息
|
|
3883
|
+
* @deprecated
|
|
3826
3884
|
*/
|
|
3827
3885
|
Agent?: Agent;
|
|
3828
3886
|
/**
|
|
3829
3887
|
* 限制二维码用户条件(已弃用)
|
|
3888
|
+
* @deprecated
|
|
3830
3889
|
*/
|
|
3831
3890
|
ApproverRestrictions?: ApproverRestriction;
|
|
3832
3891
|
}
|
|
@@ -3861,29 +3920,13 @@ export interface DescribeFlowInfoResponse {
|
|
|
3861
3920
|
RequestId?: string;
|
|
3862
3921
|
}
|
|
3863
3922
|
/**
|
|
3864
|
-
*
|
|
3923
|
+
* CancelMultiFlowSignQRCode返回参数结构体
|
|
3865
3924
|
*/
|
|
3866
|
-
export interface
|
|
3867
|
-
/**
|
|
3868
|
-
* 被抄送人手机号,11位数字
|
|
3869
|
-
*/
|
|
3870
|
-
Mobile?: string;
|
|
3925
|
+
export interface CancelMultiFlowSignQRCodeResponse {
|
|
3871
3926
|
/**
|
|
3872
|
-
*
|
|
3927
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3873
3928
|
*/
|
|
3874
|
-
|
|
3875
|
-
/**
|
|
3876
|
-
* 被抄送人类型,
|
|
3877
|
-
0--个人
|
|
3878
|
-
1--员工
|
|
3879
|
-
*/
|
|
3880
|
-
CcType?: number;
|
|
3881
|
-
/**
|
|
3882
|
-
* 被抄送人权限
|
|
3883
|
-
0--可查看
|
|
3884
|
-
1--可查看也可下载
|
|
3885
|
-
*/
|
|
3886
|
-
CcPermission?: number;
|
|
3929
|
+
RequestId?: string;
|
|
3887
3930
|
}
|
|
3888
3931
|
/**
|
|
3889
3932
|
* CreateFlow返回参数结构体
|
|
@@ -3907,9 +3950,9 @@ export interface DescribeUserAutoSignStatusRequest {
|
|
|
3907
3950
|
*/
|
|
3908
3951
|
Operator: UserInfo;
|
|
3909
3952
|
/**
|
|
3910
|
-
|
|
3953
|
+
* 自动签场景:
|
|
3911
3954
|
E_PRESCRIPTION_AUTO_SIGN 电子处方
|
|
3912
|
-
|
|
3955
|
+
*/
|
|
3913
3956
|
SceneKey: string;
|
|
3914
3957
|
/**
|
|
3915
3958
|
* 查询开启状态的用户信息
|
|
@@ -3922,9 +3965,9 @@ export interface DescribeUserAutoSignStatusRequest {
|
|
|
3922
3965
|
*/
|
|
3923
3966
|
export interface ReleasedApprover {
|
|
3924
3967
|
/**
|
|
3925
|
-
|
|
3968
|
+
* 签署人姓名,最大长度50个字符
|
|
3926
3969
|
|
|
3927
|
-
|
|
3970
|
+
*/
|
|
3928
3971
|
Name: string;
|
|
3929
3972
|
/**
|
|
3930
3973
|
* 签署人手机号
|
|
@@ -3935,10 +3978,10 @@ export interface ReleasedApprover {
|
|
|
3935
3978
|
*/
|
|
3936
3979
|
RelievedApproverReceiptId: string;
|
|
3937
3980
|
/**
|
|
3938
|
-
|
|
3981
|
+
* 指定签署人类型,目前仅支持
|
|
3939
3982
|
ORGANIZATION-企业
|
|
3940
3983
|
ENTERPRISESERVER-企业静默签
|
|
3941
|
-
|
|
3984
|
+
*/
|
|
3942
3985
|
ApproverType?: string;
|
|
3943
3986
|
}
|
|
3944
3987
|
/**
|
|
@@ -3954,16 +3997,16 @@ export interface FlowBrief {
|
|
|
3954
3997
|
*/
|
|
3955
3998
|
FlowName: string;
|
|
3956
3999
|
/**
|
|
3957
|
-
|
|
4000
|
+
* 流程的描述信息
|
|
3958
4001
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3959
|
-
|
|
4002
|
+
*/
|
|
3960
4003
|
FlowDescription: string;
|
|
3961
4004
|
/**
|
|
3962
4005
|
* 流程的类型
|
|
3963
4006
|
*/
|
|
3964
4007
|
FlowType: string;
|
|
3965
4008
|
/**
|
|
3966
|
-
|
|
4009
|
+
* 流程状态
|
|
3967
4010
|
- 0 还没有发起
|
|
3968
4011
|
- 1 待签署
|
|
3969
4012
|
- 2 部分签署
|
|
@@ -3977,27 +4020,27 @@ export interface FlowBrief {
|
|
|
3977
4020
|
- 10 拒填
|
|
3978
4021
|
- 21 已解除
|
|
3979
4022
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3980
|
-
|
|
4023
|
+
*/
|
|
3981
4024
|
FlowStatus: number;
|
|
3982
4025
|
/**
|
|
3983
|
-
|
|
4026
|
+
* 流程创建的时间戳,单位秒
|
|
3984
4027
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3985
|
-
|
|
4028
|
+
*/
|
|
3986
4029
|
CreatedOn: number;
|
|
3987
4030
|
/**
|
|
3988
|
-
|
|
4031
|
+
* 拒签或者取消的原因描述
|
|
3989
4032
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3990
|
-
|
|
4033
|
+
*/
|
|
3991
4034
|
FlowMessage: string;
|
|
3992
4035
|
/**
|
|
3993
|
-
|
|
4036
|
+
* 合同发起人userId
|
|
3994
4037
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3995
|
-
|
|
4038
|
+
*/
|
|
3996
4039
|
Creator?: string;
|
|
3997
4040
|
/**
|
|
3998
|
-
|
|
4041
|
+
* 合同过期时间,时间戳,单位秒
|
|
3999
4042
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4000
|
-
|
|
4043
|
+
*/
|
|
4001
4044
|
Deadline?: number;
|
|
4002
4045
|
}
|
|
4003
4046
|
/**
|
|
@@ -4005,29 +4048,29 @@ export interface FlowBrief {
|
|
|
4005
4048
|
*/
|
|
4006
4049
|
export interface DescribeOrganizationGroupOrganizationsResponse {
|
|
4007
4050
|
/**
|
|
4008
|
-
|
|
4051
|
+
* 查询到的符合条件的成员企业总数量
|
|
4009
4052
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4010
|
-
|
|
4053
|
+
*/
|
|
4011
4054
|
Total?: number;
|
|
4012
4055
|
/**
|
|
4013
|
-
|
|
4056
|
+
* 已授权待激活的企业数量
|
|
4014
4057
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4015
|
-
|
|
4058
|
+
*/
|
|
4016
4059
|
JoinedTotal?: number;
|
|
4017
4060
|
/**
|
|
4018
|
-
|
|
4061
|
+
* 已加入的企业数量
|
|
4019
4062
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4020
|
-
|
|
4063
|
+
*/
|
|
4021
4064
|
ActivedTotal?: number;
|
|
4022
4065
|
/**
|
|
4023
|
-
|
|
4066
|
+
* 导出文件的url
|
|
4024
4067
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4025
|
-
|
|
4068
|
+
*/
|
|
4026
4069
|
ExportUrl?: string;
|
|
4027
4070
|
/**
|
|
4028
|
-
|
|
4071
|
+
* 成员企业信息列表
|
|
4029
4072
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4030
|
-
|
|
4073
|
+
*/
|
|
4031
4074
|
List?: Array<GroupOrganization>;
|
|
4032
4075
|
/**
|
|
4033
4076
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -4035,11 +4078,27 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
|
|
|
4035
4078
|
RequestId?: string;
|
|
4036
4079
|
}
|
|
4037
4080
|
/**
|
|
4038
|
-
*
|
|
4081
|
+
* 抄送信息
|
|
4039
4082
|
*/
|
|
4040
|
-
export interface
|
|
4083
|
+
export interface CcInfo {
|
|
4041
4084
|
/**
|
|
4042
|
-
*
|
|
4085
|
+
* 被抄送人手机号,11位数字
|
|
4043
4086
|
*/
|
|
4044
|
-
|
|
4087
|
+
Mobile?: string;
|
|
4088
|
+
/**
|
|
4089
|
+
* 被抄送人姓名
|
|
4090
|
+
*/
|
|
4091
|
+
Name?: string;
|
|
4092
|
+
/**
|
|
4093
|
+
* 被抄送人类型,
|
|
4094
|
+
0--个人
|
|
4095
|
+
1--员工
|
|
4096
|
+
*/
|
|
4097
|
+
CcType?: number;
|
|
4098
|
+
/**
|
|
4099
|
+
* 被抄送人权限
|
|
4100
|
+
0--可查看
|
|
4101
|
+
1--可查看也可下载
|
|
4102
|
+
*/
|
|
4103
|
+
CcPermission?: number;
|
|
4045
4104
|
}
|