tencentcloud-sdk-nodejs 4.0.727 → 4.0.728

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

@@ -35,89 +35,82 @@ export interface DescribePersonCertificateResponse {
 export interface BillUsageDetail {
   /**
    * 合同流程ID，为32位字符串。
-建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowId?: string
   /**
    * 合同经办人名称
 如果有多个经办人用分号隔开。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   OperatorName?: string
   /**
    * 发起方组织机构名称
-注意：此字段可能返回 null，表示取不到有效值。
    */
   CreateOrganizationName?: string
   /**
-   * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
-该名称还将用于合同签署完成后的下载文件名。
-注意：此字段可能返回 null，表示取不到有效值。
+   * 合同流程的名称。
    */
   FlowName?: string
   /**
    * 当前合同状态,如下是状态码对应的状态。
-0-还没有发起
-1-等待签署
-2-部分签署 
-3-拒签
-4-已签署 
-5-已过期 
-6-已撤销 
-7-还没有预发起
-8-等待填写
-9-部分填写 
-10-拒填
-11-已解除
-注意：此字段可能返回 null，表示取不到有效值。
+<ul>
+<li>**0**: 还没有发起</li>
+<li>**1**: 等待签署</li>
+<li>**2**: 部分签署 </li>
+<li>**3**: 拒签</li>
+<li>**4**: 已签署 </li>
+<li>**5**: 已过期 </li>
+<li>**6**: 已撤销 </li>
+<li>**7**: 还没有预发起</li>
+<li>**8**: 等待填写</li>
+<li>**9**: 部分填写 </li>
+<li>**10**: 拒填</li>
+<li>**11**: 已解除</li>
+</ul>
    */
   Status?: number
   /**
-   * 套餐类型
-对应关系如下
-CloudEnterprise-企业版合同
-SingleSignature-单方签章
-CloudProve-签署报告
-CloudOnlineSign-腾讯会议在线签约
-ChannelWeCard-微工卡
-SignFlow-合同套餐
-SignFace-签署意愿（人脸识别）
-SignPassword-签署意愿（密码）
-SignSMS-签署意愿（短信）
-PersonalEssAuth-签署人实名（腾讯电子签认证）
-PersonalThirdAuth-签署人实名（信任第三方认证）
-OrgEssAuth-签署企业实名
-FlowNotify-短信通知
-AuthService-企业工商信息查询
-注意：此字段可能返回 null，表示取不到有效值。
+   * 查询的套餐类型
+对应关系如下:
+<ul>
+<li>**CloudEnterprise**: 企业版合同</li>
+<li>**SingleSignature**: 单方签章</li>
+<li>**CloudProve**: 签署报告</li>
+<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
+<li>**ChannelWeCard**: 微工卡</li>
+<li>**SignFlow**: 合同套餐</li>
+<li>**SignFace**: 签署意愿（人脸识别）</li>
+<li>**SignPassword**: 签署意愿（密码）</li>
+<li>**SignSMS**: 签署意愿（短信）</li>
+<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
+<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
+<li>**OrgEssAuth**: 签署企业实名</li>
+<li>**FlowNotify**: 短信通知</li>
+<li>**AuthService**: 企业工商信息查询</li>
+</ul>
    */
   QuotaType?: string
   /**
    * 合同使用量
-注意：此字段可能返回 null，表示取不到有效值。
+注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量`
    */
   UseCount?: number
   /**
    * 消耗的时间戳，格式为Unix标准时间戳（秒）。
-注意：此字段可能返回 null，表示取不到有效值。
    */
   CostTime?: number
   /**
    * 消耗的套餐名称
-注意：此字段可能返回 null，表示取不到有效值。
    */
   QuotaName?: string
   /**
    * 消耗类型
-1.扣费 2.撤销返还
-注意：此字段可能返回 null，表示取不到有效值。
+   **1**.扣费
+   **2**.撤销返还
    */
   CostType?: number
   /**
    * 备注
-注意：此字段可能返回 null，表示取不到有效值。
    */
   Remark?: string
 }
@@ -6448,21 +6441,23 @@ export interface DescribeBillUsageDetailRequest {
   Limit?: number
   /**
    * 查询的套餐类型 （选填 ）不传则查询所有套餐；
-对应关系如下
-CloudEnterprise-企业版合同
-SingleSignature-单方签章
-CloudProve-签署报告
-CloudOnlineSign-腾讯会议在线签约
-ChannelWeCard-微工卡
-SignFlow-合同套餐
-SignFace-签署意愿（人脸识别）
-SignPassword-签署意愿（密码）
-SignSMS-签署意愿（短信）
-PersonalEssAuth-签署人实名（腾讯电子签认证）
-PersonalThirdAuth-签署人实名（信任第三方认证）
-OrgEssAuth-签署企业实名
-FlowNotify-短信通知
-AuthService-企业工商信息查询
+目前支持:
+<ul>
+<li>**CloudEnterprise**: 企业版合同</li>
+<li>**SingleSignature**: 单方签章</li>
+<li>**CloudProve**: 签署报告</li>
+<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
+<li>**ChannelWeCard**: 微工卡</li>
+<li>**SignFlow**: 合同套餐</li>
+<li>**SignFace**: 签署意愿（人脸识别）</li>
+<li>**SignPassword**: 签署意愿（密码）</li>
+<li>**SignSMS**: 签署意愿（短信）</li>
+<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
+<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
+<li>**OrgEssAuth**: 签署企业实名</li>
+<li>**FlowNotify**: 短信通知</li>
+<li>**AuthService**: 企业工商信息查询</li>
+</ul>
    */
   QuotaType?: string
   /**

package/src/services/essbasic/v20210526/essbasic_client.ts

@@ -72,6 +72,7 @@ import {
   RecipientComponentInfo,
   ChannelDescribeRolesRequest,
   PrepareFlowsResponse,
+  ChannelCancelFlowRequest,
   TemplateInfo,
   ChannelCreateOrganizationBatchSignUrlRequest,
   GetDownloadFlowUrlResponse,
@@ -82,6 +83,7 @@ import {
   StaffRole,
   ChannelVerifyPdfRequest,
   CreateChannelFlowEvidenceReportRequest,
+  ChannelDescribeBillUsageDetailRequest,
   ChannelCancelUserAutoSignEnableUrlRequest,
   Permission,
   DescribeTemplatesRequest,
@@ -124,8 +126,9 @@ import {
   FlowApproverInfo,
   ChannelCreateUserAutoSignEnableUrlResponse,
   ChannelGetTaskResultApiRequest,
-  FillError,
   ChannelCreatePreparedPersonalEsignRequest,
+  FillError,
+  ChannelDescribeBillUsageDetailResponse,
   FlowDetailInfo,
   CreateFlowsByTemplatesResponse,
   DescribeChannelFlowEvidenceReportRequest,
@@ -158,6 +161,7 @@ import {
   ChannelCreateFlowGroupByFilesResponse,
   ChannelCreateMultiFlowSignQRCodeResponse,
   ApproverOption,
+  ChannelDescribeUserAutoSignStatusResponse,
   ProxyOrganizationOperator,
   ModifyExtendedServiceResponse,
   ChannelCreateUserRolesRequest,
@@ -175,7 +179,7 @@ import {
   ChannelUpdateSealStatusRequest,
   ChannelCreateFlowGroupByTemplatesRequest,
   SignUrl,
-  ChannelCancelFlowRequest,
+  ChannelBillUsageDetail,
   DescribeBillUsageDetailRequest,
   RelieveInfo,
   ChannelCreateSealPolicyRequest,
@@ -190,12 +194,11 @@ import {
   CreateChannelFlowEvidenceReportResponse,
   SyncFailReason,
   ChannelDescribeEmployeesResponse,
-  ChannelCreateFlowApproversRequest,
   ChannelDeleteRoleResponse,
   ChannelCreateReleaseFlowResponse,
   DescribeChannelFlowEvidenceReportResponse,
   CreateSealByImageRequest,
-  ChannelDescribeUserAutoSignStatusResponse,
+  ChannelCreateFlowApproversRequest,
   ChannelUpdateSealStatusResponse,
   ChannelCreateFlowSignUrlRequest,
   DescribeExtendedServiceAuthInfoResponse,
@@ -275,21 +278,21 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
 
   /**
      * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 
-适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
-常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
-
-**本接口适用于发起方没有填写控件的 B2C或者单C模板**
-
-**若是B2C模板,还要满足以下任意一个条件**
 
-- 模板中配置的签署顺序是无序
-- B端企业的签署方式是静默签署
-- B端企业是非首位签署
+**适用场景**:
+签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
-通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+**注意**:
+1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**,  若是B2C模板,还要满足以下任意一个条件
+    - 模板中配置的签署顺序是无序
+    - B端企业的签署方式是静默签署
+    - B端企业是非首位签署
+2. 通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
 ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
+3. 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
 
-用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
+二维码的样式如下图:
+![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
      */
   async ChannelCreateMultiFlowSignQRCode(
     req: ChannelCreateMultiFlowSignQRCodeRequest,
@@ -452,8 +455,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   }
 
   /**
-     * 此接口（DescribeUsage）用于获取第三方平台所有合作企业流量消耗情况。
- 注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
+     * 此接口（DescribeUsage）用于获取此应用下子客企业的合同消耗数量。
+
+注: 此接口**每日限频50次**，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
      */
   async DescribeUsage(
     req: DescribeUsageRequest,
@@ -645,6 +649,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
 ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
 
 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
+
 ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
 
 
@@ -847,8 +852,26 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-   * 此接口（ChannelCreateBoundFlows）用于子客领取合同，经办人需要有相应的角色，合同不能重复领取。
-   */
+     * 此接口（ChannelCreateBoundFlows）用于子客企业领取未归属给员工的合同，将合同领取给当前员工，合同不能重复领取。
+
+
+**未归属合同发起方式**
+ 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等),  则合同进入待领取状态, 示例代码如下
+```
+		FlowApprovers: []*essbasic.FlowApproverInfo{
+			{
+				ApproverType:       common.StringPtr("ORGANIZATION"),
+				OrganizationOpenId: common.StringPtr("org_dianziqian"),
+				OrganizationName:   common.StringPtr("典子谦示例企业"),
+			}
+		},
+```
+
+可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
+![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
+
+注: `支持批量领取,  如果有一个合同流程无法领取会导致接口报错,  使得所有合同都领取失败`
+     */
   async ChannelCreateBoundFlows(
     req: ChannelCreateBoundFlowsRequest,
     cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void
@@ -991,8 +1014,8 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 
 注:
 <ul>
-<li>仅支持下载 **本企业** 下合同，链接会 **登录企业控制台** </li>
-<li> **链接仅可使用一次**，不可重复使用</li>
+<li>仅支持下载 <b>本企业</b> 下合同，链接会 <b>登录企业控制台</b> </li>
+<li> <b>链接仅可使用一次</b>，不可重复使用</li>
 </ul>
      */
   async GetDownloadFlowUrl(
@@ -1099,7 +1122,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
 1. 合同中当前状态为 **待签署** 的签署人是催办的对象
 2. **每个合同只能催办一次**
 
-**催办的效果**: 对方会受到如下的短信通知
+**催办的效果**: 对方会收到如下的短信通知
+
 ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
 
 
@@ -1427,6 +1451,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     return this.request("DescribeFlowDetailInfo", req, cb)
   }
 
+  /**
+   * 通过此接口（ChannelDescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。
+   */
+  async ChannelDescribeBillUsageDetail(
+    req: ChannelDescribeBillUsageDetailRequest,
+    cb?: (error: string, rep: ChannelDescribeBillUsageDetailResponse) => void
+  ): Promise<ChannelDescribeBillUsageDetailResponse> {
+    return this.request("ChannelDescribeBillUsageDetail", req, cb)
+  }
+
   /**
      * 获取个人用户自动签的开通链接。
 
@@ -1440,8 +1474,22 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
-   */
+     * 用于获取合同中填写控件填写状态和填写的内容。 
+
+**注意**: `附件控件不会出现在结果列表中`
+
+
+**授权**:   
+此接口需要授权,  有两种开通权限的途径
+
+**第一种**:   需第三方应用的子企业登录控制台进行授权,  授权在**企业中心**的**授权管理**区域,  界面如下图
+授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
+
+**第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
+![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
+     */
   async ChannelDescribeFlowComponents(
     req: ChannelDescribeFlowComponentsRequest,
     cb?: (error: string, rep: ChannelDescribeFlowComponentsResponse) => void