tencentcloud-sdk-nodejs-essbasic 4.0.438 → 4.0.439

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

@@ -273,6 +273,21 @@ export interface UploadFilesRequest {
   Operator?: UserInfo
 }
 
+/**
+ * ChannelBatchCancelFlows返回参数结构体
+ */
+export interface ChannelBatchCancelFlowsResponse {
+  /**
+   * 签署流程批量撤销失败原因，错误信息与流程Id一一对应，如果部分流程不可撤销，不会返回错误信息，只会撤销可撤销流程
+   */
+  FailMessages: Array<string>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * GetDownloadFlowUrl返回参数结构体
  */
@@ -485,9 +500,9 @@ export interface CreateSignUrlsRequest {
   Agent: Agent
 
   /**
-   * 签署流程编号数组，最多支持100个。
+   * 签署流程编号数组，最多支持100个。(备注：该参数和合同组编号必须二选一)
    */
-  FlowIds: Array<string>
+  FlowIds?: Array<string>
 
   /**
    * 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；
@@ -544,6 +559,11 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
    * 操作者的信息
    */
   Operator?: UserInfo
+
+  /**
+   * 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)
+   */
+  FlowGroupId?: string
 }
 
 /**
@@ -644,14 +664,20 @@ export interface DescribeFlowDetailInfoRequest {
   Agent: Agent
 
   /**
-   * 合同(流程)编号数组，最多支持100个。
-   */
-  FlowIds: Array<string>
+      * 合同(流程)编号数组，最多支持100个。
+（备注：该参数和合同组编号必须二选一）
+      */
+  FlowIds?: Array<string>
 
   /**
    * 操作者的信息
    */
   Operator?: UserInfo
+
+  /**
+   * 合同组编号（备注：该参数和合同(流程)编号数组必须二选一）
+   */
+  FlowGroupId?: string
 }
 
 /**
@@ -702,6 +728,21 @@ ProcessTimeout - 转换文件超时
   RequestId?: string
 }
 
+/**
+ * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
+ */
+export interface UploadFile {
+  /**
+   * Base64编码后的文件内容
+   */
+  FileBody: string
+
+  /**
+   * 文件名
+   */
+  FileName?: string
+}
+
 /**
  * 合作企业经办人列表信息
  */
@@ -761,18 +802,88 @@ export interface ChannelGetTaskResultApiRequest {
 }
 
 /**
- * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
+ * 签署链接内容
  */
-export interface UploadFile {
+export interface SignUrlInfo {
   /**
-   * Base64编码后的文件内容
-   */
-  FileBody: string
+      * 签署链接
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SignUrl: string
 
   /**
-   * 文件名
-   */
-  FileName?: 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
+
+  /**
+      * 经办人身份证号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IdCardNumber: string
+
+  /**
+      * 签署链接对应流程Id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowId: string
+
+  /**
+      * 企业经办人 用户在渠道的编号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OpenId: string
+
+  /**
+      * 合同组签署链接对应的合同组id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowGroupId: string
 }
 
 /**
@@ -931,6 +1042,26 @@ export interface GetDownloadFlowUrlRequest {
   Operator?: UserInfo
 }
 
+/**
+ * ChannelBatchCancelFlows请求参数结构体
+ */
+export interface ChannelBatchCancelFlowsRequest {
+  /**
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+   */
+  Agent: Agent
+
+  /**
+   * 签署流程Id数组，最多100个，超过100不处理
+   */
+  FlowIds: Array<string>
+
+  /**
+   * 操作人信息
+   */
+  Operator?: UserInfo
+}
+
 /**
  * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
  */
@@ -1122,28 +1253,24 @@ REJECT: 拒绝
 }
 
 /**
- * PrepareFlows请求参数结构体
+ * DescribeUsage返回参数结构体
  */
-export interface PrepareFlowsRequest {
-  /**
-   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
-   */
-  Agent: Agent
-
+export interface DescribeUsageResponse {
   /**
-   * 多个合同（签署流程）信息，最大支持20个签署流程。
+   * 用量明细条数
    */
-  FlowInfos: Array<FlowInfo>
+  Total: number
 
   /**
-   * 操作完成后的跳转地址，最大长度200
-   */
-  JumpUrl: string
+      * 用量明细
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Details: Array<UsageDetail>
 
   /**
-   * 操作者的信息
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  Operator?: UserInfo
+  RequestId?: string
 }
 
 /**
@@ -1222,6 +1349,66 @@ export interface FlowResourceUrlInfo {
   ResourceUrlInfos: Array<ResourceUrlInfo>
 }
 
+/**
+ * 合同组中每个子合同的发起信息
+ */
+export interface FlowFileInfo {
+  /**
+   * 签署文件资源Id列表，目前仅支持单个文件
+   */
+  FileIds: Array<string>
+
+  /**
+   * 签署流程名称，长度不超过200个字符
+   */
+  FlowName: string
+
+  /**
+   * 签署流程签约方列表，最多不超过5个参与方
+   */
+  FlowApprovers: Array<FlowApproverInfo>
+
+  /**
+   * 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
+   */
+  Deadline?: number
+
+  /**
+   * 签署流程的描述，长度不超过1000个字符
+   */
+  FlowDescription?: string
+
+  /**
+   * 签署流程的类型，长度不超过255个字符
+   */
+  FlowType?: string
+
+  /**
+   * 签署流程回调地址，长度不超过255个字符
+   */
+  CallbackUrl?: string
+
+  /**
+   * 渠道的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+   */
+  CustomerData?: string
+
+  /**
+   * 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署
+   */
+  Unordered?: boolean
+
+  /**
+   * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+   */
+  CustomShowMap?: string
+
+  /**
+   * 本企业(发起方企业)是否需要签署审批
+   */
+  NeedSignReview?: boolean
+}
+
 /**
  * DescribeTemplates请求参数结构体
  */
@@ -1416,19 +1603,20 @@ export interface SignQrCode {
 }
 
 /**
- * DescribeUsage返回参数结构体
+ * ChannelCreateFlowGroupByFiles返回参数结构体
  */
-export interface DescribeUsageResponse {
+export interface ChannelCreateFlowGroupByFilesResponse {
   /**
-   * 用量明细条数
-   */
-  Total: number
+      * 合同组ID
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowGroupId: string
 
   /**
-      * 用量明细
+      * 子合同ID列表
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  Details: Array<UsageDetail>
+  FlowIds: Array<string>
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1436,6 +1624,31 @@ export interface DescribeUsageResponse {
   RequestId?: string
 }
 
+/**
+ * PrepareFlows请求参数结构体
+ */
+export interface PrepareFlowsRequest {
+  /**
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+   */
+  Agent: Agent
+
+  /**
+   * 多个合同（签署流程）信息，最大支持20个签署流程。
+   */
+  FlowInfos: Array<FlowInfo>
+
+  /**
+   * 操作完成后的跳转地址，最大长度200
+   */
+  JumpUrl: string
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
+}
+
 /**
  * 用量明细
  */
@@ -2130,82 +2343,28 @@ export interface FlowInfo {
 }
 
 /**
- * 签署链接内容
+ * ChannelCreateFlowGroupByFiles请求参数结构体
  */
-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
-
+export interface ChannelCreateFlowGroupByFilesRequest {
   /**
-      * 签署参与者机构名字
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  OrganizationName: string
-
-  /**
-      * 参与者类型:
-ORGANIZATION 企业经办人
-PERSON 自然人
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  ApproverType: string
+   * 每个子合同的发起所需的信息，数量限制2-100
+   */
+  FlowFileInfos: Array<FlowFileInfo>
 
   /**
-      * 经办人身份证号
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  IdCardNumber: string
+   * 合同组名称，长度不超过200个字符
+   */
+  FlowGroupName: string
 
   /**
-      * 签署链接对应流程Id
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  FlowId: string
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+   */
+  Agent?: Agent
 
   /**
-      * 企业经办人 用户在渠道的编号
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  OpenId: string
+   * 操作者的信息
+   */
+  Operator?: UserInfo
 }
 
 /**
@@ -2265,6 +2424,18 @@ export interface DescribeFlowDetailInfoResponse {
       */
   FlowInfo: Array<FlowDetailInfo>
 
+  /**
+      * 合同组编号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowGroupId: string
+
+  /**
+      * 合同组名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowGroupName: string
+
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */

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

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, UploadFilesRequest, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse, ChannelGetTaskResultApiRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, ChannelCreateFlowSignReviewRequest, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, DescribeResourceUrlsByFlowsRequest, ChannelCancelMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportResponse, PrepareFlowsResponse, DescribeUsageRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCancelMultiFlowSignQRCodeResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
+import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, UploadFilesRequest, ChannelBatchCancelFlowsResponse, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse, ChannelGetTaskResultApiRequest, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeUsageResponse, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, 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";
 /**
  * essbasic client
  * @class
@@ -72,6 +72,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   
        */
     GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
+    /**
+     * 此接口（SyncProxyOrganizationOperators）用于同步渠道合作企业经办人列表
+     */
+    SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
+    /**
+       * 指定需要批量撤销的签署流程Id，批量撤销合同
+  客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口失败后返回错误信息
+       */
+    ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
     /**
        * 该接口 (PrepareFlows) 用于创建待发起文件
   用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
@@ -92,8 +101,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
     /**
-     * 创建出证报告，返回报告 URL
-     */
+       * 【描述】：创建出证报告，返回报告 URL
+  【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
+       */
     CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
     /**
        * 此接口（OperateChannelTemplate）用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
@@ -104,9 +114,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
     /**
-     * 此接口（SyncProxyOrganizationOperators）用于同步渠道合作企业经办人列表
+     * 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
      */
-    SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
+    ChannelCreateFlowGroupByFiles(req: ChannelCreateFlowGroupByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void): Promise<ChannelCreateFlowGroupByFilesResponse>;
     /**
      * 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
      */

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

@@ -121,6 +121,19 @@ class Client extends TencentCloudCommon.AbstractClient {
     async GetDownloadFlowUrl(req, cb) {
         return this.request("GetDownloadFlowUrl", req, cb);
     }
+    /**
+     * 此接口（SyncProxyOrganizationOperators）用于同步渠道合作企业经办人列表
+     */
+    async SyncProxyOrganizationOperators(req, cb) {
+        return this.request("SyncProxyOrganizationOperators", req, cb);
+    }
+    /**
+       * 指定需要批量撤销的签署流程Id，批量撤销合同
+  客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口失败后返回错误信息
+       */
+    async ChannelBatchCancelFlows(req, cb) {
+        return this.request("ChannelBatchCancelFlows", req, cb);
+    }
     /**
        * 该接口 (PrepareFlows) 用于创建待发起文件
   用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
@@ -149,8 +162,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("UploadFiles", req, cb);
     }
     /**
-     * 创建出证报告，返回报告 URL
-     */
+       * 【描述】：创建出证报告，返回报告 URL
+  【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
+       */
     async CreateChannelFlowEvidenceReport(req, cb) {
         return this.request("CreateChannelFlowEvidenceReport", req, cb);
     }
@@ -165,10 +179,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("OperateChannelTemplate", req, cb);
     }
     /**
-     * 此接口（SyncProxyOrganizationOperators）用于同步渠道合作企业经办人列表
+     * 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
      */
-    async SyncProxyOrganizationOperators(req, cb) {
-        return this.request("SyncProxyOrganizationOperators", req, cb);
+    async ChannelCreateFlowGroupByFiles(req, cb) {
+        return this.request("ChannelCreateFlowGroupByFiles", req, cb);
     }
     /**
      * 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。