tencentcloud-sdk-nodejs-ess 4.1.284 → 4.1.286

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.284",
3
+ "version": "4.1.286",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -1474,7 +1474,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
1474
1474
  - **可撤回合同状态**:未全部签署完成
1475
1475
  - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
1476
1476
 
1477
- 注:
1477
+
1478
+ **合同额度返还规则**:
1479
+
1480
+ 1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
1481
+ 2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
1482
+ 3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
1483
+
1484
+ **注**:
1478
1485
  1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
1479
1486
 
1480
1487
  2. 有对应合同撤销权限的人:
@@ -1486,10 +1493,6 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
1486
1493
  - 其它员工<font color='red'>(并已经授予撤销我发起的合同后)</font>:
1487
1494
  - 撤销人与发起人<font color='red'>**不在**</font>同一个部门:<font color='red'>(确保已授予查询合同 - 企业全部合同权限)</font>
1488
1495
  - 撤销人与发起人<font color='red'>**在**</font>用一个部门:<font color='red'>(确保授予查询合同 - 本部门全部合同权限 或 企业全部合同权限)</font>
1489
-
1490
-
1491
- 3. <font color='red'>**只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。**</font>
1492
-
1493
1496
  4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
1494
1497
  */
1495
1498
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
@@ -1510,7 +1513,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
1510
1513
  批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
1511
1514
 
1512
1515
 
1513
- 注:
1516
+ **合同额度返还规则**:
1517
+
1518
+ 1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
1519
+ 2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
1520
+ 3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
1521
+
1522
+ **注**:
1514
1523
  1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
1515
1524
 
1516
1525
  2. 有对应合同撤销权限的人:
@@ -1523,9 +1532,6 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
1523
1532
  - 撤销人与发起人<font color='red'>**不在**</font>同一个部门:<font color='red'>(确保已授予查询合同 - 企业全部合同权限)</font>
1524
1533
  - 撤销人与发起人<font color='red'>**在**</font>用一个部门:<font color='red'>(确保授予查询合同 - 本部门全部合同权限 或 企业全部合同权限)</font>
1525
1534
 
1526
-
1527
- 3. <font color='red'>**只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。**</font>
1528
-
1529
1535
  4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
1530
1536
  */
1531
1537
  CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
@@ -1744,7 +1744,14 @@ class Client extends TencentCloudCommon.AbstractClient {
1744
1744
  - **可撤回合同状态**:未全部签署完成
1745
1745
  - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
1746
1746
 
1747
- 注:
1747
+
1748
+ **合同额度返还规则**:
1749
+
1750
+ 1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
1751
+ 2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
1752
+ 3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
1753
+
1754
+ **注**:
1748
1755
  1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
1749
1756
 
1750
1757
  2. 有对应合同撤销权限的人:
@@ -1756,10 +1763,6 @@ class Client extends TencentCloudCommon.AbstractClient {
1756
1763
  - 其它员工<font color='red'>(并已经授予撤销我发起的合同后)</font>:
1757
1764
  - 撤销人与发起人<font color='red'>**不在**</font>同一个部门:<font color='red'>(确保已授予查询合同 - 企业全部合同权限)</font>
1758
1765
  - 撤销人与发起人<font color='red'>**在**</font>用一个部门:<font color='red'>(确保授予查询合同 - 本部门全部合同权限 或 企业全部合同权限)</font>
1759
-
1760
-
1761
- 3. <font color='red'>**只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。**</font>
1762
-
1763
1766
  4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
1764
1767
  */
1765
1768
  async CancelFlow(req, cb) {
@@ -1784,7 +1787,13 @@ class Client extends TencentCloudCommon.AbstractClient {
1784
1787
  批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
1785
1788
 
1786
1789
 
1787
- 注:
1790
+ **合同额度返还规则**:
1791
+
1792
+ 1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
1793
+ 2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
1794
+ 3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
1795
+
1796
+ **注**:
1788
1797
  1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
1789
1798
 
1790
1799
  2. 有对应合同撤销权限的人:
@@ -1797,9 +1806,6 @@ class Client extends TencentCloudCommon.AbstractClient {
1797
1806
  - 撤销人与发起人<font color='red'>**不在**</font>同一个部门:<font color='red'>(确保已授予查询合同 - 企业全部合同权限)</font>
1798
1807
  - 撤销人与发起人<font color='red'>**在**</font>用一个部门:<font color='red'>(确保授予查询合同 - 本部门全部合同权限 或 企业全部合同权限)</font>
1799
1808
 
1800
-
1801
- 3. <font color='red'>**只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。**</font>
1802
-
1803
1809
  4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
1804
1810
  */
1805
1811
  async CreateBatchCancelFlowUrl(req, cb) {
@@ -60,6 +60,10 @@ export interface CreateSealRequest {
60
60
  * <p>电子印章类型 , 可选类型如下: <ul><li><strong>OFFICIAL</strong>: (默认)公章</li><li><strong>CONTRACT</strong>: 合同专用章;</li><li><strong>FINANCE</strong>: 财务专用章;</li><li><strong>PERSONNEL</strong>: 人事专用章</li><li><strong>INVOICE</strong>: 发票专用章</li><li><strong>OTHER</strong>: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错</p>
61
61
  */
62
62
  SealType?: string;
63
+ /**
64
+ * <p> 印章其他子类型。仅当 <code>SealType=OTHER</code> 且 <code>GenerateSource=SealGenerateSourceSystem</code> 时生效( <font color="red">不支持图片上传方式创建子类型印章</font>)。<br> <b>注1:</b>调用时请勿传入 <code>SealHorizontalText</code> 字段,系统将自动使用子印章类型名称填充该字段。<br> <b>注2:</b>本字段为白名单受控功能。如需使用,请联系客服开通并获取支持的子类型枚举值。</p>
65
+ */
66
+ SubSealType?: string;
63
67
  /**
64
68
  * <p>电子印章图片文件名称,1-50个中文字符。</p>
65
69
  */
@@ -1188,7 +1192,7 @@ export interface CreateFlowByFilesRequest {
1188
1192
  */
1189
1193
  CcNotifyType?: number;
1190
1194
  /**
1191
- * <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
1195
+ * <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul><p><strong>注</strong>: 预览服务按照合同份额 1:2的比例赠送预览次数。例如:购买 100 份合同,将赠送 200 次合同预览额度。当赠送的预览额度使用完后,如需继续使用预览服务,则需要单独购买预览服务额度。</p>
1192
1196
  */
1193
1197
  NeedPreview?: boolean;
1194
1198
  /**
@@ -7989,21 +7993,15 @@ export interface DescribeEnterpriseContractReviewChecklistsRequest {
7989
7993
  */
7990
7994
  export interface CreateDocumentResponse {
7991
7995
  /**
7992
- * 合同流程的底层电子文档ID,为32位字符串。
7993
-
7994
- 注:
7995
- 后续需用同样的FlowId再次调用[发起签署流程](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow),合同才能进入签署环节
7996
+ * <p>合同流程的底层电子文档ID,为32位字符串。</p><p>注:<br>后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow">发起签署流程</a>,合同才能进入签署环节</p>
7996
7997
  */
7997
7998
  DocumentId?: string;
7998
7999
  /**
7999
- * 合同预览链接URL
8000
-
8001
- 注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`
8002
- `2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,完整的预览链接需通过[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)获取。
8000
+ * <p>合同预览链接URL。</p><p>注: <code>1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL</code><br>`2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,完整的预览链接需通过<a href="https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83">合同文档合成完成回调</a>获取。</p>
8003
8001
  */
8004
8002
  PreviewFileUrl?: string;
8005
8003
  /**
8006
- * 签署方信息,如角色ID、角色名称等
8004
+ * <p>签署方信息,如角色ID、角色名称等</p>
8007
8005
  */
8008
8006
  Approvers?: Array<ApproverItem>;
8009
8007
  /**
@@ -8850,28 +8848,53 @@ export interface CreatePreparedPersonalEsignResponse {
8850
8848
  */
8851
8849
  export interface FlowGroupOptions {
8852
8850
  /**
8853
- * 签署人校验方式,支持以下类型
8854
- <ul><li>VerifyCheck : 人脸识别 (默认值)</li>
8855
- <li>MobileCheck : 手机号验证</li></ul>
8856
- 参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
8851
+ * <p>签署人校验方式,支持以下类型</p><ul><li>VerifyCheck : 人脸识别 (默认值)</li><li>MobileCheck : 手机号验证</li></ul>参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
8857
8852
  */
8858
8853
  ApproverVerifyType?: string;
8859
8854
  /**
8860
- * 发起合同(流程)组本方企业经办人通知方式
8861
- 签署通知类型,支持以下类型
8862
- <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
8855
+ * <p>发起合同(流程)组本方企业经办人通知方式<br>签署通知类型,支持以下类型</p><ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
8863
8856
  */
8864
8857
  SelfOrganizationApproverNotifyType?: string;
8865
8858
  /**
8866
- * 发起合同(流程)组他方经办人通知方式
8867
- 签署通知类型,支持以下类型
8868
- <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
8859
+ * <p>发起合同(流程)组他方经办人通知方式<br>签署通知类型,支持以下类型</p><ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
8869
8860
  */
8870
8861
  OtherApproverNotifyType?: string;
8871
8862
  /**
8872
- * 是否开启发起合同组的发起审批,默认:false(不开启),开启后,发起合同组会提交电子签内置审批流
8863
+ * <p>是否开启发起合同组的发起审批,默认:false(不开启),开启后,发起合同组会提交电子签内置审批流</p>
8873
8864
  */
8874
8865
  FlowGroupNeedWorkflow?: boolean;
8866
+ /**
8867
+ * <p>是否不可编辑合同名称 true-不可编辑 false-可编辑(默认)</p>
8868
+ */
8869
+ NoEditFlowName?: boolean;
8870
+ /**
8871
+ * <p>是否不可编辑合同类型 true-不可编辑 false-可编辑(默认)</p>
8872
+ */
8873
+ NoEditFlowType?: boolean;
8874
+ /**
8875
+ * <p>是否不可编辑合同截止日期 true-不可编辑 false-可编辑(默认)</p>
8876
+ */
8877
+ NoEditDeadline?: boolean;
8878
+ /**
8879
+ * <p>签署控件配置(如是否默认展示日期),用于嵌入式发起页面配置</p>
8880
+ */
8881
+ SignComponentConfig?: SignComponentConfig;
8882
+ /**
8883
+ * <p>是否禁止编辑水印控件属性 true-禁止 false-否(默认)</p>
8884
+ */
8885
+ ForbidEditWatermark?: boolean;
8886
+ /**
8887
+ * <p>发起成功后是否隐藏签署码 true-隐藏 false-否(默认)</p>
8888
+ */
8889
+ HideSignCodeAfterStart?: boolean;
8890
+ /**
8891
+ * <p>发起成功后是否签署合同,仅当前经办人为签署人时生效 true-展示签署 false-否(默认)</p>
8892
+ */
8893
+ SignAfterStart?: boolean;
8894
+ /**
8895
+ * <p>发起成功后是否预览合同 true-展示预览按钮 false-否(默认)</p>
8896
+ */
8897
+ PreviewAfterStart?: boolean;
8875
8898
  }
8876
8899
  /**
8877
8900
  * 创建合同,若对方签署人的企业信息还未在腾讯电子签注册。则在进行引导企业注册时控制企业填写的信息。
@@ -9458,31 +9481,37 @@ export interface UserFlowType {
9458
9481
  */
9459
9482
  export interface CreatePrepareFlowGroupRequest {
9460
9483
  /**
9461
- * 执行本接口操作的员工信息。
9462
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9484
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
9463
9485
  */
9464
9486
  Operator: UserInfo;
9465
9487
  /**
9466
- * 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
9488
+ * <p>合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
9467
9489
  */
9468
9490
  FlowGroupName: string;
9469
9491
  /**
9470
- * 合同(流程)组的子合同信息,支持2-50个子合同
9492
+ * <p>合同(流程)组的子合同信息,支持2-50个子合同</p>
9471
9493
  */
9472
9494
  FlowGroupInfos: Array<FlowGroupInfo>;
9473
9495
  /**
9474
- * 资源类型,取值有: <ul><li> **1**:模板</li> <li> **2**:文件</li></ul>
9496
+ * <p>资源类型,取值有: <ul><li> <strong>1</strong>:模板</li> <li> <strong>2</strong>:文件</li></ul></p>
9475
9497
  */
9476
9498
  ResourceType: number;
9477
9499
  /**
9478
- * 代理企业和员工的信息。
9479
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9500
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
9480
9501
  */
9481
9502
  Agent?: Agent;
9482
9503
  /**
9483
- * 合同组发起控制参数,当前仅支持FlowGroupNeedWorkflow,表示开启嵌入式合同组发起审批
9504
+ * <p>合同组发起控制参数,例如FlowGroupNeedWorkflow,表示开启嵌入式合同组发起审批</p>
9484
9505
  */
9485
9506
  FlowGroupOptions?: FlowGroupOptions;
9507
+ /**
9508
+ * <p>合同组类型,发起合同组后会应用到所有子合同</p>
9509
+ */
9510
+ FlowGroupType?: string;
9511
+ /**
9512
+ * <p>合同组过期时间,发起合同组后会应用到所有子合同</p>
9513
+ */
9514
+ FlowGroupDeadline?: number;
9486
9515
  }
9487
9516
  /**
9488
9517
  * CreateFileCounterSign返回参数结构体
@@ -10101,50 +10130,35 @@ export interface SignUrl {
10101
10130
  */
10102
10131
  export interface DescribeOrganizationSealsRequest {
10103
10132
  /**
10104
- * 执行本接口操作的员工信息。
10105
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10133
+ * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10106
10134
  */
10107
10135
  Operator: UserInfo;
10108
10136
  /**
10109
- * 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200
10137
+ * <p>指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200。</p>
10110
10138
  */
10111
10139
  Limit?: number;
10112
10140
  /**
10113
- * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000
10141
+ * <p>指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000。</p>
10114
10142
  */
10115
10143
  Offset?: number;
10116
10144
  /**
10117
- * 查询授权用户信息类型,取值如下:
10118
-
10119
- <ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>
10145
+ * <p>查询授权用户信息类型,取值如下:</p><ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>
10120
10146
  */
10121
10147
  InfoType?: number;
10122
10148
  /**
10123
- * 印章id,是否查询特定的印章(没有输入返回所有)
10149
+ * <p>印章id,是否查询特定的印章(没有输入返回所有)</p>
10124
10150
  */
10125
10151
  SealId?: string;
10126
10152
  /**
10127
- * 印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>FINANCE</strong>:财务专用章;</li> <li><strong>PERSONNEL</strong>:人事专用章;</li><li><strong>INVOICE</strong>:发票专用章;</li><li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li><li><strong>OTHER</strong>其他类型印章</li> </ul>
10153
+ * <p>印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>FINANCE</strong>:财务专用章;</li> <li><strong>PERSONNEL</strong>:人事专用章;</li><li><strong>INVOICE</strong>:发票专用章;</li><li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li><li><strong>OTHER</strong>其他类型印章</li> <li><strong>OTHER_xx</strong>其他印章子类型</li> </ul><br>注: <code>1.为空时查询所有类型的印章。</code><br>注: <code>2.OTHER_XX该类型为其他印章子类型,如需使用,请联系对接客服申请开通。具体可传入的子类型值,需在申请开通后由客服提供。</code></p>
10128
10154
  */
10129
10155
  SealTypes?: Array<string>;
10130
10156
  /**
10131
- * 代理企业和员工的信息。
10132
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10157
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10133
10158
  */
10134
10159
  Agent?: Agent;
10135
10160
  /**
10136
- * 需查询的印章状态列表。
10137
- <ul>
10138
- <li>空:(默认)仅查询启用状态的印章;</li>
10139
- <li><strong>ALL</strong>:查询所有状态的印章;</li>
10140
- <li><strong>CHECKING</strong>:查询待审核的印章;</li>
10141
- <li><strong>SUCCESS</strong>:查询启用状态的印章;</li>
10142
- <li><strong>FAIL</strong>:查询印章审核拒绝的印章;</li>
10143
- <li><strong>DISABLE</strong>:查询已停用的印章;</li>
10144
- <li><strong>STOPPED</strong>:查询已终止的印章;</li>
10145
- <li><strong>VOID</strong>:查询已作废的印章;</li>
10146
- <li><strong>INVALID</strong>:查询已失效的印章。</li>
10147
- </ul>
10161
+ * <p>需查询的印章状态列表。</p><ul><li>空:(默认)仅查询启用状态的印章;</li><li><strong>ALL</strong>:查询所有状态的印章;</li><li><strong>CHECKING</strong>:查询待审核的印章;</li><li><strong>SUCCESS</strong>:查询启用状态的印章;</li><li><strong>FAIL</strong>:查询印章审核拒绝的印章;</li><li><strong>DISABLE</strong>:查询已停用的印章;</li><li><strong>STOPPED</strong>:查询已终止的印章;</li><li><strong>VOID</strong>:查询已作废的印章;</li><li><strong>INVALID</strong>:查询已失效的印章。</li></ul>
10148
10162
  */
10149
10163
  SealStatuses?: Array<string>;
10150
10164
  }
@@ -10703,11 +10717,11 @@ export interface CreateExtendedServiceAuthInfosRequest {
10703
10717
  */
10704
10718
  export interface CreatePrepareFlowGroupResponse {
10705
10719
  /**
10706
- * 合同(流程)组的合同组Id
10720
+ * <p>合同(流程)组的合同组Id</p>
10707
10721
  */
10708
10722
  FlowGroupId?: string;
10709
10723
  /**
10710
- * 嵌入式合同组发起链接
10724
+ * <p>嵌入式合同组发起链接</p>
10711
10725
  */
10712
10726
  PrepareUrl?: string;
10713
10727
  /**
@@ -11203,11 +11217,11 @@ export interface Option {
11203
11217
  */
11204
11218
  export interface DescribeOrganizationSealsResponse {
11205
11219
  /**
11206
- * 在设定了SealId时,返回值为0或1;若未设定SealId,则返回公司的总印章数量
11220
+ * <p>在设定了SealId时,返回值为0或1;若未设定SealId,则返回公司的总印章数量</p>
11207
11221
  */
11208
11222
  TotalCount?: number;
11209
11223
  /**
11210
- * 查询到的印章结果数组
11224
+ * <p>查询到的印章结果数组</p>
11211
11225
  */
11212
11226
  Seals?: Array<OccupiedSeal>;
11213
11227
  /**
@@ -12245,51 +12259,39 @@ export interface CreateFlowBlockchainEvidenceUrlResponse {
12245
12259
  */
12246
12260
  export interface CreateDocumentRequest {
12247
12261
  /**
12248
- * 本合同的发起人,<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
12249
-
12250
- 注:支持填入集团子公司经办人 userId代发合同。
12262
+ * <p>本合同的发起人,<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注:支持填入集团子公司经办人 userId代发合同。</p>
12251
12263
  */
12252
12264
  Operator: UserInfo;
12253
12265
  /**
12254
- * 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
12255
-
12256
- [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)
12266
+ * <p>用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png">点击查看模板Id在控制台上的位置</a></p>
12257
12267
  */
12258
12268
  TemplateId: string;
12259
12269
  /**
12260
- * 合同流程ID,为32位字符串。
12261
- 此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
12270
+ * <p>合同流程ID,为32位字符串。<br>此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow">创建签署流程</a>接口创建得到。</p>
12262
12271
  */
12263
12272
  FlowId?: string;
12264
12273
  /**
12265
- * 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
12274
+ * <p>文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。</p>
12266
12275
  */
12267
12276
  FileNames?: Array<string>;
12268
12277
  /**
12269
- * 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
12270
- <ul>
12271
- <li>支持自动签传递印章,可通过指定自动签控件id,指定印章id来完成</li>
12272
- <li>附件控件支持传入图片、文件资源id,并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型,图片资源会放置在合同文件的末尾,如果传入的资源有非图片类型资源,会将资源放置在附件控件所在页面的下一页。</li>
12273
- </ul>
12274
- 注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。
12275
- ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png)
12278
+ * <p>电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield">FormField</a>结构体的定义。</p><ul><li>支持自动签传递印章,可通过指定自动签控件id,指定印章id来完成</li><li>附件控件支持传入图片、文件资源id,并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型,图片资源会放置在合同文件的末尾,如果传入的资源有非图片类型资源,会将资源放置在附件控件所在页面的下一页。</li></ul>注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png)
12276
12279
  */
12277
12280
  FormFields?: Array<FormField>;
12278
12281
  /**
12279
- * 是否为预览模式,取值如下:<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 1.以预览模式创建的合同仅供查看,因此参与方无法进行签署操作;;2.以预览模式调用该接口返回的FlowId为临时Flowld,无法用于发起和拉取信息。</font> </li></ul>注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,动态表格合成完后会触发文档合成完成的回调通知`
12282
+ * <p>是否为预览模式,取值如下:<ul><li> <strong>false</strong>:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> <li> <strong>true</strong>:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 1.以预览模式创建的合同仅供查看,因此参与方无法进行签署操作;;2.以预览模式调用该接口返回的FlowId为临时Flowld,无法用于发起和拉取信息。</font> </li></ul></p><p><strong>注1</strong>: <code>当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,动态表格合成完后会触发文档合成完成的回调通知</code><br><strong>注2</strong>: 预览服务按照合同份额 1:2的比例赠送预览次数。例如:购买 100 份合同,将赠送 200 次合同预览额度。当赠送的预览额度使用完后,如需继续使用预览服务,则需要单独购买预览服务额度。</p>
12280
12283
  */
12281
12284
  NeedPreview?: boolean;
12282
12285
  /**
12283
- * 预览模式下产生的预览链接类型 <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子。</li></ul>注: `1.此参数在NeedPreview 为true时有效`
12286
+ * <p>预览模式下产生的预览链接类型 <ul><li> <strong>0</strong> :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> <strong>1</strong> :H5链接 ,点开后在浏览器中展示合同的样子。</li></ul>注: <code>1.此参数在NeedPreview 为true时有效</code></p>
12284
12287
  */
12285
12288
  PreviewType?: number;
12286
12289
  /**
12287
- * 代理企业和员工的信息。
12288
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
12290
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
12289
12291
  */
12290
12292
  Agent?: Agent;
12291
12293
  /**
12292
- * 该字段已不再使用
12294
+ * <p>该字段已不再使用</p>
12293
12295
  */
12294
12296
  ClientToken?: string;
12295
12297
  }