tencentcloud-sdk-nodejs-ess 4.1.225 → 4.1.227

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.225",
3
+ "version": "4.1.227",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -4288,28 +4288,25 @@ export interface BatchOrganizationRegistrationTasksDetails {
4288
4288
  */
4289
4289
  export interface RecipientComponentInfo {
4290
4290
  /**
4291
- * 签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方
4291
+ * <p>签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方</p>
4292
4292
  */
4293
4293
  RecipientId?: string;
4294
4294
  /**
4295
- * 参与方填写状态
4296
- <ul>
4297
- <li>**空值** : 此参与方没有填写控件</li>
4298
- <li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li>
4299
- <li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>
4300
-
4295
+ * <p>参与方填写状态</p><ul><li>**空值** : 此参与方没有填写控件</li><li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li><li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>
4301
4296
  */
4302
4297
  RecipientFillStatus?: string;
4303
4298
  /**
4304
- * 是否为发起方
4305
- <ul><li>true-发起方</li>
4306
- <li>false-参与方</li></ul>
4299
+ * <p>是否为发起方</p><ul><li>true-发起方</li><li>false-参与方</li></ul>
4307
4300
  */
4308
4301
  IsPromoter?: boolean;
4309
4302
  /**
4310
- * 改参与方填写控件信息列表
4303
+ * <p>该参与方填写控件信息列表</p>
4311
4304
  */
4312
4305
  Components?: Array<FilledComponent>;
4306
+ /**
4307
+ * <p>该参与方签批控件信息</p>
4308
+ */
4309
+ SignComponents?: Array<FilledComponent>;
4313
4310
  }
4314
4311
  /**
4315
4312
  * ExportContractReviewResult返回参数结构体
@@ -10546,85 +10543,74 @@ export interface CreateBatchCancelFlowUrlRequest {
10546
10543
  */
10547
10544
  export interface CreateMultiFlowSignQRCodeRequest {
10548
10545
  /**
10549
- * 执行本接口操作的员工信息。
10550
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10546
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10551
10547
  */
10552
10548
  Operator: UserInfo;
10553
10549
  /**
10554
- * 合同模板ID,为32位字符串。
10555
- 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
10550
+ * <p>合同模板ID,为32位字符串。<br>可登录腾讯电子签控制台,在 &quot;模板&quot;-&gt;&quot;模板中心&quot;-&gt;&quot;列表展示设置&quot;选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。</p>
10556
10551
  */
10557
10552
  TemplateId: string;
10558
10553
  /**
10559
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
10560
- 该名称还将用于合同签署完成后的下载文件名。
10554
+ * <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。<br>该名称还将用于合同签署完成后的下载文件名。</p>
10561
10555
  */
10562
10556
  FlowName: string;
10563
10557
  /**
10564
- * 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
10565
- 一旦发起流程数超越该限制,该二维码将自动失效。
10558
+ * <p>通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。<br>一旦发起流程数超越该限制,该二维码将自动失效。</p>
10566
10559
  */
10567
10560
  MaxFlowNum?: number;
10568
10561
  /**
10569
- * 二维码的有效期限,默认为7天,最高设定不得超过90天。
10570
- 一旦超过二维码的有效期限,该二维码将自动失效。
10562
+ * <p>二维码的有效期限,默认为7天,最高设定不得超过90天。<br>一旦超过二维码的有效期限,该二维码将自动失效。</p>
10571
10563
  * @deprecated
10572
10564
  */
10573
10565
  QrEffectiveDay?: number;
10574
10566
  /**
10575
- * 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
10576
- 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
10577
- 最长设定期限不得超过30天。
10567
+ * <p>合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。<br>若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。<br>最长设定期限不得超过30天。</p>
10578
10568
  */
10579
10569
  FlowEffectiveDay?: number;
10580
10570
  /**
10581
- * 指定签署人信息。
10582
- 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
10571
+ * <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:<br> <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul></p><p>效果如下:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p><p>枚举值:</p><ul><li>0: 合同</li><li>1: 文件</li><li>2: 协议</li><li>3: 文书</li></ul><p>默认值:0</p>
10572
+ */
10573
+ FlowDisplayType?: number;
10574
+ /**
10575
+ * <p>指定签署人信息。<br>在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。</p>
10583
10576
  */
10584
10577
  Restrictions?: Array<ApproverRestriction>;
10585
10578
  /**
10586
- * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
10587
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
10588
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
10579
+ * <p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。<br>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
10589
10580
  */
10590
10581
  UserData?: string;
10591
10582
  /**
10592
- * 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
10593
- <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
10594
- <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
10595
-
10583
+ * <p>已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置<br><br> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign<br><br> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83</p>
10596
10584
  * @deprecated
10597
10585
  */
10598
10586
  CallbackUrl?: string;
10599
10587
  /**
10600
- * 代理企业和员工的信息。
10601
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10588
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10602
10589
  */
10603
10590
  Agent?: Agent;
10604
10591
  /**
10605
- * 限制二维码用户条件(已弃用)
10592
+ * <p>限制二维码用户条件(已弃用)</p>
10606
10593
  * @deprecated
10607
10594
  */
10608
10595
  ApproverRestrictions?: ApproverRestriction;
10609
10596
  /**
10610
- * 指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。
10597
+ * <p>指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。</p>
10611
10598
  */
10612
10599
  ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
10613
10600
  /**
10614
- * 禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true
10601
+ * <p>禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。</p>
10615
10602
  */
10616
10603
  ForbidPersonalMultipleSign?: boolean;
10617
10604
  /**
10618
- * 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。
10619
- 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
10605
+ * <p>合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。<br>例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。</p>
10620
10606
  */
10621
10607
  FlowNameAppendScannerInfo?: boolean;
10622
10608
  /**
10623
- * 签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName
10609
+ * <p>签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName</p>
10624
10610
  */
10625
10611
  QrCodeName?: string;
10626
10612
  /**
10627
- * 签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。
10613
+ * <p>签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。</p>
10628
10614
  */
10629
10615
  QrCodeExpiredOn?: number;
10630
10616
  }
@@ -10974,11 +10960,11 @@ export interface CreatePrepareFlowGroupResponse {
10974
10960
  */
10975
10961
  export interface CreateMultiFlowSignQRCodeResponse {
10976
10962
  /**
10977
- * 一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。
10963
+ * <p>一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。</p>
10978
10964
  */
10979
10965
  QrCode?: SignQrCode;
10980
10966
  /**
10981
- * 一码多签签署码的链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
10967
+ * <p>一码多签签署码的链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。</p>
10982
10968
  */
10983
10969
  SignUrls?: SignUrl;
10984
10970
  /**