tencentcloud-sdk-nodejs-essbasic 4.0.490 → 4.0.492

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

@@ -319,11 +319,11 @@ export interface CreateSealByImageRequest {
      */
     Agent: Agent;
     /**
-     * 印章名称，最大长度不超过30字符
+     * 印章名称，最大长度不超过50字符
      */
     SealName: string;
     /**
-     * 印章图片base64
+     * 印章图片base64，大小不超过10M（原始图片不超过7.6M）
      */
     SealImage: string;
     /**
@@ -480,23 +480,23 @@ export interface ChannelCreateFlowByFilesRequest {
  */
 export interface Agent {
     /**
-     * 腾讯电子签颁发给渠道的应用ID，32位字符串
+     * 应用的唯一标识。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
      */
     AppId: string;
     /**
-     * 渠道/平台合作企业的企业ID，最大64位字符串
+     * 渠道平台自定义，对于渠道子客企业的唯一标识。一个渠道子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要渠道平台保存），最大64位字符串
      */
     ProxyOrganizationOpenId?: string;
     /**
-     * 渠道/平台合作企业经办人（操作员）
+     * 渠道子客企业中的员工/经办人，通过渠道平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。
      */
     ProxyOperator?: UserInfo;
     /**
-     * 腾讯电子签颁发给渠道侧合作企业的应用ID
+     * 在子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。
      */
     ProxyAppId?: string;
     /**
-     * 内部参数，腾讯电子签颁发给渠道侧合作企业的企业ID，不需要传
+     * 内部参数，暂未开放使用
      */
     ProxyOrganizationId?: 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请求参数结构体
  */
@@ -756,14 +781,14 @@ export interface TemplateInfo {
      * 模板控件信息结构
      */
     Components: Array<Component>;
-    /**
-     * 签署区模板信息结构
-     */
-    SignComponents: Array<Component>;
     /**
      * 模板中的流程参与人信息
      */
     Recipients: Array<Recipient>;
+    /**
+     * 签署区模板信息结构
+     */
+    SignComponents: Array<Component>;
     /**
      * 模板类型：1-静默签；3-普通模板
      */
@@ -786,10 +811,14 @@ export interface TemplateInfo {
         */
     PreviewUrl: string;
     /**
-        * 渠道模板ID
+     * 渠道模板ID
+     */
+    ChannelTemplateId: string;
+    /**
+        * 渠道版-模板PDF文件链接
   注意：此字段可能返回 null，表示取不到有效值。
         */
-    ChannelTemplateId: string;
+    PdfUrl: string;
 }
 /**
  * GetDownloadFlowUrl返回参数结构体
@@ -1066,7 +1095,7 @@ export interface ChannelDescribeOrganizationSealsRequest {
      */
     Offset?: number;
     /**
-     * 查询信息类型，为0时不返回授权用户，为1时返回
+     * 查询信息类型，为1时返回授权用户，为其他值时不返回
      */
     InfoType?: number;
     /**
@@ -1079,7 +1108,7 @@ export interface ChannelDescribeOrganizationSealsRequest {
  */
 export interface ProxyOrganizationOperator {
     /**
-     * 经办人ID（渠道颁发），最大长度64个字符
+     * 对应Agent-ProxyOperator-OpenId。渠道平台自定义，对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工，不可在其他子客企业内重复使用。（比如，可以使用经办人企业名+员工身份证的hash值，需要渠道平台保存），最大64位字符串
      */
     Id: string;
     /**
@@ -1304,23 +1333,23 @@ export interface FlowInfo {
  */
 export interface UserInfo {
     /**
-     * 用户在渠道的编号，最大64位字符串
+     * 渠道平台自定义，对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工，不可在其他子客企业内重复使用。（例如，可以使用经办人企业名+员工身份证的hash值，需要渠道平台保存），最大64位字符串
      */
     OpenId?: string;
     /**
-     * 用户的来源渠道
+     * 内部参数，暂未开放使用
      */
     Channel?: string;
     /**
-     * 自定义用户编号
+     * 内部参数，暂未开放使用
      */
     CustomUserId?: string;
     /**
-     * 用户真实IP
+     * 内部参数，暂未开放使用
      */
     ClientIp?: string;
     /**
-     * 用户代理IP
+     * 内部参数，暂未开放使用
      */
     ProxyIp?: string;
 }
@@ -1420,7 +1449,7 @@ export interface ChannelCreateBoundFlowsRequest {
      */
     FlowIds?: Array<string>;
     /**
-     * 操作者的信息
+     * 暂未开放
      */
     Operator?: UserInfo;
 }
@@ -1895,6 +1924,59 @@ 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请求参数结构体
  */
@@ -2073,6 +2155,39 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
      */
     RequestId?: string;
 }
+/**
+ * ChannelCreateReleaseFlow请求参数结构体
+ */
+export interface ChannelCreateReleaseFlowRequest {
+    /**
+     * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     */
+    Agent: Agent;
+    /**
+     * 待解除的流程编号（即原流程的编号）
+     */
+    NeedRelievedFlowId: string;
+    /**
+     * 解除协议内容
+     */
+    ReliveInfo: RelieveInfo;
+    /**
+     * 非必须，解除协议的本企业签署人列表，默认使用原流程的签署人列表；当解除协议的签署人与原流程的签署人不能相同时（例如原流程签署人离职了），需要指定本企业的其他签署人来替换原流程中的原签署人，注意需要指明ApproverNumber来代表需要替换哪一个签署人，解除协议的签署人数量不能多于原流程的签署人数量
+     */
+    ReleasedApprovers?: Array<ReleasedApprover>;
+    /**
+     * 签署完回调url，最大长度1000个字符
+     */
+    CallbackUrl?: string;
+    /**
+     * 机构信息
+     */
+    Organization?: OrganizationInfo;
+    /**
+     * 用户信息
+     */
+    Operator?: UserInfo;
+}
 /**
  * ChannelCreateFlowGroupByFiles返回参数结构体
  */
@@ -2472,6 +2587,10 @@ export interface DescribeTemplatesRequest {
      * 是否获取模板预览链接
      */
     WithPreviewUrl?: boolean;
+    /**
+     * 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。
+     */
+    WithPdfUrl?: boolean;
 }
 /**
  * 持有的电子印章信息
@@ -2700,6 +2819,19 @@ export interface ChannelDescribeEmployeesResponse {
      */
     RequestId?: string;
 }
+/**
+ * ChannelCreateReleaseFlow返回参数结构体
+ */
+export interface ChannelCreateReleaseFlowResponse {
+    /**
+     * 解除协议流程编号
+     */
+    FlowId: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeChannelFlowEvidenceReport返回参数结构体
  */