tencentcloud-sdk-nodejs-essbasic 4.0.489 → 4.0.491

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

@@ -383,7 +383,7 @@ export interface ChannelCreateConvertTaskApiRequest {
      */
     Agent: Agent;
     /**
-     * 资源类型 取值范围doc,docx,html,excel之一
+     * 资源类型 取值范围doc,docx,html,xls,xlsx之一
      */
     ResourceType: string;
     /**
@@ -554,6 +554,31 @@ export interface FlowApproverDetail {
         */
     ApproveType: string;
 }
+/**
+ * 解除协议文档中内容信息，包括但不限于：解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
+ */
+export interface RelieveInfo {
+    /**
+     * 解除理由，最大支持200个字
+     */
+    Reason: string;
+    /**
+     * 解除后仍然有效的条款，保留条款，最大支持200个字
+     */
+    RemainInForceItem?: string;
+    /**
+     * 原合同事项处理-费用结算，最大支持200个字
+     */
+    OriginalExpenseSettlement?: string;
+    /**
+     * 原合同事项处理-其他事项，最大支持200个字
+     */
+    OriginalOtherSettlement?: string;
+    /**
+     * 其他约定，最大支持200个字
+     */
+    OtherDeals?: string;
+}
 /**
  * ChannelCreateFlowGroupByFiles请求参数结构体
  */
@@ -576,19 +601,36 @@ export interface ChannelCreateFlowGroupByFilesRequest {
     Operator?: UserInfo;
 }
 /**
- * 复杂文档合成任务的任务信息
+ * DescribeFlowDetailInfo返回参数结构体
  */
-export interface TaskInfo {
+export interface DescribeFlowDetailInfoResponse {
     /**
-        * 合成任务Id，可以通过 ChannelGetTaskResultApi 接口获取任务信息
+     * 渠道侧应用号Id
+     */
+    ApplicationId: string;
+    /**
+     * 渠道侧企业第三方Id
+     */
+    ProxyOrganizationOpenId: string;
+    /**
+        * 合同(签署流程)的具体详细描述信息
   注意：此字段可能返回 null，表示取不到有效值。
         */
-    TaskId: string;
+    FlowInfo: Array<FlowDetailInfo>;
     /**
-        * 任务状态：READY - 任务已完成；NOTREADY - 任务未完成；
+        * 合同组编号
   注意：此字段可能返回 null，表示取不到有效值。
         */
-    TaskStatus: string;
+    FlowGroupId: string;
+    /**
+        * 合同组名称
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    FlowGroupName: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
 }
 /**
  * 资源链接信息
@@ -844,6 +886,23 @@ export interface ChannelVerifyPdfRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * CreateChannelFlowEvidenceReport请求参数结构体
+ */
+export interface CreateChannelFlowEvidenceReportRequest {
+    /**
+     * 签署流程编号
+     */
+    FlowId: string;
+    /**
+     * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
+     */
+    Agent: Agent;
+    /**
+     * 操作者的信息
+     */
+    Operator?: UserInfo;
+}
 /**
  * ChannelVerifyPdf返回参数结构体
  */
@@ -1032,7 +1091,7 @@ export interface ChannelDescribeOrganizationSealsRequest {
      */
     Offset?: number;
     /**
-     * 查询信息类型，为0时不返回授权用户，为1时返回
+     * 查询信息类型，为1时返回授权用户，为其他值时不返回
      */
     InfoType?: number;
     /**
@@ -1041,40 +1100,32 @@ export interface ChannelDescribeOrganizationSealsRequest {
     SealId?: string;
 }
 /**
- * DescribeUsage请求参数结构体
+ * 合作企业经办人列表信息
  */
-export interface DescribeUsageRequest {
+export interface ProxyOrganizationOperator {
     /**
-     * 应用信息
+     * 经办人ID（渠道颁发），最大长度64个字符
      */
-    Agent: Agent;
+    Id: string;
     /**
-     * 开始时间，例如：2021-03-21
+     * 经办人姓名，最大长度50个字符
      */
-    StartDate: string;
-    /**
-        * 结束时间，例如：2021-06-21；
-  开始时间到结束时间的区间长度小于等于90天。
-        */
-    EndDate: string;
+    Name?: string;
     /**
-        * 是否汇总数据，默认不汇总。
-  不汇总：返回在统计区间内渠道下所有企业的每日明细，即每个企业N条数据，N为统计天数；
-  汇总：返回在统计区间内渠道下所有企业的汇总后数据，即每个企业一条数据；
+        * 经办人身份证件类型
+  1.ID_CARD 居民身份证
+  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
+  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
         */
-    NeedAggregate?: boolean;
-    /**
-     * 单次返回的最多条目数量。默认为1000，且不能超过1000。
-     */
-    Limit?: number;
+    IdCardType?: string;
     /**
-     * 偏移量，默认是0。
+     * 经办人证件号
      */
-    Offset?: number;
+    IdCardNumber?: string;
     /**
-     * 操作者的信息
+     * 经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
      */
-    Operator?: UserInfo;
+    Mobile?: string;
 }
 /**
  * 此结构 (FormField) 用于描述内容控件填充结构。
@@ -1299,36 +1350,19 @@ export interface UserInfo {
     ProxyIp?: string;
 }
 /**
- * DescribeFlowDetailInfo返回参数结构体
+ * 复杂文档合成任务的任务信息
  */
-export interface DescribeFlowDetailInfoResponse {
-    /**
-     * 渠道侧应用号Id
-     */
-    ApplicationId: string;
-    /**
-     * 渠道侧企业第三方Id
-     */
-    ProxyOrganizationOpenId: string;
-    /**
-        * 合同(签署流程)的具体详细描述信息
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    FlowInfo: Array<FlowDetailInfo>;
+export interface TaskInfo {
     /**
-        * 合同组编号
+        * 合成任务Id，可以通过 ChannelGetTaskResultApi 接口获取任务信息
   注意：此字段可能返回 null，表示取不到有效值。
         */
-    FlowGroupId: string;
+    TaskId: string;
     /**
-        * 合同组名称
+        * 任务状态：READY - 任务已完成；NOTREADY - 任务未完成；
   注意：此字段可能返回 null，表示取不到有效值。
         */
-    FlowGroupName: string;
-    /**
-     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-     */
-    RequestId?: string;
+    TaskStatus: string;
 }
 /**
  * DescribeUsage返回参数结构体
@@ -1886,6 +1920,95 @@ export interface Filter {
      */
     Values: Array<string>;
 }
+/**
+ * 解除协议的签署人，如不指定，默认使用待解除流程（即原流程）中的签署人。
+注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该签署人。
+
+如果需要指定B端（机构身份类型）签署人，其中ReleasedApprover需要传递的参数如下：
+ApproverNumber, OrganizationName, ApproverType必传。
+对于其他身份标识
+- 渠道子客企业指定经办人：OpenId必传，OrganizationOpenId必传；
+- 非渠道合作企业：Name、Mobile必传。
+ */
+export interface ReleasedApprover {
+    /**
+     * 企业签署方工商营业执照上的企业名称，签署方为非发起方企业场景下必传，最大长度64个字符
+     */
+    OrganizationName: string;
+    /**
+     * 签署人在原流程中的签署人列表中的顺序序号（从0开始，按顺序依次递增），如果不清楚原流程中的签署人列表，可以通过DescribeFlows接口查看
+     */
+    ApproverNumber: number;
+    /**
+        * 签署人类型，目前仅支持
+  ORGANIZATION-企业
+        */
+    ApproverType: string;
+    /**
+     * 签署人姓名，最大长度50个字符
+     */
+    Name?: string;
+    /**
+        * 签署人身份证件类型
+  1.ID_CARD 居民身份证
+  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
+  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
+        */
+    IdCardType?: string;
+    /**
+     * 签署人证件号
+     */
+    IdCardNumber?: string;
+    /**
+     * 签署人手机号，脱敏显示。大陆手机号为11位，暂不支持海外手机号
+     */
+    Mobile?: string;
+    /**
+     * 企业签署方在同一渠道下的其他合作企业OpenId，签署方为非发起方企业场景下必传，最大长度64个字符
+     */
+    OrganizationOpenId?: string;
+    /**
+        * 用户侧第三方id，最大长度64个字符
+  当签署方为同一渠道下的员工时，该字必传
+        */
+    OpenId?: string;
+}
+/**
+ * DescribeUsage请求参数结构体
+ */
+export interface DescribeUsageRequest {
+    /**
+     * 应用信息
+     */
+    Agent: Agent;
+    /**
+     * 开始时间，例如：2021-03-21
+     */
+    StartDate: string;
+    /**
+        * 结束时间，例如：2021-06-21；
+  开始时间到结束时间的区间长度小于等于90天。
+        */
+    EndDate: string;
+    /**
+        * 是否汇总数据，默认不汇总。
+  不汇总：返回在统计区间内渠道下所有企业的每日明细，即每个企业N条数据，N为统计天数；
+  汇总：返回在统计区间内渠道下所有企业的汇总后数据，即每个企业一条数据；
+        */
+    NeedAggregate?: boolean;
+    /**
+     * 单次返回的最多条目数量。默认为1000，且不能超过1000。
+     */
+    Limit?: number;
+    /**
+     * 偏移量，默认是0。
+     */
+    Offset?: number;
+    /**
+     * 操作者的信息
+     */
+    Operator?: UserInfo;
+}
 /**
  * CreateSignUrls返回参数结构体
  */
@@ -1963,32 +2086,21 @@ export interface ApproverRestriction {
     IdCardNumber?: string;
 }
 /**
- * 合作企业经办人列表信息
+ * DescribeChannelFlowEvidenceReport请求参数结构体
  */
-export interface ProxyOrganizationOperator {
+export interface DescribeChannelFlowEvidenceReportRequest {
     /**
-     * 经办人ID（渠道颁发），最大长度64个字符
+     * 出证报告编号
      */
-    Id: string;
-    /**
-     * 经办人姓名，最大长度50个字符
-     */
-    Name?: string;
+    ReportId: string;
     /**
-        * 经办人身份证件类型
-  1.ID_CARD 居民身份证
-  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
-  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
-        */
-    IdCardType?: string;
-    /**
-     * 经办人证件号
+     * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
      */
-    IdCardNumber?: string;
+    Agent: Agent;
     /**
-     * 经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
+     * 操作者的信息
      */
-    Mobile?: string;
+    Operator?: UserInfo;
 }
 /**
  * ChannelCreateFlowByFiles返回参数结构体
@@ -2039,6 +2151,39 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
      */
     RequestId?: string;
 }
+/**
+ * ChannelCreateReleaseFlow请求参数结构体
+ */
+export interface ChannelCreateReleaseFlowRequest {
+    /**
+     * 待解除的流程编号（即原流程的编号）
+     */
+    NeedRelievedFlowId: string;
+    /**
+     * 解除协议内容
+     */
+    ReliveInfo: RelieveInfo;
+    /**
+     * 应用相关信息
+     */
+    Agent: Agent;
+    /**
+     * 非必须，解除协议的本企业签署人列表，默认使用原流程的签署人列表；当解除协议的签署人与原流程的签署人不能相同时（比如原流程签署人离职了），需要指定本企业的其他签署人来替换原流程中的原签署人，注意需要指明ApproverNumber来代表需要替换哪一个签署人，解除协议的签署人数量不能多于原流程的签署人数量
+     */
+    ReleasedApprovers?: Array<ReleasedApprover>;
+    /**
+     * 签署完回调url，最大长度1000个字符
+     */
+    CallbackUrl?: string;
+    /**
+     * 机构信息
+     */
+    Organization?: OrganizationInfo;
+    /**
+     * 用户信息
+     */
+    Operator?: UserInfo;
+}
 /**
  * ChannelCreateFlowGroupByFiles返回参数结构体
  */
@@ -2084,6 +2229,15 @@ export interface ApproverOption {
      */
     HideOneKeySign?: boolean;
 }
+/**
+ * ChannelCreateBoundFlows返回参数结构体
+ */
+export interface ChannelCreateBoundFlowsResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ChannelGetTaskResultApi返回参数结构体
  */
@@ -2590,6 +2744,31 @@ export interface OperateChannelTemplateRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * CreateChannelFlowEvidenceReport返回参数结构体
+ */
+export interface CreateChannelFlowEvidenceReportResponse {
+    /**
+        * 废除，字段无效
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ReportUrl: string;
+    /**
+        * 出证报告 ID
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ReportId: string;
+    /**
+        * 执行中：EvidenceStatusExecuting
+  成功：EvidenceStatusSuccess
+  失败：EvidenceStatusFailed
+        */
+    Status: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 同步经办人失败原因
  */
@@ -2633,9 +2812,33 @@ export interface ChannelDescribeEmployeesResponse {
     RequestId?: string;
 }
 /**
- * ChannelCreateBoundFlows返回参数结构体
+ * ChannelCreateReleaseFlow返回参数结构体
  */
-export interface ChannelCreateBoundFlowsResponse {
+export interface ChannelCreateReleaseFlowResponse {
+    /**
+     * 解除协议流程编号
+     */
+    FlowId: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * DescribeChannelFlowEvidenceReport返回参数结构体
+ */
+export interface DescribeChannelFlowEvidenceReportResponse {
+    /**
+        * 出证报告 URL
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ReportUrl: string;
+    /**
+        * 执行中：EvidenceStatusExecuting
+  成功：EvidenceStatusSuccess
+  失败：EvidenceStatusFailed
+        */
+    Status: string;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */