tencentcloud-sdk-nodejs 4.0.358 → 4.0.361

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 (125) hide show
  1. package/CHANGELOG.md +430 -0
  2. package/SERVICE_CHANGELOG.md +459 -67
  3. package/package.json +1 -1
  4. package/products.md +31 -30
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/acp/v20220105/acp_client.ts +25 -12
  7. package/src/services/acp/v20220105/acp_models.ts +50 -0
  8. package/src/services/apigateway/v20180808/apigateway_client.ts +30 -17
  9. package/src/services/apigateway/v20180808/apigateway_models.ts +74 -22
  10. package/src/services/cat/v20180409/cat_client.ts +38 -377
  11. package/src/services/cat/v20180409/cat_models.ts +384 -2402
  12. package/src/services/cdb/v20170320/cdb_models.ts +2 -2
  13. package/src/services/cdn/v20180606/cdn_models.ts +13 -1
  14. package/src/services/ciam/index.ts +5 -0
  15. package/src/services/ciam/v20220331/ciam_client.ts +40 -0
  16. package/src/services/ciam/v20220331/ciam_models.ts +46 -0
  17. package/src/services/ciam/v20220331/index.ts +6 -0
  18. package/src/services/dlc/v20210125/dlc_models.ts +6 -0
  19. package/src/services/ess/v20201111/ess_client.ts +27 -1
  20. package/src/services/ess/v20201111/ess_models.ts +161 -51
  21. package/src/services/essbasic/v20210526/essbasic_client.ts +45 -19
  22. package/src/services/essbasic/v20210526/essbasic_models.ts +127 -15
  23. package/src/services/facefusion/v20181201/facefusion_models.ts +1 -1
  24. package/src/services/index.ts +1 -0
  25. package/src/services/ivld/v20210903/ivld_client.ts +4 -2
  26. package/src/services/live/v20180801/live_client.ts +15 -2
  27. package/src/services/live/v20180801/live_models.ts +105 -37
  28. package/src/services/mmps/v20200710/mmps_client.ts +30 -5
  29. package/src/services/mmps/v20200710/mmps_models.ts +193 -103
  30. package/src/services/monitor/v20180724/monitor_models.ts +1 -1
  31. package/src/services/oceanus/v20190422/oceanus_client.ts +22 -0
  32. package/src/services/oceanus/v20190422/oceanus_models.ts +40 -0
  33. package/src/services/ocr/v20181119/ocr_client.ts +2 -1
  34. package/src/services/ocr/v20181119/ocr_models.ts +28 -3
  35. package/src/services/partners/v20180321/partners_models.ts +1 -1
  36. package/src/services/postgres/v20170312/postgres_models.ts +53 -38
  37. package/src/services/ses/v20201002/ses_client.ts +2 -2
  38. package/src/services/ses/v20201002/ses_models.ts +2 -2
  39. package/src/services/ssl/v20191205/ssl_models.ts +19 -1
  40. package/src/services/tbaas/v20180416/tbaas_models.ts +1 -1
  41. package/src/services/tcr/v20190924/tcr_models.ts +15 -0
  42. package/src/services/tdmq/v20200217/tdmq_models.ts +4 -4
  43. package/src/services/teo/v20220106/teo_client.ts +19 -6
  44. package/src/services/teo/v20220106/teo_models.ts +81 -0
  45. package/src/services/tiia/v20190529/tiia_client.ts +34 -11
  46. package/src/services/tiia/v20190529/tiia_models.ts +70 -14
  47. package/src/services/trtc/v20190722/trtc_client.ts +2 -0
  48. package/src/services/trtc/v20190722/trtc_models.ts +104 -1
  49. package/src/services/vod/v20180717/vod_models.ts +15 -11
  50. package/src/services/vpc/v20170312/vpc_models.ts +2 -2
  51. package/tencentcloud/common/sdk_version.d.ts +1 -1
  52. package/tencentcloud/common/sdk_version.js +1 -1
  53. package/tencentcloud/services/acp/v20220105/acp_client.d.ts +9 -5
  54. package/tencentcloud/services/acp/v20220105/acp_client.js +12 -6
  55. package/tencentcloud/services/acp/v20220105/acp_models.d.ts +43 -0
  56. package/tencentcloud/services/apigateway/v20180808/apigateway_client.d.ts +10 -6
  57. package/tencentcloud/services/apigateway/v20180808/apigateway_client.js +13 -7
  58. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +65 -20
  59. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +9 -117
  60. package/tencentcloud/services/cat/v20180409/cat_client.js +12 -174
  61. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +348 -2028
  62. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +2 -2
  63. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +11 -1
  64. package/tencentcloud/services/ciam/index.d.ts +6 -0
  65. package/tencentcloud/services/ciam/index.js +7 -0
  66. package/tencentcloud/services/ciam/v20220331/ciam_client.d.ts +14 -0
  67. package/tencentcloud/services/ciam/v20220331/ciam_client.js +37 -0
  68. package/tencentcloud/services/ciam/v20220331/ciam_models.d.ts +26 -0
  69. package/tencentcloud/services/ciam/v20220331/ciam_models.js +18 -0
  70. package/tencentcloud/services/ciam/v20220331/index.d.ts +6 -0
  71. package/tencentcloud/services/ciam/v20220331/index.js +9 -0
  72. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +5 -0
  73. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +10 -1
  74. package/tencentcloud/services/ess/v20201111/ess_client.js +13 -0
  75. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +139 -46
  76. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +18 -9
  77. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +23 -10
  78. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +109 -14
  79. package/tencentcloud/services/facefusion/v20181201/facefusion_models.d.ts +1 -1
  80. package/tencentcloud/services/index.d.ts +1 -0
  81. package/tencentcloud/services/index.js +2 -0
  82. package/tencentcloud/services/ivld/v20210903/ivld_client.d.ts +4 -2
  83. package/tencentcloud/services/ivld/v20210903/ivld_client.js +4 -2
  84. package/tencentcloud/services/live/v20180801/live_client.d.ts +5 -1
  85. package/tencentcloud/services/live/v20180801/live_client.js +6 -0
  86. package/tencentcloud/services/live/v20180801/live_models.d.ts +91 -32
  87. package/tencentcloud/services/mmps/v20200710/mmps_client.d.ts +9 -1
  88. package/tencentcloud/services/mmps/v20200710/mmps_client.js +12 -0
  89. package/tencentcloud/services/mmps/v20200710/mmps_models.d.ts +164 -88
  90. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +1 -1
  91. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +15 -1
  92. package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +16 -0
  93. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +34 -0
  94. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  95. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  96. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +24 -3
  97. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +1 -1
  98. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +50 -38
  99. package/tencentcloud/services/ses/v20201002/ses_client.d.ts +2 -2
  100. package/tencentcloud/services/ses/v20201002/ses_client.js +2 -2
  101. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +2 -2
  102. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +17 -1
  103. package/tencentcloud/services/tbaas/v20180416/tbaas_models.d.ts +1 -1
  104. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +12 -0
  105. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +4 -4
  106. package/tencentcloud/services/teo/v20220106/teo_client.d.ts +7 -3
  107. package/tencentcloud/services/teo/v20220106/teo_client.js +9 -3
  108. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +69 -0
  109. package/tencentcloud/services/tiia/v20190529/tiia_client.d.ts +25 -11
  110. package/tencentcloud/services/tiia/v20190529/tiia_client.js +26 -10
  111. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +61 -12
  112. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +86 -1
  113. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +14 -10
  114. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +2 -2
  115. package/test/acp.v20220105.test.js +14 -4
  116. package/test/apigateway.v20180808.test.js +14 -4
  117. package/test/cat.v20180409.test.js +8 -278
  118. package/test/ciam.v20220331.test.js +31 -0
  119. package/test/ess.v20201111.test.js +20 -0
  120. package/test/essbasic.v20210526.test.js +24 -4
  121. package/test/live.v20180801.test.js +10 -0
  122. package/test/mmps.v20200710.test.js +20 -0
  123. package/test/oceanus.v20190422.test.js +10 -0
  124. package/test/teo.v20220106.test.js +12 -2
  125. package/test/tiia.v20190529.test.js +10 -0
@@ -3636,7 +3636,7 @@ export interface CreateDBInstanceRequest {
3636
3636
  */
3637
3637
  RoGroup?: RoGroup;
3638
3638
  /**
3639
- * 实例名称。
3639
+ * 实例名称。一次购买多个实例命名会用后缀数字区分,例instnaceName=db,goodsNum=3,实例命名分别为db1,db2,db3。
3640
3640
  */
3641
3641
  InstanceName?: string;
3642
3642
  /**
@@ -6484,7 +6484,7 @@ export interface CreateDBInstanceHourRequest {
6484
6484
  */
6485
6485
  AutoRenewFlag?: number;
6486
6486
  /**
6487
- * 实例名称。
6487
+ * 实例名称。一次购买多个实例命名会用后缀数字区分,例instnaceName=db,goodsNum=3,实例命名分别为db1,db2,db3。
6488
6488
  */
6489
6489
  InstanceName?: string;
6490
6490
  /**
@@ -2925,6 +2925,16 @@ disabled:未启用
2925
2925
  注意:此字段可能返回 null,表示取不到有效值。
2926
2926
  */
2927
2927
  ExtensionMode: number;
2928
+ /**
2929
+ * 流量包实际生效时间
2930
+ 注意:此字段可能返回 null,表示取不到有效值。
2931
+ */
2932
+ TrueEnableTime: string;
2933
+ /**
2934
+ * 流量包实际过期时间
2935
+ 注意:此字段可能返回 null,表示取不到有效值。
2936
+ */
2937
+ TrueExpireTime: string;
2928
2938
  }
2929
2939
  /**
2930
2940
  * Bot cookie策略
@@ -4033,7 +4043,7 @@ export interface WebSocket {
4033
4043
  */
4034
4044
  Switch: string;
4035
4045
  /**
4036
- * 设置超时时间,单位为秒,最大超时时间65秒。
4046
+ * 设置超时时间,单位为秒,最大超时时间300秒。
4037
4047
  注意:此字段可能返回 null,表示取不到有效值。
4038
4048
  */
4039
4049
  Timeout?: number;
@@ -0,0 +1,6 @@
1
+ export declare const ciam: {
2
+ v20220331: {
3
+ Client: typeof import("./v20220331/ciam_client").Client;
4
+ Models: typeof import("./v20220331/ciam_models");
5
+ };
6
+ };
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ciam = void 0;
4
+ const v20220331_1 = require("./v20220331");
5
+ exports.ciam = {
6
+ v20220331: v20220331_1.v20220331,
7
+ };
@@ -0,0 +1,14 @@
1
+ import { AbstractClient } from "../../../common/abstract_client";
2
+ import { ClientConfig } from "../../../common/interface";
3
+ import { ResetPasswordRequest, ResetPasswordResponse } from "./ciam_models";
4
+ /**
5
+ * ciam client
6
+ * @class
7
+ */
8
+ export declare class Client extends AbstractClient {
9
+ constructor(clientConfig: ClientConfig);
10
+ /**
11
+ * 重置用户密码
12
+ */
13
+ ResetPassword(req: ResetPasswordRequest, cb?: (error: string, rep: ResetPasswordResponse) => void): Promise<ResetPasswordResponse>;
14
+ }
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Client = void 0;
4
+ /* eslint-disable @typescript-eslint/no-unused-vars */
5
+ /*
6
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
7
+ *
8
+ * Licensed under the Apache License, Version 2.0 (the "License");
9
+ * you may not use this file except in compliance with the License.
10
+ * You may obtain a copy of the License at
11
+ *
12
+ * http://www.apache.org/licenses/LICENSE-2.0
13
+ *
14
+ * Unless required by applicable law or agreed to in writing,
15
+ * software distributed under the License is distributed on an
16
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17
+ * KIND, either express or implied. See the License for the
18
+ * specific language governing permissions and limitations
19
+ * under the License.
20
+ */
21
+ const abstract_client_1 = require("../../../common/abstract_client");
22
+ /**
23
+ * ciam client
24
+ * @class
25
+ */
26
+ class Client extends abstract_client_1.AbstractClient {
27
+ constructor(clientConfig) {
28
+ super("ciam.tencentcloudapi.com", "2022-03-31", clientConfig);
29
+ }
30
+ /**
31
+ * 重置用户密码
32
+ */
33
+ async ResetPassword(req, cb) {
34
+ return this.request("ResetPassword", req, cb);
35
+ }
36
+ }
37
+ exports.Client = Client;
@@ -0,0 +1,26 @@
1
+ /**
2
+ * ResetPassword请求参数结构体
3
+ */
4
+ export interface ResetPasswordRequest {
5
+ /**
6
+ * 用户ID
7
+ */
8
+ UserId: string;
9
+ /**
10
+ * 用户目录ID
11
+ */
12
+ UserStoreId: string;
13
+ }
14
+ /**
15
+ * ResetPassword返回参数结构体
16
+ */
17
+ export interface ResetPasswordResponse {
18
+ /**
19
+ * 重置后的用户密码
20
+ */
21
+ Password: string;
22
+ /**
23
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
24
+ */
25
+ RequestId?: string;
26
+ }
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing,
12
+ * software distributed under the License is distributed on an
13
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ * KIND, either express or implied. See the License for the
15
+ * specific language governing permissions and limitations
16
+ * under the License.
17
+ */
18
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,6 @@
1
+ import * as Models from "./ciam_models";
2
+ import { Client } from "./ciam_client";
3
+ export declare const v20220331: {
4
+ Client: typeof Client;
5
+ Models: typeof Models;
6
+ };
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.v20220331 = void 0;
4
+ const Models = require("./ciam_models");
5
+ const ciam_client_1 = require("./ciam_client");
6
+ exports.v20220331 = {
7
+ Client: ciam_client_1.Client,
8
+ Models: Models
9
+ };
@@ -1593,6 +1593,11 @@ string|tinyint|smallint|int|bigint|boolean|float|double|decimal|timestamp|date|b
1593
1593
  注意:此字段可能返回 null,表示取不到有效值。
1594
1594
  */
1595
1595
  ModifiedTime?: string;
1596
+ /**
1597
+ * 是否为分区字段
1598
+ 注意:此字段可能返回 null,表示取不到有效值。
1599
+ */
1600
+ IsPartition?: boolean;
1596
1601
  }
1597
1602
  /**
1598
1603
  * DescribeTaskResult请求参数结构体
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, DescribeFlowTemplatesResponse, StartFlowResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowResponse, DescribeFlowTemplatesRequest } from "./ess_models";
3
+ import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, DescribeFlowTemplatesResponse, CreateMultiFlowSignQRCodeRequest, StartFlowResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -11,6 +11,11 @@ export declare class Client extends AbstractClient {
11
11
  * 此接口用于发起流程
12
12
  */
13
13
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
14
+ /**
15
+ * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
16
+ 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
17
+ */
18
+ CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
14
19
  /**
15
20
  * 用于撤销流程
16
21
  */
@@ -31,6 +36,10 @@ export declare class Client extends AbstractClient {
31
36
  * 创建签署流程
32
37
  */
33
38
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
39
+ /**
40
+ * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
41
+ */
42
+ CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
34
43
  /**
35
44
  * 获取小程序跳转链接
36
45
 
@@ -33,6 +33,13 @@ class Client extends abstract_client_1.AbstractClient {
33
33
  async StartFlow(req, cb) {
34
34
  return this.request("StartFlow", req, cb);
35
35
  }
36
+ /**
37
+ * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
38
+ 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
39
+ */
40
+ async CreateMultiFlowSignQRCode(req, cb) {
41
+ return this.request("CreateMultiFlowSignQRCode", req, cb);
42
+ }
36
43
  /**
37
44
  * 用于撤销流程
38
45
  */
@@ -63,6 +70,12 @@ class Client extends abstract_client_1.AbstractClient {
63
70
  async CreateFlow(req, cb) {
64
71
  return this.request("CreateFlow", req, cb);
65
72
  }
73
+ /**
74
+ * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
75
+ */
76
+ async CancelMultiFlowSignQRCode(req, cb) {
77
+ return this.request("CancelMultiFlowSignQRCode", req, cb);
78
+ }
66
79
  /**
67
80
  * 获取小程序跳转链接
68
81
 
@@ -11,6 +11,23 @@ export interface UploadFile {
11
11
  */
12
12
  FileName?: string;
13
13
  }
14
+ /**
15
+ * CancelMultiFlowSignQRCode请求参数结构体
16
+ */
17
+ export interface CancelMultiFlowSignQRCodeRequest {
18
+ /**
19
+ * 用户信息
20
+ */
21
+ Operator: UserInfo;
22
+ /**
23
+ * 二维码id
24
+ */
25
+ QrCodeId: string;
26
+ /**
27
+ * 应用信息
28
+ */
29
+ Agent?: Agent;
30
+ }
14
31
  /**
15
32
  * DescribeFileUrls返回参数结构体
16
33
  */
@@ -291,6 +308,23 @@ export interface DescribeThirdPartyAuthCodeRequest {
291
308
  */
292
309
  AuthCode: string;
293
310
  }
311
+ /**
312
+ * 一码多扫签署二维码对象
313
+ */
314
+ export interface SignQrCode {
315
+ /**
316
+ * 二维码id
317
+ */
318
+ QrCodeId: string;
319
+ /**
320
+ * 二维码url
321
+ */
322
+ QrCodeUrl: string;
323
+ /**
324
+ * 二维码过期时间
325
+ */
326
+ ExpiredTime: number;
327
+ }
294
328
  /**
295
329
  * UploadFiles请求参数结构体
296
330
  */
@@ -461,6 +495,84 @@ KEYWORD 关键字,使用ComponentId指定关键字
461
495
  */
462
496
  OffsetY?: number;
463
497
  }
498
+ /**
499
+ * CreateMultiFlowSignQRCode返回参数结构体
500
+ */
501
+ export interface CreateMultiFlowSignQRCodeResponse {
502
+ /**
503
+ * 签署二维码对象
504
+ */
505
+ QrCode: SignQrCode;
506
+ /**
507
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
508
+ */
509
+ RequestId?: string;
510
+ }
511
+ /**
512
+ * 创建流程的签署方信息
513
+ */
514
+ export interface FlowCreateApprover {
515
+ /**
516
+ * 参与者类型:
517
+ 0:企业
518
+ 1:个人
519
+ 3:企业静默签署
520
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
521
+ */
522
+ ApproverType: number;
523
+ /**
524
+ * 如果签署方为企业,需要填入企业全称
525
+ */
526
+ OrganizationName?: string;
527
+ /**
528
+ * 是否需要签署
529
+ - `false`: 不需要签署
530
+ - `true`: 需要签署
531
+ */
532
+ Required?: boolean;
533
+ /**
534
+ * 签署方经办人姓名
535
+ */
536
+ ApproverName?: string;
537
+ /**
538
+ * 签署方经办人手机号码
539
+ */
540
+ ApproverMobile?: string;
541
+ /**
542
+ * 签署方经办人证件号码
543
+ */
544
+ ApproverIdCardNumber?: string;
545
+ /**
546
+ * 签署方经办人证件类型ID_CARD 身份证
547
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
548
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
549
+ */
550
+ ApproverIdCardType?: string;
551
+ /**
552
+ * 签署方经办人在模板中的角色ID
553
+ */
554
+ RecipientId?: string;
555
+ /**
556
+ * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个
557
+ */
558
+ UserId?: string;
559
+ /**
560
+ * 签署前置条件:是否需要阅读全文,默认为不需要
561
+ */
562
+ IsFullText?: boolean;
563
+ /**
564
+ * 签署前置条件:阅读时长限制,默认为不需要
565
+ */
566
+ PreReadTime?: number;
567
+ /**
568
+ * 是否发送短信,sms--短信通知,none--不通知,默认为sms
569
+ */
570
+ NotifyType?: string;
571
+ /**
572
+ * 签署意愿确认渠道,WEIXINAPP:人脸识别
573
+ */
574
+ VerifyChannel?: Array<string>;
575
+ }
464
576
  /**
465
577
  * UploadFiles返回参数结构体
466
578
  */
@@ -765,69 +877,41 @@ export interface FileInfo {
765
877
  CreatedOn?: number;
766
878
  }
767
879
  /**
768
- * 创建流程的签署方信息
880
+ * CreateMultiFlowSignQRCode请求参数结构体
769
881
  */
770
- export interface FlowCreateApprover {
882
+ export interface CreateMultiFlowSignQRCodeRequest {
771
883
  /**
772
- * 参与者类型:
773
- 0:企业
774
- 1:个人
775
- 3:企业静默签署
776
- 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
777
- */
778
- ApproverType: number;
779
- /**
780
- * 如果签署方为企业,需要填入企业全称
781
- */
782
- OrganizationName?: string;
783
- /**
784
- * 是否需要签署
785
- - `false`: 不需要签署
786
- - `true`: 需要签署
787
- */
788
- Required?: boolean;
789
- /**
790
- * 签署方经办人姓名
791
- */
792
- ApproverName?: string;
793
- /**
794
- * 签署方经办人手机号码
795
- */
796
- ApproverMobile?: string;
797
- /**
798
- * 签署方经办人证件号码
884
+ * 模板ID
799
885
  */
800
- ApproverIdCardNumber?: string;
886
+ TemplateId: string;
801
887
  /**
802
- * 签署方经办人证件类型ID_CARD 身份证
803
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
804
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
888
+ * 用户信息
805
889
  */
806
- ApproverIdCardType?: string;
890
+ Operator: UserInfo;
807
891
  /**
808
- * 签署方经办人在模板中的角色ID
892
+ * 合同名称
809
893
  */
810
- RecipientId?: string;
894
+ FlowName: string;
811
895
  /**
812
- * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个
896
+ * 应用信息
813
897
  */
814
- UserId?: string;
898
+ Agent?: Agent;
815
899
  /**
816
- * 签署前置条件:是否需要阅读全文,默认为不需要
900
+ * 合同有效天数 默认7天 最高设置不超过30天
817
901
  */
818
- IsFullText?: boolean;
902
+ FlowEffectiveDay?: number;
819
903
  /**
820
- * 签署前置条件:阅读时长限制,默认为不需要
904
+ * 二维码有效天数 默认7天 最高设置不超过90天
821
905
  */
822
- PreReadTime?: number;
906
+ QrEffectiveDay?: number;
823
907
  /**
824
- * 是否发送短信,sms--短信通知,none--不通知,默认为sms
908
+ * 最大合同份数,默认5份 超过此上限 二维码自动失效
825
909
  */
826
- NotifyType?: string;
910
+ MaxFlowNum?: number;
827
911
  /**
828
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
912
+ * 回调地址
829
913
  */
830
- VerifyChannel?: Array<string>;
914
+ CallbackUrl?: string;
831
915
  }
832
916
  /**
833
917
  * StartFlow返回参数结构体
@@ -914,6 +998,15 @@ MULTI_LINE_TEXT - 多行文本控件
914
998
  */
915
999
  NeedPreview?: boolean;
916
1000
  }
1001
+ /**
1002
+ * CancelMultiFlowSignQRCode返回参数结构体
1003
+ */
1004
+ export interface CancelMultiFlowSignQRCodeResponse {
1005
+ /**
1006
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1007
+ */
1008
+ RequestId?: string;
1009
+ }
917
1010
  /**
918
1011
  * CreateFlow返回参数结构体
919
1012
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SyncProxyOrganizationResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsRequest, DescribeFlowDetailInfoRequest, UploadFilesRequest, DescribeResourceUrlsByFlowsRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, CreateSignUrlsResponse, OperateChannelTemplateRequest, DescribeUsageRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, DescribeUsageResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
3
+ import { SyncProxyOrganizationResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, DescribeFlowDetailInfoRequest, UploadFilesRequest, DescribeResourceUrlsByFlowsRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, DescribeUsageResponse, CreateSignUrlsResponse, OperateChannelTemplateRequest, ChannelCancelMultiFlowSignQRCodeRequest, DescribeUsageRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, ChannelCancelMultiFlowSignQRCodeResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
4
4
  /**
5
5
  * essbasic client
6
6
  * @class
@@ -21,6 +21,19 @@ export declare class Client extends AbstractClient {
21
21
  * 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
22
22
  */
23
23
  DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
24
+ /**
25
+ * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
26
+ 1、同步标识=select时:
27
+ 返回渠道侧模板库当前模板的属性.
28
+ 2、同步标识=update或者delete时:
29
+ 对渠道子客进行模板库中模板授权,修改操作
30
+ */
31
+ OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
32
+ /**
33
+ * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
34
+ 适用的模版仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模版,且模版中发起方没有填写控件。
35
+ */
36
+ ChannelCreateMultiFlowSignQRCode(req: ChannelCreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCreateMultiFlowSignQRCodeResponse) => void): Promise<ChannelCreateMultiFlowSignQRCodeResponse>;
24
37
  /**
25
38
  * 接口(ChannelCreateFlowByFiles)用于渠道版通过文件创建流程。此接口不可直接使用,需要运营申请
26
39
  */
@@ -32,21 +45,17 @@ export declare class Client extends AbstractClient {
32
45
  */
33
46
  PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
34
47
  /**
35
- * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
36
- 1、同步标识=select时:
37
- 返回渠道侧模板库当前模板的属性.
38
- 2、同步标识=update或者delete时:
39
- 对渠道子客进行模板库中模板授权,修改操作
48
+ * 创建参与者签署短链
40
49
  */
41
- OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
50
+ CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
42
51
  /**
43
52
  * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,需要运营申请
44
53
  */
45
54
  CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse>;
46
55
  /**
47
- * 创建参与者签署短链
56
+ * 此接口(ChannelCancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
48
57
  */
49
- CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
58
+ ChannelCancelMultiFlowSignQRCode(req: ChannelCancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCancelMultiFlowSignQRCodeResponse) => void): Promise<ChannelCancelMultiFlowSignQRCodeResponse>;
50
59
  /**
51
60
  * 此接口(CreateConsoleLoginUrl)用于创建电子签控制台登录链接。若企业未激活,调用同步企业信息、同步经办人信息
52
61
 
@@ -47,6 +47,23 @@ class Client extends abstract_client_1.AbstractClient {
47
47
  async DescribeTemplates(req, cb) {
48
48
  return this.request("DescribeTemplates", req, cb);
49
49
  }
50
+ /**
51
+ * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
52
+ 1、同步标识=select时:
53
+ 返回渠道侧模板库当前模板的属性.
54
+ 2、同步标识=update或者delete时:
55
+ 对渠道子客进行模板库中模板授权,修改操作
56
+ */
57
+ async OperateChannelTemplate(req, cb) {
58
+ return this.request("OperateChannelTemplate", req, cb);
59
+ }
60
+ /**
61
+ * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
62
+ 适用的模版仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模版,且模版中发起方没有填写控件。
63
+ */
64
+ async ChannelCreateMultiFlowSignQRCode(req, cb) {
65
+ return this.request("ChannelCreateMultiFlowSignQRCode", req, cb);
66
+ }
50
67
  /**
51
68
  * 接口(ChannelCreateFlowByFiles)用于渠道版通过文件创建流程。此接口不可直接使用,需要运营申请
52
69
  */
@@ -62,14 +79,10 @@ class Client extends abstract_client_1.AbstractClient {
62
79
  return this.request("PrepareFlows", req, cb);
63
80
  }
64
81
  /**
65
- * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
66
- 1、同步标识=select时:
67
- 返回渠道侧模板库当前模板的属性.
68
- 2、同步标识=update或者delete时:
69
- 对渠道子客进行模板库中模板授权,修改操作
82
+ * 创建参与者签署短链
70
83
  */
71
- async OperateChannelTemplate(req, cb) {
72
- return this.request("OperateChannelTemplate", req, cb);
84
+ async CreateSignUrls(req, cb) {
85
+ return this.request("CreateSignUrls", req, cb);
73
86
  }
74
87
  /**
75
88
  * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,需要运营申请
@@ -78,10 +91,10 @@ class Client extends abstract_client_1.AbstractClient {
78
91
  return this.request("CreateSealByImage", req, cb);
79
92
  }
80
93
  /**
81
- * 创建参与者签署短链
94
+ * 此接口(ChannelCancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
82
95
  */
83
- async CreateSignUrls(req, cb) {
84
- return this.request("CreateSignUrls", req, cb);
96
+ async ChannelCancelMultiFlowSignQRCode(req, cb) {
97
+ return this.request("ChannelCancelMultiFlowSignQRCode", req, cb);
85
98
  }
86
99
  /**
87
100
  * 此接口(CreateConsoleLoginUrl)用于创建电子签控制台登录链接。若企业未激活,调用同步企业信息、同步经办人信息