tencentcloud-sdk-nodejs-essbasic 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/services/essbasic/v20210526/essbasic_client.ts +58 -23
- package/src/services/essbasic/v20210526/essbasic_models.ts +176 -31
- 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
|
@@ -584,6 +584,14 @@ export interface DescribeResourceUrlsByFlowsRequest {
|
|
|
584
584
|
* CreateChannelOrganizationInfoChangeUrl返回参数结构体
|
|
585
585
|
*/
|
|
586
586
|
export interface CreateChannelOrganizationInfoChangeUrlResponse {
|
|
587
|
+
/**
|
|
588
|
+
* 创建的企业信息变更链接。
|
|
589
|
+
*/
|
|
590
|
+
Url?: string
|
|
591
|
+
/**
|
|
592
|
+
* 链接过期时间。链接7天有效。
|
|
593
|
+
*/
|
|
594
|
+
ExpiredTime?: number
|
|
587
595
|
/**
|
|
588
596
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
589
597
|
*/
|
|
@@ -1355,29 +1363,30 @@ MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverM
|
|
|
1355
1363
|
}
|
|
1356
1364
|
|
|
1357
1365
|
/**
|
|
1358
|
-
*
|
|
1366
|
+
* 应用相关信息
|
|
1359
1367
|
*/
|
|
1360
|
-
export interface
|
|
1368
|
+
export interface Agent {
|
|
1361
1369
|
/**
|
|
1362
|
-
*
|
|
1363
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1370
|
+
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
1364
1371
|
*/
|
|
1365
|
-
|
|
1372
|
+
AppId: string
|
|
1366
1373
|
/**
|
|
1367
|
-
*
|
|
1368
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1374
|
+
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
1369
1375
|
*/
|
|
1370
|
-
|
|
1376
|
+
ProxyOrganizationOpenId?: string
|
|
1371
1377
|
/**
|
|
1372
|
-
*
|
|
1373
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1378
|
+
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
1374
1379
|
*/
|
|
1375
|
-
|
|
1380
|
+
ProxyOperator?: UserInfo
|
|
1376
1381
|
/**
|
|
1377
|
-
*
|
|
1378
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1382
|
+
* 非必需参数,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
1379
1383
|
*/
|
|
1380
|
-
|
|
1384
|
+
ProxyAppId?: string
|
|
1385
|
+
/**
|
|
1386
|
+
* 内部参数,暂未开放使用
|
|
1387
|
+
* @deprecated
|
|
1388
|
+
*/
|
|
1389
|
+
ProxyOrganizationId?: string
|
|
1381
1390
|
}
|
|
1382
1391
|
|
|
1383
1392
|
/**
|
|
@@ -1752,6 +1761,35 @@ export interface TemplateInfo {
|
|
|
1752
1761
|
Available?: number
|
|
1753
1762
|
}
|
|
1754
1763
|
|
|
1764
|
+
/**
|
|
1765
|
+
* ChannelCreateOrganizationBatchSignUrl请求参数结构体
|
|
1766
|
+
*/
|
|
1767
|
+
export interface ChannelCreateOrganizationBatchSignUrlRequest {
|
|
1768
|
+
/**
|
|
1769
|
+
* 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1770
|
+
*/
|
|
1771
|
+
Agent: Agent
|
|
1772
|
+
/**
|
|
1773
|
+
* 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。
|
|
1774
|
+
*/
|
|
1775
|
+
FlowIds?: Array<string>
|
|
1776
|
+
/**
|
|
1777
|
+
* 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
|
|
1778
|
+
*/
|
|
1779
|
+
OpenId?: string
|
|
1780
|
+
/**
|
|
1781
|
+
* 签署方经办人的姓名。
|
|
1782
|
+
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
1783
|
+
|
|
1784
|
+
注:`请确保和合同中填入的一致`
|
|
1785
|
+
*/
|
|
1786
|
+
Name?: string
|
|
1787
|
+
/**
|
|
1788
|
+
* 员工手机号,必须与姓名一起使用。 如果OpenId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
|
|
1789
|
+
*/
|
|
1790
|
+
Mobile?: string
|
|
1791
|
+
}
|
|
1792
|
+
|
|
1755
1793
|
/**
|
|
1756
1794
|
* GetDownloadFlowUrl返回参数结构体
|
|
1757
1795
|
*/
|
|
@@ -1767,30 +1805,29 @@ export interface GetDownloadFlowUrlResponse {
|
|
|
1767
1805
|
}
|
|
1768
1806
|
|
|
1769
1807
|
/**
|
|
1770
|
-
*
|
|
1808
|
+
* 渠道角色信息
|
|
1771
1809
|
*/
|
|
1772
|
-
export interface
|
|
1773
|
-
/**
|
|
1774
|
-
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
1775
|
-
*/
|
|
1776
|
-
AppId: string
|
|
1810
|
+
export interface ChannelRole {
|
|
1777
1811
|
/**
|
|
1778
|
-
*
|
|
1812
|
+
* 角色id
|
|
1813
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1779
1814
|
*/
|
|
1780
|
-
|
|
1815
|
+
RoleId?: string
|
|
1781
1816
|
/**
|
|
1782
|
-
*
|
|
1817
|
+
* 角色名
|
|
1818
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1783
1819
|
*/
|
|
1784
|
-
|
|
1820
|
+
RoleName?: string
|
|
1785
1821
|
/**
|
|
1786
|
-
*
|
|
1822
|
+
* 角色状态:1-启用;2-禁用
|
|
1823
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1787
1824
|
*/
|
|
1788
|
-
|
|
1825
|
+
RoleStatus?: number
|
|
1789
1826
|
/**
|
|
1790
|
-
*
|
|
1791
|
-
|
|
1827
|
+
* 权限树
|
|
1828
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1792
1829
|
*/
|
|
1793
|
-
|
|
1830
|
+
PermissionGroups?: Array<PermissionGroup>
|
|
1794
1831
|
}
|
|
1795
1832
|
|
|
1796
1833
|
/**
|
|
@@ -2414,6 +2451,42 @@ export interface CommonFlowApprover {
|
|
|
2414
2451
|
ApproverSignTypes?: Array<number | bigint>
|
|
2415
2452
|
}
|
|
2416
2453
|
|
|
2454
|
+
/**
|
|
2455
|
+
* 指定补充签署人信息
|
|
2456
|
+
- RecipientId 必须指定
|
|
2457
|
+
*/
|
|
2458
|
+
export interface FillApproverInfo {
|
|
2459
|
+
/**
|
|
2460
|
+
* 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
|
|
2461
|
+
|
|
2462
|
+
*/
|
|
2463
|
+
RecipientId: string
|
|
2464
|
+
/**
|
|
2465
|
+
* 指定企业经办签署人OpenId
|
|
2466
|
+
*/
|
|
2467
|
+
OpenId?: string
|
|
2468
|
+
/**
|
|
2469
|
+
* 签署人姓名
|
|
2470
|
+
*/
|
|
2471
|
+
ApproverName?: string
|
|
2472
|
+
/**
|
|
2473
|
+
* 签署人手机号码
|
|
2474
|
+
*/
|
|
2475
|
+
ApproverMobile?: string
|
|
2476
|
+
/**
|
|
2477
|
+
* 企业名称
|
|
2478
|
+
*/
|
|
2479
|
+
OrganizationName?: string
|
|
2480
|
+
/**
|
|
2481
|
+
* 企业OpenId
|
|
2482
|
+
*/
|
|
2483
|
+
OrganizationOpenId?: string
|
|
2484
|
+
/**
|
|
2485
|
+
* 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,organization_open_id+open_id 必传
|
|
2486
|
+
*/
|
|
2487
|
+
NotChannelOrganization?: string
|
|
2488
|
+
}
|
|
2489
|
+
|
|
2417
2490
|
/**
|
|
2418
2491
|
* 合同文件验签单个结果结构体
|
|
2419
2492
|
*/
|
|
@@ -2933,6 +3006,39 @@ export interface ChannelCreateBoundFlowsResponse {
|
|
|
2933
3006
|
RequestId?: string
|
|
2934
3007
|
}
|
|
2935
3008
|
|
|
3009
|
+
/**
|
|
3010
|
+
* ChannelCreateFlowApprovers请求参数结构体
|
|
3011
|
+
*/
|
|
3012
|
+
export interface ChannelCreateFlowApproversRequest {
|
|
3013
|
+
/**
|
|
3014
|
+
* 渠道应用相关信息
|
|
3015
|
+
*/
|
|
3016
|
+
Agent: Agent
|
|
3017
|
+
/**
|
|
3018
|
+
* 合同唯一编号
|
|
3019
|
+
*/
|
|
3020
|
+
FlowId: string
|
|
3021
|
+
/**
|
|
3022
|
+
* 补充企业签署人信息。
|
|
3023
|
+
|
|
3024
|
+
- 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
|
|
3025
|
+
|
|
3026
|
+
- 如果不指定,则使用姓名和手机号进行补充。
|
|
3027
|
+
*/
|
|
3028
|
+
Approvers: Array<FillApproverInfo>
|
|
3029
|
+
/**
|
|
3030
|
+
* 操作人信息
|
|
3031
|
+
*/
|
|
3032
|
+
Operator?: UserInfo
|
|
3033
|
+
/**
|
|
3034
|
+
* 签署人信息补充方式
|
|
3035
|
+
|
|
3036
|
+
<ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
|
|
3037
|
+
<li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
|
|
3038
|
+
*/
|
|
3039
|
+
FillApproverType?: number
|
|
3040
|
+
}
|
|
3041
|
+
|
|
2936
3042
|
/**
|
|
2937
3043
|
* 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
|
|
2938
3044
|
*/
|
|
@@ -3072,6 +3178,16 @@ export interface SyncProxyOrganizationOperatorsRequest {
|
|
|
3072
3178
|
Operator?: UserInfo
|
|
3073
3179
|
}
|
|
3074
3180
|
|
|
3181
|
+
/**
|
|
3182
|
+
* ChannelCreateFlowApprovers返回参数结构体
|
|
3183
|
+
*/
|
|
3184
|
+
export interface ChannelCreateFlowApproversResponse {
|
|
3185
|
+
/**
|
|
3186
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3187
|
+
*/
|
|
3188
|
+
RequestId?: string
|
|
3189
|
+
}
|
|
3190
|
+
|
|
3075
3191
|
/**
|
|
3076
3192
|
* CreateSignUrls请求参数结构体
|
|
3077
3193
|
*/
|
|
@@ -3105,6 +3221,7 @@ export interface CreateSignUrlsRequest {
|
|
|
3105
3221
|
- NOT_CHANNEL:非第三方平台子客企业企业
|
|
3106
3222
|
- PERSON:个人
|
|
3107
3223
|
- FOLLOWER:关注方,目前是合同抄送方
|
|
3224
|
+
- RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
|
|
3108
3225
|
*/
|
|
3109
3226
|
GenerateType?: string
|
|
3110
3227
|
/**
|
|
@@ -3152,7 +3269,7 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
|
|
|
3152
3269
|
*/
|
|
3153
3270
|
Hides?: Array<number | bigint>
|
|
3154
3271
|
/**
|
|
3155
|
-
* 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids
|
|
3272
|
+
* 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
|
|
3156
3273
|
*/
|
|
3157
3274
|
RecipientIds?: Array<string>
|
|
3158
3275
|
}
|
|
@@ -4511,7 +4628,17 @@ export interface ChannelBatchCancelFlowsRequest {
|
|
|
4511
4628
|
/**
|
|
4512
4629
|
* CreateChannelOrganizationInfoChangeUrl请求参数结构体
|
|
4513
4630
|
*/
|
|
4514
|
-
export
|
|
4631
|
+
export interface CreateChannelOrganizationInfoChangeUrlRequest {
|
|
4632
|
+
/**
|
|
4633
|
+
* 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4634
|
+
*/
|
|
4635
|
+
Agent: Agent
|
|
4636
|
+
/**
|
|
4637
|
+
* 企业信息变更类型,可选类型如下:
|
|
4638
|
+
<ul><li>**1**:企业超管变更</li><li>**2**:企业基础信息变更</li></ul>
|
|
4639
|
+
*/
|
|
4640
|
+
ChangeType: number
|
|
4641
|
+
}
|
|
4515
4642
|
|
|
4516
4643
|
/**
|
|
4517
4644
|
* ChannelModifyRole请求参数结构体
|
|
@@ -4873,6 +5000,24 @@ export interface DescribeUsageResponse {
|
|
|
4873
5000
|
RequestId?: string
|
|
4874
5001
|
}
|
|
4875
5002
|
|
|
5003
|
+
/**
|
|
5004
|
+
* ChannelCreateOrganizationBatchSignUrl返回参数结构体
|
|
5005
|
+
*/
|
|
5006
|
+
export interface ChannelCreateOrganizationBatchSignUrlResponse {
|
|
5007
|
+
/**
|
|
5008
|
+
* 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
|
|
5009
|
+
*/
|
|
5010
|
+
SignUrl?: string
|
|
5011
|
+
/**
|
|
5012
|
+
* 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
|
|
5013
|
+
*/
|
|
5014
|
+
ExpiredTime?: number
|
|
5015
|
+
/**
|
|
5016
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5017
|
+
*/
|
|
5018
|
+
RequestId?: string
|
|
5019
|
+
}
|
|
5020
|
+
|
|
4876
5021
|
/**
|
|
4877
5022
|
* 用量明细
|
|
4878
5023
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
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";
|
|
2
|
+
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";
|
|
3
3
|
/**
|
|
4
4
|
* essbasic client
|
|
5
5
|
* @class
|
|
@@ -40,7 +40,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
40
40
|
|
|
41
41
|
适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
|
|
42
42
|
|
|
43
|
-
适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles
|
|
43
|
+
适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
44
44
|
*/
|
|
45
45
|
ChannelModifyRole(req: ChannelModifyRoleRequest, cb?: (error: string, rep: ChannelModifyRoleResponse) => void): Promise<ChannelModifyRoleResponse>;
|
|
46
46
|
/**
|
|
@@ -105,11 +105,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
105
105
|
*/
|
|
106
106
|
ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
109
|
-
|
|
110
|
-
|
|
108
|
+
* 通过此接口,创建小程序批量签署链接,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
|
|
109
|
+
|
|
110
|
+
注:
|
|
111
|
+
- 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
|
|
112
|
+
- 仅支持传入待签署或者待领取的合同,待填写暂不支持。
|
|
113
|
+
- 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章,暂不支持签批控件
|
|
111
114
|
*/
|
|
112
|
-
|
|
115
|
+
ChannelCreateOrganizationBatchSignUrl(req: ChannelCreateOrganizationBatchSignUrlRequest, cb?: (error: string, rep: ChannelCreateOrganizationBatchSignUrlResponse) => void): Promise<ChannelCreateOrganizationBatchSignUrlResponse>;
|
|
113
116
|
/**
|
|
114
117
|
* 将指定印章授权给第三方平台子客企业下的某些员工
|
|
115
118
|
*/
|
|
@@ -119,9 +122,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
119
122
|
|
|
120
123
|
适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
|
|
121
124
|
|
|
122
|
-
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles
|
|
125
|
+
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
123
126
|
*/
|
|
124
127
|
ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise<ChannelCreateRoleResponse>;
|
|
128
|
+
/**
|
|
129
|
+
* 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
|
|
130
|
+
如若在模板中配置了动态表格, 上传的附件必须为A4大小
|
|
131
|
+
合同发起人必须在电子签已经进行实名。
|
|
132
|
+
*/
|
|
133
|
+
CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
|
|
125
134
|
/**
|
|
126
135
|
* 企业方可以通过此接口关闭个人的自动签功能
|
|
127
136
|
*/
|
|
@@ -168,9 +177,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
168
177
|
4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
|
|
169
178
|
跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
|
|
170
179
|
全屏方式:
|
|
171
|
-
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
|
180
|
+
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html )
|
|
172
181
|
半屏方式:
|
|
173
|
-
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
|
182
|
+
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html )
|
|
174
183
|
其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
|
175
184
|
使用CreateSignUrls,设置EndPoint为APP,得到path。
|
|
176
185
|
|
|
@@ -304,11 +313,20 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
304
313
|
*/
|
|
305
314
|
PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
|
|
306
315
|
/**
|
|
307
|
-
*
|
|
308
|
-
|
|
309
|
-
|
|
316
|
+
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
317
|
+
当前接口限制最多合同(流程)50个.
|
|
318
|
+
返回的链接只能使用一次
|
|
310
319
|
*/
|
|
311
|
-
|
|
320
|
+
GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
|
|
321
|
+
/**
|
|
322
|
+
* 适用场景:
|
|
323
|
+
当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口动态补充签署人。同一签署人只允许补充一人,最终实际签署人取决于谁先领取合同完成签署。
|
|
324
|
+
|
|
325
|
+
限制条件:
|
|
326
|
+
1. 本企业(发起方企业)企业签署人仅支持通过企业名称+姓名+手机号进行补充。
|
|
327
|
+
2. 个人签署人仅支持通过姓名+手机号进行补充。
|
|
328
|
+
*/
|
|
329
|
+
ChannelCreateFlowApprovers(req: ChannelCreateFlowApproversRequest, cb?: (error: string, rep: ChannelCreateFlowApproversResponse) => void): Promise<ChannelCreateFlowApproversResponse>;
|
|
312
330
|
/**
|
|
313
331
|
* 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
|
|
314
332
|
*/
|
|
@@ -356,7 +374,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
356
374
|
/**
|
|
357
375
|
* 此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。
|
|
358
376
|
*/
|
|
359
|
-
CreateChannelOrganizationInfoChangeUrl(req
|
|
377
|
+
CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
|
|
360
378
|
/**
|
|
361
379
|
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
362
380
|
若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
|
@@ -67,7 +67,7 @@ class Client extends TencentCloudCommon.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 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
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 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
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 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
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 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
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
|
* 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
|