tencentcloud-sdk-nodejs-ess 4.1.243 → 4.1.245

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.243",
3
+ "version": "4.1.245",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -380,16 +380,33 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
380
380
  */
381
381
  DescribeInformationExtractionTask(req: DescribeInformationExtractionTaskRequest, cb?: (error: string, rep: DescribeInformationExtractionTaskResponse) => void): Promise<DescribeInformationExtractionTaskResponse>;
382
382
  /**
383
- * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
383
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100
384
+ ##### 需要符合以下条件的合同才可被催办:
385
+ <ol>
386
+ <li>发起合同时,**设置了签署人通知类型:SMS,EMAIL,ALL**</li>
387
+ <li>合同中当前状态为 **待签署** 的签署人是催办的对象</li>
388
+ <li>**每个合同的每个签署方最多3次*</li>
389
+ </ol>
384
390
 
385
- 1. 发起合同时,**签署人的NotifyType需设置为sms**
386
- 2. 合同中当前状态为 **待签署** 的签署人是催办的对象
387
- 3. **每个合同只能催办一次**
391
+ ##### 催办的规则和效果:
392
+ ###### 规则
388
393
 
389
- **催办的效果**: 对方会收到如下的短信通知
394
+ - 指定RemindTypes,会触发符合签署人NotifyType的通知类型
395
+ - 这里EMAIL类型例外,如果指定了RemindEmailInfos,那么就会按照指定的email来通知,不管签署人NotifyType是否设置了EMAIL通知类型
396
+ - 如果指定了RemindEmailInfos,那么就会按照指定的email来通知
397
+ - 若未指定RemindTypes,则按照发起合同时设置的签署人原始通知类型处理
398
+
399
+ ###### 效果
400
+
401
+
402
+ <li>对方会收到如下的短信通知</li>
390
403
 
391
404
  ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
392
405
 
406
+ <li>对方会收到如下的邮件通知</li>
407
+
408
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/0841ccbd8db9747760b17914dcc166c6.png)
409
+
393
410
  注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
394
411
  */
395
412
  CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
@@ -466,16 +466,33 @@ class Client extends TencentCloudCommon.AbstractClient {
466
466
  return this.request("DescribeInformationExtractionTask", req, cb);
467
467
  }
468
468
  /**
469
- * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
469
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100
470
+ ##### 需要符合以下条件的合同才可被催办:
471
+ <ol>
472
+ <li>发起合同时,**设置了签署人通知类型:SMS,EMAIL,ALL**</li>
473
+ <li>合同中当前状态为 **待签署** 的签署人是催办的对象</li>
474
+ <li>**每个合同的每个签署方最多3次*</li>
475
+ </ol>
470
476
 
471
- 1. 发起合同时,**签署人的NotifyType需设置为sms**
472
- 2. 合同中当前状态为 **待签署** 的签署人是催办的对象
473
- 3. **每个合同只能催办一次**
477
+ ##### 催办的规则和效果:
478
+ ###### 规则
474
479
 
475
- **催办的效果**: 对方会收到如下的短信通知
480
+ - 指定RemindTypes,会触发符合签署人NotifyType的通知类型
481
+ - 这里EMAIL类型例外,如果指定了RemindEmailInfos,那么就会按照指定的email来通知,不管签署人NotifyType是否设置了EMAIL通知类型
482
+ - 如果指定了RemindEmailInfos,那么就会按照指定的email来通知
483
+ - 若未指定RemindTypes,则按照发起合同时设置的签署人原始通知类型处理
484
+
485
+ ###### 效果
486
+
487
+
488
+ <li>对方会收到如下的短信通知</li>
476
489
 
477
490
  ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
478
491
 
492
+ <li>对方会收到如下的邮件通知</li>
493
+
494
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/0841ccbd8db9747760b17914dcc166c6.png)
495
+
479
496
  注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
480
497
  */
481
498
  async CreateFlowReminds(req, cb) {
@@ -5563,11 +5563,11 @@ export interface FlowForwardInfo {
5563
5563
  */
5564
5564
  export interface CreateOrganizationBatchSignUrlResponse {
5565
5565
  /**
5566
- * 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
5566
+ * <p>批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。</p>
5567
5567
  */
5568
5568
  SignUrl?: string;
5569
5569
  /**
5570
- * 链接过期截止时间,格式为Unix标准时间戳(秒),默认为7天后截止。
5570
+ * <p>链接过期截止时间,格式为Unix标准时间戳(秒),默认为7天后截止。</p>
5571
5571
  */
5572
5572
  ExpiredTime?: number;
5573
5573
  /**
@@ -5767,56 +5767,43 @@ export interface DescribeDraftContractByPromptsTaskResponse {
5767
5767
  */
5768
5768
  export interface CreateOrganizationBatchSignUrlRequest {
5769
5769
  /**
5770
- * 执行本接口操作的员工信息。使用此接口时,必须填写userId
5771
- 支持填入集团子公司经办人 userId 代发合同。
5772
-
5773
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5770
+ * <p>执行本接口操作的员工信息。使用此接口时,必须填写userId。<br>支持填入集团子公司经办人 userId 代发合同。</p><p>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
5774
5771
  */
5775
5772
  Operator: UserInfo;
5776
5773
  /**
5777
- * 请指定需执行批量签署的流程ID,数量范围为1-100。您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。用户将利用链接对这些合同实施批量操作。 注:生成动态签署方领取时此参数必传。
5774
+ * <p>请指定需执行批量签署的流程ID,数量范围为1-100。您可登录腾讯电子签控制台,浏览 &quot;合同&quot;-&gt;&quot;合同中心&quot; 以查阅某一合同的FlowId(在页面中显示为合同ID)。用户将利用链接对这些合同实施批量操作。 注:生成动态签署方领取时此参数必传。</p>
5778
5775
  */
5779
5776
  FlowIds?: Array<string>;
5780
5777
  /**
5781
- * 代理企业和员工的信息。
5782
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5778
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
5783
5779
  */
5784
5780
  Agent?: Agent;
5785
5781
  /**
5786
- * 员工在腾讯电子签平台的独特身份标识,为32位字符串。
5787
- 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。
5788
- UserId必须是传入合同(FlowId)中的签署人。
5789
-
5790
- <ul>
5791
- <li>1. 若UserId为空,Name和Mobile 必须提供。</li>
5792
- <li>2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。</li>
5793
- </ul>
5782
+ * <p>员工在腾讯电子签平台的独特身份标识,为32位字符串。<br>您可登录腾讯电子签控制台,在 &quot;更多能力&quot;-&gt;&quot;组织管理&quot; 中查阅某位员工的UserId(在页面中显示为用户ID)。<br>UserId必须是传入合同(FlowId)中的签署人。</p><ul><li>1. 若UserId为空,Name和Mobile 必须提供。</li><li>2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。</li></ul>
5794
5783
  */
5795
5784
  UserId?: string;
5796
5785
  /**
5797
- * 员工姓名,必须与手机号码一起使用。
5798
- 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
5786
+ * <p>员工姓名,必须与手机号码一起使用。<br>如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。</p>
5799
5787
  */
5800
5788
  Name?: string;
5801
5789
  /**
5802
- * 员工手机号,必须与姓名一起使用。
5803
- 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
5790
+ * <p>员工手机号,必须与姓名一起使用。<br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。</p>
5804
5791
  */
5805
5792
  Mobile?: string;
5806
5793
  /**
5807
- * 为签署方经办人在签署合同中的参与方ID,必须与参数FlowIds数组一一对应。您可以通过查询合同接口(DescribeFlowInfo)查询此参数。若传了此参数,则可以不传 UserId, Name, Mobile等参数 注:生成动态签署方领取时此参数必传。
5794
+ * <p>为签署方经办人在签署合同中的参与方ID,必须与参数FlowIds数组一一对应。您可以通过查询合同接口(DescribeFlowInfo)查询此参数。若传了此参数,则可以不传 UserId, Name, Mobile等参数 注:生成动态签署方领取时此参数必传。</p>
5808
5795
  */
5809
5796
  RecipientIds?: Array<string>;
5810
5797
  /**
5811
- * 合同组Id,传入此参数则可以不传FlowIds
5798
+ * <p>合同组Id,传入此参数则可以不传FlowIds</p>
5812
5799
  */
5813
5800
  FlowGroupId?: string;
5814
5801
  /**
5815
- * 是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注:`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。`
5802
+ * <p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul></p>
5816
5803
  */
5817
5804
  CanBatchReject?: boolean;
5818
5805
  /**
5819
- * 动态签署方领取链接配置。
5806
+ * <p>动态签署方领取链接配置。</p>
5820
5807
  */
5821
5808
  DynamicSignOption?: DynamicSignOption;
5822
5809
  }