tencentcloud-sdk-nodejs 4.0.699 → 4.0.701
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/CHANGELOG.md +322 -0
- package/SERVICE_CHANGELOG.md +410 -154
- package/package.json +1 -1
- package/products.md +25 -25
- package/src/common/sdk_version.ts +1 -1
- package/src/services/batch/v20170312/batch_models.ts +5 -0
- package/src/services/cdn/v20180606/cdn_models.ts +1 -1
- package/src/services/cls/v20201016/cls_client.ts +3 -4
- package/src/services/cls/v20201016/cls_models.ts +17 -14
- package/src/services/cvm/v20170312/cvm_models.ts +5 -0
- package/src/services/dbbrain/v20210527/dbbrain_models.ts +3 -3
- package/src/services/dlc/v20210125/dlc_client.ts +318 -59
- package/src/services/dlc/v20210125/dlc_models.ts +1076 -228
- package/src/services/es/v20180416/es_models.ts +19 -14
- package/src/services/ess/v20201111/ess_client.ts +4 -2
- package/src/services/ess/v20201111/ess_models.ts +10 -2
- package/src/services/essbasic/v20210526/essbasic_client.ts +58 -23
- package/src/services/essbasic/v20210526/essbasic_models.ts +176 -31
- package/src/services/iss/v20230517/iss_models.ts +3 -3
- package/src/services/live/v20180801/live_models.ts +4 -1
- package/src/services/monitor/v20180724/monitor_models.ts +10 -5
- package/src/services/postgres/v20170312/postgres_client.ts +12 -0
- package/src/services/postgres/v20170312/postgres_models.ts +66 -0
- package/src/services/scf/v20180416/scf_models.ts +1 -0
- package/src/services/ssl/v20191205/ssl_client.ts +4 -2
- package/src/services/tcm/v20210413/tcm_models.ts +5 -0
- package/src/services/tdmq/v20200217/tdmq_client.ts +2 -1
- package/src/services/tdmq/v20200217/tdmq_models.ts +202 -93
- package/src/services/tke/v20180525/tke_models.ts +1 -1
- package/src/services/vod/v20180717/vod_models.ts +2 -2
- package/src/services/waf/v20180125/waf_client.ts +15 -3
- package/src/services/waf/v20180125/waf_models.ts +224 -166
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/batch/v20170312/batch_models.d.ts +5 -0
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +1 -1
- package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -2
- package/tencentcloud/services/cls/v20201016/cls_client.js +1 -2
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +17 -14
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +5 -0
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +3 -3
- package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +101 -17
- package/tencentcloud/services/dlc/v20210125/dlc_client.js +150 -24
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +1023 -224
- package/tencentcloud/services/es/v20180416/es_models.d.ts +19 -14
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +4 -2
- package/tencentcloud/services/ess/v20201111/ess_client.js +4 -2
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +10 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +32 -14
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +36 -14
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +171 -31
- package/tencentcloud/services/iss/v20230517/iss_models.d.ts +3 -3
- package/tencentcloud/services/live/v20180801/live_models.d.ts +4 -1
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +10 -5
- package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +5 -1
- package/tencentcloud/services/postgres/v20170312/postgres_client.js +6 -0
- package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +64 -0
- package/tencentcloud/services/scf/v20180416/scf_models.d.ts +1 -0
- package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +3 -1
- package/tencentcloud/services/ssl/v20191205/ssl_client.js +3 -1
- package/tencentcloud/services/tcm/v20210413/tcm_models.d.ts +5 -0
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +201 -93
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +1 -1
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +2 -2
- package/tencentcloud/services/waf/v20180125/waf_client.d.ts +5 -1
- package/tencentcloud/services/waf/v20180125/waf_client.js +6 -0
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +222 -166
- package/test/dlc.v20210125.test.js +228 -18
- package/test/essbasic.v20210526.test.js +24 -4
- package/test/postgres.v20170312.test.js +10 -0
- package/test/waf.v20180125.test.js +10 -0
|
@@ -414,72 +414,77 @@ export interface IndexMetaField {
|
|
|
414
414
|
* 索引类型
|
|
415
415
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
416
416
|
*/
|
|
417
|
-
IndexType
|
|
417
|
+
IndexType?: string;
|
|
418
418
|
/**
|
|
419
419
|
* 索引名
|
|
420
420
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
421
421
|
*/
|
|
422
|
-
IndexName
|
|
422
|
+
IndexName?: string;
|
|
423
|
+
/**
|
|
424
|
+
* 索引元数据JSON
|
|
425
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
426
|
+
*/
|
|
427
|
+
IndexMetaJson?: string;
|
|
423
428
|
/**
|
|
424
429
|
* 索引状态
|
|
425
430
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
426
431
|
*/
|
|
427
|
-
IndexStatus
|
|
432
|
+
IndexStatus?: string;
|
|
428
433
|
/**
|
|
429
434
|
* 索引存储大小,单位Byte
|
|
430
435
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
431
436
|
*/
|
|
432
|
-
IndexStorage
|
|
437
|
+
IndexStorage?: number;
|
|
433
438
|
/**
|
|
434
439
|
* 索引创建时间
|
|
435
440
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
436
441
|
*/
|
|
437
|
-
IndexCreateTime
|
|
442
|
+
IndexCreateTime?: string;
|
|
438
443
|
/**
|
|
439
444
|
* 后备索引
|
|
440
445
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
441
446
|
*/
|
|
442
|
-
BackingIndices
|
|
447
|
+
BackingIndices?: Array<BackingIndexMetaField>;
|
|
443
448
|
/**
|
|
444
449
|
* 索引所属集群ID
|
|
445
450
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
446
451
|
*/
|
|
447
|
-
ClusterId
|
|
452
|
+
ClusterId?: string;
|
|
448
453
|
/**
|
|
449
454
|
* 索引所属集群名
|
|
450
455
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
451
456
|
*/
|
|
452
|
-
ClusterName
|
|
457
|
+
ClusterName?: string;
|
|
453
458
|
/**
|
|
454
459
|
* 索引所属集群版本
|
|
455
460
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
456
461
|
*/
|
|
457
|
-
ClusterVersion
|
|
462
|
+
ClusterVersion?: string;
|
|
458
463
|
/**
|
|
459
464
|
* 索引生命周期字段
|
|
460
465
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
461
466
|
*/
|
|
462
|
-
IndexPolicyField
|
|
467
|
+
IndexPolicyField?: IndexPolicyField;
|
|
463
468
|
/**
|
|
464
469
|
* 索引自治字段
|
|
465
470
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
466
471
|
*/
|
|
467
|
-
IndexOptionsField
|
|
472
|
+
IndexOptionsField?: IndexOptionsField;
|
|
468
473
|
/**
|
|
469
474
|
* 索引配置字段
|
|
470
475
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
471
476
|
*/
|
|
472
|
-
IndexSettingsField
|
|
477
|
+
IndexSettingsField?: IndexSettingsField;
|
|
473
478
|
/**
|
|
474
479
|
* 索引所属集群APP ID
|
|
475
480
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
476
481
|
*/
|
|
477
|
-
AppId
|
|
482
|
+
AppId?: number;
|
|
478
483
|
/**
|
|
479
484
|
* 索引文档数
|
|
480
485
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
481
486
|
*/
|
|
482
|
-
IndexDocs
|
|
487
|
+
IndexDocs?: number;
|
|
483
488
|
}
|
|
484
489
|
/**
|
|
485
490
|
* DiagnoseInstance请求参数结构体
|
|
@@ -71,7 +71,8 @@ export declare class Client extends AbstractClient {
|
|
|
71
71
|
|
|
72
72
|
适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
|
|
73
73
|
|
|
74
|
-
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles
|
|
74
|
+
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
75
|
+
|
|
75
76
|
适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
76
77
|
|
|
77
78
|
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
@@ -369,7 +370,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
369
370
|
|
|
370
371
|
适用场景1:更新当前企业的自定义SaaS角色或集团角色,并且更新时不进行角色中权限的更新(PermissionGroups 参数不传)。
|
|
371
372
|
|
|
372
|
-
适用场景2:更新当前企业的自定义SaaS角色或集团角色,并且更新时进行角色中权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles
|
|
373
|
+
适用场景2:更新当前企业的自定义SaaS角色或集团角色,并且更新时进行角色中权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
374
|
+
|
|
373
375
|
适用场景3:更新集团角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
374
376
|
|
|
375
377
|
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
@@ -107,7 +107,8 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
107
107
|
|
|
108
108
|
适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
|
|
109
109
|
|
|
110
|
-
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles
|
|
110
|
+
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
111
|
+
|
|
111
112
|
适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
112
113
|
|
|
113
114
|
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
@@ -477,7 +478,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
477
478
|
|
|
478
479
|
适用场景1:更新当前企业的自定义SaaS角色或集团角色,并且更新时不进行角色中权限的更新(PermissionGroups 参数不传)。
|
|
479
480
|
|
|
480
|
-
适用场景2:更新当前企业的自定义SaaS角色或集团角色,并且更新时进行角色中权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles
|
|
481
|
+
适用场景2:更新当前企业的自定义SaaS角色或集团角色,并且更新时进行角色中权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
482
|
+
|
|
481
483
|
适用场景3:更新集团角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
482
484
|
|
|
483
485
|
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
@@ -1285,6 +1285,11 @@ export interface TemplateInfo {
|
|
|
1285
1285
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1286
1286
|
*/
|
|
1287
1287
|
Published?: boolean;
|
|
1288
|
+
/**
|
|
1289
|
+
* 分享来源的模板ID。用在集团账号子企业模板里
|
|
1290
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1291
|
+
*/
|
|
1292
|
+
ShareTemplateId?: string;
|
|
1288
1293
|
/**
|
|
1289
1294
|
* 模板内部指定的印章列表
|
|
1290
1295
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
@@ -1534,7 +1539,8 @@ export interface CreateSchemeUrlRequest {
|
|
|
1534
1539
|
|
|
1535
1540
|
<ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
|
|
1536
1541
|
<li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
|
|
1537
|
-
<li> **2** : 腾讯电子签小程序合同列表页</li
|
|
1542
|
+
<li> **2** : 腾讯电子签小程序合同列表页</li><li> **3** : 腾讯电子签小程序合同封面页
|
|
1543
|
+
注:`生成动态签署人补充链接时,必须指定为封面页`</li></ul>
|
|
1538
1544
|
*/
|
|
1539
1545
|
PathType?: number;
|
|
1540
1546
|
/**
|
|
@@ -1560,7 +1566,9 @@ export interface CreateSchemeUrlRequest {
|
|
|
1560
1566
|
*/
|
|
1561
1567
|
Hides?: Array<number | bigint>;
|
|
1562
1568
|
/**
|
|
1563
|
-
* 签署节点ID
|
|
1569
|
+
* 签署节点ID,用于生成动态签署人链接完成领取。
|
|
1570
|
+
|
|
1571
|
+
注:`生成动态签署人补充链接时必传。`
|
|
1564
1572
|
*/
|
|
1565
1573
|
RecipientId?: string;
|
|
1566
1574
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
|
|
3
|
+
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateFlowApproversRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
|
|
4
4
|
/**
|
|
5
5
|
* essbasic client
|
|
6
6
|
* @class
|
|
@@ -41,7 +41,7 @@ export declare class Client extends AbstractClient {
|
|
|
41
41
|
|
|
42
42
|
适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
|
|
43
43
|
|
|
44
|
-
适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles
|
|
44
|
+
适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
45
45
|
*/
|
|
46
46
|
ChannelModifyRole(req: ChannelModifyRoleRequest, cb?: (error: string, rep: ChannelModifyRoleResponse) => void): Promise<ChannelModifyRoleResponse>;
|
|
47
47
|
/**
|
|
@@ -106,11 +106,14 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
106
106
|
*/
|
|
107
107
|
ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
|
|
108
108
|
/**
|
|
109
|
-
*
|
|
110
|
-
|
|
111
|
-
|
|
109
|
+
* 通过此接口,创建小程序批量签署链接,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
|
|
110
|
+
|
|
111
|
+
注:
|
|
112
|
+
- 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
|
|
113
|
+
- 仅支持传入待签署或者待领取的合同,待填写暂不支持。
|
|
114
|
+
- 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章,暂不支持签批控件
|
|
112
115
|
*/
|
|
113
|
-
|
|
116
|
+
ChannelCreateOrganizationBatchSignUrl(req: ChannelCreateOrganizationBatchSignUrlRequest, cb?: (error: string, rep: ChannelCreateOrganizationBatchSignUrlResponse) => void): Promise<ChannelCreateOrganizationBatchSignUrlResponse>;
|
|
114
117
|
/**
|
|
115
118
|
* 将指定印章授权给第三方平台子客企业下的某些员工
|
|
116
119
|
*/
|
|
@@ -120,9 +123,15 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
120
123
|
|
|
121
124
|
适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
|
|
122
125
|
|
|
123
|
-
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles
|
|
126
|
+
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
124
127
|
*/
|
|
125
128
|
ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise<ChannelCreateRoleResponse>;
|
|
129
|
+
/**
|
|
130
|
+
* 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
|
|
131
|
+
如若在模板中配置了动态表格, 上传的附件必须为A4大小
|
|
132
|
+
合同发起人必须在电子签已经进行实名。
|
|
133
|
+
*/
|
|
134
|
+
CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
|
|
126
135
|
/**
|
|
127
136
|
* 企业方可以通过此接口关闭个人的自动签功能
|
|
128
137
|
*/
|
|
@@ -169,9 +178,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
169
178
|
4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
|
|
170
179
|
跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
|
|
171
180
|
全屏方式:
|
|
172
|
-
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
|
181
|
+
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html )
|
|
173
182
|
半屏方式:
|
|
174
|
-
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
|
183
|
+
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html )
|
|
175
184
|
其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
|
176
185
|
使用CreateSignUrls,设置EndPoint为APP,得到path。
|
|
177
186
|
|
|
@@ -305,11 +314,20 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
305
314
|
*/
|
|
306
315
|
PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
|
|
307
316
|
/**
|
|
308
|
-
*
|
|
309
|
-
|
|
310
|
-
|
|
317
|
+
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
318
|
+
当前接口限制最多合同(流程)50个.
|
|
319
|
+
返回的链接只能使用一次
|
|
311
320
|
*/
|
|
312
|
-
|
|
321
|
+
GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
|
|
322
|
+
/**
|
|
323
|
+
* 适用场景:
|
|
324
|
+
当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口动态补充签署人。同一签署人只允许补充一人,最终实际签署人取决于谁先领取合同完成签署。
|
|
325
|
+
|
|
326
|
+
限制条件:
|
|
327
|
+
1. 本企业(发起方企业)企业签署人仅支持通过企业名称+姓名+手机号进行补充。
|
|
328
|
+
2. 个人签署人仅支持通过姓名+手机号进行补充。
|
|
329
|
+
*/
|
|
330
|
+
ChannelCreateFlowApprovers(req: ChannelCreateFlowApproversRequest, cb?: (error: string, rep: ChannelCreateFlowApproversResponse) => void): Promise<ChannelCreateFlowApproversResponse>;
|
|
313
331
|
/**
|
|
314
332
|
* 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
|
|
315
333
|
*/
|
|
@@ -357,7 +375,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
357
375
|
/**
|
|
358
376
|
* 此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。
|
|
359
377
|
*/
|
|
360
|
-
CreateChannelOrganizationInfoChangeUrl(req
|
|
378
|
+
CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
|
|
361
379
|
/**
|
|
362
380
|
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
363
381
|
若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
|
@@ -67,7 +67,7 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
67
67
|
|
|
68
68
|
适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
|
|
69
69
|
|
|
70
|
-
适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles
|
|
70
|
+
适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
71
71
|
*/
|
|
72
72
|
async ChannelModifyRole(req, cb) {
|
|
73
73
|
return this.request("ChannelModifyRole", req, cb);
|
|
@@ -150,12 +150,15 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
150
150
|
return this.request("ChannelCancelFlow", req, cb);
|
|
151
151
|
}
|
|
152
152
|
/**
|
|
153
|
-
*
|
|
154
|
-
|
|
155
|
-
|
|
153
|
+
* 通过此接口,创建小程序批量签署链接,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
|
|
154
|
+
|
|
155
|
+
注:
|
|
156
|
+
- 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
|
|
157
|
+
- 仅支持传入待签署或者待领取的合同,待填写暂不支持。
|
|
158
|
+
- 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章,暂不支持签批控件
|
|
156
159
|
*/
|
|
157
|
-
async
|
|
158
|
-
return this.request("
|
|
160
|
+
async ChannelCreateOrganizationBatchSignUrl(req, cb) {
|
|
161
|
+
return this.request("ChannelCreateOrganizationBatchSignUrl", req, cb);
|
|
159
162
|
}
|
|
160
163
|
/**
|
|
161
164
|
* 将指定印章授权给第三方平台子客企业下的某些员工
|
|
@@ -168,11 +171,19 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
168
171
|
|
|
169
172
|
适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
|
|
170
173
|
|
|
171
|
-
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles
|
|
174
|
+
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
172
175
|
*/
|
|
173
176
|
async ChannelCreateRole(req, cb) {
|
|
174
177
|
return this.request("ChannelCreateRole", req, cb);
|
|
175
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
|
|
181
|
+
如若在模板中配置了动态表格, 上传的附件必须为A4大小
|
|
182
|
+
合同发起人必须在电子签已经进行实名。
|
|
183
|
+
*/
|
|
184
|
+
async CreateFlowsByTemplates(req, cb) {
|
|
185
|
+
return this.request("CreateFlowsByTemplates", req, cb);
|
|
186
|
+
}
|
|
176
187
|
/**
|
|
177
188
|
* 企业方可以通过此接口关闭个人的自动签功能
|
|
178
189
|
*/
|
|
@@ -227,9 +238,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
227
238
|
4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
|
|
228
239
|
跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
|
|
229
240
|
全屏方式:
|
|
230
|
-
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
|
241
|
+
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html )
|
|
231
242
|
半屏方式:
|
|
232
|
-
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
|
243
|
+
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html )
|
|
233
244
|
其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
|
234
245
|
使用CreateSignUrls,设置EndPoint为APP,得到path。
|
|
235
246
|
|
|
@@ -401,12 +412,23 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
401
412
|
return this.request("PrepareFlows", req, cb);
|
|
402
413
|
}
|
|
403
414
|
/**
|
|
404
|
-
*
|
|
405
|
-
|
|
406
|
-
|
|
415
|
+
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
416
|
+
当前接口限制最多合同(流程)50个.
|
|
417
|
+
返回的链接只能使用一次
|
|
407
418
|
*/
|
|
408
|
-
async
|
|
409
|
-
return this.request("
|
|
419
|
+
async GetDownloadFlowUrl(req, cb) {
|
|
420
|
+
return this.request("GetDownloadFlowUrl", req, cb);
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* 适用场景:
|
|
424
|
+
当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口动态补充签署人。同一签署人只允许补充一人,最终实际签署人取决于谁先领取合同完成签署。
|
|
425
|
+
|
|
426
|
+
限制条件:
|
|
427
|
+
1. 本企业(发起方企业)企业签署人仅支持通过企业名称+姓名+手机号进行补充。
|
|
428
|
+
2. 个人签署人仅支持通过姓名+手机号进行补充。
|
|
429
|
+
*/
|
|
430
|
+
async ChannelCreateFlowApprovers(req, cb) {
|
|
431
|
+
return this.request("ChannelCreateFlowApprovers", req, cb);
|
|
410
432
|
}
|
|
411
433
|
/**
|
|
412
434
|
* 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
|