tencentcloud-sdk-nodejs 4.0.650 → 4.0.652

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 (89) hide show
  1. package/CHANGELOG.md +559 -0
  2. package/SERVICE_CHANGELOG.md +599 -138
  3. package/package.json +1 -1
  4. package/products.md +31 -31
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apigateway/v20180808/apigateway_client.ts +1 -16
  7. package/src/services/apigateway/v20180808/apigateway_models.ts +8 -54
  8. package/src/services/bma/v20221115/bma_models.ts +7 -2
  9. package/src/services/cam/v20190116/cam_models.ts +12 -12
  10. package/src/services/ccc/v20200210/ccc_models.ts +10 -0
  11. package/src/services/cfs/v20190719/cfs_models.ts +8 -0
  12. package/src/services/cls/v20201016/cls_client.ts +17 -2
  13. package/src/services/cls/v20201016/cls_models.ts +198 -26
  14. package/src/services/cwp/v20180228/cwp_models.ts +37 -32
  15. package/src/services/cynosdb/v20190107/cynosdb_models.ts +9 -1
  16. package/src/services/dnspod/v20210323/dnspod_models.ts +4 -0
  17. package/src/services/dts/v20211206/dts_models.ts +1 -1
  18. package/src/services/ess/v20201111/ess_client.ts +70 -19
  19. package/src/services/ess/v20201111/ess_models.ts +281 -102
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +23 -10
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +401 -355
  22. package/src/services/facefusion/v20181201/facefusion_client.ts +4 -1
  23. package/src/services/facefusion/v20181201/facefusion_models.ts +62 -20
  24. package/src/services/facefusion/v20220927/facefusion_client.ts +3 -0
  25. package/src/services/facefusion/v20220927/facefusion_models.ts +39 -1
  26. package/src/services/gaap/v20180529/gaap_models.ts +2 -2
  27. package/src/services/iotvideo/v20211125/iotvideo_models.ts +10 -0
  28. package/src/services/lcic/v20220817/lcic_models.ts +20 -2
  29. package/src/services/live/v20180801/live_models.ts +1 -1
  30. package/src/services/ocr/v20181119/ocr_client.ts +2 -2
  31. package/src/services/ocr/v20181119/ocr_models.ts +4 -0
  32. package/src/services/postgres/v20170312/postgres_models.ts +50 -34
  33. package/src/services/tcss/v20201101/tcss_client.ts +2 -0
  34. package/src/services/tcss/v20201101/tcss_models.ts +105 -25
  35. package/src/services/trtc/v20190722/trtc_models.ts +9 -1
  36. package/src/services/tsf/v20180326/tsf_models.ts +11 -11
  37. package/src/services/tts/v20190823/tts_models.ts +4 -4
  38. package/src/services/vpc/v20170312/vpc_client.ts +15 -1
  39. package/src/services/vpc/v20170312/vpc_models.ts +133 -6
  40. package/src/services/waf/v20180125/waf_client.ts +20 -7
  41. package/src/services/waf/v20180125/waf_models.ts +79 -16
  42. package/tencentcloud/common/sdk_version.d.ts +1 -1
  43. package/tencentcloud/common/sdk_version.js +1 -1
  44. package/tencentcloud/services/apigateway/v20180808/apigateway_client.d.ts +1 -7
  45. package/tencentcloud/services/apigateway/v20180808/apigateway_client.js +0 -8
  46. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +8 -51
  47. package/tencentcloud/services/bma/v20221115/bma_models.d.ts +7 -2
  48. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +12 -12
  49. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +10 -0
  50. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +8 -0
  51. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +5 -1
  52. package/tencentcloud/services/cls/v20201016/cls_client.js +6 -0
  53. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +193 -26
  54. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +37 -32
  55. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +9 -1
  56. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +4 -0
  57. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  58. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +34 -9
  59. package/tencentcloud/services/ess/v20201111/ess_client.js +41 -10
  60. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +273 -102
  61. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +9 -5
  62. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -5
  63. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +393 -350
  64. package/tencentcloud/services/facefusion/v20181201/facefusion_models.d.ts +59 -20
  65. package/tencentcloud/services/facefusion/v20220927/facefusion_models.d.ts +36 -1
  66. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +2 -2
  67. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +10 -0
  68. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +20 -2
  69. package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -1
  70. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +2 -2
  71. package/tencentcloud/services/ocr/v20181119/ocr_client.js +2 -2
  72. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +4 -0
  73. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +50 -34
  74. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +103 -25
  75. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +9 -1
  76. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +11 -11
  77. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +4 -4
  78. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  79. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  80. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +129 -6
  81. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +7 -3
  82. package/tencentcloud/services/waf/v20180125/waf_client.js +9 -3
  83. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +76 -16
  84. package/test/apigateway.v20180808.test.js +0 -10
  85. package/test/cls.v20201016.test.js +10 -0
  86. package/test/ess.v20201111.test.js +34 -4
  87. package/test/essbasic.v20210526.test.js +12 -2
  88. package/test/vpc.v20170312.test.js +10 -0
  89. package/test/waf.v20180125.test.js +12 -2
@@ -32,6 +32,7 @@ import {
32
32
  ModifyApplicationCallbackInfoResponse,
33
33
  CreateMultiFlowSignQRCodeResponse,
34
34
  FlowCreateApprover,
35
+ ReviewerInfo,
35
36
  DescribeThirdPartyAuthCodeResponse,
36
37
  HasAuthUser,
37
38
  DisableUserAutoSignResponse,
@@ -68,6 +69,7 @@ import {
68
69
  DescribeThirdPartyAuthCodeRequest,
69
70
  UnbindEmployeeUserIdWithClientOpenIdResponse,
70
71
  CreateReleaseFlowResponse,
72
+ CreateWebThemeConfigResponse,
71
73
  BindEmployeeUserIdWithClientOpenIdRequest,
72
74
  DescribeIntegrationDepartmentsRequest,
73
75
  CreateIntegrationDepartmentResponse,
@@ -110,6 +112,7 @@ import {
110
112
  FlowDetailInfo,
111
113
  CreatePreparedPersonalEsignResponse,
112
114
  DescribeOrganizationSealsResponse,
115
+ CreateEmbedWebUrlRequest,
113
116
  DeleteIntegrationEmployeesRequest,
114
117
  FailedUpdateStaffData,
115
118
  GetTaskResultApiRequest,
@@ -118,6 +121,7 @@ import {
118
121
  CreateFlowGroupByFilesResponse,
119
122
  CreateIntegrationEmployeesResponse,
120
123
  DeleteIntegrationRoleUsersRequest,
124
+ CreateFlowByFilesRequest,
121
125
  CreateFlowSignUrlRequest,
122
126
  CreateReleaseFlowRequest,
123
127
  CreateIntegrationUserRolesRequest,
@@ -135,25 +139,28 @@ import {
135
139
  Filter,
136
140
  CreateStaffResult,
137
141
  CreateUserAutoSignEnableUrlRequest,
142
+ CreateOrganizationBatchSignUrlResponse,
138
143
  DescribeIntegrationMainOrganizationUserResponse,
139
144
  RemindFlowRecords,
140
145
  CancelUserAutoSignEnableUrlRequest,
141
146
  FailedCreateStaffData,
142
147
  ApproverRestriction,
148
+ CreateWebThemeConfigRequest,
143
149
  DeleteSealPoliciesRequest,
144
- CreateFlowByFilesRequest,
150
+ CreateOrganizationBatchSignUrlRequest,
145
151
  IntegrateRole,
146
152
  CreatePrepareFlowResponse,
147
153
  GetTaskResultApiResponse,
148
154
  CancelMultiFlowSignQRCodeRequest,
149
155
  DeleteIntegrationDepartmentRequest,
156
+ WebThemeConfig,
150
157
  ModifyApplicationCallbackInfoRequest,
151
158
  IntegrationMainOrganizationUser,
152
159
  StartFlowRequest,
153
160
  CreateSealResponse,
154
161
  CreatePrepareFlowRequest,
155
162
  ApproverOption,
156
- FileUrl,
163
+ CreateEmbedWebUrlResponse,
157
164
  CreateSealPolicyRequest,
158
165
  DescribeOrganizationSealsRequest,
159
166
  CancelFlowRequest,
@@ -184,6 +191,7 @@ import {
184
191
  CreateFlowResponse,
185
192
  DescribeUserAutoSignStatusRequest,
186
193
  FilledComponent,
194
+ FileUrl,
187
195
  FlowBrief,
188
196
  DescribeOrganizationGroupOrganizationsResponse,
189
197
  DescribeExtendedServiceAuthInfosResponse,
@@ -247,8 +255,18 @@ callbackinfo包含: 回调地址和签名key
247
255
  }
248
256
 
249
257
  /**
250
- * 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。<br/>
251
- 该接口常用来配合“创建电子文档”接口作为前置的接口使用。<br/>
258
+ * 本接口用于查询本企业模板列表。
259
+
260
+ 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
261
+
262
+ > **适用场景**
263
+ > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
264
+ > 一个模板通常会包含以下结构信息
265
+ >- 模板基本信息
266
+ >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
267
+ >- 填写控件 Components
268
+ >- 签署控件 SignComponents
269
+ >- 生成模板的文件基础信息 FileInfos
252
270
  */
253
271
  async DescribeFlowTemplates(
254
272
  req: DescribeFlowTemplatesRequest,
@@ -299,13 +317,13 @@ callbackinfo包含: 回调地址和签名key
299
317
  }
300
318
 
301
319
  /**
302
- * 此API接口用户查询加入集团的成员企业
320
+ * 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
303
321
  */
304
- async DescribeOrganizationGroupOrganizations(
305
- req: DescribeOrganizationGroupOrganizationsRequest,
306
- cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void
307
- ): Promise<DescribeOrganizationGroupOrganizationsResponse> {
308
- return this.request("DescribeOrganizationGroupOrganizations", req, cb)
322
+ async CreateEmbedWebUrl(
323
+ req: CreateEmbedWebUrlRequest,
324
+ cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void
325
+ ): Promise<CreateEmbedWebUrlResponse> {
326
+ return this.request("CreateEmbedWebUrl", req, cb)
309
327
  }
310
328
 
311
329
  /**
@@ -636,8 +654,10 @@ callbackinfo包含: 回调地址和签名key
636
654
  }
637
655
 
638
656
  /**
639
- * 创建个人H5签署链接,请联系客户经理申请使用 <br/>
640
- 该接口用于发起合同后,生成C端签署人的签署链接 <br/>
657
+ * 创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
658
+
659
+ 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
660
+
641
661
  注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
642
662
  注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
643
663
  注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
@@ -698,13 +718,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
698
718
  }
699
719
 
700
720
  /**
701
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
702
- */
703
- async DescribeFlowComponents(
704
- req: DescribeFlowComponentsRequest,
705
- cb?: (error: string, rep: DescribeFlowComponentsResponse) => void
706
- ): Promise<DescribeFlowComponentsResponse> {
707
- return this.request("DescribeFlowComponents", req, cb)
721
+ * 通过此接口,创建企业批量签署链接,企业员工点击链接即可跳转控制台进行批量签署。
722
+ 如果没有UserId,Name和Mobile必填,对应的员工必须在企业下已经实名,且该员工为批量签署合同中的签署方。
723
+ */
724
+ async CreateOrganizationBatchSignUrl(
725
+ req: CreateOrganizationBatchSignUrlRequest,
726
+ cb?: (error: string, rep: CreateOrganizationBatchSignUrlResponse) => void
727
+ ): Promise<CreateOrganizationBatchSignUrlResponse> {
728
+ return this.request("CreateOrganizationBatchSignUrl", req, cb)
708
729
  }
709
730
 
710
731
  /**
@@ -721,6 +742,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
721
742
  return this.request("CreateFlowReminds", req, cb)
722
743
  }
723
744
 
745
+ /**
746
+ * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
747
+ */
748
+ async DescribeFlowComponents(
749
+ req: DescribeFlowComponentsRequest,
750
+ cb?: (error: string, rep: DescribeFlowComponentsResponse) => void
751
+ ): Promise<DescribeFlowComponentsResponse> {
752
+ return this.request("DescribeFlowComponents", req, cb)
753
+ }
754
+
724
755
  /**
725
756
  * 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
726
757
 
@@ -743,6 +774,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
743
774
  return this.request("DescribeThirdPartyAuthCode", req, cb)
744
775
  }
745
776
 
777
+ /**
778
+ * 用来创建页面主题配置
779
+ */
780
+ async CreateWebThemeConfig(
781
+ req: CreateWebThemeConfigRequest,
782
+ cb?: (error: string, rep: CreateWebThemeConfigResponse) => void
783
+ ): Promise<CreateWebThemeConfigResponse> {
784
+ return this.request("CreateWebThemeConfig", req, cb)
785
+ }
786
+
746
787
  /**
747
788
  * 查询企业印章的列表,需要操作者具有查询印章权限
748
789
  客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
@@ -816,6 +857,16 @@ PDF资源Id 通过上传文件接口获取
816
857
  return this.request("CreateFlowGroupByFiles", req, cb)
817
858
  }
818
859
 
860
+ /**
861
+ * 此API接口用户查询加入集团的成员企业
862
+ */
863
+ async DescribeOrganizationGroupOrganizations(
864
+ req: DescribeOrganizationGroupOrganizationsRequest,
865
+ cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void
866
+ ): Promise<DescribeOrganizationGroupOrganizationsResponse> {
867
+ return this.request("DescribeOrganizationGroupOrganizations", req, cb)
868
+ }
869
+
819
870
  /**
820
871
  * 创建员工,此接口会发送提醒员工实名的短信
821
872
  */
@@ -419,6 +419,28 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
419
419
  SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
420
420
  */
421
421
  ComponentLimitType?: Array<string>
422
+ /**
423
+ * 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
424
+ */
425
+ ApproverVerifyTypes?: Array<number>
426
+ /**
427
+ * 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
428
+ */
429
+ ApproverSignTypes?: Array<number>
430
+ }
431
+
432
+ /**
433
+ * 关注方信息
434
+ */
435
+ export interface ReviewerInfo {
436
+ /**
437
+ * 姓名
438
+ */
439
+ Name?: string
440
+ /**
441
+ * 手机号
442
+ */
443
+ Mobile?: string
422
444
  }
423
445
 
424
446
  /**
@@ -1363,6 +1385,16 @@ export interface CreateReleaseFlowResponse {
1363
1385
  RequestId?: string
1364
1386
  }
1365
1387
 
1388
+ /**
1389
+ * CreateWebThemeConfig返回参数结构体
1390
+ */
1391
+ export interface CreateWebThemeConfigResponse {
1392
+ /**
1393
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1394
+ */
1395
+ RequestId?: string
1396
+ }
1397
+
1366
1398
  /**
1367
1399
  * BindEmployeeUserIdWithClientOpenId请求参数结构体
1368
1400
  */
@@ -1426,31 +1458,39 @@ export interface CreateIntegrationDepartmentResponse {
1426
1458
  */
1427
1459
  export interface DescribeFlowTemplatesRequest {
1428
1460
  /**
1429
- * 调用方用户信息,userId 必填
1461
+ * 调用方员工/经办人信息
1462
+ UserId 必填,在企业控制台组织架构中可以查到员工的UserId
1463
+ 注:请保证对应
1430
1464
  */
1431
1465
  Operator: UserInfo
1432
1466
  /**
1433
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1467
+ * 代理相关应用信息
1468
+ 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1434
1469
  */
1435
1470
  Agent?: Agent
1436
1471
  /**
1437
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
1472
+ * 查询内容类型
1473
+ 0-模板列表及详情(默认)
1474
+ 1-仅模板列表
1438
1475
  */
1439
1476
  ContentType?: number
1440
1477
  /**
1441
- * 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
1478
+ * 搜索条件,本字段用于指定模板Id进行查询。
1479
+ Key:template-id
1480
+ Values:需要查询的模板Id列表
1442
1481
  */
1443
1482
  Filters?: Array<Filter>
1444
1483
  /**
1445
- * 查询偏移位置,默认0
1484
+ * 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
1446
1485
  */
1447
1486
  Offset?: number
1448
1487
  /**
1449
- * 查询个数,默认20,最大200
1488
+ * 指定每页多少条数据,如果不传默认为20,单页最大200
1450
1489
  */
1451
1490
  Limit?: number
1452
1491
  /**
1453
- * ApplicationId不为空,查询指定应用下的模板列表
1492
+ * 用于查询指定应用号下单模板列表。
1493
+ ApplicationId不为空,查询指定应用下的模板列表
1454
1494
  ApplicationId为空,查询所有应用下的模板列表
1455
1495
  */
1456
1496
  ApplicationId?: string
@@ -2719,6 +2759,38 @@ export interface DescribeOrganizationSealsResponse {
2719
2759
  RequestId?: string
2720
2760
  }
2721
2761
 
2762
+ /**
2763
+ * CreateEmbedWebUrl请求参数结构体
2764
+ */
2765
+ export interface CreateEmbedWebUrlRequest {
2766
+ /**
2767
+ * 操作者信息
2768
+ */
2769
+ Operator: UserInfo
2770
+ /**
2771
+ * WEB嵌入资源类型。
2772
+ <br/>CREATE_SEAL: 创建印章
2773
+ <br/>PREVIEW_SEAL_LIST:预览印章列表
2774
+ <br/>PREVIEW_SEAL_DETAIL:预览印章详情
2775
+ <br/>EXTEND_SERVICE:拓展服务
2776
+
2777
+ */
2778
+ EmbedType: string
2779
+ /**
2780
+ * WEB嵌入的业务资源ID
2781
+ <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
2782
+ */
2783
+ BusinessId?: string
2784
+ /**
2785
+ * 代理相关应用信息,如集团主企业代子企业操作
2786
+ */
2787
+ Agent?: Agent
2788
+ /**
2789
+ * 抄送方信息
2790
+ */
2791
+ Reviewer?: ReviewerInfo
2792
+ }
2793
+
2722
2794
  /**
2723
2795
  * DeleteIntegrationEmployees请求参数结构体
2724
2796
  */
@@ -2885,6 +2957,110 @@ export interface DeleteIntegrationRoleUsersRequest {
2885
2957
  Agent?: Agent
2886
2958
  }
2887
2959
 
2960
+ /**
2961
+ * CreateFlowByFiles请求参数结构体
2962
+ */
2963
+ export interface CreateFlowByFilesRequest {
2964
+ /**
2965
+ * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
2966
+ */
2967
+ Operator: UserInfo
2968
+ /**
2969
+ * 签署流程名称,最大长度200个字符
2970
+ */
2971
+ FlowName: string
2972
+ /**
2973
+ * 签署参与者信息,最大限制50方
2974
+ */
2975
+ Approvers: Array<ApproverInfo>
2976
+ /**
2977
+ * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
2978
+ */
2979
+ FileIds: Array<string>
2980
+ /**
2981
+ * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
2982
+ */
2983
+ FlowType?: string
2984
+ /**
2985
+ * 经办人内容控件配置
2986
+ */
2987
+ Components?: Array<Component>
2988
+ /**
2989
+ * 被抄送人的信息列表。
2990
+ 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
2991
+ */
2992
+ CcInfos?: Array<CcInfo>
2993
+ /**
2994
+ * 是否需要预览,true:预览模式,false:非预览(默认);
2995
+ 预览链接有效期300秒;
2996
+
2997
+ 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
2998
+ */
2999
+ NeedPreview?: boolean
3000
+ /**
3001
+ * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
3002
+ */
3003
+ PreviewType?: number
3004
+ /**
3005
+ * 签署流程的签署截止时间。
3006
+ 值为unix时间戳,精确到秒,不传默认为当前时间一年后
3007
+ */
3008
+ Deadline?: number
3009
+ /**
3010
+ * 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
3011
+ */
3012
+ RemindedOn?: number
3013
+ /**
3014
+ * 发送类型:
3015
+ true:无序签
3016
+ false:有序签
3017
+ 注:默认为false(有序签)
3018
+ */
3019
+ Unordered?: boolean
3020
+ /**
3021
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
3022
+ */
3023
+ CustomShowMap?: string
3024
+ /**
3025
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3026
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
3027
+
3028
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
3029
+ */
3030
+ NeedSignReview?: boolean
3031
+ /**
3032
+ * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
3033
+ */
3034
+ UserData?: string
3035
+ /**
3036
+ * 签署人校验方式
3037
+ VerifyCheck: 人脸识别(默认)
3038
+ MobileCheck:手机号验证
3039
+ 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
3040
+ */
3041
+ ApproverVerifyType?: string
3042
+ /**
3043
+ * 签署流程描述,最大长度1000个字符
3044
+ */
3045
+ FlowDescription?: string
3046
+ /**
3047
+ * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
3048
+ */
3049
+ SignBeanTag?: number
3050
+ /**
3051
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3052
+ */
3053
+ Agent?: Agent
3054
+ /**
3055
+ * 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
3056
+ */
3057
+ CcNotifyType?: number
3058
+ /**
3059
+ * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
3060
+ */
3061
+ AutoSignScene?: string
3062
+ }
3063
+
2888
3064
  /**
2889
3065
  * CreateFlowSignUrl请求参数结构体
2890
3066
  */
@@ -2894,7 +3070,9 @@ export interface CreateFlowSignUrlRequest {
2894
3070
  */
2895
3071
  FlowId: string
2896
3072
  /**
2897
- * 流程签署人,其中ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
3073
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
3074
+
3075
+ 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
2898
3076
  */
2899
3077
  FlowApproverInfos: Array<FlowCreateApprover>
2900
3078
  /**
@@ -3362,6 +3540,24 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
3362
3540
  Agent?: Agent
3363
3541
  }
3364
3542
 
3543
+ /**
3544
+ * CreateOrganizationBatchSignUrl返回参数结构体
3545
+ */
3546
+ export interface CreateOrganizationBatchSignUrlResponse {
3547
+ /**
3548
+ * 批量签署入口链接
3549
+ */
3550
+ SignUrl?: string
3551
+ /**
3552
+ * 链接过期时间戳
3553
+ */
3554
+ ExpiredTime?: number
3555
+ /**
3556
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3557
+ */
3558
+ RequestId?: string
3559
+ }
3560
+
3365
3561
  /**
3366
3562
  * DescribeIntegrationMainOrganizationUser返回参数结构体
3367
3563
  */
@@ -3458,6 +3654,26 @@ export interface ApproverRestriction {
3458
3654
  IdCardNumber?: string
3459
3655
  }
3460
3656
 
3657
+ /**
3658
+ * CreateWebThemeConfig请求参数结构体
3659
+ */
3660
+ export interface CreateWebThemeConfigRequest {
3661
+ /**
3662
+ * 操作人信息
3663
+ */
3664
+ Operator: UserInfo
3665
+ /**
3666
+ * 主题类型
3667
+ <br/>EMBED_WEB_THEME:嵌入式主题
3668
+ <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
3669
+ */
3670
+ ThemeType: string
3671
+ /**
3672
+ * 主题配置
3673
+ */
3674
+ WebThemeConfig: WebThemeConfig
3675
+ }
3676
+
3461
3677
  /**
3462
3678
  * DeleteSealPolicies请求参数结构体
3463
3679
  */
@@ -3485,107 +3701,33 @@ export interface DeleteSealPoliciesRequest {
3485
3701
  }
3486
3702
 
3487
3703
  /**
3488
- * CreateFlowByFiles请求参数结构体
3704
+ * CreateOrganizationBatchSignUrl请求参数结构体
3489
3705
  */
3490
- export interface CreateFlowByFilesRequest {
3706
+ export interface CreateOrganizationBatchSignUrlRequest {
3491
3707
  /**
3492
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
3708
+ * 调用方用户信息,UserId 必填,支持填入集团子公司经办人UserId。
3493
3709
  */
3494
3710
  Operator: UserInfo
3495
3711
  /**
3496
- * 签署流程名称,最大长度200个字符
3497
- */
3498
- FlowName: string
3499
- /**
3500
- * 签署参与者信息,最大限制50方
3501
- */
3502
- Approvers: Array<ApproverInfo>
3503
- /**
3504
- * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
3505
- */
3506
- FileIds: Array<string>
3507
- /**
3508
- * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
3509
- */
3510
- FlowType?: string
3511
- /**
3512
- * 经办人内容控件配置
3513
- */
3514
- Components?: Array<Component>
3515
- /**
3516
- * 被抄送人的信息列表。
3517
- 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
3518
- */
3519
- CcInfos?: Array<CcInfo>
3520
- /**
3521
- * 是否需要预览,true:预览模式,false:非预览(默认);
3522
- 预览链接有效期300秒;
3523
-
3524
- 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
3525
- */
3526
- NeedPreview?: boolean
3527
- /**
3528
- * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
3529
- */
3530
- PreviewType?: number
3531
- /**
3532
- * 签署流程的签署截止时间。
3533
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
3534
- */
3535
- Deadline?: number
3536
- /**
3537
- * 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
3538
- */
3539
- RemindedOn?: number
3540
- /**
3541
- * 发送类型:
3542
- true:无序签
3543
- false:有序签
3544
- 注:默认为false(有序签)
3545
- */
3546
- Unordered?: boolean
3547
- /**
3548
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
3549
- */
3550
- CustomShowMap?: string
3551
- /**
3552
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3553
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
3554
-
3555
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
3556
- */
3557
- NeedSignReview?: boolean
3558
- /**
3559
- * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
3560
- */
3561
- UserData?: string
3562
- /**
3563
- * 签署人校验方式
3564
- VerifyCheck: 人脸识别(默认)
3565
- MobileCheck:手机号验证
3566
- 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
3567
- */
3568
- ApproverVerifyType?: string
3569
- /**
3570
- * 签署流程描述,最大长度1000个字符
3712
+ * 指定需要进行批量签署的流程id,数量1-100,填写后用户将通过链接对这些合同进行批量签署。
3571
3713
  */
3572
- FlowDescription?: string
3714
+ FlowIds: Array<string>
3573
3715
  /**
3574
- * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
3716
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填。
3575
3717
  */
3576
- SignBeanTag?: number
3718
+ Agent?: Agent
3577
3719
  /**
3578
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3720
+ * 员工的UserId,该UserId对应的员工必须已经加入企业并实名,Name和Mobile为空时该字段不能为空。(优先使用UserId对应的员工)
3579
3721
  */
3580
- Agent?: Agent
3722
+ UserId?: string
3581
3723
  /**
3582
- * 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
3724
+ * 员工姓名,该字段需要与Mobile组合使用,UserId为空时该字段不能为空。(UserId为空时,使用Name和Mbile对应的员工)
3583
3725
  */
3584
- CcNotifyType?: number
3726
+ Name?: string
3585
3727
  /**
3586
- * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
3728
+ * 员工手机号码,该字段需要与Name组合使用,UserId为空时该字段不能为空。(UserId为空时,使用Name和Mbile对应的员工)
3587
3729
  */
3588
- AutoSignScene?: string
3730
+ Mobile?: string
3589
3731
  }
3590
3732
 
3591
3733
  /**
@@ -3707,6 +3849,24 @@ export interface DeleteIntegrationDepartmentRequest {
3707
3849
  ReceiveDeptId?: string
3708
3850
  }
3709
3851
 
3852
+ /**
3853
+ * 页面主题配置
3854
+ */
3855
+ export interface WebThemeConfig {
3856
+ /**
3857
+ * 是否页面底部显示电子签logo
3858
+ <br/>true:允许在页面底部隐藏电子签logo
3859
+ <br/>false:不允许允许在页面底部隐藏电子签logo
3860
+ <br/>默认false,不隐藏logo
3861
+ */
3862
+ DisplaySignBrandLogo?: boolean
3863
+ /**
3864
+ * 主题颜色
3865
+ <br/>支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
3866
+ */
3867
+ WebEmbedThemeColor?: string
3868
+ }
3869
+
3710
3870
  /**
3711
3871
  * ModifyApplicationCallbackInfo请求参数结构体
3712
3872
  */
@@ -3827,6 +3987,10 @@ export interface CreatePrepareFlowRequest {
3827
3987
  * 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
3828
3988
  */
3829
3989
  IntelligentStatus?: string
3990
+ /**
3991
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3992
+ */
3993
+ Agent?: Agent
3830
3994
  }
3831
3995
 
3832
3996
  /**
@@ -3844,18 +4008,18 @@ export interface ApproverOption {
3844
4008
  }
3845
4009
 
3846
4010
  /**
3847
- * 下载文件的URL信息
4011
+ * CreateEmbedWebUrl返回参数结构体
3848
4012
  */
3849
- export interface FileUrl {
4013
+ export interface CreateEmbedWebUrlResponse {
3850
4014
  /**
3851
- * 下载文件的URL,有效期为输入的UrlTtl,默认5分钟
4015
+ * 嵌入的web链接,有效期:5分钟
4016
+ EmbedType=PREVIEW_CC_FLOW,该url为h5链接
3852
4017
  */
3853
- Url: string
4018
+ WebUrl?: string
3854
4019
  /**
3855
- * 下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
3856
- 注意:此字段可能返回 null,表示取不到有效值。
4020
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3857
4021
  */
3858
- Option: string
4022
+ RequestId?: string
3859
4023
  }
3860
4024
 
3861
4025
  /**
@@ -4801,6 +4965,21 @@ export interface FilledComponent {
4801
4965
  ImageUrl?: string
4802
4966
  }
4803
4967
 
4968
+ /**
4969
+ * 下载文件的URL信息
4970
+ */
4971
+ export interface FileUrl {
4972
+ /**
4973
+ * 下载文件的URL,有效期为输入的UrlTtl,默认5分钟
4974
+ */
4975
+ Url: string
4976
+ /**
4977
+ * 下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
4978
+ 注意:此字段可能返回 null,表示取不到有效值。
4979
+ */
4980
+ Option: string
4981
+ }
4982
+
4804
4983
  /**
4805
4984
  * 流程信息摘要
4806
4985
  */