tencentcloud-sdk-nodejs-essbasic 4.0.566 → 4.0.567
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 +364 -0
- package/SERVICE_CHANGELOG.md +522 -120
- package/package.json +1 -1
- package/products.md +26 -26
- package/src/services/essbasic/v20210526/essbasic_client.ts +49 -11
- package/src/services/essbasic/v20210526/essbasic_models.ts +472 -290
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +15 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +21 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +361 -206
|
@@ -406,6 +406,40 @@ export interface CreateConsoleLoginUrlResponse {
|
|
|
406
406
|
*/
|
|
407
407
|
RequestId?: string;
|
|
408
408
|
}
|
|
409
|
+
/**
|
|
410
|
+
* ChannelDeleteRoleUsers请求参数结构体
|
|
411
|
+
*/
|
|
412
|
+
export interface ChannelDeleteRoleUsersRequest {
|
|
413
|
+
/**
|
|
414
|
+
* 操作人信息
|
|
415
|
+
*/
|
|
416
|
+
Operator: UserInfo;
|
|
417
|
+
/**
|
|
418
|
+
* 角色Id
|
|
419
|
+
*/
|
|
420
|
+
RoleId: string;
|
|
421
|
+
/**
|
|
422
|
+
* 用户列表
|
|
423
|
+
*/
|
|
424
|
+
UserIds: Array<string>;
|
|
425
|
+
/**
|
|
426
|
+
* 代理信息
|
|
427
|
+
*/
|
|
428
|
+
Agent: Agent;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* ChannelCreateUserRoles返回参数结构体
|
|
432
|
+
*/
|
|
433
|
+
export interface ChannelCreateUserRolesResponse {
|
|
434
|
+
/**
|
|
435
|
+
* 绑定失败的用户角色列表
|
|
436
|
+
*/
|
|
437
|
+
FailedCreateRoleData?: Array<FailedCreateRoleData>;
|
|
438
|
+
/**
|
|
439
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
440
|
+
*/
|
|
441
|
+
RequestId?: string;
|
|
442
|
+
}
|
|
409
443
|
/**
|
|
410
444
|
* SyncProxyOrganization请求参数结构体
|
|
411
445
|
*/
|
|
@@ -660,29 +694,24 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
660
694
|
CcNotifyType?: number;
|
|
661
695
|
}
|
|
662
696
|
/**
|
|
663
|
-
*
|
|
697
|
+
* 渠道角色信息
|
|
664
698
|
*/
|
|
665
|
-
export interface
|
|
666
|
-
/**
|
|
667
|
-
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
668
|
-
*/
|
|
669
|
-
AppId: string;
|
|
670
|
-
/**
|
|
671
|
-
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
672
|
-
*/
|
|
673
|
-
ProxyOrganizationOpenId?: string;
|
|
699
|
+
export interface ChannelRole {
|
|
674
700
|
/**
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
701
|
+
* 角色id
|
|
702
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
703
|
+
*/
|
|
704
|
+
RoleId?: string;
|
|
678
705
|
/**
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
706
|
+
* 角色名
|
|
707
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
708
|
+
*/
|
|
709
|
+
RoleName?: string;
|
|
682
710
|
/**
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
711
|
+
* 角色状态:1-启用;2-禁用
|
|
712
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
713
|
+
*/
|
|
714
|
+
RoleStatus?: number;
|
|
686
715
|
}
|
|
687
716
|
/**
|
|
688
717
|
* 签署人的流程信息明细
|
|
@@ -739,29 +768,22 @@ export interface FlowApproverDetail {
|
|
|
739
768
|
ApproveType: string;
|
|
740
769
|
}
|
|
741
770
|
/**
|
|
742
|
-
*
|
|
771
|
+
* DescribeResourceUrlsByFlows返回参数结构体
|
|
743
772
|
*/
|
|
744
|
-
export interface
|
|
745
|
-
/**
|
|
746
|
-
* 解除理由,最大支持200个字
|
|
747
|
-
*/
|
|
748
|
-
Reason: string;
|
|
749
|
-
/**
|
|
750
|
-
* 解除后仍然有效的条款,保留条款,最大支持200个字
|
|
751
|
-
*/
|
|
752
|
-
RemainInForceItem?: string;
|
|
773
|
+
export interface DescribeResourceUrlsByFlowsResponse {
|
|
753
774
|
/**
|
|
754
|
-
*
|
|
775
|
+
* 签署流程资源对应链接信息
|
|
755
776
|
*/
|
|
756
|
-
|
|
777
|
+
FlowResourceUrlInfos?: Array<FlowResourceUrlInfo>;
|
|
757
778
|
/**
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
779
|
+
* 创建消息,对应多个合同ID,
|
|
780
|
+
成功为“”,创建失败则对应失败消息
|
|
781
|
+
*/
|
|
782
|
+
ErrorMessages?: Array<string>;
|
|
761
783
|
/**
|
|
762
|
-
*
|
|
784
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
763
785
|
*/
|
|
764
|
-
|
|
786
|
+
RequestId?: string;
|
|
765
787
|
}
|
|
766
788
|
/**
|
|
767
789
|
* ChannelCreateFlowGroupByFiles请求参数结构体
|
|
@@ -844,111 +866,31 @@ export interface ResourceUrlInfo {
|
|
|
844
866
|
Type: string;
|
|
845
867
|
}
|
|
846
868
|
/**
|
|
847
|
-
*
|
|
848
|
-
|
|
849
|
-
其中签署方FlowApproverInfo需要传递的参数
|
|
850
|
-
非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
|
|
851
|
-
1-个人:Name、Mobile必传
|
|
852
|
-
2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
853
|
-
3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;
|
|
854
|
-
4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
855
|
-
|
|
856
|
-
RecipientId参数:
|
|
857
|
-
从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
|
|
869
|
+
* ChannelDescribeRoles请求参数结构体
|
|
858
870
|
*/
|
|
859
|
-
export interface
|
|
860
|
-
/**
|
|
861
|
-
* 签署人姓名,最大长度50个字符
|
|
862
|
-
*/
|
|
863
|
-
Name?: string;
|
|
864
|
-
/**
|
|
865
|
-
* 签署人身份证件类型
|
|
866
|
-
1.ID_CARD 居民身份证
|
|
867
|
-
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
868
|
-
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
869
|
-
*/
|
|
870
|
-
IdCardType?: string;
|
|
871
|
-
/**
|
|
872
|
-
* 签署人证件号
|
|
873
|
-
*/
|
|
874
|
-
IdCardNumber?: string;
|
|
871
|
+
export interface ChannelDescribeRolesRequest {
|
|
875
872
|
/**
|
|
876
|
-
*
|
|
877
|
-
*/
|
|
878
|
-
Mobile?: string;
|
|
879
|
-
/**
|
|
880
|
-
* 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
873
|
+
* 操作人信息
|
|
881
874
|
*/
|
|
882
|
-
|
|
883
|
-
/**
|
|
884
|
-
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
885
|
-
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
886
|
-
*/
|
|
887
|
-
NotChannelOrganization?: boolean;
|
|
888
|
-
/**
|
|
889
|
-
* 用户侧第三方id,最大长度64个字符
|
|
890
|
-
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
891
|
-
*/
|
|
892
|
-
OpenId?: string;
|
|
875
|
+
Operator: UserInfo;
|
|
893
876
|
/**
|
|
894
|
-
*
|
|
877
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
895
878
|
*/
|
|
896
|
-
|
|
897
|
-
/**
|
|
898
|
-
* 签署人类型
|
|
899
|
-
PERSON-个人/自然人;
|
|
900
|
-
PERSON_AUTO_SIGN-个人自动签(定制化场景下使用);
|
|
901
|
-
ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
|
|
902
|
-
ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
|
|
903
|
-
*/
|
|
904
|
-
ApproverType?: string;
|
|
905
|
-
/**
|
|
906
|
-
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
907
|
-
*/
|
|
908
|
-
RecipientId?: string;
|
|
909
|
-
/**
|
|
910
|
-
* 签署截止时间,默认一年
|
|
911
|
-
*/
|
|
912
|
-
Deadline?: number;
|
|
913
|
-
/**
|
|
914
|
-
* 签署完回调url,最大长度1000个字符
|
|
915
|
-
*/
|
|
916
|
-
CallbackUrl?: string;
|
|
917
|
-
/**
|
|
918
|
-
* 使用PDF文件直接发起合同时,签署人指定的签署控件
|
|
919
|
-
*/
|
|
920
|
-
SignComponents?: Array<Component>;
|
|
921
|
-
/**
|
|
922
|
-
* 个人签署方指定签署控件类型,目前支持:OCR_ESIGN -AI智慧手写签名
|
|
923
|
-
HANDWRITE -手写签名
|
|
924
|
-
*/
|
|
925
|
-
ComponentLimitType?: Array<string>;
|
|
926
|
-
/**
|
|
927
|
-
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
928
|
-
*/
|
|
929
|
-
PreReadTime?: number;
|
|
930
|
-
/**
|
|
931
|
-
* 签署完前端跳转的url,暂未使用
|
|
932
|
-
*/
|
|
933
|
-
JumpUrl?: string;
|
|
879
|
+
Agent: Agent;
|
|
934
880
|
/**
|
|
935
|
-
*
|
|
881
|
+
* 查询起始偏移,最大2000
|
|
936
882
|
*/
|
|
937
|
-
|
|
883
|
+
Offset: number;
|
|
938
884
|
/**
|
|
939
|
-
*
|
|
885
|
+
* 查询数量,最大200
|
|
940
886
|
*/
|
|
941
|
-
|
|
942
|
-
/**
|
|
943
|
-
* 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
|
|
944
|
-
查看合同的签署方式 Flow层级的优先于approver层级的
|
|
945
|
-
*/
|
|
946
|
-
ApproverVerifyTypes?: Array<number>;
|
|
887
|
+
Limit: string;
|
|
947
888
|
/**
|
|
948
|
-
*
|
|
949
|
-
1
|
|
889
|
+
* 查询的关键字段:
|
|
890
|
+
Key:"RoleType",Vales:["1"]查询系统角色,Values:["2]查询自定义角色
|
|
891
|
+
Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
|
|
950
892
|
*/
|
|
951
|
-
|
|
893
|
+
Filters?: Array<Filter>;
|
|
952
894
|
}
|
|
953
895
|
/**
|
|
954
896
|
* PrepareFlows返回参数结构体
|
|
@@ -1050,6 +992,31 @@ export interface GetDownloadFlowUrlResponse {
|
|
|
1050
992
|
*/
|
|
1051
993
|
RequestId?: string;
|
|
1052
994
|
}
|
|
995
|
+
/**
|
|
996
|
+
* 应用相关信息
|
|
997
|
+
*/
|
|
998
|
+
export interface Agent {
|
|
999
|
+
/**
|
|
1000
|
+
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
1001
|
+
*/
|
|
1002
|
+
AppId: string;
|
|
1003
|
+
/**
|
|
1004
|
+
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
1005
|
+
*/
|
|
1006
|
+
ProxyOrganizationOpenId?: string;
|
|
1007
|
+
/**
|
|
1008
|
+
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
1009
|
+
*/
|
|
1010
|
+
ProxyOperator?: UserInfo;
|
|
1011
|
+
/**
|
|
1012
|
+
* 在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
1013
|
+
*/
|
|
1014
|
+
ProxyAppId?: string;
|
|
1015
|
+
/**
|
|
1016
|
+
* 内部参数,暂未开放使用
|
|
1017
|
+
*/
|
|
1018
|
+
ProxyOrganizationId?: string;
|
|
1019
|
+
}
|
|
1053
1020
|
/**
|
|
1054
1021
|
* 签署参与者信息
|
|
1055
1022
|
*/
|
|
@@ -1136,7 +1103,7 @@ export interface StaffRole {
|
|
|
1136
1103
|
*/
|
|
1137
1104
|
export interface ChannelVerifyPdfRequest {
|
|
1138
1105
|
/**
|
|
1139
|
-
*
|
|
1106
|
+
* 流程ID
|
|
1140
1107
|
*/
|
|
1141
1108
|
FlowId: string;
|
|
1142
1109
|
/**
|
|
@@ -1174,9 +1141,8 @@ export interface ChannelVerifyPdfResponse {
|
|
|
1174
1141
|
*/
|
|
1175
1142
|
VerifyResult?: number;
|
|
1176
1143
|
/**
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
*/
|
|
1144
|
+
* 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
|
|
1145
|
+
*/
|
|
1180
1146
|
PdfVerifyResults?: Array<PdfVerifyResult>;
|
|
1181
1147
|
/**
|
|
1182
1148
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1258,6 +1224,78 @@ export interface OrganizationInfo {
|
|
|
1258
1224
|
*/
|
|
1259
1225
|
Channel?: string;
|
|
1260
1226
|
}
|
|
1227
|
+
/**
|
|
1228
|
+
* 签署链接内容
|
|
1229
|
+
*/
|
|
1230
|
+
export interface SignUrlInfo {
|
|
1231
|
+
/**
|
|
1232
|
+
* 签署链接,过期时间为30天
|
|
1233
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1234
|
+
*/
|
|
1235
|
+
SignUrl: string;
|
|
1236
|
+
/**
|
|
1237
|
+
* 合同过期时间
|
|
1238
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1239
|
+
*/
|
|
1240
|
+
Deadline: number;
|
|
1241
|
+
/**
|
|
1242
|
+
* 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
|
|
1243
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1244
|
+
*/
|
|
1245
|
+
SignOrder: number;
|
|
1246
|
+
/**
|
|
1247
|
+
* 签署人编号
|
|
1248
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1249
|
+
*/
|
|
1250
|
+
SignId: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* 自定义用户编号
|
|
1253
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1254
|
+
*/
|
|
1255
|
+
CustomUserId: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* 用户姓名
|
|
1258
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1259
|
+
*/
|
|
1260
|
+
Name: string;
|
|
1261
|
+
/**
|
|
1262
|
+
* 用户手机号码
|
|
1263
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1264
|
+
*/
|
|
1265
|
+
Mobile: string;
|
|
1266
|
+
/**
|
|
1267
|
+
* 签署参与者机构名字
|
|
1268
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1269
|
+
*/
|
|
1270
|
+
OrganizationName: string;
|
|
1271
|
+
/**
|
|
1272
|
+
* 参与者类型:
|
|
1273
|
+
ORGANIZATION 企业经办人
|
|
1274
|
+
PERSON 自然人
|
|
1275
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1276
|
+
*/
|
|
1277
|
+
ApproverType: string;
|
|
1278
|
+
/**
|
|
1279
|
+
* 经办人身份证号
|
|
1280
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1281
|
+
*/
|
|
1282
|
+
IdCardNumber: string;
|
|
1283
|
+
/**
|
|
1284
|
+
* 签署链接对应流程Id
|
|
1285
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1286
|
+
*/
|
|
1287
|
+
FlowId: string;
|
|
1288
|
+
/**
|
|
1289
|
+
* 企业经办人 用户在渠道的编号
|
|
1290
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1291
|
+
*/
|
|
1292
|
+
OpenId: string;
|
|
1293
|
+
/**
|
|
1294
|
+
* 合同组签署链接对应的合同组id
|
|
1295
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1296
|
+
*/
|
|
1297
|
+
FlowGroupId: string;
|
|
1298
|
+
}
|
|
1261
1299
|
/**
|
|
1262
1300
|
* 通用签署人信息
|
|
1263
1301
|
*/
|
|
@@ -1870,18 +1908,13 @@ export interface AuthorizedUser {
|
|
|
1870
1908
|
OpenId: string;
|
|
1871
1909
|
}
|
|
1872
1910
|
/**
|
|
1873
|
-
*
|
|
1911
|
+
* ChannelDeleteRoleUsers返回参数结构体
|
|
1874
1912
|
*/
|
|
1875
|
-
export interface
|
|
1913
|
+
export interface ChannelDeleteRoleUsersResponse {
|
|
1876
1914
|
/**
|
|
1877
|
-
*
|
|
1915
|
+
* 角色id
|
|
1878
1916
|
*/
|
|
1879
|
-
|
|
1880
|
-
/**
|
|
1881
|
-
* 创建消息,对应多个合同ID,
|
|
1882
|
-
成功为“”,创建失败则对应失败消息
|
|
1883
|
-
*/
|
|
1884
|
-
ErrorMessages?: Array<string>;
|
|
1917
|
+
RoleId?: string;
|
|
1885
1918
|
/**
|
|
1886
1919
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1887
1920
|
*/
|
|
@@ -2036,6 +2069,113 @@ export interface SignQrCode {
|
|
|
2036
2069
|
*/
|
|
2037
2070
|
ExpiredTime: number;
|
|
2038
2071
|
}
|
|
2072
|
+
/**
|
|
2073
|
+
* 创建签署流程签署人入参。
|
|
2074
|
+
|
|
2075
|
+
其中签署方FlowApproverInfo需要传递的参数
|
|
2076
|
+
非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
|
|
2077
|
+
1-个人:Name、Mobile必传
|
|
2078
|
+
2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
2079
|
+
3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;
|
|
2080
|
+
4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
2081
|
+
|
|
2082
|
+
RecipientId参数:
|
|
2083
|
+
从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
|
|
2084
|
+
*/
|
|
2085
|
+
export interface FlowApproverInfo {
|
|
2086
|
+
/**
|
|
2087
|
+
* 签署人姓名,最大长度50个字符
|
|
2088
|
+
*/
|
|
2089
|
+
Name?: string;
|
|
2090
|
+
/**
|
|
2091
|
+
* 签署人身份证件类型
|
|
2092
|
+
1.ID_CARD 居民身份证
|
|
2093
|
+
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2094
|
+
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2095
|
+
*/
|
|
2096
|
+
IdCardType?: string;
|
|
2097
|
+
/**
|
|
2098
|
+
* 签署人证件号
|
|
2099
|
+
*/
|
|
2100
|
+
IdCardNumber?: string;
|
|
2101
|
+
/**
|
|
2102
|
+
* 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
|
|
2103
|
+
*/
|
|
2104
|
+
Mobile?: string;
|
|
2105
|
+
/**
|
|
2106
|
+
* 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
2107
|
+
*/
|
|
2108
|
+
OrganizationName?: string;
|
|
2109
|
+
/**
|
|
2110
|
+
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
2111
|
+
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
2112
|
+
*/
|
|
2113
|
+
NotChannelOrganization?: boolean;
|
|
2114
|
+
/**
|
|
2115
|
+
* 用户侧第三方id,最大长度64个字符
|
|
2116
|
+
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
2117
|
+
*/
|
|
2118
|
+
OpenId?: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
2121
|
+
*/
|
|
2122
|
+
OrganizationOpenId?: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* 签署人类型
|
|
2125
|
+
PERSON-个人/自然人;
|
|
2126
|
+
PERSON_AUTO_SIGN-个人自动签(定制化场景下使用);
|
|
2127
|
+
ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
|
|
2128
|
+
ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
|
|
2129
|
+
*/
|
|
2130
|
+
ApproverType?: string;
|
|
2131
|
+
/**
|
|
2132
|
+
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
2133
|
+
*/
|
|
2134
|
+
RecipientId?: string;
|
|
2135
|
+
/**
|
|
2136
|
+
* 签署截止时间,默认一年
|
|
2137
|
+
*/
|
|
2138
|
+
Deadline?: number;
|
|
2139
|
+
/**
|
|
2140
|
+
* 签署完回调url,最大长度1000个字符
|
|
2141
|
+
*/
|
|
2142
|
+
CallbackUrl?: string;
|
|
2143
|
+
/**
|
|
2144
|
+
* 使用PDF文件直接发起合同时,签署人指定的签署控件
|
|
2145
|
+
*/
|
|
2146
|
+
SignComponents?: Array<Component>;
|
|
2147
|
+
/**
|
|
2148
|
+
* 个人签署方指定签署控件类型,目前支持:OCR_ESIGN -AI智慧手写签名
|
|
2149
|
+
HANDWRITE -手写签名
|
|
2150
|
+
*/
|
|
2151
|
+
ComponentLimitType?: Array<string>;
|
|
2152
|
+
/**
|
|
2153
|
+
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
2154
|
+
*/
|
|
2155
|
+
PreReadTime?: number;
|
|
2156
|
+
/**
|
|
2157
|
+
* 签署完前端跳转的url,暂未使用
|
|
2158
|
+
*/
|
|
2159
|
+
JumpUrl?: string;
|
|
2160
|
+
/**
|
|
2161
|
+
* 签署人个性化能力值
|
|
2162
|
+
*/
|
|
2163
|
+
ApproverOption?: ApproverOption;
|
|
2164
|
+
/**
|
|
2165
|
+
* 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
|
|
2166
|
+
*/
|
|
2167
|
+
ApproverNeedSignReview?: boolean;
|
|
2168
|
+
/**
|
|
2169
|
+
* 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
|
|
2170
|
+
查看合同的签署方式 Flow层级的优先于approver层级的
|
|
2171
|
+
*/
|
|
2172
|
+
ApproverVerifyTypes?: Array<number>;
|
|
2173
|
+
/**
|
|
2174
|
+
* 签署人签署合同时的认证方式
|
|
2175
|
+
1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
|
|
2176
|
+
*/
|
|
2177
|
+
ApproverSignTypes?: Array<number>;
|
|
2178
|
+
}
|
|
2039
2179
|
/**
|
|
2040
2180
|
* ChannelGetTaskResultApi请求参数结构体
|
|
2041
2181
|
*/
|
|
@@ -2172,76 +2312,19 @@ export interface SyncProxyOrganizationOperatorsResponse {
|
|
|
2172
2312
|
RequestId?: string;
|
|
2173
2313
|
}
|
|
2174
2314
|
/**
|
|
2175
|
-
*
|
|
2315
|
+
* 绑定失败的用户角色信息
|
|
2176
2316
|
*/
|
|
2177
|
-
export interface
|
|
2178
|
-
/**
|
|
2179
|
-
* 签署链接,过期时间为30天
|
|
2180
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2181
|
-
*/
|
|
2182
|
-
SignUrl: string;
|
|
2183
|
-
/**
|
|
2184
|
-
* 合同过期时间
|
|
2185
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2186
|
-
*/
|
|
2187
|
-
Deadline: number;
|
|
2188
|
-
/**
|
|
2189
|
-
* 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
|
|
2190
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2191
|
-
*/
|
|
2192
|
-
SignOrder: number;
|
|
2193
|
-
/**
|
|
2194
|
-
* 签署人编号
|
|
2195
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2196
|
-
*/
|
|
2197
|
-
SignId: string;
|
|
2198
|
-
/**
|
|
2199
|
-
* 自定义用户编号
|
|
2200
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2201
|
-
*/
|
|
2202
|
-
CustomUserId: string;
|
|
2203
|
-
/**
|
|
2204
|
-
* 用户姓名
|
|
2205
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2206
|
-
*/
|
|
2207
|
-
Name: string;
|
|
2208
|
-
/**
|
|
2209
|
-
* 用户手机号码
|
|
2210
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2211
|
-
*/
|
|
2212
|
-
Mobile: string;
|
|
2213
|
-
/**
|
|
2214
|
-
* 签署参与者机构名字
|
|
2215
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2216
|
-
*/
|
|
2217
|
-
OrganizationName: string;
|
|
2317
|
+
export interface FailedCreateRoleData {
|
|
2218
2318
|
/**
|
|
2219
|
-
*
|
|
2220
|
-
ORGANIZATION 企业经办人
|
|
2221
|
-
PERSON 自然人
|
|
2222
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2223
|
-
*/
|
|
2224
|
-
ApproverType: string;
|
|
2225
|
-
/**
|
|
2226
|
-
* 经办人身份证号
|
|
2319
|
+
* 用户userId
|
|
2227
2320
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2228
2321
|
*/
|
|
2229
|
-
|
|
2230
|
-
/**
|
|
2231
|
-
* 签署链接对应流程Id
|
|
2232
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2233
|
-
*/
|
|
2234
|
-
FlowId: string;
|
|
2235
|
-
/**
|
|
2236
|
-
* 企业经办人 用户在渠道的编号
|
|
2237
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2238
|
-
*/
|
|
2239
|
-
OpenId: string;
|
|
2322
|
+
UserId?: string;
|
|
2240
2323
|
/**
|
|
2241
|
-
*
|
|
2324
|
+
* 角色RoleId列表
|
|
2242
2325
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2243
2326
|
*/
|
|
2244
|
-
|
|
2327
|
+
RoleIds?: Array<string>;
|
|
2245
2328
|
}
|
|
2246
2329
|
/**
|
|
2247
2330
|
* 流程对应资源链接信息
|
|
@@ -2534,6 +2617,32 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
|
|
|
2534
2617
|
*/
|
|
2535
2618
|
RequestId?: string;
|
|
2536
2619
|
}
|
|
2620
|
+
/**
|
|
2621
|
+
* ChannelDescribeRoles返回参数结构体
|
|
2622
|
+
*/
|
|
2623
|
+
export interface ChannelDescribeRolesResponse {
|
|
2624
|
+
/**
|
|
2625
|
+
* 页面偏移量,最大2000
|
|
2626
|
+
*/
|
|
2627
|
+
Offset?: number;
|
|
2628
|
+
/**
|
|
2629
|
+
* 查询数量,最大200
|
|
2630
|
+
*/
|
|
2631
|
+
Limit?: number;
|
|
2632
|
+
/**
|
|
2633
|
+
* 查询角色的总数量
|
|
2634
|
+
*/
|
|
2635
|
+
TotalCount?: number;
|
|
2636
|
+
/**
|
|
2637
|
+
* 角色信息
|
|
2638
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2639
|
+
*/
|
|
2640
|
+
ChannelRoles?: Array<ChannelRole>;
|
|
2641
|
+
/**
|
|
2642
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2643
|
+
*/
|
|
2644
|
+
RequestId?: string;
|
|
2645
|
+
}
|
|
2537
2646
|
/**
|
|
2538
2647
|
* ChannelCreateReleaseFlow请求参数结构体
|
|
2539
2648
|
*/
|
|
@@ -2673,6 +2782,27 @@ export interface ModifyExtendedServiceResponse {
|
|
|
2673
2782
|
*/
|
|
2674
2783
|
RequestId?: string;
|
|
2675
2784
|
}
|
|
2785
|
+
/**
|
|
2786
|
+
* ChannelCreateUserRoles请求参数结构体
|
|
2787
|
+
*/
|
|
2788
|
+
export interface ChannelCreateUserRolesRequest {
|
|
2789
|
+
/**
|
|
2790
|
+
* 操作者信息
|
|
2791
|
+
*/
|
|
2792
|
+
Operator: UserInfo;
|
|
2793
|
+
/**
|
|
2794
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
2795
|
+
*/
|
|
2796
|
+
Agent: Agent;
|
|
2797
|
+
/**
|
|
2798
|
+
* 绑定角色的员工id列表
|
|
2799
|
+
*/
|
|
2800
|
+
UserIds: Array<string>;
|
|
2801
|
+
/**
|
|
2802
|
+
* 绑定角色的角色id列表
|
|
2803
|
+
*/
|
|
2804
|
+
RoleIds: Array<string>;
|
|
2805
|
+
}
|
|
2676
2806
|
/**
|
|
2677
2807
|
* ChannelGetTaskResultApi返回参数结构体
|
|
2678
2808
|
*/
|
|
@@ -3147,6 +3277,31 @@ export interface DescribeTemplatesRequest {
|
|
|
3147
3277
|
*/
|
|
3148
3278
|
ChannelTemplateId?: string;
|
|
3149
3279
|
}
|
|
3280
|
+
/**
|
|
3281
|
+
* 解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
|
|
3282
|
+
*/
|
|
3283
|
+
export interface RelieveInfo {
|
|
3284
|
+
/**
|
|
3285
|
+
* 解除理由,最大支持200个字
|
|
3286
|
+
*/
|
|
3287
|
+
Reason: string;
|
|
3288
|
+
/**
|
|
3289
|
+
* 解除后仍然有效的条款,保留条款,最大支持200个字
|
|
3290
|
+
*/
|
|
3291
|
+
RemainInForceItem?: string;
|
|
3292
|
+
/**
|
|
3293
|
+
* 原合同事项处理-费用结算,最大支持200个字
|
|
3294
|
+
*/
|
|
3295
|
+
OriginalExpenseSettlement?: string;
|
|
3296
|
+
/**
|
|
3297
|
+
* 原合同事项处理-其他事项,最大支持200个字
|
|
3298
|
+
*/
|
|
3299
|
+
OriginalOtherSettlement?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* 其他约定,最大支持200个字
|
|
3302
|
+
*/
|
|
3303
|
+
OtherDeals?: string;
|
|
3304
|
+
}
|
|
3150
3305
|
/**
|
|
3151
3306
|
* ChannelCreateSealPolicy请求参数结构体
|
|
3152
3307
|
*/
|