tencentcloud-sdk-nodejs 4.0.659 → 4.0.661

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

@@ -608,7 +608,7 @@ callbackinfo包含： 回调地址和签名key
   }
 
   /**
-   * 查询企业角色列表
+   * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列
    */
   async DescribeIntegrationRoles(
     req: DescribeIntegrationRolesRequest,
@@ -685,8 +685,9 @@ callbackinfo包含： 回调地址和签名key
   }
 
   /**
-   * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
-   */
+     * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
+注：如果是集团代子企业发起任务场景，可以通过对Agent参数（未列在入参列表）设置代理的相关应用信息来支持，Agent参数设置可以参考CreateFlow接口的Agent相关说明。
+     */
   async CreateConvertTaskApi(
     req: CreateConvertTaskApiRequest,
     cb?: (error: string, rep: CreateConvertTaskApiResponse) => void
@@ -697,7 +698,7 @@ callbackinfo包含： 回调地址和签名key
   /**
      * 查询流程基础信息
 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
-每个企业限制日调用量限制：10W，当日超过此限制后再调用接口返回错误
+每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误
      */
   async DescribeFlowBriefs(
     req: DescribeFlowBriefsRequest,
@@ -758,8 +759,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息
-   */
+     * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
+注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
+     */
   async DescribeFlowComponents(
     req: DescribeFlowComponentsRequest,
     cb?: (error: string, rep: DescribeFlowComponentsResponse) => void
@@ -811,8 +813,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 移除员工
-   */
+     * 移除员工
+这里分两个场景
+如果不传交接人的ReceiveUserId或者ReceiveOpenId，则会直接把这个人进行离职
+如果传了交接人，会把离职人未处理完的合同交接给交接人后再离职
+     */
   async DeleteIntegrationEmployees(
     req: DeleteIntegrationEmployeesRequest,
     cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void
@@ -883,8 +888,9 @@ PDF资源Id 通过上传文件接口获取
   }
 
   /**
-   * 创建员工,此接口会发送提醒员工实名的短信
-   */
+     * 创建员工,此接口会发送提醒员工实名的短信，如果通过手机号发现员工已经创建，则不会重新创建，会发送短信提醒员工实名
+注意：此接口支持企微组织架构的 openid 创建员工，这种场景下传递明文的企微 openid 到WeworkOpenId字段即可（企微明文的 openid 一定要在应用的可见范围内才行），通过企微创建的员工，会发送企微消息去提醒实名
+     */
   async CreateIntegrationEmployees(
     req: CreateIntegrationEmployeesRequest,
     cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void

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

@@ -224,6 +224,10 @@ true：做透明化处理和颜色增强。
 填写的FileId通过UploadFiles接口上传文件获取。
    */
   FileId?: string
+  /**
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   */
+  Agent?: Agent
 }
 
 /**
@@ -344,13 +348,15 @@ export interface FlowCreateApprover {
    */
   ApproverMobile?: string
   /**
-   * 签署方经办人证件类型ID_CARD 身份证
+   * 签署人的证件类型
+ID_CARD 身份证
 HONGKONG_AND_MACAO 港澳居民来往内地通行证
 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
    */
   ApproverIdCardType?: string
   /**
-   * 签署方经办人证件号码
+   * 签署人证件号（长度不超过18位）
    */
   ApproverIdCardNumber?: string
   /**
@@ -670,7 +676,7 @@ export interface DescribeIntegrationRolesRequest {
    */
   Operator: UserInfo
   /**
-   * 返回最大数量，最大为200
+   * 指定每页多少条数据，单页最大200
    */
   Limit: number
   /**
@@ -685,7 +691,7 @@ Key:"IsGroupRole"，Values:["0"],查询非集团角色，Values:["1"]表示查
    */
   Filters?: Array<Filter>
   /**
-   * 偏移量，默认为0，最大为2000
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
    */
   Offset?: number
 }
@@ -873,11 +879,11 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
    */
   Operator: UserInfo
   /**
-   * 单次查询成员企业最大返回数量
+   * 指定每页多少条数据，单页最大1000
    */
   Limit: number
   /**
-   * 页面偏移量
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0
    */
   Offset: number
   /**
@@ -893,7 +899,7 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
    */
   Export?: boolean
   /**
-   * 成员企业id
+   * 成员企业机构 ID，在PC控制台 集团管理可获取
    */
   Id?: string
 }
@@ -1032,7 +1038,7 @@ export interface CreateFlowGroupByFilesRequest {
  */
 export interface DescribeFlowComponentsResponse {
   /**
-   * 流程关联的填写控件信息
+   * 流程关联的填写控件信息，按照参与方进行分类返回。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   RecipientComponentInfos?: Array<RecipientComponentInfo>
@@ -1256,7 +1262,7 @@ export interface DescribeIntegrationEmployeesRequest {
    */
   Operator: UserInfo
   /**
-   * 返回最大数量，最大为20
+   * 指定每页多少条数据，单页最大20
    */
   Limit: number
   /**
@@ -1269,7 +1275,7 @@ export interface DescribeIntegrationEmployeesRequest {
    */
   Filters?: Array<Filter>
   /**
-   * 偏移量，默认为0，最大为20000
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
    */
   Offset?: number
 }
@@ -1394,10 +1400,11 @@ export interface CreateSchemeUrlRequest {
    */
   Mobile?: string
   /**
-   * 链接类型
-HTTP：跳转电子签小程序的http_url，
-APP：第三方APP或小程序跳转电子签小程序的path。
-默认为HTTP类型
+   * 要跳转的链接类型
+
+- HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  (默认)
+- APP： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型
+
    */
   EndPoint?: string
   /**
@@ -1409,7 +1416,12 @@ APP：第三方APP或小程序跳转电子签小程序的path。
    */
   FlowGroupId?: string
   /**
-   * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
+   * 要跳转到的页面类型 
+
+- 0: 不传, 主页 (默认)
+- 1: 小程序合同详情 
+- 2: 小程序合同列表页 
+
    */
   PathType?: number
   /**
@@ -1426,10 +1438,10 @@ false：否。
   /**
    * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
 
-0:合同签署页面更多操作按钮
-1:合同签署页面更多操作的拒绝签署按钮
-2:合同签署页面更多操作的转他人处理按钮
-3:签署成功页的查看详情按钮
+- 0:合同签署页面更多操作按钮
+- 1:合同签署页面更多操作的拒绝签署按钮
+- 2:合同签署页面更多操作的转他人处理按钮
+- 3:签署成功页的查看详情按钮
    */
   Hides?: Array<number>
 }
@@ -2018,12 +2030,12 @@ export interface DescribeIntegrationEmployeesResponse {
    */
   Employees?: Array<Staff>
   /**
-   * 偏移量，默认为0，最大为20000
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Offset?: number
   /**
-   * 返回最大数量，最大为20
+   * 指定每页多少条数据，单页最大20
    */
   Limit?: number
   /**
@@ -2672,16 +2684,18 @@ export interface RecipientComponentInfo {
   RecipientId?: string
   /**
    * 参与方填写状态
+0-未填写
+1-已填写
 注意：此字段可能返回 null，表示取不到有效值。
    */
   RecipientFillStatus?: string
   /**
-   * 是否发起方
+   * 是否为发起方
 注意：此字段可能返回 null，表示取不到有效值。
    */
   IsPromoter?: boolean
   /**
-   * 填写控件内容
+   * 填写控件列表
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Components?: Array<FilledComponent>
@@ -2741,11 +2755,11 @@ export interface DescribeFlowComponentsRequest {
    */
   Operator: UserInfo
   /**
-   * 电子签流程的Id
+   * 流程(合同)的编号
    */
   FlowId: string
   /**
-   * 应用相关信息
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
 }
@@ -2840,7 +2854,7 @@ export interface GroupOrganization {
    */
   JoinTime?: number
   /**
-   * 是否使用审批流引擎，true-是，false-否
+   * 是否使用自建审批流引擎（即不是企微审批流引擎），true-是，false-否
 注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowEngineEnable?: boolean
@@ -3049,7 +3063,7 @@ export interface DeleteIntegrationEmployeesRequest {
    */
   Operator: UserInfo
   /**
-   * 待移除员工的信息，userId和openId二选一，必填一个
+   * 待移除员工的信息，userId和openId二选一，必填一个，如果需要指定交接人的话，ReceiveUserId或者ReceiveOpenId字段二选一
    */
   Employees: Array<Staff>
   /**
@@ -3197,7 +3211,7 @@ export interface DeleteIntegrationRoleUsersRequest {
    */
   RoleId: string
   /**
-   * 用户信息
+   * 用户信息,最多 200 个用户，并且 UserId 和 OpenId 二选一，其他字段不需要传
    */
   Users: Array<UserInfo>
   /**
@@ -3384,11 +3398,11 @@ export interface CreateIntegrationUserRolesRequest {
    */
   Operator: UserInfo
   /**
-   * 绑定角色的用户id列表
+   * 绑定角色的用户id列表，不能重复，不能大于 100 个
    */
   UserIds: Array<string>
   /**
-   * 绑定角色的角色id列表
+   * 绑定角色的角色id列表，不能重复，不能大于 100，可以通过DescribeIntegrationRoles接口获取
    */
   RoleIds: Array<string>
   /**
@@ -3655,16 +3669,17 @@ export interface ApproverInfo {
    */
   SignComponents?: Array<Component>
   /**
-   * 签署人的身份证号
-   */
-  ApproverIdCardNumber?: string
-  /**
-   * 签署人的身份证件类型 
+   * 签署人的证件类型
 ID_CARD 身份证
 HONGKONG_AND_MACAO 港澳居民来往内地通行证
 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
    */
   ApproverIdCardType?: string
+  /**
+   * 签署人证件号（长度不超过18位）
+   */
+  ApproverIdCardNumber?: string
   /**
    * 签署通知类型：sms--短信，none--不通知
    */
@@ -3736,11 +3751,11 @@ export interface ModifyIntegrationDepartmentRequest {
    */
   Operator: UserInfo
   /**
-   * 电子签部门ID
+   * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
    */
   DeptId: string
   /**
-   * 电子签父部门ID
+   * 电子签父部门ID，通过DescribeIntegrationDepartments接口可以获取
    */
   ParentDeptId?: string
   /**
@@ -4131,7 +4146,7 @@ export interface DeleteIntegrationDepartmentRequest {
    */
   Operator: UserInfo
   /**
-   * 电子签中的部门id
+   * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
    */
   DeptId: string
   /**
@@ -4793,11 +4808,11 @@ BATCH_SIGN：批量签署
  */
 export interface DescribeIntegrationRolesResponse {
   /**
-   * 偏移量，默认为0，最大为2000
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
    */
   Offset?: number
   /**
-   * 返回最大数量，最大为200
+   * 指定每页多少条数据，单页最大200
    */
   Limit?: number
   /**
@@ -4837,7 +4852,7 @@ export interface CreateFlowRemindsRequest {
  */
 export interface UpdateIntegrationEmployeesRequest {
   /**
-   * 当前用户信息，OpenId与UserId二选一必填一个，OpenId是第三方客户ID，userId是用户实名后的电子签生成的ID,当传入客户系统openId，传入的openId需与电子签员工userId绑定，且参数Channel必填，Channel值为YUFU；
+   * 当前用户信息，UserId必填
    */
   Operator: UserInfo
   /**
@@ -5462,7 +5477,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
    */
   ActivedTotal?: number
   /**
-   * 导出文件的url
+   * 如果入参Export为 true 时使用，表示导出Excel的url
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ExportUrl?: string

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

@@ -275,7 +275,7 @@ export class Client extends AbstractClient {
 
   /**
      * 此接口（DescribeUsage）用于获取第三方平台所有合作企业流量消耗情况。
- 注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
+ 注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
      */
   async DescribeUsage(
     req: DescribeUsageRequest,
@@ -320,7 +320,7 @@ export class Client extends AbstractClient {
 
   /**
      * 查询子客企业电子印章，需要操作者具有管理印章权限
-客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
+客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数，只返回启用的印章。
      */
   async ChannelDescribeOrganizationSeals(
     req: ChannelDescribeOrganizationSealsRequest,
@@ -489,7 +489,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   }
 
   /**
-   * 对流程的合同文件进行验证，判断文件是否合法。
+   * 对流程的合同文件进行数字签名验证，判断文件是否被篡改。
    */
   async ChannelVerifyPdf(
     req: ChannelVerifyPdfRequest,
@@ -747,7 +747,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息
+   * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
    */
   async ChannelDescribeFlowComponents(
     req: ChannelDescribeFlowComponentsRequest,

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

@@ -901,7 +901,7 @@ export interface ChannelDeleteRoleUsersRequest {
    */
   RoleId: string
   /**
-   * 电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数
+   * 电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多两百
    */
   UserIds?: Array<string>
   /**
@@ -910,7 +910,7 @@ export interface ChannelDeleteRoleUsersRequest {
    */
   Operator?: UserInfo
   /**
-   * 客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数
+   * 客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多两百
    */
   OpenIds?: Array<string>
 }
@@ -1445,11 +1445,11 @@ export interface ChannelDescribeRolesRequest {
    */
   Agent: Agent
   /**
-   * 查询起始偏移，最大2000
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
    */
   Offset: number
   /**
-   * 查询数量，最大200
+   * 指定每页多少条数据，单页最大200
    */
   Limit: string
   /**
@@ -2543,13 +2543,13 @@ export interface ChannelCreateBoundFlowsRequest {
  */
 export interface ChannelDescribeEmployeesRequest {
   /**
-   * 返回最大数量，最大为20
+   * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
    */
-  Limit: number
+  Agent: Agent
   /**
-   * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+   * 指定每页多少条数据，单页最大20
    */
-  Agent?: Agent
+  Limit: number
   /**
    * 查询过滤实名用户，Key为Status，Values为["IsVerified"]
 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
@@ -2557,7 +2557,7 @@ export interface ChannelDescribeEmployeesRequest {
    */
   Filters?: Array<Filter>
   /**
-   * 偏移量，默认为0，最大为20000
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0,最大为20000
    */
   Offset?: number
   /**
@@ -2779,14 +2779,15 @@ export interface FlowApproverInfo {
    */
   Name?: string
   /**
-   * 签署人身份证件类型
+   * 签署人的证件类型
 1.ID_CARD 居民身份证
 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
+4.OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
    */
   IdCardType?: string
   /**
-   * 签署人证件号
+   * 签署人证件号（长度不超过18位）
    */
   IdCardNumber?: string
   /**
@@ -3345,11 +3346,11 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
  */
 export interface ChannelDescribeRolesResponse {
   /**
-   * 页面偏移量，最大2000
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
    */
   Offset?: number
   /**
-   * 查询数量，最大200
+   * 指定每页多少条数据，单页最大200
    */
   Limit?: number
   /**
@@ -3412,7 +3413,7 @@ export interface ChannelCreateReleaseFlowRequest {
  */
 export interface ChannelDescribeFlowComponentsResponse {
   /**
-   * 流程关联的填写控件信息
+   * 流程关联的填写控件信息，控件会按照参与方进行分类。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   RecipientComponentInfos?: Array<RecipientComponentInfo>
@@ -3533,15 +3534,15 @@ export interface ChannelCreateUserRolesRequest {
    */
   Agent: Agent
   /**
-   * 绑定角色的角色id列表
+   * 绑定角色的角色id列表，最多 100 个
    */
   RoleIds: Array<string>
   /**
-   * 电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数
+   * 电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多 100 个
    */
   UserIds?: Array<string>
   /**
-   * 客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数
+   * 客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多 100 个
    */
   OpenIds?: Array<string>
   /**
@@ -4165,12 +4166,12 @@ export interface ChannelDescribeEmployeesResponse {
    */
   Employees?: Array<Staff>
   /**
-   * 偏移量，默认为0，最大为20000
+   * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Offset?: number
   /**
-   * 返回最大数量，最大为20
+   * 指定每页多少条数据，单页最大20
    */
   Limit?: number
   /**