tencentcloud-sdk-nodejs-ess 4.0.387 → 4.0.397

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -128,22 +128,22 @@ export interface CreateDocumentResponse {
  * StartFlow请求参数结构体
  */
 export interface StartFlowRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
     /**
      * 签署流程编号，由CreateFlow接口返回
      */
     FlowId: string;
     /**
-     * 用户信息
+     * 客户端Token，保持接口幂等性,最大长度64个字符
      */
-    Operator: UserInfo;
+    ClientToken?: string;
     /**
      * 应用相关信息
      */
     Agent?: Agent;
-    /**
-     * 客户端Token，保持接口幂等性,最大长度64个字符
-     */
-    ClientToken?: string;
 }
 /**
  * CancelFlow返回参数结构体
@@ -158,6 +158,10 @@ export interface CancelFlowResponse {
  * CreateDocument请求参数结构体
  */
 export interface CreateDocumentRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
     /**
      * 签署流程编号,由CreateFlow接口返回
      */
@@ -170,14 +174,6 @@ export interface CreateDocumentRequest {
      * 文件名列表,单个文件名最大长度200个字符
      */
     FileNames: Array<string>;
-    /**
-     * 无
-     */
-    Operator: UserInfo;
-    /**
-     * 应用相关信息
-     */
-    Agent?: Agent;
     /**
      * 内容控件信息数组
      */
@@ -191,11 +187,19 @@ export interface CreateDocumentRequest {
      * 客户端Token，保持接口幂等性,最大长度64个字符
      */
     ClientToken?: string;
+    /**
+     * 应用相关信息
+     */
+    Agent?: Agent;
 }
 /**
  * CreateFlow请求参数结构体
  */
 export interface CreateFlowRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
     /**
      * 签署流程名称,最大长度200个字符
      */
@@ -205,29 +209,22 @@ export interface CreateFlowRequest {
      */
     Approvers: Array<FlowCreateApprover>;
     /**
-     * 操作人信息
+     * 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
      */
-    Operator: UserInfo;
+    FlowType?: string;
     /**
-     * 应用相关信息
+     * 客户端Token，保持接口幂等性,最大长度64个字符
      */
-    Agent?: Agent;
+    ClientToken?: string;
     /**
-        * 发送类型：
-  true：无序签
-  false：有序签
-  注：默认为false（有序签），请和模板中的配置保持一致
-        */
-    Unordered?: boolean;
+     * 暂未开放
+     */
+    CallbackUrl?: string;
     /**
         * 签署流程的签署截止时间。
   值为unix时间戳,精确到秒,不传默认为当前时间一年后
         */
     DeadLine?: number;
-    /**
-     * 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
-     */
-    FlowType?: string;
     /**
      * 用户自定义字段(需进行base64 encode),回调的时候会进行透传, 长度需要小于20480
      */
@@ -237,9 +234,12 @@ export interface CreateFlowRequest {
      */
     FlowDescription?: string;
     /**
-     * 客户端Token，保持接口幂等性,最大长度64个字符
-     */
-    ClientToken?: string;
+        * 发送类型：
+  true：无序签
+  false：有序签
+  注：默认为false（有序签），请和模板中的配置保持一致
+        */
+    Unordered?: boolean;
     /**
      * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
      */
@@ -249,29 +249,22 @@ export interface CreateFlowRequest {
      */
     RelatedFlowId?: string;
     /**
-     * 暂未开放
+     * 应用相关信息
      */
-    CallbackUrl?: string;
+    Agent?: Agent;
 }
 /**
  * CreateSchemeUrl请求参数结构体
  */
 export interface CreateSchemeUrlRequest {
     /**
-     * 调用方用户信息，参考通用结构
+     * 调用方用户信息，userId 必填
      */
     Operator: UserInfo;
     /**
-     * 应用相关信息
+     * 企业名称
      */
-    Agent?: Agent;
-    /**
-        * 链接类型
-  HTTP：跳转电子签小程序的http_url，
-  APP：第三方APP或小程序跳转电子签小程序的path。
-  默认为HTTP类型
-        */
-    EndPoint?: string;
+    OrganizationName?: string;
     /**
      * 姓名,最大长度50个字符
      */
@@ -281,9 +274,12 @@ export interface CreateSchemeUrlRequest {
      */
     Mobile?: string;
     /**
-     * 企业名称
-     */
-    OrganizationName?: string;
+        * 链接类型
+  HTTP：跳转电子签小程序的http_url，
+  APP：第三方APP或小程序跳转电子签小程序的path。
+  默认为HTTP类型
+        */
+    EndPoint?: string;
     /**
      * 签署流程编号 (PathType=1时必传)
      */
@@ -296,6 +292,10 @@ export interface CreateSchemeUrlRequest {
      * 是否自动回跳 true：是， false：否。该参数只针对"APP" 类型的签署链接有效
      */
     AutoJumpBack?: boolean;
+    /**
+     * 应用相关信息
+     */
+    Agent?: Agent;
 }
 /**
  * 下载文件的URL信息
@@ -337,6 +337,27 @@ export interface SignQrCode {
      */
     ExpiredTime: number;
 }
+/**
+ * GetTaskResultApi请求参数结构体
+ */
+export interface GetTaskResultApiRequest {
+    /**
+     * 任务Id
+     */
+    TaskId: string;
+    /**
+     * 企业信息
+     */
+    Organization?: OrganizationInfo;
+    /**
+     * 操作人信息
+     */
+    Operator?: UserInfo;
+    /**
+     * 渠道信息
+     */
+    Agent?: Agent;
+}
 /**
  * UploadFiles请求参数结构体
  */
@@ -380,6 +401,10 @@ export interface UploadFilesRequest {
  * CancelFlow请求参数结构体
  */
 export interface CancelFlowRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
     /**
      * 签署流程id
      */
@@ -388,10 +413,6 @@ export interface CancelFlowRequest {
      * 撤销原因，最长200个字符；
      */
     CancelMessage: string;
-    /**
-     * 操作用户id
-     */
-    Operator: UserInfo;
     /**
      * 应用相关信息
      */
@@ -416,13 +437,15 @@ export interface DescribeFlowBriefsResponse {
 export interface Component {
     /**
         * 如果是 Component 控件类型，则可选类型为：
-  TEXT - 内容文本控件
-  DATE - 内容日期控件
-  CHECK_BOX - 勾选框控件
+  TEXT - 单行文本
+  MULTI_LINE_TEXT - 多行文本
+  CHECK_BOX - 勾选框
+  ATTACHMENT - 附件
+  SELECTOR - 选择器
   如果是 SignComponent 控件类型，则可选类型为：
-  SIGN_SEAL - 签署印章控件
+  SIGN_SEAL - 签署印章控件，静默签署时需要传入印章id作为ComponentValue
   SIGN_DATE - 签署日期控件
-  SIGN_SIGNATURE - 手写签名控件
+  SIGN_SIGNATURE - 手写签名控件，静默签署时不能使用
         */
     ComponentType: string;
     /**
@@ -478,8 +501,13 @@ export interface Component {
      */
     ComponentRecipientId?: string;
     /**
-     * 控件所填写的内容
-     */
+        * 控件填充vaule，ComponentType和传入值类型对应关系：
+  TEXT - 文本内容
+  MULTI_LINE_TEXT - 文本内容
+  CHECK_BOX - true/false
+  ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
+  SELECTOR - 选项值
+        */
     ComponentValue?: string;
     /**
      * 是否是表单域类型，默认不存在
@@ -628,18 +656,43 @@ export interface CreateFlowByFilesResponse {
      */
     RequestId?: string;
 }
+/**
+ * 机构信息
+ */
+export interface OrganizationInfo {
+    /**
+     * 机构在平台的编号
+     */
+    OrganizationId?: string;
+    /**
+     * 用户渠道
+     */
+    Channel?: string;
+    /**
+     * 用户在渠道的机构编号
+     */
+    OrganizationOpenId?: string;
+    /**
+     * 用户真实的IP
+     */
+    ClientIp?: string;
+    /**
+     * 机构的代理IP
+     */
+    ProxyIp?: string;
+}
 /**
  * DescribeFlowBriefs请求参数结构体
  */
 export interface DescribeFlowBriefsRequest {
     /**
-     * 需要查询的流程ID列表
+     * 调用方用户信息，userId 必填
      */
-    FlowIds: Array<string>;
+    Operator: UserInfo;
     /**
-     * 操作人信息
+     * 需要查询的流程ID列表
      */
-    Operator: UserInfo;
+    FlowIds: Array<string>;
     /**
      * 应用相关信息
      */
@@ -702,6 +755,31 @@ export interface Recipient {
      */
     RecipientExtra?: string;
 }
+/**
+ * 用户信息
+ */
+export interface UserInfo {
+    /**
+     * 用户在平台的编号
+     */
+    UserId?: string;
+    /**
+     * 用户的来源渠道
+     */
+    Channel?: string;
+    /**
+     * 用户在渠道的编号
+     */
+    OpenId?: string;
+    /**
+     * 用户真实IP
+     */
+    ClientIp?: string;
+    /**
+     * 用户代理IP
+     */
+    ProxyIp?: string;
+}
 /**
  * DescribeFileUrls请求参数结构体
  */
@@ -777,7 +855,7 @@ export interface ApproverInfo {
      */
     ApproverMobile: string;
     /**
-     * 本环节操作人签署控件配置，为企业静默签署时，只允许类型为SIGN_SEAL（印章）和SIGN_DATE（日期）控件，并且传入印章编号。
+     * 本环节操作人签署控件配置
      */
     SignComponents: Array<Component>;
     /**
@@ -924,6 +1002,19 @@ export interface CreateMultiFlowSignQRCodeRequest {
      */
     QrEffectiveDay?: number;
 }
+/**
+ * CreateConvertTaskApi返回参数结构体
+ */
+export interface CreateConvertTaskApiResponse {
+    /**
+     * 转换任务Id
+     */
+    TaskId: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * StartFlow返回参数结构体
  */
@@ -937,6 +1028,35 @@ export interface StartFlowResponse {
      */
     RequestId?: string;
 }
+/**
+ * CreateConvertTaskApi请求参数结构体
+ */
+export interface CreateConvertTaskApiRequest {
+    /**
+     * 资源Id
+     */
+    ResourceId: string;
+    /**
+     * 资源类型 取值范围doc,docx,html之一
+     */
+    ResourceType: string;
+    /**
+     * 资源名称
+     */
+    ResourceName: string;
+    /**
+     * 无
+     */
+    Organization?: OrganizationInfo;
+    /**
+     * 无
+     */
+    Operator?: UserInfo;
+    /**
+     * 无
+     */
+    Agent?: Agent;
+}
 /**
  * CreateSchemeUrl返回参数结构体
  */
@@ -954,6 +1074,10 @@ export interface CreateSchemeUrlResponse {
  * CreateFlowByFiles请求参数结构体
  */
 export interface CreateFlowByFilesRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
     /**
      * 签署流程名称,最大长度200个字符
      */
@@ -967,34 +1091,18 @@ export interface CreateFlowByFilesRequest {
      */
     FileIds: Array<string>;
     /**
-     * 调用方用户信息
+     * 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
      */
-    Operator: UserInfo;
+    FlowType?: string;
     /**
-     * 应用号信息
+     * 经办人内容控件配置
      */
-    Agent?: Agent;
-    /**
-        * 经办人内容控件配置。可选类型为：
-  TEXT - 内容文本控件
-  MULTI_LINE_TEXT - 多行文本控件
-  CHECK_BOX - 勾选框控件
-  ATTACHMENT - 附件
-  注：默认字体大小为 字号12
-        */
     Components?: Array<Component>;
     /**
-        * 签署流程的签署截止时间。
-  值为unix时间戳,精确到秒,不传默认为当前时间一年后
-        */
-    Deadline?: number;
-    /**
-        * 发送类型：
-  true：无序签
-  false：有序签
-  注：默认为false（有序签）
+        * 被抄送人的信息列表。
+  注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
         */
-    Unordered?: boolean;
+    CcInfos?: Array<CcInfo>;
     /**
         * 是否需要预览，true：预览模式，false：非预览（默认）；
   预览链接有效期300秒；
@@ -1005,18 +1113,25 @@ export interface CreateFlowByFilesRequest {
      */
     FlowDescription?: string;
     /**
-     * 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
-     */
-    FlowType?: string;
+        * 签署流程的签署截止时间。
+  值为unix时间戳,精确到秒,不传默认为当前时间一年后
+        */
+    Deadline?: number;
     /**
-        * 被抄送人的信息列表。
-  注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
+        * 发送类型：
+  true：无序签
+  false：有序签
+  注：默认为false（有序签）
         */
-    CcInfos?: Array<CcInfo>;
+    Unordered?: boolean;
     /**
      * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
      */
     CustomShowMap?: string;
+    /**
+     * 应用号信息
+     */
+    Agent?: Agent;
 }
 /**
  * CancelMultiFlowSignQRCode返回参数结构体
@@ -1049,15 +1164,20 @@ export declare type Agent = null;
  */
 export interface FormField {
     /**
-     * 控件填充value
-     */
+        * 控件填充value，ComponentType和传入值类型对应关系：
+  TEXT - 文本内容
+  MULTI_LINE_TEXT - 文本内容
+  CHECK_BOX - true/false
+  ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
+  SELECTOR - 模板中配置的选项值
+        */
     ComponentValue: string;
     /**
-     * 控件id
+     * 控件id，和ComponentName选择一项传入即可
      */
     ComponentId?: string;
     /**
-     * 控件名字，最大长度不超过30字符
+     * 控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可
      */
     ComponentName?: string;
 }
@@ -1066,58 +1186,58 @@ export interface FormField {
  */
 export interface DescribeFlowTemplatesRequest {
     /**
-     * 操作人信息
+     * 调用方用户信息，userId 必填
      */
     Operator: UserInfo;
     /**
-     * 查询偏移位置，默认0
+     * 搜索条件，具体参考Filter结构体。本接口取值：template-id：按照【 **模板唯一标识** 】进行过滤
      */
-    Offset?: number;
+    Filters?: Array<Filter>;
     /**
      * 查询个数，默认20，最大100
      */
     Limit?: number;
     /**
-     * 搜索条件，具体参考Filter结构体。本接口取值：template-id：按照【 **模板唯一标识** 】进行过滤
+     * 查询偏移位置，默认0
      */
-    Filters?: Array<Filter>;
+    Offset?: number;
     /**
-     * 应用相关信息
+     * 查询内容：0-模板列表及详情（默认），1-仅模板列表
      */
-    Agent?: Agent;
+    ContentType?: number;
     /**
      * 暂未开放
      */
     GenerateSource?: number;
     /**
-     * 查询内容：0-模板列表及详情（默认），1-仅模板列表
+     * 应用相关信息
      */
-    ContentType?: number;
+    Agent?: Agent;
 }
 /**
- * 用户信息
+ * GetTaskResultApi返回参数结构体
  */
-export interface UserInfo {
+export interface GetTaskResultApiResponse {
     /**
-     * 用户在平台的编号
+     * 任务Id
      */
-    UserId?: string;
+    TaskId: string;
     /**
-     * 用户的来源渠道
+     * 任务状态
      */
-    Channel?: string;
+    TaskStatus: number;
     /**
-     * 用户在渠道的编号
+     * 状态描述
      */
-    OpenId?: string;
+    TaskMessage: string;
     /**
-     * 用户真实IP
+     * 资源Id
      */
-    ClientIp?: string;
+    ResourceId: string;
     /**
-     * 用户代理IP
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
-    ProxyIp?: string;
+    RequestId?: string;
 }
 /**
  * 流程信息摘要