tencentcloud-sdk-nodejs 4.0.523 → 4.0.524

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 (40) hide show
  1. package/CHANGELOG.md +156 -0
  2. package/SERVICE_CHANGELOG.md +202 -170
  3. package/package.json +1 -1
  4. package/products.md +12 -12
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cdb/v20170320/cdb_models.ts +15 -0
  7. package/src/services/ckafka/v20190819/ckafka_models.ts +2 -2
  8. package/src/services/ess/v20201111/ess_client.ts +16 -3
  9. package/src/services/ess/v20201111/ess_models.ts +230 -161
  10. package/src/services/essbasic/v20210526/essbasic_client.ts +15 -2
  11. package/src/services/essbasic/v20210526/essbasic_models.ts +83 -13
  12. package/src/services/gme/v20180711/gme_client.ts +6 -6
  13. package/src/services/gme/v20180711/gme_models.ts +25 -25
  14. package/src/services/lcic/v20220817/lcic_client.ts +4 -2
  15. package/src/services/lcic/v20220817/lcic_models.ts +58 -23
  16. package/src/services/teo/v20220901/teo_models.ts +2 -2
  17. package/src/services/tiw/v20190919/tiw_models.ts +29 -11
  18. package/src/services/trp/v20210515/trp_models.ts +10 -0
  19. package/src/services/vod/v20180717/vod_models.ts +1 -1
  20. package/tencentcloud/common/sdk_version.d.ts +1 -1
  21. package/tencentcloud/common/sdk_version.js +1 -1
  22. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +12 -0
  23. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +2 -2
  24. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +5 -1
  25. package/tencentcloud/services/ess/v20201111/ess_client.js +6 -0
  26. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +197 -138
  27. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +5 -1
  28. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +6 -0
  29. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +72 -13
  30. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +6 -6
  31. package/tencentcloud/services/gme/v20180711/gme_client.js +6 -6
  32. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +25 -25
  33. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +2 -2
  34. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +49 -20
  35. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +2 -2
  36. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +26 -11
  37. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +8 -0
  38. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +1 -1
  39. package/test/ess.v20201111.test.js +10 -0
  40. package/test/essbasic.v20210526.test.js +10 -0
@@ -2536,6 +2536,16 @@ export interface TraceCode {
2536
2536
  * 产品名称
2537
2537
  */
2538
2538
  ProductName: string
2539
+
2540
+ /**
2541
+ * 渠道商ID
2542
+ */
2543
+ AgentId?: number
2544
+
2545
+ /**
2546
+ * 码层级 0: 最小级, 1: 一级, 2: 二级
2547
+ */
2548
+ Level?: number
2539
2549
  }
2540
2550
 
2541
2551
  /**
@@ -1700,7 +1700,7 @@ export interface ComposeMediaResponse {
1700
1700
  /**
1701
1701
  * 制作媒体文件的任务 ID,可以通过该 ID 查询制作任务(任务类型为 MakeMedia)的状态。
1702
1702
  */
1703
- TaskId: string
1703
+ TaskId?: string
1704
1704
 
1705
1705
  /**
1706
1706
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.523";
1
+ export declare const sdkVersion = "4.0.524";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.523";
4
+ exports.sdkVersion = "4.0.524";
@@ -6492,6 +6492,18 @@ export interface CommonTimeWindow {
6492
6492
  * 周日的时间窗,格式如: 02:00-06:00
6493
6493
  */
6494
6494
  Sunday?: string;
6495
+ /**
6496
+ * 常规备份保留策略,weekly-按周备份,monthly-按月备份,默认为weekly
6497
+ */
6498
+ BackupPeriodStrategy?: string;
6499
+ /**
6500
+ * 如果设置为按月备份,需填入每月具体备份日期,相邻备份天数不得超过两天。例[1,4,7,9,11,14,17,19,22,25,28,30,31]
6501
+ */
6502
+ Days?: Array<number>;
6503
+ /**
6504
+ * 月度备份时间窗,BackupPeriodStrategy为monthly时必填。格式如: 02:00-06:00
6505
+ */
6506
+ BackupPeriodTime?: string;
6495
6507
  }
6496
6508
  /**
6497
6509
  * ModifyAccountMaxUserConnections请求参数结构体
@@ -1602,7 +1602,7 @@ export interface DescribeInstancesDetailResponse {
1602
1602
  /**
1603
1603
  * 返回的实例详情结果对象
1604
1604
  */
1605
- Result: InstanceDetailResponse;
1605
+ Result?: InstanceDetailResponse;
1606
1606
  /**
1607
1607
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1608
1608
  */
@@ -5205,7 +5205,7 @@ export interface DescribeInstancesDetailRequest {
5205
5205
  */
5206
5206
  InstanceId?: string;
5207
5207
  /**
5208
- * (过滤条件)按照实例名称过滤,支持模糊查询
5208
+ * (过滤条件)按照实例名,实例Id,可用区,私有网络id,子网id 过滤,支持模糊查询
5209
5209
  */
5210
5210
  SearchWord?: string;
5211
5211
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, UploadFilesRequest, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, CreateBatchCancelFlowUrlResponse, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateFlowByFilesRequest, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, CreateSchemeUrlResponse, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, StartFlowRequest, CreatePrepareFlowRequest, DeleteIntegrationEmployeesResponse, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeFlowBriefsRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
3
+ import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, UploadFilesRequest, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, CreateBatchCancelFlowUrlResponse, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, CreateSchemeUrlResponse, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, StartFlowRequest, CreatePrepareFlowRequest, DeleteIntegrationEmployeesResponse, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeFlowBriefsRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -126,6 +126,10 @@ export declare class Client extends AbstractClient {
126
126
  调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,并设置参数Version/版本号为2020-12-22
127
127
  */
128
128
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
129
+ /**
130
+ * 创建签署链接,需要联系运营人员开白后才可使用
131
+ */
132
+ CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
129
133
  /**
130
134
  * 通过AuthCode查询用户是否实名
131
135
  */
@@ -190,6 +190,12 @@ class Client extends abstract_client_1.AbstractClient {
190
190
  async UploadFiles(req, cb) {
191
191
  return this.request("UploadFiles", req, cb);
192
192
  }
193
+ /**
194
+ * 创建签署链接,需要联系运营人员开白后才可使用
195
+ */
196
+ async CreateFlowSignUrl(req, cb) {
197
+ return this.request("CreateFlowSignUrl", req, cb);
198
+ }
193
199
  /**
194
200
  * 通过AuthCode查询用户是否实名
195
201
  */
@@ -142,73 +142,6 @@ export interface CreateMultiFlowSignQRCodeResponse {
142
142
  */
143
143
  RequestId?: string;
144
144
  }
145
- /**
146
- * DescribeThirdPartyAuthCode返回参数结构体
147
- */
148
- export interface DescribeThirdPartyAuthCodeResponse {
149
- /**
150
- * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
151
- */
152
- VerifyStatus: string;
153
- /**
154
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
155
- */
156
- RequestId?: string;
157
- }
158
- /**
159
- * CreateIntegrationEmployees请求参数结构体
160
- */
161
- export interface CreateIntegrationEmployeesRequest {
162
- /**
163
- * 操作人信息,userId必填
164
- */
165
- Operator: UserInfo;
166
- /**
167
- * 待创建员工的信息,Mobile和DisplayName必填
168
- */
169
- Employees: Array<Staff>;
170
- }
171
- /**
172
- * CreateFlowEvidenceReport请求参数结构体
173
- */
174
- export interface CreateFlowEvidenceReportRequest {
175
- /**
176
- * 调用方用户信息,userId 必填
177
- */
178
- Operator: UserInfo;
179
- /**
180
- * 签署流程编号
181
- */
182
- FlowId: string;
183
- }
184
- /**
185
- * StartFlow返回参数结构体
186
- */
187
- export interface StartFlowResponse {
188
- /**
189
- * 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
190
- */
191
- Status: string;
192
- /**
193
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
194
- */
195
- RequestId?: string;
196
- }
197
- /**
198
- * 集成版企业角色信息
199
- */
200
- export interface StaffRole {
201
- /**
202
- * 角色id
203
- 注意:此字段可能返回 null,表示取不到有效值。
204
- */
205
- RoleId: string;
206
- /**
207
- * 角色名称
208
- 注意:此字段可能返回 null,表示取不到有效值。
209
- */
210
- RoleName: string;
211
- }
212
145
  /**
213
146
  * 创建流程的签署方信息
214
147
  */
@@ -288,6 +221,98 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
288
221
  */
289
222
  ApproverOption?: ApproverOption;
290
223
  }
224
+ /**
225
+ * DescribeThirdPartyAuthCode返回参数结构体
226
+ */
227
+ export interface DescribeThirdPartyAuthCodeResponse {
228
+ /**
229
+ * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
230
+ */
231
+ VerifyStatus: string;
232
+ /**
233
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
234
+ */
235
+ RequestId?: string;
236
+ }
237
+ /**
238
+ * CreateIntegrationEmployees请求参数结构体
239
+ */
240
+ export interface CreateIntegrationEmployeesRequest {
241
+ /**
242
+ * 操作人信息,userId必填
243
+ */
244
+ Operator: UserInfo;
245
+ /**
246
+ * 待创建员工的信息,Mobile和DisplayName必填
247
+ */
248
+ Employees: Array<Staff>;
249
+ }
250
+ /**
251
+ * CreateFlowEvidenceReport请求参数结构体
252
+ */
253
+ export interface CreateFlowEvidenceReportRequest {
254
+ /**
255
+ * 调用方用户信息,userId 必填
256
+ */
257
+ Operator: UserInfo;
258
+ /**
259
+ * 签署流程编号
260
+ */
261
+ FlowId: string;
262
+ }
263
+ /**
264
+ * StartFlow返回参数结构体
265
+ */
266
+ export interface StartFlowResponse {
267
+ /**
268
+ * 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
269
+ */
270
+ Status: string;
271
+ /**
272
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
273
+ */
274
+ RequestId?: string;
275
+ }
276
+ /**
277
+ * 集成版企业角色信息
278
+ */
279
+ export interface StaffRole {
280
+ /**
281
+ * 角色id
282
+ 注意:此字段可能返回 null,表示取不到有效值。
283
+ */
284
+ RoleId: string;
285
+ /**
286
+ * 角色名称
287
+ 注意:此字段可能返回 null,表示取不到有效值。
288
+ */
289
+ RoleName: string;
290
+ }
291
+ /**
292
+ * 签署链接信息
293
+ */
294
+ export interface FlowApproverUrlInfo {
295
+ /**
296
+ * 签署链接,注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
297
+ 注意:此字段可能返回 null,表示取不到有效值。
298
+ */
299
+ SignUrl?: string;
300
+ /**
301
+ * 签署人手机号
302
+ 注意:此字段可能返回 null,表示取不到有效值。
303
+ */
304
+ ApproverMobile?: string;
305
+ /**
306
+ * 签署人姓名
307
+ 注意:此字段可能返回 null,表示取不到有效值。
308
+ */
309
+ ApproverName?: string;
310
+ /**
311
+ * 签署人类型 1-个人
312
+ 注意:此字段可能返回 null,表示取不到有效值。
313
+ */
314
+ ApproverType?: number;
315
+ }
291
316
  /**
292
317
  * CreateConvertTaskApi请求参数结构体
293
318
  */
@@ -1048,6 +1073,19 @@ MobileCheck:手机号验证
1048
1073
  */
1049
1074
  SignBeanTag?: number;
1050
1075
  }
1076
+ /**
1077
+ * CreateFlowSignUrl返回参数结构体
1078
+ */
1079
+ export interface CreateFlowSignUrlResponse {
1080
+ /**
1081
+ * 签署人签署链接信息
1082
+ */
1083
+ FlowApproverUrlInfos: Array<FlowApproverUrlInfo>;
1084
+ /**
1085
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1086
+ */
1087
+ RequestId?: string;
1088
+ }
1051
1089
  /**
1052
1090
  * DescribeFileUrls请求参数结构体
1053
1091
  */
@@ -1506,6 +1544,27 @@ export interface RegisterInfo {
1506
1544
  */
1507
1545
  Uscc: string;
1508
1546
  }
1547
+ /**
1548
+ * CreateFlowSignUrl请求参数结构体
1549
+ */
1550
+ export interface CreateFlowSignUrlRequest {
1551
+ /**
1552
+ * 流程编号
1553
+ */
1554
+ FlowId: string;
1555
+ /**
1556
+ * 流程签署人,其中ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
1557
+ */
1558
+ FlowApproverInfos: Array<FlowCreateApprover>;
1559
+ /**
1560
+ * 机构信息,暂未开放
1561
+ */
1562
+ Organization: OrganizationInfo;
1563
+ /**
1564
+ * 用户信息,此结构体UserId必填
1565
+ */
1566
+ Operator?: UserInfo;
1567
+ }
1509
1568
  /**
1510
1569
  * CreateIntegrationEmployees返回参数结构体
1511
1570
  */
@@ -1692,17 +1751,76 @@ export interface VerifyPdfRequest {
1692
1751
  Operator?: UserInfo;
1693
1752
  }
1694
1753
  /**
1695
- * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
1754
+ * 参与者信息
1696
1755
  */
1697
- export interface UploadFile {
1756
+ export interface ApproverInfo {
1698
1757
  /**
1699
- * Base64编码后的文件内容
1758
+ * 参与者类型:
1759
+ 0:企业
1760
+ 1:个人
1761
+ 3:企业静默签署
1762
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
1700
1763
  */
1701
- FileBody: string;
1764
+ ApproverType: number;
1702
1765
  /**
1703
- * 文件名,最大长度不超过200字符
1766
+ * 本环节需要操作人的名字
1704
1767
  */
1705
- FileName?: string;
1768
+ ApproverName: string;
1769
+ /**
1770
+ * 本环节需要操作人的手机号
1771
+ */
1772
+ ApproverMobile: string;
1773
+ /**
1774
+ * 本环节操作人签署控件配置
1775
+ */
1776
+ SignComponents: Array<Component>;
1777
+ /**
1778
+ * 如果是企业,则为企业的名字
1779
+ */
1780
+ OrganizationName?: string;
1781
+ /**
1782
+ * 身份证号
1783
+ */
1784
+ ApproverIdCardNumber?: string;
1785
+ /**
1786
+ * 证件类型
1787
+ ID_CARD 身份证
1788
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
1789
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1790
+ */
1791
+ ApproverIdCardType?: string;
1792
+ /**
1793
+ * sms--短信,none--不通知
1794
+ */
1795
+ NotifyType?: string;
1796
+ /**
1797
+ * 1--收款人、2--开具人、3--见证人
1798
+ */
1799
+ ApproverRole?: number;
1800
+ /**
1801
+ * 签署意愿确认渠道,WEIXINAPP:人脸识别
1802
+ */
1803
+ VerifyChannel?: Array<string>;
1804
+ /**
1805
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
1806
+ */
1807
+ PreReadTime?: number;
1808
+ /**
1809
+ * 签署人userId,传此字段则不用传姓名、手机号
1810
+ */
1811
+ UserId?: string;
1812
+ /**
1813
+ * 签署人用户来源,企微侧用户请传入:WEWORKAPP
1814
+ */
1815
+ ApproverSource?: string;
1816
+ /**
1817
+ * 客户自定义签署人标识,64位长度,保证唯一,非企微场景不使用此字段
1818
+ */
1819
+ CustomApproverTag?: string;
1820
+ /**
1821
+ * 签署人个性化能力值
1822
+ */
1823
+ ApproverOption?: ApproverOption;
1706
1824
  }
1707
1825
  /**
1708
1826
  * CreateFlowSignReview返回参数结构体
@@ -1995,76 +2113,17 @@ export interface CancelFlowRequest {
1995
2113
  Agent?: Agent;
1996
2114
  }
1997
2115
  /**
1998
- * 参与者信息
2116
+ * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
1999
2117
  */
2000
- export interface ApproverInfo {
2001
- /**
2002
- * 参与者类型:
2003
- 0:企业
2004
- 1:个人
2005
- 3:企业静默签署
2006
- 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
2007
- */
2008
- ApproverType: number;
2009
- /**
2010
- * 本环节需要操作人的名字
2011
- */
2012
- ApproverName: string;
2013
- /**
2014
- * 本环节需要操作人的手机号
2015
- */
2016
- ApproverMobile: string;
2017
- /**
2018
- * 本环节操作人签署控件配置
2019
- */
2020
- SignComponents: Array<Component>;
2021
- /**
2022
- * 如果是企业,则为企业的名字
2023
- */
2024
- OrganizationName?: string;
2025
- /**
2026
- * 身份证号
2027
- */
2028
- ApproverIdCardNumber?: string;
2029
- /**
2030
- * 证件类型
2031
- ID_CARD 身份证
2032
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
2033
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2034
- */
2035
- ApproverIdCardType?: string;
2036
- /**
2037
- * sms--短信,none--不通知
2038
- */
2039
- NotifyType?: string;
2040
- /**
2041
- * 1--收款人、2--开具人、3--见证人
2042
- */
2043
- ApproverRole?: number;
2044
- /**
2045
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
2046
- */
2047
- VerifyChannel?: Array<string>;
2048
- /**
2049
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
2050
- */
2051
- PreReadTime?: number;
2052
- /**
2053
- * 签署人userId,传此字段则不用传姓名、手机号
2054
- */
2055
- UserId?: string;
2056
- /**
2057
- * 签署人用户来源,企微侧用户请传入:WEWORKAPP
2058
- */
2059
- ApproverSource?: string;
2118
+ export interface UploadFile {
2060
2119
  /**
2061
- * 客户自定义签署人标识,64位长度,保证唯一,非企微场景不使用此字段
2120
+ * Base64编码后的文件内容
2062
2121
  */
2063
- CustomApproverTag?: string;
2122
+ FileBody: string;
2064
2123
  /**
2065
- * 签署人个性化能力值
2124
+ * 文件名,最大长度不超过200字符
2066
2125
  */
2067
- ApproverOption?: ApproverOption;
2126
+ FileName?: string;
2068
2127
  }
2069
2128
  /**
2070
2129
  * 模板控件信息
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateSealByImageResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, SyncProxyOrganizationRequest, CreateSealByImageRequest, PrepareFlowsRequest, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowGroupByFilesRequest, DescribeFlowDetailInfoResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, UploadFilesRequest, ChannelDescribeOrganizationSealsRequest, DescribeExtendedServiceAuthInfoRequest, DescribeUsageResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, DescribeResourceUrlsByFlowsResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelGetTaskResultApiRequest, CreateFlowsByTemplatesResponse, SyncProxyOrganizationOperatorsResponse, DescribeUsageRequest, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, DescribeChannelFlowEvidenceReportRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDescribeOrganizationSealsResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelCreateReleaseFlowRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreateBoundFlowsResponse, ModifyExtendedServiceResponse, ChannelGetTaskResultApiResponse, DescribeExtendedServiceAuthInfoResponse, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, CreateFlowsByTemplatesRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse } from "./essbasic_models";
3
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowSignUrlResponse, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateSealByImageResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, SyncProxyOrganizationRequest, CreateSealByImageRequest, ChannelCreateFlowSignUrlRequest, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowGroupByFilesRequest, DescribeFlowDetailInfoResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelVerifyPdfResponse, DescribeChannelFlowEvidenceReportRequest, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, UploadFilesRequest, ChannelDescribeOrganizationSealsRequest, DescribeExtendedServiceAuthInfoRequest, DescribeUsageResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, DescribeResourceUrlsByFlowsResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelGetTaskResultApiRequest, CreateFlowsByTemplatesResponse, SyncProxyOrganizationOperatorsResponse, DescribeUsageRequest, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDescribeOrganizationSealsResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelCreateReleaseFlowRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreateBoundFlowsResponse, ModifyExtendedServiceResponse, ChannelGetTaskResultApiResponse, DescribeExtendedServiceAuthInfoResponse, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, CreateFlowsByTemplatesRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse } from "./essbasic_models";
4
4
  /**
5
5
  * essbasic client
6
6
  * @class
@@ -164,6 +164,10 @@ HttpProfile httpProfile = new HttpProfile();
164
164
  httpProfile.setEndpoint("file.test.ess.tencent.cn");
165
165
  */
166
166
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
167
+ /**
168
+ * 渠道版创建签署链接,需要联系运营人员开白后才可使用
169
+ */
170
+ ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
167
171
  /**
168
172
  * 此接口(SyncProxyOrganization)用于同步渠道子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
169
173
  */
@@ -238,6 +238,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
238
238
  async UploadFiles(req, cb) {
239
239
  return this.request("UploadFiles", req, cb);
240
240
  }
241
+ /**
242
+ * 渠道版创建签署链接,需要联系运营人员开白后才可使用
243
+ */
244
+ async ChannelCreateFlowSignUrl(req, cb) {
245
+ return this.request("ChannelCreateFlowSignUrl", req, cb);
246
+ }
241
247
  /**
242
248
  * 此接口(SyncProxyOrganization)用于同步渠道子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
243
249
  */
@@ -20,6 +20,19 @@ export interface ChannelCreateConvertTaskApiResponse {
20
20
  */
21
21
  RequestId?: string;
22
22
  }
23
+ /**
24
+ * ChannelCreateFlowSignUrl返回参数结构体
25
+ */
26
+ export interface ChannelCreateFlowSignUrlResponse {
27
+ /**
28
+ * 签署人签署链接信息
29
+ */
30
+ FlowApproverUrlInfos: Array<FlowApproverUrlInfo>;
31
+ /**
32
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
33
+ */
34
+ RequestId?: string;
35
+ }
23
36
  /**
24
37
  * ChannelBatchCancelFlows返回参数结构体
25
38
  */
@@ -333,25 +346,29 @@ export interface CreateSealByImageRequest {
333
346
  Operator?: UserInfo;
334
347
  }
335
348
  /**
336
- * PrepareFlows请求参数结构体
349
+ * ChannelCreateFlowSignUrl请求参数结构体
337
350
  */
338
- export interface PrepareFlowsRequest {
351
+ export interface ChannelCreateFlowSignUrlRequest {
339
352
  /**
340
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
353
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
341
354
  */
342
355
  Agent: Agent;
343
356
  /**
344
- * 多个合同(签署流程)信息,最大支持20个签署流程。
357
+ * 流程编号
345
358
  */
346
- FlowInfos: Array<FlowInfo>;
359
+ FlowId: string;
347
360
  /**
348
- * 操作完成后的跳转地址,最大长度200
361
+ * 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
349
362
  */
350
- JumpUrl: string;
363
+ FlowApproverInfos: Array<FlowApproverInfo>;
351
364
  /**
352
- * 操作者的信息
365
+ * 用户信息,暂未开放
353
366
  */
354
367
  Operator?: UserInfo;
368
+ /**
369
+ * 机构信息,暂未开放
370
+ */
371
+ Organization?: OrganizationInfo;
355
372
  }
356
373
  /**
357
374
  * ChannelCancelFlow返回参数结构体
@@ -375,6 +392,27 @@ export interface DownloadFlowInfo {
375
392
  */
376
393
  FlowIdList: Array<string>;
377
394
  }
395
+ /**
396
+ * 签署人签署链接信息
397
+ */
398
+ export interface FlowApproverUrlInfo {
399
+ /**
400
+ * 签署链接,注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
401
+ */
402
+ SignUrl: string;
403
+ /**
404
+ * 签署人手机号
405
+ */
406
+ Mobile: string;
407
+ /**
408
+ * 签署人姓名
409
+ */
410
+ Name: string;
411
+ /**
412
+ * 签署人类型 PERSON-个人
413
+ */
414
+ ApproverType: string;
415
+ }
378
416
  /**
379
417
  * ChannelCreateConvertTaskApi请求参数结构体
380
418
  */
@@ -948,6 +986,23 @@ export interface ChannelVerifyPdfResponse {
948
986
  */
949
987
  RequestId?: string;
950
988
  }
989
+ /**
990
+ * DescribeChannelFlowEvidenceReport请求参数结构体
991
+ */
992
+ export interface DescribeChannelFlowEvidenceReportRequest {
993
+ /**
994
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
995
+ */
996
+ Agent: Agent;
997
+ /**
998
+ * 出证报告编号
999
+ */
1000
+ ReportId: string;
1001
+ /**
1002
+ * 操作者的信息
1003
+ */
1004
+ Operator?: UserInfo;
1005
+ }
951
1006
  /**
952
1007
  * CreateConsoleLoginUrl请求参数结构体
953
1008
  */
@@ -2183,17 +2238,21 @@ export interface ApproverRestriction {
2183
2238
  IdCardNumber?: string;
2184
2239
  }
2185
2240
  /**
2186
- * DescribeChannelFlowEvidenceReport请求参数结构体
2241
+ * PrepareFlows请求参数结构体
2187
2242
  */
2188
- export interface DescribeChannelFlowEvidenceReportRequest {
2243
+ export interface PrepareFlowsRequest {
2189
2244
  /**
2190
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
2245
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2191
2246
  */
2192
2247
  Agent: Agent;
2193
2248
  /**
2194
- * 出证报告编号
2249
+ * 多个合同(签署流程)信息,最大支持20个签署流程。
2195
2250
  */
2196
- ReportId: string;
2251
+ FlowInfos: Array<FlowInfo>;
2252
+ /**
2253
+ * 操作完成后的跳转地址,最大长度200
2254
+ */
2255
+ JumpUrl: string;
2197
2256
  /**
2198
2257
  * 操作者的信息
2199
2258
  */