tencentcloud-sdk-nodejs 4.0.686 → 4.0.688

package/src/services/ess/v20201111/ess_models.ts

@@ -136,7 +136,7 @@ export interface DescribeFlowEvidenceReportRequest {
    */
   Operator: UserInfo
   /**
-   * 签署报告编号
+   * 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
    */
   ReportId: string
   /**
@@ -977,11 +977,12 @@ export interface FlowApproverDetail {
  */
 export interface CreateFlowGroupByFilesRequest {
   /**
-   * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId 代发合同
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
-   * 合同（流程）组名称,最大长度200个字符
+   * 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
    */
   FlowGroupName: string
   /**
@@ -989,11 +990,17 @@ export interface CreateFlowGroupByFilesRequest {
    */
   FlowGroupInfos: Array<FlowGroupInfo>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 合同（流程）组的配置项信息。包括是否通知本企业签署方，是否通知其他签署方
+   * 合同（流程）组的配置项信息。
+其中包括：
+<ul>
+<li>是否通知本企业签署方</li>
+<li>是否通知其他签署方</li>
+</ul>
    */
   FlowGroupOptions?: FlowGroupOptions
 }
@@ -1018,17 +1025,16 @@ export interface DescribeFlowComponentsResponse {
  */
 export interface DescribeFlowEvidenceReportResponse {
   /**
-   * 出证报告PDF的下载 URL
+   * 出证报告PDF的下载 URL，`有效期为5分钟`，超过有效期后将无法再下载。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ReportUrl?: string
   /**
-   * 签署报告出证任务的状态
-<ul>
-<li>EvidenceStatusExecuting : 出证任务在执行中</li>
-<li>EvidenceStatusSuccess : 出证任务执行成功</li>
-<li>EvidenceStatusFailed : 出证任务执行失败</li>
-</ul>
+   * 出证任务执行的状态, 状态含义如下：
+
+<ul><li>**EvidenceStatusExecuting**：  出证任务在执行中</li>
+<li>**EvidenceStatusSuccess**：  出证任务执行成功</li>
+<li>**EvidenceStatusFailed** ： 出征任务执行失败</li></ul>
    */
   Status?: string
   /**
@@ -1526,8 +1532,7 @@ export interface AutoSignConfig {
    * 设置用户开通自动签时是否绑定个人自动签账号许可。
 
 <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
-<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
-
+</ul>
    */
   LicenseType?: number
 }
@@ -1865,9 +1870,7 @@ export interface DescribeUserAutoSignStatusResponse {
   /**
    * 设置用户开通自动签时是否绑定个人自动签账号许可。
 
-<ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
-<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
-
+<ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li></ul>
    */
   LicenseType?: number
   /**
@@ -2381,55 +2384,82 @@ export interface CreateUserAutoSignEnableUrlResponse {
  */
 export interface FlowGroupInfo {
   /**
-   * 合同（流程）的名称
+   * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
+该名称还将用于合同签署完成后的下载文件名。
    */
   FlowName: string
   /**
-   * 合同（流程）的签署方信息
+   * 签署流程参与者信息，最大限制50方
+注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
    */
   Approvers: Array<ApproverInfo>
   /**
-   * 发起合同（流程）的资源Id,此资源必须是PDF文件,来自UploadFiles,使用文件发起合同(流程)组时必传
+   * 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。
+建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
    */
   FileIds?: Array<string>
   /**
-   * 发起合同（流程）的模板Id,用模板发起合同（流程）组时必填
+   * 合同模板ID，为32位字符串。
+建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
+可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
    */
   TemplateId?: string
   /**
-   * 合同（流程）的类型
+   * 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
+示例值：劳务合同
    */
   FlowType?: string
   /**
-   * 合同（流程）的描述
+   * 签署流程描述,最大长度1000个字符
    */
   FlowDescription?: string
   /**
-   * 合同（流程）的截止时间戳，单位秒。默认是一年
+   * 签署流程的签署截止时间。
+
+值为unix时间戳,精确到秒,不传默认为当前时间一年后
+示例值：1604912664
    */
   Deadline?: number
   /**
    * 合同（流程）的回调地址
+   * @deprecated
    */
   CallbackUrl?: string
   /**
-   * 第三方平台传递过来的信息, 限制1024字符 格式必须是base64的
+   * 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
+在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
+回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
    */
   UserData?: string
   /**
-   * 合同（流程）的签署是否是无序签, true - 无序。 false - 有序, 默认
+   * 发送类型：
+true：无序签
+false：有序签
+注：默认为false（有序签），请和模板中的配置保持一致
+示例值：true
    */
   Unordered?: boolean
   /**
-   * 合同（流程）发起方的填写控件, 由发起方进行在发起时进行填充
+   * 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
+<ul><li>单行文本控件</li>
+<li>多行文本控件</li>
+<li>勾选框控件</li>
+<li>数字控件</li>
+<li>图片控件</li>
+<li>动态表格等填写控件</li></ul>
    */
   Components?: Array<Component>
   /**
-   * 本企业（发起方）是否需要签署审批，若需要审批则只允许查看不允许签署，需要您调用接口CreateFlowSignReview提交审批结果。
+   * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
+若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+
+注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+示例值：true
    */
   NeedSignReview?: boolean
   /**
-   * 本企业（发起方）自动签署，需要您在发起合同时给印章控件指定自动签的印章。
+   * 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+示例值：E_PRESCRIPTION_AUTO_SIGN
    */
   AutoSignScene?: string
 }
@@ -2723,20 +2753,6 @@ DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo
   ComponentName?: string
 }
 
-/**
- * CreateChannelSubOrganizationModifyQrCode请求参数结构体
- */
-export interface CreateChannelSubOrganizationModifyQrCodeRequest {
-  /**
-   * 操作人信息，userId必填
-   */
-  Operator: UserInfo
-  /**
-   * 应用编号
-   */
-  ApplicationId: string
-}
-
 /**
  * 用户信息
  */
@@ -3115,16 +3131,16 @@ export interface RecipientComponentInfo {
  */
 export interface CreateFlowEvidenceReportResponse {
   /**
-   * 出证报告 ID，可用于DescribeFlowEvidenceReport接口查询出证PDF的下载地址
+   * 出证报告 ID，可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ReportId?: string
   /**
-   * 出证任务执行的状态, 可能会有以下状态：
+   * 出证任务执行的状态, 状态含义如下：
 
-<ul><li>EvidenceStatusExecuting：  出证任务在执行中</li>
-<li>EvidenceStatusSuccess：  出证任务执行成功</li>
-<li>EvidenceStatusFailed ： 出征任务执行失败</li></ul>
+<ul><li>**EvidenceStatusExecuting**：  出证任务在执行中</li>
+<li>**EvidenceStatusSuccess**：  出证任务执行成功</li>
+<li>**EvidenceStatusFailed** ： 出征任务执行失败</li></ul>
    */
   Status?: string
   /**
@@ -3340,65 +3356,23 @@ export interface CreateDocumentRequest {
 }
 
 /**
- * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
+ * 催办接口返回的详细信息。
  */
-export interface FlowDetailInfo {
-  /**
-   * 合同(流程)的ID
-   */
-  FlowId?: string
-  /**
-   * 合同(流程)的名字
-   */
-  FlowName?: string
-  /**
-   * 合同(流程)的类型
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  FlowType?: string
-  /**
-   * 流程状态
-- 0 还没有发起
-- 1 待签署
-- 2 部分签署
-- 3 已拒签
-- 4 已签署
-- 5 已过期
-- 6 已撤销
-- 7 还没有预发起
-- 8 等待填写
-- 9 部分填写
-- 10 拒填
-- 21 已解除
-   */
-  FlowStatus?: number
-  /**
-   * 合同(流程)的信息
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  FlowMessage?: string
-  /**
-   * 流程的描述
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  FlowDescription?: string
-  /**
-   * 合同(流程)的创建时间戳，单位秒
-   */
-  CreatedOn?: number
+export interface RemindFlowRecords {
   /**
-   * 合同(流程)的签署方数组
+   * 合同流程是否可以催办：
+true - 可以，false - 不可以。
+若无法催办，将返回RemindMessage以解释原因。
    */
-  FlowApproverInfos?: Array<FlowApproverDetail>
+  CanRemind?: boolean
   /**
-   * 合同(流程)的关注方信息列表
+   * 合同流程ID，为32位字符串。
    */
-  CcInfos?: Array<FlowApproverDetail>
+  FlowId?: string
   /**
-   * 合同发起人UserId
-注意：此字段可能返回 null，表示取不到有效值。
+   * 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
    */
-  Creator?: string
+  RemindMessage?: string
 }
 
 /**
@@ -3438,7 +3412,8 @@ export interface DescribeOrganizationSealsResponse {
  */
 export interface CreateEmbedWebUrlRequest {
   /**
-   * 操作者信息
+   * 执行本接口操作的员工信息。
+<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
@@ -3463,7 +3438,8 @@ export interface CreateEmbedWebUrlRequest {
    */
   BusinessId?: string
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作
+   * 代理企业和员工的信息。
+<br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
@@ -3471,7 +3447,7 @@ export interface CreateEmbedWebUrlRequest {
    */
   Reviewer?: ReviewerInfo
   /**
-   * 个性化参数
+   * 个性化参数，用于控制页面展示内容
    */
   Option?: EmbedUrlOption
 }
@@ -3548,20 +3524,22 @@ export interface GetTaskResultApiRequest {
  */
 export interface FlowGroupOptions {
   /**
-   * 发起合同（流程）组的合同（流程）签署人校验方式
-VerifyCheck: 人脸识别（默认）
-MobileCheck：手机号验证
+   * 签署人校验方式,支持以下类型
+<ul><li>VerifyCheck : 人脸识别 (默认值)</li>
+<li>MobileCheck : 手机号验证</li></ul>
 参数说明：此参数仅在合同组文件发起有效，可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
    */
   ApproverVerifyType?: string
   /**
    * 发起合同（流程）组本方企业经办人通知方式
-签署通知类型：sms--短信，none--不通知
+签署通知类型，支持以下类型
+<ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
    */
   SelfOrganizationApproverNotifyType?: string
   /**
    * 发起合同（流程）组他方经办人通知方式
-签署通知类型：sms--短信，none--不通知
+签署通知类型，支持以下类型
+<ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
    */
   OtherApproverNotifyType?: string
 }
@@ -3916,21 +3894,65 @@ export interface CreateIntegrationUserRolesRequest {
 }
 
 /**
- * CreateChannelSubOrganizationModifyQrCode返回参数结构体
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
  */
-export interface CreateChannelSubOrganizationModifyQrCodeResponse {
+export interface FlowDetailInfo {
   /**
-   * 二维码下载链接
+   * 合同(流程)的ID
    */
-  QrCodeUrl?: string
+  FlowId?: string
   /**
-   * 二维码失效时间 UNIX 时间戳 精确到秒
+   * 合同(流程)的名字
    */
-  ExpiredTime?: number
+  FlowName?: string
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 合同(流程)的类型
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  RequestId?: string
+  FlowType?: string
+  /**
+   * 流程状态
+- 0 还没有发起
+- 1 待签署
+- 2 部分签署
+- 3 已拒签
+- 4 已签署
+- 5 已过期
+- 6 已撤销
+- 7 还没有预发起
+- 8 等待填写
+- 9 部分填写
+- 10 拒填
+- 21 已解除
+   */
+  FlowStatus?: number
+  /**
+   * 合同(流程)的信息
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  FlowMessage?: string
+  /**
+   * 流程的描述
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  FlowDescription?: string
+  /**
+   * 合同(流程)的创建时间戳，单位秒
+   */
+  CreatedOn?: number
+  /**
+   * 合同(流程)的签署方数组
+   */
+  FlowApproverInfos?: Array<FlowApproverDetail>
+  /**
+   * 合同(流程)的关注方信息列表
+   */
+  CcInfos?: Array<FlowApproverDetail>
+  /**
+   * 合同发起人UserId
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Creator?: string
 }
 
 /**
@@ -4429,11 +4451,11 @@ export interface CreateUserAutoSignEnableUrlRequest {
  */
 export interface CreateOrganizationBatchSignUrlResponse {
   /**
-   * 批量签署入口链接
+   * 批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
    */
   SignUrl?: string
   /**
-   * 链接过期时间戳
+   * 链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。
    */
   ExpiredTime?: number
   /**
@@ -4457,26 +4479,6 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
   RequestId?: string
 }
 
-/**
- * 催办接口返回的详细信息。
- */
-export interface RemindFlowRecords {
-  /**
-   * 合同流程是否可以催办：
-true - 可以，false - 不可以。
-若无法催办，将返回RemindMessage以解释原因。
-   */
-  CanRemind?: boolean
-  /**
-   * 合同流程ID，为32位字符串。
-   */
-  FlowId?: string
-  /**
-   * 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
-   */
-  RemindMessage?: string
-}
-
 /**
  * CancelUserAutoSignEnableUrl请求参数结构体
  */
@@ -4554,13 +4556,13 @@ export interface ApproverRestriction {
  */
 export interface CreateWebThemeConfigRequest {
   /**
-   * 操作人信息
+   * 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 主题类型
-<br/>EMBED_WEB_THEME：嵌入式主题
-<br/>目前只支持EMBED_WEB_THEME，web页面嵌入的主题风格配置
+   * 主题类型，取值如下：
+<ul><li> **EMBED_WEB_THEME**：嵌入式主题（默认），web页面嵌入的主题风格配置</li>
+</ul>
    */
   ThemeType: string
   /**
@@ -4568,7 +4570,8 @@ export interface CreateWebThemeConfigRequest {
    */
   WebThemeConfig: WebThemeConfig
   /**
-   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -4604,27 +4607,39 @@ export interface DeleteSealPoliciesRequest {
  */
 export interface CreateOrganizationBatchSignUrlRequest {
   /**
-   * 调用方用户信息，UserId 必填，支持填入集团子公司经办人UserId。
+   * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
+支持填入集团子公司经办人 userId 代发合同。
+
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 指定需要进行批量签署的流程id，数量1-100，填写后用户将通过链接对这些合同进行批量签署。
+   * 请指定需执行批量签署的流程ID，数量范围为1-100。
+您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。
+用户将利用链接对这些合同实施批量操作。
    */
   FlowIds: Array<string>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填。
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 员工的UserId，该UserId对应的员工必须已经加入企业并实名，Name和Mobile为空时该字段不能为空。（优先使用UserId对应的员工）
+   * 员工在腾讯电子签平台的独特身份标识，为32位字符串。
+您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。
+UserId必须是传入合同（FlowId）中的签署人。
+- 1. 若UserId为空，Name和Mobile 必须提供。
+- 2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。
    */
   UserId?: string
   /**
-   * 员工姓名，该字段需要与Mobile组合使用，UserId为空时该字段不能为空。（UserId为空时，使用Name和Mbile对应的员工）
+   * 员工姓名，必须与手机号码一起使用。
+如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
    */
   Name?: string
   /**
-   * 员工手机号码，该字段需要与Name组合使用，UserId为空时该字段不能为空。（UserId为空时，使用Name和Mbile对应的员工）
+   * 员工手机号，必须与姓名一起使用。
+ 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
    */
   Mobile?: string
 }
@@ -4766,15 +4781,15 @@ export interface DeleteIntegrationDepartmentRequest {
  */
 export interface WebThemeConfig {
   /**
-   * 是否页面底部显示电子签logo
-<br/>true：允许在页面底部隐藏电子签logo
-<br/>false：不允许允许在页面底部隐藏电子签logo
-<br/>默认false，不隐藏logo
+   * 是否显示页面底部电子签logo，取值如下：
+<ul><li> **true**：页面底部显示电子签logo</li>
+<li> **false**：页面底部不显示电子签logo（默认）</li></ul>
    */
   DisplaySignBrandLogo?: boolean
   /**
-   * 主题颜色
-<br/>支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
+   * 主题颜色：
+支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
+<br/>
    */
   WebEmbedThemeColor?: string
 }
@@ -4995,7 +5010,7 @@ export interface ApproverOption {
 export interface CreateEmbedWebUrlResponse {
   /**
    * 嵌入的web链接，有效期：5分钟
-EmbedType=PREVIEW_CC_FLOW，该url为h5链接
+<br/>EmbedType=PREVIEW_CC_FLOW，该url为h5链接
    */
   WebUrl?: string
   /**
@@ -5854,17 +5869,18 @@ export interface EmbedUrlOption {
  */
 export interface CreateBatchCancelFlowUrlRequest {
   /**
-   * 调用方用户信息，userId 必填
+   * 执行本接口操作的员工信息。
+<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
    * 需要执行撤回的流程(合同)的编号列表，最多100个.
-列表中的流程(合同)编号不要重复.
+<br>列表中的流程(合同)编号不要重复.
    */
   FlowIds: Array<string>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
-
+   * 代理企业和员工的信息。
+<br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }