tencentcloud-sdk-nodejs 4.0.566 → 4.0.567

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

@@ -34,48 +34,46 @@ export interface Department {
     DepartmentName: string;
 }
 /**
- * CreateSchemeUrl请求参数结构体
+ * CreatePreparedPersonalEsign请求参数结构体
  */
-export interface CreateSchemeUrlRequest {
+export interface CreatePreparedPersonalEsignRequest {
     /**
-      * 调用方用户信息，userId 必填
+      * 个人用户名称
       */
-    Operator: UserInfo;
+    UserName: string;
     /**
-      * 企业名称
+      * 身份证件号码
       */
-    OrganizationName?: string;
-    /**
-      * 姓名,最大长度50个字符
-      */
-    Name?: string;
+    IdCardNumber: string;
     /**
-      * 手机号，大陆手机号11位
+      * 印章图片的base64
       */
-    Mobile?: string;
+    SealImage: string;
     /**
-      * 链接类型
-HTTP：跳转电子签小程序的http_url，
-APP：第三方APP或小程序跳转电子签小程序的path。
-默认为HTTP类型
+      * 印章名称
       */
-    EndPoint?: string;
+    SealName: string;
     /**
-      * 签署流程编号 (PathType=1时必传)
+      * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
       */
-    FlowId?: string;
+    Operator?: UserInfo;
     /**
-      * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
+      * 身份证件类型:
+ID_CARD 身份证
+PASSPORT 护照
+HONGKONG_AND_MACAO 香港身份
+FOREIGN_ID_CARD 国外身份
+HONGKONG_MACAO_AND_TAIWAN 港台身份
       */
-    PathType?: number;
+    IdCardType?: string;
     /**
-      * 是否自动回跳 true：是， false：否。该参数只针对"APP" 类型的签署链接有效
+      * 手机号码
       */
-    AutoJumpBack?: boolean;
+    Mobile?: string;
     /**
-      * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+      * 是否需开通自动签
       */
-    Agent?: Agent;
+    EnableAutoSign?: boolean;
 }
 /**
  * 二期接口返回的模板中文件的信息结构
@@ -255,6 +253,10 @@ export interface CreateIntegrationEmployeesRequest {
       * 待创建员工的信息，Mobile和DisplayName必填
       */
     Employees: Array<Staff>;
+    /**
+      * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+      */
+    Agent?: Agent;
 }
 /**
  * CreateFlowEvidenceReport请求参数结构体
@@ -754,6 +756,50 @@ false：有序签
       */
     CcInfos?: Array<CcInfo>;
 }
+/**
+ * CreateSchemeUrl请求参数结构体
+ */
+export interface CreateSchemeUrlRequest {
+    /**
+      * 调用方用户信息，userId 必填
+      */
+    Operator: UserInfo;
+    /**
+      * 企业名称
+      */
+    OrganizationName?: string;
+    /**
+      * 姓名,最大长度50个字符
+      */
+    Name?: string;
+    /**
+      * 手机号，大陆手机号11位
+      */
+    Mobile?: string;
+    /**
+      * 链接类型
+HTTP：跳转电子签小程序的http_url，
+APP：第三方APP或小程序跳转电子签小程序的path。
+默认为HTTP类型
+      */
+    EndPoint?: string;
+    /**
+      * 签署流程编号 (PathType=1时必传)
+      */
+    FlowId?: string;
+    /**
+      * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
+      */
+    PathType?: number;
+    /**
+      * 是否自动回跳 true：是， false：否。该参数只针对"APP" 类型的签署链接有效
+      */
+    AutoJumpBack?: boolean;
+    /**
+      * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+      */
+    Agent?: Agent;
+}
 /**
  * 自动签开启、签署相关配置
  */
@@ -1491,7 +1537,7 @@ export interface Staff {
       */
     Email?: string;
     /**
-      * 用户在第三方平台id
+      * 用户在第三方平台id，如需在此接口提醒员工实名，该参数不传
 注意：此字段可能返回 null，表示取不到有效值。
       */
     OpenId?: string;
@@ -1523,6 +1569,14 @@ export interface Staff {
 注意：此字段可能返回 null，表示取不到有效值。
       */
     QuiteJob?: number;
+    /**
+      * 员工离职交接人用户id
+      */
+    ReceiveUserId?: string;
+    /**
+      * 员工离职交接人用户OpenId
+      */
+    ReceiveOpenId?: string;
 }
 /**
  * CreateFlowEvidenceReport返回参数结构体
@@ -1699,6 +1753,19 @@ export interface RemindFlowRecords {
       */
     RemindMessage: string;
 }
+/**
+ * CreatePreparedPersonalEsign返回参数结构体
+ */
+export interface CreatePreparedPersonalEsignResponse {
+    /**
+      * 导入生成的印章ID
+      */
+    SealId?: string;
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
+}
 /**
  * DescribeOrganizationSeals返回参数结构体
  */
@@ -1728,6 +1795,10 @@ export interface DeleteIntegrationEmployeesRequest {
       * 待移除员工的信息，userId和openId二选一，必填一个
       */
     Employees: Array<Staff>;
+    /**
+      * 代理信息
+      */
+    Agent?: Agent;
 }
 /**
  * 一码多扫签署二维码对象
@@ -1787,7 +1858,7 @@ export interface CreateIntegrationEmployeesResponse {
     /**
       * 创建员工的结果
       */
-    CreateEmployeeResult: CreateStaffResult;
+    CreateEmployeeResult?: CreateStaffResult;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
@@ -1938,6 +2009,11 @@ export interface SuccessCreateStaffData {
       * 员工在电子签平台的id
       */
     UserId: string;
+    /**
+      * 提示，当创建已存在未实名用户时，改字段有值
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Note?: string;
 }
 /**
  * 签署参与者信息
@@ -2001,7 +2077,7 @@ export interface Recipient {
  */
 export interface VerifyPdfRequest {
     /**
-      * 合同Id，流程Id
+      * 流程ID
       */
     FlowId: string;
     /**
@@ -2618,7 +2694,7 @@ MULTI_LINE_TEXT - 多行文本控件，输入文本字符串；
 CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
 FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID；
 DYNAMIC_TABLE - 动态表格控件；
-ATTACHMENT - 附件控件,ComponentValue 填写福建图片的资源 ID列表，以逗号分割；
+ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分割；
 SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容；
 DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串；
 DISTRICT - 省市区行政区划控件，ComponentValue填写省市区行政区划字符串内容；
@@ -2857,7 +2933,7 @@ export interface DeleteIntegrationEmployeesResponse {
     /**
       * 员工删除数据
       */
-    DeleteEmployeeResult: DeleteStaffsResult;
+    DeleteEmployeeResult?: DeleteStaffsResult;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
@@ -2887,16 +2963,15 @@ export interface VerifyPdfResponse {
     /**
       * 验签结果，1-文件未被篡改，全部签名在腾讯电子签完成； 2-文件未被篡改，部分签名在腾讯电子签完成；3-文件被篡改；4-异常：文件内没有签名域；5-异常：文件签名格式错误
       */
-    VerifyResult: number;
+    VerifyResult?: number;
     /**
-      * 验签结果详情,内部状态1-验签成功，在电子签签署；2-验签成功，在其他平台签署；3-验签失败；4-pdf文件没有签名域
-；5-文件签名格式错误
+      * 验签结果详情,内部状态1-验签成功，在电子签签署；2-验签成功，在其他平台签署；3-验签失败；4-pdf文件没有签名域；5-文件签名格式错误
       */
-    PdfVerifyResults: Array<PdfVerifyResult>;
+    PdfVerifyResults?: Array<PdfVerifyResult>;
     /**
       * 验签序列号
       */
-    VerifySerialNo: string;
+    VerifySerialNo?: string;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */

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

@@ -1,6 +1,6 @@
 import { AbstractClient } from "../../../common/abstract_client";
 import { ClientConfig } from "../../../common/interface";
-import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, ChannelCreateFlowSignUrlResponse, CreateSealByImageResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowGroupByFilesRequest, DescribeFlowDetailInfoResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, UploadFilesRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeUsageResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, DescribeResourceUrlsByFlowsResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelGetTaskResultApiRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, SyncProxyOrganizationOperatorsResponse, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDescribeOrganizationSealsResponse, ChannelCreatePrepareFlowResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelCreateReleaseFlowRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreateBoundFlowsResponse, ModifyExtendedServiceResponse, ChannelGetTaskResultApiResponse, ChannelDeleteSealPoliciesResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, ChannelUpdateSealStatusRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest } from "./essbasic_models";
+import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, ChannelCreateFlowSignUrlResponse, CreateSealByImageResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, UploadFilesRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeUsageResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelGetTaskResultApiRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, SyncProxyOrganizationOperatorsResponse, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDescribeOrganizationSealsResponse, ChannelCreatePrepareFlowResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreateBoundFlowsResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelDeleteSealPoliciesResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, ChannelUpdateSealStatusRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest } from "./essbasic_models";
 /**
  * essbasic client
  * @class
@@ -67,6 +67,14 @@ export declare class Client extends AbstractClient {
 客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
      */
     ChannelDescribeOrganizationSeals(req: ChannelDescribeOrganizationSealsRequest, cb?: (error: string, rep: ChannelDescribeOrganizationSealsResponse) => void): Promise<ChannelDescribeOrganizationSealsResponse>;
+    /**
+     * 渠道版删除员工绑定角色
+     */
+    ChannelDeleteRoleUsers(req: ChannelDeleteRoleUsersRequest, cb?: (error: string, rep: ChannelDeleteRoleUsersResponse) => void): Promise<ChannelDeleteRoleUsersResponse>;
+    /**
+     * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板
+     */
+    DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
     /**
      * 创建跳转小程序查看或签署的链接。
 
@@ -178,15 +186,19 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
 合同发起人必须在电子签已经进行实名。
      */
     CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
+    /**
+     * 渠道办查询用户角色
+     */
+    ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise<ChannelDescribeRolesResponse>;
     /**
      * 根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。
 此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
      */
     DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
     /**
-     * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板
+     * 渠道版绑定员工角色
      */
-    DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
+    ChannelCreateUserRoles(req: ChannelCreateUserRolesRequest, cb?: (error: string, rep: ChannelCreateUserRolesResponse) => void): Promise<ChannelCreateUserRolesResponse>;
     /**
      * 此接口（UploadFiles）用于文件上传。
 其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。

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

@@ -113,6 +113,18 @@ class Client extends abstract_client_1.AbstractClient {
     async ChannelDescribeOrganizationSeals(req, cb) {
         return this.request("ChannelDescribeOrganizationSeals", req, cb);
     }
+    /**
+     * 渠道版删除员工绑定角色
+     */
+    async ChannelDeleteRoleUsers(req, cb) {
+        return this.request("ChannelDeleteRoleUsers", req, cb);
+    }
+    /**
+     * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板
+     */
+    async DescribeTemplates(req, cb) {
+        return this.request("DescribeTemplates", req, cb);
+    }
     /**
      * 创建跳转小程序查看或签署的链接。
 
@@ -256,6 +268,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
     async CreateFlowsByTemplates(req, cb) {
         return this.request("CreateFlowsByTemplates", req, cb);
     }
+    /**
+     * 渠道办查询用户角色
+     */
+    async ChannelDescribeRoles(req, cb) {
+        return this.request("ChannelDescribeRoles", req, cb);
+    }
     /**
      * 根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。
 此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
@@ -264,10 +282,10 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
         return this.request("DescribeResourceUrlsByFlows", req, cb);
     }
     /**
-     * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板
+     * 渠道版绑定员工角色
      */
-    async DescribeTemplates(req, cb) {
-        return this.request("DescribeTemplates", req, cb);
+    async ChannelCreateUserRoles(req, cb) {
+        return this.request("ChannelCreateUserRoles", req, cb);
     }
     /**
      * 此接口（UploadFiles）用于文件上传。