tencentcloud-sdk-nodejs-ess 4.0.618 → 4.0.620
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 +487 -0
- package/SERVICE_CHANGELOG.md +478 -156
- package/package.json +1 -1
- package/products.md +30 -30
- package/src/services/ess/v20201111/ess_models.ts +344 -860
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +344 -312
|
@@ -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
|
/**
|
|
@@ -374,11 +375,11 @@ export interface DescribeIntegrationRolesRequest {
|
|
|
374
375
|
*/
|
|
375
376
|
Agent?: Agent;
|
|
376
377
|
/**
|
|
377
|
-
|
|
378
|
+
* 查询的关键字段:
|
|
378
379
|
Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
|
|
379
380
|
Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
|
|
380
381
|
Key:"IsGroupRole",Values:["0"],查询非集团角色,Values:["1"]表示查询集团角色
|
|
381
|
-
|
|
382
|
+
*/
|
|
382
383
|
Filters?: Array<Filter>;
|
|
383
384
|
/**
|
|
384
385
|
* 偏移量,默认为0,最大为2000
|
|
@@ -416,14 +417,14 @@ export interface StartFlowResponse {
|
|
|
416
417
|
*/
|
|
417
418
|
export interface StaffRole {
|
|
418
419
|
/**
|
|
419
|
-
|
|
420
|
+
* 角色id
|
|
420
421
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
421
|
-
|
|
422
|
+
*/
|
|
422
423
|
RoleId: string;
|
|
423
424
|
/**
|
|
424
|
-
|
|
425
|
+
* 角色名称
|
|
425
426
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
426
|
-
|
|
427
|
+
*/
|
|
427
428
|
RoleName: string;
|
|
428
429
|
}
|
|
429
430
|
/**
|
|
@@ -431,29 +432,29 @@ export interface StaffRole {
|
|
|
431
432
|
*/
|
|
432
433
|
export interface FlowApproverUrlInfo {
|
|
433
434
|
/**
|
|
434
|
-
|
|
435
|
+
* 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
|
|
435
436
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
436
|
-
|
|
437
|
+
*/
|
|
437
438
|
SignUrl?: string;
|
|
438
439
|
/**
|
|
439
|
-
|
|
440
|
+
* 签署人类型 1-个人
|
|
440
441
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
441
|
-
|
|
442
|
+
*/
|
|
442
443
|
ApproverType?: number;
|
|
443
444
|
/**
|
|
444
|
-
|
|
445
|
+
* 签署人姓名
|
|
445
446
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
446
|
-
|
|
447
|
+
*/
|
|
447
448
|
ApproverName?: string;
|
|
448
449
|
/**
|
|
449
|
-
|
|
450
|
+
* 签署人手机号
|
|
450
451
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
451
|
-
|
|
452
|
+
*/
|
|
452
453
|
ApproverMobile?: string;
|
|
453
454
|
/**
|
|
454
|
-
|
|
455
|
+
* 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
|
|
455
456
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
456
|
-
|
|
457
|
+
*/
|
|
457
458
|
LongUrl?: string;
|
|
458
459
|
}
|
|
459
460
|
/**
|
|
@@ -487,10 +488,12 @@ export interface CreateConvertTaskApiRequest {
|
|
|
487
488
|
Operator?: UserInfo;
|
|
488
489
|
/**
|
|
489
490
|
* 应用号信息
|
|
491
|
+
* @deprecated
|
|
490
492
|
*/
|
|
491
493
|
Agent?: Agent;
|
|
492
494
|
/**
|
|
493
495
|
* 暂未开放
|
|
496
|
+
* @deprecated
|
|
494
497
|
*/
|
|
495
498
|
Organization?: OrganizationInfo;
|
|
496
499
|
}
|
|
@@ -546,10 +549,12 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
|
|
|
546
549
|
export interface Agent {
|
|
547
550
|
/**
|
|
548
551
|
* 代理机构的应用编号,32位字符串,一般不用传
|
|
552
|
+
* @deprecated
|
|
549
553
|
*/
|
|
550
554
|
AppId?: string;
|
|
551
555
|
/**
|
|
552
556
|
* 被代理机构的应用号,一般不用传
|
|
557
|
+
* @deprecated
|
|
553
558
|
*/
|
|
554
559
|
ProxyAppId?: string;
|
|
555
560
|
/**
|
|
@@ -558,6 +563,7 @@ export interface Agent {
|
|
|
558
563
|
ProxyOrganizationId?: string;
|
|
559
564
|
/**
|
|
560
565
|
* 被代理机构的经办人,一般不用传
|
|
566
|
+
* @deprecated
|
|
561
567
|
*/
|
|
562
568
|
ProxyOperator?: string;
|
|
563
569
|
}
|
|
@@ -566,16 +572,16 @@ export interface Agent {
|
|
|
566
572
|
*/
|
|
567
573
|
export interface FlowApproverDetail {
|
|
568
574
|
/**
|
|
569
|
-
|
|
575
|
+
* 签署时的相关信息
|
|
570
576
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
571
|
-
|
|
577
|
+
*/
|
|
572
578
|
ApproveMessage?: string;
|
|
573
579
|
/**
|
|
574
580
|
* 签署方姓名
|
|
575
581
|
*/
|
|
576
582
|
ApproveName: string;
|
|
577
583
|
/**
|
|
578
|
-
|
|
584
|
+
* 签署方的签署状态
|
|
579
585
|
0:还没有发起
|
|
580
586
|
1:流程中 没有开始处理
|
|
581
587
|
2:待签署
|
|
@@ -589,16 +595,16 @@ export interface FlowApproverDetail {
|
|
|
589
595
|
10:填写完成
|
|
590
596
|
15:已解除
|
|
591
597
|
19:转他人处理
|
|
592
|
-
|
|
598
|
+
*/
|
|
593
599
|
ApproveStatus: number;
|
|
594
600
|
/**
|
|
595
601
|
* 模板配置中的参与方ID,与控件绑定
|
|
596
602
|
*/
|
|
597
603
|
ReceiptId: string;
|
|
598
604
|
/**
|
|
599
|
-
|
|
605
|
+
* 客户自定义的用户ID
|
|
600
606
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
601
|
-
|
|
607
|
+
*/
|
|
602
608
|
CustomUserId: string;
|
|
603
609
|
/**
|
|
604
610
|
* 签署人手机号
|
|
@@ -613,29 +619,29 @@ export interface FlowApproverDetail {
|
|
|
613
619
|
*/
|
|
614
620
|
ApproveTime: number;
|
|
615
621
|
/**
|
|
616
|
-
|
|
622
|
+
* 签署方类型,ORGANIZATION-企业员工,PERSON-个人,ENTERPRISESERVER-企业静默签
|
|
617
623
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
618
|
-
|
|
624
|
+
*/
|
|
619
625
|
ApproveType: string;
|
|
620
626
|
/**
|
|
621
|
-
|
|
627
|
+
* 签署方侧用户来源,如WEWORKAPP-企业微信等
|
|
622
628
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
623
|
-
|
|
629
|
+
*/
|
|
624
630
|
ApproverSource: string;
|
|
625
631
|
/**
|
|
626
|
-
|
|
632
|
+
* 客户自定义签署方标识
|
|
627
633
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
628
|
-
|
|
634
|
+
*/
|
|
629
635
|
CustomApproverTag: string;
|
|
630
636
|
/**
|
|
631
|
-
|
|
637
|
+
* 签署方企业Id
|
|
632
638
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
633
|
-
|
|
639
|
+
*/
|
|
634
640
|
OrganizationId: string;
|
|
635
641
|
/**
|
|
636
|
-
|
|
642
|
+
* 签署方企业名称
|
|
637
643
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
638
|
-
|
|
644
|
+
*/
|
|
639
645
|
OrganizationName: string;
|
|
640
646
|
}
|
|
641
647
|
/**
|
|
@@ -667,23 +673,25 @@ export interface DescribeFlowTemplatesRequest {
|
|
|
667
673
|
*/
|
|
668
674
|
Limit?: number;
|
|
669
675
|
/**
|
|
670
|
-
|
|
676
|
+
* 这个参数跟下面的IsChannel参数配合使用。
|
|
671
677
|
IsChannel=false时,ApplicationId参数不起任何作用。
|
|
672
678
|
IsChannel=true时,ApplicationId为空,查询所有第三方应用集成平台企业模板列表;ApplicationId不为空,查询指定应用下的模板列表
|
|
673
679
|
ApplicationId为空,查询所有应用下的模板列表
|
|
674
|
-
|
|
680
|
+
*/
|
|
675
681
|
ApplicationId?: string;
|
|
676
682
|
/**
|
|
677
|
-
|
|
683
|
+
* 默认为false,查询SaaS模板库列表;
|
|
678
684
|
为true,查询第三方应用集成平台企业模板库管理列表
|
|
679
|
-
|
|
685
|
+
*/
|
|
680
686
|
IsChannel?: boolean;
|
|
681
687
|
/**
|
|
682
688
|
* 暂未开放
|
|
689
|
+
* @deprecated
|
|
683
690
|
*/
|
|
684
691
|
Organization?: OrganizationInfo;
|
|
685
692
|
/**
|
|
686
693
|
* 暂未开放
|
|
694
|
+
* @deprecated
|
|
687
695
|
*/
|
|
688
696
|
GenerateSource?: number;
|
|
689
697
|
}
|
|
@@ -692,15 +700,15 @@ export interface DescribeFlowTemplatesRequest {
|
|
|
692
700
|
*/
|
|
693
701
|
export interface DescribeFlowEvidenceReportResponse {
|
|
694
702
|
/**
|
|
695
|
-
|
|
703
|
+
* 报告 URL
|
|
696
704
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
697
|
-
|
|
705
|
+
*/
|
|
698
706
|
ReportUrl: string;
|
|
699
707
|
/**
|
|
700
|
-
|
|
708
|
+
* 执行中:EvidenceStatusExecuting
|
|
701
709
|
成功:EvidenceStatusSuccess
|
|
702
710
|
失败:EvidenceStatusFailed
|
|
703
|
-
|
|
711
|
+
*/
|
|
704
712
|
Status: string;
|
|
705
713
|
/**
|
|
706
714
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -717,6 +725,7 @@ export interface CallbackInfo {
|
|
|
717
725
|
CallbackUrl: string;
|
|
718
726
|
/**
|
|
719
727
|
* 回调加密key,已废弃
|
|
728
|
+
* @deprecated
|
|
720
729
|
*/
|
|
721
730
|
Token?: string;
|
|
722
731
|
/**
|
|
@@ -789,11 +798,11 @@ export interface TemplateInfo {
|
|
|
789
798
|
*/
|
|
790
799
|
Promoter?: Recipient;
|
|
791
800
|
/**
|
|
792
|
-
|
|
801
|
+
* 模板类型
|
|
793
802
|
取值:
|
|
794
803
|
1 静默签,
|
|
795
804
|
3 普通模板
|
|
796
|
-
|
|
805
|
+
*/
|
|
797
806
|
TemplateType?: number;
|
|
798
807
|
/**
|
|
799
808
|
* 模板可用状态,取值:1启用(默认),2停用
|
|
@@ -804,19 +813,19 @@ export interface TemplateInfo {
|
|
|
804
813
|
*/
|
|
805
814
|
OrganizationId?: string;
|
|
806
815
|
/**
|
|
807
|
-
|
|
816
|
+
* 模板预览链接,有效时间5分钟
|
|
808
817
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
809
|
-
|
|
818
|
+
*/
|
|
810
819
|
PreviewUrl?: string;
|
|
811
820
|
/**
|
|
812
|
-
|
|
821
|
+
* 模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。
|
|
813
822
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
814
|
-
|
|
823
|
+
*/
|
|
815
824
|
TemplateVersion?: string;
|
|
816
825
|
/**
|
|
817
|
-
|
|
826
|
+
* 模板是否已发布。true-已发布;false-未发布
|
|
818
827
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
819
|
-
|
|
828
|
+
*/
|
|
820
829
|
Published?: boolean;
|
|
821
830
|
}
|
|
822
831
|
/**
|
|
@@ -828,9 +837,9 @@ export interface CreateDocumentResponse {
|
|
|
828
837
|
*/
|
|
829
838
|
DocumentId?: string;
|
|
830
839
|
/**
|
|
831
|
-
|
|
840
|
+
* 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
|
|
832
841
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
833
|
-
|
|
842
|
+
*/
|
|
834
843
|
PreviewFileUrl?: string;
|
|
835
844
|
/**
|
|
836
845
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -854,9 +863,9 @@ export interface DescribeIntegrationEmployeesRequest {
|
|
|
854
863
|
*/
|
|
855
864
|
Agent?: Agent;
|
|
856
865
|
/**
|
|
857
|
-
|
|
866
|
+
* 查询过滤实名用户,Key为Status,Values为["IsVerified"]
|
|
858
867
|
根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
|
|
859
|
-
|
|
868
|
+
*/
|
|
860
869
|
Filters?: Array<Filter>;
|
|
861
870
|
/**
|
|
862
871
|
* 偏移量,默认为0,最大为20000
|
|
@@ -902,12 +911,13 @@ export interface CreateFlowRequest {
|
|
|
902
911
|
ClientToken?: string;
|
|
903
912
|
/**
|
|
904
913
|
* 暂未开放
|
|
914
|
+
* @deprecated
|
|
905
915
|
*/
|
|
906
916
|
RelatedFlowId?: string;
|
|
907
917
|
/**
|
|
908
|
-
|
|
918
|
+
* 签署流程的签署截止时间。
|
|
909
919
|
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
910
|
-
|
|
920
|
+
*/
|
|
911
921
|
DeadLine?: number;
|
|
912
922
|
/**
|
|
913
923
|
* 用户自定义字段,回调的时候会进行透传,长度需要小于20480
|
|
@@ -918,25 +928,26 @@ export interface CreateFlowRequest {
|
|
|
918
928
|
*/
|
|
919
929
|
FlowDescription?: string;
|
|
920
930
|
/**
|
|
921
|
-
|
|
931
|
+
* 发送类型:
|
|
922
932
|
true:无序签
|
|
923
933
|
false:有序签
|
|
924
934
|
注:默认为false(有序签),请和模板中的配置保持一致
|
|
925
|
-
|
|
935
|
+
*/
|
|
926
936
|
Unordered?: boolean;
|
|
927
937
|
/**
|
|
928
938
|
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
929
939
|
*/
|
|
930
940
|
CustomShowMap?: string;
|
|
931
941
|
/**
|
|
932
|
-
|
|
942
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
933
943
|
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
934
944
|
|
|
935
945
|
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
936
|
-
|
|
946
|
+
*/
|
|
937
947
|
NeedSignReview?: boolean;
|
|
938
948
|
/**
|
|
939
949
|
* 暂未开放
|
|
950
|
+
* @deprecated
|
|
940
951
|
*/
|
|
941
952
|
CallbackUrl?: string;
|
|
942
953
|
/**
|
|
@@ -944,9 +955,9 @@ export interface CreateFlowRequest {
|
|
|
944
955
|
*/
|
|
945
956
|
Agent?: Agent;
|
|
946
957
|
/**
|
|
947
|
-
|
|
958
|
+
* 被抄送人的信息列表。
|
|
948
959
|
注: 此功能为白名单功能,若有需要,请联系电子签客服开白使用。
|
|
949
|
-
|
|
960
|
+
*/
|
|
950
961
|
CcInfos?: Array<CcInfo>;
|
|
951
962
|
/**
|
|
952
963
|
* 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
@@ -974,11 +985,11 @@ export interface CreateSchemeUrlRequest {
|
|
|
974
985
|
*/
|
|
975
986
|
Mobile?: string;
|
|
976
987
|
/**
|
|
977
|
-
|
|
988
|
+
* 链接类型
|
|
978
989
|
HTTP:跳转电子签小程序的http_url,
|
|
979
990
|
APP:第三方APP或小程序跳转电子签小程序的path。
|
|
980
991
|
默认为HTTP类型
|
|
981
|
-
|
|
992
|
+
*/
|
|
982
993
|
EndPoint?: string;
|
|
983
994
|
/**
|
|
984
995
|
* 签署流程编号 (PathType=1时必传)
|
|
@@ -1062,9 +1073,9 @@ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
|
|
|
1062
1073
|
*/
|
|
1063
1074
|
export interface CreateReleaseFlowResponse {
|
|
1064
1075
|
/**
|
|
1065
|
-
|
|
1076
|
+
* 解除协议流程编号
|
|
1066
1077
|
|
|
1067
|
-
|
|
1078
|
+
*/
|
|
1068
1079
|
FlowId?: string;
|
|
1069
1080
|
/**
|
|
1070
1081
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1137,22 +1148,27 @@ export interface DeleteSealPoliciesResponse {
|
|
|
1137
1148
|
export interface OrganizationInfo {
|
|
1138
1149
|
/**
|
|
1139
1150
|
* 机构在平台的编号,内部字段,暂未开放
|
|
1151
|
+
* @deprecated
|
|
1140
1152
|
*/
|
|
1141
1153
|
OrganizationId?: string;
|
|
1142
1154
|
/**
|
|
1143
1155
|
* 用户渠道,内部字段,暂未开放
|
|
1156
|
+
* @deprecated
|
|
1144
1157
|
*/
|
|
1145
1158
|
Channel?: string;
|
|
1146
1159
|
/**
|
|
1147
1160
|
* 用户在渠道的机构编号,内部字段,暂未开放
|
|
1161
|
+
* @deprecated
|
|
1148
1162
|
*/
|
|
1149
1163
|
OrganizationOpenId?: string;
|
|
1150
1164
|
/**
|
|
1151
1165
|
* 用户真实的IP,内部字段,暂未开放
|
|
1166
|
+
* @deprecated
|
|
1152
1167
|
*/
|
|
1153
1168
|
ClientIp?: string;
|
|
1154
1169
|
/**
|
|
1155
1170
|
* 机构的代理IP,内部字段,暂未开放
|
|
1171
|
+
* @deprecated
|
|
1156
1172
|
*/
|
|
1157
1173
|
ProxyIp?: string;
|
|
1158
1174
|
}
|
|
@@ -1186,14 +1202,14 @@ export interface FillApproverInfo {
|
|
|
1186
1202
|
*/
|
|
1187
1203
|
RecipientId: string;
|
|
1188
1204
|
/**
|
|
1189
|
-
|
|
1205
|
+
* 签署人来源
|
|
1190
1206
|
WEWORKAPP: 企业微信
|
|
1191
|
-
|
|
1207
|
+
*/
|
|
1192
1208
|
ApproverSource: string;
|
|
1193
1209
|
/**
|
|
1194
|
-
|
|
1210
|
+
* 企业自定义账号ID
|
|
1195
1211
|
WEWORKAPP场景下指企业自有应用获取企微明文的userid
|
|
1196
|
-
|
|
1212
|
+
*/
|
|
1197
1213
|
CustomUserId: string;
|
|
1198
1214
|
}
|
|
1199
1215
|
/**
|
|
@@ -1225,9 +1241,9 @@ export interface OccupiedSeal {
|
|
|
1225
1241
|
*/
|
|
1226
1242
|
SealStatus: string;
|
|
1227
1243
|
/**
|
|
1228
|
-
|
|
1244
|
+
* 审核失败原因
|
|
1229
1245
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1230
|
-
|
|
1246
|
+
*/
|
|
1231
1247
|
FailReason: string;
|
|
1232
1248
|
/**
|
|
1233
1249
|
* 印章图片url,5分钟内有效
|
|
@@ -1242,9 +1258,9 @@ export interface OccupiedSeal {
|
|
|
1242
1258
|
*/
|
|
1243
1259
|
IsAllTime: boolean;
|
|
1244
1260
|
/**
|
|
1245
|
-
|
|
1261
|
+
* 授权人列表
|
|
1246
1262
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1247
|
-
|
|
1263
|
+
*/
|
|
1248
1264
|
AuthorizedUsers: Array<AuthorizedUser>;
|
|
1249
1265
|
}
|
|
1250
1266
|
/**
|
|
@@ -1252,14 +1268,14 @@ export interface OccupiedSeal {
|
|
|
1252
1268
|
*/
|
|
1253
1269
|
export interface FailedDeleteStaffData {
|
|
1254
1270
|
/**
|
|
1255
|
-
|
|
1271
|
+
* 员工在电子签的userId
|
|
1256
1272
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1257
|
-
|
|
1273
|
+
*/
|
|
1258
1274
|
UserId: string;
|
|
1259
1275
|
/**
|
|
1260
|
-
|
|
1276
|
+
* 员工在第三方平台的openId
|
|
1261
1277
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1262
|
-
|
|
1278
|
+
*/
|
|
1263
1279
|
OpenId: string;
|
|
1264
1280
|
/**
|
|
1265
1281
|
* 失败原因
|
|
@@ -1353,11 +1369,11 @@ export interface UserThreeFactor {
|
|
|
1353
1369
|
*/
|
|
1354
1370
|
Name: string;
|
|
1355
1371
|
/**
|
|
1356
|
-
|
|
1372
|
+
* 证件类型:
|
|
1357
1373
|
ID_CARD 身份证
|
|
1358
1374
|
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
1359
1375
|
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
1360
|
-
|
|
1376
|
+
*/
|
|
1361
1377
|
IdCardType: string;
|
|
1362
1378
|
/**
|
|
1363
1379
|
* 证件号,如果有 X 请大写
|
|
@@ -1403,9 +1419,9 @@ export interface DisableUserAutoSignRequest {
|
|
|
1403
1419
|
*/
|
|
1404
1420
|
Operator: UserInfo;
|
|
1405
1421
|
/**
|
|
1406
|
-
|
|
1422
|
+
* 自动签场景:
|
|
1407
1423
|
E_PRESCRIPTION_AUTO_SIGN 电子处方
|
|
1408
|
-
|
|
1424
|
+
*/
|
|
1409
1425
|
SceneKey: string;
|
|
1410
1426
|
/**
|
|
1411
1427
|
* 关闭自动签的个人的三要素
|
|
@@ -1417,14 +1433,14 @@ export interface DisableUserAutoSignRequest {
|
|
|
1417
1433
|
*/
|
|
1418
1434
|
export interface DescribeIntegrationEmployeesResponse {
|
|
1419
1435
|
/**
|
|
1420
|
-
|
|
1436
|
+
* 员工数据列表
|
|
1421
1437
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1422
|
-
|
|
1438
|
+
*/
|
|
1423
1439
|
Employees?: Array<Staff>;
|
|
1424
1440
|
/**
|
|
1425
|
-
|
|
1441
|
+
* 偏移量,默认为0,最大为20000
|
|
1426
1442
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1427
|
-
|
|
1443
|
+
*/
|
|
1428
1444
|
Offset?: number;
|
|
1429
1445
|
/**
|
|
1430
1446
|
* 返回最大数量,最大为20
|
|
@@ -1482,15 +1498,15 @@ export interface CreateFlowSignReviewRequest {
|
|
|
1482
1498
|
*/
|
|
1483
1499
|
FlowId: string;
|
|
1484
1500
|
/**
|
|
1485
|
-
|
|
1501
|
+
* 企业内部审核结果
|
|
1486
1502
|
PASS: 通过
|
|
1487
1503
|
REJECT: 拒绝
|
|
1488
|
-
|
|
1504
|
+
*/
|
|
1489
1505
|
ReviewType: string;
|
|
1490
1506
|
/**
|
|
1491
|
-
|
|
1507
|
+
* 审核原因
|
|
1492
1508
|
当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
|
|
1493
|
-
|
|
1509
|
+
*/
|
|
1494
1510
|
ReviewMessage?: string;
|
|
1495
1511
|
/**
|
|
1496
1512
|
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
|
@@ -1582,17 +1598,17 @@ export interface DescribeFileUrlsRequest {
|
|
|
1582
1598
|
*/
|
|
1583
1599
|
Operator: UserInfo;
|
|
1584
1600
|
/**
|
|
1585
|
-
|
|
1601
|
+
* 文件对应的业务类型,目前支持:
|
|
1586
1602
|
- 流程 "FLOW",如需下载合同文件请选择此项
|
|
1587
1603
|
- 模板 "TEMPLATE"
|
|
1588
1604
|
- 文档 "DOCUMENT"
|
|
1589
1605
|
- 印章 “SEAL”
|
|
1590
|
-
|
|
1606
|
+
*/
|
|
1591
1607
|
BusinessType: string;
|
|
1592
1608
|
/**
|
|
1593
|
-
|
|
1609
|
+
* 业务编号的数组,如流程编号、模板编号、文档编号、印章编号。如需下载合同文件请传入FlowId
|
|
1594
1610
|
最大支持20个资源
|
|
1595
|
-
|
|
1611
|
+
*/
|
|
1596
1612
|
BusinessIds: Array<string>;
|
|
1597
1613
|
/**
|
|
1598
1614
|
* 下载后的文件命名,只有FileType为zip的时候生效
|
|
@@ -1616,14 +1632,17 @@ export interface DescribeFileUrlsRequest {
|
|
|
1616
1632
|
UrlTtl?: number;
|
|
1617
1633
|
/**
|
|
1618
1634
|
* 暂不开放
|
|
1635
|
+
* @deprecated
|
|
1619
1636
|
*/
|
|
1620
1637
|
CcToken?: string;
|
|
1621
1638
|
/**
|
|
1622
1639
|
* 暂不开放
|
|
1640
|
+
* @deprecated
|
|
1623
1641
|
*/
|
|
1624
1642
|
Scene?: string;
|
|
1625
1643
|
/**
|
|
1626
1644
|
* 应用相关信息
|
|
1645
|
+
* @deprecated
|
|
1627
1646
|
*/
|
|
1628
1647
|
Agent?: Agent;
|
|
1629
1648
|
}
|
|
@@ -1742,14 +1761,14 @@ content String 表头单元格内容,字数不超过100
|
|
|
1742
1761
|
*/
|
|
1743
1762
|
export interface FormField {
|
|
1744
1763
|
/**
|
|
1745
|
-
|
|
1764
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
1746
1765
|
TEXT - 文本内容
|
|
1747
1766
|
MULTI_LINE_TEXT - 文本内容
|
|
1748
1767
|
CHECK_BOX - true/false
|
|
1749
1768
|
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
1750
1769
|
SELECTOR - 选项值
|
|
1751
1770
|
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
1752
|
-
|
|
1771
|
+
*/
|
|
1753
1772
|
ComponentValue: string;
|
|
1754
1773
|
/**
|
|
1755
1774
|
* 控件id,和ComponentName选择一项传入即可
|
|
@@ -1783,18 +1802,22 @@ export interface UserInfo {
|
|
|
1783
1802
|
UserId?: string;
|
|
1784
1803
|
/**
|
|
1785
1804
|
* 用户的来源渠道,一般不用传,特定场景根据接口说明传值
|
|
1805
|
+
* @deprecated
|
|
1786
1806
|
*/
|
|
1787
1807
|
Channel?: string;
|
|
1788
1808
|
/**
|
|
1789
1809
|
* 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
|
|
1810
|
+
* @deprecated
|
|
1790
1811
|
*/
|
|
1791
1812
|
OpenId?: string;
|
|
1792
1813
|
/**
|
|
1793
1814
|
* 用户真实IP,内部字段,暂未开放
|
|
1815
|
+
* @deprecated
|
|
1794
1816
|
*/
|
|
1795
1817
|
ClientIp?: string;
|
|
1796
1818
|
/**
|
|
1797
1819
|
* 用户代理IP,内部字段,暂未开放
|
|
1820
|
+
* @deprecated
|
|
1798
1821
|
*/
|
|
1799
1822
|
ProxyIp?: string;
|
|
1800
1823
|
}
|
|
@@ -1836,24 +1859,24 @@ export interface Staff {
|
|
|
1836
1859
|
*/
|
|
1837
1860
|
Mobile?: string;
|
|
1838
1861
|
/**
|
|
1839
|
-
|
|
1862
|
+
* 用户邮箱
|
|
1840
1863
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1841
|
-
|
|
1864
|
+
*/
|
|
1842
1865
|
Email?: string;
|
|
1843
1866
|
/**
|
|
1844
|
-
|
|
1867
|
+
* 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
|
|
1845
1868
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1846
|
-
|
|
1869
|
+
*/
|
|
1847
1870
|
OpenId?: string;
|
|
1848
1871
|
/**
|
|
1849
|
-
|
|
1872
|
+
* 员工角色
|
|
1850
1873
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1851
|
-
|
|
1874
|
+
*/
|
|
1852
1875
|
Roles?: Array<StaffRole>;
|
|
1853
1876
|
/**
|
|
1854
|
-
|
|
1877
|
+
* 员工部门
|
|
1855
1878
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1856
|
-
|
|
1879
|
+
*/
|
|
1857
1880
|
Department?: Department;
|
|
1858
1881
|
/**
|
|
1859
1882
|
* 员工是否实名
|
|
@@ -1864,14 +1887,14 @@ export interface Staff {
|
|
|
1864
1887
|
*/
|
|
1865
1888
|
CreatedOn?: number;
|
|
1866
1889
|
/**
|
|
1867
|
-
|
|
1890
|
+
* 员工实名时间戳,单位秒
|
|
1868
1891
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1869
|
-
|
|
1892
|
+
*/
|
|
1870
1893
|
VerifiedOn?: number;
|
|
1871
1894
|
/**
|
|
1872
|
-
|
|
1895
|
+
* 员工是否离职:0-未离职,1-离职
|
|
1873
1896
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1874
|
-
|
|
1897
|
+
*/
|
|
1875
1898
|
QuiteJob?: number;
|
|
1876
1899
|
/**
|
|
1877
1900
|
* 员工离职交接人用户id
|
|
@@ -1887,20 +1910,20 @@ export interface Staff {
|
|
|
1887
1910
|
*/
|
|
1888
1911
|
export interface CreateFlowEvidenceReportResponse {
|
|
1889
1912
|
/**
|
|
1890
|
-
|
|
1913
|
+
* 出证报告 ID,用于查询出证报告DescribeFlowEvidenceReport接口时用到
|
|
1891
1914
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1892
|
-
|
|
1915
|
+
*/
|
|
1893
1916
|
ReportId?: string;
|
|
1894
1917
|
/**
|
|
1895
|
-
|
|
1918
|
+
* 执行中:EvidenceStatusExecuting
|
|
1896
1919
|
成功:EvidenceStatusSuccess
|
|
1897
1920
|
失败:EvidenceStatusFailed
|
|
1898
|
-
|
|
1921
|
+
*/
|
|
1899
1922
|
Status?: string;
|
|
1900
1923
|
/**
|
|
1901
|
-
|
|
1924
|
+
* 废除,字段无效
|
|
1902
1925
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1903
|
-
|
|
1926
|
+
*/
|
|
1904
1927
|
ReportUrl?: string;
|
|
1905
1928
|
/**
|
|
1906
1929
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1912,9 +1935,9 @@ export interface CreateFlowEvidenceReportResponse {
|
|
|
1912
1935
|
*/
|
|
1913
1936
|
export interface DescribeFileUrlsResponse {
|
|
1914
1937
|
/**
|
|
1915
|
-
|
|
1938
|
+
* 文件URL信息;
|
|
1916
1939
|
链接不是永久链接,有效期5分钟后链接失效。
|
|
1917
|
-
|
|
1940
|
+
*/
|
|
1918
1941
|
FileUrls?: Array<FileUrl>;
|
|
1919
1942
|
/**
|
|
1920
1943
|
* URL数量
|
|
@@ -1959,64 +1982,64 @@ export interface CreateIntegrationDepartmentRequest {
|
|
|
1959
1982
|
*/
|
|
1960
1983
|
export interface GroupOrganization {
|
|
1961
1984
|
/**
|
|
1962
|
-
|
|
1985
|
+
* 成员企业名
|
|
1963
1986
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1964
|
-
|
|
1987
|
+
*/
|
|
1965
1988
|
Name?: string;
|
|
1966
1989
|
/**
|
|
1967
|
-
|
|
1990
|
+
* 成员企业别名
|
|
1968
1991
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1969
|
-
|
|
1992
|
+
*/
|
|
1970
1993
|
Alias?: string;
|
|
1971
1994
|
/**
|
|
1972
|
-
|
|
1995
|
+
* 成员企业id
|
|
1973
1996
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1974
|
-
|
|
1997
|
+
*/
|
|
1975
1998
|
OrganizationId?: string;
|
|
1976
1999
|
/**
|
|
1977
|
-
|
|
2000
|
+
* 更新时间,时间戳,单位秒
|
|
1978
2001
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1979
|
-
|
|
2002
|
+
*/
|
|
1980
2003
|
UpdateTime?: number;
|
|
1981
2004
|
/**
|
|
1982
|
-
|
|
2005
|
+
* 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
|
|
1983
2006
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1984
|
-
|
|
2007
|
+
*/
|
|
1985
2008
|
Status?: number;
|
|
1986
2009
|
/**
|
|
1987
|
-
|
|
2010
|
+
* 是否为集团主企业
|
|
1988
2011
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1989
|
-
|
|
2012
|
+
*/
|
|
1990
2013
|
IsMainOrganization?: boolean;
|
|
1991
2014
|
/**
|
|
1992
|
-
|
|
2015
|
+
* 企业社会信用代码
|
|
1993
2016
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1994
|
-
|
|
2017
|
+
*/
|
|
1995
2018
|
IdCardNumber?: string;
|
|
1996
2019
|
/**
|
|
1997
|
-
|
|
2020
|
+
* 企业超管信息
|
|
1998
2021
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1999
|
-
|
|
2022
|
+
*/
|
|
2000
2023
|
AdminInfo?: Admin;
|
|
2001
2024
|
/**
|
|
2002
|
-
|
|
2025
|
+
* 企业许可证
|
|
2003
2026
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2004
|
-
|
|
2027
|
+
*/
|
|
2005
2028
|
License?: string;
|
|
2006
2029
|
/**
|
|
2007
|
-
|
|
2030
|
+
* 企业许可证过期时间,时间戳,单位秒
|
|
2008
2031
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2009
|
-
|
|
2032
|
+
*/
|
|
2010
2033
|
LicenseExpireTime?: number;
|
|
2011
2034
|
/**
|
|
2012
|
-
|
|
2035
|
+
* 成员企业加入集团时间,时间戳,单位秒
|
|
2013
2036
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2014
|
-
|
|
2037
|
+
*/
|
|
2015
2038
|
JoinTime?: number;
|
|
2016
2039
|
/**
|
|
2017
|
-
|
|
2040
|
+
* 是否使用审批流引擎,true-是,false-否
|
|
2018
2041
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2019
|
-
|
|
2042
|
+
*/
|
|
2020
2043
|
FlowEngineEnable?: boolean;
|
|
2021
2044
|
}
|
|
2022
2045
|
/**
|
|
@@ -2057,9 +2080,9 @@ export interface CreateDocumentRequest {
|
|
|
2057
2080
|
*/
|
|
2058
2081
|
FormFields?: Array<FormField>;
|
|
2059
2082
|
/**
|
|
2060
|
-
|
|
2083
|
+
* 是否需要生成预览文件 默认不生成;
|
|
2061
2084
|
预览链接有效期300秒;
|
|
2062
|
-
|
|
2085
|
+
*/
|
|
2063
2086
|
NeedPreview?: boolean;
|
|
2064
2087
|
/**
|
|
2065
2088
|
* 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
|
|
@@ -2087,12 +2110,12 @@ export interface FlowDetailInfo {
|
|
|
2087
2110
|
*/
|
|
2088
2111
|
FlowName: string;
|
|
2089
2112
|
/**
|
|
2090
|
-
|
|
2113
|
+
* 合同(流程)的类型
|
|
2091
2114
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2092
|
-
|
|
2115
|
+
*/
|
|
2093
2116
|
FlowType: string;
|
|
2094
2117
|
/**
|
|
2095
|
-
|
|
2118
|
+
* 流程状态
|
|
2096
2119
|
- 0 还没有发起
|
|
2097
2120
|
- 1 待签署
|
|
2098
2121
|
- 2 部分签署
|
|
@@ -2105,17 +2128,17 @@ export interface FlowDetailInfo {
|
|
|
2105
2128
|
- 9 部分填写
|
|
2106
2129
|
- 10 拒填
|
|
2107
2130
|
- 21 已解除
|
|
2108
|
-
|
|
2131
|
+
*/
|
|
2109
2132
|
FlowStatus: number;
|
|
2110
2133
|
/**
|
|
2111
|
-
|
|
2134
|
+
* 合同(流程)的信息
|
|
2112
2135
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2113
|
-
|
|
2136
|
+
*/
|
|
2114
2137
|
FlowMessage: string;
|
|
2115
2138
|
/**
|
|
2116
|
-
|
|
2139
|
+
* 流程的描述
|
|
2117
2140
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2118
|
-
|
|
2141
|
+
*/
|
|
2119
2142
|
FlowDescription: string;
|
|
2120
2143
|
/**
|
|
2121
2144
|
* 合同(流程)的创建时间戳,单位秒
|
|
@@ -2130,9 +2153,9 @@ export interface FlowDetailInfo {
|
|
|
2130
2153
|
*/
|
|
2131
2154
|
CcInfos?: Array<FlowApproverDetail>;
|
|
2132
2155
|
/**
|
|
2133
|
-
|
|
2156
|
+
* 合同发起人UserId
|
|
2134
2157
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2135
|
-
|
|
2158
|
+
*/
|
|
2136
2159
|
Creator?: string;
|
|
2137
2160
|
}
|
|
2138
2161
|
/**
|
|
@@ -2221,10 +2244,12 @@ export interface GetTaskResultApiRequest {
|
|
|
2221
2244
|
Operator?: UserInfo;
|
|
2222
2245
|
/**
|
|
2223
2246
|
* 应用号信息
|
|
2247
|
+
* @deprecated
|
|
2224
2248
|
*/
|
|
2225
2249
|
Agent?: Agent;
|
|
2226
2250
|
/**
|
|
2227
2251
|
* 暂未开放
|
|
2252
|
+
* @deprecated
|
|
2228
2253
|
*/
|
|
2229
2254
|
Organization?: OrganizationInfo;
|
|
2230
2255
|
}
|
|
@@ -2297,6 +2322,7 @@ export interface CreateFlowSignUrlRequest {
|
|
|
2297
2322
|
Agent?: Agent;
|
|
2298
2323
|
/**
|
|
2299
2324
|
* 机构信息,暂未开放
|
|
2325
|
+
* @deprecated
|
|
2300
2326
|
*/
|
|
2301
2327
|
Organization?: OrganizationInfo;
|
|
2302
2328
|
}
|
|
@@ -2317,10 +2343,10 @@ export interface CreateReleaseFlowRequest {
|
|
|
2317
2343
|
*/
|
|
2318
2344
|
ReliveInfo: RelieveInfo;
|
|
2319
2345
|
/**
|
|
2320
|
-
|
|
2346
|
+
* 非必须,解除协议的本企业签署人列表,
|
|
2321
2347
|
默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
|
|
2322
2348
|
解除协议的签署人数量不能多于原流程的签署人数量
|
|
2323
|
-
|
|
2349
|
+
*/
|
|
2324
2350
|
ReleasedApprovers?: Array<ReleasedApprover>;
|
|
2325
2351
|
}
|
|
2326
2352
|
/**
|
|
@@ -2383,17 +2409,17 @@ export interface SuccessUpdateStaffData {
|
|
|
2383
2409
|
*/
|
|
2384
2410
|
export interface CreateFlowByFilesResponse {
|
|
2385
2411
|
/**
|
|
2386
|
-
|
|
2412
|
+
* 签署流程编号。
|
|
2387
2413
|
|
|
2388
2414
|
注:如入参 是否需要预览 NeedPreview 设置为 true,不会正式发起合同,此处不会有值返回;如入参 是否需要预览 NeedPreview 设置为 false,此处会正常返回签署流程编号 FlowId。
|
|
2389
|
-
|
|
2415
|
+
*/
|
|
2390
2416
|
FlowId?: string;
|
|
2391
2417
|
/**
|
|
2392
|
-
|
|
2418
|
+
* 合同预览链接。
|
|
2393
2419
|
|
|
2394
2420
|
注:如入参 是否需要预览 NeedPreview 设置为 true,会开启“预览模式”,此处会返回预览链接;如入参 是否需要预览 NeedPreview 设置为 false,此处不会有值返回。
|
|
2395
2421
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2396
|
-
|
|
2422
|
+
*/
|
|
2397
2423
|
PreviewUrl?: string;
|
|
2398
2424
|
/**
|
|
2399
2425
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2434,9 +2460,9 @@ export interface SuccessCreateStaffData {
|
|
|
2434
2460
|
*/
|
|
2435
2461
|
UserId: string;
|
|
2436
2462
|
/**
|
|
2437
|
-
|
|
2463
|
+
* 提示,当创建已存在未实名用户时,改字段有值
|
|
2438
2464
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2439
|
-
|
|
2465
|
+
*/
|
|
2440
2466
|
Note?: string;
|
|
2441
2467
|
}
|
|
2442
2468
|
/**
|
|
@@ -2514,14 +2540,14 @@ export interface VerifyPdfRequest {
|
|
|
2514
2540
|
*/
|
|
2515
2541
|
export interface FailedCreateRoleData {
|
|
2516
2542
|
/**
|
|
2517
|
-
|
|
2543
|
+
* 用户userId
|
|
2518
2544
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2519
|
-
|
|
2545
|
+
*/
|
|
2520
2546
|
UserId?: string;
|
|
2521
2547
|
/**
|
|
2522
|
-
|
|
2548
|
+
* 角色id列表
|
|
2523
2549
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2524
|
-
|
|
2550
|
+
*/
|
|
2525
2551
|
RoleIds?: Array<string>;
|
|
2526
2552
|
}
|
|
2527
2553
|
/**
|
|
@@ -2529,12 +2555,12 @@ export interface FailedCreateRoleData {
|
|
|
2529
2555
|
*/
|
|
2530
2556
|
export interface ApproverInfo {
|
|
2531
2557
|
/**
|
|
2532
|
-
|
|
2558
|
+
* 参与者类型:
|
|
2533
2559
|
0:企业
|
|
2534
2560
|
1:个人
|
|
2535
2561
|
3:企业静默签署
|
|
2536
2562
|
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
|
|
2537
|
-
|
|
2563
|
+
*/
|
|
2538
2564
|
ApproverType: number;
|
|
2539
2565
|
/**
|
|
2540
2566
|
* 签署人的姓名
|
|
@@ -2557,11 +2583,11 @@ export interface ApproverInfo {
|
|
|
2557
2583
|
*/
|
|
2558
2584
|
ApproverIdCardNumber?: string;
|
|
2559
2585
|
/**
|
|
2560
|
-
|
|
2586
|
+
* 签署人的身份证件类型
|
|
2561
2587
|
ID_CARD 身份证
|
|
2562
2588
|
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2563
2589
|
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
2564
|
-
|
|
2590
|
+
*/
|
|
2565
2591
|
ApproverIdCardType?: string;
|
|
2566
2592
|
/**
|
|
2567
2593
|
* 签署通知类型:sms--短信,none--不通知
|
|
@@ -2596,16 +2622,16 @@ export interface ApproverInfo {
|
|
|
2596
2622
|
*/
|
|
2597
2623
|
ApproverOption?: ApproverOption;
|
|
2598
2624
|
/**
|
|
2599
|
-
|
|
2625
|
+
* 签署人查看合同时认证方式,
|
|
2600
2626
|
1-实名查看 2-短信验证码查看(企业签署方不支持该方式)
|
|
2601
2627
|
如果不传默认为1
|
|
2602
|
-
|
|
2628
|
+
*/
|
|
2603
2629
|
ApproverVerifyTypes?: Array<number>;
|
|
2604
2630
|
/**
|
|
2605
|
-
|
|
2631
|
+
* 签署人签署合同时的认证方式
|
|
2606
2632
|
1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
|
|
2607
2633
|
合同签署认证方式的优先级 verifyChannel>approverSignTypes
|
|
2608
|
-
|
|
2634
|
+
*/
|
|
2609
2635
|
ApproverSignTypes?: Array<number>;
|
|
2610
2636
|
}
|
|
2611
2637
|
/**
|
|
@@ -2664,14 +2690,14 @@ export interface Filter {
|
|
|
2664
2690
|
*/
|
|
2665
2691
|
export interface CreateStaffResult {
|
|
2666
2692
|
/**
|
|
2667
|
-
|
|
2693
|
+
* 创建员工的成功列表
|
|
2668
2694
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2669
|
-
|
|
2695
|
+
*/
|
|
2670
2696
|
SuccessEmployeeData: Array<SuccessCreateStaffData>;
|
|
2671
2697
|
/**
|
|
2672
|
-
|
|
2698
|
+
* 创建员工的失败列表
|
|
2673
2699
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2674
|
-
|
|
2700
|
+
*/
|
|
2675
2701
|
FailedEmployeeData: Array<FailedCreateStaffData>;
|
|
2676
2702
|
}
|
|
2677
2703
|
/**
|
|
@@ -2683,9 +2709,9 @@ export interface CreateUserAutoSignEnableUrlRequest {
|
|
|
2683
2709
|
*/
|
|
2684
2710
|
Operator: UserInfo;
|
|
2685
2711
|
/**
|
|
2686
|
-
|
|
2712
|
+
* 自动签场景:
|
|
2687
2713
|
E_PRESCRIPTION_AUTO_SIGN 电子处方
|
|
2688
|
-
|
|
2714
|
+
*/
|
|
2689
2715
|
SceneKey: string;
|
|
2690
2716
|
/**
|
|
2691
2717
|
* 自动签开通,签署相关配置
|
|
@@ -2713,9 +2739,9 @@ export interface CreateUserAutoSignEnableUrlRequest {
|
|
|
2713
2739
|
*/
|
|
2714
2740
|
export interface DescribeIntegrationMainOrganizationUserResponse {
|
|
2715
2741
|
/**
|
|
2716
|
-
|
|
2742
|
+
* 主企业员工账号信息
|
|
2717
2743
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2718
|
-
|
|
2744
|
+
*/
|
|
2719
2745
|
IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser;
|
|
2720
2746
|
/**
|
|
2721
2747
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2752,9 +2778,9 @@ export interface CancelUserAutoSignEnableUrlRequest {
|
|
|
2752
2778
|
*/
|
|
2753
2779
|
SceneKey: string;
|
|
2754
2780
|
/**
|
|
2755
|
-
|
|
2781
|
+
* 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
|
|
2756
2782
|
|
|
2757
|
-
|
|
2783
|
+
*/
|
|
2758
2784
|
UserInfo: UserThreeFactor;
|
|
2759
2785
|
}
|
|
2760
2786
|
/**
|
|
@@ -2849,54 +2875,54 @@ export interface CreateFlowByFilesRequest {
|
|
|
2849
2875
|
*/
|
|
2850
2876
|
Components?: Array<Component>;
|
|
2851
2877
|
/**
|
|
2852
|
-
|
|
2878
|
+
* 被抄送人的信息列表。
|
|
2853
2879
|
注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
|
|
2854
|
-
|
|
2880
|
+
*/
|
|
2855
2881
|
CcInfos?: Array<CcInfo>;
|
|
2856
2882
|
/**
|
|
2857
|
-
|
|
2883
|
+
* 是否需要预览,true:预览模式,false:非预览(默认);
|
|
2858
2884
|
预览链接有效期300秒;
|
|
2859
2885
|
|
|
2860
2886
|
注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
|
|
2861
|
-
|
|
2887
|
+
*/
|
|
2862
2888
|
NeedPreview?: boolean;
|
|
2863
2889
|
/**
|
|
2864
2890
|
* 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
|
|
2865
2891
|
*/
|
|
2866
2892
|
PreviewType?: number;
|
|
2867
2893
|
/**
|
|
2868
|
-
|
|
2894
|
+
* 签署流程的签署截止时间。
|
|
2869
2895
|
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
2870
|
-
|
|
2896
|
+
*/
|
|
2871
2897
|
Deadline?: number;
|
|
2872
2898
|
/**
|
|
2873
|
-
|
|
2899
|
+
* 发送类型:
|
|
2874
2900
|
true:无序签
|
|
2875
2901
|
false:有序签
|
|
2876
2902
|
注:默认为false(有序签)
|
|
2877
|
-
|
|
2903
|
+
*/
|
|
2878
2904
|
Unordered?: boolean;
|
|
2879
2905
|
/**
|
|
2880
2906
|
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
2881
2907
|
*/
|
|
2882
2908
|
CustomShowMap?: string;
|
|
2883
2909
|
/**
|
|
2884
|
-
|
|
2910
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
2885
2911
|
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
2886
2912
|
|
|
2887
2913
|
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
2888
|
-
|
|
2914
|
+
*/
|
|
2889
2915
|
NeedSignReview?: boolean;
|
|
2890
2916
|
/**
|
|
2891
2917
|
* 用户自定义字段,回调的时候会进行透传,长度需要小于20480
|
|
2892
2918
|
*/
|
|
2893
2919
|
UserData?: string;
|
|
2894
2920
|
/**
|
|
2895
|
-
|
|
2921
|
+
* 签署人校验方式
|
|
2896
2922
|
VerifyCheck: 人脸识别(默认)
|
|
2897
2923
|
MobileCheck:手机号验证
|
|
2898
2924
|
参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
2899
|
-
|
|
2925
|
+
*/
|
|
2900
2926
|
ApproverVerifyType?: string;
|
|
2901
2927
|
/**
|
|
2902
2928
|
* 签署流程描述,最大长度1000个字符
|
|
@@ -2924,29 +2950,29 @@ export interface CreateFlowByFilesRequest {
|
|
|
2924
2950
|
*/
|
|
2925
2951
|
export interface IntegrateRole {
|
|
2926
2952
|
/**
|
|
2927
|
-
|
|
2953
|
+
* 角色id
|
|
2928
2954
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2929
|
-
|
|
2955
|
+
*/
|
|
2930
2956
|
RoleId?: string;
|
|
2931
2957
|
/**
|
|
2932
|
-
|
|
2958
|
+
* 角色名
|
|
2933
2959
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2934
|
-
|
|
2960
|
+
*/
|
|
2935
2961
|
RoleName?: string;
|
|
2936
2962
|
/**
|
|
2937
|
-
|
|
2963
|
+
* 角色状态,1-启用,2-禁用
|
|
2938
2964
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2939
|
-
|
|
2965
|
+
*/
|
|
2940
2966
|
RoleStatus?: number;
|
|
2941
2967
|
/**
|
|
2942
|
-
|
|
2968
|
+
* 是否是集团角色,true-是,false-否
|
|
2943
2969
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2944
|
-
|
|
2970
|
+
*/
|
|
2945
2971
|
IsGroupRole?: boolean;
|
|
2946
2972
|
/**
|
|
2947
|
-
|
|
2973
|
+
* 管辖的子企业列表
|
|
2948
2974
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2949
|
-
|
|
2975
|
+
*/
|
|
2950
2976
|
SubOrgIdList?: Array<string>;
|
|
2951
2977
|
}
|
|
2952
2978
|
/**
|
|
@@ -2971,24 +2997,24 @@ export interface GetTaskResultApiResponse {
|
|
|
2971
2997
|
*/
|
|
2972
2998
|
TaskId?: string;
|
|
2973
2999
|
/**
|
|
2974
|
-
|
|
3000
|
+
* 任务状态,需要关注的状态
|
|
2975
3001
|
0 :NeedTranform - 任务已提交
|
|
2976
3002
|
4 :Processing - 文档转换中
|
|
2977
3003
|
8 :TaskEnd - 任务处理完成
|
|
2978
3004
|
-2 :DownloadFailed - 下载失败
|
|
2979
3005
|
-6 :ProcessFailed - 转换失败
|
|
2980
3006
|
-13:ProcessTimeout - 转换文件超时
|
|
2981
|
-
|
|
3007
|
+
*/
|
|
2982
3008
|
TaskStatus?: number;
|
|
2983
3009
|
/**
|
|
2984
|
-
|
|
3010
|
+
* 状态描述,需要关注的状态
|
|
2985
3011
|
NeedTranform - 任务已提交
|
|
2986
3012
|
Processing - 文档转换中
|
|
2987
3013
|
TaskEnd - 任务处理完成
|
|
2988
3014
|
DownloadFailed - 下载失败
|
|
2989
3015
|
ProcessFailed - 转换失败
|
|
2990
3016
|
ProcessTimeout - 转换文件超时
|
|
2991
|
-
|
|
3017
|
+
*/
|
|
2992
3018
|
TaskMessage?: string;
|
|
2993
3019
|
/**
|
|
2994
3020
|
* 资源Id,也是FileId,用于文件发起使用
|
|
@@ -3055,19 +3081,19 @@ export interface ModifyApplicationCallbackInfoRequest {
|
|
|
3055
3081
|
*/
|
|
3056
3082
|
export interface IntegrationMainOrganizationUser {
|
|
3057
3083
|
/**
|
|
3058
|
-
|
|
3084
|
+
* 主企业id
|
|
3059
3085
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3060
|
-
|
|
3086
|
+
*/
|
|
3061
3087
|
MainOrganizationId?: string;
|
|
3062
3088
|
/**
|
|
3063
|
-
|
|
3089
|
+
* 主企业员工UserId
|
|
3064
3090
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3065
|
-
|
|
3091
|
+
*/
|
|
3066
3092
|
MainUserId?: string;
|
|
3067
3093
|
/**
|
|
3068
|
-
|
|
3094
|
+
* 主企业员工名
|
|
3069
3095
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3070
|
-
|
|
3096
|
+
*/
|
|
3071
3097
|
UserName?: string;
|
|
3072
3098
|
}
|
|
3073
3099
|
/**
|
|
@@ -3116,9 +3142,9 @@ export interface CreatePrepareFlowRequest {
|
|
|
3116
3142
|
*/
|
|
3117
3143
|
Unordered?: boolean;
|
|
3118
3144
|
/**
|
|
3119
|
-
|
|
3145
|
+
* 签署流程的签署截止时间。
|
|
3120
3146
|
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
3121
|
-
|
|
3147
|
+
*/
|
|
3122
3148
|
Deadline?: number;
|
|
3123
3149
|
/**
|
|
3124
3150
|
* 用户自定义合同类型
|
|
@@ -3155,9 +3181,9 @@ export interface FileUrl {
|
|
|
3155
3181
|
*/
|
|
3156
3182
|
Url: string;
|
|
3157
3183
|
/**
|
|
3158
|
-
|
|
3184
|
+
* 下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
|
|
3159
3185
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3160
|
-
|
|
3186
|
+
*/
|
|
3161
3187
|
Option: string;
|
|
3162
3188
|
}
|
|
3163
3189
|
/**
|
|
@@ -3218,14 +3244,14 @@ export interface DescribeOrganizationSealsRequest {
|
|
|
3218
3244
|
*/
|
|
3219
3245
|
SealId?: string;
|
|
3220
3246
|
/**
|
|
3221
|
-
|
|
3247
|
+
* 印章类型列表(都是组织机构印章)。
|
|
3222
3248
|
为空时查询所有类型的印章。
|
|
3223
3249
|
目前支持以下类型:
|
|
3224
3250
|
OFFICIAL:企业公章;
|
|
3225
3251
|
CONTRACT:合同专用章;
|
|
3226
3252
|
ORGANIZATION_SEAL:企业印章(图片上传创建);
|
|
3227
3253
|
LEGAL_PERSON_SEAL:法定代表人章
|
|
3228
|
-
|
|
3254
|
+
*/
|
|
3229
3255
|
SealTypes?: Array<string>;
|
|
3230
3256
|
/**
|
|
3231
3257
|
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
|
@@ -3271,7 +3297,7 @@ export interface UploadFile {
|
|
|
3271
3297
|
*/
|
|
3272
3298
|
export interface Component {
|
|
3273
3299
|
/**
|
|
3274
|
-
|
|
3300
|
+
* 如果是Component填写控件类型,则可选的字段为:
|
|
3275
3301
|
TEXT - 普通文本控件,输入文本字符串;
|
|
3276
3302
|
MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
|
|
3277
3303
|
CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
|
|
@@ -3292,7 +3318,7 @@ export interface Component {
|
|
|
3292
3318
|
SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
|
|
3293
3319
|
|
|
3294
3320
|
表单域的控件不能作为印章和签名控件
|
|
3295
|
-
|
|
3321
|
+
*/
|
|
3296
3322
|
ComponentType: string;
|
|
3297
3323
|
/**
|
|
3298
3324
|
* 控件所属文件的序号(取值为:0-N)。目前单文件的情况下,值是0
|
|
@@ -3335,7 +3361,7 @@ export interface Component {
|
|
|
3335
3361
|
*/
|
|
3336
3362
|
ComponentRecipientId?: string;
|
|
3337
3363
|
/**
|
|
3338
|
-
|
|
3364
|
+
* 扩展参数:
|
|
3339
3365
|
为JSON格式。
|
|
3340
3366
|
|
|
3341
3367
|
ComponentType为FILL_IMAGE时,支持以下参数:
|
|
@@ -3361,14 +3387,14 @@ export interface Component {
|
|
|
3361
3387
|
如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
|
|
3362
3388
|
特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
|
|
3363
3389
|
参数样例: "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
|
|
3364
|
-
|
|
3390
|
+
*/
|
|
3365
3391
|
ComponentExtra?: string;
|
|
3366
3392
|
/**
|
|
3367
3393
|
* 是否是表单域类型,默认不false-不是
|
|
3368
3394
|
*/
|
|
3369
3395
|
IsFormType?: boolean;
|
|
3370
3396
|
/**
|
|
3371
|
-
|
|
3397
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
3372
3398
|
TEXT - 文本内容
|
|
3373
3399
|
MULTI_LINE_TEXT - 文本内容
|
|
3374
3400
|
CHECK_BOX - true/false
|
|
@@ -3444,13 +3470,13 @@ export interface Component {
|
|
|
3444
3470
|
|
|
3445
3471
|
学历控件:
|
|
3446
3472
|
同单行文本控件约束,填写选择值中的字符串
|
|
3447
|
-
|
|
3473
|
+
*/
|
|
3448
3474
|
ComponentValue?: string;
|
|
3449
3475
|
/**
|
|
3450
|
-
|
|
3476
|
+
* NORMAL 正常模式,使用坐标制定签署控件位置
|
|
3451
3477
|
FIELD 表单域,需使用ComponentName指定表单域名称
|
|
3452
3478
|
KEYWORD 关键字,使用ComponentId指定关键字
|
|
3453
|
-
|
|
3479
|
+
*/
|
|
3454
3480
|
GenerateMode?: string;
|
|
3455
3481
|
/**
|
|
3456
3482
|
* 日期签署控件的字号,默认为 12
|
|
@@ -3473,9 +3499,9 @@ export interface Component {
|
|
|
3473
3499
|
*/
|
|
3474
3500
|
ChannelComponentSource?: number;
|
|
3475
3501
|
/**
|
|
3476
|
-
|
|
3502
|
+
* 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
|
|
3477
3503
|
传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
|
|
3478
|
-
|
|
3504
|
+
*/
|
|
3479
3505
|
KeywordOrder?: string;
|
|
3480
3506
|
/**
|
|
3481
3507
|
* 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
|
|
@@ -3495,29 +3521,29 @@ export interface Component {
|
|
|
3495
3521
|
*/
|
|
3496
3522
|
export interface IntegrationDepartment {
|
|
3497
3523
|
/**
|
|
3498
|
-
|
|
3524
|
+
* 部门ID
|
|
3499
3525
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3500
|
-
|
|
3526
|
+
*/
|
|
3501
3527
|
DeptId?: string;
|
|
3502
3528
|
/**
|
|
3503
|
-
|
|
3529
|
+
* 部门名
|
|
3504
3530
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3505
|
-
|
|
3531
|
+
*/
|
|
3506
3532
|
DeptName?: string;
|
|
3507
3533
|
/**
|
|
3508
|
-
|
|
3534
|
+
* 父部门ID
|
|
3509
3535
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3510
|
-
|
|
3536
|
+
*/
|
|
3511
3537
|
ParentDeptId?: string;
|
|
3512
3538
|
/**
|
|
3513
|
-
|
|
3539
|
+
* 客户系统部门ID
|
|
3514
3540
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3515
|
-
|
|
3541
|
+
*/
|
|
3516
3542
|
DeptOpenId?: string;
|
|
3517
3543
|
/**
|
|
3518
|
-
|
|
3544
|
+
* 序列号
|
|
3519
3545
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3520
|
-
|
|
3546
|
+
*/
|
|
3521
3547
|
OrderNo?: number;
|
|
3522
3548
|
}
|
|
3523
3549
|
/**
|
|
@@ -3648,14 +3674,14 @@ export interface VerifyPdfResponse {
|
|
|
3648
3674
|
*/
|
|
3649
3675
|
export interface DeleteStaffsResult {
|
|
3650
3676
|
/**
|
|
3651
|
-
|
|
3677
|
+
* 删除员工的成功数据
|
|
3652
3678
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3653
|
-
|
|
3679
|
+
*/
|
|
3654
3680
|
SuccessEmployeeData: Array<SuccessDeleteStaffData>;
|
|
3655
3681
|
/**
|
|
3656
|
-
|
|
3682
|
+
* 删除员工的失败数据
|
|
3657
3683
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3658
|
-
|
|
3684
|
+
*/
|
|
3659
3685
|
FailedEmployeeData: Array<FailedDeleteStaffData>;
|
|
3660
3686
|
}
|
|
3661
3687
|
/**
|
|
@@ -3676,14 +3702,14 @@ export interface DescribeFlowBriefsResponse {
|
|
|
3676
3702
|
*/
|
|
3677
3703
|
export interface Admin {
|
|
3678
3704
|
/**
|
|
3679
|
-
|
|
3705
|
+
* 超管名
|
|
3680
3706
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3681
|
-
|
|
3707
|
+
*/
|
|
3682
3708
|
Name?: string;
|
|
3683
3709
|
/**
|
|
3684
|
-
|
|
3710
|
+
* 超管手机号
|
|
3685
3711
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3686
|
-
|
|
3712
|
+
*/
|
|
3687
3713
|
Mobile?: string;
|
|
3688
3714
|
}
|
|
3689
3715
|
/**
|
|
@@ -3692,10 +3718,12 @@ export interface Admin {
|
|
|
3692
3718
|
export interface Caller {
|
|
3693
3719
|
/**
|
|
3694
3720
|
* 应用号
|
|
3721
|
+
* @deprecated
|
|
3695
3722
|
*/
|
|
3696
3723
|
ApplicationId?: string;
|
|
3697
3724
|
/**
|
|
3698
3725
|
* 主机构ID
|
|
3726
|
+
* @deprecated
|
|
3699
3727
|
*/
|
|
3700
3728
|
OrganizationId?: string;
|
|
3701
3729
|
/**
|
|
@@ -3704,6 +3732,7 @@ export interface Caller {
|
|
|
3704
3732
|
OperatorId?: string;
|
|
3705
3733
|
/**
|
|
3706
3734
|
* 下属机构ID
|
|
3735
|
+
* @deprecated
|
|
3707
3736
|
*/
|
|
3708
3737
|
SubOrganizationId?: string;
|
|
3709
3738
|
}
|
|
@@ -3729,11 +3758,11 @@ export interface DescribeFlowTemplatesResponse {
|
|
|
3729
3758
|
*/
|
|
3730
3759
|
export interface UploadFilesRequest {
|
|
3731
3760
|
/**
|
|
3732
|
-
|
|
3761
|
+
* 文件对应业务类型
|
|
3733
3762
|
1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
|
|
3734
3763
|
2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
|
|
3735
3764
|
3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
|
|
3736
|
-
|
|
3765
|
+
*/
|
|
3737
3766
|
BusinessType: string;
|
|
3738
3767
|
/**
|
|
3739
3768
|
* 调用方信息,其中OperatorId为必填字段,即用户的UserId
|
|
@@ -3744,15 +3773,15 @@ export interface UploadFilesRequest {
|
|
|
3744
3773
|
*/
|
|
3745
3774
|
FileInfos?: Array<UploadFile>;
|
|
3746
3775
|
/**
|
|
3747
|
-
|
|
3776
|
+
* 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
|
|
3748
3777
|
如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
|
|
3749
|
-
|
|
3778
|
+
*/
|
|
3750
3779
|
FileType?: string;
|
|
3751
3780
|
/**
|
|
3752
|
-
|
|
3781
|
+
* 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
|
|
3753
3782
|
true--是,处理置白
|
|
3754
3783
|
默认为false--否,不处理
|
|
3755
|
-
|
|
3784
|
+
*/
|
|
3756
3785
|
CoverRect?: boolean;
|
|
3757
3786
|
/**
|
|
3758
3787
|
* 用户自定义ID数组,与上传文件一一对应
|
|
@@ -3760,6 +3789,7 @@ export interface UploadFilesRequest {
|
|
|
3760
3789
|
CustomIds?: Array<string>;
|
|
3761
3790
|
/**
|
|
3762
3791
|
* 不再使用,上传文件链接数组,最多支持20个URL
|
|
3792
|
+
* @deprecated
|
|
3763
3793
|
*/
|
|
3764
3794
|
FileUrls?: string;
|
|
3765
3795
|
}
|
|
@@ -3772,24 +3802,24 @@ export interface RelieveInfo {
|
|
|
3772
3802
|
*/
|
|
3773
3803
|
Reason: string;
|
|
3774
3804
|
/**
|
|
3775
|
-
|
|
3805
|
+
* 解除后仍然有效的条款,保留条款,最大支持200个字
|
|
3776
3806
|
|
|
3777
|
-
|
|
3807
|
+
*/
|
|
3778
3808
|
RemainInForceItem?: string;
|
|
3779
3809
|
/**
|
|
3780
|
-
|
|
3810
|
+
* 原合同事项处理-费用结算,最大支持200个字
|
|
3781
3811
|
|
|
3782
|
-
|
|
3812
|
+
*/
|
|
3783
3813
|
OriginalExpenseSettlement?: string;
|
|
3784
3814
|
/**
|
|
3785
|
-
|
|
3815
|
+
* 原合同事项处理-其他事项,最大支持200个字
|
|
3786
3816
|
|
|
3787
|
-
|
|
3817
|
+
*/
|
|
3788
3818
|
OriginalOtherSettlement?: string;
|
|
3789
3819
|
/**
|
|
3790
|
-
|
|
3820
|
+
* 其他约定,最大支持200个字
|
|
3791
3821
|
|
|
3792
|
-
|
|
3822
|
+
*/
|
|
3793
3823
|
OtherDeals?: string;
|
|
3794
3824
|
}
|
|
3795
3825
|
/**
|
|
@@ -3822,9 +3852,9 @@ export interface CreateMultiFlowSignQRCodeRequest {
|
|
|
3822
3852
|
*/
|
|
3823
3853
|
FlowName: string;
|
|
3824
3854
|
/**
|
|
3825
|
-
|
|
3855
|
+
* 最大可发起签署流程份数,默认5份
|
|
3826
3856
|
发起流程数量超过此上限后二维码自动失效
|
|
3827
|
-
|
|
3857
|
+
*/
|
|
3828
3858
|
MaxFlowNum?: number;
|
|
3829
3859
|
/**
|
|
3830
3860
|
* 签署流程有效天数 默认7天 最高设置不超过30天
|
|
@@ -3843,17 +3873,19 @@ export interface CreateMultiFlowSignQRCodeRequest {
|
|
|
3843
3873
|
*/
|
|
3844
3874
|
UserData?: string;
|
|
3845
3875
|
/**
|
|
3846
|
-
|
|
3876
|
+
* 回调地址,最大长度1000字符串
|
|
3847
3877
|
回调时机:
|
|
3848
3878
|
用户通过签署二维码发起签署流程时,企业额度不足导致失败
|
|
3849
|
-
|
|
3879
|
+
*/
|
|
3850
3880
|
CallbackUrl?: string;
|
|
3851
3881
|
/**
|
|
3852
3882
|
* 应用信息
|
|
3883
|
+
* @deprecated
|
|
3853
3884
|
*/
|
|
3854
3885
|
Agent?: Agent;
|
|
3855
3886
|
/**
|
|
3856
3887
|
* 限制二维码用户条件(已弃用)
|
|
3888
|
+
* @deprecated
|
|
3857
3889
|
*/
|
|
3858
3890
|
ApproverRestrictions?: ApproverRestriction;
|
|
3859
3891
|
}
|
|
@@ -3918,9 +3950,9 @@ export interface DescribeUserAutoSignStatusRequest {
|
|
|
3918
3950
|
*/
|
|
3919
3951
|
Operator: UserInfo;
|
|
3920
3952
|
/**
|
|
3921
|
-
|
|
3953
|
+
* 自动签场景:
|
|
3922
3954
|
E_PRESCRIPTION_AUTO_SIGN 电子处方
|
|
3923
|
-
|
|
3955
|
+
*/
|
|
3924
3956
|
SceneKey: string;
|
|
3925
3957
|
/**
|
|
3926
3958
|
* 查询开启状态的用户信息
|
|
@@ -3933,9 +3965,9 @@ export interface DescribeUserAutoSignStatusRequest {
|
|
|
3933
3965
|
*/
|
|
3934
3966
|
export interface ReleasedApprover {
|
|
3935
3967
|
/**
|
|
3936
|
-
|
|
3968
|
+
* 签署人姓名,最大长度50个字符
|
|
3937
3969
|
|
|
3938
|
-
|
|
3970
|
+
*/
|
|
3939
3971
|
Name: string;
|
|
3940
3972
|
/**
|
|
3941
3973
|
* 签署人手机号
|
|
@@ -3946,10 +3978,10 @@ export interface ReleasedApprover {
|
|
|
3946
3978
|
*/
|
|
3947
3979
|
RelievedApproverReceiptId: string;
|
|
3948
3980
|
/**
|
|
3949
|
-
|
|
3981
|
+
* 指定签署人类型,目前仅支持
|
|
3950
3982
|
ORGANIZATION-企业
|
|
3951
3983
|
ENTERPRISESERVER-企业静默签
|
|
3952
|
-
|
|
3984
|
+
*/
|
|
3953
3985
|
ApproverType?: string;
|
|
3954
3986
|
}
|
|
3955
3987
|
/**
|
|
@@ -3965,16 +3997,16 @@ export interface FlowBrief {
|
|
|
3965
3997
|
*/
|
|
3966
3998
|
FlowName: string;
|
|
3967
3999
|
/**
|
|
3968
|
-
|
|
4000
|
+
* 流程的描述信息
|
|
3969
4001
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3970
|
-
|
|
4002
|
+
*/
|
|
3971
4003
|
FlowDescription: string;
|
|
3972
4004
|
/**
|
|
3973
4005
|
* 流程的类型
|
|
3974
4006
|
*/
|
|
3975
4007
|
FlowType: string;
|
|
3976
4008
|
/**
|
|
3977
|
-
|
|
4009
|
+
* 流程状态
|
|
3978
4010
|
- 0 还没有发起
|
|
3979
4011
|
- 1 待签署
|
|
3980
4012
|
- 2 部分签署
|
|
@@ -3988,27 +4020,27 @@ export interface FlowBrief {
|
|
|
3988
4020
|
- 10 拒填
|
|
3989
4021
|
- 21 已解除
|
|
3990
4022
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3991
|
-
|
|
4023
|
+
*/
|
|
3992
4024
|
FlowStatus: number;
|
|
3993
4025
|
/**
|
|
3994
|
-
|
|
4026
|
+
* 流程创建的时间戳,单位秒
|
|
3995
4027
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3996
|
-
|
|
4028
|
+
*/
|
|
3997
4029
|
CreatedOn: number;
|
|
3998
4030
|
/**
|
|
3999
|
-
|
|
4031
|
+
* 拒签或者取消的原因描述
|
|
4000
4032
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4001
|
-
|
|
4033
|
+
*/
|
|
4002
4034
|
FlowMessage: string;
|
|
4003
4035
|
/**
|
|
4004
|
-
|
|
4036
|
+
* 合同发起人userId
|
|
4005
4037
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4006
|
-
|
|
4038
|
+
*/
|
|
4007
4039
|
Creator?: string;
|
|
4008
4040
|
/**
|
|
4009
|
-
|
|
4041
|
+
* 合同过期时间,时间戳,单位秒
|
|
4010
4042
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4011
|
-
|
|
4043
|
+
*/
|
|
4012
4044
|
Deadline?: number;
|
|
4013
4045
|
}
|
|
4014
4046
|
/**
|
|
@@ -4016,29 +4048,29 @@ export interface FlowBrief {
|
|
|
4016
4048
|
*/
|
|
4017
4049
|
export interface DescribeOrganizationGroupOrganizationsResponse {
|
|
4018
4050
|
/**
|
|
4019
|
-
|
|
4051
|
+
* 查询到的符合条件的成员企业总数量
|
|
4020
4052
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4021
|
-
|
|
4053
|
+
*/
|
|
4022
4054
|
Total?: number;
|
|
4023
4055
|
/**
|
|
4024
|
-
|
|
4056
|
+
* 已授权待激活的企业数量
|
|
4025
4057
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4026
|
-
|
|
4058
|
+
*/
|
|
4027
4059
|
JoinedTotal?: number;
|
|
4028
4060
|
/**
|
|
4029
|
-
|
|
4061
|
+
* 已加入的企业数量
|
|
4030
4062
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4031
|
-
|
|
4063
|
+
*/
|
|
4032
4064
|
ActivedTotal?: number;
|
|
4033
4065
|
/**
|
|
4034
|
-
|
|
4066
|
+
* 导出文件的url
|
|
4035
4067
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4036
|
-
|
|
4068
|
+
*/
|
|
4037
4069
|
ExportUrl?: string;
|
|
4038
4070
|
/**
|
|
4039
|
-
|
|
4071
|
+
* 成员企业信息列表
|
|
4040
4072
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4041
|
-
|
|
4073
|
+
*/
|
|
4042
4074
|
List?: Array<GroupOrganization>;
|
|
4043
4075
|
/**
|
|
4044
4076
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -4058,15 +4090,15 @@ export interface CcInfo {
|
|
|
4058
4090
|
*/
|
|
4059
4091
|
Name?: string;
|
|
4060
4092
|
/**
|
|
4061
|
-
|
|
4093
|
+
* 被抄送人类型,
|
|
4062
4094
|
0--个人
|
|
4063
4095
|
1--员工
|
|
4064
|
-
|
|
4096
|
+
*/
|
|
4065
4097
|
CcType?: number;
|
|
4066
4098
|
/**
|
|
4067
|
-
|
|
4099
|
+
* 被抄送人权限
|
|
4068
4100
|
0--可查看
|
|
4069
4101
|
1--可查看也可下载
|
|
4070
|
-
|
|
4102
|
+
*/
|
|
4071
4103
|
CcPermission?: number;
|
|
4072
4104
|
}
|