tencentcloud-sdk-nodejs-essbasic 4.0.730 → 4.0.732

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

@@ -436,16 +436,17 @@ UpperRight-右下角。
  */
 export interface ChannelDeleteSealPoliciesRequest {
   /**
-   * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+   * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
    */
   Agent: Agent
   /**
-   * 指定印章ID
+   * 操作的印章ID
    */
   SealId: string
   /**
-   * 指定用户ID数组，电子签系统用户ID
-可以填写OpenId，系统会通过组织+渠道+OpenId查询得到UserId进行授权取消。
+   * 需要删除授权的用户ID数组，可以传入电子签系统用户ID或OpenId。
+注: 
+1. `填写OpenId时，系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作`
    */
   UserIds: Array<string>
   /**
@@ -1444,6 +1445,7 @@ export interface ChannelCreateConvertTaskApiRequest {
 <li>jpeg</li>
 <li>png</li>
 <li>bmp</li>
+<li>html</li>
 <li>txt</li></ul>
    */
   ResourceType: string
@@ -1942,18 +1944,30 @@ export interface ChannelDescribeRolesRequest {
    */
   Agent: Agent
   /**
-   * 指定每页多少条数据，单页最大200
+   * 指定每页返回的数据条数，和Offset参数配合使用，单页最大200。
+
+注: `因为历史原因, 此字段为字符串类型`
    */
   Limit: string
   /**
    * 查询的关键字段:
-Key:"RoleType",Values:["1"]查询系统角色，Values:["2"]查询自定义角色
-Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色
-Key:"IsReturnPermissionGroup"，Values:["0"]:表示接口不返回角色对应的权限树字段，Values:["1"]表示接口返回角色对应的权限树字段
+Key:"**RoleType**",Values:["**1**"]查询系统角色，
+Key:"**RoleType**",Values:["**2**"]查询自定义角色
+Key:"**RoleStatus**",Values:["**1**"]查询启用角色
+Key:"**RoleStatus**",Values:["**2**"]查询禁用角色
+Key:"**IsReturnPermissionGroup**"，Values:["**0**"]表示接口不返回角色对应的权限树字段
+Key:"**IsReturnPermissionGroup**"，Values:["**1**"]表示接口返回角色对应的权限树字段
+
+注: `同名字的Key的过滤条件会冲突, 只能填写一个`
+
    */
   Filters?: Array<Filter>
   /**
-   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
+   * 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。
+
+注：
+1.`offset从0开始，即第一页为0。`
+2.`默认从第一页返回。`
    */
   Offset?: number
   /**
@@ -3278,7 +3292,7 @@ export interface FlowGroupOptions {
  */
 export interface ChannelDescribeOrganizationSealsRequest {
   /**
-   * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+   * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
    */
   Agent: Agent
   /**
@@ -3286,25 +3300,32 @@ export interface ChannelDescribeOrganizationSealsRequest {
    */
   Limit: number
   /**
-   * 偏移量，默认为0，最大为20000
+   * 分页查询偏移量，默认为0，最大为20000
    */
   Offset?: number
   /**
-   * 查询信息类型，为1时返回授权用户，为其他值时不返回
+   * 查询信息类型
+支持的值如下：
+<ul><li>0-默认，不返回授权用户信息</li>
+<li>1-返回授权用户信息</li>
+</ul>
    */
   InfoType?: number
   /**
    * 印章id（没有输入返回所有）
+
+注:  `没有输入返回所有记录，最大返回100条。`
    */
   SealId?: string
   /**
-   * 印章类型列表（都是组织机构印章）。
-为空时查询所有类型的印章。
-目前支持以下类型：
-OFFICIAL：企业公章；
-CONTRACT：合同专用章；
-ORGANIZATION_SEAL：企业印章(图片上传创建)；
-LEGAL_PERSON_SEAL：法定代表人章
+   * 印章类型列表，目前支持传入以下类型：
+<ul><li>OFFICIAL-企业公章</li>
+<li>CONTRACT-合同专用章</li>
+<li>ORGANIZATION_SEAL-企业印章(图片上传创建)</li>
+<li>LEGAL_PERSON_SEAL-法定代表人章</li>
+</ul>
+
+注:  `为空时查询所有类型的印章。`
    */
   SealTypes?: Array<string>
 }
@@ -5316,11 +5337,11 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
  */
 export interface ChannelDescribeRolesResponse {
   /**
-   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
+   * 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。
    */
   Offset?: number
   /**
-   * 指定每页多少条数据，单页最大200
+   * 指定每页返回的数据条数，和Offset参数配合使用，单页最大200。
    */
   Limit?: number
   /**
@@ -5328,7 +5349,7 @@ export interface ChannelDescribeRolesResponse {
    */
   TotalCount?: number
   /**
-   * 角色信息
+   * 查询的角色信息列表
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ChannelRoles?: Array<ChannelRole>
@@ -5467,6 +5488,10 @@ export interface ApproverOption {
    * 是否可以拒签 默认false-可以拒签 true-不可以拒签
    */
   NoRefuse?: boolean
+  /**
+   * 是否可以转发 默认false-可以转发 true-不可以转发
+   */
+  NoTransfer?: boolean
   /**
    * 是否隐藏一键签署 默认false-不隐藏true-隐藏
    */
@@ -5943,11 +5968,12 @@ export interface ChannelModifyRoleRequest {
  */
 export interface ChannelUpdateSealStatusRequest {
   /**
-   * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+   * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
    */
   Agent: Agent
   /**
-   * 操作的印章状态，DISABLE-停用印章
+   * 印章状态，目前支持传入以下类型：
+<ul><li>DISABLE-停用印章</li></ul>
    */
   Status: string
   /**

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

@@ -7,7 +7,7 @@ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, Cha
 export declare class Client extends TencentCloudCommon.AbstractClient {
     constructor(clientConfig: TencentCloudCommon.ClientConfig);
     /**
-     * 删除指定印章下多个授权信息
+     * 此接口（ChannelDeleteSealPolicies）用于删除已指定员工印章授权信息，删除员工的印章授权后，该员工使用印章进行盖章时，将需要提交印章授权申请且通过审核后才能使用该印章进行签署。
      */
     ChannelDeleteSealPolicies(req: ChannelDeleteSealPoliciesRequest, cb?: (error: string, rep: ChannelDeleteSealPoliciesResponse) => void): Promise<ChannelDeleteSealPoliciesResponse>;
     /**
@@ -164,7 +164,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
     DescribeExtendedServiceAuthInfo(req: DescribeExtendedServiceAuthInfoRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthInfoResponse) => void): Promise<DescribeExtendedServiceAuthInfoResponse>;
     /**
        * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
-  相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355
+  
+  
+  <font color="red">**系统默认角色**</font>说明可参考下表
+  
+  | 角色名称| 建议授予对象 | 角色描述 |
+  | --- | --- | --- |
+  | **超级管理员** |电子签业务最高权限，可以授权给法务/企业法人/业务负责人等 | 所有功能和数据管理权限，只能设置一位超管。 |
+  | **业务管理员**|IT 系统负责人，可以授权给CTO等 | 企业合同模块、印章模块、模板模块等全量功能及数据权限。 |
+  | **经办人**|企业法务负责人等 | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。 |
+  | **业务员**|销售员、采购员 等| 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。 |
        */
     ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise<ChannelDescribeRolesResponse>;
     /**
@@ -290,8 +299,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     ChannelDisableUserAutoSign(req: ChannelDisableUserAutoSignRequest, cb?: (error: string, rep: ChannelDisableUserAutoSignResponse) => void): Promise<ChannelDisableUserAutoSignResponse>;
     /**
-       * 查询子客企业电子印章，需要操作者具有管理印章权限
-  客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数，只返回启用的印章。
+       * 此接口（ChannelDescribeOrganizationSeals）查询子客企业电子印章。<br />
+  注:
+  1. `查询子客企业电子印章，需要操作者具有管理印章权限`
+  2. `客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理`
+  3. `此接口只能查询启用的印章`
        */
     ChannelDescribeOrganizationSeals(req: ChannelDescribeOrganizationSealsRequest, cb?: (error: string, rep: ChannelDescribeOrganizationSealsResponse) => void): Promise<ChannelDescribeOrganizationSealsResponse>;
     /**
@@ -443,7 +455,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
     /**
-     * 本接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态
+     * 此接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态。
      */
     ChannelUpdateSealStatus(req: ChannelUpdateSealStatusRequest, cb?: (error: string, rep: ChannelUpdateSealStatusResponse) => void): Promise<ChannelUpdateSealStatusResponse>;
     /**

package/tencentcloud/services/essbasic/v20210526/essbasic_client.js

@@ -28,7 +28,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         super("essbasic.tencentcloudapi.com", "2021-05-26", clientConfig);
     }
     /**
-     * 删除指定印章下多个授权信息
+     * 此接口（ChannelDeleteSealPolicies）用于删除已指定员工印章授权信息，删除员工的印章授权后，该员工使用印章进行盖章时，将需要提交印章授权申请且通过审核后才能使用该印章进行签署。
      */
     async ChannelDeleteSealPolicies(req, cb) {
         return this.request("ChannelDeleteSealPolicies", req, cb);
@@ -203,7 +203,16 @@ class Client extends TencentCloudCommon.AbstractClient {
     }
     /**
        * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
-  相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355
+  
+  
+  <font color="red">**系统默认角色**</font>说明可参考下表
+  
+  | 角色名称| 建议授予对象 | 角色描述 |
+  | --- | --- | --- |
+  | **超级管理员** |电子签业务最高权限，可以授权给法务/企业法人/业务负责人等 | 所有功能和数据管理权限，只能设置一位超管。 |
+  | **业务管理员**|IT 系统负责人，可以授权给CTO等 | 企业合同模块、印章模块、模板模块等全量功能及数据权限。 |
+  | **经办人**|企业法务负责人等 | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。 |
+  | **业务员**|销售员、采购员 等| 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。 |
        */
     async ChannelDescribeRoles(req, cb) {
         return this.request("ChannelDescribeRoles", req, cb);
@@ -347,8 +356,11 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelDisableUserAutoSign", req, cb);
     }
     /**
-       * 查询子客企业电子印章，需要操作者具有管理印章权限
-  客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数，只返回启用的印章。
+       * 此接口（ChannelDescribeOrganizationSeals）查询子客企业电子印章。<br />
+  注:
+  1. `查询子客企业电子印章，需要操作者具有管理印章权限`
+  2. `客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理`
+  3. `此接口只能查询启用的印章`
        */
     async ChannelDescribeOrganizationSeals(req, cb) {
         return this.request("ChannelDescribeOrganizationSeals", req, cb);
@@ -522,7 +534,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateChannelFlowEvidenceReport", req, cb);
     }
     /**
-     * 本接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态
+     * 此接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态。
      */
     async ChannelUpdateSealStatus(req, cb) {
         return this.request("ChannelUpdateSealStatus", req, cb);

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

@@ -414,16 +414,17 @@ export interface Component {
  */
 export interface ChannelDeleteSealPoliciesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
      */
     Agent: Agent;
     /**
-     * 指定印章ID
+     * 操作的印章ID
      */
     SealId: string;
     /**
-     * 指定用户ID数组，电子签系统用户ID
-  可以填写OpenId，系统会通过组织+渠道+OpenId查询得到UserId进行授权取消。
+     * 需要删除授权的用户ID数组，可以传入电子签系统用户ID或OpenId。
+  注:
+  1. `填写OpenId时，系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作`
      */
     UserIds: Array<string>;
     /**
@@ -1387,6 +1388,7 @@ export interface ChannelCreateConvertTaskApiRequest {
   <li>jpeg</li>
   <li>png</li>
   <li>bmp</li>
+  <li>html</li>
   <li>txt</li></ul>
      */
     ResourceType: string;
@@ -1873,18 +1875,30 @@ export interface ChannelDescribeRolesRequest {
      */
     Agent: Agent;
     /**
-     * 指定每页多少条数据，单页最大200
+     * 指定每页返回的数据条数，和Offset参数配合使用，单页最大200。
+  
+  注: `因为历史原因, 此字段为字符串类型`
      */
     Limit: string;
     /**
      * 查询的关键字段:
-  Key:"RoleType",Values:["1"]查询系统角色，Values:["2"]查询自定义角色
-  Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色
-  Key:"IsReturnPermissionGroup"，Values:["0"]:表示接口不返回角色对应的权限树字段，Values:["1"]表示接口返回角色对应的权限树字段
+  Key:"**RoleType**",Values:["**1**"]查询系统角色，
+  Key:"**RoleType**",Values:["**2**"]查询自定义角色
+  Key:"**RoleStatus**",Values:["**1**"]查询启用角色
+  Key:"**RoleStatus**",Values:["**2**"]查询禁用角色
+  Key:"**IsReturnPermissionGroup**"，Values:["**0**"]表示接口不返回角色对应的权限树字段
+  Key:"**IsReturnPermissionGroup**"，Values:["**1**"]表示接口返回角色对应的权限树字段
+  
+  注: `同名字的Key的过滤条件会冲突, 只能填写一个`
+  
      */
     Filters?: Array<Filter>;
     /**
-     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
+     * 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。
+  
+  注：
+  1.`offset从0开始，即第一页为0。`
+  2.`默认从第一页返回。`
      */
     Offset?: number;
     /**
@@ -3178,7 +3192,7 @@ export interface FlowGroupOptions {
  */
 export interface ChannelDescribeOrganizationSealsRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
      */
     Agent: Agent;
     /**
@@ -3186,25 +3200,32 @@ export interface ChannelDescribeOrganizationSealsRequest {
      */
     Limit: number;
     /**
-     * 偏移量，默认为0，最大为20000
+     * 分页查询偏移量，默认为0，最大为20000
      */
     Offset?: number;
     /**
-     * 查询信息类型，为1时返回授权用户，为其他值时不返回
+     * 查询信息类型
+  支持的值如下：
+  <ul><li>0-默认，不返回授权用户信息</li>
+  <li>1-返回授权用户信息</li>
+  </ul>
      */
     InfoType?: number;
     /**
      * 印章id（没有输入返回所有）
+  
+  注:  `没有输入返回所有记录，最大返回100条。`
      */
     SealId?: string;
     /**
-     * 印章类型列表（都是组织机构印章）。
-  为空时查询所有类型的印章。
-  目前支持以下类型：
-  OFFICIAL：企业公章；
-  CONTRACT：合同专用章；
-  ORGANIZATION_SEAL：企业印章(图片上传创建)；
-  LEGAL_PERSON_SEAL：法定代表人章
+     * 印章类型列表，目前支持传入以下类型：
+  <ul><li>OFFICIAL-企业公章</li>
+  <li>CONTRACT-合同专用章</li>
+  <li>ORGANIZATION_SEAL-企业印章(图片上传创建)</li>
+  <li>LEGAL_PERSON_SEAL-法定代表人章</li>
+  </ul>
+  
+  注:  `为空时查询所有类型的印章。`
      */
     SealTypes?: Array<string>;
 }
@@ -5162,11 +5183,11 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
  */
 export interface ChannelDescribeRolesResponse {
     /**
-     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
+     * 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。
      */
     Offset?: number;
     /**
-     * 指定每页多少条数据，单页最大200
+     * 指定每页返回的数据条数，和Offset参数配合使用，单页最大200。
      */
     Limit?: number;
     /**
@@ -5174,7 +5195,7 @@ export interface ChannelDescribeRolesResponse {
      */
     TotalCount?: number;
     /**
-     * 角色信息
+     * 查询的角色信息列表
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ChannelRoles?: Array<ChannelRole>;
@@ -5308,6 +5329,10 @@ export interface ApproverOption {
      * 是否可以拒签 默认false-可以拒签 true-不可以拒签
      */
     NoRefuse?: boolean;
+    /**
+     * 是否可以转发 默认false-可以转发 true-不可以转发
+     */
+    NoTransfer?: boolean;
     /**
      * 是否隐藏一键签署 默认false-不隐藏true-隐藏
      */
@@ -5768,11 +5793,12 @@ export interface ChannelModifyRoleRequest {
  */
 export interface ChannelUpdateSealStatusRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
      */
     Agent: Agent;
     /**
-     * 操作的印章状态，DISABLE-停用印章
+     * 印章状态，目前支持传入以下类型：
+  <ul><li>DISABLE-停用印章</li></ul>
      */
     Status: string;
     /**