tencentcloud-sdk-nodejs-ess 4.0.453 → 4.0.455

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

@@ -16,18 +16,73 @@
  */
 
 /**
- * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
+ * 合同文件验签单个结果结构体
  */
-export interface UploadFile {
+export interface PdfVerifyResult {
   /**
-   * Base64编码后的文件内容
+   * 验签结果
    */
-  FileBody: string
+  VerifyResult: number
 
   /**
-   * 文件名，最大长度不超过200字符
+   * 签署平台
    */
-  FileName?: string
+  SignPlatform: string
+
+  /**
+   * 签署人名称
+   */
+  SignerName: string
+
+  /**
+   * 签署时间
+   */
+  SignTime: number
+
+  /**
+   * 签名算法
+   */
+  SignAlgorithm: string
+
+  /**
+   * 签名证书序列号
+   */
+  CertSn: string
+
+  /**
+   * 证书起始时间
+   */
+  CertNotBefore: number
+
+  /**
+   * 证书过期时间
+   */
+  CertNotAfter: number
+
+  /**
+   * 签名域横坐标
+   */
+  ComponentPosX: number
+
+  /**
+   * 签名域纵坐标
+   */
+  ComponentPosY: number
+
+  /**
+   * 签名域宽度
+   */
+  ComponentWidth: number
+
+  /**
+   * 签名域高度
+   */
+  ComponentHeight: number
+
+  /**
+   * 签名域所在页码
+   */
+  ComponentPage: number
 }
 
 /**
@@ -181,6 +236,31 @@ export interface CreateDocumentResponse {
   RequestId?: string
 }
 
+/**
+ * DescribeIntegrationEmployees请求参数结构体
+ */
+export interface DescribeIntegrationEmployeesRequest {
+  /**
+   * 操作人信息，userId必填
+   */
+  Operator: UserInfo
+
+  /**
+   * 返回最大数量，最大为20
+   */
+  Limit: number
+
+  /**
+   * 查询过滤实名用户，key为Status，Values为["IsVerified"]
+   */
+  Filters?: Array<Filter>
+
+  /**
+   * 偏移量，默认为0，最大为20000
+   */
+  Offset?: number
+}
+
 /**
  * StartFlow请求参数结构体
  */
@@ -344,6 +424,21 @@ false：有序签
   Agent?: Agent
 }
 
+/**
+ * 集成版员工部门信息
+ */
+export interface Department {
+  /**
+   * 部门id
+   */
+  DepartmentId: string
+
+  /**
+   * 部门名称
+   */
+  DepartmentName: string
+}
+
 /**
  * CreateSchemeUrl请求参数结构体
  */
@@ -397,6 +492,33 @@ APP：第三方APP或小程序跳转电子签小程序的path。
   Agent?: Agent
 }
 
+/**
+ * 删除员工结果
+ */
+export interface DeleteStaffsResult {
+  /**
+      * 删除员工的成功数据
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SuccessEmployeeData: Array<SuccessDeleteStaffData>
+
+  /**
+      * 删除员工的失败数据
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FailedEmployeeData: Array<FailedDeleteStaffData>
+}
+
+/**
+ * DescribeThirdPartyAuthCode请求参数结构体
+ */
+export interface DescribeThirdPartyAuthCodeRequest {
+  /**
+   * 电子签小程序跳转客户小程序时携带的授权查看码
+   */
+  AuthCode: string
+}
+
 /**
  * 下载文件的URL信息
  */
@@ -414,13 +536,18 @@ export interface FileUrl {
 }
 
 /**
- * DescribeThirdPartyAuthCode请求参数结构体
+ * DeleteIntegrationEmployees返回参数结构体
  */
-export interface DescribeThirdPartyAuthCodeRequest {
+export interface DeleteIntegrationEmployeesResponse {
   /**
-   * 电子签小程序跳转客户小程序时携带的授权查看码
+   * 员工删除数据
    */
-  AuthCode: string
+  DeleteEmployeeResult: DeleteStaffsResult
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -439,23 +566,50 @@ export interface Filter {
 }
 
 /**
- * 一码多扫签署二维码对象
+ * DeleteIntegrationEmployees请求参数结构体
  */
-export interface SignQrCode {
+export interface DeleteIntegrationEmployeesRequest {
   /**
-   * 二维码id
+   * 操作人信息，userId必填
    */
-  QrCodeId: string
+  Operator: UserInfo
 
   /**
-   * 二维码url
+   * 待移除员工的信息，userId和openId二选一，必填一个
    */
-  QrCodeUrl: string
+  Employees: Array<Staff>
+}
 
+/**
+ * DescribeIntegrationEmployees返回参数结构体
+ */
+export interface DescribeIntegrationEmployeesResponse {
   /**
-   * 二维码过期时间
+      * 员工数据列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Employees: Array<Staff>
+
+  /**
+      * 偏移量，默认为0，最大为20000
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Offset: number
+
+  /**
+   * 返回最大数量，最大为20
    */
-  ExpiredTime: number
+  Limit: number
+
+  /**
+   * 符合条件的员工数量
+   */
+  TotalCount: number
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -795,6 +949,21 @@ export interface UploadFilesResponse {
   RequestId?: string
 }
 
+/**
+ * CreateIntegrationEmployees返回参数结构体
+ */
+export interface CreateIntegrationEmployeesResponse {
+  /**
+   * 创建员工的结果
+   */
+  CreateEmployeeResult: CreateStaffResult
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeThirdPartyAuthCode返回参数结构体
  */
@@ -864,6 +1033,21 @@ export interface FlowDetailInfo {
   FlowApproverInfos: Array<FlowApproverDetail>
 }
 
+/**
+ * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
+ */
+export interface UploadFile {
+  /**
+   * Base64编码后的文件内容
+   */
+  FileBody: string
+
+  /**
+   * 文件名，最大长度不超过200字符
+   */
+  FileName?: string
+}
+
 /**
  * CreateFlowByFiles返回参数结构体
  */
@@ -890,33 +1074,23 @@ export interface CreateFlowByFilesResponse {
 }
 
 /**
- * 机构信息
+ * 创建员工的失败数据
  */
-export interface OrganizationInfo {
-  /**
-   * 机构在平台的编号
-   */
-  OrganizationId?: string
-
-  /**
-   * 用户渠道
-   */
-  Channel?: string
-
+export interface FailedCreateStaffData {
   /**
-   * 用户在渠道的机构编号
+   * 员工名
    */
-  OrganizationOpenId?: string
+  DisplayName: string
 
   /**
-   * 用户真实的IP
+   * 员工手机号
    */
-  ClientIp?: string
+  Mobile: string
 
   /**
-   * 机构的代理IP
+   * 失败原因
    */
-  ProxyIp?: string
+  Reason: string
 }
 
 /**
@@ -939,6 +1113,26 @@ export interface DescribeFlowBriefsRequest {
   Agent?: Agent
 }
 
+/**
+ * 创建员工的成功数据
+ */
+export interface SuccessCreateStaffData {
+  /**
+   * 员工名
+   */
+  DisplayName: string
+
+  /**
+   * 员工手机号
+   */
+  Mobile: string
+
+  /**
+   * 员工在电子签平台的id
+   */
+  UserId: string
+}
+
 /**
  * 签署参与者信息
  */
@@ -1118,102 +1312,52 @@ export interface VerifyPdfResponse {
 }
 
 /**
- * DescribeFileUrls请求参数结构体
+ * CreateIntegrationEmployees请求参数结构体
  */
-export interface DescribeFileUrlsRequest {
+export interface CreateIntegrationEmployeesRequest {
   /**
-      * 文件对应的业务类型，目前支持：
-- 模板 "TEMPLATE"
-- 文档 "DOCUMENT"
-- 印章  “SEAL”
-- 流程 "FLOW"
-      */
-  BusinessType: string
+   * 操作人信息，userId必填
+   */
+  Operator: UserInfo
 
   /**
-      * 业务编号的数组，如模板编号、文档编号、印章编号
-最大支持20个资源
+   * 待创建员工的信息，Mobile和DisplayName必填
+   */
+  Employees: Array<Staff>
+}
+
+/**
+ * 参与者信息
+ */
+export interface ApproverInfo {
+  /**
+      * 参与者类型：
+0：企业
+1：个人
+3：企业静默签署
+注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
       */
-  BusinessIds: Array<string>
+  ApproverType: number
 
   /**
-   * 操作者信息
+   * 本环节需要操作人的名字
    */
-  Operator: UserInfo
+  ApproverName: string
 
   /**
-   * 应用相关信息
+   * 本环节需要操作人的手机号
    */
-  Agent?: Agent
+  ApproverMobile: string
 
   /**
-   * 下载后的文件命名，只有fileType为zip的时候生效
+   * 本环节操作人签署控件配置
    */
-  FileName?: string
+  SignComponents: Array<Component>
 
   /**
-   * 文件类型，"JPG", "PDF","ZIP"等
+   * 如果是企业,则为企业的名字
    */
-  FileType?: string
-
-  /**
-   * 指定资源起始偏移量，默认0
-   */
-  Offset?: number
-
-  /**
-   * 指定资源数量，查询全部资源则传入-1
-   */
-  Limit?: number
-
-  /**
-   * 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)
-   */
-  UrlTtl?: number
-
-  /**
-   * 暂不开放
-   */
-  Scene?: string
-
-  /**
-   * 暂不开放
-   */
-  CcToken?: string
-}
-
-/**
- * 参与者信息
- */
-export interface ApproverInfo {
-  /**
-      * 参与者类型：
-0：企业
-1：个人
-3：企业静默签署
-注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
-      */
-  ApproverType: number
-
-  /**
-   * 本环节需要操作人的名字
-   */
-  ApproverName: string
-
-  /**
-   * 本环节需要操作人的手机号
-   */
-  ApproverMobile: string
-
-  /**
-   * 本环节操作人签署控件配置
-   */
-  SignComponents: Array<Component>
-
-  /**
-   * 如果是企业,则为企业的名字
-   */
-  OrganizationName?: string
+  OrganizationName?: string
 
   /**
    * 身份证号
@@ -1320,73 +1464,25 @@ export interface DescribeFlowTemplatesResponse {
 }
 
 /**
- * 合同文件验签单个结果结构体
+ * 删除员工失败数据
  */
-export interface PdfVerifyResult {
-  /**
-   * 验签结果
-   */
-  VerifyResult: number
-
-  /**
-   * 签署平台
-   */
-  SignPlatform: string
-
-  /**
-   * 签署人名称
-   */
-  SignerName: string
-
-  /**
-   * 签署时间
-   */
-  SignTime: number
-
-  /**
-   * 签名算法
-   */
-  SignAlgorithm: string
-
-  /**
-   * 签名证书序列号
-   */
-  CertSn: string
-
-  /**
-   * 证书起始时间
-   */
-  CertNotBefore: number
-
-  /**
-   * 证书过期时间
-   */
-  CertNotAfter: number
-
-  /**
-   * 签名域横坐标
-   */
-  ComponentPosX: number
-
-  /**
-   * 签名域纵坐标
-   */
-  ComponentPosY: number
-
+export interface FailedDeleteStaffData {
   /**
-   * 签名域宽度
-   */
-  ComponentWidth: number
+      * 员工在电子签的userId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UserId: string
 
   /**
-   * 签名域高度
-   */
-  ComponentHeight: number
+      * 员工在第三方平台的openId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OpenId: string
 
   /**
-   * 签名域所在页码
+   * 失败原因
    */
-  ComponentPage: number
+  Reason: string
 }
 
 /**
@@ -1429,6 +1525,23 @@ export interface CreateBatchCancelFlowUrlResponse {
   RequestId?: string
 }
 
+/**
+ * 创建员工的结果
+ */
+export interface CreateStaffResult {
+  /**
+      * 创建员工的成功列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SuccessEmployeeData: Array<SuccessCreateStaffData>
+
+  /**
+      * 创建员工的失败列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FailedEmployeeData: Array<FailedCreateStaffData>
+}
+
 /**
  * UploadFiles请求参数结构体
  */
@@ -1475,6 +1588,138 @@ false--否，不处理
   CustomIds?: Array<string>
 }
 
+/**
+ * 一码多扫签署二维码对象
+ */
+export interface SignQrCode {
+  /**
+   * 二维码id
+   */
+  QrCodeId: string
+
+  /**
+   * 二维码url
+   */
+  QrCodeUrl: string
+
+  /**
+   * 二维码过期时间
+   */
+  ExpiredTime: number
+}
+
+/**
+ * 集成版企业角色信息
+ */
+export interface StaffRole {
+  /**
+      * 角色id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  RoleId: string
+
+  /**
+      * 角色名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  RoleName: string
+}
+
+/**
+ * DescribeFileUrls请求参数结构体
+ */
+export interface DescribeFileUrlsRequest {
+  /**
+      * 文件对应的业务类型，目前支持：
+- 模板 "TEMPLATE"
+- 文档 "DOCUMENT"
+- 印章  “SEAL”
+- 流程 "FLOW"
+      */
+  BusinessType: string
+
+  /**
+      * 业务编号的数组，如模板编号、文档编号、印章编号
+最大支持20个资源
+      */
+  BusinessIds: Array<string>
+
+  /**
+   * 操作者信息
+   */
+  Operator: UserInfo
+
+  /**
+   * 应用相关信息
+   */
+  Agent?: Agent
+
+  /**
+   * 下载后的文件命名，只有fileType为zip的时候生效
+   */
+  FileName?: string
+
+  /**
+   * 文件类型，"JPG", "PDF","ZIP"等
+   */
+  FileType?: string
+
+  /**
+   * 指定资源起始偏移量，默认0
+   */
+  Offset?: number
+
+  /**
+   * 指定资源数量，查询全部资源则传入-1
+   */
+  Limit?: number
+
+  /**
+   * 下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)
+   */
+  UrlTtl?: number
+
+  /**
+   * 暂不开放
+   */
+  Scene?: string
+
+  /**
+   * 暂不开放
+   */
+  CcToken?: string
+}
+
+/**
+ * 机构信息
+ */
+export interface OrganizationInfo {
+  /**
+   * 机构在平台的编号
+   */
+  OrganizationId?: string
+
+  /**
+   * 用户渠道
+   */
+  Channel?: string
+
+  /**
+   * 用户在渠道的机构编号
+   */
+  OrganizationOpenId?: string
+
+  /**
+   * 用户真实的IP
+   */
+  ClientIp?: string
+
+  /**
+   * 机构的代理IP
+   */
+  ProxyIp?: string
+}
+
 /**
  * StartFlow返回参数结构体
  */
@@ -1555,6 +1800,26 @@ export interface CreateBatchCancelFlowUrlRequest {
   FlowIds: Array<string>
 }
 
+/**
+ * 删除员工的成功数据
+ */
+export interface SuccessDeleteStaffData {
+  /**
+   * 员工名
+   */
+  DisplayName: string
+
+  /**
+   * 员工手机号
+   */
+  Mobile: string
+
+  /**
+   * 员工在电子签平台的id
+   */
+  UserId: string
+}
+
 /**
  * CreateMultiFlowSignQRCode请求参数结构体
  */
@@ -2141,3 +2406,63 @@ export interface CcInfo {
    */
   Mobile?: string
 }
+
+/**
+ * 企业员工信息
+ */
+export interface Staff {
+  /**
+   * 用户在电子签平台的id
+   */
+  UserId?: string
+
+  /**
+   * 显示的用户名/昵称
+   */
+  DisplayName?: string
+
+  /**
+   * 用户手机号
+   */
+  Mobile?: string
+
+  /**
+      * 用户邮箱
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Email?: string
+
+  /**
+      * 用户在第三方平台id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OpenId?: string
+
+  /**
+      * 员工角色
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Roles?: Array<StaffRole>
+
+  /**
+      * 员工部门
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Department?: Department
+
+  /**
+   * 员工是否实名
+   */
+  Verified?: boolean
+
+  /**
+   * 员工创建时间戳
+   */
+  CreatedOn?: number
+
+  /**
+      * 员工实名时间戳
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  VerifiedOn?: number
+}