tencentcloud-sdk-nodejs-essbasic 4.0.259 → 4.0.263

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

@@ -63,6 +63,10 @@ export interface FlowApproverInfo {
      * 用户侧第三方id
      */
     OpenId?: string;
+    /**
+     * 合同的强制预览时间：3~300s，未指定则按合同页数计算
+     */
+    PreReadTime?: number;
 }
 /**
  * PrepareFlows返回参数结构体
@@ -77,6 +81,35 @@ export interface PrepareFlowsResponse {
      */
     RequestId?: string;
 }
+/**
+ * 合作企业经办人列表信息
+ */
+export interface ProxyOrganizationOperator {
+    /**
+     * 经办人ID（渠道颁发）
+     */
+    Id: string;
+    /**
+     * 经办人姓名
+     */
+    Name?: string;
+    /**
+        * 经办人身份证件类型
+  用户证件类型：默认ID_CARD
+  1. ID_CARD - 居民身份证
+  2. HOUSEHOLD_REGISTER - 户口本
+  3. TEMP_ID_CARD - 临时居民身份证
+        */
+    IdCardType?: string;
+    /**
+     * 经办人身份证号
+     */
+    IdCardNumber?: string;
+    /**
+     * 经办人手机号
+     */
+    Mobile?: string;
+}
 /**
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
  */
@@ -117,6 +150,23 @@ export interface TemplateInfo {
      * 模板中的流程参与人信息
      */
     Recipients: Array<Recipient>;
+    /**
+     * 是否是发起人
+     */
+    IsPromoter: boolean;
+}
+/**
+ * GetDownloadFlowUrl返回参数结构体
+ */
+export interface GetDownloadFlowUrlResponse {
+    /**
+     * 进入合同（流程）下载确认页面链接
+     */
+    DownLoadUrl: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
 }
 /**
  * DescribeResourceUrlsByFlows返回参数结构体
@@ -136,6 +186,43 @@ 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返回参数结构体
  */
@@ -150,25 +237,43 @@ export interface DescribeTemplatesResponse {
     RequestId?: string;
 }
 /**
- * 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;
 }
 /**
  * CreateSignUrls请求参数结构体
@@ -195,6 +300,36 @@ export interface CreateSignUrlsRequest {
      */
     JumpUrl?: string;
 }
+/**
+ * 授权出错信息
+ */
+export interface AuthFailMessage {
+    /**
+     * 合作企业Id
+     */
+    ProxyOrganizationOpenId: string;
+    /**
+     * 出错信息
+     */
+    Message: string;
+}
+/**
+ * DescribeFlowDetailInfo请求参数结构体
+ */
+export interface DescribeFlowDetailInfoRequest {
+    /**
+     * 应用信息
+     */
+    Agent: Agent;
+    /**
+     * 合同(流程)编号数组
+     */
+    FlowIds: Array<string>;
+    /**
+     * 操作者的信息
+     */
+    Operator?: UserInfo;
+}
 /**
  * DescribeResourceUrlsByFlows请求参数结构体
  */
@@ -311,71 +446,63 @@ export interface Component {
     ComponentDescription?: string;
 }
 /**
- * 签署链接内容
+ * GetDownloadFlowUrl请求参数结构体
  */
-export interface SignUrlInfo {
+export interface GetDownloadFlowUrlRequest {
     /**
-        * 签署链接
-  注意：此字段可能返回 null，表示取不到有效值。
+        * 应用信息
+  此接口Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
         */
-    SignUrl: string;
+    Agent: Agent;
     /**
-        * 链接失效时间
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    Deadline: number;
+     * 操作者的信息
+     */
+    Operator?: UserInfo;
     /**
-        * 当流程为顺序签署此参数有效时，数字越小优先级越高，暂不支持并行签署 可选
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    SignOrder: number;
+     * 文件夹数组，合同（流程）总数不能超过50个，一个文件夹下，不能超过20个合同（流程），
+     */
+    DownLoadFlows?: Array<DownloadFlowInfo>;
+}
+/**
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
+ */
+export interface FlowDetailInfo {
     /**
-        * 签署人编号
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    SignId: string;
+     * 合同(流程)的Id
+     */
+    FlowId: string;
     /**
-        * 自定义用户编号
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    CustomUserId: string;
+     * 合同(流程)的名字
+     */
+    FlowName: string;
     /**
-        * 用户姓名
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    Name: string;
+     * 合同(流程)的类型
+     */
+    FlowType: string;
     /**
-        * 用户手机号码
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    Mobile: string;
+     * 合同(流程)的状态
+     */
+    FlowStatus: string;
     /**
-        * 签署参与者机构名字
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    OrganizationName: string;
+     * 合同(流程)的信息
+     */
+    FlowMessage: string;
     /**
-        * 参与者类型:
-  ORGANIZATION 企业经办人
-  PERSON 自然人
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    ApproverType: string;
+     * 合同(流程)的创建时间戳
+     */
+    CreateOn: number;
     /**
-        * 经办人身份证号
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    IdCardNumber: string;
+     * 合同(流程)的签署截止时间戳
+     */
+    DeadLine: number;
     /**
-        * 签署链接对应流程Id
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    FlowId: string;
+     * 用户自定义数据
+     */
+    CustomData: string;
     /**
-        * 企业经办人 用户在渠道的编号
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    OpenId: string;
+     * 合同(流程)的签署人数组
+     */
+    FlowApproverInfos: Array<FlowApproverDetail>;
 }
 /**
  * CreateConsoleLoginUrl请求参数结构体
@@ -434,33 +561,25 @@ export interface CreateFlowsByTemplatesResponse {
     RequestId?: string;
 }
 /**
- * 合作企业经办人列表信息
+ * 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;
 }
 /**
  * SyncProxyOrganizationOperators返回参数结构体
@@ -483,6 +602,73 @@ export interface SyncProxyOrganizationOperatorsResponse {
      */
     RequestId?: string;
 }
+/**
+ * 签署链接内容
+ */
+export interface SignUrlInfo {
+    /**
+        * 签署链接
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    SignUrl: string;
+    /**
+        * 链接失效时间
+  注意：此字段可能返回 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;
+}
 /**
  * 流程对应资源链接信息
  */
@@ -515,6 +701,27 @@ export interface DescribeTemplatesRequest {
      */
     TemplateId?: string;
 }
+/**
+ * SyncProxyOrganizationOperators请求参数结构体
+ */
+export interface SyncProxyOrganizationOperatorsRequest {
+    /**
+     * 操作类型，新增:"CREATE"，修改:"UPDATE"，离职:"RESIGN"
+     */
+    OperatorType: string;
+    /**
+     * 应用信息
+     */
+    Agent: Agent;
+    /**
+     * 经办人信息列表
+     */
+    ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
+    /**
+     * 操作者的信息
+     */
+    Operator?: UserInfo;
+}
 /**
  * CreateConsoleLoginUrl返回参数结构体
  */
@@ -576,27 +783,6 @@ export interface SyncProxyOrganizationRequest {
      */
     Operator?: UserInfo;
 }
-/**
- * PrepareFlows请求参数结构体
- */
-export interface PrepareFlowsRequest {
-    /**
-     * 渠道应用相关信息
-     */
-    Agent: Agent;
-    /**
-     * 多个合同（流程）信息
-     */
-    FlowInfos: Array<FlowInfo>;
-    /**
-     * 操作完成后的跳转地址
-     */
-    JumpUrl: string;
-    /**
-     * 操作者的信息
-     */
-    Operator?: UserInfo;
-}
 /**
  * 用量明细
  */
@@ -637,6 +823,48 @@ 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>;
+}
 /**
  * 同步经办人失败原因
  */
@@ -689,41 +917,13 @@ export interface DescribeUsageRequest {
     Offset?: number;
 }
 /**
- * 签署参与者信息
+ * 抄送信息
  */
-export interface Recipient {
-    /**
-     * 签署人唯一标识
-     */
-    RecipientId?: string;
-    /**
-     * 签署方类型：ENTERPRISE-企业INDIVIDUAL-自然人
-     */
-    RecipientType?: string;
-    /**
-     * 描述
-     */
-    Description?: string;
+export interface CcInfo {
     /**
-     * 签署方备注信息
-     */
-    RoleName?: string;
-    /**
-     * 是否需要校验
-     */
-    RequireValidation?: boolean;
-    /**
-     * 是否必须填写
+     * 被抄送人手机号
      */
-    RequireSign?: boolean;
-    /**
-     * 签署类型
-     */
-    SignType?: number;
-    /**
-     * 签署顺序：数字越小优先级越高
-     */
-    RoutingOrder?: number;
+    Mobile?: string;
 }
 /**
  * 应用相关信息
@@ -769,6 +969,60 @@ export interface FormField {
         */
     ComponentName?: string;
 }
+/**
+ * 签署人的流程信息明细
+ */
+export interface FlowApproverDetail {
+    /**
+     * 模板配置时候的签署人id,与控件绑定
+     */
+    ReceiptId: string;
+    /**
+        * 渠道侧企业的第三方id
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ProxyOrganizationOpenId: string;
+    /**
+     * 渠道侧企业操作人的第三方id
+     */
+    ProxyOperatorOpenId: string;
+    /**
+     * 渠道侧企业名称
+     */
+    ProxyOrganizationName: string;
+    /**
+     * 签署人手机号
+     */
+    Mobile: string;
+    /**
+     * 签署人签署顺序
+     */
+    SignOrder: number;
+    /**
+        * 签署人姓名
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ApproveName: string;
+    /**
+        * 当前签署人的状态
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ApproveStatus: string;
+    /**
+        * 签署人信息
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ApproveMessage: string;
+    /**
+     * 签署人签署时间
+     */
+    ApproveTime: number;
+    /**
+        * 参与者类型 (ORGANIZATION企业/PERSON个人)
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ApproveType: string;
+}
 /**
  * 此结构体 (FlowInfo) 用于描述流程信息。
  */
@@ -813,6 +1067,10 @@ export interface FlowInfo {
      * 渠道的业务信息，限制1024字符
      */
     CustomerData?: string;
+    /**
+     * 被抄送人的信息列表
+     */
+    CcInfos?: Array<CcInfo>;
 }
 /**
  * 接口调用者信息
@@ -857,3 +1115,25 @@ export interface DescribeUsageResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeFlowDetailInfo返回参数结构体
+ */
+export interface DescribeFlowDetailInfoResponse {
+    /**
+     * 渠道侧应用号Id
+     */
+    ApplicationId: string;
+    /**
+     * 渠道侧企业第三方Id
+     */
+    ProxyOrganizationOpenId: string;
+    /**
+        * 合同(流程)的具体详细描述信息
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    FlowInfo: Array<FlowDetailInfo>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}