tencentcloud-sdk-nodejs-essbasic 4.0.453 → 4.0.455

package/src/services/essbasic/v20210526/essbasic_client.ts

@@ -23,15 +23,17 @@ import {
   ChannelCreateConvertTaskApiResponse,
   OperateChannelTemplateRequest,
   TemplateInfo,
-  UploadFilesRequest,
+  ChannelDescribeEmployeesRequest,
   SyncProxyOrganizationResponse,
   ChannelBatchCancelFlowsResponse,
   GetDownloadFlowUrlResponse,
+  DescribeTemplatesResponse,
   DescribeResourceUrlsByFlowsResponse,
   ChannelCreateMultiFlowSignQRCodeResponse,
   Recipient,
-  DescribeTemplatesResponse,
+  Department,
   OperateChannelTemplateResponse,
+  StaffRole,
   CreateSignUrlsResponse,
   CreateSignUrlsRequest,
   ChannelCreateMultiFlowSignQRCodeRequest,
@@ -48,6 +50,7 @@ import {
   GetDownloadFlowUrlRequest,
   ChannelBatchCancelFlowsRequest,
   FlowDetailInfo,
+  SyncFailReason,
   CreateConsoleLoginUrlRequest,
   OrganizationInfo,
   CreateFlowsByTemplatesResponse,
@@ -62,6 +65,7 @@ import {
   SyncProxyOrganizationOperatorsRequest,
   CreateConsoleLoginUrlResponse,
   CreateFlowsByTemplatesRequest,
+  Filter,
   SyncProxyOrganizationRequest,
   CreateSealByImageRequest,
   SignQrCode,
@@ -74,8 +78,9 @@ import {
   DownloadFlowInfo,
   ChannelCancelMultiFlowSignQRCodeRequest,
   CreateChannelFlowEvidenceReportResponse,
-  SyncFailReason,
   PrepareFlowsResponse,
+  ChannelDescribeEmployeesResponse,
+  TaskInfo,
   DescribeUsageRequest,
   ChannelCreateBatchCancelFlowUrlRequest,
   ApproverRestriction,
@@ -90,7 +95,8 @@ import {
   FlowApproverDetail,
   FlowInfo,
   ChannelCreateFlowGroupByFilesRequest,
-  TaskInfo,
+  UploadFilesRequest,
+  Staff,
   CcInfo,
   ChannelCancelMultiFlowSignQRCodeResponse,
   DescribeFlowDetailInfoResponse,
@@ -240,8 +246,8 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-     * 【描述】：创建出证报告，返回报告 URL
-【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
+     * 创建出证报告，返回报告 URL。此接口暂未开放，有问题请联系运营人员。
+
      */
   async CreateChannelFlowEvidenceReport(
     req: CreateChannelFlowEvidenceReportRequest,
@@ -283,6 +289,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("SyncProxyOrganizationOperators", req, cb)
   }
 
+  /**
+   * 查询企业员工
+   */
+  async ChannelDescribeEmployees(
+    req: ChannelDescribeEmployeesRequest,
+    cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void
+  ): Promise<ChannelDescribeEmployeesResponse> {
+    return this.request("ChannelDescribeEmployees", req, cb)
+  }
+
   /**
      * 指定需要批量撤销的签署流程Id，批量撤销合同
 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口失败后返回错误信息

package/src/services/essbasic/v20210526/essbasic_models.ts

@@ -312,30 +312,33 @@ export interface TemplateInfo {
 }
 
 /**
- * UploadFiles请求参数结构体
+ * ChannelDescribeEmployees请求参数结构体
  */
-export interface UploadFilesRequest {
+export interface ChannelDescribeEmployeesRequest {
   /**
-   * 应用相关信息，若是渠道版调用 appid 和proxyappid 必填
+   * 返回最大数量，最大为20
    */
-  Agent: Agent
-
-  /**
-      * 文件对应业务类型，用于区分文件存储路径：
-1. TEMPLATE - 模板； 文件类型：.pdf .doc .docx .html
-2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
-      */
-  BusinessType: string
+  Limit: number
 
   /**
-   * 上传文件内容数组，最多支持20个文件
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
    */
-  FileInfos?: Array<UploadFile>
+  Agent?: Agent
 
   /**
    * 操作者的信息
    */
   Operator?: UserInfo
+
+  /**
+   * 查询过滤实名用户，key为Status，Values为["IsVerified"]
+   */
+  Filters?: Array<Filter>
+
+  /**
+   * 偏移量，默认为0，最大为20000
+   */
+  Offset?: number
 }
 
 /**
@@ -378,6 +381,36 @@ export interface GetDownloadFlowUrlResponse {
   RequestId?: string
 }
 
+/**
+ * DescribeTemplates返回参数结构体
+ */
+export interface DescribeTemplatesResponse {
+  /**
+   * 模板详情
+   */
+  Templates: Array<TemplateInfo>
+
+  /**
+   * 查询总数
+   */
+  TotalCount: number
+
+  /**
+   * 查询数量
+   */
+  Limit: number
+
+  /**
+   * 查询起始偏移
+   */
+  Offset: number
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeResourceUrlsByFlows返回参数结构体
  */
@@ -470,33 +503,20 @@ export interface Recipient {
 }
 
 /**
- * DescribeTemplates返回参数结构体
+ * 渠道版员工部门信息
  */
-export interface DescribeTemplatesResponse {
+export interface Department {
   /**
-   * 模板详情
-   */
-  Templates: Array<TemplateInfo>
-
-  /**
-   * 查询总数
-   */
-  TotalCount: number
-
-  /**
-   * 查询数量
-   */
-  Limit: number
-
-  /**
-   * 查询起始偏移
-   */
-  Offset: number
+      * 部门id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  DepartmentId: string
 
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
+      * 部门名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  DepartmentName: string
 }
 
 /**
@@ -545,6 +565,23 @@ export interface OperateChannelTemplateResponse {
   RequestId?: string
 }
 
+/**
+ * 渠道版员工角色信息
+ */
+export interface StaffRole {
+  /**
+      * 角色id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  RoleId: string
+
+  /**
+      * 角色名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  RoleName: string
+}
+
 /**
  * CreateSignUrls返回参数结构体
  */
@@ -1208,6 +1245,23 @@ export interface FlowDetailInfo {
   FlowApproverInfos: Array<FlowApproverDetail>
 }
 
+/**
+ * 同步经办人失败原因
+ */
+export interface SyncFailReason {
+  /**
+   * 经办人Id
+   */
+  Id: string
+
+  /**
+      * 失败原因
+例如：Id不符合规范、证件号码不合法等
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Message: string
+}
+
 /**
  * CreateConsoleLoginUrl请求参数结构体
  */
@@ -1621,6 +1675,21 @@ export interface CreateFlowsByTemplatesRequest {
   Operator?: UserInfo
 }
 
+/**
+ * 此结构体 (Filter) 用于描述查询过滤条件。
+ */
+export interface Filter {
+  /**
+   * 查询过滤条件的Key
+   */
+  Key: string
+
+  /**
+   * 查询过滤条件的Value列表
+   */
+  Values: Array<string>
+}
+
 /**
  * SyncProxyOrganization请求参数结构体
  */
@@ -1894,30 +1963,45 @@ export interface CreateChannelFlowEvidenceReportResponse {
 }
 
 /**
- * 同步经办人失败原因
+ * PrepareFlows返回参数结构体
  */
-export interface SyncFailReason {
+export interface PrepareFlowsResponse {
   /**
-   * 经办人Id
+   * 待发起文件确认页
    */
-  Id: string
+  ConfirmUrl: string
 
   /**
-      * 失败原因
-例如：Id不符合规范、证件号码不合法等
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Message: string
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
- * PrepareFlows返回参数结构体
+ * ChannelDescribeEmployees返回参数结构体
  */
-export interface PrepareFlowsResponse {
+export interface ChannelDescribeEmployeesResponse {
   /**
-   * 待发起文件确认页
+      * 员工数据列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Employees: Array<Staff>
+
+  /**
+      * 偏移量，默认为0，最大为20000
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Offset: number
+
+  /**
+   * 返回最大数量，最大为20
    */
-  ConfirmUrl: string
+  Limit: number
+
+  /**
+   * 符合条件的员工数量
+   */
+  TotalCount: number
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1925,6 +2009,23 @@ export interface PrepareFlowsResponse {
   RequestId?: string
 }
 
+/**
+ * 复杂文档合成任务的任务信息
+ */
+export interface TaskInfo {
+  /**
+      * 合成任务Id，可以通过 ChannelGetTaskResultApi 接口获取任务信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  TaskId: string
+
+  /**
+      * 任务状态：READY - 任务已完成；NOTREADY - 任务未完成；
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  TaskStatus: string
+}
+
 /**
  * DescribeUsage请求参数结构体
  */
@@ -2483,20 +2584,89 @@ export interface ChannelCreateFlowGroupByFilesRequest {
 }
 
 /**
- * 复杂文档合成任务的任务信息
+ * UploadFiles请求参数结构体
  */
-export interface TaskInfo {
+export interface UploadFilesRequest {
   /**
-      * 合成任务Id，可以通过 ChannelGetTaskResultApi 接口获取任务信息
+   * 应用相关信息，若是渠道版调用 appid 和proxyappid 必填
+   */
+  Agent: Agent
+
+  /**
+      * 文件对应业务类型，用于区分文件存储路径：
+1. TEMPLATE - 模板； 文件类型：.pdf .doc .docx .html
+2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
+      */
+  BusinessType: string
+
+  /**
+   * 上传文件内容数组，最多支持20个文件
+   */
+  FileInfos?: Array<UploadFile>
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
+}
+
+/**
+ * 企业员工信息
+ */
+export interface Staff {
+  /**
+   * 员工在电子签平台的id
+   */
+  UserId: string
+
+  /**
+   * 显示的员工名
+   */
+  DisplayName: string
+
+  /**
+   * 员工手机号
+   */
+  Mobile: string
+
+  /**
+      * 员工邮箱
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  TaskId: string
+  Email: string
 
   /**
-      * 任务状态：READY - 任务已完成；NOTREADY - 任务未完成；
+      * 员工在第三方平台id
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  TaskStatus: string
+  OpenId: string
+
+  /**
+      * 员工角色
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Roles: Array<StaffRole>
+
+  /**
+      * 员工部门
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Department: Department
+
+  /**
+   * 员工是否实名
+   */
+  Verified: boolean
+
+  /**
+   * 员工创建时间戳
+   */
+  CreatedOn: number
+
+  /**
+   * 员工实名时间戳
+   */
+  VerifiedOn: number
 }
 
 /**

package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, UploadFilesRequest, SyncProxyOrganizationResponse, ChannelBatchCancelFlowsResponse, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse, ChannelGetTaskResultApiRequest, ChannelVerifyPdfResponse, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeUsageResponse, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, ChannelVerifyPdfRequest, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, ChannelCreateFlowGroupByFilesResponse, PrepareFlowsRequest, ChannelCreateBatchCancelFlowUrlResponse, DescribeResourceUrlsByFlowsRequest, ChannelCancelMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportResponse, PrepareFlowsResponse, DescribeUsageRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowGroupByFilesRequest, ChannelCancelMultiFlowSignQRCodeResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
+import { ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, ChannelDescribeEmployeesRequest, SyncProxyOrganizationResponse, ChannelBatchCancelFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse, ChannelGetTaskResultApiRequest, ChannelVerifyPdfResponse, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeUsageResponse, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, ChannelVerifyPdfRequest, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, ChannelCreateFlowGroupByFilesResponse, PrepareFlowsRequest, ChannelCreateBatchCancelFlowUrlResponse, DescribeResourceUrlsByFlowsRequest, ChannelCancelMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportResponse, PrepareFlowsResponse, ChannelDescribeEmployeesResponse, DescribeUsageRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowGroupByFilesRequest, UploadFilesRequest, ChannelCancelMultiFlowSignQRCodeResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
 /**
  * essbasic client
  * @class
@@ -69,8 +69,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse>;
     /**
-       * 【描述】：创建出证报告，返回报告 URL
-  【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
+       * 创建出证报告，返回报告 URL。此接口暂未开放，有问题请联系运营人员。
+  
        */
     CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
     /**
@@ -88,6 +88,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   若经办人信息有误，或者需要修改，也可以先将之前的经办人做离职操作，然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
        */
     SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
+    /**
+     * 查询企业员工
+     */
+    ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
     /**
        * 指定需要批量撤销的签署流程Id，批量撤销合同
   客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口失败后返回错误信息

package/tencentcloud/services/essbasic/v20210526/essbasic_client.js

@@ -114,8 +114,8 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelGetTaskResultApi", req, cb);
     }
     /**
-       * 【描述】：创建出证报告，返回报告 URL
-  【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
+       * 创建出证报告，返回报告 URL。此接口暂未开放，有问题请联系运营人员。
+  
        */
     async CreateChannelFlowEvidenceReport(req, cb) {
         return this.request("CreateChannelFlowEvidenceReport", req, cb);
@@ -141,6 +141,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async SyncProxyOrganizationOperators(req, cb) {
         return this.request("SyncProxyOrganizationOperators", req, cb);
     }
+    /**
+     * 查询企业员工
+     */
+    async ChannelDescribeEmployees(req, cb) {
+        return this.request("ChannelDescribeEmployees", req, cb);
+    }
     /**
        * 指定需要批量撤销的签署流程Id，批量撤销合同
   客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口失败后返回错误信息