tencentcloud-sdk-nodejs-ess 4.0.659 → 4.0.662

package/tencentcloud/services/ess/v20201111/ess_client.d.ts

@@ -199,7 +199,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CreateSeal(req: CreateSealRequest, cb?: (error: string, rep: CreateSealResponse) => void): Promise<CreateSealResponse>;
     /**
-     * 查询企业角色列表
+     * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列
      */
     DescribeIntegrationRoles(req: DescribeIntegrationRolesRequest, cb?: (error: string, rep: DescribeIntegrationRolesResponse) => void): Promise<DescribeIntegrationRolesResponse>;
     /**
@@ -234,13 +234,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CreatePersonAuthCertificateImage(req: CreatePersonAuthCertificateImageRequest, cb?: (error: string, rep: CreatePersonAuthCertificateImageResponse) => void): Promise<CreatePersonAuthCertificateImageResponse>;
     /**
-     * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
-     */
+       * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
+  注：如果是集团代子企业发起任务场景，可以通过对Agent参数（未列在入参列表）设置代理的相关应用信息来支持，Agent参数设置可以参考CreateFlow接口的Agent相关说明。
+       */
     CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
     /**
        * 查询流程基础信息
   适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
-  每个企业限制日调用量限制：10W，当日超过此限制后再调用接口返回错误
+  每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误
        */
     DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
     /**
@@ -271,8 +272,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
     /**
-     * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息
-     */
+       * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
+  注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
+       */
     DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
     /**
        * 集团企业统一使用主代子进行操作，无需根据子企业账号进行转化查询，该接口需要屏蔽下线
@@ -294,8 +296,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     DescribeOrganizationSeals(req: DescribeOrganizationSealsRequest, cb?: (error: string, rep: DescribeOrganizationSealsResponse) => void): Promise<DescribeOrganizationSealsResponse>;
     /**
-     * 移除员工
-     */
+       * 移除员工
+  这里分两个场景
+  如果不传交接人的ReceiveUserId或者ReceiveOpenId，则会直接把这个人进行离职
+  如果传了交接人，会把离职人未处理完的合同交接给交接人后再离职
+       */
     DeleteIntegrationEmployees(req: DeleteIntegrationEmployeesRequest, cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void): Promise<DeleteIntegrationEmployeesResponse>;
     /**
        * 获取小程序签署链接
@@ -330,8 +335,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
     /**
-     * 创建员工,此接口会发送提醒员工实名的短信
-     */
+       * 创建员工,此接口会发送提醒员工实名的短信，如果通过手机号发现员工已经创建，则不会重新创建，会发送短信提醒员工实名
+  注意：此接口支持企微组织架构的 openid 创建员工，这种场景下传递明文的企微 openid 到WeworkOpenId字段即可（企微明文的 openid 一定要在应用的可见范围内才行），通过企微创建的员工，会发送企微消息去提醒实名
+       */
     CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
     /**
        * 更新员工信息(姓名，手机号，邮件、部门)，用户实名后无法更改姓名与手机号。

package/tencentcloud/services/ess/v20201111/ess_client.js

@@ -288,7 +288,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateSeal", req, cb);
     }
     /**
-     * 查询企业角色列表
+     * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列
      */
     async DescribeIntegrationRoles(req, cb) {
         return this.request("DescribeIntegrationRoles", req, cb);
@@ -337,15 +337,16 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreatePersonAuthCertificateImage", req, cb);
     }
     /**
-     * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
-     */
+       * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
+  注：如果是集团代子企业发起任务场景，可以通过对Agent参数（未列在入参列表）设置代理的相关应用信息来支持，Agent参数设置可以参考CreateFlow接口的Agent相关说明。
+       */
     async CreateConvertTaskApi(req, cb) {
         return this.request("CreateConvertTaskApi", req, cb);
     }
     /**
        * 查询流程基础信息
   适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
-  每个企业限制日调用量限制：10W，当日超过此限制后再调用接口返回错误
+  每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误
        */
     async DescribeFlowBriefs(req, cb) {
         return this.request("DescribeFlowBriefs", req, cb);
@@ -386,8 +387,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateFlowReminds", req, cb);
     }
     /**
-     * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息
-     */
+       * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
+  注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
+       */
     async DescribeFlowComponents(req, cb) {
         return this.request("DescribeFlowComponents", req, cb);
     }
@@ -419,8 +421,11 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DescribeOrganizationSeals", req, cb);
     }
     /**
-     * 移除员工
-     */
+       * 移除员工
+  这里分两个场景
+  如果不传交接人的ReceiveUserId或者ReceiveOpenId，则会直接把这个人进行离职
+  如果传了交接人，会把离职人未处理完的合同交接给交接人后再离职
+       */
     async DeleteIntegrationEmployees(req, cb) {
         return this.request("DeleteIntegrationEmployees", req, cb);
     }
@@ -467,8 +472,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DescribeOrganizationGroupOrganizations", req, cb);
     }
     /**
-     * 创建员工,此接口会发送提醒员工实名的短信
-     */
+       * 创建员工,此接口会发送提醒员工实名的短信，如果通过手机号发现员工已经创建，则不会重新创建，会发送短信提醒员工实名
+  注意：此接口支持企微组织架构的 openid 创建员工，这种场景下传递明文的企微 openid 到WeworkOpenId字段即可（企微明文的 openid 一定要在应用的可见范围内才行），通过企微创建的员工，会发送企微消息去提醒实名
+       */
     async CreateIntegrationEmployees(req, cb) {
         return this.request("CreateIntegrationEmployees", req, cb);
     }

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -201,6 +201,10 @@ export interface CreatePreparedPersonalEsignRequest {
   填写的FileId通过UploadFiles接口上传文件获取。
      */
     FileId?: string;
+    /**
+     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     */
+    Agent?: Agent;
 }
 /**
  * DescribeIntegrationDepartments返回参数结构体
@@ -314,13 +318,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;
     /**
@@ -630,7 +636,7 @@ export interface DescribeIntegrationRolesRequest {
      */
     Operator: UserInfo;
     /**
-     * 返回最大数量，最大为200
+     * 指定每页多少条数据，单页最大200
      */
     Limit: number;
     /**
@@ -645,7 +651,7 @@ export interface DescribeIntegrationRolesRequest {
      */
     Filters?: Array<Filter>;
     /**
-     * 偏移量，默认为0，最大为2000
+     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
      */
     Offset?: number;
 }
@@ -672,7 +678,13 @@ export interface CreateFlowEvidenceReportRequest {
  */
 export interface StartFlowResponse {
     /**
-     * 返回描述，START-发起成功， REVIEW-提交审核成功，EXECUTING-已提交发起任务
+     * 发起成功之后返回状态，
+  
+  START-发起成功，
+  
+  REVIEW-提交审核成功，
+  
+  EXECUTING-已提交发起任务
      */
     Status?: string;
     /**
@@ -823,11 +835,11 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
      */
     Operator: UserInfo;
     /**
-     * 单次查询成员企业最大返回数量
+     * 指定每页多少条数据，单页最大1000
      */
     Limit: number;
     /**
-     * 页面偏移量
+     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0
      */
     Offset: number;
     /**
@@ -843,7 +855,7 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
      */
     Export?: boolean;
     /**
-     * 成员企业id
+     * 成员企业机构 ID，在PC控制台 集团管理可获取
      */
     Id?: string;
 }
@@ -978,7 +990,7 @@ export interface CreateFlowGroupByFilesRequest {
  */
 export interface DescribeFlowComponentsResponse {
     /**
-     * 流程关联的填写控件信息
+     * 流程关联的填写控件信息，按照参与方进行分类返回。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     RecipientComponentInfos?: Array<RecipientComponentInfo>;
@@ -1196,7 +1208,7 @@ export interface DescribeIntegrationEmployeesRequest {
      */
     Operator: UserInfo;
     /**
-     * 返回最大数量，最大为20
+     * 指定每页多少条数据，单页最大20
      */
     Limit: number;
     /**
@@ -1209,7 +1221,7 @@ export interface DescribeIntegrationEmployeesRequest {
      */
     Filters?: Array<Filter>;
     /**
-     * 偏移量，默认为0，最大为20000
+     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
      */
     Offset?: number;
 }
@@ -1331,10 +1343,11 @@ export interface CreateSchemeUrlRequest {
      */
     Mobile?: string;
     /**
-     * 链接类型
-  HTTP：跳转电子签小程序的http_url，
-  APP：第三方APP或小程序跳转电子签小程序的path。
-  默认为HTTP类型
+     * 要跳转的链接类型
+  
+  - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  (默认)
+  - APP： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型
+  
      */
     EndPoint?: string;
     /**
@@ -1346,7 +1359,12 @@ export interface CreateSchemeUrlRequest {
      */
     FlowGroupId?: string;
     /**
-     * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
+     * 要跳转到的页面类型
+  
+  - 0: 不传, 主页 (默认)
+  - 1: 小程序合同详情
+  - 2: 小程序合同列表页
+  
      */
     PathType?: number;
     /**
@@ -1363,10 +1381,10 @@ export interface CreateSchemeUrlRequest {
     /**
      * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
   
-  0:合同签署页面更多操作按钮
-  1:合同签署页面更多操作的拒绝签署按钮
-  2:合同签署页面更多操作的转他人处理按钮
-  3:签署成功页的查看详情按钮
+  - 0:合同签署页面更多操作按钮
+  - 1:合同签署页面更多操作的拒绝签署按钮
+  - 2:合同签署页面更多操作的转他人处理按钮
+  - 3:签署成功页的查看详情按钮
      */
     Hides?: Array<number>;
 }
@@ -1931,12 +1949,12 @@ export interface DescribeIntegrationEmployeesResponse {
      */
     Employees?: Array<Staff>;
     /**
-     * 偏移量，默认为0，最大为20000
+     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Offset?: number;
     /**
-     * 返回最大数量，最大为20
+     * 指定每页多少条数据，单页最大20
      */
     Limit?: number;
     /**
@@ -2570,16 +2588,18 @@ export interface RecipientComponentInfo {
     RecipientId?: string;
     /**
      * 参与方填写状态
+  0-未填写
+  1-已填写
   注意：此字段可能返回 null，表示取不到有效值。
      */
     RecipientFillStatus?: string;
     /**
-     * 是否发起方
+     * 是否为发起方
   注意：此字段可能返回 null，表示取不到有效值。
      */
     IsPromoter?: boolean;
     /**
-     * 填写控件内容
+     * 填写控件列表
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Components?: Array<FilledComponent>;
@@ -2636,11 +2656,11 @@ export interface DescribeFlowComponentsRequest {
      */
     Operator: UserInfo;
     /**
-     * 电子签流程的Id
+     * 流程(合同)的编号
      */
     FlowId: string;
     /**
-     * 应用相关信息
+     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
      */
     Agent?: Agent;
 }
@@ -2733,7 +2753,7 @@ export interface GroupOrganization {
      */
     JoinTime?: number;
     /**
-     * 是否使用审批流引擎，true-是，false-否
+     * 是否使用自建审批流引擎（即不是企微审批流引擎），true-是，false-否
   注意：此字段可能返回 null，表示取不到有效值。
      */
     FlowEngineEnable?: boolean;
@@ -2935,7 +2955,7 @@ export interface DeleteIntegrationEmployeesRequest {
      */
     Operator: UserInfo;
     /**
-     * 待移除员工的信息，userId和openId二选一，必填一个
+     * 待移除员工的信息，userId和openId二选一，必填一个，如果需要指定交接人的话，ReceiveUserId或者ReceiveOpenId字段二选一
      */
     Employees: Array<Staff>;
     /**
@@ -3076,7 +3096,7 @@ export interface DeleteIntegrationRoleUsersRequest {
      */
     RoleId: string;
     /**
-     * 用户信息
+     * 用户信息,最多 200 个用户，并且 UserId 和 OpenId 二选一，其他字段不需要传
      */
     Users: Array<UserInfo>;
     /**
@@ -3259,11 +3279,11 @@ export interface CreateIntegrationUserRolesRequest {
      */
     Operator: UserInfo;
     /**
-     * 绑定角色的用户id列表
+     * 绑定角色的用户id列表，不能重复，不能大于 100 个
      */
     UserIds: Array<string>;
     /**
-     * 绑定角色的角色id列表
+     * 绑定角色的角色id列表，不能重复，不能大于 100，可以通过DescribeIntegrationRoles接口获取
      */
     RoleIds: Array<string>;
     /**
@@ -3520,16 +3540,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--不通知
      */
@@ -3599,11 +3620,11 @@ export interface ModifyIntegrationDepartmentRequest {
      */
     Operator: UserInfo;
     /**
-     * 电子签部门ID
+     * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
      */
     DeptId: string;
     /**
-     * 电子签父部门ID
+     * 电子签父部门ID，通过DescribeIntegrationDepartments接口可以获取
      */
     ParentDeptId?: string;
     /**
@@ -3977,7 +3998,7 @@ export interface DeleteIntegrationDepartmentRequest {
      */
     Operator: UserInfo;
     /**
-     * 电子签中的部门id
+     * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
      */
     DeptId: string;
     /**
@@ -4064,7 +4085,11 @@ export interface StartFlowRequest {
      */
     Agent?: Agent;
     /**
-     * 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
+     * 给关注人发送短信通知的类型，
+  
+  0-合同发起时通知
+  
+  1-签署完成后通知
      */
     CcNotifyType?: number;
 }
@@ -4623,11 +4648,11 @@ export interface DescribeExtendedServiceAuthInfosRequest {
  */
 export interface DescribeIntegrationRolesResponse {
     /**
-     * 偏移量，默认为0，最大为2000
+     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
      */
     Offset?: number;
     /**
-     * 返回最大数量，最大为200
+     * 指定每页多少条数据，单页最大200
      */
     Limit?: number;
     /**
@@ -4665,7 +4690,7 @@ export interface CreateFlowRemindsRequest {
  */
 export interface UpdateIntegrationEmployeesRequest {
     /**
-     * 当前用户信息，OpenId与UserId二选一必填一个，OpenId是第三方客户ID，userId是用户实名后的电子签生成的ID,当传入客户系统openId，传入的openId需与电子签员工userId绑定，且参数Channel必填，Channel值为YUFU；
+     * 当前用户信息，UserId必填
      */
     Operator: UserInfo;
     /**
@@ -5266,7 +5291,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
      */
     ActivedTotal?: number;
     /**
-     * 导出文件的url
+     * 如果入参Export为 true 时使用，表示导出Excel的url
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ExportUrl?: string;