tencentcloud-sdk-nodejs-ess 4.0.612 → 4.0.613

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.
@@ -94,11 +94,6 @@ export interface CreatePreparedPersonalEsignRequest {
94
94
  */
95
95
  SealName: string
96
96
 
97
- /**
98
- * 印章图片的base64,最大不超过 8M
99
- */
100
- SealImage: string
101
-
102
97
  /**
103
98
  * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
104
99
  */
@@ -114,6 +109,13 @@ HONGKONG_MACAO_AND_TAIWAN 中国台湾
114
109
  */
115
110
  IdCardType?: string
116
111
 
112
+ /**
113
+ * 印章图片的base64
114
+ 注:已废弃
115
+ 请先通过UploadFiles接口上传文件,获取 FileId
116
+ */
117
+ SealImage?: string
118
+
117
119
  /**
118
120
  * 是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。
119
121
  */
@@ -146,6 +148,13 @@ BLUE 蓝色。
146
148
  true:做透明化处理和颜色增强。
147
149
  */
148
150
  ProcessSeal?: boolean
151
+
152
+ /**
153
+ * 印章图片文件 id
154
+ 取值:
155
+ 填写的FileId通过UploadFiles接口上传文件获取。
156
+ */
157
+ FileId?: string
149
158
  }
150
159
 
151
160
  /**
@@ -728,6 +737,16 @@ export interface DescribeFlowTemplatesRequest {
728
737
  */
729
738
  Agent?: Agent
730
739
 
740
+ /**
741
+ * 查询内容:0-模板列表及详情(默认),1-仅模板列表
742
+ */
743
+ ContentType?: number
744
+
745
+ /**
746
+ * 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
747
+ */
748
+ Filters?: Array<Filter>
749
+
731
750
  /**
732
751
  * 查询偏移位置,默认0
733
752
  */
@@ -738,11 +757,6 @@ export interface DescribeFlowTemplatesRequest {
738
757
  */
739
758
  Limit?: number
740
759
 
741
- /**
742
- * 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
743
- */
744
- Filters?: Array<Filter>
745
-
746
760
  /**
747
761
  * 这个参数跟下面的IsChannel参数配合使用。
748
762
  IsChannel=false时,ApplicationId参数不起任何作用。
@@ -757,11 +771,6 @@ ApplicationId为空,查询所有应用下的模板列表
757
771
  */
758
772
  IsChannel?: boolean
759
773
 
760
- /**
761
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
762
- */
763
- ContentType?: number
764
-
765
774
  /**
766
775
  * 暂未开放
767
776
  */
@@ -806,13 +815,23 @@ export interface CallbackInfo {
806
815
  CallbackUrl: string
807
816
 
808
817
  /**
809
- * 回调加密token
818
+ * 回调加密key,已废弃
810
819
  */
811
- Token: string
820
+ Token?: string
821
+
822
+ /**
823
+ * 回调加密key
824
+ */
825
+ CallbackKey?: string
826
+
827
+ /**
828
+ * 回调验签token
829
+ */
830
+ CallbackToken?: string
812
831
  }
813
832
 
814
833
  /**
815
- * 二期接口返回的模板的信息结构
834
+ * 企业模板的信息结构
816
835
  */
817
836
  export interface TemplateInfo {
818
837
  /**
@@ -831,7 +850,7 @@ export interface TemplateInfo {
831
850
  Description?: string
832
851
 
833
852
  /**
834
- * 模板关联的资源IDs
853
+ * 模板关联的资源ID列表
835
854
  */
836
855
  DocumentResourceIds?: Array<string>
837
856
 
@@ -841,7 +860,7 @@ export interface TemplateInfo {
841
860
  FileInfos?: Array<FileInfo>
842
861
 
843
862
  /**
844
- * 附件关联的资源ID
863
+ * 附件关联的资源ID
845
864
  */
846
865
  AttachmentResourceIds?: Array<string>
847
866
 
@@ -871,12 +890,12 @@ export interface TemplateInfo {
871
890
  Status?: number
872
891
 
873
892
  /**
874
- * 模板的创建人
893
+ * 模板的创建人UserId
875
894
  */
876
895
  Creator?: string
877
896
 
878
897
  /**
879
- * 模板创建的时间戳(精确到秒)
898
+ * 模板创建的时间戳,单位秒
880
899
  */
881
900
  CreatedOn?: number
882
901
 
@@ -899,12 +918,12 @@ export interface TemplateInfo {
899
918
  Available?: number
900
919
 
901
920
  /**
902
- * 模板创建组织id
921
+ * 创建模板的机构id
903
922
  */
904
923
  OrganizationId?: string
905
924
 
906
925
  /**
907
- * 模板预览链接
926
+ * 模板预览链接,有效时间5分钟
908
927
  注意:此字段可能返回 null,表示取不到有效值。
909
928
  */
910
929
  PreviewUrl?: string
@@ -957,6 +976,11 @@ export interface DescribeIntegrationEmployeesRequest {
957
976
  */
958
977
  Limit: number
959
978
 
979
+ /**
980
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
981
+ */
982
+ Agent?: Agent
983
+
960
984
  /**
961
985
  * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
962
986
  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
@@ -1211,7 +1235,7 @@ export interface CreateReleaseFlowResponse {
1211
1235
  */
1212
1236
  export interface BindEmployeeUserIdWithClientOpenIdRequest {
1213
1237
  /**
1214
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定
1238
+ * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定。(参数参考示例)
1215
1239
  */
1216
1240
  Operator: UserInfo
1217
1241
 
@@ -1328,12 +1352,12 @@ export interface OccupiedSeal {
1328
1352
  SealName: string
1329
1353
 
1330
1354
  /**
1331
- * 电子印章授权时间戳
1355
+ * 电子印章授权时间戳,单位秒
1332
1356
  */
1333
1357
  CreateOn: number
1334
1358
 
1335
1359
  /**
1336
- * 电子印章授权人
1360
+ * 电子印章授权人的UserId
1337
1361
  */
1338
1362
  Creator: string
1339
1363
 
@@ -1359,12 +1383,12 @@ export interface OccupiedSeal {
1359
1383
  Url: string
1360
1384
 
1361
1385
  /**
1362
- * 印章类型
1386
+ * 印章类型,OFFICIAL-企业公章, CONTRACT-合同专用章,ORGANIZATIONSEAL-企业印章(本地上传印章类型),LEGAL_PERSON_SEAL-法人印章
1363
1387
  */
1364
1388
  SealType: string
1365
1389
 
1366
1390
  /**
1367
- * 用印申请是否为永久授权
1391
+ * 用印申请是否为永久授权,true-是,false-否
1368
1392
  */
1369
1393
  IsAllTime: boolean
1370
1394
 
@@ -1417,7 +1441,7 @@ export interface PdfVerifyResult {
1417
1441
  SignerName: string
1418
1442
 
1419
1443
  /**
1420
- * 签署时间
1444
+ * 签署时间戳,单位秒
1421
1445
  */
1422
1446
  SignTime: number
1423
1447
 
@@ -1432,37 +1456,37 @@ export interface PdfVerifyResult {
1432
1456
  CertSn: string
1433
1457
 
1434
1458
  /**
1435
- * 证书起始时间
1459
+ * 证书起始时间戳,单位秒
1436
1460
  */
1437
1461
  CertNotBefore: number
1438
1462
 
1439
1463
  /**
1440
- * 证书过期时间
1464
+ * 证书过期时间戳,单位秒
1441
1465
  */
1442
1466
  CertNotAfter: number
1443
1467
 
1444
1468
  /**
1445
- * 签名域横坐标
1469
+ * 签名域横坐标,单位pt
1446
1470
  */
1447
1471
  ComponentPosX: number
1448
1472
 
1449
1473
  /**
1450
- * 签名域纵坐标
1474
+ * 签名域纵坐标,单位pt
1451
1475
  */
1452
1476
  ComponentPosY: number
1453
1477
 
1454
1478
  /**
1455
- * 签名域宽度
1479
+ * 签名域宽度,单位pt
1456
1480
  */
1457
1481
  ComponentWidth: number
1458
1482
 
1459
1483
  /**
1460
- * 签名域高度
1484
+ * 签名域高度,单位pt
1461
1485
  */
1462
1486
  ComponentHeight: number
1463
1487
 
1464
1488
  /**
1465
- * 签名域所在页码
1489
+ * 签名域所在页码,1~N
1466
1490
  */
1467
1491
  ComponentPage: number
1468
1492
  }
@@ -1530,7 +1554,7 @@ export interface SignQrCode {
1530
1554
  QrCodeUrl: string
1531
1555
 
1532
1556
  /**
1533
- * 二维码过期时间
1557
+ * 二维码过期时间戳,单位秒
1534
1558
  */
1535
1559
  ExpiredTime: number
1536
1560
  }
@@ -1555,7 +1579,7 @@ export interface CreateSealPolicyResponse {
1555
1579
  */
1556
1580
  export interface DisableUserAutoSignRequest {
1557
1581
  /**
1558
- * 操作人信息
1582
+ * 操作人信息,UserId必填
1559
1583
  */
1560
1584
  Operator: UserInfo
1561
1585
 
@@ -1666,7 +1690,7 @@ REJECT: 拒绝
1666
1690
  ReviewMessage?: string
1667
1691
 
1668
1692
  /**
1669
- * 应用相关信息
1693
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1670
1694
  */
1671
1695
  Agent?: Agent
1672
1696
  }
@@ -1696,7 +1720,7 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
1696
1720
  */
1697
1721
  export interface CreateSchemeUrlResponse {
1698
1722
  /**
1699
- * 小程序链接地址
1723
+ * 小程序链接地址,有效期5分钟
1700
1724
  */
1701
1725
  SchemeUrl?: string
1702
1726
 
@@ -1967,7 +1991,7 @@ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo
1967
1991
  */
1968
1992
  export interface CreateChannelSubOrganizationModifyQrCodeRequest {
1969
1993
  /**
1970
- * 操作人
1994
+ * 操作人信息,userId必填
1971
1995
  */
1972
1996
  Operator: UserInfo
1973
1997
 
@@ -2081,12 +2105,12 @@ export interface Staff {
2081
2105
  Verified?: boolean
2082
2106
 
2083
2107
  /**
2084
- * 员工创建时间戳
2108
+ * 员工创建时间戳,单位秒
2085
2109
  */
2086
2110
  CreatedOn?: number
2087
2111
 
2088
2112
  /**
2089
- * 员工实名时间戳
2113
+ * 员工实名时间戳,单位秒
2090
2114
  注意:此字段可能返回 null,表示取不到有效值。
2091
2115
  */
2092
2116
  VerifiedOn?: number
@@ -2181,7 +2205,7 @@ export interface GroupOrganization {
2181
2205
  OrganizationId?: string
2182
2206
 
2183
2207
  /**
2184
- * 更新时间
2208
+ * 更新时间,时间戳,单位秒
2185
2209
  注意:此字段可能返回 null,表示取不到有效值。
2186
2210
  */
2187
2211
  UpdateTime?: number
@@ -2217,19 +2241,19 @@ export interface GroupOrganization {
2217
2241
  License?: string
2218
2242
 
2219
2243
  /**
2220
- * 企业许可证过期时间
2244
+ * 企业许可证过期时间,时间戳,单位秒
2221
2245
  注意:此字段可能返回 null,表示取不到有效值。
2222
2246
  */
2223
2247
  LicenseExpireTime?: number
2224
2248
 
2225
2249
  /**
2226
- * 成员企业加入集团时间
2250
+ * 成员企业加入集团时间,时间戳,单位秒
2227
2251
  注意:此字段可能返回 null,表示取不到有效值。
2228
2252
  */
2229
2253
  JoinTime?: number
2230
2254
 
2231
2255
  /**
2232
- * 是否可以使用审批流引擎
2256
+ * 是否使用审批流引擎,true-是,false-否
2233
2257
  注意:此字段可能返回 null,表示取不到有效值。
2234
2258
  */
2235
2259
  FlowEngineEnable?: boolean
@@ -2467,7 +2491,7 @@ export interface GetTaskResultApiRequest {
2467
2491
  TaskId: string
2468
2492
 
2469
2493
  /**
2470
- * 操作人信息
2494
+ * 操作人信息,UserId必填
2471
2495
  */
2472
2496
  Operator?: UserInfo
2473
2497
 
@@ -2517,7 +2541,7 @@ export interface CreateIntegrationEmployeesResponse {
2517
2541
  */
2518
2542
  export interface DeleteIntegrationRoleUsersRequest {
2519
2543
  /**
2520
- * 操作人
2544
+ * 操作人信息,userId必填
2521
2545
  */
2522
2546
  Operator: UserInfo
2523
2547
 
@@ -2532,7 +2556,7 @@ export interface DeleteIntegrationRoleUsersRequest {
2532
2556
  Users: Array<UserInfo>
2533
2557
 
2534
2558
  /**
2535
- * 代理信息
2559
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2536
2560
  */
2537
2561
  Agent?: Agent
2538
2562
  }
@@ -2599,7 +2623,7 @@ export interface CreateReleaseFlowRequest {
2599
2623
  */
2600
2624
  export interface CreateIntegrationUserRolesRequest {
2601
2625
  /**
2602
- * 操作人信息
2626
+ * 操作人信息,UserId必填
2603
2627
  */
2604
2628
  Operator: UserInfo
2605
2629
 
@@ -2765,7 +2789,7 @@ export interface Recipient {
2765
2789
  RequireSign?: boolean
2766
2790
 
2767
2791
  /**
2768
- * 添加序列
2792
+ * 添加序列,0~N
2769
2793
  */
2770
2794
  RoutingOrder?: number
2771
2795
 
@@ -2980,7 +3004,7 @@ export interface CreateStaffResult {
2980
3004
  */
2981
3005
  export interface CreateUserAutoSignEnableUrlRequest {
2982
3006
  /**
2983
- * 操作人信息
3007
+ * 操作人信息,UserId必填
2984
3008
  */
2985
3009
  Operator: UserInfo
2986
3010
 
@@ -3037,7 +3061,7 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
3037
3061
  */
3038
3062
  export interface RemindFlowRecords {
3039
3063
  /**
3040
- * 是否能够催办
3064
+ * 是否能够催办,true-是,false-否
3041
3065
  */
3042
3066
  CanRemind: boolean
3043
3067
 
@@ -3047,7 +3071,7 @@ export interface RemindFlowRecords {
3047
3071
  FlowId: string
3048
3072
 
3049
3073
  /**
3050
- * 催办详情
3074
+ * 催办详情信息
3051
3075
  */
3052
3076
  RemindMessage: string
3053
3077
  }
@@ -3102,7 +3126,7 @@ export interface ApproverRestriction {
3102
3126
  */
3103
3127
  export interface DeleteSealPoliciesRequest {
3104
3128
  /**
3105
- * 操作撤销的用户信息
3129
+ * 调用方用户信息,userId 必填
3106
3130
  */
3107
3131
  Operator: UserInfo
3108
3132
 
@@ -3111,11 +3135,6 @@ export interface DeleteSealPoliciesRequest {
3111
3135
  */
3112
3136
  PolicyIds?: Array<string>
3113
3137
 
3114
- /**
3115
- * 应用相关
3116
- */
3117
- Agent?: Agent
3118
-
3119
3138
  /**
3120
3139
  * 印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填
3121
3140
  */
@@ -3125,6 +3144,11 @@ export interface DeleteSealPoliciesRequest {
3125
3144
  * 待授权的员工ID
3126
3145
  */
3127
3146
  UserIds?: Array<string>
3147
+
3148
+ /**
3149
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3150
+ */
3151
+ Agent?: Agent
3128
3152
  }
3129
3153
 
3130
3154
  /**
@@ -3269,7 +3293,7 @@ export interface IntegrateRole {
3269
3293
  RoleStatus?: number
3270
3294
 
3271
3295
  /**
3272
- * 是否是集团角色
3296
+ * 是否是集团角色,true-是,false-否
3273
3297
  注意:此字段可能返回 null,表示取不到有效值。
3274
3298
  */
3275
3299
  IsGroupRole?: boolean
@@ -3286,7 +3310,7 @@ export interface IntegrateRole {
3286
3310
  */
3287
3311
  export interface CreatePrepareFlowResponse {
3288
3312
  /**
3289
- * 快速发起预览链接
3313
+ * 快速发起预览链接,有效期5分钟
3290
3314
  */
3291
3315
  Url?: string
3292
3316
 
@@ -3343,7 +3367,7 @@ ProcessTimeout - 转换文件超时
3343
3367
  */
3344
3368
  export interface CancelMultiFlowSignQRCodeRequest {
3345
3369
  /**
3346
- * 用户信息
3370
+ * 调用方用户信息,userId 必填
3347
3371
  */
3348
3372
  Operator: UserInfo
3349
3373
 
@@ -3353,7 +3377,7 @@ export interface CancelMultiFlowSignQRCodeRequest {
3353
3377
  QrCodeId: string
3354
3378
 
3355
3379
  /**
3356
- * 应用信息
3380
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3357
3381
  */
3358
3382
  Agent?: Agent
3359
3383
  }
@@ -3513,7 +3537,7 @@ export interface FileUrl {
3513
3537
  */
3514
3538
  export interface CreateSealPolicyRequest {
3515
3539
  /**
3516
- * 授权发起人在平台信息,具体参考UserInfo结构体
3540
+ * 调用方用户信息,userId 必填
3517
3541
  */
3518
3542
  Operator: UserInfo
3519
3543
 
@@ -3533,19 +3557,19 @@ export interface CreateSealPolicyRequest {
3533
3557
  Expired: number
3534
3558
 
3535
3559
  /**
3536
- * 印章授权内容
3560
+ * 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用
3537
3561
  */
3538
- Policy?: string
3562
+ UserIds?: Array<string>
3539
3563
 
3540
3564
  /**
3541
- * 应用相关
3565
+ * 印章授权内容
3542
3566
  */
3543
- Agent?: Agent
3567
+ Policy?: string
3544
3568
 
3545
3569
  /**
3546
- * 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用
3570
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3547
3571
  */
3548
- UserIds?: Array<string>
3572
+ Agent?: Agent
3549
3573
  }
3550
3574
 
3551
3575
  /**
@@ -3614,7 +3638,7 @@ export interface CancelFlowRequest {
3614
3638
  CancelMessage: string
3615
3639
 
3616
3640
  /**
3617
- * 应用相关信息
3641
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3618
3642
  */
3619
3643
  Agent?: Agent
3620
3644
  }
@@ -3957,12 +3981,12 @@ export interface DescribeFlowBriefsRequest {
3957
3981
  Operator: UserInfo
3958
3982
 
3959
3983
  /**
3960
- * 需要查询的流程ID列表,限制最大20
3984
+ * 需要查询的流程ID列表,限制最大100
3961
3985
  */
3962
3986
  FlowIds: Array<string>
3963
3987
 
3964
3988
  /**
3965
- * 应用相关信息
3989
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3966
3990
  */
3967
3991
  Agent?: Agent
3968
3992
  }
@@ -4051,7 +4075,7 @@ export interface DescribeFlowBriefsResponse {
4051
4075
  /**
4052
4076
  * 流程列表
4053
4077
  */
4054
- FlowBriefs: Array<FlowBrief>
4078
+ FlowBriefs?: Array<FlowBrief>
4055
4079
 
4056
4080
  /**
4057
4081
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -4111,7 +4135,7 @@ export interface DescribeFlowTemplatesResponse {
4111
4135
  Templates?: Array<TemplateInfo>
4112
4136
 
4113
4137
  /**
4114
- * 查询到的总个数
4138
+ * 查询到的总数
4115
4139
  */
4116
4140
  TotalCount?: number
4117
4141
 
@@ -4221,7 +4245,7 @@ export interface CreateBatchCancelFlowUrlRequest {
4221
4245
  */
4222
4246
  export interface CreateMultiFlowSignQRCodeRequest {
4223
4247
  /**
4224
- * 用户信息
4248
+ * 用户信息,其中UserId为必填参数
4225
4249
  */
4226
4250
  Operator: UserInfo
4227
4251
 
@@ -4289,7 +4313,7 @@ export interface DescribeFlowInfoRequest {
4289
4313
  FlowIds: Array<string>
4290
4314
 
4291
4315
  /**
4292
- * 调用方用户信息
4316
+ * 调用方用户信息,userId 必填
4293
4317
  */
4294
4318
  Operator?: UserInfo
4295
4319
 
@@ -4363,7 +4387,7 @@ export interface CreateFlowResponse {
4363
4387
  */
4364
4388
  export interface DescribeUserAutoSignStatusRequest {
4365
4389
  /**
4366
- * 操作人信息
4390
+ * 操作人信息,UserId必填
4367
4391
  */
4368
4392
  Operator: UserInfo
4369
4393
 
@@ -29,15 +29,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
29
29
  */
30
30
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
31
31
  /**
32
- * 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
33
- */
32
+ * 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。<br/>
33
+ 该接口常用来配合“创建电子文档”接口作为前置的接口使用。<br/>
34
+ */
34
35
  DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
35
36
  /**
36
37
  * 撤销员工持有的印章权限
37
38
  */
38
39
  DeleteSealPolicies(req: DeleteSealPoliciesRequest, cb?: (error: string, rep: DeleteSealPoliciesResponse) => void): Promise<DeleteSealPoliciesResponse>;
39
40
  /**
40
- * 查询文件下载URL
41
+ * 查询文件下载URL
41
42
  适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
42
43
  */
43
44
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
@@ -93,7 +94,6 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
93
94
  适用场景:
94
95
  在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。
95
96
  若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
96
-
97
97
  */
98
98
  CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
99
99
  /**
@@ -118,9 +118,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
118
118
  */
119
119
  CreateSealPolicy(req: CreateSealPolicyRequest, cb?: (error: string, rep: CreateSealPolicyResponse) => void): Promise<CreateSealPolicyResponse>;
120
120
  /**
121
- * 通过模板创建签署流程
122
- 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
123
- 注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
121
+ * 通过模板创建签署流程<br/>
122
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。<br/>
123
+ 注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。<br/>
124
+ 配合“创建电子文档”接口和“发起流程”接口使用。<br/>
124
125
  */
125
126
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
126
127
  /**
@@ -140,10 +141,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
140
141
  */
141
142
  DescribeFlowEvidenceReport(req: DescribeFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeFlowEvidenceReportResponse) => void): Promise<DescribeFlowEvidenceReportResponse>;
142
143
  /**
143
- * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
144
- 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
145
- 适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
146
- 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
144
+ * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
145
+ 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
146
+ 适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。<br/>
147
+ 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。<br/>
147
148
  */
148
149
  CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
149
150
  /**
@@ -163,8 +164,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
163
164
  */
164
165
  CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
165
166
  /**
166
- * 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
167
- */
167
+ * 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>
168
+ 大文件转换所需的时间可能会比较长。
169
+ */
168
170
  GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
169
171
  /**
170
172
  * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
@@ -197,10 +199,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
197
199
  */
198
200
  CreateIntegrationUserRoles(req: CreateIntegrationUserRolesRequest, cb?: (error: string, rep: CreateIntegrationUserRolesResponse) => void): Promise<CreateIntegrationUserRolesResponse>;
199
201
  /**
200
- * 此接口(UploadFiles)用于文件上传。
201
- 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
202
- 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。
203
- 调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,并设置参数Version/版本号为2020-12-22
202
+ * 此接口(UploadFiles)用于文件上传。<br/>
203
+ 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。<br/>
204
+
205
+ 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。<br/>
206
+ 调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,代码示例:<br/>
207
+ HttpProfile httpProfile = new HttpProfile();<br/>
208
+ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
204
209
  */
205
210
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
206
211
  /**