tencentcloud-sdk-nodejs-ess 4.1.273 → 4.1.276

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.273",
3
+ "version": "4.1.276",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -305,7 +305,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
305
305
  1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)
306
306
  2. 已经在授权中或者授权成功的企业,无法重复授权
307
307
  3. 授权企业和被授权企业必须都是已认证企业
308
- 4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。
308
+ 4. <font color='red'>需要授权企业的超管或者法人打开链接</font>走开通逻辑。
309
309
 
310
310
 
311
311
  **该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**
@@ -373,7 +373,7 @@ class Client extends TencentCloudCommon.AbstractClient {
373
373
  1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)
374
374
  2. 已经在授权中或者授权成功的企业,无法重复授权
375
375
  3. 授权企业和被授权企业必须都是已认证企业
376
- 4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。
376
+ 4. <font color='red'>需要授权企业的超管或者法人打开链接</font>走开通逻辑。
377
377
 
378
378
 
379
379
  **该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**
@@ -101,7 +101,7 @@ export interface CreateSealRequest {
101
101
  */
102
102
  SealStyle?: string;
103
103
  /**
104
- * <p>印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> <strong>38_38</strong>: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>40_40</strong>: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>42_42</strong>(默认): 圆形企业公章直径42mm, SealStyle是圆形的时候才有效</li> <li> <strong>45_45</strong>: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>50_50</strong>: 圆形企业印章直径50mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>58_58</strong>: 圆形企业印章直径58mm, SealStyle是圆形的时候才有效</li> <li> <strong>40_30</strong>: 椭圆形印章40mm x 30mm, SealStyle是椭圆的时候才有效</li> <li> <strong>45_30</strong>: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul></p>
104
+ * <p>印章尺寸,格式为 宽_高(单位:mm,整数),用于签署时按物理尺寸将印章加盖到PDF。<br>取值范围:<br> 图片上传印章(Image FileToken 非空时生效):支持自定义尺寸,宽、高均为 10-100 的整数(即 1cm-10cm),宽高比(宽/高)需在 0.1-10 之间。<br>• 系统生成印章(未传 Image 与 FileToken):仅支持与SealStyle 匹配的固定枚举值:<br>  - 圆形印章(SealStyle=cycle):38_38 / 40_40 / 42_42 / 45_45 / 50_50 / 58_58<br>  - 椭圆印章(SealStyle=ellipse):40_30 / 45_30<br>字段依赖关系:<br> SealStyle关联:仅系统生成印章场景下 SealStyle 生效,此时 SealSize 需与 SealStyle对应的枚举匹配;图片上传印章场景 SealStyle 会被忽略,SealSize支持自定义。<br> SealType 关联:公章/合同章仅支持圆形枚举,财务/人事/其它章支持圆形或椭圆枚举。<br>• 与 Image / FileToken 关联:SealSize 是加盖到 PDF的物理尺寸,与上传图片的像素分辨率无绑定,图片会按 SealSize 缩放渲染;建议上传图片的宽高比与 SealSize 保持一致,避免拉伸形变。</p>
105
105
  */
106
106
  SealSize?: string;
107
107
  /**
@@ -404,28 +404,23 @@ export interface VerifyDigitFileRequest {
404
404
  */
405
405
  export interface CreateFlowEvidenceReportRequest {
406
406
  /**
407
- * 执行本接口操作的员工信息。
408
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
407
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
409
408
  */
410
409
  Operator: UserInfo;
411
410
  /**
412
- * 合同流程ID,为32位字符串。
413
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
411
+ * <p>合同流程ID,为32位字符串。<br>可登录腾讯电子签控制台,在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</p>
414
412
  */
415
413
  FlowId: string;
416
414
  /**
417
- * 代理企业和员工的信息。
418
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
415
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
419
416
  */
420
417
  Agent?: Agent;
421
418
  /**
422
- * 指定申请的报告类型,可选类型如下:
423
- <ul><li> **0** :合同签署报告(默认)</li>
424
- <li> **1** :公证处核验报告</li></ul>
419
+ * <p>指定申请的报告类型,可选类型如下:<ul><li> <strong>0</strong> :合同签署报告(默认)</li></ul></p><p>枚举值:</p><ul><li>0: 合同签署报告</li></ul>
425
420
  */
426
421
  ReportType?: number;
427
422
  /**
428
- * 混合云模式获取合同文件合并出证,默认:不同意。注:此参数需要联系腾讯电子签运营进行开通后生效
423
+ * <p>混合云模式获取合同文件合并出证,默认:不同意。注:此参数需要联系腾讯电子签运营进行开通后生效</p>
429
424
  */
430
425
  HybridEvidenceFlowFile?: boolean;
431
426
  }
@@ -659,23 +654,19 @@ export interface CreateFlowForwardsResponse {
659
654
  */
660
655
  export interface DescribeFlowEvidenceReportRequest {
661
656
  /**
662
- * 执行本接口操作的员工信息。
663
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
657
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
664
658
  */
665
659
  Operator: UserInfo;
666
660
  /**
667
- * 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
661
+ * <p>签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生</p>
668
662
  */
669
663
  ReportId: string;
670
664
  /**
671
- * 代理企业和员工的信息。
672
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
665
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
673
666
  */
674
667
  Agent?: Agent;
675
668
  /**
676
- * 指定申请的报告类型,可选类型如下:
677
- <ul><li> **0** :合同签署报告(默认)</li>
678
- <li> **1** :公证处核验报告</li></ul>
669
+ * <p>指定申请的报告类型,可选类型如下:<ul><li> <strong>0</strong> :合同签署报告(默认)</li></ul></p><p>枚举值:</p><ul><li>0: 合同签署报告</li></ul>
679
670
  */
680
671
  ReportType?: number;
681
672
  }
@@ -3105,15 +3096,15 @@ export interface CreateBatchOrganizationAuthorizationUrlResponse {
3105
3096
  */
3106
3097
  export interface ModifyPartnerAutoSignAuthUrlResponse {
3107
3098
  /**
3108
- * 授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime
3099
+ * <p>授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。</p>
3109
3100
  */
3110
3101
  Url?: string;
3111
3102
  /**
3112
- * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
3103
+ * <p>从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径</p>
3113
3104
  */
3114
3105
  MiniAppPath?: string;
3115
3106
  /**
3116
- * 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
3107
+ * <p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
3117
3108
  */
3118
3109
  ExpireTime?: number;
3119
3110
  /**
@@ -4175,15 +4166,11 @@ export interface DescribeFlowTemplatesRequest {
4175
4166
  */
4176
4167
  export interface DescribeFlowEvidenceReportResponse {
4177
4168
  /**
4178
- * 出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。
4169
+ * <p>出证报告PDF的下载 URL,<code>有效期为5分钟</code>,超过有效期后将无法再下载。</p>
4179
4170
  */
4180
4171
  ReportUrl?: string;
4181
4172
  /**
4182
- * 出证任务执行的状态, 状态含义如下:
4183
-
4184
- <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
4185
- <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
4186
- <li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
4173
+ * <p>出证任务执行的状态, 状态含义如下:</p><ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li><li>**EvidenceStatusSuccess**: 出证任务执行成功</li><li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
4187
4174
  */
4188
4175
  Status?: string;
4189
4176
  /**
@@ -5564,39 +5551,27 @@ export interface FeedbackInfo {
5564
5551
  */
5565
5552
  export interface CreatePartnerAutoSignAuthUrlRequest {
5566
5553
  /**
5567
- * 代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5554
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
5568
5555
  */
5569
5556
  Agent?: Agent;
5570
5557
  /**
5571
- * 执行本接口操作的员工信息。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5558
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
5572
5559
  */
5573
5560
  Operator?: UserInfo;
5574
5561
  /**
5575
- * 被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入
5562
+ * <p>被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入</p>
5576
5563
  */
5577
5564
  AuthorizedOrganizationId?: string;
5578
5565
  /**
5579
- * 被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
5580
- 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
5566
+ * <p>被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。<br>注: <code>如果名称中包含英文括号(),请使用中文括号()代替。</code></p>
5581
5567
  */
5582
5568
  AuthorizedOrganizationName?: string;
5583
5569
  /**
5584
- * 在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:
5585
-
5586
- <ul>
5587
- <li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>
5588
- <li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>
5589
- <li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>
5590
- <li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>
5591
- </ul>
5570
+ * <p>在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。</p><p>枚举值:</p><ul><li>OFFICIAL: 企业公章,用于代表企业对外的正式文件和重要事务的认证</li><li>CONTRACT: 合同专用章,专门用于签署各类合同。</li><li>FINANCE: 财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证</li><li>PERSONNEL: 人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li><li>OTHER: 其他类型印章,包含子类型</li></ul>
5592
5571
  */
5593
5572
  SealTypes?: Array<string>;
5594
5573
  /**
5595
- * 在处理授权关系时,授权的方向
5596
- <ul>
5597
- <li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
5598
- <li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>
5599
- </ul>
5574
+ * <p>在处理授权关系时,授权的方向</p><ul><li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li><li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li></ul>
5600
5575
  */
5601
5576
  AuthToMe?: boolean;
5602
5577
  }
@@ -8609,15 +8584,15 @@ export interface FlowGroupInfo {
8609
8584
  */
8610
8585
  export interface CreatePartnerAutoSignAuthUrlResponse {
8611
8586
  /**
8612
- * 授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime
8587
+ * <p>授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。</p>
8613
8588
  */
8614
8589
  Url?: string;
8615
8590
  /**
8616
- * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
8591
+ * <p>从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径</p>
8617
8592
  */
8618
8593
  MiniAppPath?: string;
8619
8594
  /**
8620
- * 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
8595
+ * <p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
8621
8596
  */
8622
8597
  ExpireTime?: number;
8623
8598
  /**
@@ -8705,20 +8680,15 @@ export interface CreateSingleSignOnEmployeesResponse {
8705
8680
  */
8706
8681
  export interface CreateFlowEvidenceReportResponse {
8707
8682
  /**
8708
- * 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
8683
+ * <p>出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL</p>
8709
8684
  */
8710
8685
  ReportId?: string;
8711
8686
  /**
8712
- * 出证任务执行的状态, 状态含义如下:
8713
-
8714
- <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
8715
- <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
8716
- <li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
8687
+ * <p>出证任务执行的状态, 状态含义如下:</p><ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li><li>**EvidenceStatusSuccess**: 出证任务执行成功</li><li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
8717
8688
  */
8718
8689
  Status?: string;
8719
8690
  /**
8720
- * 此字段已经废除,不再使用.
8721
- 出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
8691
+ * <p>此字段已经废除,不再使用.<br>出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取</p>
8722
8692
  * @deprecated
8723
8693
  */
8724
8694
  ReportUrl?: string;
@@ -10653,30 +10623,29 @@ export interface UpdateIntegrationEmployeesResponse {
10653
10623
  */
10654
10624
  export interface ModifyPartnerAutoSignAuthUrlRequest {
10655
10625
  /**
10656
- * 代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10626
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10657
10627
  */
10658
10628
  Agent?: Agent;
10659
10629
  /**
10660
- * 执行本接口操作的员工信息。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10630
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10661
10631
  */
10662
10632
  Operator?: UserInfo;
10663
10633
  /**
10664
- * 被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入
10634
+ * <p>被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入</p>
10665
10635
  */
10666
10636
  AuthorizedOrganizationId?: string;
10667
10637
  /**
10668
- * 被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
10669
- 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
10638
+ * <p>被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。<br>注: <code>如果名称中包含英文括号(),请使用中文括号()代替。</code></p>
10670
10639
  */
10671
10640
  AuthorizedOrganizationName?: string;
10672
10641
  /**
10673
- * 在处理授权关系时,授权的方向
10674
- <ul>
10675
- <li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
10676
- <li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>
10677
- </ul>
10642
+ * <p>在处理授权关系时,授权的方向</p><ul><li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li><li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li></ul>
10678
10643
  */
10679
10644
  AuthToMe?: boolean;
10645
+ /**
10646
+ * <p>在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。</p><p>枚举值:</p><ul><li>OFFICIAL: 企业公章,用于代表企业对外的正式文件和重要事务的认证</li><li>CONTRACT: 合同专用章,专门用于签署各类合同。</li><li>FINANCE: 财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证</li><li>PERSONNEL: 人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li><li>OTHER: 其他类型印章,包含子类型</li></ul>
10647
+ */
10648
+ SealTypes?: Array<string>;
10680
10649
  }
10681
10650
  /**
10682
10651
  * DescribeInformationExtractionWebUrl返回参数结构体