tencentcloud-sdk-nodejs-ess 4.0.611 → 4.0.613

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

@@ -94,11 +94,6 @@ export interface CreatePreparedPersonalEsignRequest {
    */
   SealName: string
 
-  /**
-   * 印章图片的base64，最大不超过 8M
-   */
-  SealImage: string
-
   /**
    * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
    */
@@ -114,6 +109,13 @@ HONGKONG_MACAO_AND_TAIWAN 中国台湾
       */
   IdCardType?: string
 
+  /**
+      * 印章图片的base64
+注：已废弃
+请先通过UploadFiles接口上传文件，获取 FileId
+      */
+  SealImage?: string
+
   /**
    * 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
    */
@@ -146,6 +148,13 @@ BLUE 蓝色。
 true：做透明化处理和颜色增强。
       */
   ProcessSeal?: boolean
+
+  /**
+      * 印章图片文件 id
+取值：
+填写的FileId通过UploadFiles接口上传文件获取。
+      */
+  FileId?: string
 }
 
 /**
@@ -232,7 +241,7 @@ export interface FlowCreateApprover {
 0：企业
 1：个人
 3：企业静默签署
-注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
+注：类型为3（企业静默签署）时，会默认完成该签署方的签署。静默签署仅进行盖章操作，不能是手写签名。
       */
   ApproverType: number
 
@@ -264,7 +273,7 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
   ApproverIdCardNumber?: string
 
   /**
-   * 签署方经办人在模板中的角色ID
+   * 签署方经办人在模板中的参与方ID
    */
   RecipientId?: string
 
@@ -629,38 +638,41 @@ export interface Agent {
  */
 export interface FlowApproverDetail {
   /**
-      * 签署人信息
+      * 签署时的相关信息
 注意：此字段可能返回 null，表示取不到有效值。
       */
   ApproveMessage?: string
 
   /**
-   * 签署人名字
+   * 签署方姓名
    */
   ApproveName: string
 
   /**
-      * 签署人的状态
+      * 签署方的签署状态
 0：还没有发起
 1：流程中 没有开始处理
-2：待处理
-3：签署态
-4：拒绝态
-5：过期没人处理
-6：取消态
+2：待签署
+3：已签署
+4：已拒绝
+5：已过期
+6：已撤销
 7：还没有预发起
 8：待填写
 9：因为各种原因而终止
+10：填写完成
+15：已解除
+19：转他人处理
       */
   ApproveStatus: number
 
   /**
-   * 模板配置时候的签署人id,与控件绑定
+   * 模板配置中的参与方ID,与控件绑定
    */
   ReceiptId: string
 
   /**
-      * 客户自定义userId
+      * 客户自定义的用户ID
 注意：此字段可能返回 null，表示取不到有效值。
       */
   CustomUserId: string
@@ -671,41 +683,41 @@ export interface FlowApproverDetail {
   Mobile: string
 
   /**
-   * 签署顺序
+   * 签署顺序，如果是有序签署，签署顺序从小到大
    */
   SignOrder: number
 
   /**
-   * 签署人签署时间
+   * 签署人签署时间，时间戳，单位秒
    */
   ApproveTime: number
 
   /**
-      * 参与者类型
+      * 签署方类型，ORGANIZATION-企业员工，PERSON-个人，ENTERPRISESERVER-企业静默签
 注意：此字段可能返回 null，表示取不到有效值。
       */
   ApproveType: string
 
   /**
-      * 签署人侧用户来源
+      * 签署方侧用户来源，如WEWORKAPP-企业微信等
 注意：此字段可能返回 null，表示取不到有效值。
       */
   ApproverSource: string
 
   /**
-      * 客户自定义签署人标识
+      * 客户自定义签署方标识
 注意：此字段可能返回 null，表示取不到有效值。
       */
   CustomApproverTag: string
 
   /**
-      * 签署人企业Id
+      * 签署方企业Id
 注意：此字段可能返回 null，表示取不到有效值。
       */
   OrganizationId: string
 
   /**
-      * 签署人企业名称
+      * 签署方企业名称
 注意：此字段可能返回 null，表示取不到有效值。
       */
   OrganizationName: string
@@ -725,6 +737,16 @@ export interface DescribeFlowTemplatesRequest {
    */
   Agent?: Agent
 
+  /**
+   * 查询内容：0-模板列表及详情（默认），1-仅模板列表
+   */
+  ContentType?: number
+
+  /**
+   * 搜索条件，具体参考Filter结构体。本接口取值：template-id：按照【 **模板唯一标识** 】进行过滤
+   */
+  Filters?: Array<Filter>
+
   /**
    * 查询偏移位置，默认0
    */
@@ -735,11 +757,6 @@ export interface DescribeFlowTemplatesRequest {
    */
   Limit?: number
 
-  /**
-   * 搜索条件，具体参考Filter结构体。本接口取值：template-id：按照【 **模板唯一标识** 】进行过滤
-   */
-  Filters?: Array<Filter>
-
   /**
       * 这个参数跟下面的IsChannel参数配合使用。
 IsChannel=false时，ApplicationId参数不起任何作用。
@@ -754,11 +771,6 @@ ApplicationId为空，查询所有应用下的模板列表
       */
   IsChannel?: boolean
 
-  /**
-   * 查询内容：0-模板列表及详情（默认），1-仅模板列表
-   */
-  ContentType?: number
-
   /**
    * 暂未开放
    */
@@ -803,13 +815,23 @@ export interface CallbackInfo {
   CallbackUrl: string
 
   /**
-   * 回调加密token
+   * 回调加密key，已废弃
+   */
+  Token?: string
+
+  /**
+   * 回调加密key
    */
-  Token: string
+  CallbackKey?: string
+
+  /**
+   * 回调验签token
+   */
+  CallbackToken?: string
 }
 
 /**
- * 二期接口返回的模板的信息结构
+ * 企业模板的信息结构
  */
 export interface TemplateInfo {
   /**
@@ -828,7 +850,7 @@ export interface TemplateInfo {
   Description?: string
 
   /**
-   * 模板关联的资源IDs
+   * 模板关联的资源ID列表
    */
   DocumentResourceIds?: Array<string>
 
@@ -838,7 +860,7 @@ export interface TemplateInfo {
   FileInfos?: Array<FileInfo>
 
   /**
-   * 附件关联的资源ID是
+   * 附件关联的资源ID
    */
   AttachmentResourceIds?: Array<string>
 
@@ -868,12 +890,12 @@ export interface TemplateInfo {
   Status?: number
 
   /**
-   * 模板的创建人
+   * 模板的创建人UserId
    */
   Creator?: string
 
   /**
-   * 模板创建的时间戳（精确到秒）
+   * 模板创建的时间戳，单位秒
    */
   CreatedOn?: number
 
@@ -896,12 +918,12 @@ export interface TemplateInfo {
   Available?: number
 
   /**
-   * 模板创建组织id
+   * 创建模板的机构id
    */
   OrganizationId?: string
 
   /**
-      * 模板预览链接
+      * 模板预览链接，有效时间5分钟
 注意：此字段可能返回 null，表示取不到有效值。
       */
   PreviewUrl?: string
@@ -954,6 +976,11 @@ export interface DescribeIntegrationEmployeesRequest {
    */
   Limit: number
 
+  /**
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   */
+  Agent?: Agent
+
   /**
       * 查询过滤实名用户，Key为Status，Values为["IsVerified"]
 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
@@ -1208,7 +1235,7 @@ export interface CreateReleaseFlowResponse {
  */
 export interface BindEmployeeUserIdWithClientOpenIdRequest {
   /**
-   * 用户信息，OpenId与UserId二选一必填一个，OpenId是第三方客户ID，userId是用户实名后的电子签生成的ID,当传入客户系统openId，传入的openId需与电子签员工userId绑定，且参数Channel必填，Channel值为INTEGRATE；当传入参数UserId，Channel无需指定
+   * 用户信息，OpenId与UserId二选一必填一个，OpenId是第三方客户ID，userId是用户实名后的电子签生成的ID,当传入客户系统openId，传入的openId需与电子签员工userId绑定，且参数Channel必填，Channel值为INTEGRATE；当传入参数UserId，Channel无需指定。（参数参考示例）
    */
   Operator: UserInfo
 
@@ -1293,7 +1320,7 @@ export interface DescribeUserAutoSignStatusResponse {
  */
 export interface FillApproverInfo {
   /**
-   * 签署人签署Id
+   * 对应模板中的参与方ID
    */
   RecipientId: string
 
@@ -1304,7 +1331,7 @@ WEWORKAPP: 企业微信
   ApproverSource: string
 
   /**
-      * 企业自定义账号Id
+      * 企业自定义账号ID
 WEWORKAPP场景下指企业自有应用获取企微明文的userid
       */
   CustomUserId: string
@@ -1325,12 +1352,12 @@ export interface OccupiedSeal {
   SealName: string
 
   /**
-   * 电子印章授权时间戳
+   * 电子印章授权时间戳，单位秒
    */
   CreateOn: number
 
   /**
-   * 电子印章授权人
+   * 电子印章授权人的UserId
    */
   Creator: string
 
@@ -1356,12 +1383,12 @@ export interface OccupiedSeal {
   Url: string
 
   /**
-   * 印章类型
+   * 印章类型,OFFICIAL-企业公章, CONTRACT-合同专用章,ORGANIZATIONSEAL-企业印章(本地上传印章类型),LEGAL_PERSON_SEAL-法人印章
    */
   SealType: string
 
   /**
-   * 用印申请是否为永久授权
+   * 用印申请是否为永久授权，true-是，false-否
    */
   IsAllTime: boolean
 
@@ -1414,7 +1441,7 @@ export interface PdfVerifyResult {
   SignerName: string
 
   /**
-   * 签署时间
+   * 签署时间戳，单位秒
    */
   SignTime: number
 
@@ -1429,37 +1456,37 @@ export interface PdfVerifyResult {
   CertSn: string
 
   /**
-   * 证书起始时间
+   * 证书起始时间戳，单位秒
    */
   CertNotBefore: number
 
   /**
-   * 证书过期时间
+   * 证书过期时间戳，单位秒
    */
   CertNotAfter: number
 
   /**
-   * 签名域横坐标
+   * 签名域横坐标，单位pt
    */
   ComponentPosX: number
 
   /**
-   * 签名域纵坐标
+   * 签名域纵坐标，单位pt
    */
   ComponentPosY: number
 
   /**
-   * 签名域宽度
+   * 签名域宽度，单位pt
    */
   ComponentWidth: number
 
   /**
-   * 签名域高度
+   * 签名域高度，单位pt
    */
   ComponentHeight: number
 
   /**
-   * 签名域所在页码
+   * 签名域所在页码，1～N
    */
   ComponentPage: number
 }
@@ -1527,7 +1554,7 @@ export interface SignQrCode {
   QrCodeUrl: string
 
   /**
-   * 二维码过期时间
+   * 二维码过期时间戳，单位秒
    */
   ExpiredTime: number
 }
@@ -1552,7 +1579,7 @@ export interface CreateSealPolicyResponse {
  */
 export interface DisableUserAutoSignRequest {
   /**
-   * 操作人信息
+   * 操作人信息,UserId必填
    */
   Operator: UserInfo
 
@@ -1663,7 +1690,7 @@ REJECT: 拒绝
   ReviewMessage?: string
 
   /**
-   * 应用相关信息
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
 }
@@ -1693,7 +1720,7 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
  */
 export interface CreateSchemeUrlResponse {
   /**
-   * 小程序链接地址
+   * 小程序链接地址，有效期5分钟
    */
   SchemeUrl?: string
 
@@ -1964,7 +1991,7 @@ DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo
  */
 export interface CreateChannelSubOrganizationModifyQrCodeRequest {
   /**
-   * 操作人
+   * 操作人信息，userId必填
    */
   Operator: UserInfo
 
@@ -2078,12 +2105,12 @@ export interface Staff {
   Verified?: boolean
 
   /**
-   * 员工创建时间戳
+   * 员工创建时间戳，单位秒
    */
   CreatedOn?: number
 
   /**
-      * 员工实名时间戳
+      * 员工实名时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
       */
   VerifiedOn?: number
@@ -2178,7 +2205,7 @@ export interface GroupOrganization {
   OrganizationId?: string
 
   /**
-      * 更新时间
+      * 更新时间，时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
       */
   UpdateTime?: number
@@ -2214,19 +2241,19 @@ export interface GroupOrganization {
   License?: string
 
   /**
-      * 企业许可证过期时间
+      * 企业许可证过期时间，时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
       */
   LicenseExpireTime?: number
 
   /**
-      * 成员企业加入集团时间
+      * 成员企业加入集团时间，时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
       */
   JoinTime?: number
 
   /**
-      * 是否可以使用审批流引擎
+      * 是否使用审批流引擎，true-是，false-否
 注意：此字段可能返回 null，表示取不到有效值。
       */
   FlowEngineEnable?: boolean
@@ -2303,7 +2330,7 @@ export interface CreateDocumentRequest {
  */
 export interface FlowDetailInfo {
   /**
-   * 合同(流程)的Id
+   * 合同(流程)的ID
    */
   FlowId: string
 
@@ -2321,16 +2348,17 @@ export interface FlowDetailInfo {
   /**
       * 流程状态
 - 0 还没有发起
-- 1 未签署
+- 1 待签署
 - 2 部分签署
-- 3 已退回
-- 4 完成签署
+- 3 已拒签
+- 4 已签署
 - 5 已过期
-- 6 已取消
+- 6 已撤销
 - 7 还没有预发起
 - 8 等待填写
 - 9 部分填写
 - 10 拒填
+- 21 已解除
       */
   FlowStatus: number
 
@@ -2347,12 +2375,12 @@ export interface FlowDetailInfo {
   FlowDescription: string
 
   /**
-   * 合同(流程)的创建时间戳
+   * 合同(流程)的创建时间戳，单位秒
    */
   CreatedOn: number
 
   /**
-   * 合同(流程)的签署人数组
+   * 合同(流程)的签署方数组
    */
   FlowApproverInfos: Array<FlowApproverDetail>
 
@@ -2463,7 +2491,7 @@ export interface GetTaskResultApiRequest {
   TaskId: string
 
   /**
-   * 操作人信息
+   * 操作人信息,UserId必填
    */
   Operator?: UserInfo
 
@@ -2513,7 +2541,7 @@ export interface CreateIntegrationEmployeesResponse {
  */
 export interface DeleteIntegrationRoleUsersRequest {
   /**
-   * 操作人
+   * 操作人信息，userId必填
    */
   Operator: UserInfo
 
@@ -2528,7 +2556,7 @@ export interface DeleteIntegrationRoleUsersRequest {
   Users: Array<UserInfo>
 
   /**
-   * 代理信息
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
 }
@@ -2595,7 +2623,7 @@ export interface CreateReleaseFlowRequest {
  */
 export interface CreateIntegrationUserRolesRequest {
   /**
-   * 操作人信息
+   * 操作人信息，UserId必填
    */
   Operator: UserInfo
 
@@ -2761,7 +2789,7 @@ export interface Recipient {
   RequireSign?: boolean
 
   /**
-   * 添加序列
+   * 添加序列，0～N
    */
   RoutingOrder?: number
 
@@ -2976,7 +3004,7 @@ export interface CreateStaffResult {
  */
 export interface CreateUserAutoSignEnableUrlRequest {
   /**
-   * 操作人信息
+   * 操作人信息,UserId必填
    */
   Operator: UserInfo
 
@@ -3033,7 +3061,7 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
  */
 export interface RemindFlowRecords {
   /**
-   * 是否能够催办
+   * 是否能够催办，true-是，false-否
    */
   CanRemind: boolean
 
@@ -3043,7 +3071,7 @@ export interface RemindFlowRecords {
   FlowId: string
 
   /**
-   * 催办详情
+   * 催办详情信息
    */
   RemindMessage: string
 }
@@ -3098,7 +3126,7 @@ export interface ApproverRestriction {
  */
 export interface DeleteSealPoliciesRequest {
   /**
-   * 操作撤销的用户信息
+   * 调用方用户信息，userId 必填
    */
   Operator: UserInfo
 
@@ -3107,11 +3135,6 @@ export interface DeleteSealPoliciesRequest {
    */
   PolicyIds?: Array<string>
 
-  /**
-   * 应用相关
-   */
-  Agent?: Agent
-
   /**
    * 印章ID。这个参数跟上面的PolicyIds其中一个必填，另外一个可选填
    */
@@ -3121,6 +3144,11 @@ export interface DeleteSealPoliciesRequest {
    * 待授权的员工ID
    */
   UserIds?: Array<string>
+
+  /**
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   */
+  Agent?: Agent
 }
 
 /**
@@ -3265,7 +3293,7 @@ export interface IntegrateRole {
   RoleStatus?: number
 
   /**
-      * 是否是集团角色
+      * 是否是集团角色，true-是，false-否
 注意：此字段可能返回 null，表示取不到有效值。
       */
   IsGroupRole?: boolean
@@ -3282,7 +3310,7 @@ export interface IntegrateRole {
  */
 export interface CreatePrepareFlowResponse {
   /**
-   * 快速发起预览链接
+   * 快速发起预览链接，有效期5分钟
    */
   Url?: string
 
@@ -3339,7 +3367,7 @@ ProcessTimeout - 转换文件超时
  */
 export interface CancelMultiFlowSignQRCodeRequest {
   /**
-   * 用户信息
+   * 调用方用户信息，userId 必填
    */
   Operator: UserInfo
 
@@ -3349,7 +3377,7 @@ export interface CancelMultiFlowSignQRCodeRequest {
   QrCodeId: string
 
   /**
-   * 应用信息
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
 }
@@ -3493,12 +3521,12 @@ export interface ApproverOption {
  */
 export interface FileUrl {
   /**
-   * 下载文件的URL
+   * 下载文件的URL，有效期为输入的UrlTtl，默认5分钟
    */
   Url: string
 
   /**
-      * 下载文件的附加信息
+      * 下载文件的附加信息。如果是pdf文件，会返回pdf文件每页的有效高宽
 注意：此字段可能返回 null，表示取不到有效值。
       */
   Option: string
@@ -3509,7 +3537,7 @@ export interface FileUrl {
  */
 export interface CreateSealPolicyRequest {
   /**
-   * 授权发起人在平台信息，具体参考UserInfo结构体
+   * 调用方用户信息，userId 必填
    */
   Operator: UserInfo
 
@@ -3529,19 +3557,19 @@ export interface CreateSealPolicyRequest {
   Expired: number
 
   /**
-   * 印章授权内容
+   * 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填，跟上面的Users同时起作用
    */
-  Policy?: string
+  UserIds?: Array<string>
 
   /**
-   * 应用相关
+   * 印章授权内容
    */
-  Agent?: Agent
+  Policy?: string
 
   /**
-   * 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填，跟上面的Users同时起作用
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
-  UserIds?: Array<string>
+  Agent?: Agent
 }
 
 /**
@@ -3610,7 +3638,7 @@ export interface CancelFlowRequest {
   CancelMessage: string
 
   /**
-   * 应用相关信息
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
 }
@@ -3953,12 +3981,12 @@ export interface DescribeFlowBriefsRequest {
   Operator: UserInfo
 
   /**
-   * 需要查询的流程ID列表，限制最大20个
+   * 需要查询的流程ID列表，限制最大100个
    */
   FlowIds: Array<string>
 
   /**
-   * 应用相关信息
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
 }
@@ -4047,7 +4075,7 @@ export interface DescribeFlowBriefsResponse {
   /**
    * 流程列表
    */
-  FlowBriefs: Array<FlowBrief>
+  FlowBriefs?: Array<FlowBrief>
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -4087,7 +4115,7 @@ export interface Caller {
   OrganizationId?: string
 
   /**
-   * 经办人的用户ID
+   * 经办人的用户ID，同UserId
    */
   OperatorId?: string
 
@@ -4107,7 +4135,7 @@ export interface DescribeFlowTemplatesResponse {
   Templates?: Array<TemplateInfo>
 
   /**
-   * 查询到的总个数
+   * 查询到的总数
    */
   TotalCount?: number
 
@@ -4217,7 +4245,7 @@ export interface CreateBatchCancelFlowUrlRequest {
  */
 export interface CreateMultiFlowSignQRCodeRequest {
   /**
-   * 用户信息
+   * 用户信息，其中UserId为必填参数
    */
   Operator: UserInfo
 
@@ -4285,7 +4313,7 @@ export interface DescribeFlowInfoRequest {
   FlowIds: Array<string>
 
   /**
-   * 调用方用户信息
+   * 调用方用户信息，userId 必填
    */
   Operator?: UserInfo
 
@@ -4359,7 +4387,7 @@ export interface CreateFlowResponse {
  */
 export interface DescribeUserAutoSignStatusRequest {
   /**
-   * 操作人信息
+   * 操作人信息，UserId必填
    */
   Operator: UserInfo
 
@@ -4402,7 +4430,7 @@ export interface ReleasedApprover {
  */
 export interface FlowBrief {
   /**
-   * 流程的编号
+   * 流程的编号ID
    */
   FlowId: string
 
@@ -4412,7 +4440,7 @@ export interface FlowBrief {
   FlowName: string
 
   /**
-      * 流程的描述
+      * 流程的描述信息
 注意：此字段可能返回 null，表示取不到有效值。
       */
   FlowDescription: string
@@ -4424,23 +4452,24 @@ export interface FlowBrief {
 
   /**
       * 流程状态
-- `0`  还没有发起
-- `1`  未签署
-- `2`  部分签署
-- `3`  已退回
-- `4`  完成签署
-- `5`  已过期
-- `6`  已取消
-- `7`  还没有预发起
-- `8`  等待填写
-- `9`  部分填写
-- `10`  拒填
+- 0 还没有发起
+- 1 待签署
+- 2 部分签署
+- 3 已拒签
+- 4 已签署
+- 5 已过期
+- 6 已撤销
+- 7 还没有预发起
+- 8 等待填写
+- 9 部分填写
+- 10 拒填
+- 21 已解除
 注意：此字段可能返回 null，表示取不到有效值。
       */
   FlowStatus: number
 
   /**
-      * 流程创建的时间戳
+      * 流程创建的时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
       */
   CreatedOn: number