tencentcloud-sdk-nodejs 4.0.653 → 4.0.654

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.
Files changed (64) hide show
  1. package/CHANGELOG.md +305 -0
  2. package/SERVICE_CHANGELOG.md +448 -88
  3. package/package.json +1 -1
  4. package/products.md +19 -19
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apigateway/v20180808/apigateway_models.ts +3 -3
  7. package/src/services/asr/v20190614/asr_models.ts +7 -2
  8. package/src/services/clb/v20180317/clb_client.ts +17 -8
  9. package/src/services/clb/v20180317/clb_models.ts +16 -16
  10. package/src/services/cls/v20201016/cls_client.ts +24 -0
  11. package/src/services/cls/v20201016/cls_models.ts +136 -34
  12. package/src/services/cynosdb/v20190107/cynosdb_models.ts +33 -12
  13. package/src/services/emr/v20190103/emr_models.ts +5 -0
  14. package/src/services/ess/v20201111/ess_client.ts +7 -4
  15. package/src/services/ess/v20201111/ess_models.ts +321 -78
  16. package/src/services/essbasic/v20210526/essbasic_client.ts +15 -4
  17. package/src/services/essbasic/v20210526/essbasic_models.ts +131 -70
  18. package/src/services/faceid/v20180301/faceid_models.ts +8 -4
  19. package/src/services/live/v20180801/live_client.ts +1 -0
  20. package/src/services/live/v20180801/live_models.ts +24 -1
  21. package/src/services/mna/v20210119/mna_models.ts +10 -3
  22. package/src/services/mps/v20190612/mps_models.ts +33 -0
  23. package/src/services/ms/v20180408/ms_client.ts +1 -1
  24. package/src/services/ms/v20180408/ms_models.ts +19 -19
  25. package/src/services/oceanus/v20190422/oceanus_client.ts +62 -54
  26. package/src/services/oceanus/v20190422/oceanus_models.ts +1487 -1284
  27. package/src/services/tdmq/v20200217/tdmq_client.ts +24 -11
  28. package/src/services/tdmq/v20200217/tdmq_models.ts +102 -36
  29. package/src/services/tts/v20190823/tts_models.ts +1 -1
  30. package/src/services/vpc/v20170312/vpc_models.ts +35 -35
  31. package/tencentcloud/common/sdk_version.d.ts +1 -1
  32. package/tencentcloud/common/sdk_version.js +1 -1
  33. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +3 -3
  34. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +7 -2
  35. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +15 -6
  36. package/tencentcloud/services/clb/v20180317/clb_client.js +15 -6
  37. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +16 -16
  38. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +9 -1
  39. package/tencentcloud/services/cls/v20201016/cls_client.js +12 -0
  40. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +132 -34
  41. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +33 -12
  42. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +5 -0
  43. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +4 -3
  44. package/tencentcloud/services/ess/v20201111/ess_client.js +4 -3
  45. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +319 -78
  46. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +13 -2
  47. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +13 -2
  48. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +131 -70
  49. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +8 -4
  50. package/tencentcloud/services/live/v20180801/live_models.d.ts +23 -1
  51. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +10 -3
  52. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +33 -0
  53. package/tencentcloud/services/ms/v20180408/ms_client.d.ts +1 -1
  54. package/tencentcloud/services/ms/v20180408/ms_client.js +1 -1
  55. package/tencentcloud/services/ms/v20180408/ms_models.d.ts +19 -19
  56. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +1 -1
  57. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +1442 -1247
  58. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +7 -3
  59. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +9 -3
  60. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +99 -36
  61. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +1 -1
  62. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +35 -35
  63. package/test/cls.v20201016.test.js +20 -0
  64. package/test/tdmq.v20200217.test.js +12 -2
@@ -125,11 +125,11 @@ export interface Department {
125
125
  /**
126
126
  * 部门id
127
127
  */
128
- DepartmentId: string;
128
+ DepartmentId?: string;
129
129
  /**
130
130
  * 部门名称
131
131
  */
132
- DepartmentName: string;
132
+ DepartmentName?: string;
133
133
  }
134
134
  /**
135
135
  * CreatePreparedPersonalEsign请求参数结构体
@@ -220,7 +220,7 @@ export interface DescribeIntegrationDepartmentsResponse {
220
220
  */
221
221
  export interface FileInfo {
222
222
  /**
223
- * 文件Id
223
+ * 文件ID
224
224
  */
225
225
  FileId?: string;
226
226
  /**
@@ -232,7 +232,7 @@ export interface FileInfo {
232
232
  */
233
233
  FileSize?: number;
234
234
  /**
235
- * 文件上传时间,10位时间戳(精确到秒)
235
+ * 文件上传时间,格式为Unix标准时间戳(秒)
236
236
  */
237
237
  CreatedOn?: number;
238
238
  }
@@ -293,15 +293,21 @@ export interface FlowCreateApprover {
293
293
  */
294
294
  ApproverType: number;
295
295
  /**
296
- * 如果签署方为企业,需要填入企业全称
296
+ * 签署人企业名称
297
+ <br/>当approverType=1 或 approverType=3时,必须指定
298
+
299
+
297
300
  */
298
301
  OrganizationName?: string;
299
302
  /**
300
303
  * 签署方经办人姓名
304
+ <br/>在未指定签署人电子签UserId情况下,为必填参数
301
305
  */
302
306
  ApproverName?: string;
303
307
  /**
304
308
  * 签署方经办人手机号码
309
+ <br/>在未指定签署人电子签UserId情况下,为必填参数
310
+
305
311
  */
306
312
  ApproverMobile?: string;
307
313
  /**
@@ -316,6 +322,9 @@ export interface FlowCreateApprover {
316
322
  ApproverIdCardNumber?: string;
317
323
  /**
318
324
  * 签署方经办人在模板中的参与方ID
325
+ <br/>模版发起合同时,该参数为必填项
326
+ <br/>文件发起合同是,该参数无序传值
327
+
319
328
  */
320
329
  RecipientId?: string;
321
330
  /**
@@ -323,7 +332,11 @@ export interface FlowCreateApprover {
323
332
  */
324
333
  VerifyChannel?: Array<string>;
325
334
  /**
326
- * 是否发送短信,sms--短信通知,none--不通知,默认为sms;发起方=签署方时不发送短信
335
+ * 是否发送短信
336
+ <br/>sms--短信通知
337
+ <br/>none--不通知
338
+ <br/>默认为sms
339
+ <br/>发起方=签署方时不发送短信
327
340
  */
328
341
  NotifyType?: string;
329
342
  /**
@@ -335,7 +348,9 @@ export interface FlowCreateApprover {
335
348
  */
336
349
  PreReadTime?: number;
337
350
  /**
338
- * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。
351
+ * 签署方经办人的电子签用户ID
352
+ <br/>当未指定签署人姓名+手机号的情况下,该字段毕传
353
+
339
354
  */
340
355
  UserId?: string;
341
356
  /**
@@ -343,11 +358,15 @@ export interface FlowCreateApprover {
343
358
  */
344
359
  Required?: boolean;
345
360
  /**
346
- * 签署人用户来源,企微侧用户请传入:WEWORKAPP
361
+ * 签署人用户来源
362
+ <br/>企微侧用户请传入:WEWORKAPP
347
363
  */
348
364
  ApproverSource?: string;
349
365
  /**
350
- * 企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
366
+ * 企业签署方或签标识,客户自定义,64位长度
367
+ <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
368
+ <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
369
+ <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
351
370
  */
352
371
  CustomApproverTag?: string;
353
372
  /**
@@ -370,15 +389,20 @@ export interface FlowCreateApprover {
370
389
  */
371
390
  SignId?: string;
372
391
  /**
373
- * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要。为个人签署方时则由发起方企业审核。
392
+ * 当前签署方进行签署操作是否需要企业内部审批
393
+ <br>true 则为需要
394
+ <br/>false,无序企业内部审批(默认)
395
+ <br/>为个人签署方时则由发起方企业审核。
374
396
  */
375
397
  ApproverNeedSignReview?: boolean;
376
398
  /**
377
399
  * 签署人签署控件
400
+ <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
378
401
  */
379
402
  SignComponents?: Array<Component>;
380
403
  /**
381
404
  * 签署人填写控件
405
+ <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
382
406
  */
383
407
  Components?: Array<Component>;
384
408
  /**
@@ -491,6 +515,72 @@ export interface CreateIntegrationEmployeesRequest {
491
515
  */
492
516
  Agent?: Agent;
493
517
  }
518
+ /**
519
+ * 创建合同个性化参数
520
+ */
521
+ export interface CreateFlowOption {
522
+ /**
523
+ * 是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。
524
+ <br/>true:允许编辑(默认),<br/>false:不允许编辑<br/>默认:false:不允许编辑
525
+ */
526
+ CanEditFlow?: boolean;
527
+ /**
528
+ * 是否允许编辑模版控件
529
+ <br/>true:允许编辑模版控件信息
530
+ <br/>false:不允许编辑模版控件信息
531
+ <br/>默认false:不允许编辑模版控件信息
532
+ */
533
+ CanEditFormField?: boolean;
534
+ /**
535
+ * 发起页面隐藏合同名称展示
536
+ <br/>true:发起页面隐藏合同名称展示
537
+ <br/>false:发起页面不隐藏合同名称展示
538
+ <br/>默认false:发起页面不隐藏合同名称展示
539
+ */
540
+ HideShowFlowName?: boolean;
541
+ /**
542
+ * 发起页面隐藏合同类型展示
543
+ <br/>true:发起页面隐藏合同类型展示
544
+ <br/>false:发起页面不隐藏合同类型展示
545
+ <br/>默认false:发起页面不隐藏合同类型展示
546
+
547
+ */
548
+ HideShowFlowType?: boolean;
549
+ /**
550
+ * 发起页面隐藏合同截止日期展示
551
+ <br/>true:发起页面隐藏合同截止日期展示
552
+ <br/>false:发起页面不隐藏合同截止日期展示
553
+ <br/>默认false:发起页面不隐藏合同截止日期展示
554
+ */
555
+ HideShowDeadline?: boolean;
556
+ /**
557
+ * 发起页面允许跳过添加签署人环节
558
+ <br/>true:发起页面允许跳过添加签署人环节
559
+ <br/>false:发起页面不允许跳过添加签署人环节
560
+ <br/>默认false:发起页面不允许跳过添加签署人环节
561
+
562
+ */
563
+ CanSkipAddApprover?: boolean;
564
+ /**
565
+ * 文件发起页面跳过文件上传步骤
566
+ <br/>true:文件发起页面跳过文件上传步骤
567
+ <br/>false:文件发起页面不跳过文件上传步骤
568
+ <br/>默认false:文件发起页面不跳过文件上传步骤
569
+ */
570
+ SkipUploadFile?: boolean;
571
+ /**
572
+ * 禁止编辑填写控件
573
+ <br/>true:禁止编辑填写控件
574
+ <br/>false:允许编辑填写控件
575
+ <br/>默认false:允许编辑填写控件
576
+ */
577
+ ForbidEditFillComponent?: boolean;
578
+ /**
579
+ * 定制化发起合同弹窗的描述信息,描述信息最长500
580
+
581
+ */
582
+ CustomCreateFlowDescription?: string;
583
+ }
494
584
  /**
495
585
  * 解除协议的签署人,如不指定,默认使用待解除流程(即原流程)中的签署人。
496
586
  注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。
@@ -588,9 +678,28 @@ export interface StartFlowResponse {
588
678
  RequestId?: string;
589
679
  }
590
680
  /**
591
- * 模板结构体中的印章信息
681
+ * 模板中指定的印章信息
592
682
  */
593
- export declare type SealInfo = null;
683
+ export interface SealInfo {
684
+ /**
685
+ * 印章ID
686
+ 注意:此字段可能返回 null,表示取不到有效值。
687
+ */
688
+ SealId?: string;
689
+ /**
690
+ * 印章类型。LEGAL_PERSON_SEAL: 法定代表人章;
691
+ ORGANIZATIONSEAL:企业印章;
692
+ OFFICIAL:企业公章;
693
+ CONTRACT:合同专用章
694
+ 注意:此字段可能返回 null,表示取不到有效值。
695
+ */
696
+ SealType?: string;
697
+ /**
698
+ * 印章名称
699
+ 注意:此字段可能返回 null,表示取不到有效值。
700
+ */
701
+ SealName?: string;
702
+ }
594
703
  /**
595
704
  * 集成版企业角色信息
596
705
  */
@@ -599,12 +708,12 @@ export interface StaffRole {
599
708
  * 角色id
600
709
  注意:此字段可能返回 null,表示取不到有效值。
601
710
  */
602
- RoleId: string;
711
+ RoleId?: string;
603
712
  /**
604
713
  * 角色名称
605
714
  注意:此字段可能返回 null,表示取不到有效值。
606
715
  */
607
- RoleName: string;
716
+ RoleName?: string;
608
717
  }
609
718
  /**
610
719
  * 签署链接信息
@@ -939,15 +1048,24 @@ export interface CreateFlowGroupByTemplatesResponse {
939
1048
  RequestId?: string;
940
1049
  }
941
1050
  /**
942
- * 企业模板的信息结构
1051
+ * 此结构体 (TemplateInfo) 用于描述模板的信息。
1052
+
1053
+ > **模板组成**
1054
+ >
1055
+ > 一个模板通常会包含以下结构信息
1056
+ >- 模板基本信息
1057
+ >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
1058
+ >- 填写控件 Components
1059
+ >- 签署控件 SignComponents
1060
+ >- 生成模板的文件基础信息 FileInfos
943
1061
  */
944
1062
  export interface TemplateInfo {
945
1063
  /**
946
- * 模板ID
1064
+ * 模板ID,模板的唯一标识
947
1065
  */
948
1066
  TemplateId?: string;
949
1067
  /**
950
- * 模板名字
1068
+ * 模板名
951
1069
  */
952
1070
  TemplateName?: string;
953
1071
  /**
@@ -959,7 +1077,7 @@ export interface TemplateInfo {
959
1077
  */
960
1078
  DocumentResourceIds?: Array<string>;
961
1079
  /**
962
- * 返回的文件信息结构
1080
+ * 生成模板的文件基础信息
963
1081
  */
964
1082
  FileInfos?: Array<FileInfo>;
965
1083
  /**
@@ -968,49 +1086,55 @@ export interface TemplateInfo {
968
1086
  AttachmentResourceIds?: Array<string>;
969
1087
  /**
970
1088
  * 签署顺序
1089
+ 无序 -1
1090
+ 有序为序列数字 0,1,2
971
1091
  */
972
1092
  SignOrder?: Array<number>;
973
1093
  /**
974
- * 签署参与者的信息
1094
+ * 模板中的签署参与方列表
975
1095
  */
976
1096
  Recipients?: Array<Recipient>;
977
1097
  /**
978
- * 模板信息结构
1098
+ * 模板的填充控件列表
979
1099
  */
980
1100
  Components?: Array<Component>;
981
1101
  /**
982
- * 签署区模板信息结构
1102
+ * 模板中的签署控件列表
983
1103
  */
984
1104
  SignComponents?: Array<Component>;
985
1105
  /**
986
- * 模板状态(-1:不可用;0:草稿态;1:正式态)
1106
+ * 模板状态
1107
+ -1:不可用
1108
+ 0:草稿态
1109
+ 1:正式态,可以正常使用
987
1110
  */
988
1111
  Status?: number;
989
1112
  /**
990
- * 模板的创建人UserId
1113
+ * 模板的创建者信息,电子签系统用户ID
991
1114
  */
992
1115
  Creator?: string;
993
1116
  /**
994
- * 模板创建的时间戳,单位秒
1117
+ * 模板创建的时间戳,格式为Unix标准时间戳(秒)
995
1118
  */
996
1119
  CreatedOn?: number;
997
1120
  /**
998
- * 发起人角色信息
1121
+ * 发起方参与信息Promoter
999
1122
  */
1000
1123
  Promoter?: Recipient;
1001
1124
  /**
1002
- * 模板类型
1003
- 取值:
1125
+ * 模板类型:
1004
1126
  1 静默签,
1005
1127
  3 普通模板
1006
1128
  */
1007
1129
  TemplateType?: number;
1008
1130
  /**
1009
- * 模板可用状态,取值:1启用(默认),2停用
1131
+ * 模板可用状态:
1132
+ 1 启用(默认)
1133
+ 2 停用
1010
1134
  */
1011
1135
  Available?: number;
1012
1136
  /**
1013
- * 创建模板的机构id
1137
+ * 创建模板的企业ID,电子签的机构ID
1014
1138
  */
1015
1139
  OrganizationId?: string;
1016
1140
  /**
@@ -1024,7 +1148,9 @@ export interface TemplateInfo {
1024
1148
  */
1025
1149
  TemplateVersion?: string;
1026
1150
  /**
1027
- * 模板是否已发布。true-已发布;false-未发布
1151
+ * 模板是否已发布:
1152
+ true-已发布
1153
+ false-未发布
1028
1154
  注意:此字段可能返回 null,表示取不到有效值。
1029
1155
  */
1030
1156
  Published?: boolean;
@@ -1410,7 +1536,7 @@ export interface DescribeFlowTemplatesRequest {
1410
1536
  /**
1411
1537
  * 调用方员工/经办人信息
1412
1538
  UserId 必填,在企业控制台组织架构中可以查到员工的UserId
1413
- 注:请保证对应
1539
+ 注:请保证员工有相关的角色权限
1414
1540
  */
1415
1541
  Operator: UserInfo;
1416
1542
  /**
@@ -1527,8 +1653,8 @@ export interface DescribeUserAutoSignStatusResponse {
1527
1653
  /**
1528
1654
  * 补充签署人信息
1529
1655
  - RecipientId 必须指定
1530
- - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填
1531
- - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填
1656
+ - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1657
+ - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
1532
1658
  */
1533
1659
  export interface FillApproverInfo {
1534
1660
  /**
@@ -1538,11 +1664,12 @@ export interface FillApproverInfo {
1538
1664
  /**
1539
1665
  * 签署人来源
1540
1666
  WEWORKAPP: 企业微信
1667
+ <br/>仅【企微或签】时指定WEWORKAPP
1541
1668
  */
1542
1669
  ApproverSource?: string;
1543
1670
  /**
1544
1671
  * 企业自定义账号ID
1545
- WEWORKAPP场景下指企业自有应用获取企微明文的userid
1672
+ <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
1546
1673
  */
1547
1674
  CustomUserId?: string;
1548
1675
  /**
@@ -1631,55 +1758,55 @@ export interface PdfVerifyResult {
1631
1758
  /**
1632
1759
  * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
1633
1760
  */
1634
- VerifyResult: number;
1761
+ VerifyResult?: number;
1635
1762
  /**
1636
1763
  * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
1637
1764
  */
1638
- SignPlatform: string;
1765
+ SignPlatform?: string;
1639
1766
  /**
1640
1767
  * 签署人名称
1641
1768
  */
1642
- SignerName: string;
1769
+ SignerName?: string;
1643
1770
  /**
1644
1771
  * 签署时间戳,单位秒
1645
1772
  */
1646
- SignTime: number;
1773
+ SignTime?: number;
1647
1774
  /**
1648
1775
  * 签名算法
1649
1776
  */
1650
- SignAlgorithm: string;
1777
+ SignAlgorithm?: string;
1651
1778
  /**
1652
1779
  * 签名证书序列号
1653
1780
  */
1654
- CertSn: string;
1781
+ CertSn?: string;
1655
1782
  /**
1656
- * 证书起始时间戳,单位秒
1783
+ * 证书起始时间戳,单位毫秒
1657
1784
  */
1658
- CertNotBefore: number;
1785
+ CertNotBefore?: number;
1659
1786
  /**
1660
- * 证书过期时间戳,单位秒
1787
+ * 证书过期时间戳,单位毫秒
1661
1788
  */
1662
- CertNotAfter: number;
1789
+ CertNotAfter?: number;
1663
1790
  /**
1664
1791
  * 签名域横坐标,单位pt
1665
1792
  */
1666
- ComponentPosX: number;
1793
+ ComponentPosX?: number;
1667
1794
  /**
1668
1795
  * 签名域纵坐标,单位pt
1669
1796
  */
1670
- ComponentPosY: number;
1797
+ ComponentPosY?: number;
1671
1798
  /**
1672
1799
  * 签名域宽度,单位pt
1673
1800
  */
1674
- ComponentWidth: number;
1801
+ ComponentWidth?: number;
1675
1802
  /**
1676
1803
  * 签名域高度,单位pt
1677
1804
  */
1678
- ComponentHeight: number;
1805
+ ComponentHeight?: number;
1679
1806
  /**
1680
1807
  * 签名域所在页码,1~N
1681
1808
  */
1682
- ComponentPage: number;
1809
+ ComponentPage?: number;
1683
1810
  }
1684
1811
  /**
1685
1812
  * CreateBatchCancelFlowUrl返回参数结构体
@@ -2690,7 +2817,8 @@ export interface CreateEmbedWebUrlRequest {
2690
2817
  <br/>PREVIEW_SEAL_LIST:预览印章列表
2691
2818
  <br/>PREVIEW_SEAL_DETAIL:预览印章详情
2692
2819
  <br/>EXTEND_SERVICE:拓展服务
2693
-
2820
+ <br/>PREVIEW_FLOW:预览合同
2821
+ <br/>PREVIEW_FLOW_DETAIL:查看合同详情
2694
2822
  */
2695
2823
  EmbedType: string;
2696
2824
  /**
@@ -2706,6 +2834,10 @@ export interface CreateEmbedWebUrlRequest {
2706
2834
  * 抄送方信息
2707
2835
  */
2708
2836
  Reviewer?: ReviewerInfo;
2837
+ /**
2838
+ * 个性化参数
2839
+ */
2840
+ Option?: EmbedUrlOption;
2709
2841
  }
2710
2842
  /**
2711
2843
  * DeleteIntegrationEmployees请求参数结构体
@@ -3152,15 +3284,19 @@ export interface SuccessCreateStaffData {
3152
3284
  WeworkOpenId?: string;
3153
3285
  }
3154
3286
  /**
3155
- * 签署参与者信息
3287
+ * 流程中参与方的信息结构
3156
3288
  */
3157
3289
  export interface Recipient {
3158
3290
  /**
3159
- * 签署参与者ID
3291
+ * 签署参与者ID,唯一标识
3160
3292
  */
3161
3293
  RecipientId?: string;
3162
3294
  /**
3163
- * 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
3295
+ * 参与者类型。
3296
+ 默认为空。
3297
+ ENTERPRISE-企业;
3298
+ INDIVIDUAL-个人;
3299
+ PROMOTER-发起方
3164
3300
  */
3165
3301
  RecipientType?: string;
3166
3302
  /**
@@ -3172,19 +3308,22 @@ export interface Recipient {
3172
3308
  */
3173
3309
  RoleName?: string;
3174
3310
  /**
3175
- * 是否需要验证,默认为false
3311
+ * 是否需要验证,
3312
+ 默认为false-不需要验证
3176
3313
  */
3177
3314
  RequireValidation?: boolean;
3178
3315
  /**
3179
- * 是否需要签署,默认为true
3316
+ * 是否需要签署,
3317
+ 默认为true-需要签署
3180
3318
  */
3181
3319
  RequireSign?: boolean;
3182
3320
  /**
3183
- * 添加序列,0~N
3321
+ * 此参与方添加的顺序,从0~N
3184
3322
  */
3185
3323
  RoutingOrder?: number;
3186
3324
  /**
3187
- * 是否需要发送,默认为true
3325
+ * 是否需要发送,
3326
+ 默认为true-需要发送
3188
3327
  */
3189
3328
  RequireDelivery?: boolean;
3190
3329
  /**
@@ -3196,15 +3335,18 @@ export interface Recipient {
3196
3335
  */
3197
3336
  Mobile?: string;
3198
3337
  /**
3199
- * 关联的用户ID
3338
+ * 关联的用户ID,电子签系统的用户ID
3200
3339
  */
3201
3340
  UserId?: string;
3202
3341
  /**
3203
- * 发送方式。默认为EMAIL。EMAIL-邮件;MOBILE-手机短信;WECHAT-微信通知
3342
+ * 发送方式,默认为EMAIL。
3343
+ EMAIL-邮件;
3344
+ MOBILE-手机短信;
3345
+ WECHAT-微信通知
3204
3346
  */
3205
3347
  DeliveryMethod?: string;
3206
3348
  /**
3207
- * 附属信息
3349
+ * 参与方的一些附属信息,json格式
3208
3350
  */
3209
3351
  RecipientExtra?: string;
3210
3352
  }
@@ -3843,16 +3985,20 @@ export interface CreatePrepareFlowRequest {
3843
3985
  */
3844
3986
  FlowName: string;
3845
3987
  /**
3846
- * 是否顺序签署(true:无序签,false:顺序签)
3988
+ * 是否顺序签署
3989
+ true:无序签
3990
+ false:顺序签
3847
3991
  */
3848
3992
  Unordered?: boolean;
3849
3993
  /**
3850
3994
  * 签署流程的签署截止时间。
3851
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
3995
+ 值为unix时间戳,精确到秒
3996
+ 不传默认为当前时间一年后
3852
3997
  */
3853
3998
  Deadline?: number;
3854
3999
  /**
3855
- * 用户自定义合同类型
4000
+ * 用户自定义合同类型Id
4001
+ 该id为电子签企业内的合同类型id
3856
4002
  */
3857
4003
  UserFlowTypeId?: string;
3858
4004
  /**
@@ -3860,9 +4006,58 @@ export interface CreatePrepareFlowRequest {
3860
4006
  */
3861
4007
  Approvers?: Array<FlowCreateApprover>;
3862
4008
  /**
3863
- * 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
4009
+ * 打开智能添加填写区
4010
+ (默认开启,打开:"OPEN"
4011
+ 关闭:"CLOSE"
3864
4012
  */
3865
4013
  IntelligentStatus?: string;
4014
+ /**
4015
+ * 资源类型,
4016
+ 1:文件,
4017
+ 2:模板
4018
+ 不传默认为1:文件
4019
+ 目前仅支持文件
4020
+ */
4021
+ ResourceType?: number;
4022
+ /**
4023
+ * 发起方填写控件
4024
+ 该类型控件由发起方完成填写
4025
+ */
4026
+ Components?: Component;
4027
+ /**
4028
+ * 发起合同个性化参数
4029
+ 用于满足创建及页面操作过程中的个性化要求
4030
+ 具体定制化内容详见数据接口说明
4031
+ */
4032
+ FlowOption?: CreateFlowOption;
4033
+ /**
4034
+ * 是否开启发起方签署审核
4035
+ true:开启发起方签署审核
4036
+ false:不开启发起方签署审核
4037
+ 默认false:不开启发起方签署审核
4038
+ */
4039
+ NeedSignReview?: boolean;
4040
+ /**
4041
+ * 开启发起方发起合同审核
4042
+ true:开启发起方发起合同审核
4043
+ false:不开启发起方发起合同审核
4044
+ 默认false:不开启发起方发起合同审核
4045
+ */
4046
+ NeedCreateReview?: boolean;
4047
+ /**
4048
+ * 用户自定义参数
4049
+ */
4050
+ UserData?: string;
4051
+ /**
4052
+ * 合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接
4053
+ */
4054
+ FlowId?: string;
4055
+ /**
4056
+ * 合同类型名称
4057
+ 该字段用于客户自定义合同类型
4058
+ 建议使用时指定合同类型,便于之后合同分类以及查看
4059
+ */
4060
+ FlowType?: string;
3866
4061
  /**
3867
4062
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3868
4063
  */
@@ -4002,7 +4197,7 @@ export interface UploadFile {
4002
4197
  FileName?: string;
4003
4198
  }
4004
4199
  /**
4005
- * 模板控件信息
4200
+ * 模板/流程中控件信息,可以是填充控件或签署控件
4006
4201
  */
4007
4202
  export interface Component {
4008
4203
  /**
@@ -4030,7 +4225,8 @@ export interface Component {
4030
4225
  */
4031
4226
  ComponentType: string;
4032
4227
  /**
4033
- * 控件所属文件的序号(取值为:0-N)。目前单文件的情况下,值是0
4228
+ * 控件所属文件的序号(取值为:0-N)。
4229
+ 目前单文件的情况下,值是0
4034
4230
  */
4035
4231
  FileIndex: number;
4036
4232
  /**
@@ -4054,19 +4250,21 @@ export interface Component {
4054
4250
  */
4055
4251
  ComponentPosY: number;
4056
4252
  /**
4057
- * 查询时返回控件唯一Id。使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
4253
+ * 控件唯一ID。
4254
+ 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
4058
4255
  */
4059
4256
  ComponentId?: string;
4060
4257
  /**
4061
- * 查询时返回控件名。使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
4258
+ * 控件名。
4259
+ 或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
4062
4260
  */
4063
4261
  ComponentName?: string;
4064
4262
  /**
4065
- * 是否必选,默认为false
4263
+ * 是否必选,默认为false-非必选
4066
4264
  */
4067
4265
  ComponentRequired?: boolean;
4068
4266
  /**
4069
- * 控件关联的签署人ID
4267
+ * 控件关联的参与方ID,对应Recipient结构体中的RecipientId
4070
4268
  */
4071
4269
  ComponentRecipientId?: string;
4072
4270
  /**
@@ -4102,7 +4300,7 @@ export interface Component {
4102
4300
  */
4103
4301
  ComponentExtra?: string;
4104
4302
  /**
4105
- * 是否是表单域类型,默认不false-不是
4303
+ * 是否是表单域类型,默认false-不是
4106
4304
  注意:此字段可能返回 null,表示取不到有效值。
4107
4305
  */
4108
4306
  IsFormType?: boolean;
@@ -4196,7 +4394,7 @@ export interface Component {
4196
4394
  */
4197
4395
  ComponentDateFontSize?: number;
4198
4396
  /**
4199
- * 第三方应用集成平台模板控件 id 标识
4397
+ * 第三方应用集成平台模板控件 ID 标识
4200
4398
  */
4201
4399
  ChannelComponentId?: string;
4202
4400
  /**
@@ -4210,26 +4408,50 @@ export interface Component {
4210
4408
  */
4211
4409
  OffsetY?: number;
4212
4410
  /**
4213
- * 第三方应用集成中子客企业控件来源。0-平台指定;1-用户自定义
4411
+ * 第三方应用集成中子客企业控件来源。
4412
+ 0-平台指定;
4413
+ 1-用户自定义
4214
4414
  */
4215
4415
  ChannelComponentSource?: number;
4216
4416
  /**
4217
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
4417
+ * 指定关键字排序规则,Positive-正序,Reverse-倒序。
4418
+ 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
4218
4419
  传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
4219
4420
  */
4220
4421
  KeywordOrder?: string;
4221
4422
  /**
4222
- * 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
4423
+ * 指定关键字页码。
4424
+ 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
4223
4425
  */
4224
4426
  KeywordPage?: number;
4225
4427
  /**
4226
- * 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
4428
+ * 关键字位置模式,
4429
+ Middle-居中,
4430
+ Below-正下方,
4431
+ Right-正右方,
4432
+ LowerRight-右上角,
4433
+ UpperRight-右下角。
4434
+ 示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
4227
4435
  */
4228
4436
  RelativeLocation?: string;
4229
4437
  /**
4230
- * 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
4438
+ * 关键字索引。
4439
+ 如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
4440
+ 示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
4231
4441
  */
4232
4442
  KeywordIndexes?: Array<number>;
4443
+ /**
4444
+ * 是否锁定控件值不允许编辑(嵌入式发起使用)
4445
+ <br/>默认false:不锁定控件值,允许在页面编辑控件值
4446
+ 注意:此字段可能返回 null,表示取不到有效值。
4447
+ */
4448
+ LockComponentValue?: boolean;
4449
+ /**
4450
+ * 是否禁止移动和删除控件
4451
+ <br/>默认false,不禁止移动和删除控件
4452
+ 注意:此字段可能返回 null,表示取不到有效值。
4453
+ */
4454
+ ForbidMoveAndDelete?: boolean;
4233
4455
  }
4234
4456
  /**
4235
4457
  * 部门信息
@@ -4330,7 +4552,7 @@ export interface CreateFlowRemindsRequest {
4330
4552
  */
4331
4553
  export interface UpdateIntegrationEmployeesRequest {
4332
4554
  /**
4333
- * 操作人信息,userId必填
4555
+ * 当前用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为YUFU;
4334
4556
  */
4335
4557
  Operator: UserInfo;
4336
4558
  /**
@@ -4615,6 +4837,25 @@ export interface RelieveInfo {
4615
4837
  */
4616
4838
  OtherDeals?: string;
4617
4839
  }
4840
+ /**
4841
+ * 个性化参数
4842
+ */
4843
+ export interface EmbedUrlOption {
4844
+ /**
4845
+ * 合同详情预览,允许展示控件信息
4846
+ <br/>true:允许在合同详情页展示控件
4847
+ <br/>false:不允许在合同详情页展示控件
4848
+ <br/>默认false,合同详情页不展示控件
4849
+ */
4850
+ ShowFlowDetailComponent?: boolean;
4851
+ /**
4852
+ * 模版预览,允许展示模版控件信息
4853
+ <br/>true:允许在模版预览页展示控件
4854
+ <br/>false:不允许在模版预览页展示控件
4855
+ <br/>默认false,模版预览页不展示控件
4856
+ */
4857
+ ShowTemplateComponent?: boolean;
4858
+ }
4618
4859
  /**
4619
4860
  * CreateBatchCancelFlowUrl请求参数结构体
4620
4861
  */