tencentcloud-sdk-nodejs 4.0.682 → 4.0.683

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 (91) hide show
  1. package/CHANGELOG.md +141 -0
  2. package/SERVICE_CHANGELOG.md +155 -169
  3. package/package.json +1 -1
  4. package/products.md +10 -10
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/index.ts +2 -2
  7. package/src/services/bma/index.ts +2 -2
  8. package/src/services/btoe/index.ts +2 -2
  9. package/src/services/cbs/v20170312/cbs_client.ts +2 -2
  10. package/src/services/ccc/v20200210/ccc_client.ts +2 -1
  11. package/src/services/ccc/v20200210/ccc_models.ts +21 -2
  12. package/src/services/cii/index.ts +2 -2
  13. package/src/services/cloudstudio/index.ts +2 -2
  14. package/src/services/dts/index.ts +2 -2
  15. package/src/services/ess/v20201111/ess_client.ts +26 -16
  16. package/src/services/ess/v20201111/ess_models.ts +85 -42
  17. package/src/services/essbasic/index.ts +2 -2
  18. package/src/services/iai/index.ts +2 -2
  19. package/src/services/iai/v20180301/iai_models.ts +8 -12
  20. package/src/services/iai/v20200303/iai_models.ts +8 -12
  21. package/src/services/ims/index.ts +2 -2
  22. package/src/services/iotcloud/index.ts +2 -2
  23. package/src/services/iotvideo/index.ts +4 -4
  24. package/src/services/mgobe/index.ts +2 -2
  25. package/src/services/mrs/v20200910/mrs_models.ts +48 -25
  26. package/src/services/tem/index.ts +2 -2
  27. package/src/services/thpc/index.ts +4 -4
  28. package/src/services/thpc/v20230321/thpc_models.ts +17 -0
  29. package/src/services/tione/index.ts +2 -2
  30. package/src/services/tms/index.ts +2 -2
  31. package/src/services/tsw/index.ts +2 -2
  32. package/src/services/vm/index.ts +2 -2
  33. package/src/services/waf/v20180125/waf_client.ts +12 -0
  34. package/src/services/waf/v20180125/waf_models.ts +28 -0
  35. package/src/services/yunsou/index.ts +2 -2
  36. package/tencentcloud/common/sdk_version.d.ts +1 -1
  37. package/tencentcloud/common/sdk_version.js +1 -1
  38. package/tencentcloud/services/ams/index.d.ts +4 -4
  39. package/tencentcloud/services/ams/index.js +2 -2
  40. package/tencentcloud/services/bma/index.d.ts +4 -4
  41. package/tencentcloud/services/bma/index.js +2 -2
  42. package/tencentcloud/services/btoe/index.d.ts +4 -4
  43. package/tencentcloud/services/btoe/index.js +2 -2
  44. package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +2 -2
  45. package/tencentcloud/services/cbs/v20170312/cbs_client.js +2 -2
  46. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -1
  47. package/tencentcloud/services/ccc/v20200210/ccc_client.js +1 -1
  48. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -2
  49. package/tencentcloud/services/cii/index.d.ts +4 -4
  50. package/tencentcloud/services/cii/index.js +2 -2
  51. package/tencentcloud/services/cloudstudio/index.d.ts +4 -4
  52. package/tencentcloud/services/cloudstudio/index.js +2 -2
  53. package/tencentcloud/services/dts/index.d.ts +4 -4
  54. package/tencentcloud/services/dts/index.js +2 -2
  55. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +21 -11
  56. package/tencentcloud/services/ess/v20201111/ess_client.js +21 -11
  57. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +85 -42
  58. package/tencentcloud/services/essbasic/index.d.ts +4 -4
  59. package/tencentcloud/services/essbasic/index.js +2 -2
  60. package/tencentcloud/services/iai/index.d.ts +4 -4
  61. package/tencentcloud/services/iai/index.js +2 -2
  62. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +8 -12
  63. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +8 -12
  64. package/tencentcloud/services/ims/index.d.ts +4 -4
  65. package/tencentcloud/services/ims/index.js +2 -2
  66. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  67. package/tencentcloud/services/iotcloud/index.js +2 -2
  68. package/tencentcloud/services/iotvideo/index.d.ts +6 -6
  69. package/tencentcloud/services/iotvideo/index.js +4 -4
  70. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  71. package/tencentcloud/services/mgobe/index.js +2 -2
  72. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +48 -25
  73. package/tencentcloud/services/tem/index.d.ts +4 -4
  74. package/tencentcloud/services/tem/index.js +2 -2
  75. package/tencentcloud/services/thpc/index.d.ts +6 -6
  76. package/tencentcloud/services/thpc/index.js +4 -4
  77. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +17 -0
  78. package/tencentcloud/services/tione/index.d.ts +4 -4
  79. package/tencentcloud/services/tione/index.js +2 -2
  80. package/tencentcloud/services/tms/index.d.ts +4 -4
  81. package/tencentcloud/services/tms/index.js +2 -2
  82. package/tencentcloud/services/tsw/index.d.ts +4 -4
  83. package/tencentcloud/services/tsw/index.js +2 -2
  84. package/tencentcloud/services/vm/index.d.ts +4 -4
  85. package/tencentcloud/services/vm/index.js +2 -2
  86. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +5 -1
  87. package/tencentcloud/services/waf/v20180125/waf_client.js +6 -0
  88. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +26 -0
  89. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  90. package/tencentcloud/services/yunsou/index.js +2 -2
  91. package/test/waf.v20180125.test.js +10 -0
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.btoe = void 0;
4
- const v20210514_1 = require("./v20210514");
5
4
  const v20210303_1 = require("./v20210303");
5
+ const v20210514_1 = require("./v20210514");
6
6
  exports.btoe = {
7
- v20210514: v20210514_1.v20210514,
8
7
  v20210303: v20210303_1.v20210303,
8
+ v20210514: v20210514_1.v20210514,
9
9
  };
@@ -144,8 +144,8 @@ export declare class Client extends AbstractClient {
144
144
  /**
145
145
  * 本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
146
146
 
147
- * 当前仅支持修改快照名称及将非永久快照修改为永久快照。
148
- * “快照名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
147
+ * 本接口支持修改快照名称及到期时间,以及将非永久快照修改为永久快照。
148
+ * “快照名称”仅为方便用户管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
149
149
  */
150
150
  ModifySnapshotAttribute(req: ModifySnapshotAttributeRequest, cb?: (error: string, rep: ModifySnapshotAttributeResponse) => void): Promise<ModifySnapshotAttributeResponse>;
151
151
  /**
@@ -208,8 +208,8 @@ class Client extends abstract_client_1.AbstractClient {
208
208
  /**
209
209
  * 本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
210
210
 
211
- * 当前仅支持修改快照名称及将非永久快照修改为永久快照。
212
- * “快照名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
211
+ * 本接口支持修改快照名称及到期时间,以及将非永久快照修改为永久快照。
212
+ * “快照名称”仅为方便用户管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
213
213
  */
214
214
  async ModifySnapshotAttribute(req, cb) {
215
215
  return this.request("ModifySnapshotAttribute", req, cb);
@@ -36,7 +36,7 @@ export declare class Client extends AbstractClient {
36
36
  */
37
37
  DeleteExtension(req: DeleteExtensionRequest, cb?: (error: string, rep: DeleteExtensionResponse) => void): Promise<DeleteExtensionResponse>;
38
38
  /**
39
- * 绑定坐席所属技能组
39
+ * 绑定座席所属技能组
40
40
  */
41
41
  BindStaffSkillGroupList(req: BindStaffSkillGroupListRequest, cb?: (error: string, rep: BindStaffSkillGroupListResponse) => void): Promise<BindStaffSkillGroupListResponse>;
42
42
  /**
@@ -70,7 +70,7 @@ class Client extends abstract_client_1.AbstractClient {
70
70
  return this.request("DeleteExtension", req, cb);
71
71
  }
72
72
  /**
73
- * 绑定坐席所属技能组
73
+ * 绑定座席所属技能组
74
74
  */
75
75
  async BindStaffSkillGroupList(req, cb) {
76
76
  return this.request("BindStaffSkillGroupList", req, cb);
@@ -1850,6 +1850,19 @@ export interface CreateExtensionRequest {
1850
1850
  */
1851
1851
  Relation?: string;
1852
1852
  }
1853
+ /**
1854
+ * 座席绑定技能组列表
1855
+ */
1856
+ export interface StaffSkillGroupList {
1857
+ /**
1858
+ * 技能组ID
1859
+ */
1860
+ SkillGroupId: number;
1861
+ /**
1862
+ * 座席在技能组中的优先级(1为最高,5最低,默认3)
1863
+ */
1864
+ Priority?: number;
1865
+ }
1853
1866
  /**
1854
1867
  * CreateAutoCalloutTask请求参数结构体
1855
1868
  */
@@ -2120,13 +2133,18 @@ export interface BindStaffSkillGroupListRequest {
2120
2133
  */
2121
2134
  SdkAppId: number;
2122
2135
  /**
2123
- * 坐席邮箱
2136
+ * 座席邮箱
2124
2137
  */
2125
2138
  StaffEmail: string;
2126
2139
  /**
2127
2140
  * 绑定技能组列表
2141
+ * @deprecated
2128
2142
  */
2129
- SkillGroupList: Array<number | bigint>;
2143
+ SkillGroupList?: Array<number | bigint>;
2144
+ /**
2145
+ * 绑定技能组列表(必填)
2146
+ */
2147
+ StaffSkillGroupList?: Array<StaffSkillGroupList>;
2130
2148
  }
2131
2149
  /**
2132
2150
  * DescribePSTNActiveSessionList请求参数结构体
@@ -1,10 +1,10 @@
1
1
  export declare const cii: {
2
- v20201210: {
3
- Client: typeof import("./v20201210/cii_client").Client;
4
- Models: typeof import("./v20201210/cii_models");
5
- };
6
2
  v20210408: {
7
3
  Client: typeof import("./v20210408/cii_client").Client;
8
4
  Models: typeof import("./v20210408/cii_models");
9
5
  };
6
+ v20201210: {
7
+ Client: typeof import("./v20201210/cii_client").Client;
8
+ Models: typeof import("./v20201210/cii_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.cii = void 0;
4
- const v20201210_1 = require("./v20201210");
5
4
  const v20210408_1 = require("./v20210408");
5
+ const v20201210_1 = require("./v20201210");
6
6
  exports.cii = {
7
- v20201210: v20201210_1.v20201210,
8
7
  v20210408: v20210408_1.v20210408,
8
+ v20201210: v20201210_1.v20201210,
9
9
  };
@@ -1,10 +1,10 @@
1
1
  export declare const cloudstudio: {
2
- v20210524: {
3
- Client: typeof import("./v20210524/cloudstudio_client").Client;
4
- Models: typeof import("./v20210524/cloudstudio_models");
5
- };
6
2
  v20230508: {
7
3
  Client: typeof import("./v20230508/cloudstudio_client").Client;
8
4
  Models: typeof import("./v20230508/cloudstudio_models");
9
5
  };
6
+ v20210524: {
7
+ Client: typeof import("./v20210524/cloudstudio_client").Client;
8
+ Models: typeof import("./v20210524/cloudstudio_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.cloudstudio = void 0;
4
- const v20210524_1 = require("./v20210524");
5
4
  const v20230508_1 = require("./v20230508");
5
+ const v20210524_1 = require("./v20210524");
6
6
  exports.cloudstudio = {
7
- v20210524: v20210524_1.v20210524,
8
7
  v20230508: v20230508_1.v20230508,
8
+ v20210524: v20210524_1.v20210524,
9
9
  };
@@ -1,10 +1,10 @@
1
1
  export declare const dts: {
2
- v20180330: {
3
- Client: typeof import("./v20180330/dts_client").Client;
4
- Models: typeof import("./v20180330/dts_models");
5
- };
6
2
  v20211206: {
7
3
  Client: typeof import("./v20211206/dts_client").Client;
8
4
  Models: typeof import("./v20211206/dts_models");
9
5
  };
6
+ v20180330: {
7
+ Client: typeof import("./v20180330/dts_client").Client;
8
+ Models: typeof import("./v20180330/dts_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.dts = void 0;
4
- const v20180330_1 = require("./v20180330");
5
4
  const v20211206_1 = require("./v20211206");
5
+ const v20180330_1 = require("./v20180330");
6
6
  exports.dts = {
7
- v20180330: v20180330_1.v20180330,
8
7
  v20211206: v20211206_1.v20211206,
8
+ v20180330: v20180330_1.v20180330,
9
9
  };
@@ -26,9 +26,9 @@ export declare class Client extends AbstractClient {
26
26
  */
27
27
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
28
28
  /**
29
- * 用于撤销签署流程
30
- 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
31
- 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
29
+ * 用于撤销签署流程<br/>
30
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
31
+ `注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
32
32
  */
33
33
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
34
34
  /**
@@ -175,6 +175,13 @@ export declare class Client extends AbstractClient {
175
175
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
176
176
  /**
177
177
  * 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
178
+
179
+ `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
180
+ `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
181
+ `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
182
+ `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
183
+ `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
184
+ `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
178
185
  */
179
186
  CreateReleaseFlow(req: CreateReleaseFlowRequest, cb?: (error: string, rep: CreateReleaseFlowResponse) => void): Promise<CreateReleaseFlowResponse>;
180
187
  /**
@@ -216,7 +223,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
216
223
  */
217
224
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
218
225
  /**
219
- * 查询出证报告,返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
226
+ * 查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
220
227
  */
221
228
  DescribeFlowEvidenceReport(req: DescribeFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeFlowEvidenceReportResponse) => void): Promise<DescribeFlowEvidenceReportResponse>;
222
229
  /**
@@ -244,7 +251,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
244
251
  */
245
252
  GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
246
253
  /**
247
- * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
254
+ * 此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
255
+ 该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
256
+ 如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
248
257
  */
249
258
  CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
250
259
  /**
@@ -252,13 +261,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
252
261
  */
253
262
  DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
254
263
  /**
255
- * 创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
256
-
257
- 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
264
+ * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
258
265
 
259
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
260
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
261
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
266
+ 注:
267
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
268
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
269
+ `3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
262
270
  */
263
271
  CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
264
272
  /**
@@ -362,6 +370,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
362
370
  CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
363
371
  /**
364
372
  * 此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
373
+
374
+ 注: `在调用此接口时,请确保指定的用户已生成自动签开通链接并且未完成开通,否则无法撤销`
365
375
  */
366
376
  CancelUserAutoSignEnableUrl(req: CancelUserAutoSignEnableUrlRequest, cb?: (error: string, rep: CancelUserAutoSignEnableUrlResponse) => void): Promise<CancelUserAutoSignEnableUrlResponse>;
367
377
  /**
@@ -52,9 +52,9 @@ class Client extends abstract_client_1.AbstractClient {
52
52
  return this.request("StartFlow", req, cb);
53
53
  }
54
54
  /**
55
- * 用于撤销签署流程
56
- 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
57
- 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
55
+ * 用于撤销签署流程<br/>
56
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
57
+ `注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
58
58
  */
59
59
  async CancelFlow(req, cb) {
60
60
  return this.request("CancelFlow", req, cb);
@@ -247,6 +247,13 @@ class Client extends abstract_client_1.AbstractClient {
247
247
  }
248
248
  /**
249
249
  * 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
250
+
251
+ `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
252
+ `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
253
+ `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
254
+ `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
255
+ `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
256
+ `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
250
257
  */
251
258
  async CreateReleaseFlow(req, cb) {
252
259
  return this.request("CreateReleaseFlow", req, cb);
@@ -300,7 +307,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
300
307
  return this.request("UploadFiles", req, cb);
301
308
  }
302
309
  /**
303
- * 查询出证报告,返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
310
+ * 查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
304
311
  */
305
312
  async DescribeFlowEvidenceReport(req, cb) {
306
313
  return this.request("DescribeFlowEvidenceReport", req, cb);
@@ -340,7 +347,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
340
347
  return this.request("GetTaskResultApi", req, cb);
341
348
  }
342
349
  /**
343
- * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
350
+ * 此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
351
+ 该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
352
+ 如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
344
353
  */
345
354
  async CancelMultiFlowSignQRCode(req, cb) {
346
355
  return this.request("CancelMultiFlowSignQRCode", req, cb);
@@ -352,13 +361,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
352
361
  return this.request("DescribeIntegrationEmployees", req, cb);
353
362
  }
354
363
  /**
355
- * 创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
356
-
357
- 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
364
+ * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
358
365
 
359
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
360
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
361
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
366
+ 注:
367
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
368
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
369
+ `3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
362
370
  */
363
371
  async CreateFlowSignUrl(req, cb) {
364
372
  return this.request("CreateFlowSignUrl", req, cb);
@@ -494,6 +502,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
494
502
  }
495
503
  /**
496
504
  * 此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
505
+
506
+ 注: `在调用此接口时,请确保指定的用户已生成自动签开通链接并且未完成开通,否则无法撤销`
497
507
  */
498
508
  async CancelUserAutoSignEnableUrl(req, cb) {
499
509
  return this.request("CancelUserAutoSignEnableUrl", req, cb);
@@ -111,16 +111,17 @@ export interface CancelFlowResponse {
111
111
  */
112
112
  export interface DescribeFlowEvidenceReportRequest {
113
113
  /**
114
- * 调用方用户信息,userId 必填
114
+ * 执行本接口操作的员工信息。
115
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
115
116
  */
116
117
  Operator: UserInfo;
117
118
  /**
118
- * 出证报告编号
119
+ * 签署报告编号
119
120
  */
120
121
  ReportId: string;
121
122
  /**
122
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
123
-
123
+ * 代理企业和员工的信息。
124
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
124
125
  */
125
126
  Agent?: Agent;
126
127
  }
@@ -325,12 +326,16 @@ export interface CreateMultiFlowSignQRCodeResponse {
325
326
  */
326
327
  export interface FlowApproverUrlInfo {
327
328
  /**
328
- * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
329
+ * 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
330
+ 注: `注意该链接有效期为30分钟`
329
331
  注意:此字段可能返回 null,表示取不到有效值。
330
332
  */
331
333
  SignUrl?: string;
332
334
  /**
333
- * 签署人类型 1-个人
335
+ * 签署参与人类型
336
+ <ul><li> **1** :个人参与方</li></ul>
337
+
338
+ 注: `现在仅支持个人参与方`
334
339
  注意:此字段可能返回 null,表示取不到有效值。
335
340
  */
336
341
  ApproverType?: number;
@@ -345,7 +350,8 @@ export interface FlowApproverUrlInfo {
345
350
  */
346
351
  ApproverMobile?: string;
347
352
  /**
348
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
353
+ * 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
354
+ 注: `注意该链接有效期为30分钟`
349
355
  注意:此字段可能返回 null,表示取不到有效值。
350
356
  */
351
357
  LongUrl?: string;
@@ -940,11 +946,12 @@ export interface DescribeFlowEvidenceReportResponse {
940
946
  */
941
947
  ReportUrl?: string;
942
948
  /**
943
- * 出证任务执行的状态, 分布表示下面的含义
944
-
945
- EvidenceStatusExecuting 出证任务在执行中
946
- EvidenceStatusSuccess 出证任务执行成功
947
- EvidenceStatusFailed 出证任务执行失败
949
+ * 签署报告出证任务的状态
950
+ <ul>
951
+ <li>EvidenceStatusExecuting : 出证任务在执行中</li>
952
+ <li>EvidenceStatusSuccess : 出证任务执行成功</li>
953
+ <li>EvidenceStatusFailed : 出证任务执行失败</li>
954
+ </ul>
948
955
  */
949
956
  Status?: string;
950
957
  /**
@@ -1432,6 +1439,7 @@ export interface DescribeIntegrationMainOrganizationUserRequest {
1432
1439
  export interface CreateReleaseFlowResponse {
1433
1440
  /**
1434
1441
  * 解除协议流程编号
1442
+ `注意:这里的流程编号对应的合同是本次发起的解除协议。`
1435
1443
 
1436
1444
  */
1437
1445
  FlowId?: string;
@@ -1917,18 +1925,22 @@ export interface CreateBatchCancelFlowUrlResponse {
1917
1925
  */
1918
1926
  export interface UserThreeFactor {
1919
1927
  /**
1920
- * 姓名
1928
+ * 签署方经办人的姓名。
1929
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1921
1930
  */
1922
1931
  Name: string;
1923
1932
  /**
1924
- * 证件类型:
1925
- ID_CARD 身份证
1926
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
1927
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1933
+ * 证件类型,支持以下类型
1934
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
1935
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
1936
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
1928
1937
  */
1929
1938
  IdCardType: string;
1930
1939
  /**
1931
- * 证件号,如果有 X 请大写
1940
+ * 证件号码,应符合以下规则
1941
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1942
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
1943
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
1932
1944
  */
1933
1945
  IdCardNumber: string;
1934
1946
  }
@@ -3515,21 +3527,27 @@ export interface CreateFlowByFilesRequest {
3515
3527
  */
3516
3528
  export interface CreateFlowSignUrlRequest {
3517
3529
  /**
3518
- * 流程编号
3530
+ * 合同流程ID,为32位字符串。
3531
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3532
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3519
3533
  */
3520
3534
  FlowId: string;
3521
3535
  /**
3522
- * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
3536
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
3523
3537
 
3524
- 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
3538
+ 注:
3539
+ `1. ApproverType目前只支持个人类型的签署人。`
3540
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
3525
3541
  */
3526
3542
  FlowApproverInfos: Array<FlowCreateApprover>;
3527
3543
  /**
3528
- * 用户信息,此结构体UserId必填
3544
+ * 执行本接口操作的员工信息。
3545
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3529
3546
  */
3530
3547
  Operator?: UserInfo;
3531
3548
  /**
3532
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3549
+ * 代理企业和员工的信息。
3550
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3533
3551
  */
3534
3552
  Agent?: Agent;
3535
3553
  /**
@@ -3538,7 +3556,7 @@ export interface CreateFlowSignUrlRequest {
3538
3556
  */
3539
3557
  Organization?: OrganizationInfo;
3540
3558
  /**
3541
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
3559
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
3542
3560
  */
3543
3561
  JumpUrl?: string;
3544
3562
  }
@@ -3547,31 +3565,42 @@ export interface CreateFlowSignUrlRequest {
3547
3565
  */
3548
3566
  export interface CreateReleaseFlowRequest {
3549
3567
  /**
3550
- * 调用方用户信息,userId 必填
3568
+ * 执行本接口操作的员工信息。
3569
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3551
3570
  */
3552
3571
  Operator: UserInfo;
3553
3572
  /**
3554
- * 待解除的签署流程编号(即原签署流程的编号)
3573
+ * 待解除的签署流程编号(即原签署流程的编号)。
3555
3574
  */
3556
3575
  NeedRelievedFlowId: string;
3557
3576
  /**
3558
- * 解除协议内容
3577
+ * 解除协议内容。
3559
3578
  */
3560
3579
  ReliveInfo: RelieveInfo;
3561
3580
  /**
3562
- * 非必须,解除协议的本企业签署人列表,
3563
- 默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
3564
- 解除协议的签署人数量不能多于原流程的签署人数量
3581
+ * 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3582
+ */
3583
+ Agent?: Agent;
3584
+ /**
3585
+ * 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
3586
+ 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3587
+ 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
3588
+
3589
+ `注意:只能更换同企业的签署人。`<br/>
3590
+ `注意:不支持更换个人类型的签署人。`<br/>
3565
3591
  */
3566
3592
  ReleasedApprovers?: Array<ReleasedApprover>;
3567
3593
  /**
3568
- * 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
3594
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
3595
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3569
3596
  */
3570
3597
  Deadline?: number;
3571
3598
  /**
3572
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3599
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
3600
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
3601
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3573
3602
  */
3574
- Agent?: Agent;
3603
+ UserData?: string;
3575
3604
  }
3576
3605
  /**
3577
3606
  * CreateIntegrationUserRoles请求参数结构体
@@ -4129,11 +4158,15 @@ export interface RemindFlowRecords {
4129
4158
  */
4130
4159
  export interface CancelUserAutoSignEnableUrlRequest {
4131
4160
  /**
4132
- * 操作人信息,UseId必填
4161
+ * 执行本接口操作的员工信息。
4162
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4133
4163
  */
4134
4164
  Operator: UserInfo;
4135
4165
  /**
4136
- * 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
4166
+ * 企业开通用户自动签场景,例如电子处方。
4167
+ <ul>
4168
+ <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
4169
+ </ul>
4137
4170
  */
4138
4171
  SceneKey: string;
4139
4172
  /**
@@ -4141,6 +4174,11 @@ export interface CancelUserAutoSignEnableUrlRequest {
4141
4174
 
4142
4175
  */
4143
4176
  UserInfo: UserThreeFactor;
4177
+ /**
4178
+ * 代理企业和员工的信息。
4179
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4180
+ */
4181
+ Agent?: Agent;
4144
4182
  }
4145
4183
  /**
4146
4184
  * 创建员工的失败数据
@@ -4351,15 +4389,17 @@ export interface GetTaskResultApiResponse {
4351
4389
  */
4352
4390
  export interface CancelMultiFlowSignQRCodeRequest {
4353
4391
  /**
4354
- * 调用方用户信息,userId 必填
4392
+ * 执行本接口操作的员工信息。
4393
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4355
4394
  */
4356
4395
  Operator: UserInfo;
4357
4396
  /**
4358
- * 二维码id
4397
+ * 二维码ID,为32位字符串。
4359
4398
  */
4360
4399
  QrCodeId: string;
4361
4400
  /**
4362
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4401
+ * 代理企业和员工的信息。
4402
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4363
4403
  */
4364
4404
  Agent?: Agent;
4365
4405
  }
@@ -4737,19 +4777,22 @@ export interface PermissionGroup {
4737
4777
  */
4738
4778
  export interface CancelFlowRequest {
4739
4779
  /**
4740
- * 调用方用户信息,userId 必填
4780
+ * 执行本接口操作的员工信息。
4781
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4741
4782
  */
4742
4783
  Operator: UserInfo;
4743
4784
  /**
4744
- * 签署流程id
4785
+ * 合同流程ID, 为32位字符串。
4786
+ 建议开发者保存此流程ID方便后续其他操作。
4745
4787
  */
4746
4788
  FlowId: string;
4747
4789
  /**
4748
- * 撤销原因,最长200个字符;
4790
+ * 撤销此合同(流程)的原因,最长200个字。
4749
4791
  */
4750
4792
  CancelMessage: string;
4751
4793
  /**
4752
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4794
+ * 代理企业和员工的信息。
4795
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4753
4796
  */
4754
4797
  Agent?: Agent;
4755
4798
  }
@@ -1,10 +1,10 @@
1
1
  export declare const essbasic: {
2
- v20210526: {
3
- Client: typeof import("./v20210526/essbasic_client").Client;
4
- Models: typeof import("./v20210526/essbasic_models");
5
- };
6
2
  v20201222: {
7
3
  Client: typeof import("./v20201222/essbasic_client").Client;
8
4
  Models: typeof import("./v20201222/essbasic_models");
9
5
  };
6
+ v20210526: {
7
+ Client: typeof import("./v20210526/essbasic_client").Client;
8
+ Models: typeof import("./v20210526/essbasic_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.essbasic = void 0;
4
- const v20210526_1 = require("./v20210526");
5
4
  const v20201222_1 = require("./v20201222");
5
+ const v20210526_1 = require("./v20210526");
6
6
  exports.essbasic = {
7
- v20210526: v20210526_1.v20210526,
8
7
  v20201222: v20201222_1.v20201222,
8
+ v20210526: v20210526_1.v20210526,
9
9
  };