tencentcloud-sdk-nodejs-essbasic 4.0.255 → 4.0.260

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

@@ -91,6 +91,11 @@ export interface FlowApproverInfo {
    * 用户侧第三方id
    */
   OpenId?: string
+
+  /**
+   * 合同的强制预览时间：3~300s，未指定则按合同页数计算
+   */
+  PreReadTime?: number
 }
 
 /**
@@ -158,6 +163,21 @@ export interface TemplateInfo {
   Recipients: Array<Recipient>
 }
 
+/**
+ * GetDownloadFlowUrl返回参数结构体
+ */
+export interface GetDownloadFlowUrlResponse {
+  /**
+   * 进入合同（流程）下载确认页面链接
+   */
+  DownLoadUrl: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeResourceUrlsByFlows返回参数结构体
  */
@@ -179,6 +199,51 @@ export interface DescribeResourceUrlsByFlowsResponse {
   RequestId?: string
 }
 
+/**
+ * 签署参与者信息
+ */
+export interface Recipient {
+  /**
+   * 签署人唯一标识
+   */
+  RecipientId?: string
+
+  /**
+   * 签署方类型：ENTERPRISE-企业INDIVIDUAL-自然人
+   */
+  RecipientType?: string
+
+  /**
+   * 描述
+   */
+  Description?: string
+
+  /**
+   * 签署方备注信息
+   */
+  RoleName?: string
+
+  /**
+   * 是否需要校验
+   */
+  RequireValidation?: boolean
+
+  /**
+   * 是否必须填写
+   */
+  RequireSign?: boolean
+
+  /**
+   * 签署类型
+   */
+  SignType?: number
+
+  /**
+   * 签署顺序：数字越小优先级越高
+   */
+  RoutingOrder?: number
+}
+
 /**
  * DescribeTemplates返回参数结构体
  */
@@ -195,28 +260,49 @@ export interface DescribeTemplatesResponse {
 }
 
 /**
- * SyncProxyOrganizationOperators请求参数结构体
+ * OperateChannelTemplate返回参数结构体
  */
-export interface SyncProxyOrganizationOperatorsRequest {
+export interface OperateChannelTemplateResponse {
   /**
-   * 操作类型，新增:"CREATE"，修改:"UPDATE"，离职:"RESIGN"
-   */
-  OperatorType: string
+      * 腾讯电子签颁发给渠道的应用ID
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  AppId: string
 
   /**
-   * 应用信息
-   */
-  Agent: Agent
+      * 渠道方模板库模板唯一标识
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  TemplateId: string
 
   /**
-   * 经办人信息列表
-   */
-  ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
+      * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OperateResult: string
 
   /**
-   * 操作者的信息
+      * 模板可见性, 全部可见-"all", 部分可见-"part"
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  AuthTag: string
+
+  /**
+      * 合作企业方第三方机构唯一标识数据
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ProxyOrganizationOpenIds: Array<string>
+
+  /**
+      * 操作失败信息数组
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FailMessageList: Array<AuthFailMessage>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  Operator?: UserInfo
+  RequestId?: string
 }
 
 /**
@@ -249,6 +335,21 @@ export interface CreateSignUrlsRequest {
   JumpUrl?: string
 }
 
+/**
+ * 授权出错信息
+ */
+export interface AuthFailMessage {
+  /**
+   * 合作企业Id
+   */
+  ProxyOrganizationOpenId: string
+
+  /**
+   * 出错信息
+   */
+  Message: string
+}
+
 /**
  * DescribeResourceUrlsByFlows请求参数结构体
  */
@@ -383,6 +484,27 @@ TEXT控件可以指定字体
   ComponentDescription?: string
 }
 
+/**
+ * GetDownloadFlowUrl请求参数结构体
+ */
+export interface GetDownloadFlowUrlRequest {
+  /**
+      * 应用信息
+此接口Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
+      */
+  Agent: Agent
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
+
+  /**
+   * 文件夹数组，合同（流程）总数不能超过50个，一个文件夹下，不能超过20个合同（流程），
+   */
+  DownLoadFlows?: Array<DownloadFlowInfo>
+}
+
 /**
  * 签署链接内容
  */
@@ -530,37 +652,28 @@ export interface CreateFlowsByTemplatesResponse {
 }
 
 /**
- * 合作企业经办人列表信息
+ * PrepareFlows请求参数结构体
  */
-export interface ProxyOrganizationOperator {
+export interface PrepareFlowsRequest {
   /**
-   * 经办人ID（渠道颁发）
+   * 渠道应用相关信息
    */
-  Id: string
+  Agent: Agent
 
   /**
-   * 经办人姓名
+   * 多个合同（流程）信息
    */
-  Name?: string
-
-  /**
-      * 经办人身份证件类型
-用户证件类型：默认ID_CARD
-1. ID_CARD - 居民身份证
-2. HOUSEHOLD_REGISTER - 户口本
-3. TEMP_ID_CARD - 临时居民身份证
-      */
-  IdCardType?: string
+  FlowInfos: Array<FlowInfo>
 
   /**
-   * 经办人身份证号
+   * 操作完成后的跳转地址
    */
-  IdCardNumber?: string
+  JumpUrl: string
 
   /**
-   * 经办人手机号
+   * 操作者的信息
    */
-  Mobile?: string
+  Operator?: UserInfo
 }
 
 /**
@@ -624,6 +737,31 @@ export interface DescribeTemplatesRequest {
   TemplateId?: string
 }
 
+/**
+ * SyncProxyOrganizationOperators请求参数结构体
+ */
+export interface SyncProxyOrganizationOperatorsRequest {
+  /**
+   * 操作类型，新增:"CREATE"，修改:"UPDATE"，离职:"RESIGN"
+   */
+  OperatorType: string
+
+  /**
+   * 应用信息
+   */
+  Agent: Agent
+
+  /**
+   * 经办人信息列表
+   */
+  ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
+}
+
 /**
  * CreateConsoleLoginUrl返回参数结构体
  */
@@ -696,31 +834,6 @@ export interface SyncProxyOrganizationRequest {
   Operator?: UserInfo
 }
 
-/**
- * PrepareFlows请求参数结构体
- */
-export interface PrepareFlowsRequest {
-  /**
-   * 渠道应用相关信息
-   */
-  Agent: Agent
-
-  /**
-   * 多个合同（流程）信息
-   */
-  FlowInfos: Array<FlowInfo>
-
-  /**
-   * 操作完成后的跳转地址
-   */
-  JumpUrl: string
-
-  /**
-   * 操作者的信息
-   */
-  Operator?: UserInfo
-}
-
 /**
  * 用量明细
  */
@@ -768,6 +881,56 @@ export interface CreateSignUrlsResponse {
   RequestId?: string
 }
 
+/**
+ * OperateChannelTemplate请求参数结构体
+ */
+export interface OperateChannelTemplateRequest {
+  /**
+   * 应用信息
+   */
+  Agent: Agent
+
+  /**
+   * 渠道方模板库模板唯一标识
+   */
+  TemplateId: string
+
+  /**
+   * 操作类型，查询:"SELECT"，删除:"DELETE"，更新:"UPDATE"
+   */
+  OperateType: string
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
+
+  /**
+   * 模板可见性, 全部可见-"all", 部分可见-"part"
+   */
+  AuthTag?: string
+
+  /**
+   * 合作企业方第三方机构唯一标识数据
+   */
+  ProxyOrganizationOpenIds?: string
+}
+
+/**
+ * 合同（流程）下载信息
+ */
+export interface DownloadFlowInfo {
+  /**
+   * 文件夹名称
+   */
+  FileName: string
+
+  /**
+   * 合同（流程）的标识数组
+   */
+  FlowIdList: Array<string>
+}
+
 /**
  * 同步经办人失败原因
  */
@@ -829,48 +992,37 @@ export interface DescribeUsageRequest {
 }
 
 /**
- * 签署参与者信息
+ * 合作企业经办人列表信息
  */
-export interface Recipient {
-  /**
-   * 签署人唯一标识
-   */
-  RecipientId?: string
-
-  /**
-   * 签署方类型：ENTERPRISE-企业INDIVIDUAL-自然人
-   */
-  RecipientType?: string
-
-  /**
-   * 描述
-   */
-  Description?: string
-
+export interface ProxyOrganizationOperator {
   /**
-   * 签署方备注信息
+   * 经办人ID（渠道颁发）
    */
-  RoleName?: string
+  Id: string
 
   /**
-   * 是否需要校验
+   * 经办人姓名
    */
-  RequireValidation?: boolean
+  Name?: string
 
   /**
-   * 是否必须填写
-   */
-  RequireSign?: boolean
+      * 经办人身份证件类型
+用户证件类型：默认ID_CARD
+1. ID_CARD - 居民身份证
+2. HOUSEHOLD_REGISTER - 户口本
+3. TEMP_ID_CARD - 临时居民身份证
+      */
+  IdCardType?: string
 
   /**
-   * 签署类型
+   * 经办人身份证号
    */
-  SignType?: number
+  IdCardNumber?: string
 
   /**
-   * 签署顺序：数字越小优先级越高
+   * 经办人手机号
    */
-  RoutingOrder?: number
+  Mobile?: string
 }
 
 /**

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

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { SyncProxyOrganizationResponse, PrepareFlowsResponse, DescribeResourceUrlsByFlowsResponse, DescribeTemplatesResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, DescribeResourceUrlsByFlowsRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, SyncProxyOrganizationOperatorsResponse, DescribeTemplatesRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, PrepareFlowsRequest, CreateSignUrlsResponse, DescribeUsageRequest, DescribeUsageResponse } from "./essbasic_models";
+import { SyncProxyOrganizationResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsRequest, DescribeResourceUrlsByFlowsRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSignUrlsResponse, OperateChannelTemplateRequest, DescribeUsageRequest, DescribeUsageResponse } from "./essbasic_models";
 /**
  * essbasic client
  * @class
@@ -10,10 +10,32 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 接口（CreateFlowsByTemplates）用于使用多个模板批量创建流程
      */
     CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
+    /**
+       * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载确认页面链接，支持客户合同（流程）归类打包下载。
+  
+       */
+    GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
     /**
      * 该接口 (PrepareFlows) 用于创建待发起文件
      */
     PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
+    /**
+       * 此接口（OperateChannelTemplate）用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的指定.
+  1、同步标识=select时：
+  输入规则：“可见标识”、“指定合作企业列表”为空。
+  处理规则：返回指定模版的可见标识、指定合作企业列表。
+  2、同步标识=update时：
+  输入规则：“可见标识”、“指定合作企业列表”非必填输入。
+  处理规则：
+  若“可见标识”=空，不做处理，返回当前的可见标识。
+  若“可见标识”=所有合作企业，不取“指定合作企业列表”的值处理。
+  若“可见标识”=指定合作企业，取“指定合作企业列表”的值进行更新/插入。
+  3、同步标识=delete时：
+  输入规则：“可见标识”、“指定合作企业列表”非必填输入。
+  处理规则：
+  仅取“指定合作企业列表”的值进行删除处理，为空时不做处。
+       */
+    OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
     /**
      * 根据流程Id批量创建签署参与者签署H5链接
      */

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

@@ -33,12 +33,38 @@ class Client extends TencentCloudCommon.AbstractClient {
     async CreateFlowsByTemplates(req, cb) {
         return this.request("CreateFlowsByTemplates", req, cb);
     }
+    /**
+       * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载确认页面链接，支持客户合同（流程）归类打包下载。
+  
+       */
+    async GetDownloadFlowUrl(req, cb) {
+        return this.request("GetDownloadFlowUrl", req, cb);
+    }
     /**
      * 该接口 (PrepareFlows) 用于创建待发起文件
      */
     async PrepareFlows(req, cb) {
         return this.request("PrepareFlows", req, cb);
     }
+    /**
+       * 此接口（OperateChannelTemplate）用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的指定.
+  1、同步标识=select时：
+  输入规则：“可见标识”、“指定合作企业列表”为空。
+  处理规则：返回指定模版的可见标识、指定合作企业列表。
+  2、同步标识=update时：
+  输入规则：“可见标识”、“指定合作企业列表”非必填输入。
+  处理规则：
+  若“可见标识”=空，不做处理，返回当前的可见标识。
+  若“可见标识”=所有合作企业，不取“指定合作企业列表”的值处理。
+  若“可见标识”=指定合作企业，取“指定合作企业列表”的值进行更新/插入。
+  3、同步标识=delete时：
+  输入规则：“可见标识”、“指定合作企业列表”非必填输入。
+  处理规则：
+  仅取“指定合作企业列表”的值进行删除处理，为空时不做处。
+       */
+    async OperateChannelTemplate(req, cb) {
+        return this.request("OperateChannelTemplate", req, cb);
+    }
     /**
      * 根据流程Id批量创建签署参与者签署H5链接
      */