tencentcloud-sdk-nodejs-ess 4.0.681 → 4.0.682

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

@@ -308,11 +308,11 @@ export interface ModifyApplicationCallbackInfoResponse {
  */
 export interface CreateMultiFlowSignQRCodeResponse {
     /**
-     * 签署二维码对象
+     * 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
      */
     QrCode?: SignQrCode;
     /**
-     * 签署链接对象
+     * 流程签署二维码的签署信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
      */
     SignUrls?: SignUrl;
     /**
@@ -377,18 +377,18 @@ export interface DescribeThirdPartyAuthCodeResponse {
     RequestId?: string;
 }
 /**
- * 被授权用户信息
+ * 被授权的用户信息
  */
 export interface HasAuthUser {
     /**
-     * 用户id
+     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     UserId?: string;
     /**
-     * 用户归属
-  MainOrg：主企业
-  CurrentOrg：当前企业
+     * 当前员工的归属情况，可能值是：
+  MainOrg：在集团企业的场景下，返回此值代表是归属主企业
+  CurrentOrg：在普通企业场景下返回此值；或者在集团企业的场景下，返回此值代表归属子企业
   注意：此字段可能返回 null，表示取不到有效值。
      */
     BelongTo?: string;
@@ -600,13 +600,10 @@ export interface CreateFlowEvidenceReportRequest {
  */
 export interface StartFlowResponse {
     /**
-     * 发起成功之后返回状态，
-  
-  START-发起成功，
-  
-  REVIEW-提交审核成功，
-  
-  EXECUTING-已提交发起任务
+     * 发起成功后返回的状态，根据合同流程的不同，返回不同状态：
+  START - 发起成功
+  REVIEW - 提交审核成功
+  EXECUTING - 已提交发起任务
      */
     Status?: string;
     /**
@@ -888,6 +885,11 @@ export interface FlowApproverDetail {
   注意：此字段可能返回 null，表示取不到有效值。
      */
     OrganizationName?: string;
+    /**
+     * 签署参与人在本流程中的编号ID（每个流程不同），可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    SignId?: string;
 }
 /**
  * CreateFlowGroupByFiles请求参数结构体
@@ -951,11 +953,11 @@ export interface DescribeFlowEvidenceReportResponse {
     RequestId?: string;
 }
 /**
- * 应用回调信息
+ * 企业应用回调信息
  */
 export interface CallbackInfo {
     /**
-     * 回调url
+     * 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。
      */
     CallbackUrl: string;
     /**
@@ -964,11 +966,11 @@ export interface CallbackInfo {
      */
     Token?: string;
     /**
-     * 回调加密key
+     * 回调加密key，用于回调消息加解密。
      */
     CallbackKey?: string;
     /**
-     * 回调验签token
+     * 回调验签token，用于回调通知校验。
      */
     CallbackToken?: string;
 }
@@ -1270,65 +1272,69 @@ export interface CreateFlowRequest {
  */
 export interface CreateSchemeUrlRequest {
     /**
-     * 调用方用户信息，userId 必填
+     * 执行本接口操作的员工信息, userId 必填。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
      */
     Operator: UserInfo;
     /**
-     * 企业名称
+     * 合同流程签署方的组织机构名称。
+  如果名称中包含英文括号()，请使用中文括号（）代替。
      */
     OrganizationName?: string;
     /**
-     * 姓名,最大长度50个字符
+     * 合同流程里边签署方经办人的姓名。
+  
      */
     Name?: string;
     /**
-     * 手机号，大陆手机号11位
+     * 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
      */
     Mobile?: string;
     /**
      * 要跳转的链接类型
   
-  - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  (默认)，此时返回长链
-  - HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
-  - APP： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型
-  
+  <ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li>
+  <li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li>
+  <li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li></ul>
      */
     EndPoint?: string;
     /**
-     * 签署流程编号 (PathType=1时必传)
+     * 合同流程ID
+  注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传,   跳转其他页面可不传`
      */
     FlowId?: string;
     /**
-     * 合同组ID
+     * 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
      */
     FlowGroupId?: string;
     /**
      * 要跳转到的页面类型
   
-  - 0: 不传, 主页 (默认)
-  - 1: 小程序合同详情
-  - 2: 小程序合同列表页
-  
+  <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
+  <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
+  <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
      */
     PathType?: number;
     /**
-     * 是否自动回跳
-  true：是，
-  false：否。
-  该参数只针对"APP" 类型的签署链接有效
+     * 签署完成后是否自动回跳
+  <ul><li>**false**：否, 签署完成不会自动跳转回来(默认)</li><li>**true**：是, 签署完成会自动跳转回来</li></ul>
+  注:  ` 该参数只针对"APP" 类型的签署链接有效`
      */
     AutoJumpBack?: boolean;
     /**
-     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     * 代理企业和员工的信息。
+  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
      */
     Agent?: Agent;
     /**
-     * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
+     * 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
   
-  - 0:合同签署页面更多操作按钮
-  - 1:合同签署页面更多操作的拒绝签署按钮
-  - 2:合同签署页面更多操作的转他人处理按钮
-  - 3:签署成功页的查看详情按钮
+  <ul><li> **0** :合同签署页面更多操作按钮</li>
+  <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
+  <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
+  <li> **3** :签署成功页的查看详情按钮</li></ul>
+  
+  注:  `字段为数组, 可以传值隐藏多个按钮`
      */
     Hides?: Array<number | bigint>;
 }
@@ -1927,21 +1933,22 @@ export interface UserThreeFactor {
     IdCardNumber: string;
 }
 /**
- * 一码多扫签署二维码对象
+ * 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
  */
 export interface SignQrCode {
     /**
-     * 二维码id
+     * 二维码ID，为32位字符串。
      */
-    QrCodeId: string;
+    QrCodeId?: string;
     /**
-     * 二维码url
+     * 二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
      */
-    QrCodeUrl: string;
+    QrCodeUrl?: string;
     /**
-     * 二维码过期时间戳，单位秒
+     * 二维码的有截止时间，格式为Unix标准时间戳（秒）。
+  一旦超过二维码的有效期限，该二维码将自动失效。
      */
-    ExpiredTime: number;
+    ExpiredTime?: number;
 }
 /**
  * CreateSealPolicy返回参数结构体
@@ -2105,7 +2112,11 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
  */
 export interface CreateSchemeUrlResponse {
     /**
-     * 小程序链接地址，有效期90天。如果EndPoint是App，得到的链接Path如’weixin://dl/business/?t= *TICKET*‘，用于客户APP、小程序直接拉起电子签小程序；其他EndPoint得到的https链接如'https://essurl.cn/xxx'，点击链接会打开一个H5页面，然后拉起电子签小程序。
+     * 腾讯电子签小程序的签署链接。
+  
+  <ul><li>如果EndPoint是**APP**，得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
+  <li>如果EndPoint是**HTTP**，得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`，点击后会跳转到腾讯电子签小程序进行签署</li>
+  <li>如果EndPoint是**HTTP_SHORT_URL**，得到的链接类似于 `https://essurl.cn/2n**42Nd`，点击后会跳转到腾讯电子签小程序进行签署</li></ul>
      */
     SchemeUrl?: string;
     /**
@@ -4397,19 +4408,23 @@ export interface WebThemeConfig {
  */
 export interface ModifyApplicationCallbackInfoRequest {
     /**
-     * 调用方用户信息，userId 必填
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
      */
     Operator: UserInfo;
     /**
-     * 操作类型：1-新增，2-删除
+     * 操作类型：
+  1-新增
+  2-删除
      */
     OperateType: number;
     /**
-     * 回调信息
+     * 企业应用回调信息
      */
     CallbackInfo: CallbackInfo;
     /**
-     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     * 代理企业和员工的信息。
+  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
      */
     Agent?: Agent;
 }
@@ -4438,27 +4453,29 @@ export interface IntegrationMainOrganizationUser {
  */
 export interface StartFlowRequest {
     /**
-     * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
      */
     Operator: UserInfo;
     /**
-     * 签署流程编号，由CreateFlow接口返回
+     * 合同流程ID，为32位字符串。
+  此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
      */
     FlowId: string;
     /**
      * 客户端Token，保持接口幂等性,最大长度64个字符
+     * @deprecated
      */
     ClientToken?: string;
     /**
-     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     * 代理企业和员工的信息。
+  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
      */
     Agent?: Agent;
     /**
-     * 给关注人发送短信通知的类型，
-  
-  0-合同发起时通知
-  
-  1-签署完成后通知
+     * 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
+  0 - 合同发起时通知（默认）
+  1 - 签署完成后通知
      */
     CcNotifyType?: number;
 }
@@ -5041,22 +5058,26 @@ export interface IntegrationDepartment {
  */
 export interface DescribeExtendedServiceAuthInfosRequest {
     /**
-     * 操作人信息
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
      */
     Operator: UserInfo;
     /**
-     * 代理相关应用信息，如集团主企业代子企业操作
+     * 要查询的扩展服务类型。
+  默认为空，即查询当前支持的所有扩展服务信息。
+  若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+  <ul><li>OPEN_SERVER_SIGN：企业静默签署</li>
+  <li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
+  <li>MOBILE_CHECK_APPROVER：使用手机号验证签署方身份</li>
+  <li>PAGING_SEAL：骑缝章</li>
+  <li>BATCH_SIGN：批量签署</li></ul>
      */
-    Agent?: Agent;
+    ExtendServiceType?: string;
     /**
-     * 扩展服务类型，默认为空，查询目前支持的所有扩展服务信息，单个指定则查询单个扩展服务开通信息，取值：
-  OPEN_SERVER_SIGN：开通企业静默签署
-  OVERSEA_SIGN：企业与港澳台居民签署合同
-  MOBILE_CHECK_APPROVER：使用手机号验证签署方身份
-  PAGING_SEAL：骑缝章
-  BATCH_SIGN：批量签署
+     * 代理企业和员工的信息。
+  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
      */
-    ExtendServiceType?: string;
+    Agent?: Agent;
 }
 /**
  * DescribeIntegrationRoles返回参数结构体
@@ -5164,21 +5185,24 @@ export interface CreateFlowGroupByTemplatesRequest {
     FlowGroupOptions?: FlowGroupOptions;
 }
 /**
- * 一码多扫签署二维码签署信息
+ * 流程签署二维码的签署信息，适用于客户系统整合二维码功能。
+通过链接，用户可直接访问电子签名小程序并签署合同。
  */
 export interface SignUrl {
     /**
-     * 小程序签署链接
+     * 跳转至电子签名小程序签署的链接地址。
+  适用于客户端APP及小程序直接唤起电子签名小程序。
      */
-    AppSignUrl: string;
+    AppSignUrl?: string;
     /**
-     * 签署链接有效时间
+     * 签署链接有效时间，格式类似"2022-08-05 15:55:01"
      */
-    EffectiveTime: string;
+    EffectiveTime?: string;
     /**
-     * 移动端签署链接
+     * 跳转至电子签名小程序签署的链接地址，格式类似于https://essurl.cn/xxx。
+  打开此链接将会展示H5中间页面，随后唤起电子签名小程序以进行合同签署。
      */
-    HttpSignUrl: string;
+    HttpSignUrl?: string;
 }
 /**
  * VerifyPdf返回参数结构体
@@ -5326,39 +5350,40 @@ export interface UploadFilesRequest {
     FileUrls?: string;
 }
 /**
- * 授权服务信息
+ * 扩展服务开通和授权的详细信息
  */
 export interface ExtendAuthInfo {
     /**
-     * 授权服务类型
-  OPEN_SERVER_SIGN：开通企业静默签署
-  OVERSEA_SIGN：企业与港澳台居民签署合同
-  MOBILE_CHECK_APPROVER：使用手机号验证签署方身份
-  PAGING_SEAL：骑缝章
-  BATCH_SIGN：批量签署
+     * 扩展服务的类型，可能是以下值：
+  <ul><li>OPEN_SERVER_SIGN：企业静默签署</li>
+  <li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
+  <li>MOBILE_CHECK_APPROVER：使用手机号验证签署方身份</li>
+  <li>PAGING_SEAL：骑缝章</li>
+  <li>BATCH_SIGN：批量签署</li></ul>
      */
     Type?: string;
     /**
-     * 授权服务名称
+     * 扩展服务的名称
      */
     Name?: string;
     /**
-     * 授权服务状态，ENABLE：开通
+     * 扩展服务的开通状态：
+  ENABLE：开通
   DISABLE：未开通
      */
     Status?: string;
     /**
-     * 授权人用户id
+     * 操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     OperatorUserId?: string;
     /**
-     * 授权时间戳，单位秒
+     * 扩展服务的操作时间，格式为Unix标准时间戳（秒）。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     OperateOn?: number;
     /**
-     * 被授权用户列表
+     * 该扩展服务若可以授权，此参数对应授权人员的列表
   注意：此字段可能返回 null，表示取不到有效值。
      */
     HasAuthUserList?: Array<HasAuthUser>;
@@ -5435,40 +5460,45 @@ export interface CreateBatchCancelFlowUrlRequest {
  */
 export interface CreateMultiFlowSignQRCodeRequest {
     /**
-     * 用户信息，其中UserId为必填参数
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
      */
     Operator: UserInfo;
     /**
-     * 模板ID
+     * 合同模板ID，为32位字符串。
+  可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
      */
     TemplateId: string;
     /**
-     * 签署流程名称，最大长度不超过200字符
+     * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
+  该名称还将用于合同签署完成后的下载文件名。
      */
     FlowName: string;
     /**
-     * 最大可发起签署流程份数，默认5份
-  <br/>发起流程数量超过此上限后二维码自动失效
+     * 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。
+  一旦发起流程数超越该限制，该二维码将自动失效。
      */
     MaxFlowNum?: number;
     /**
-     * 签署流程有效天数
-  <br/>默认7天
-  <br/>最高设置不超过30天
+     * 二维码的有效期限，默认为7天，最高设定不得超过90天。
+  一旦超过二维码的有效期限，该二维码将自动失效。
      */
-    FlowEffectiveDay?: number;
+    QrEffectiveDay?: number;
     /**
-     * 二维码有效天数 默认7天 最高设置不超过90天
+     * 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。
+  若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。
+  最长设定期限不得超过30天。
      */
-    QrEffectiveDay?: number;
+    FlowEffectiveDay?: number;
     /**
-     * 指定的签署人信息
-  <br/>指定后，则只允许指定的签署人扫码签署
+     * 指定签署人信息。
+  在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
      */
     Restrictions?: Array<ApproverRestriction>;
     /**
-     * 用户自定义字段
-  <br/>回调的时候会进行透传，长度需要小于20480
+     * 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
+  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
+  回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
      */
     UserData?: string;
     /**
@@ -5480,7 +5510,8 @@ export interface CreateMultiFlowSignQRCodeRequest {
      */
     CallbackUrl?: string;
     /**
-     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     * 代理企业和员工的信息。
+  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
      */
     Agent?: Agent;
     /**
@@ -5736,7 +5767,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
  */
 export interface DescribeExtendedServiceAuthInfosResponse {
     /**
-     * 授权服务信息列表
+     * 服务开通和授权的信息列表，根据查询类型返回所有支持的扩展服务开通和授权状况，或者返回特定扩展服务的开通和授权状况。
      */
     AuthInfoList?: Array<ExtendAuthInfo>;
     /**