tencentcloud-sdk-nodejs-ess 4.1.279 → 4.1.284

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.279",
3
+ "version": "4.1.284",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -322,9 +322,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
322
322
  注意:
323
323
  1. 转交的目标经办人需要已经加入企业,且完成实名。
324
324
  2. 仅企业拥有`超管`、`法人`或者`合同管理员`角色的员工才有调用本接口的权限。如果使用主带子方式调用,请确保您已经加入子企业,且账号在子企业中担任任一上述角色。
325
- 3. 仅支持当前经办人为待签署或待填写状态时进行转交操作。
326
- 4. 若原合同有填写控件,且当前经办人已经完成填写,则不支持进行转交。
327
- 5. 若当前经办人已签署完成,或者处于签署流程中,则不支持进行转交。
325
+ 5. 若原合同有填写控件,且当前经办人已经完成填写,则不支持进行转交。
326
+ 6. 若当前经办人已签署完成,或者处于签署流程中,或合同处于完成态(例如:签署完成,拒签,撤销,过期等),则不支持进行转交。
328
327
  */
329
328
  CreateFlowForwards(req: CreateFlowForwardsRequest, cb?: (error: string, rep: CreateFlowForwardsResponse) => void): Promise<CreateFlowForwardsResponse>;
330
329
  /**
@@ -394,9 +394,8 @@ class Client extends TencentCloudCommon.AbstractClient {
394
394
  注意:
395
395
  1. 转交的目标经办人需要已经加入企业,且完成实名。
396
396
  2. 仅企业拥有`超管`、`法人`或者`合同管理员`角色的员工才有调用本接口的权限。如果使用主带子方式调用,请确保您已经加入子企业,且账号在子企业中担任任一上述角色。
397
- 3. 仅支持当前经办人为待签署或待填写状态时进行转交操作。
398
- 4. 若原合同有填写控件,且当前经办人已经完成填写,则不支持进行转交。
399
- 5. 若当前经办人已签署完成,或者处于签署流程中,则不支持进行转交。
397
+ 5. 若原合同有填写控件,且当前经办人已经完成填写,则不支持进行转交。
398
+ 6. 若当前经办人已签署完成,或者处于签署流程中,或合同处于完成态(例如:签署完成,拒签,撤销,过期等),则不支持进行转交。
400
399
  */
401
400
  async CreateFlowForwards(req, cb) {
402
401
  return this.request("CreateFlowForwards", req, cb);
@@ -637,11 +637,11 @@ export interface Tag {
637
637
  */
638
638
  export interface CreateFlowForwardsResponse {
639
639
  /**
640
- * 失败的合同id以及错误详情
640
+ * <p>失败的合同id以及错误详情</p>
641
641
  */
642
642
  FailedFlows?: Array<FlowForwardResult>;
643
643
  /**
644
- * 成功的合同id
644
+ * <p>成功的合同id</p>
645
645
  */
646
646
  SuccessFlows?: Array<string>;
647
647
  /**
@@ -4663,21 +4663,19 @@ export interface FlowApproverDetail {
4663
4663
  */
4664
4664
  export interface CreateFlowForwardsRequest {
4665
4665
  /**
4666
- * 执行本接口操作的员工信息。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4666
+ * <p>执行本接口操作的员工信息。注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
4667
4667
  */
4668
4668
  Operator: UserInfo;
4669
4669
  /**
4670
- * 合同对应参与方需要修改的目标经办人。其UserId可在企业控制台中组织管理里面找到。或者使用获取员工信息接口得到。
4671
-
4672
- 注意:`需要保证目标经办人已经加入企业且已实名`
4670
+ * <p>合同对应参与方需要修改的目标经办人。其UserId可在企业控制台中组织管理里面找到。或者使用获取员工信息接口得到。</p><p>注意:<code>需要保证目标经办人已经加入企业且已实名</code></p>
4673
4671
  */
4674
4672
  TargetUserId: string;
4675
4673
  /**
4676
- * 企业签署方的合同及对应签署方
4674
+ * <p>企业签署方的合同及对应签署方</p>
4677
4675
  */
4678
4676
  FlowForwardInfos: Array<FlowForwardInfo>;
4679
4677
  /**
4680
- * 代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4678
+ * <p>代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
4681
4679
  */
4682
4680
  Agent?: Agent;
4683
4681
  }
@@ -8031,10 +8029,7 @@ export interface CreateIntegrationUserRolesResponse {
8031
8029
  */
8032
8030
  export interface CreateEmbedWebUrlResponse {
8033
8031
  /**
8034
- * 嵌入的web链接,有效期:5分钟
8035
- 链接仅能使用一次
8036
- 建议:每次都用接口生成链接,保证链接的有效性
8037
- <br/>EmbedType=PREVIEW_CC_FLOW,该url为h5链接
8032
+ * <p>嵌入的web链接,有效期:5分钟<br>链接仅能使用一次<br>建议:每次都用接口生成链接,保证链接的有效性<br><br>EmbedType=PREVIEW_CC_FLOW,该url为h5链接</p>
8038
8033
  */
8039
8034
  WebUrl?: string;
8040
8035
  /**
@@ -12385,82 +12380,37 @@ export interface CreateUserMobileChangeUrlRequest {
12385
12380
  */
12386
12381
  export interface CreateEmbedWebUrlRequest {
12387
12382
  /**
12388
- * 执行本接口操作的员工信息。
12389
- <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
12383
+ * <p>执行本接口操作的员工信息。<br><br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
12390
12384
  */
12391
12385
  Operator: UserInfo;
12392
12386
  /**
12393
- * WEB嵌入资源类型,支持以下类型
12394
- <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
12395
- <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
12396
- <li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>
12397
- <li>CREATE_CONTRACT_DRAFT_COOPEDIT:生成创建起草合同的嵌入页面</li>
12398
- <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
12399
- <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
12400
- <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
12401
- <li>EXTEND_SERVICE:生成高级签署能力的嵌入页面</li>
12402
- <li>PREVIEW_FLOW:生成预览合同的嵌入页面(支持移动端)</li>
12403
- <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面(仅支持PC端)</li></ul>
12404
-
12405
- 注意:
12406
- 不同的嵌入类型,操作人需要的权限项不同(权限配置可参考[权限配置](https://qian.tencent.com/document/61355))。
12407
- <table border="1">
12408
- <thead>
12409
- <tr><th>EmbedType</th><th>权限</th></tr>
12410
- </thead>
12411
- <tbody>
12412
- <tr><th>CREATE_SEAL</th><th>印章管理-添加印章</th></tr>
12413
- <tr><th>CREATE_TEMPLATE</th><th>模板管理-创建模板</th></tr>
12414
- <tr><th>MODIFY_TEMPLATE</th><th>模板管理-编辑模板</th></tr>
12415
- <tr><th>CREATE_CONTRACT_DRAFT_COOPEDIT</th><th>合同管理-起草合同</th></tr>
12416
- <tr><th>PREVIEW_TEMPLATE</th><th>拥有下面三种权限的一种就行</br>
12417
- 模板管理-查询模板(本企业全部模板)</br>
12418
- 模板管理-查询模板(本部门全部模板)</br>
12419
- 模板管理-查询模板(本人创建模板)</th></tr>
12420
- <tr><th>PREVIEW_SEAL_LIST</th><th>印章管理</th></tr>
12421
- <tr><th>PREVIEW_SEAL_DETAIL</th><th>印章管理</th></tr>
12422
- <tr><th>EXTEND_SERVICE</th><th>无要求</th></tr>
12423
- <tr><th>PREVIEW_FLOW</th><th>是否是当前合同的参与方,或者发起方企业的法人、超管、合同管理员</th></tr>
12424
- <tr><th>PREVIEW_FLOW_DETAIL</th><th>是否是当前合同的参与方,或者发起方企业的法人、超管、合同管理员</th></tr>
12425
- </tbody>
12426
- </table>
12387
+ * <p>WEB嵌入资源类型,支持以下类型</p><p>枚举值:</p><ul><li><p>CREATE_SEAL: 生成创建印章的嵌入页面</p></li><li><p>CREATE_TEMPLATE: 生成创建模板的嵌入页面</p></li><li><p>MODIFY_TEMPLATE: 生成编辑模板的嵌入页面</p></li><li><p>CREATE_CONTRACT_DRAFT_COOPEDIT: 生成创建起草合同的嵌入页面</p></li><li><p>PREVIEW_TEMPLATE: 生成预览模板的嵌入页面</p></li><li><p>PREVIEW_SEAL_LIST: 生成预览印章列表的嵌入页面</p></li><li><p>PREVIEW_SEAL_DETAIL: 生成预览印章详情的嵌入页面</p></li><li><p>EXTEND_SERVICE: 生成高级签署能力的嵌入页面</p></li><li><p>PREVIEW_FLOW: 生成预览合同的嵌入页面(支持移动端)</p></li><li><p>PREVIEW_FLOW_DETAIL: 生成查看合同详情的嵌入页面(仅支持PC端)</p></li><li><p>CHANNEL_TEMPLATE: 生成应用模板库管理的嵌入页面(仅支持PC端)</p></li><li><p>CHANNEL_COMPONENT: 生成应用模板控件管理的嵌入页面(仅支持PC端)</p><p>注意: 不同的嵌入类型,操作人需要的权限项不同(权限配置可参考<a href="https://qian.tencent.com/document/61355">权限配置</a>)。 <table border="1"> <thead> <tr><th>EmbedType</th><th>权限</th></tr> </thead> <tbody> <tr><th>CREATE_SEAL</th><th>印章管理-添加印章</th></tr> <tr><th>CREATE_TEMPLATE</th><th>模板管理-创建模板</th></tr> <tr><th>MODIFY_TEMPLATE</th><th>模板管理-编辑模板</th></tr> <tr><th>CREATE_CONTRACT_DRAFT_COOPEDIT</th><th>合同管理-起草合同</th></tr> <tr><th>PREVIEW_TEMPLATE</th><th>拥有下面三种权限的一种就行<br> 模板管理-查询模板(本企业全部模板)<br> 模板管理-查询模板(本部门全部模板)<br> 模板管理-查询模板(本人创建模板)</th></tr> <tr><th>PREVIEW_SEAL_LIST</th><th>印章管理</th></tr> <tr><th>PREVIEW_SEAL_DETAIL</th><th>印章管理</th></tr> <tr><th>EXTEND_SERVICE</th><th>无要求</th></tr> <tr><th>PREVIEW_FLOW</th><th>是否是当前合同的参与方,或者发起方企业的法人、超管、合同管理员</th></tr> <tr><th>PREVIEW_FLOW_DETAIL</th><th>是否是当前合同的参与方,或者发起方企业的法人、超管、合同管理员</th></tr> <tr><th>CHANNEL_TEMPLATE</th><th>开发者中心-应用模板库管理</th></tr> <tr><th>CHANNEL_COMPONENT</th><th>开发者中心-应用模板控件管理</th></tr> </tbody> </table></p></li></ul>
12427
12388
  */
12428
12389
  EmbedType: string;
12429
12390
  /**
12430
- * WEB嵌入的业务资源ID
12431
-
12432
- 当EmbedType取值
12433
- <ul>
12434
- <li>为PREVIEW_SEAL_DETAIL,必填,取值为印章id。</li>
12435
- <li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>
12436
- <li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id。</li>
12437
- <li>为CREATE_CONTRACT_DRAFT_COOPEDIT,非必填,取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>
12438
- <li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id。</li>
12439
- </ul>
12440
-
12441
- 注意:
12442
- 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口[创建文件转换任务
12443
- ](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。
12444
- 2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。
12391
+ * <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为PREVIEW_SEAL_DETAIL,必填,取值为印章id。</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id。</li><li>为CREATE_CONTRACT_DRAFT_COOPEDIT,非必填,取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id。</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi">查询转换任务状态</a> 来进行转换成PDF资源。</li><li>CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。</li></ol>
12445
12392
  */
12446
12393
  BusinessId?: string;
12447
12394
  /**
12448
- * 代理企业和员工的信息。
12449
- <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
12395
+ * <p>代理企业和员工的信息。<br><br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
12450
12396
  */
12451
12397
  Agent?: Agent;
12452
12398
  /**
12453
- * 抄送方信息
12399
+ * <p>抄送方信息</p>
12454
12400
  */
12455
12401
  Reviewer?: ReviewerInfo;
12456
12402
  /**
12457
- * 个性化参数,用于控制页面展示内容
12403
+ * <p>个性化参数,用于控制页面展示内容</p>
12458
12404
  */
12459
12405
  Option?: EmbedUrlOption;
12460
12406
  /**
12461
12407
  * <ul> <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li> <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li> <li>支持的格式:json字符串的BASE64编码字符串</li> <li>示例:<ul> <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li> <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li> </ul> </li> </ul>
12462
12408
  */
12463
12409
  UserData?: string;
12410
+ /**
12411
+ * <p>第三方应用号ID</p><p>当EmbedType取以下值时,该字段生效</p><ul><li>CHANNEL_TEMPLATE:生成指定应用的模板库管理页面</li><li>CHANNEL_COMPONENT:生成指定应用的控件管理页面</li></ul>
12412
+ */
12413
+ ApplicationId?: string;
12464
12414
  }
12465
12415
  /**
12466
12416
  * ExportContractReviewMarkedRisk返回参数结构体