tencentcloud-sdk-nodejs-ess 4.1.237 → 4.1.240

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-ess",
3
- "version": "4.1.237",
3
+ "version": "4.1.240",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -239,55 +239,36 @@ export interface DisableUserAutoSignRequest {
239
239
  */
240
240
  export interface UploadFilesRequest {
241
241
  /**
242
- * 文件对应业务类型,可以选择的类型如下<ul><li> **TEMPLATE** : 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li> **DOCUMENT** : 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同,直接上传后使用返回的文件资源Id即可</li><li> **SEAL** : 此文件用于印章的生成,文件类型支持.jpg/.jpeg/.png</li></ul> ["yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT"]
242
+ * <p>文件对应业务类型,可以选择的类型如下<ul><li> <strong>TEMPLATE</strong> : 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li> <strong>DOCUMENT</strong> : 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同,直接上传后使用返回的文件资源Id即可</li><li> <strong>SEAL</strong> : 此文件用于印章的生成,文件类型支持.jpg/.jpeg/.png</li><li> <strong>ARCHIVE</strong> : 此文件用于归档文件夹,文件类型支持.pdf/.zip格式</li></ul> [&quot;yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT&quot;]</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板</li><li>DOCUMENT: 此文件用来发起合同流程</li><li>SEAL: 此文件用于印章的生成</li><li>ARCHIVE: 此文件用于归档文件夹</li></ul>
243
243
  */
244
244
  BusinessType: string;
245
245
  /**
246
- * 执行本接口操作的员工信息。其中OperatorId为必填字段,即用户的UserId
247
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
246
+ * <p>执行本接口操作的员工信息。其中OperatorId为必填字段,即用户的UserId。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
248
247
  */
249
248
  Caller?: Caller;
250
249
  /**
251
- * 请上传文件内容数组,最多可上传20个文件。
252
-
253
- <b>所有文件必须符合<font color="red">FileType</font>指定的文件类型。</b>
250
+ * <p>请上传文件内容数组,最多可上传20个文件。</p><p><b>所有文件必须符合<font color="red">FileType</font>指定的文件类型。</b></p>
254
251
  */
255
252
  FileInfos?: Array<UploadFile>;
256
253
  /**
257
- * 文件类型, 默认通过文件内容和文件后缀一起解析得到文件类型,调用接口时可以显示的指定上传文件的类型。
258
- 可支持的指定类型如下:
259
- <ul><li>pdf</li>
260
- <li>doc</li>
261
- <li>docx</li>
262
- <li>xls</li>
263
- <li>xlsx</li>
264
- <li>html</li>
265
- <li>jpg</li>
266
- <li>jpeg</li>
267
- <li>png</li></ul>
268
- 如:pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf
254
+ * <p>文件类型, 默认通过文件内容和文件后缀一起解析得到文件类型,调用接口时可以显示的指定上传文件的类型。<br>可支持的指定类型如下:</p><ul><li>pdf</li><li>doc</li><li>docx</li><li>xls</li><li>xlsx</li><li>html</li><li>jpg</li><li>jpeg</li><li>png</li></ul>如:pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf
269
255
  */
270
256
  FileType?: string;
271
257
  /**
272
- * 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。
273
- <ul><li>**true**:将灰色矩阵置为白色。</li>
274
- <li>**false**:无需处理,不会将灰色矩阵置为白色(默认)。</li></ul>
275
-
276
- 注: `该参数仅在关键字定位时,需要去除关键字所在的灰框场景下使用。`
258
+ * <p>此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。</p><ul><li>**true**:将灰色矩阵置为白色。</li><li>**false**:无需处理,不会将灰色矩阵置为白色(默认)。</li></ul><p>注: <code>该参数仅在关键字定位时,需要去除关键字所在的灰框场景下使用。</code></p>
277
259
  */
278
260
  CoverRect?: boolean;
279
261
  /**
280
- * 该字段已不再使用
262
+ * <p>该字段已不再使用</p>
281
263
  */
282
264
  CustomIds?: Array<string>;
283
265
  /**
284
- * 不再使用,上传文件链接数组,最多支持20个URL
266
+ * <p>不再使用,上传文件链接数组,最多支持20个URL</p>
285
267
  * @deprecated
286
268
  */
287
269
  FileUrls?: string;
288
270
  /**
289
- * 代理企业和员工的信息。
290
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
271
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
291
272
  */
292
273
  Agent?: Agent;
293
274
  }
@@ -5410,13 +5391,11 @@ export interface CreateFlowByFilesResponse {
5410
5391
  */
5411
5392
  export interface UploadFilesResponse {
5412
5393
  /**
5413
- * 文件资源ID数组,每个文件资源ID为32位字符串。
5414
- 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
5415
- 注:`有效期一个小时(超过一小时后系统不定期清理,会有部分时间差), 有效期内此文件id可以反复使用, 超过有效期无法使用`
5394
+ * <p>文件资源ID数组,每个文件资源ID为32位字符串。<br>建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。<br>注:<code>有效期一个小时(超过一小时后系统不定期清理,会有部分时间差), 有效期内此文件id可以反复使用, 超过有效期无法使用</code></p>
5416
5395
  */
5417
5396
  FileIds?: Array<string>;
5418
5397
  /**
5419
- * 上传成功文件数量
5398
+ * <p>上传成功文件数量</p>
5420
5399
  */
5421
5400
  TotalCount?: number;
5422
5401
  /**
@@ -10763,7 +10742,7 @@ export interface CreateBatchQuickSignUrlRequest {
10763
10742
  */
10764
10743
  CanSkipReadFlow?: boolean;
10765
10744
  /**
10766
- * <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。 </p><p>注意: </p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。</code> </li><li><code>动态签署方链接暂不支持修改过期时间。</code></li></ol>
10745
+ * <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。 </p><p>注意: </p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。此校验将会扣除短信份额,不建议通过设置此值来缓存签署链接,建议在用户需要签署的时候临时生成链接。</code></li><li><code>动态签署方链接暂不支持修改过期时间。</code></li></ol>
10767
10746
  */
10768
10747
  ExpiredOn?: number;
10769
10748
  }
@@ -12832,7 +12811,7 @@ export interface CreateFlowSignUrlRequest {
12832
12811
  */
12833
12812
  UrlType?: number;
12834
12813
  /**
12835
- * <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。</p><p>注意:</p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。</code></li><li><code>若生成合同发起方预览链接,有效期大于30分钟,则需要进行验证码校验的手机号为发起方账号绑定的手机号。</code></li></ol>
12814
+ * <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。</p><p>注意:</p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。此校验将会扣除短信份额,不建议通过设置此值来缓存签署链接,建议在用户需要签署的时候临时生成链接。</code></li><li><code>若生成合同发起方预览链接,有效期大于30分钟,则需要进行验证码校验的手机号为发起方账号绑定的手机号。</code></li></ol>
12836
12815
  */
12837
12816
  ExpiredOn?: number;
12838
12817
  }