tencentcloud-sdk-nodejs 4.0.688 → 4.0.690

package/src/services/es/v20180416/es_models.ts

@@ -894,7 +894,7 @@ export interface DescribeIndexMetaResponse {
    * 索引元数据字段
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  IndexMetaField: IndexMetaField
+  IndexMetaField?: IndexMetaField
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1098,7 +1098,7 @@ export interface CreateIndexRequest {
    */
   IndexName: string
   /**
-   * 创建的索引元数据JSON，如mappings、settings
+   * 【必填】创建的索引元数据JSON，如mappings、settings
    */
   IndexMetaJson?: string
   /**
@@ -1298,12 +1298,12 @@ export interface DescribeIndexListResponse {
    * 索引元数据字段
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  IndexMetaFields: Array<IndexMetaField>
+  IndexMetaFields?: Array<IndexMetaField>
   /**
    * 查询总数
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  TotalCount: number
+  TotalCount?: number
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1549,7 +1549,7 @@ export interface DescribeIndexListRequest {
    */
   IndexStatusList?: Array<string>
   /**
-   * 排序顺序，支持asc、desc
+   * 排序顺序，支持asc、desc，默认为desc 数据格式"asc","desc"
    */
   Order?: string
 }

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

@@ -26,7 +26,6 @@ import {
   Department,
   CreatePreparedPersonalEsignRequest,
   DescribeIntegrationDepartmentsResponse,
-  FileInfo,
   CreateFlowApproversResponse,
   DescribeFileUrlsResponse,
   ModifyApplicationCallbackInfoResponse,
@@ -62,14 +61,13 @@ import {
   TemplateInfo,
   CreateDocumentResponse,
   DescribeIntegrationEmployeesRequest,
-  UnbindEmployeeUserIdWithClientOpenIdResponse,
   CreateIntegrationUserRolesResponse,
   CreateFlowRequest,
   CreateSchemeUrlRequest,
   DeleteIntegrationDepartmentResponse,
   AutoSignConfig,
   DescribeThirdPartyAuthCodeRequest,
-  DescribeIntegrationMainOrganizationUserRequest,
+  UnbindEmployeeUserIdWithClientOpenIdResponse,
   CreateReleaseFlowResponse,
   CreateWebThemeConfigResponse,
   BindEmployeeUserIdWithClientOpenIdRequest,
@@ -148,7 +146,7 @@ import {
   CreateStaffResult,
   CreateUserAutoSignEnableUrlRequest,
   CreateOrganizationBatchSignUrlResponse,
-  DescribeIntegrationMainOrganizationUserResponse,
+  FileInfo,
   CancelUserAutoSignEnableUrlRequest,
   FailedCreateStaffData,
   ApproverRestriction,
@@ -162,7 +160,6 @@ import {
   DeleteIntegrationDepartmentRequest,
   WebThemeConfig,
   ModifyApplicationCallbackInfoRequest,
-  IntegrationMainOrganizationUser,
   StartFlowRequest,
   CreateSealResponse,
   CreatePrepareFlowRequest,
@@ -340,8 +337,15 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 本接口（CreateEmbedWebUrl）用于创建嵌入web的链接 本接口支持创建：创建印章，创建模板，修改模板，预览模板，预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
-   */
+     * 本接口（CreateEmbedWebUrl）用于创建嵌入Web的链接，支持以下类型的Web链接创建：
+1. 创建印章
+2. 创建模板
+3. 修改模板
+4. 预览模板
+5. 预览合同流程
+
+用户可以通过这些链接快速将其集成到自己的系统中。
+     */
   async CreateEmbedWebUrl(
     req: CreateEmbedWebUrlRequest,
     cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void
@@ -360,8 +364,10 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
-   */
+     * 此接口（UnbindEmployeeUserIdWithClientOpenId）用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。
+
+注：`在调用此接口时，需确保OpenId已通过调用`<a href="https://qian.tencent.com/developers/companyApis/staffs/BindEmployeeUserIdWithClientOpenId" target="_blank">BindEmployeeUserIdWithClientOpenId</a>`接口与电子签系统的UserId绑定过。若OpenId未经过绑定，则无法使用此接口进行解绑操作。`
+     */
   async UnbindEmployeeUserIdWithClientOpenId(
     req: UnbindEmployeeUserIdWithClientOpenIdRequest,
     cb?: (error: string, rep: UnbindEmployeeUserIdWithClientOpenIdResponse) => void
@@ -382,7 +388,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 通过此接口，删除企业的部门。
+   * 此接口（DeleteIntegrationDepartment）用于删除企业的部门信息。
    */
   async DeleteIntegrationDepartment(
     req: DeleteIntegrationDepartmentRequest,
@@ -392,7 +398,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 将电子签系统员工userId与客户系统员工openId进行绑定
+   * 此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
    */
   async BindEmployeeUserIdWithClientOpenId(
     req: BindEmployeeUserIdWithClientOpenIdRequest,
@@ -412,12 +418,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * ### 适用场景
-在通过模板或者文件发起合同时，若未指定企业签署人信息，则流程发起后，可以调用此接口补充或签签署人。
-同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
-### 限制条件
--  本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
-- 他方企业仅支持通过姓名+手机号补充
+     * 适用场景：
+当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。
+
+限制条件：
+1. 本企业（发起方企业）企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
+2. 本企业（发起方企业）非企业微信签署人仅支持通过姓名+手机号进行补充。
+3. 他方企业仅支持通过姓名+手机号进行补充。
      */
   async CreateFlowApprovers(
     req: CreateFlowApproversRequest,
@@ -427,7 +434,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 通过此接口，更新企业的部门信息，支持更新部门名、客户系统部门ID、部门序列号。
+   * 此接口（ModifyIntegrationDepartment）用于更新企业的部门信息，支持更新部门名称、客户系统部门ID和部门序号等信息。
    */
   async ModifyIntegrationDepartment(
     req: ModifyIntegrationDepartmentRequest,
@@ -437,23 +444,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 通过此接口可以关闭个人用户自动签功能。
-无需对应的用户刷脸等方式同意即可关闭。
-
-注意: 
-
-<ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
-<li>如果此用户在开通时候绑定过个人自动签账号许可,  关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
-     */
-  async DisableUserAutoSign(
-    req: DisableUserAutoSignRequest,
-    cb?: (error: string, rep: DisableUserAutoSignResponse) => void
-  ): Promise<DisableUserAutoSignResponse> {
-    return this.request("DisableUserAutoSign", req, cb)
-  }
-
-  /**
-   * 解绑员工与对应角色关系
+   * 解绑员工与对应角色的关系，如需绑定请使用 CreateIntegrationUserRoles 接口。
    */
   async DeleteIntegrationRoleUsers(
     req: DeleteIntegrationRoleUsersRequest,
@@ -589,8 +580,9 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 此接口（CreateFlowGroupByTemplates）通过多模板创建合同组签署流程。<br/>
-此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
+     * 此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。
+
+适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
      */
   async CreateFlowGroupByTemplates(
     req: CreateFlowGroupByTemplatesRequest,
@@ -672,8 +664,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列
-   */
+     * 此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。
+
+注：`法人角色是系统保留角色，因此返回列表中不含法人角色。`
+     */
   async DescribeIntegrationRoles(
     req: DescribeIntegrationRolesRequest,
     cb?: (error: string, rep: DescribeIntegrationRolesResponse) => void
@@ -682,7 +676,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 通过此接口，创建企业的部门，支持绑定客户系统部门ID。
+   * 此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。
    */
   async CreateIntegrationDepartment(
     req: CreateIntegrationDepartmentRequest,
@@ -715,7 +709,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 查询企业员工列表，每次返回的数据量最大为20
+   * 此接口（DescribeIntegrationEmployees）用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。
    */
   async DescribeIntegrationEmployees(
     req: DescribeIntegrationEmployeesRequest,
@@ -748,7 +742,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
 
 ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
 
-注:  `只能获取个人用户证明图片, 企业员工的暂不支持`
+注:  
+<ul>
+<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
+<li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。  </li>
+</ul>
      */
   async CreatePersonAuthCertificateImage(
     req: CreatePersonAuthCertificateImageRequest,
@@ -788,7 +786,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 绑定员工与对应角色
+   * 此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。
    */
   async CreateIntegrationUserRoles(
     req: CreateIntegrationUserRolesRequest,
@@ -866,15 +864,19 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-     * 集团企业统一使用主代子进行操作，无需根据子企业账号进行转化查询，该接口需要屏蔽下线
+     * 通过此接口可以关闭个人用户自动签功能。
+无需对应的用户刷脸等方式同意即可关闭。
+
+注意: 
 
-通过子企业影子账号查询主企业员工账号
+<ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
+<li>如果此用户在开通时候绑定过个人自动签账号许可,  关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
      */
-  async DescribeIntegrationMainOrganizationUser(
-    req: DescribeIntegrationMainOrganizationUserRequest,
-    cb?: (error: string, rep: DescribeIntegrationMainOrganizationUserResponse) => void
-  ): Promise<DescribeIntegrationMainOrganizationUserResponse> {
-    return this.request("DescribeIntegrationMainOrganizationUser", req, cb)
+  async DisableUserAutoSign(
+    req: DisableUserAutoSignRequest,
+    cb?: (error: string, rep: DisableUserAutoSignResponse) => void
+  ): Promise<DisableUserAutoSignResponse> {
+    return this.request("DisableUserAutoSign", req, cb)
   }
 
   /**
@@ -917,10 +919,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-     * 移除员工
-这里分两个场景
-如果不传交接人的ReceiveUserId或者ReceiveOpenId，则会直接把这个人进行离职
-如果传了交接人，会把离职人未处理完的合同交接给交接人后再离职
+     * 该接口（DeleteIntegrationEmployees）用于移除企业员工，同时可选择是否进行离职交接。
+-  如果不设置交接人的ReceiveUserId或ReceiveOpenId，则该员工将被直接移除而不进行交接操作。
+-  如果设置了ReceiveUserId或ReceiveOpenId，该员工未处理的合同将会被系统交接给设置的交接人，然后再对该员工进行离职操作。
+
+注：`1. 超管或法人身份的员工不能被删除。2. 员工存在待处理合同且无人交接时不能被删除。`
      */
   async DeleteIntegrationEmployees(
     req: DeleteIntegrationEmployeesRequest,
@@ -969,7 +972,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 通过此接口，查询企业的部门，支持查询单个部门节点或单个部门节点及一级子节点部门列表。
+   * 此接口（DescribeIntegrationDepartments）用于查询企业的部门信息列表，支持查询单个部门节点或单个部门节点及一级子节点部门列表。
    */
   async DescribeIntegrationDepartments(
     req: DescribeIntegrationDepartmentsRequest,
@@ -993,8 +996,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 此API接口用户查询加入集团的成员企业
-   */
+     * 此API接口用来查询加入集团的成员企业信息
+适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计
+     */
   async DescribeOrganizationGroupOrganizations(
     req: DescribeOrganizationGroupOrganizationsRequest,
     cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void
@@ -1003,9 +1007,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-     * 创建员工,此接口会发送提醒员工实名的短信，如果通过手机号发现员工已经创建，则不会重新创建，会发送短信提醒员工实名
-注意：此接口支持企微组织架构的 openid 创建员工，这种场景下传递明文的企微 openid 到WeworkOpenId字段即可（企微明文的 openid 一定要在应用的可见范围内才行），通过企微创建的员工，会发送企微消息去提醒实名
-     */
+   * 此接口（CreateIntegrationEmployees）用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建，则不会重新创建，但会发送短信提醒员工实名。另外，此接口还支持通过企微组织架构的openid 创建员工（将WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内），该场景下，员工会接收到提醒实名的企微消息。
+   */
   async CreateIntegrationEmployees(
     req: CreateIntegrationEmployeesRequest,
     cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void