tencentcloud-sdk-nodejs-essbasic 4.0.700 → 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.
@@ -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
@@ -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
- * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
109
- 当前接口限制最多合同(流程)50个.
110
- 返回的链接只能使用一次
108
+ * 通过此接口,创建小程序批量签署链接,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
109
+
110
+ 注:
111
+ - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
112
+ - 仅支持传入待签署或者待领取的合同,待填写暂不支持。
113
+ - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章,暂不支持签批控件
111
114
  */
112
- GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
115
+ ChannelCreateOrganizationBatchSignUrl(req: ChannelCreateOrganizationBatchSignUrlRequest, cb?: (error: string, rep: ChannelCreateOrganizationBatchSignUrlResponse) => void): Promise<ChannelCreateOrganizationBatchSignUrlResponse>;
113
116
  /**
114
117
  * 将指定印章授权给第三方平台子客企业下的某些员工
115
118
  */
@@ -122,6 +125,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
122
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
  */
@@ -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
- * 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
308
- 如若在模板中配置了动态表格, 上传的附件必须为A4大小
309
- 合同发起人必须在电子签已经进行实名。
316
+ * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
317
+ 当前接口限制最多合同(流程)50个.
318
+ 返回的链接只能使用一次
310
319
  */
311
- CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
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
  */
@@ -150,12 +150,15 @@ class Client extends TencentCloudCommon.AbstractClient {
150
150
  return this.request("ChannelCancelFlow", req, cb);
151
151
  }
152
152
  /**
153
- * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
154
- 当前接口限制最多合同(流程)50个.
155
- 返回的链接只能使用一次
153
+ * 通过此接口,创建小程序批量签署链接,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
154
+
155
+ 注:
156
+ - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
157
+ - 仅支持传入待签署或者待领取的合同,待填写暂不支持。
158
+ - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章,暂不支持签批控件
156
159
  */
157
- async GetDownloadFlowUrl(req, cb) {
158
- return this.request("GetDownloadFlowUrl", req, cb);
160
+ async ChannelCreateOrganizationBatchSignUrl(req, cb) {
161
+ return this.request("ChannelCreateOrganizationBatchSignUrl", req, cb);
159
162
  }
160
163
  /**
161
164
  * 将指定印章授权给第三方平台子客企业下的某些员工
@@ -173,6 +176,14 @@ class Client extends TencentCloudCommon.AbstractClient {
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
  */
@@ -401,12 +412,23 @@ class Client extends TencentCloudCommon.AbstractClient {
401
412
  return this.request("PrepareFlows", req, cb);
402
413
  }
403
414
  /**
404
- * 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
405
- 如若在模板中配置了动态表格, 上传的附件必须为A4大小
406
- 合同发起人必须在电子签已经进行实名。
415
+ * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
416
+ 当前接口限制最多合同(流程)50个.
417
+ 返回的链接只能使用一次
407
418
  */
408
- async CreateFlowsByTemplates(req, cb) {
409
- return this.request("CreateFlowsByTemplates", req, cb);
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
  * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
@@ -1305,29 +1305,30 @@ export interface ChannelCreateFlowByFilesRequest {
1305
1305
  Operator?: UserInfo;
1306
1306
  }
1307
1307
  /**
1308
- * 渠道角色信息
1308
+ * 应用相关信息
1309
1309
  */
1310
- export interface ChannelRole {
1310
+ export interface Agent {
1311
1311
  /**
1312
- * 角色id
1313
- 注意:此字段可能返回 null,表示取不到有效值。
1312
+ * 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
1314
1313
  */
1315
- RoleId?: string;
1314
+ AppId: string;
1316
1315
  /**
1317
- * 角色名
1318
- 注意:此字段可能返回 null,表示取不到有效值。
1316
+ * 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
1319
1317
  */
1320
- RoleName?: string;
1318
+ ProxyOrganizationOpenId?: string;
1321
1319
  /**
1322
- * 角色状态:1-启用;2-禁用
1323
- 注意:此字段可能返回 null,表示取不到有效值。
1320
+ * 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
1324
1321
  */
1325
- RoleStatus?: number;
1322
+ ProxyOperator?: UserInfo;
1326
1323
  /**
1327
- * 权限树
1328
- 注意:此字段可能返回 null,表示取不到有效值。
1324
+ * 非必需参数,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
1329
1325
  */
1330
- PermissionGroups?: Array<PermissionGroup>;
1326
+ ProxyAppId?: string;
1327
+ /**
1328
+ * 内部参数,暂未开放使用
1329
+ * @deprecated
1330
+ */
1331
+ ProxyOrganizationId?: string;
1331
1332
  }
1332
1333
  /**
1333
1334
  * ChannelCreatePreparedPersonalEsign返回参数结构体
@@ -1690,6 +1691,34 @@ export interface TemplateInfo {
1690
1691
  */
1691
1692
  Available?: number;
1692
1693
  }
1694
+ /**
1695
+ * ChannelCreateOrganizationBatchSignUrl请求参数结构体
1696
+ */
1697
+ export interface ChannelCreateOrganizationBatchSignUrlRequest {
1698
+ /**
1699
+ * 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1700
+ */
1701
+ Agent: Agent;
1702
+ /**
1703
+ * 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。
1704
+ */
1705
+ FlowIds?: Array<string>;
1706
+ /**
1707
+ * 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
1708
+ */
1709
+ OpenId?: string;
1710
+ /**
1711
+ * 签署方经办人的姓名。
1712
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1713
+
1714
+ 注:`请确保和合同中填入的一致`
1715
+ */
1716
+ Name?: string;
1717
+ /**
1718
+ * 员工手机号,必须与姓名一起使用。 如果OpenId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
1719
+ */
1720
+ Mobile?: string;
1721
+ }
1693
1722
  /**
1694
1723
  * GetDownloadFlowUrl返回参数结构体
1695
1724
  */
@@ -1704,30 +1733,29 @@ export interface GetDownloadFlowUrlResponse {
1704
1733
  RequestId?: string;
1705
1734
  }
1706
1735
  /**
1707
- * 应用相关信息
1736
+ * 渠道角色信息
1708
1737
  */
1709
- export interface Agent {
1710
- /**
1711
- * 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
1712
- */
1713
- AppId: string;
1738
+ export interface ChannelRole {
1714
1739
  /**
1715
- * 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
1740
+ * 角色id
1741
+ 注意:此字段可能返回 null,表示取不到有效值。
1716
1742
  */
1717
- ProxyOrganizationOpenId?: string;
1743
+ RoleId?: string;
1718
1744
  /**
1719
- * 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
1745
+ * 角色名
1746
+ 注意:此字段可能返回 null,表示取不到有效值。
1720
1747
  */
1721
- ProxyOperator?: UserInfo;
1748
+ RoleName?: string;
1722
1749
  /**
1723
- * 非必需参数,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
1750
+ * 角色状态:1-启用;2-禁用
1751
+ 注意:此字段可能返回 null,表示取不到有效值。
1724
1752
  */
1725
- ProxyAppId?: string;
1753
+ RoleStatus?: number;
1726
1754
  /**
1727
- * 内部参数,暂未开放使用
1728
- * @deprecated
1755
+ * 权限树
1756
+ 注意:此字段可能返回 null,表示取不到有效值。
1729
1757
  */
1730
- ProxyOrganizationId?: string;
1758
+ PermissionGroups?: Array<PermissionGroup>;
1731
1759
  }
1732
1760
  /**
1733
1761
  * 流程中参与方的信息结构
@@ -2335,6 +2363,41 @@ export interface CommonFlowApprover {
2335
2363
  */
2336
2364
  ApproverSignTypes?: Array<number | bigint>;
2337
2365
  }
2366
+ /**
2367
+ * 指定补充签署人信息
2368
+ - RecipientId 必须指定
2369
+ */
2370
+ export interface FillApproverInfo {
2371
+ /**
2372
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
2373
+
2374
+ */
2375
+ RecipientId: string;
2376
+ /**
2377
+ * 指定企业经办签署人OpenId
2378
+ */
2379
+ OpenId?: string;
2380
+ /**
2381
+ * 签署人姓名
2382
+ */
2383
+ ApproverName?: string;
2384
+ /**
2385
+ * 签署人手机号码
2386
+ */
2387
+ ApproverMobile?: string;
2388
+ /**
2389
+ * 企业名称
2390
+ */
2391
+ OrganizationName?: string;
2392
+ /**
2393
+ * 企业OpenId
2394
+ */
2395
+ OrganizationOpenId?: string;
2396
+ /**
2397
+ * 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,organization_open_id+open_id 必传
2398
+ */
2399
+ NotChannelOrganization?: string;
2400
+ }
2338
2401
  /**
2339
2402
  * 合同文件验签单个结果结构体
2340
2403
  */
@@ -2841,6 +2904,38 @@ export interface ChannelCreateBoundFlowsResponse {
2841
2904
  */
2842
2905
  RequestId?: string;
2843
2906
  }
2907
+ /**
2908
+ * ChannelCreateFlowApprovers请求参数结构体
2909
+ */
2910
+ export interface ChannelCreateFlowApproversRequest {
2911
+ /**
2912
+ * 渠道应用相关信息
2913
+ */
2914
+ Agent: Agent;
2915
+ /**
2916
+ * 合同唯一编号
2917
+ */
2918
+ FlowId: string;
2919
+ /**
2920
+ * 补充企业签署人信息。
2921
+
2922
+ - 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
2923
+
2924
+ - 如果不指定,则使用姓名和手机号进行补充。
2925
+ */
2926
+ Approvers: Array<FillApproverInfo>;
2927
+ /**
2928
+ * 操作人信息
2929
+ */
2930
+ Operator?: UserInfo;
2931
+ /**
2932
+ * 签署人信息补充方式
2933
+
2934
+ <ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
2935
+ <li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
2936
+ */
2937
+ FillApproverType?: number;
2938
+ }
2844
2939
  /**
2845
2940
  * 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
2846
2941
  */
@@ -2973,6 +3068,15 @@ export interface SyncProxyOrganizationOperatorsRequest {
2973
3068
  */
2974
3069
  Operator?: UserInfo;
2975
3070
  }
3071
+ /**
3072
+ * ChannelCreateFlowApprovers返回参数结构体
3073
+ */
3074
+ export interface ChannelCreateFlowApproversResponse {
3075
+ /**
3076
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3077
+ */
3078
+ RequestId?: string;
3079
+ }
2976
3080
  /**
2977
3081
  * CreateSignUrls请求参数结构体
2978
3082
  */
@@ -3006,6 +3110,7 @@ export interface CreateSignUrlsRequest {
3006
3110
  - NOT_CHANNEL:非第三方平台子客企业企业
3007
3111
  - PERSON:个人
3008
3112
  - FOLLOWER:关注方,目前是合同抄送方
3113
+ - RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
3009
3114
  */
3010
3115
  GenerateType?: string;
3011
3116
  /**
@@ -3053,7 +3158,7 @@ export interface CreateSignUrlsRequest {
3053
3158
  */
3054
3159
  Hides?: Array<number | bigint>;
3055
3160
  /**
3056
- * 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致
3161
+ * 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
3057
3162
  */
3058
3163
  RecipientIds?: Array<string>;
3059
3164
  }
@@ -4720,6 +4825,23 @@ export interface DescribeUsageResponse {
4720
4825
  */
4721
4826
  RequestId?: string;
4722
4827
  }
4828
+ /**
4829
+ * ChannelCreateOrganizationBatchSignUrl返回参数结构体
4830
+ */
4831
+ export interface ChannelCreateOrganizationBatchSignUrlResponse {
4832
+ /**
4833
+ * 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
4834
+ */
4835
+ SignUrl?: string;
4836
+ /**
4837
+ * 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
4838
+ */
4839
+ ExpiredTime?: number;
4840
+ /**
4841
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4842
+ */
4843
+ RequestId?: string;
4844
+ }
4723
4845
  /**
4724
4846
  * 用量明细
4725
4847
  */