tencentcloud-sdk-nodejs 4.0.688 → 4.0.690

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

@@ -165,15 +165,15 @@ export interface UpdateIntegrationEmployeesResponse {
 }
 
 /**
- * 集成版员工部门信息
+ * 集成版员工部门信息。
  */
 export interface Department {
   /**
-   * 部门id
+   * 部门ID。
    */
   DepartmentId?: string
   /**
-   * 部门名称
+   * 部门名称。
    */
   DepartmentName?: string
 }
@@ -263,7 +263,7 @@ true：做透明化处理和颜色增强。
  */
 export interface DescribeIntegrationDepartmentsResponse {
   /**
-   * 部门列表
+   * 部门信息列表。部门信息根据部门排序号OrderNo降序排列，根据部门创建时间升序排列。
    */
   Departments?: Array<IntegrationDepartment>
   /**
@@ -272,28 +272,6 @@ export interface DescribeIntegrationDepartmentsResponse {
   RequestId?: string
 }
 
-/**
- * 模板中文件的信息结构
- */
-export interface FileInfo {
-  /**
-   * 文件ID
-   */
-  FileId?: string
-  /**
-   * 文件名
-   */
-  FileName?: string
-  /**
-   * 文件大小，单位为Byte
-   */
-  FileSize?: number
-  /**
-   * 文件上传时间，格式为Unix标准时间戳（秒）
-   */
-  CreatedOn?: number
-}
-
 /**
  * CreateFlowApprovers返回参数结构体
  */
@@ -461,7 +439,8 @@ export interface CancelUserAutoSignEnableUrlResponse {
  */
 export interface BindEmployeeUserIdWithClientOpenIdResponse {
   /**
-   * 绑定是否成功，1表示成功，0表示失败
+   * 绑定是否成功。
+<ul><li>**0**：失败</li><li>**1**：成功</li></ul>
    */
   Status?: number
   /**
@@ -475,17 +454,19 @@ export interface BindEmployeeUserIdWithClientOpenIdResponse {
  */
 export interface CreateIntegrationEmployeesRequest {
   /**
-   * 操作人信息，userId必填
+   * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 待创建员工的信息，不超过20个。
-所有类型的企业支持的入参：Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填，其他字段暂不支持。
-企微类型的企业特有支持的入参：WeworkOpenId，传入此字段无需在传入其他信息
+   * 待创建员工的信息，最多不超过20个。
+其中入参Mobile和DisplayName必填，OpenId、Email和Department.DepartmentId选填，其他字段暂不支持设置。
+在创建企微企业员工场景下，只需传入WeworkOpenId，无需再传其他信息。
    */
   Employees: Array<Staff>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -603,27 +584,36 @@ export interface ReleasedApprover {
  */
 export interface DescribeIntegrationRolesRequest {
   /**
-   * 操作人信息，UserId必填
+   * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
-   * 指定每页多少条数据，单页最大200
+   * 指定分页每页返回的数据条数，单页最大支持 200。
    */
   Limit: number
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 查询的关键字段:
-Key:"RoleType",Values:["1"]查询系统角色，Values:["2"]查询自定义角色
-Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色
-Key:"IsGroupRole"，Values:["0"]:查询非集团角色，Values:["1"]表示查询集团角色
-Key:"IsReturnPermissionGroup"，Values:["0"]:表示接口不返回角色对应的权限树字段，Values:["1"]表示接口返回角色对应的权限树字段
+   * 查询的关键字段，支持Key-Value单值查询。可选键值对如下：
+<ul>
+  <li>Key:"RoleType"，查询角色类型，Values可选：
+    <ul><li>**"1"**：查询系统角色</li><li>**"2"**：查询自定义角色</li></ul>
+  </li><li>Key:"RoleStatus"，查询角色状态，Values可选：
+    <ul><li>**"1"**：查询启用角色</li><li>**"2"**：查询禁用角色</li></ul>
+  </li><li>Key:"IsGroupRole"，是否查询集团角色，Values可选：
+    <ul><li>**"0"**：查询非集团角色</li><li>**"1"**：查询集团角色</li></ul>
+  </li><li>Key:"IsReturnPermissionGroup"，是否返回角色对应权限树，Values可选：
+    <ul><li>**"0"**：接口不返回角色对应的权限树字段</li><li>**"1"**：接口返回角色对应的权限树字段</li></ul>
+  </li>
+</ul>
    */
   Filters?: Array<Filter>
   /**
-   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
+   * 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 0 开始，即首页为 0，最大2000。
    */
   Offset?: number
 }
@@ -691,16 +681,16 @@ CONTRACT：合同专用章
 }
 
 /**
- * 集成版企业角色信息
+ * 集成版企业角色信息。
  */
 export interface StaffRole {
   /**
-   * 角色id
+   * 角色ID。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   RoleId?: string
   /**
-   * 角色名称
+   * 角色名称。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   RoleName?: string
@@ -807,7 +797,9 @@ export interface CreateConvertTaskApiRequest {
  */
 export interface DeleteIntegrationEmployeesResponse {
   /**
-   * 员工删除数据
+   * 员工删除结果。包含成功数据与失败数据。
+<ul><li>**成功数据**：展示员工姓名、手机号与电子签平台UserId</li>
+<li>**失败数据**：展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
    */
   DeleteEmployeeResult?: DeleteStaffsResult
   /**
@@ -835,15 +827,16 @@ export interface CreateFlowRemindsResponse {
  */
 export interface DescribeOrganizationGroupOrganizationsRequest {
   /**
-   * 操作人信息，userId必填
+   * 执行本接口操作的员工信息,userId必填。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
-   * 指定每页多少条数据，单页最大1000
+   * 指定分页每页返回的数据条数，单页最大1000
    */
   Limit: number
   /**
-   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0
+   * 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
    */
   Offset: number
   /**
@@ -851,15 +844,23 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
    */
   Name?: string
   /**
-   * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
+   * 成员企业加入集团的当前状态
+<ul><li> **1**：待授权</li>
+<li> **2**：已授权待激活</li>
+<li> **3**：拒绝授权</li>
+<li> **4**：已解除</li>
+<li> **5**：已加入</li>
+</ul>
    */
   Status?: number
   /**
    * 是否导出当前成员企业数据
+<ul><li> **false**：不导出（默认值）</li>
+<li> **true**：导出</li></ul>
    */
   Export?: boolean
   /**
-   * 成员企业机构 ID，在PC控制台 集团管理可获取
+   * 成员企业机构 ID，32 位字符串，在PC控制台 集团管理可获取
    */
   Id?: string
 }
@@ -1235,44 +1236,37 @@ export interface CreateDocumentResponse {
  */
 export interface DescribeIntegrationEmployeesRequest {
   /**
-   * 操作人信息，userId必填
+   * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 指定每页多少条数据，单页最大20
+   * 指定分页每页返回的数据条数，单页最大支持 20。
    */
   Limit: number
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 查询过滤实名用户，Key为Status，Values为["IsVerified"]，查询过滤未实名用户，Key为Status，Values为["NotVerified"]
-查询某个部门的用户，Key为DepartmentId，Values为["DepartmentId"]
-根据用户Id查询员工时，Key为UserId，Values为["UserId"]
-根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
+   * 查询的关键字段，支持Key-Values查询。可选键值如下：
+<ul>
+  <li>Key:**"Status"**，根据实名状态查询员工，Values可选：
+    <ul><li>**["IsVerified"]**：查询已实名的员工</li><li>**["NotVerified"]**：查询未实名的员工</li></ul></li>
+  <li>Key:**"DepartmentId"**，根据部门ID查询部门下的员工，Values为指定的部门ID：**["DepartmentId"]**</li>
+  <li>Key:**"UserId"**，根据用户ID查询员工，Values为指定的用户ID：**["UserId"]**</li>
+  <li>Key:**"UserWeWorkOpenId"**，根据用户企微账号ID查询员工，Values为指定用户的企微账号ID：**["UserWeWorkOpenId"]**</li>
+  <li>Key:**"StaffOpenId"**，根据第三方系统用户OpenId查询员工，Values为第三方系统用户OpenId列表：**["OpenId1","OpenId2",...]**</li>
+</ul>
    */
   Filters?: Array<Filter>
   /**
-   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
+   * 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 0 开始，即首页为 0，最大20000。
    */
   Offset?: number
 }
 
-/**
- * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
- */
-export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
-  /**
-   * 解绑是否成功，1表示成功，0表示失败
-   */
-  Status?: number
-  /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
-}
-
 /**
  * CreateIntegrationUserRoles返回参数结构体
  */
@@ -1558,13 +1552,19 @@ export interface DescribeThirdPartyAuthCodeRequest {
 }
 
 /**
- * DescribeIntegrationMainOrganizationUser请求参数结构体
+ * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
  */
-export interface DescribeIntegrationMainOrganizationUserRequest {
+export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
   /**
-   * 操作人信息，userId必填
+   * 解绑是否成功。
+<ul><li> **0**：失败 </li>
+<li> **1**：成功 </li></ul>
    */
-  Operator: UserInfo
+  Status?: number
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -1598,19 +1598,22 @@ export interface CreateWebThemeConfigResponse {
  */
 export interface BindEmployeeUserIdWithClientOpenIdRequest {
   /**
-   * 用户信息，OpenId与UserId二选一必填一个，OpenId是第三方客户ID，userId是用户实名后的电子签生成的ID,当传入客户系统openId，传入的openId需与电子签员工userId绑定，且参数Channel必填，Channel值为INTEGRATE；当传入参数UserId，Channel无需指定。（参数参考示例）
+   * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 电子签系统员工UserId
+   * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)；或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
    */
   UserId: string
   /**
-   * 客户系统OpenId
+   * 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
    */
   OpenId: string
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -1625,7 +1628,9 @@ export interface DescribeIntegrationDepartmentsRequest {
    */
   Operator: UserInfo
   /**
-   * 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
+   * 查询类型，支持以下类型：
+<ul><li>**0**：查询单个部门节点列表，不包含子节点部门信息</li>
+<li>**1**：查询单个部门节点级一级子节点部门信息列表</li></ul>
    */
   QueryType: number
   /**
@@ -1634,11 +1639,13 @@ export interface DescribeIntegrationDepartmentsRequest {
    */
   Agent?: Agent
   /**
-   * 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
+   * 查询的部门ID。
+注：`如果同时指定了DeptId与DeptOpenId参数，系统将优先使用DeptId参数进行查询。当二者都未指定时，系统将返回根节点部门数据。`
    */
   DeptId?: string
   /**
-   * 客户系统部门ID,与DeptId二选一,优先DeptId,都为空时获取根节点数据
+   * 查询的客户系统部门ID。
+注：`如果同时指定了DeptId与DeptOpenId参数，系统将优先使用DeptId参数进行查询。当二者都未指定时，系统将返回根节点部门数据。`
    */
   DeptOpenId?: string
 }
@@ -1738,7 +1745,7 @@ export interface ComponentLimit {
  */
 export interface CreateIntegrationDepartmentResponse {
   /**
-   * 电子签部门ID
+   * 电子签部门ID。建议开发者保存此部门ID，方便后续查询或修改部门信息。
    */
   DeptId?: string
   /**
@@ -1882,12 +1889,15 @@ export interface DescribeUserAutoSignStatusResponse {
 /**
  * 补充签署人信息
 - RecipientId 必须指定
--  通过企业自定义账号ID补充签署人时，ApproverSource 和 CustomUserId 必填，ApproverSource取值：WEWORKAPP
+-  通过企业微信自定义账号ID补充签署人时，ApproverSource 和 CustomUserId 必填，ApproverSource取值：WEWORKAPP
 - 通过二要素（姓名/手机号）补充签署人时，ApproverName 和 ApproverMobile 必填，ApproverSource设置为空
  */
 export interface FillApproverInfo {
   /**
-   * 对应模板中的参与方ID
+   * 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
+模板发起合同时，该参数为必填项。
+文件发起合同是，该参数无需传值。
+如果开发者后序用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
    */
   RecipientId: string
   /**
@@ -1897,16 +1907,16 @@ WEWORKAPP: 企业微信
    */
   ApproverSource?: string
   /**
-   * 企业自定义账号ID
-<br/>当ApproverSource为WEWORKAPP的企微或签场景下，必须指企业自有应用获取企微明文的userid
+   * 企业微信UserId
+<br/>当ApproverSource为WEWORKAPP的企微或签场景下，必须指企业自有应用获取企业微信的UserId
    */
   CustomUserId?: string
   /**
-   * 补充签署人姓名
+   * 补充企业签署人员工姓名
    */
   ApproverName?: string
   /**
-   * 补充签署人手机号
+   * 补充企业签署人员工手机号
    */
   ApproverMobile?: string
 }
@@ -2195,21 +2205,21 @@ export interface DisableUserAutoSignRequest {
  */
 export interface DescribeIntegrationEmployeesResponse {
   /**
-   * 员工数据列表
+   * 员工信息列表。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Employees?: Array<Staff>
   /**
-   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
+   * 指定分页返回第几页的数据。页码从 0 开始，即首页为 0，最大20000。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Offset?: number
   /**
-   * 指定每页多少条数据，单页最大20
+   * 指定分页每页返回的数据条数，单页最大支持 20。
    */
   Limit?: number
   /**
-   * 符合条件的员工数量
+   * 符合条件的员工数量。
    */
   TotalCount?: number
   /**
@@ -2300,19 +2310,23 @@ CreateReview:发起审核
  */
 export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
   /**
-   * 用户信息，OpenId与UserId二选一必填一个，OpenId是第三方客户ID，userId是用户实名后的电子签生成的ID,当传入客户系统openId，传入的openId需与电子签员工userId绑定，且参数Channel必填，Channel值为INTEGRATE；当传入参数UserId，Channel无需指定(参数用法参考示例)
+   * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 电子签系统员工UserId
+   * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
    */
   UserId: string
   /**
-   * 客户系统OpenId
+   * 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。
+该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
    */
   OpenId: string
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -2340,7 +2354,7 @@ export interface CreateSchemeUrlResponse {
  */
 export interface CreateUserAutoSignEnableUrlResponse {
   /**
-   * 个人用户自动签的开通链接, 短链形式
+   * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
    */
   Url?: string
   /**
@@ -2788,25 +2802,31 @@ export interface UserInfo {
  */
 export interface CreateFlowApproversRequest {
   /**
-   * 调用方用户信息，userId 必填
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 签署流程编号
+   * 合同流程ID，为32位字符串。
+建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
    */
   FlowId: string
   /**
-   * 补充签署人信息
+   * 补充企业签署人信息。
+
+- 如果发起方指定的补充签署人是企业微信签署人（ApproverSource=WEWORKAPP），则需要提供企业微信UserId进行补充；
+
+- 如果不指定，则使用姓名和手机号进行补充。
    */
   Approvers: Array<FillApproverInfo>
   /**
-   * 企微消息中的发起人
+   * 在可定制的企业微信通知中，发起人可以根据具体需求进行自定义设置。
    */
   Initiator?: string
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作
-
-
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -2879,10 +2899,10 @@ export interface FlowCreateApprover {
    */
   ApproverIdCardNumber?: string
   /**
-   * 签署方经办人在模板中的参与方ID
-<br/>模板发起合同时，该参数为必填项
-<br/>文件发起合同是，该参数无序传值
-
+   * 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
+模板发起合同时，该参数为必填项。
+文件发起合同是，该参数无需传值。
+如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
    */
   RecipientId?: string
   /**
@@ -3021,78 +3041,80 @@ export interface FlowCreateApprover {
 }
 
 /**
- * 企业员工信息
+ * 企业员工信息。
  */
 export interface Staff {
   /**
-   * 用户在电子签平台的id
-注：创建和更新场景无需填写
+   * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+注：`创建和更新场景无需填写。`
    */
   UserId?: string
   /**
-   * 显示的用户名/昵称
+   * 显示的用户名/昵称。
    */
   DisplayName?: string
   /**
-   * 用户手机号
+   * 用户手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
    */
   Mobile?: string
   /**
-   * 用户邮箱
+   * 用户邮箱。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Email?: string
   /**
-   * 用户在第三方平台id，如需在此接口提醒员工实名，该参数不传
+   * 用户在第三方平台ID。
+注：`如需在此接口提醒员工实名，该参数不传。`
 注意：此字段可能返回 null，表示取不到有效值。
    */
   OpenId?: string
   /**
-   * 员工角色
-注：创建和更新场景无需填写
+   * 员工角色信息。
+注：`创建和更新场景无需填写。`
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Roles?: Array<StaffRole>
   /**
-   * 员工部门
+   * 员工部门信息。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Department?: Department
   /**
-   * 员工是否实名
-注：创建和更新场景无需填写
+   * 员工是否实名。
+注：`创建和更新场景无需填写。`
    */
   Verified?: boolean
   /**
-   * 员工创建时间戳，单位秒
-注：创建和更新场景无需填写
+   * 员工创建时间戳，单位秒。
+注：`创建和更新场景无需填写。`
    */
   CreatedOn?: number
   /**
-   * 员工实名时间戳，单位秒
-注：创建和更新场景无需填写
+   * 员工实名时间戳，单位秒。
+注：`创建和更新场景无需填写。`
 注意：此字段可能返回 null，表示取不到有效值。
    */
   VerifiedOn?: number
   /**
-   * 员工是否离职：0-未离职，1-离职
-注：创建和更新场景无需填写
+   * 员工是否离职：
+<ul><li>**0**：未离职</li><li>**1**：离职</li></ul>
+注：`创建和更新场景无需填写。`
 注意：此字段可能返回 null，表示取不到有效值。
    */
   QuiteJob?: number
   /**
-   * 员工离职交接人用户id
-注：创建和更新场景无需填写
+   * 员工离职交接人用户ID。
+注：`创建和更新场景无需填写。`
    */
   ReceiveUserId?: string
   /**
-   * 员工离职交接人用户OpenId
-注：创建和更新场景无需填写
+   * 员工离职交接人用户OpenId。
+注：`创建和更新场景无需填写。`
    */
   ReceiveOpenId?: string
   /**
-   * 企业微信用户账号ID
-注：仅企微类型的企业创建员工接口支持该字段
+   * 企业微信用户账号ID。
+注：`仅企微类型的企业创建员工接口支持该字段。`
 注意：此字段可能返回 null，表示取不到有效值。
    */
   WeworkOpenId?: string
@@ -3198,28 +3220,29 @@ export interface CreateIntegrationDepartmentRequest {
    */
   Operator: UserInfo
   /**
-   * 部门名称，不超过50个字符
+   * 部门名称，最大长度为50个字符。
    */
   DeptName: string
   /**
-   * 代理企业和员工的信息。
-在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 电子签父部门ID，与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
+   * 电子签父部门ID。
+注：`如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。`
    */
   ParentDeptId?: string
   /**
-   * 第三方平台中父部门ID,与ParentDeptId二选一,优先ParentDeptId,都为空时自动填充至根节点下
+   * 第三方平台中父部门ID。
+注：`如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。`
    */
   ParentDeptOpenId?: string
   /**
-   * 客户系统部门ID，不超过64个字符
+   * 客户系统部门ID，最大长度为64个字符。
    */
   DeptOpenId?: string
   /**
-   * 排序号,1~30000范围内
+   * 排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。
    */
   OrderNo?: number
 }
@@ -3239,17 +3262,24 @@ export interface GroupOrganization {
    */
   Alias?: string
   /**
-   * 成员企业id
+   * 成员企业id，为 32 位字符串，可在电子签PC 控制台，企业设置->企业电子签账号 获取
 注意：此字段可能返回 null，表示取不到有效值。
    */
   OrganizationId?: string
   /**
-   * 更新时间，时间戳，单位秒
+   * 记录更新时间， unix时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
    */
   UpdateTime?: number
   /**
-   * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
+   * 成员企业加入集团的当前状态
+<ul><li> **1**：待授权</li>
+<li> **2**：已授权待激活</li>
+<li> **3**：拒绝授权</li>
+<li> **4**：已解除</li>
+<li> **5**：已加入</li>
+</ul>
+
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Status?: number
@@ -3269,22 +3299,24 @@ export interface GroupOrganization {
    */
   AdminInfo?: Admin
   /**
-   * 企业许可证
+   * 企业许可证Id，此字段暂时不需要关注
 注意：此字段可能返回 null，表示取不到有效值。
    */
   License?: string
   /**
-   * 企业许可证过期时间，时间戳，单位秒
+   * 企业许可证过期时间，unix时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
    */
   LicenseExpireTime?: number
   /**
-   * 成员企业加入集团时间，时间戳，单位秒
+   * 成员企业加入集团时间，unix时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
    */
   JoinTime?: number
   /**
-   * 是否使用自建审批流引擎（即不是企微审批流引擎），true-是，false-否
+   * 是否使用自建审批流引擎（即不是企微审批流引擎）
+<ul><li> **true**：是</li>
+<li> **false**：否</li></ul>
 注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowEngineEnable?: boolean
@@ -3417,24 +3449,23 @@ export interface CreateEmbedWebUrlRequest {
    */
   Operator: UserInfo
   /**
-   * WEB嵌入资源类型。
-<br/>CREATE_SEAL: 生成创建印章的嵌入页面
-<br/>CREATE_TEMPLATE：生成创建模板的嵌入页面
-<br/>MODIFY_TEMPLATE：生成编辑模板的嵌入页面
-<br/>PREVIEW_TEMPLATE：生成预览模板的嵌入页面
-<br/>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
-<br/>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
-<br/>EXTEND_SERVICE：生成拓展服务的嵌入页面
-<br/>PREVIEW_FLOW：生成预览合同的嵌入页面
-<br/>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面
-
+   * WEB嵌入资源类型，支持以下类型
+<ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
+<li>CREATE_TEMPLATE：生成创建模板的嵌入页面</li>
+<li>MODIFY_TEMPLATE：生成编辑模板的嵌入页面</li>
+<li>PREVIEW_TEMPLATE：生成预览模板的嵌入页面</li>
+<li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li>
+<li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li>
+<li>EXTEND_SERVICE：生成拓展服务的嵌入页面</li>
+<li>PREVIEW_FLOW：生成预览合同的嵌入页面</li>
+<li>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面</li></ul>
    */
   EmbedType: string
   /**
    * WEB嵌入的业务资源ID
-<br/>PREVIEW_SEAL_DETAIL，必填，取值为印章id
-<br/>MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id
-<br/>PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
+<ul><li>PREVIEW_SEAL_DETAIL，必填，取值为印章id</li>
+<li>MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id</li>
+<li>PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id</li><ul>
    */
   BusinessId?: string
   /**
@@ -3457,15 +3488,19 @@ export interface CreateEmbedWebUrlRequest {
  */
 export interface DeleteIntegrationEmployeesRequest {
   /**
-   * 操作人信息，userId必填
+   * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 待移除员工的信息，userId和openId二选一，必填一个，如果需要指定交接人的话，ReceiveUserId或者ReceiveOpenId字段二选一
+   * 待移除员工的信息。应符合以下规则：
+<ul><li>UserId和OpenId不可同时为空。</li>
+<li>若需要进行离职交接，交接人信息ReceiveUserId和ReceiveOpenId不可同时为空。否则视为不进行离职交接。</li></ul>
    */
   Employees: Array<Staff>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -3479,7 +3514,7 @@ export interface FailedUpdateStaffData {
    */
   DisplayName?: string
   /**
-   * 用户传入的手机号
+   * 用户传入的手机号，明文展示
    */
   Mobile?: string
   /**
@@ -3487,7 +3522,8 @@ export interface FailedUpdateStaffData {
    */
   Reason?: string
   /**
-   * 用户Id
+   * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
    */
   UserId?: string
   /**
@@ -3607,7 +3643,7 @@ export interface CreateFlowGroupByFilesResponse {
  */
 export interface CreateIntegrationEmployeesResponse {
   /**
-   * 创建员工的结果
+   * 创建员工的结果。包含创建成功的数据与创建失败数据。
    */
   CreateEmployeeResult?: CreateStaffResult
   /**
@@ -3621,11 +3657,11 @@ export interface CreateIntegrationEmployeesResponse {
  */
 export interface DeleteIntegrationRoleUsersRequest {
   /**
-   * 操作人信息，userId必填
+   * 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
-   * 角色id
+   * 角色id，可以通过DescribeIntegrationRoles接口获取角色信息
    */
   RoleId: string
   /**
@@ -3633,7 +3669,7 @@ export interface DeleteIntegrationRoleUsersRequest {
    */
   Users: Array<UserInfo>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -3876,7 +3912,7 @@ export interface CreateReleaseFlowRequest {
  */
 export interface CreateIntegrationUserRolesRequest {
   /**
-   * 操作人信息，UserId必填
+   * 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
@@ -3884,11 +3920,11 @@ export interface CreateIntegrationUserRolesRequest {
    */
   UserIds: Array<string>
   /**
-   * 绑定角色的角色id列表，不能重复，不能大于 100，可以通过DescribeIntegrationRoles接口获取
+   * 绑定角色的角色id列表，不能重复，不能大于 100，可以通过DescribeIntegrationRoles接口获取角色信息
    */
   RoleIds: Array<string>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -3964,11 +4000,12 @@ export interface SuccessUpdateStaffData {
    */
   DisplayName?: string
   /**
-   * 传入的手机号
+   * 传入的手机号，没有打码
    */
   Mobile?: string
   /**
-   * 用户Id
+   * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
    */
   UserId?: string
 }
@@ -4343,7 +4380,7 @@ export interface ModifyIntegrationDepartmentRequest {
    */
   Operator: UserInfo
   /**
-   * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
+   * 电子签部门ID，通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
    */
   DeptId: string
   /**
@@ -4352,19 +4389,19 @@ export interface ModifyIntegrationDepartmentRequest {
    */
   Agent?: Agent
   /**
-   * 电子签父部门ID，通过DescribeIntegrationDepartments接口可以获取
+   * 电子签父部门ID，通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
    */
   ParentDeptId?: string
   /**
-   * 部门名称，不超过50个字符
+   * 部门名称，最大长度为50个字符。
    */
   DeptName?: string
   /**
-   * 客户系统部门ID，不超过64个字符
+   * 客户系统部门ID，最大长度为64个字符。
    */
   DeptOpenId?: string
   /**
-   * 排序号,1~30000范围内
+   * 排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。
    */
   OrderNo?: number
 }
@@ -4465,18 +4502,25 @@ export interface CreateOrganizationBatchSignUrlResponse {
 }
 
 /**
- * DescribeIntegrationMainOrganizationUser返回参数结构体
+ * 模板中文件的信息结构
  */
-export interface DescribeIntegrationMainOrganizationUserResponse {
+export interface FileInfo {
   /**
-   * 主企业员工账号信息
-注意：此字段可能返回 null，表示取不到有效值。
+   * 文件ID
    */
-  IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser
+  FileId?: string
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 文件名
    */
-  RequestId?: string
+  FileName?: string
+  /**
+   * 文件大小，单位为Byte
+   */
+  FileSize?: number
+  /**
+   * 文件上传时间，格式为Unix标准时间戳（秒）
+   */
+  CreatedOn?: number
 }
 
 /**
@@ -4762,7 +4806,7 @@ export interface DeleteIntegrationDepartmentRequest {
    */
   Operator: UserInfo
   /**
-   * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
+   * 电子签中的部门ID，通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口可获得。
    */
   DeptId: string
   /**
@@ -4771,7 +4815,8 @@ export interface DeleteIntegrationDepartmentRequest {
    */
   Agent?: Agent
   /**
-   * 交接部门ID。待删除部门中的合同、印章和模板数据，交接至该部门ID下，未填写交接至公司根部门。
+   * 交接部门ID。
+待删除部门中的合同、印章和模板数据，将会被交接至该部门ID下；若未填写则交接至公司根部门。
    */
   ReceiveDeptId?: string
 }
@@ -4820,27 +4865,6 @@ export interface ModifyApplicationCallbackInfoRequest {
   Agent?: Agent
 }
 
-/**
- * 主企业员工账号信息
- */
-export interface IntegrationMainOrganizationUser {
-  /**
-   * 主企业id
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  MainOrganizationId?: string
-  /**
-   * 主企业员工UserId
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  MainUserId?: string
-  /**
-   * 主企业员工名
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  UserName?: string
-}
-
 /**
  * StartFlow请求参数结构体
  */
@@ -5435,12 +5459,12 @@ UpperRight-右下角。
  */
 export interface IntegrationDepartment {
   /**
-   * 部门ID
+   * 部门ID。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   DeptId?: string
   /**
-   * 部门名
+   * 部门名。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   DeptName?: string
@@ -5455,7 +5479,7 @@ export interface IntegrationDepartment {
    */
   DeptOpenId?: string
   /**
-   * 序列号
+   * 序列号。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   OrderNo?: number
@@ -5493,19 +5517,19 @@ export interface DescribeExtendedServiceAuthInfosRequest {
  */
 export interface DescribeIntegrationRolesResponse {
   /**
-   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
+   * 指定分页返回的页码。页码从0开始，最大为2000。
    */
   Offset?: number
   /**
-   * 指定每页多少条数据，单页最大200
+   * 指定分页每页返回的数据条数，单页最大支持 200。
    */
   Limit?: number
   /**
-   * 符合查询条件的总的角色数
+   * 符合查询条件的总角色数。
    */
   TotalCount?: number
   /**
-   * 企业角色信息列表
+   * 企业角色信息列表。
    */
   IntegrateRoles?: Array<IntegrateRole>
   /**
@@ -5539,7 +5563,8 @@ export interface CreateFlowRemindsRequest {
  */
 export interface UpdateIntegrationEmployeesRequest {
   /**
-   * 当前用户信息，UserId必填
+   * 执行本接口操作的员工信息,UserId必填。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
@@ -5549,7 +5574,8 @@ export interface UpdateIntegrationEmployeesRequest {
    */
   Employees: Array<Staff>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -5582,23 +5608,30 @@ export interface DescribeFlowBriefsRequest {
  */
 export interface CreateFlowGroupByTemplatesRequest {
   /**
-   * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId 代发合同
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
-   * 合同组名称,最大长度200个字符
+   * 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
    */
   FlowGroupName: string
   /**
-   * 合同组的子合同信息，支持2-50个子合同
+   * 合同（流程）组的子合同信息，支持2-50个子合同
    */
   FlowGroupInfos: Array<FlowGroupInfo>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 合同组的配置信息。包括是否通知本企业签署方，是否通知其他签署方
+   * 合同（流程）组的配置项信息。
+其中包括：
+<ul>
+<li>是否通知本企业签署方</li>
+<li>是否通知其他签署方</li>
+</ul>
    */
   FlowGroupOptions?: FlowGroupOptions
 }
@@ -5687,7 +5720,9 @@ export interface Admin {
    */
   Name?: string
   /**
-   * 超管手机号
+   * 超管手机号，打码显示
+示例值：138****1569
+
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Mobile?: string
@@ -6172,12 +6207,12 @@ export interface FlowBrief {
  */
 export interface DescribeOrganizationGroupOrganizationsResponse {
   /**
-   * 查询到的符合条件的成员企业总数量
+   * 符合查询条件的资源实例总数量。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Total?: number
   /**
-   * 已授权待激活的企业数量
+   * 已授权待激活的子企业总数量
 注意：此字段可能返回 null，表示取不到有效值。
    */
   JoinedTotal?: number
@@ -6198,7 +6233,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
    */
   List?: Array<GroupOrganization>
   /**
-   * 已加入的企业数量
+   * 已加入的子企业总数量
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ActivatedTotal?: number