tencentcloud-sdk-nodejs-essbasic 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
|
@@ -251,11 +251,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
251
251
|
|
|
252
252
|
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/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/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
|
|
253
253
|
|
|
254
|
+
**合同额度返还规则**:
|
|
254
255
|
|
|
255
|
-
|
|
256
|
+
1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
|
|
257
|
+
2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
|
|
258
|
+
3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
|
|
259
|
+
|
|
260
|
+
**注**:
|
|
256
261
|
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
|
|
257
262
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
258
|
-
- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
259
263
|
- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
|
|
260
264
|
*/
|
|
261
265
|
ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
|
|
@@ -383,10 +387,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
383
387
|
- **可撤回合同状态**:未全部签署完成
|
|
384
388
|
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
385
389
|
|
|
386
|
-
|
|
390
|
+
**合同额度返还规则**:
|
|
391
|
+
|
|
392
|
+
1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
|
|
393
|
+
2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
|
|
394
|
+
3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
|
|
395
|
+
|
|
396
|
+
**注**:
|
|
387
397
|
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
|
|
388
398
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
389
|
-
- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
390
399
|
- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
|
|
391
400
|
*/
|
|
392
401
|
ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
|
|
@@ -1249,9 +1258,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
1249
1258
|
|
|
1250
1259
|
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/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/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
|
|
1251
1260
|
|
|
1252
|
-
|
|
1261
|
+
**合同额度返还规则**:
|
|
1262
|
+
|
|
1263
|
+
1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
|
|
1264
|
+
2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
|
|
1265
|
+
3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
|
|
1266
|
+
|
|
1267
|
+
**注**:
|
|
1253
1268
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
1254
|
-
- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
1255
1269
|
- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
|
|
1256
1270
|
*/
|
|
1257
1271
|
ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
|
|
@@ -307,11 +307,15 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
307
307
|
|
|
308
308
|
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/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/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
|
|
309
309
|
|
|
310
|
+
**合同额度返还规则**:
|
|
310
311
|
|
|
311
|
-
|
|
312
|
+
1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
|
|
313
|
+
2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
|
|
314
|
+
3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
|
|
315
|
+
|
|
316
|
+
**注**:
|
|
312
317
|
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
|
|
313
318
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
314
|
-
- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
315
319
|
- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
|
|
316
320
|
*/
|
|
317
321
|
async ChannelBatchCancelFlows(req, cb) {
|
|
@@ -457,10 +461,15 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
457
461
|
- **可撤回合同状态**:未全部签署完成
|
|
458
462
|
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
459
463
|
|
|
460
|
-
|
|
464
|
+
**合同额度返还规则**:
|
|
465
|
+
|
|
466
|
+
1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
|
|
467
|
+
2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
|
|
468
|
+
3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
|
|
469
|
+
|
|
470
|
+
**注**:
|
|
461
471
|
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
|
|
462
472
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
463
|
-
- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
464
473
|
- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
|
|
465
474
|
*/
|
|
466
475
|
async ChannelCancelFlow(req, cb) {
|
|
@@ -1431,9 +1440,14 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
1431
1440
|
|
|
1432
1441
|
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/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/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
|
|
1433
1442
|
|
|
1434
|
-
|
|
1443
|
+
**合同额度返还规则**:
|
|
1444
|
+
|
|
1445
|
+
1.撤销服务按照合同份额 1:1赠送免费撤销次数。例如购买 100 份合同,赠送 100 次免费撤销额度。
|
|
1446
|
+
2.仅当没有任何参与方签署过,或仅自动签署完成的合同,撤销后才会使用免费撤销额度。
|
|
1447
|
+
3.当赠送的免费撤销额度使用完后,后续仍可撤销合同,但不会返还合同额度。
|
|
1448
|
+
|
|
1449
|
+
**注**:
|
|
1435
1450
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
1436
|
-
- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
1437
1451
|
- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
|
|
1438
1452
|
*/
|
|
1439
1453
|
async ChannelCreateBatchCancelFlowUrl(req, cb) {
|
|
@@ -1972,7 +1972,7 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
1972
1972
|
*/
|
|
1973
1973
|
FlowDisplayType?: number;
|
|
1974
1974
|
/**
|
|
1975
|
-
* <p>是否为预览模式,取值如下: <ul><li> <strong>false</strong>:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> <li> <strong>true</strong>:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul></p>
|
|
1975
|
+
* <p>是否为预览模式,取值如下: <ul><li> <strong>false</strong>:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> <li> <strong>true</strong>:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul></p><p><strong>注</strong>: 预览服务按照合同份额 1:2的比例赠送预览次数。例如:购买 100 份合同,将赠送 200 次合同预览额度。当赠送的预览额度使用完后,如需继续使用预览服务,则需要单独购买预览服务额度。</p>
|
|
1976
1976
|
*/
|
|
1977
1977
|
NeedPreview?: boolean;
|
|
1978
1978
|
/**
|
|
@@ -3157,30 +3157,33 @@ export interface DeleteOrganizationAuthorizationsResponse {
|
|
|
3157
3157
|
*/
|
|
3158
3158
|
export interface ChannelCreatePrepareFlowGroupRequest {
|
|
3159
3159
|
/**
|
|
3160
|
-
*
|
|
3160
|
+
* <p>合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。</p>
|
|
3161
3161
|
*/
|
|
3162
3162
|
BaseFlowInfos: Array<BaseFlowInfo>;
|
|
3163
3163
|
/**
|
|
3164
|
-
*
|
|
3164
|
+
* <p>合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
|
|
3165
3165
|
*/
|
|
3166
3166
|
FlowGroupName: string;
|
|
3167
3167
|
/**
|
|
3168
|
-
*
|
|
3168
|
+
* <p>资源类型,取值有: <ul><li> <strong>1</strong>:模板</li> <li> <strong>2</strong>:文件</li></ul></p>
|
|
3169
3169
|
*/
|
|
3170
3170
|
ResourceType: number;
|
|
3171
3171
|
/**
|
|
3172
|
-
*
|
|
3173
|
-
|
|
3174
|
-
此接口下面信息必填。
|
|
3175
|
-
<ul>
|
|
3176
|
-
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
|
|
3177
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(合同的发起企业)</li>
|
|
3178
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (合同的发起人)</li>
|
|
3179
|
-
</ul>
|
|
3180
|
-
|
|
3181
|
-
合同的发起企业和发起人必需已经完成实名,并加入企业
|
|
3172
|
+
* <p>合同的发起企业和发起人信息,<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a></p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(合同的发起企业)</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (合同的发起人)</li></ul><p>合同的发起企业和发起人必需已经完成实名,并加入企业</p>
|
|
3182
3173
|
*/
|
|
3183
3174
|
Agent?: Agent;
|
|
3175
|
+
/**
|
|
3176
|
+
* <p>合同组发起参数控制,包括对合同组名称、过期时间、发起后签署以及查看等操作</p>
|
|
3177
|
+
*/
|
|
3178
|
+
FlowGroupOptions?: FlowGroupOptions;
|
|
3179
|
+
/**
|
|
3180
|
+
* <p>合同组类型,会应用到所有子合同</p>
|
|
3181
|
+
*/
|
|
3182
|
+
FlowGroupType?: string;
|
|
3183
|
+
/**
|
|
3184
|
+
* <p>合同组过期时间,会应用到所有子合同</p>
|
|
3185
|
+
*/
|
|
3186
|
+
FlowGroupDeadline?: number;
|
|
3184
3187
|
}
|
|
3185
3188
|
/**
|
|
3186
3189
|
* DescribeExtendedServiceAuthDetail请求参数结构体
|
|
@@ -4195,63 +4198,76 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
|
4195
4198
|
*/
|
|
4196
4199
|
export interface FlowGroupOptions {
|
|
4197
4200
|
/**
|
|
4198
|
-
*
|
|
4199
|
-
<ul><li>**false**(默认):发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
|
|
4200
|
-
<li>**true**:发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
|
|
4201
|
+
* <p>发起方企业经办人(即签署人为发起方企业员工)是否需要对子合同进行独立的意愿确认</p><ul><li>**false**(默认):发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li><li>**true**:发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
|
|
4201
4202
|
*/
|
|
4202
4203
|
SelfOrganizationApproverSignEach?: boolean;
|
|
4203
4204
|
/**
|
|
4204
|
-
*
|
|
4205
|
-
<ul><li>**false**(默认):非发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
|
|
4206
|
-
<li>**true**:非发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
|
|
4205
|
+
* <p>非发起方企业经办人(即:签署人为个人或者不为发起方企业的员工)是否需要对子合同进行独立的意愿确认</p><ul><li>**false**(默认):非发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li><li>**true**:非发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
|
|
4207
4206
|
*/
|
|
4208
4207
|
OtherApproverSignEach?: boolean;
|
|
4208
|
+
/**
|
|
4209
|
+
* <p>是否不可编辑合同名称 true-不可编辑 false-可编辑(默认)</p>
|
|
4210
|
+
*/
|
|
4211
|
+
NoEditFlowName?: boolean;
|
|
4212
|
+
/**
|
|
4213
|
+
* <p>是否不可编辑合同类型 true-不可编辑 false-可编辑(默认)</p>
|
|
4214
|
+
*/
|
|
4215
|
+
NoEditFlowType?: boolean;
|
|
4216
|
+
/**
|
|
4217
|
+
* <p>是否不可编辑合同截止日期 true-不可编辑 false-可编辑(默认)</p>
|
|
4218
|
+
*/
|
|
4219
|
+
NoEditDeadline?: boolean;
|
|
4220
|
+
/**
|
|
4221
|
+
* <p>签署控件配置(如是否默认展示日期),用于嵌入式发起页面配置</p>
|
|
4222
|
+
*/
|
|
4223
|
+
SignComponentConfig?: SignComponentConfig;
|
|
4224
|
+
/**
|
|
4225
|
+
* <p>是否禁止编辑水印控件属性 true-禁止 false-否(默认)</p>
|
|
4226
|
+
*/
|
|
4227
|
+
ForbidEditWatermark?: boolean;
|
|
4228
|
+
/**
|
|
4229
|
+
* <p>发起成功后是否隐藏签署码 true-隐藏 false-否(默认)</p>
|
|
4230
|
+
*/
|
|
4231
|
+
HideSignCodeAfterStart?: boolean;
|
|
4232
|
+
/**
|
|
4233
|
+
* <p>发起成功后是否签署合同,仅当前经办人为签署人时生效 true-展示签署 false-否(默认)</p>
|
|
4234
|
+
*/
|
|
4235
|
+
SignAfterStart?: boolean;
|
|
4236
|
+
/**
|
|
4237
|
+
* <p>发起成功后是否预览合同 true-展示预览按钮 false-否(默认)</p>
|
|
4238
|
+
*/
|
|
4239
|
+
PreviewAfterStart?: boolean;
|
|
4209
4240
|
}
|
|
4210
4241
|
/**
|
|
4211
4242
|
* ChannelDescribeOrganizationSeals请求参数结构体
|
|
4212
4243
|
*/
|
|
4213
4244
|
export interface ChannelDescribeOrganizationSealsRequest {
|
|
4214
4245
|
/**
|
|
4215
|
-
*
|
|
4216
|
-
|
|
4217
|
-
此接口下面信息必填。
|
|
4218
|
-
<ul>
|
|
4219
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
4220
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4221
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4222
|
-
</ul>
|
|
4223
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
4246
|
+
* <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
|
|
4224
4247
|
*/
|
|
4225
4248
|
Agent: Agent;
|
|
4226
4249
|
/**
|
|
4227
|
-
*
|
|
4250
|
+
* <p>指定分页每页返回的数据条数,单页最大支持 100。默认值为20</p>
|
|
4228
4251
|
*/
|
|
4229
4252
|
Limit?: number;
|
|
4230
4253
|
/**
|
|
4231
|
-
*
|
|
4254
|
+
* <p>分页查询偏移量,默认为0,最大为20000</p>
|
|
4232
4255
|
*/
|
|
4233
4256
|
Offset?: number;
|
|
4234
4257
|
/**
|
|
4235
|
-
*
|
|
4236
|
-
|
|
4237
|
-
<ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>
|
|
4258
|
+
* <p>查询授权用户信息类型,取值如下:</p><ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>
|
|
4238
4259
|
*/
|
|
4239
4260
|
InfoType?: number;
|
|
4240
4261
|
/**
|
|
4241
|
-
*
|
|
4242
|
-
|
|
4243
|
-
注: `没有输入返回所有记录,最大返回100条。`
|
|
4262
|
+
* <p>印章id,是否查询特定的印章(没有输入返回所有)</p><p>注: <code>没有输入返回所有记录,最大返回100条。</code></p>
|
|
4244
4263
|
*/
|
|
4245
4264
|
SealId?: string;
|
|
4246
4265
|
/**
|
|
4247
|
-
*
|
|
4266
|
+
* <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>注: <code>1.为空时查询所有类型的印章。</code><br>注: <code>2.OTHER_XX该类型为其他印章子类型,如需使用,请联系对接客服申请开通。具体可传入的子类型值,需在申请开通后由客服提供。</code></p>
|
|
4248
4267
|
*/
|
|
4249
4268
|
SealTypes?: Array<string>;
|
|
4250
4269
|
/**
|
|
4251
|
-
*
|
|
4252
|
-
需查询的印章状态列表。
|
|
4253
|
-
|
|
4254
|
-
<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>
|
|
4270
|
+
* <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>
|
|
4255
4271
|
*/
|
|
4256
4272
|
SealStatuses?: Array<string>;
|
|
4257
4273
|
}
|
|
@@ -5809,36 +5825,27 @@ export interface PrepareFlowsRequest {
|
|
|
5809
5825
|
*/
|
|
5810
5826
|
export interface CreateFlowsByTemplatesResponse {
|
|
5811
5827
|
/**
|
|
5812
|
-
*
|
|
5813
|
-
建议开发者妥善保存此流程ID数组,以便于顺利进行后续操作。
|
|
5814
|
-
|
|
5815
|
-
[点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
|
|
5828
|
+
* <p>生成的合同流程ID数组,合同流程ID为32位字符串。<br>建议开发者妥善保存此流程ID数组,以便于顺利进行后续操作。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png">点击产看FlowId在控制台上的位置</a></p>
|
|
5816
5829
|
*/
|
|
5817
5830
|
FlowIds?: Array<string>;
|
|
5818
5831
|
/**
|
|
5819
|
-
*
|
|
5832
|
+
* <p>第三方应用平台的业务信息, 与创建合同的FlowInfos数组中的CustomerData一一对应</p>
|
|
5820
5833
|
*/
|
|
5821
5834
|
CustomerData?: Array<string>;
|
|
5822
5835
|
/**
|
|
5823
|
-
*
|
|
5824
|
-
成功为“”,创建失败则对应失败消息
|
|
5836
|
+
* <p>创建消息,对应多个合同ID,<br>成功为“”,创建失败则对应失败消息</p>
|
|
5825
5837
|
*/
|
|
5826
5838
|
ErrorMessages?: Array<string>;
|
|
5827
5839
|
/**
|
|
5828
|
-
*
|
|
5829
|
-
|
|
5830
|
-
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
5831
|
-
如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过[合同文档合成完成回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%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)获取或使用返回的TaskInfo中的TaskId通过[查询转换任务状态
|
|
5832
|
-
](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi)接口查询得到
|
|
5840
|
+
* <p>合同预览链接URL数组。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL<br>如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%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>获取或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi">查询转换任务状态</a>接口查询得到</p>
|
|
5833
5841
|
*/
|
|
5834
5842
|
PreviewUrls?: Array<string>;
|
|
5835
5843
|
/**
|
|
5836
|
-
*
|
|
5837
|
-
如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
|
|
5844
|
+
* <p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br>如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;</p>
|
|
5838
5845
|
*/
|
|
5839
5846
|
TaskInfos?: Array<TaskInfo>;
|
|
5840
5847
|
/**
|
|
5841
|
-
*
|
|
5848
|
+
* <p>签署方信息,如角色ID、角色名称等</p>
|
|
5842
5849
|
*/
|
|
5843
5850
|
FlowApprovers?: Array<FlowApproverItem>;
|
|
5844
5851
|
/**
|
|
@@ -7090,11 +7097,11 @@ export interface ChannelDisableUserAutoSignRequest {
|
|
|
7090
7097
|
*/
|
|
7091
7098
|
export interface ChannelDescribeOrganizationSealsResponse {
|
|
7092
7099
|
/**
|
|
7093
|
-
*
|
|
7100
|
+
* <p>在设定了SealId时,返回值为0或1;若未设定SealId,则返回公司的总印章数量</p>
|
|
7094
7101
|
*/
|
|
7095
7102
|
TotalCount?: number;
|
|
7096
7103
|
/**
|
|
7097
|
-
*
|
|
7104
|
+
* <p>查询到的印章结果数组</p>
|
|
7098
7105
|
*/
|
|
7099
7106
|
Seals?: Array<OccupiedSeal>;
|
|
7100
7107
|
/**
|
|
@@ -7475,12 +7482,11 @@ export interface ApproverOption {
|
|
|
7475
7482
|
*/
|
|
7476
7483
|
export interface ChannelCreatePrepareFlowGroupResponse {
|
|
7477
7484
|
/**
|
|
7478
|
-
*
|
|
7479
|
-
建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。
|
|
7485
|
+
* <p>合同组ID,为32位字符串。<br>建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。</p>
|
|
7480
7486
|
*/
|
|
7481
7487
|
FlowGroupId?: string;
|
|
7482
7488
|
/**
|
|
7483
|
-
*
|
|
7489
|
+
* <p>嵌入式发起链接</p>
|
|
7484
7490
|
*/
|
|
7485
7491
|
PrepareUrl?: string;
|
|
7486
7492
|
/**
|
|
@@ -8467,41 +8473,23 @@ export interface OccupiedSeal {
|
|
|
8467
8473
|
*/
|
|
8468
8474
|
export interface CreateFlowsByTemplatesRequest {
|
|
8469
8475
|
/**
|
|
8470
|
-
*
|
|
8471
|
-
|
|
8472
|
-
此接口下面信息必填。
|
|
8473
|
-
<ul>
|
|
8474
|
-
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
|
|
8475
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(合同的发起企业)</li>
|
|
8476
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (合同的发起人)</li>
|
|
8477
|
-
</ul>
|
|
8476
|
+
* <p>合同的发起企业和发起人信息,<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a></p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(合同的发起企业)</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (合同的发起人)</li></ul>
|
|
8478
8477
|
*/
|
|
8479
8478
|
Agent: Agent;
|
|
8480
8479
|
/**
|
|
8481
|
-
*
|
|
8480
|
+
* <p>要创建的合同信息列表,最多支持一次创建20个合同</p>
|
|
8482
8481
|
*/
|
|
8483
8482
|
FlowInfos: Array<FlowInfo>;
|
|
8484
8483
|
/**
|
|
8485
|
-
*
|
|
8486
|
-
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
8487
|
-
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font></li></ul>
|
|
8488
|
-
|
|
8489
|
-
注:
|
|
8490
|
-
|
|
8491
|
-
`如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
|
|
8492
|
-
|
|
8484
|
+
* <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font></li></ul><p><strong>注1</strong>: 如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到</p><p><strong>注2</strong>: 预览服务按照合同份额 1:2的比例赠送预览次数。例如:购买 100 份合同,将赠送 200 次合同预览额度。当赠送的预览额度使用完后,如需继续使用预览服务,则需要单独购买预览服务额度。</p>
|
|
8493
8485
|
*/
|
|
8494
8486
|
NeedPreview?: boolean;
|
|
8495
8487
|
/**
|
|
8496
|
-
*
|
|
8497
|
-
<ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
|
|
8498
|
-
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
8499
|
-
注: `此参数在NeedPreview 为true时有效`
|
|
8500
|
-
|
|
8488
|
+
* <p>预览模式下产生的预览链接类型 </p><ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>注: <code>此参数在NeedPreview 为true时有效</code>
|
|
8501
8489
|
*/
|
|
8502
8490
|
PreviewType?: number;
|
|
8503
8491
|
/**
|
|
8504
|
-
*
|
|
8492
|
+
* <p>操作者的信息,不用传</p>
|
|
8505
8493
|
* @deprecated
|
|
8506
8494
|
*/
|
|
8507
8495
|
Operator?: UserInfo;
|
|
@@ -8582,6 +8570,10 @@ export interface CreateSealByImageRequest {
|
|
|
8582
8570
|
* <p>印章样式, 可以选择的样式如下: </p><ul><li>**circle**:(默认)圆形印章</li><li>**ellipse**:椭圆印章</li></ul>
|
|
8583
8571
|
*/
|
|
8584
8572
|
SealStyle?: string;
|
|
8573
|
+
/**
|
|
8574
|
+
* <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>
|
|
8575
|
+
*/
|
|
8576
|
+
SubSealType?: string;
|
|
8585
8577
|
/**
|
|
8586
8578
|
* <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>
|
|
8587
8579
|
*/
|