tencentcloud-sdk-nodejs-essbasic 4.0.331 → 4.0.334

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

@@ -821,82 +821,18 @@ export interface SyncProxyOrganizationOperatorsResponse {
 }
 
 /**
- * 签署链接内容
+ * CreateSealByImage返回参数结构体
  */
-export interface SignUrlInfo {
-  /**
-      * 签署链接
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  SignUrl: string
-
-  /**
-      * 链接失效时间,默认30分钟
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Deadline: number
-
-  /**
-      * 当流程为顺序签署此参数有效时，数字越小优先级越高，暂不支持并行签署 可选
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  SignOrder: number
-
-  /**
-      * 签署人编号
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  SignId: string
-
-  /**
-      * 自定义用户编号
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  CustomUserId: string
-
-  /**
-      * 用户姓名
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Name: string
-
-  /**
-      * 用户手机号码
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Mobile: string
-
-  /**
-      * 签署参与者机构名字
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  OrganizationName: string
-
-  /**
-      * 参与者类型:
-ORGANIZATION 企业经办人
-PERSON 自然人
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  ApproverType: string
-
+export interface CreateSealByImageResponse {
   /**
-      * 经办人身份证号
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  IdCardNumber: string
-
-  /**
-      * 签署链接对应流程Id
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  FlowId: string
+   * 印章id
+   */
+  SealId: string
 
   /**
-      * 企业经办人 用户在渠道的编号
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  OpenId: string
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -1038,6 +974,61 @@ export interface SyncProxyOrganizationRequest {
   Operator?: UserInfo
 }
 
+/**
+ * CreateSealByImage请求参数结构体
+ */
+export interface CreateSealByImageRequest {
+  /**
+   * 渠道应用相关信息
+   */
+  Agent: Agent
+
+  /**
+   * 印章名称
+   */
+  SealName: string
+
+  /**
+   * 印章图片base64
+   */
+  SealImage: string
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
+}
+
+/**
+ * 接口调用者信息
+ */
+export interface UserInfo {
+  /**
+   * 自定义用户编号
+   */
+  CustomUserId?: string
+
+  /**
+   * 用户的来源渠道
+   */
+  Channel?: string
+
+  /**
+   * 用户在渠道的编号
+   */
+  OpenId?: string
+
+  /**
+   * 用户真实IP
+   */
+  ClientIp?: string
+
+  /**
+   * 用户代理IP
+   */
+  ProxyIp?: string
+}
+
 /**
  * 用量明细
  */
@@ -1136,28 +1127,13 @@ export interface DownloadFlowInfo {
 }
 
 /**
- * UploadFiles返回参数结构体
+ * 抄送信息
  */
-export interface UploadFilesResponse {
-  /**
-   * 文件id数组
-   */
-  FileIds: Array<string>
-
-  /**
-   * 上传成功文件数量
-   */
-  TotalCount: number
-
-  /**
-   * 文件Url
-   */
-  FileUrls: Array<string>
-
+export interface CcInfo {
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 被抄送人手机号
    */
-  RequestId?: string
+  Mobile?: string
 }
 
 /**
@@ -1221,13 +1197,104 @@ export interface DescribeUsageRequest {
 }
 
 /**
- * 抄送信息
+ * ChannelCreateFlowByFiles请求参数结构体
  */
-export interface CcInfo {
+export interface ChannelCreateFlowByFilesRequest {
   /**
-   * 被抄送人手机号
+   * 渠道应用相关信息
    */
-  Mobile?: string
+  Agent?: Agent
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
+
+  /**
+   * 签署文件资源Id列表，目前仅支持单个文件
+   */
+  FileIds?: Array<string>
+
+  /**
+   * 流程名称，长度不超过200个字符
+   */
+  FlowName?: string
+
+  /**
+   * 流程截止时间，十位数时间戳，最大值为33162419560，即3020年
+   */
+  Deadline?: number
+
+  /**
+   * 流程的描述，长度不超过1000个字符
+   */
+  FlowDescription?: string
+
+  /**
+   * 流程的类型，长度不超过255个字符
+   */
+  FlowType?: string
+
+  /**
+   * 流程回调地址，长度不超过255个字符
+   */
+  CallbackUrl?: string
+
+  /**
+   * 流程签约方列表，最多不超过5个参与方
+   */
+  FlowApprovers?: Array<FlowApproverInfo>
+
+  /**
+   * 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署
+   */
+  Unordered?: boolean
+
+  /**
+   * 签署文件中的控件，如：填写控件等
+   */
+  Components?: Array<Component>
+}
+
+/**
+ * ChannelCreateFlowByFiles返回参数结构体
+ */
+export interface ChannelCreateFlowByFilesResponse {
+  /**
+      * 合同流程ID
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * UploadFiles返回参数结构体
+ */
+export interface UploadFilesResponse {
+  /**
+   * 文件id数组
+   */
+  FileIds: Array<string>
+
+  /**
+   * 上传成功文件数量
+   */
+  TotalCount: number
+
+  /**
+   * 文件Url
+   */
+  FileUrls: Array<string>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -1407,33 +1474,82 @@ export interface FlowInfo {
 }
 
 /**
- * 接口调用者信息
+ * 签署链接内容
  */
-export interface UserInfo {
+export interface SignUrlInfo {
   /**
-   * 自定义用户编号
-   */
-  CustomUserId?: string
+      * 签署链接
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SignUrl: string
 
   /**
-   * 用户的来源渠道
-   */
-  Channel?: string
+      * 链接失效时间,默认30分钟
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Deadline: number
 
   /**
-   * 用户在渠道的编号
-   */
-  OpenId?: string
+      * 当流程为顺序签署此参数有效时，数字越小优先级越高，暂不支持并行签署 可选
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SignOrder: number
 
   /**
-   * 用户真实IP
-   */
-  ClientIp?: string
+      * 签署人编号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SignId: string
 
   /**
-   * 用户代理IP
-   */
-  ProxyIp?: string
+      * 自定义用户编号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CustomUserId: string
+
+  /**
+      * 用户姓名
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Name: string
+
+  /**
+      * 用户手机号码
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Mobile: string
+
+  /**
+      * 签署参与者机构名字
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OrganizationName: string
+
+  /**
+      * 参与者类型:
+ORGANIZATION 企业经办人
+PERSON 自然人
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ApproverType: string
+
+  /**
+      * 经办人身份证号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IdCardNumber: string
+
+  /**
+      * 签署链接对应流程Id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowId: string
+
+  /**
+      * 企业经办人 用户在渠道的编号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OpenId: 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, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsRequest, DescribeFlowDetailInfoRequest, UploadFilesRequest, DescribeResourceUrlsByFlowsRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSignUrlsResponse, OperateChannelTemplateRequest, UploadFilesResponse, DescribeUsageRequest, DescribeUsageResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
+import { SyncProxyOrganizationResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsRequest, DescribeFlowDetailInfoRequest, UploadFilesRequest, DescribeResourceUrlsByFlowsRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, CreateSignUrlsResponse, OperateChannelTemplateRequest, DescribeUsageRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, DescribeUsageResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
 /**
  * essbasic client
  * @class
@@ -11,7 +11,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
     /**
-       * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，支持客户合同（流程）按照自定义文件夹形式 分类下载。
+       * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
   当前接口限制最多合同（流程）50个.
   
        */
@@ -20,10 +20,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 通过此接口（DescribeTemplates）查询该企业在电子签渠道版中配置的有效模板列表
      */
     DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
+    /**
+     * 接口（ChannelCreateFlowByFiles）用于渠道版通过文件创建流程。此接口不可直接使用，需要运营申请
+     */
+    ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
     /**
        * 该接口 (PrepareFlows) 用于创建待发起文件
   用户通过该接口进入流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-  目前该接口只支持B2C。
+  目前该接口只支持B2C，不建议使用。
        */
     PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
     /**
@@ -34,6 +38,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   对渠道子客进行模板库中模板授权,修改操作
        */
     OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
+    /**
+     * 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，需要运营申请
+     */
+    CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse>;
     /**
      * 创建参与者签署短链
      */
@@ -61,8 +69,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
     /**
-     * 根据流程信息批量获取资源下载链接
-     */
+       * 根据流程信息批量获取资源下载链接，可直接下载
+  限制：只能下载合作企业授权过的、单方签署的流程文件（若合作企业与渠道是同一企业，可以下载所有流程文件）
+       */
     DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
     /**
        * 此接口（UploadFiles）用于文件上传。

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

@@ -34,7 +34,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateFlowsByTemplates", req, cb);
     }
     /**
-       * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，支持客户合同（流程）按照自定义文件夹形式 分类下载。
+       * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
   当前接口限制最多合同（流程）50个.
   
        */
@@ -47,10 +47,16 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeTemplates(req, cb) {
         return this.request("DescribeTemplates", req, cb);
     }
+    /**
+     * 接口（ChannelCreateFlowByFiles）用于渠道版通过文件创建流程。此接口不可直接使用，需要运营申请
+     */
+    async ChannelCreateFlowByFiles(req, cb) {
+        return this.request("ChannelCreateFlowByFiles", req, cb);
+    }
     /**
        * 该接口 (PrepareFlows) 用于创建待发起文件
   用户通过该接口进入流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-  目前该接口只支持B2C。
+  目前该接口只支持B2C，不建议使用。
        */
     async PrepareFlows(req, cb) {
         return this.request("PrepareFlows", req, cb);
@@ -65,6 +71,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async OperateChannelTemplate(req, cb) {
         return this.request("OperateChannelTemplate", req, cb);
     }
+    /**
+     * 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，需要运营申请
+     */
+    async CreateSealByImage(req, cb) {
+        return this.request("CreateSealByImage", req, cb);
+    }
     /**
      * 创建参与者签署短链
      */
@@ -104,8 +116,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("SyncProxyOrganization", req, cb);
     }
     /**
-     * 根据流程信息批量获取资源下载链接
-     */
+       * 根据流程信息批量获取资源下载链接，可直接下载
+  限制：只能下载合作企业授权过的、单方签署的流程文件（若合作企业与渠道是同一企业，可以下载所有流程文件）
+       */
     async DescribeResourceUrlsByFlows(req, cb) {
         return this.request("DescribeResourceUrlsByFlows", req, cb);
     }