tencentcloud-sdk-nodejs-ess 4.0.652 → 4.0.654

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.
@@ -35,6 +35,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
35
35
  当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
36
36
 
37
37
  > **适用场景**
38
+ >
38
39
  > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
39
40
  > 一个模板通常会包含以下结构信息
40
41
  >- 模板基本信息
@@ -121,8 +122,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
121
122
  CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
122
123
  /**
123
124
  * 创建快速发起流程
124
- 适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
125
- 注:该接口文件的resourceId 是通过上传文件之后获取的。
125
+ <br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
126
+ <br/>注:该接口文件的resourceId 是通过上传文件之后获取的。
126
127
  */
127
128
  CreatePrepareFlow(req: CreatePrepareFlowRequest, cb?: (error: string, rep: CreatePrepareFlowResponse) => void): Promise<CreatePrepareFlowResponse>;
128
129
  /**
@@ -206,8 +207,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
206
207
  */
207
208
  CreateIntegrationDepartment(req: CreateIntegrationDepartmentRequest, cb?: (error: string, rep: CreateIntegrationDepartmentResponse) => void): Promise<CreateIntegrationDepartmentResponse>;
208
209
  /**
209
- * 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>
210
- 大文件转换所需的时间可能会比较长。
210
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。
211
+ 注意:大文件转换所需的时间可能会比较长。
211
212
  */
212
213
  GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
213
214
  /**
@@ -233,9 +234,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
233
234
  */
234
235
  CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
235
236
  /**
236
- * 查询流程摘要
237
+ * 查询流程基础信息
237
238
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
238
- 日调用量限制:10W
239
+ 每个企业限制日调用量限制:10W, 当当日超过此限制后再调用接口返回错误
239
240
  */
240
241
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
241
242
  /**
@@ -329,7 +330,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
329
330
  */
330
331
  CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
331
332
  /**
332
- * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号
333
- */
333
+ * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
334
+ 可进行批量操作,Employees中的userID与openID二选一必填
335
+ */
334
336
  UpdateIntegrationEmployees(req: UpdateIntegrationEmployeesRequest, cb?: (error: string, rep: UpdateIntegrationEmployeesResponse) => void): Promise<UpdateIntegrationEmployeesResponse>;
335
337
  }
@@ -64,6 +64,7 @@ class Client extends TencentCloudCommon.AbstractClient {
64
64
  当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
65
65
 
66
66
  > **适用场景**
67
+ >
67
68
  > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
68
69
  > 一个模板通常会包含以下结构信息
69
70
  >- 模板基本信息
@@ -184,8 +185,8 @@ class Client extends TencentCloudCommon.AbstractClient {
184
185
  }
185
186
  /**
186
187
  * 创建快速发起流程
187
- 适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
188
- 注:该接口文件的resourceId 是通过上传文件之后获取的。
188
+ <br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
189
+ <br/>注:该接口文件的resourceId 是通过上传文件之后获取的。
189
190
  */
190
191
  async CreatePrepareFlow(req, cb) {
191
192
  return this.request("CreatePrepareFlow", req, cb);
@@ -299,8 +300,8 @@ class Client extends TencentCloudCommon.AbstractClient {
299
300
  return this.request("CreateIntegrationDepartment", req, cb);
300
301
  }
301
302
  /**
302
- * 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>
303
- 大文件转换所需的时间可能会比较长。
303
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。
304
+ 注意:大文件转换所需的时间可能会比较长。
304
305
  */
305
306
  async GetTaskResultApi(req, cb) {
306
307
  return this.request("GetTaskResultApi", req, cb);
@@ -336,9 +337,9 @@ class Client extends TencentCloudCommon.AbstractClient {
336
337
  return this.request("CreateConvertTaskApi", req, cb);
337
338
  }
338
339
  /**
339
- * 查询流程摘要
340
+ * 查询流程基础信息
340
341
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
341
- 日调用量限制:10W
342
+ 每个企业限制日调用量限制:10W, 当当日超过此限制后再调用接口返回错误
342
343
  */
343
344
  async DescribeFlowBriefs(req, cb) {
344
345
  return this.request("DescribeFlowBriefs", req, cb);
@@ -466,8 +467,9 @@ class Client extends TencentCloudCommon.AbstractClient {
466
467
  return this.request("CreateIntegrationEmployees", req, cb);
467
468
  }
468
469
  /**
469
- * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号
470
- */
470
+ * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
471
+ 可进行批量操作,Employees中的userID与openID二选一必填
472
+ */
471
473
  async UpdateIntegrationEmployees(req, cb) {
472
474
  return this.request("UpdateIntegrationEmployees", req, cb);
473
475
  }