tencentcloud-sdk-nodejs-essbasic 4.0.625 → 4.0.627

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

@@ -404,6 +404,60 @@ export interface BaseFlowInfo {
      */
     NeedCreateReview?: boolean;
 }
+/**
+ * 解除协议的签署人，如不指定，默认使用待解除流程（即原流程）中的签署人。
+注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该签署人。
+
+如果需要指定B端（机构身份类型）签署人，其中ReleasedApprover需要传递的参数如下：
+ApproverNumber, OrganizationName, ApproverType必传。
+对于其他身份标识
+- 子客企业指定经办人：OpenId必传，OrganizationOpenId必传；
+- 非子客企业：Name、Mobile必传。
+ */
+export interface ReleasedApprover {
+    /**
+     * 企业签署方工商营业执照上的企业名称，签署方为非发起方企业场景下必传，最大长度64个字符
+     */
+    OrganizationName: string;
+    /**
+     * 签署人在原流程中的签署人列表中的顺序序号（从0开始，按顺序依次递增），如果不清楚原流程中的签署人列表，可以通过DescribeFlows接口查看
+     */
+    ApproverNumber: number;
+    /**
+     * 签署人类型，目前仅支持
+  ORGANIZATION-企业
+  ENTERPRISESERVER-企业静默签
+     */
+    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;
+}
 /**
  * CreateConsoleLoginUrl返回参数结构体
  */
@@ -906,24 +960,29 @@ export interface DescribeFlowDetailInfoResponse {
     RequestId?: string;
 }
 /**
- * 资源链接信息
+ * 参与方填写控件信息
  */
-export interface ResourceUrlInfo {
+export interface RecipientComponentInfo {
     /**
-     * 资源链接地址，过期时间5分钟
+     * 参与方Id
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    Url: string;
+    RecipientId?: string;
     /**
-     * 资源名称
+     * 参与方填写状态
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    Name: string;
+    RecipientFillStatus?: string;
     /**
-     * 资源类型
+     * 是否发起方
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    Type: string;
+    IsPromoter?: boolean;
+    /**
+     * 填写控件内容
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Components?: Array<FilledComponent>;
 }
 /**
  * ChannelDescribeRoles请求参数结构体
@@ -1867,18 +1926,9 @@ export interface TaskInfo {
     TaskStatus: string;
 }
 /**
- * DescribeUsage返回参数结构体
+ * ChannelCreateBoundFlows返回参数结构体
  */
-export interface DescribeUsageResponse {
-    /**
-     * 用量明细条数
-     */
-    Total?: number;
-    /**
-     * 用量明细
-  注意：此字段可能返回 null，表示取不到有效值。
-     */
-    Details?: Array<UsageDetail>;
+export interface ChannelCreateBoundFlowsResponse {
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -1937,6 +1987,26 @@ export interface Staff {
      */
     QuiteJob: number;
 }
+/**
+ * 资源链接信息
+ */
+export interface ResourceUrlInfo {
+    /**
+     * 资源链接地址，过期时间5分钟
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Url: string;
+    /**
+     * 资源名称
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Name: string;
+    /**
+     * 资源类型
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Type: string;
+}
 /**
  * ChannelCreateBoundFlows请求参数结构体
  */
@@ -2515,58 +2585,34 @@ export interface Filter {
     Values: Array<string>;
 }
 /**
- * 解除协议的签署人，如不指定，默认使用待解除流程（即原流程）中的签署人。
-注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该签署人。
-
-如果需要指定B端（机构身份类型）签署人，其中ReleasedApprover需要传递的参数如下：
-ApproverNumber, OrganizationName, ApproverType必传。
-对于其他身份标识
-- 子客企业指定经办人：OpenId必传，OrganizationOpenId必传；
-- 非子客企业：Name、Mobile必传。
+ * 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
  */
-export interface ReleasedApprover {
+export interface FilledComponent {
     /**
-     * 企业签署方工商营业执照上的企业名称，签署方为非发起方企业场景下必传，最大长度64个字符
-     */
-    OrganizationName: string;
-    /**
-     * 签署人在原流程中的签署人列表中的顺序序号（从0开始，按顺序依次递增），如果不清楚原流程中的签署人列表，可以通过DescribeFlows接口查看
-     */
-    ApproverNumber: number;
-    /**
-     * 签署人类型，目前仅支持
-  ORGANIZATION-企业
-  ENTERPRISESERVER-企业静默签
-     */
-    ApproverType: string;
-    /**
-     * 签署人姓名，最大长度50个字符
-     */
-    Name?: string;
-    /**
-     * 签署人身份证件类型
-  1.ID_CARD 居民身份证
-  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
-  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
+     * 控件Id
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    IdCardType?: string;
+    ComponentId?: string;
     /**
-     * 签署人证件号
+     * 控件名称
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    IdCardNumber?: string;
+    ComponentName?: string;
     /**
-     * 签署人手机号，脱敏显示。大陆手机号为11位，暂不支持海外手机号
+     * 控件填写状态；0-未填写；1-已填写
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Mobile?: string;
+    ComponentFillStatus?: string;
     /**
-     * 企业签署方在同一第三方应用下的其他合作企业OpenId，签署方为非发起方企业场景下必传，最大长度64个字符
+     * 控件填写内容
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    OrganizationOpenId?: string;
+    ComponentValue?: string;
     /**
-     * 用户侧第三方id，最大长度64个字符
-  当签署方为同一第三方应用下的员工时，该字必传
+     * 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    OpenId?: string;
+    ImageUrl?: string;
 }
 /**
  * CreateSignUrls返回参数结构体
@@ -2794,6 +2840,20 @@ export interface ChannelCreateReleaseFlowRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * ChannelDescribeFlowComponents返回参数结构体
+ */
+export interface ChannelDescribeFlowComponentsResponse {
+    /**
+     * 流程关联的填写控件信息
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    RecipientComponentInfos?: Array<RecipientComponentInfo>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ChannelCreateFlowGroupByFiles返回参数结构体
  */
@@ -2839,15 +2899,6 @@ export interface ApproverOption {
      */
     HideOneKeySign?: boolean;
 }
-/**
- * ChannelCreateBoundFlows返回参数结构体
- */
-export interface ChannelCreateBoundFlowsResponse {
-    /**
-     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-     */
-    RequestId?: string;
-}
 /**
  * 合作企业经办人列表信息
  */
@@ -3075,7 +3126,38 @@ export interface Component {
      */
     ComponentPosY?: number;
     /**
-     * 参数控件样式，json格式表述
+     * 扩展参数：
+  为JSON格式。
+  
+  ComponentType为FILL_IMAGE时，支持以下参数：
+  NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中
+  FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放
+  
+  ComponentType为SIGN_SIGNATURE类型可以控制签署方式
+  {“ComponentTypeLimit”: [“xxx”]}
+  xxx可以为：
+  HANDWRITE – 手写签名
+  OCR_ESIGN -- AI智能识别手写签名
+  ESIGN -- 个人印章类型
+  SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
+  如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
+  
+  ComponentType为SIGN_DATE时，支持以下参数：
+  1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"
+  2 FontSize： 数字类型，范围6-72，默认值为12
+  3 FontAlign： 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
+  4 Format： 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
+  5 Gaps:： 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数
+  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
+  特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
+  参数样例：    "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}"
+  
+  ComponentType为SIGN_SEAL类型时，支持以下参数：
+  1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）
+  参数样例： "ComponentExtra":"{\"PageRanges\":[\"PageRange\":{\"BeginPage\":1,\"EndPage\":-1}]}"
+  
+  
+  参数控件样式，json格式表述
   
   不同类型的控件会有部分非通用参数
   
@@ -3107,7 +3189,11 @@ export interface Component {
   5 Gaps:： 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙钟的空格个数
   如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
   特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
-  参数样例：    "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
+  参数样例：    "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}"
+  
+  ComponentType为SIGN_SEAL类型时，支持以下参数：
+  1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）
+  参数样例： "ComponentExtra":"{\"PageRanges\":[\"PageRange\":{\"BeginPage\":1,\"EndPage\":-1}]}"
      */
     ComponentExtra?: string;
     /**
@@ -3554,6 +3640,24 @@ export interface CreateFlowsByTemplatesRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * DescribeUsage返回参数结构体
+ */
+export interface DescribeUsageResponse {
+    /**
+     * 用量明细条数
+     */
+    Total?: number;
+    /**
+     * 用量明细
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Details?: Array<UsageDetail>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 用量明细
  */
@@ -3860,3 +3964,16 @@ export interface CcInfo {
      */
     CcPermission?: number;
 }
+/**
+ * ChannelDescribeFlowComponents请求参数结构体
+ */
+export interface ChannelDescribeFlowComponentsRequest {
+    /**
+     * 应用相关信息
+     */
+    Agent: Agent;
+    /**
+     * 电子签流程的Id
+     */
+    FlowId: string;
+}