tencentcloud-sdk-nodejs-essbasic 4.0.614 → 4.0.616

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

@@ -70,7 +70,7 @@ export interface ChannelDeleteSealPoliciesRequest {
   SealId: string
 
   /**
-   * 指定用户ID数组
+   * 指定用户ID数组，电子签系统用户ID
    */
   UserIds: Array<string>
 
@@ -174,12 +174,12 @@ SIGN_REJECT:拒签(流程结束)
  */
 export interface AuthFailMessage {
   /**
-   * 合作企业Id
+   * 第三方应用平台的子客企业OpenId
    */
   ProxyOrganizationOpenId: string
 
   /**
-   * 出错信息
+   * 错误信息
    */
   Message: string
 }
@@ -265,7 +265,7 @@ export interface DescribeResourceUrlsByFlowsRequest {
  */
 export interface RemindFlowRecords {
   /**
-   * 是否能够催办
+   * 是否能够催办，true-是，false-否
    */
   CanRemind: boolean
 
@@ -275,7 +275,7 @@ export interface RemindFlowRecords {
   FlowId: string
 
   /**
-   * 催办详情
+   * 催办详情信息
    */
   RemindMessage: string
 }
@@ -421,7 +421,7 @@ export interface FlowFileInfo {
  */
 export interface CreateFlowOption {
   /**
-   * 是否允许修改合同信息
+   * 是否允许修改合同信息，true-是，false-否
    */
   CanEditFlow?: boolean
 }
@@ -446,7 +446,7 @@ export interface BaseFlowInfo {
   FlowDescription: string
 
   /**
-   * 合同流程截止时间，unix时间戳
+   * 合同流程截止时间，unix时间戳，单位秒
    */
   Deadline: number
 
@@ -456,7 +456,7 @@ export interface BaseFlowInfo {
   Unordered?: boolean
 
   /**
-   * 打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
+   * 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
    */
   IntelligentStatus?: string
 
@@ -466,7 +466,7 @@ export interface BaseFlowInfo {
   FormFields?: Array<FormField>
 
   /**
-   * 本企业(发起方企业)是否需要签署审批，true：开启本企业签署审批
+   * 本企业(发起方企业)是否需要签署审批，true：开启本企业签署审批。使用ChannelCreateFlowSignReview接口提交审批结果，才能继续完成签署
    */
   NeedSignReview?: boolean
 
@@ -501,7 +501,7 @@ export interface CreateConsoleLoginUrlResponse {
   ConsoleUrl?: string
 
   /**
-   * 子客企业是否已开通腾讯电子签
+   * 子客企业是否已开通腾讯电子签，true-是，false-否
    */
   IsActivated?: boolean
 
@@ -531,7 +531,7 @@ export interface ChannelDeleteRoleUsersRequest {
   RoleId: string
 
   /**
-   * 用户列表
+   * 用户列表，电子签系统的UserId
    */
   UserIds: Array<string>
 
@@ -667,7 +667,7 @@ export interface ChannelCreateFlowRemindsRequest {
  */
 export interface ChannelCreateSealPolicyResponse {
   /**
-   * 最终授权成功的用户ID数组。其他的跳过的是已经授权了的
+   * 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的
    */
   UserIds?: Array<string>
 
@@ -850,11 +850,6 @@ MobileCheck：手机号验证
    */
   SignBeanTag?: number
 
-  /**
-   * 操作者的信息，不用传
-   */
-  Operator?: UserInfo
-
   /**
    * 被抄送人信息列表
    */
@@ -869,6 +864,11 @@ MobileCheck：手机号验证
    * 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
    */
   AutoSignScene?: string
+
+  /**
+   * 操作者的信息，不用传
+   */
+  Operator?: UserInfo
 }
 
 /**
@@ -962,7 +962,7 @@ RELIEVED 已经解除
   ApproveMessage: string
 
   /**
-   * 签署人签署时间
+   * 签署人签署时间戳，单位秒
    */
   ApproveTime: number
 
@@ -1155,7 +1155,7 @@ export interface TemplateInfo {
   Description: string
 
   /**
-   * 模板控件信息结构
+   * 模板的填充控件信息结构
    */
   Components: Array<Component>
 
@@ -1165,7 +1165,7 @@ export interface TemplateInfo {
   Recipients: Array<Recipient>
 
   /**
-   * 签署区模板信息结构
+   * 模板中的签署控件信息结构
    */
   SignComponents: Array<Component>
 
@@ -1177,37 +1177,37 @@ export interface TemplateInfo {
   /**
    * 是否是发起人 ,已弃用
    */
-  IsPromoter: boolean
+  IsPromoter?: boolean
 
   /**
-   * 模板的创建者信息
+   * 模板的创建者信息，电子签系统用户ID
    */
   Creator: string
 
   /**
-   * 模板创建的时间戳（精确到秒）
+   * 模板创建的时间戳，单位秒
    */
   CreatedOn: number
 
   /**
-      * 模板的H5预览链接,可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
+      * 模板的H5预览链接,可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回，有效期5分钟。
 注意：此字段可能返回 null，表示取不到有效值。
       */
   PreviewUrl: string
 
   /**
-      * 第三方应用集成-模板PDF文件链接
+      * 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理），有效期5分钟。
 注意：此字段可能返回 null，表示取不到有效值。
       */
   PdfUrl: string
 
   /**
-   * 关联的平台企业模板ID
+   * 关联的第三方应用平台企业模板ID
    */
   ChannelTemplateId: string
 
   /**
-      * 关联的平台企业模板名称
+      * 关联的三方应用平台平台企业模板名称
 注意：此字段可能返回 null，表示取不到有效值。
       */
   ChannelTemplateName: string
@@ -1281,7 +1281,7 @@ export interface Agent {
  */
 export interface Recipient {
   /**
-   * 签署人唯一标识
+   * 签署人唯一标识，在通过模板发起合同的时候对应签署方Id
    */
   RecipientId?: string
 
@@ -1296,17 +1296,17 @@ export interface Recipient {
   Description?: string
 
   /**
-   * 签署方备注信息
+   * 签署方备注角色名
    */
   RoleName?: string
 
   /**
-   * 是否需要校验
+   * 是否需要校验，true-是，false-否
    */
   RequireValidation?: boolean
 
   /**
-   * 是否必须填写
+   * 是否必须填写，true-是，false-否
    */
   RequireSign?: boolean
 
@@ -1504,24 +1504,24 @@ export interface OrganizationInfo {
   OrganizationOpenId: string
 
   /**
-   * 用户真实的IP
+   * 机构在平台的编号
    */
-  ClientIp: string
+  OrganizationId?: string
 
   /**
-   * 机构的代理IP
+   * 用户渠道
    */
-  ProxyIp: string
+  Channel?: string
 
   /**
-   * 机构在平台的编号
+   * 用户真实的IP
    */
-  OrganizationId?: string
+  ClientIp?: string
 
   /**
-   * 用户渠道
+   * 机构的代理IP
    */
-  Channel?: string
+  ProxyIp?: string
 }
 
 /**
@@ -1535,7 +1535,7 @@ export interface SignUrlInfo {
   SignUrl: string
 
   /**
-      * 合同过期时间
+      * 合同过期时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
       */
   Deadline: number
@@ -1556,7 +1556,7 @@ export interface SignUrlInfo {
       * 自定义用户编号
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  CustomUserId: string
+  CustomUserId?: string
 
   /**
       * 用户姓名
@@ -1629,7 +1629,7 @@ export interface CommonFlowApprover {
   OrganizationId?: string
 
   /**
-   * 企业OpenId，第三方应用集成非静默签子客企业签署人发起合同毕传
+   * 企业OpenId，第三方应用集成非静默签子客企业签署人发起合同必传
    */
   OrganizationOpenId?: string
 
@@ -1705,7 +1705,7 @@ export interface PdfVerifyResult {
   SignerName: string
 
   /**
-   * 签署时间
+   * 签署时间戳，单位秒
    */
   SignTime: number
 
@@ -1720,12 +1720,12 @@ export interface PdfVerifyResult {
   CertSn: string
 
   /**
-   * 证书起始时间
+   * 证书起始时间戳，单位秒
    */
   CertNotBefore: number
 
   /**
-   * 证书过期时间
+   * 证书过期时间戳，单位秒
    */
   CertNotAfter: number
 
@@ -1735,27 +1735,27 @@ export interface PdfVerifyResult {
   SignType: number
 
   /**
-   * 签名域横坐标
+   * 签名域横坐标，单位px
    */
   ComponentPosX: number
 
   /**
-   * 签名域纵坐标
+   * 签名域纵坐标，单位px
    */
   ComponentPosY: number
 
   /**
-   * 签名域宽度
+   * 签名域宽度，单位px
    */
   ComponentWidth: number
 
   /**
-   * 签名域高度
+   * 签名域高度，单位px
    */
   ComponentHeight: number
 
   /**
-   * 签名域所在页码
+   * 签名域所在页码，1～N
    */
   ComponentPage: number
 }
@@ -1906,7 +1906,6 @@ export interface DescribeExtendedServiceAuthInfoRequest {
 
 /**
  * 此结构 (FormField) 用于描述内容控件填充结构。
-
  */
 export interface FormField {
   /**
@@ -1916,7 +1915,7 @@ MULTI_LINE_TEXT - 文本内容
 CHECK_BOX - true/false
 FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
 SELECTOR - 选项值
-DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
+DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo
       */
   ComponentValue: string
 
@@ -2198,7 +2197,7 @@ export interface DescribeUsageResponse {
  */
 export interface Staff {
   /**
-   * 员工在电子签平台的id
+   * 员工在电子签平台的用户ID
    */
   UserId: string
 
@@ -2219,7 +2218,7 @@ export interface Staff {
   Email: string
 
   /**
-      * 员工在第三方平台id
+      * 员工在第三方应用平台的用户ID
 注意：此字段可能返回 null，表示取不到有效值。
       */
   OpenId: string
@@ -2242,12 +2241,12 @@ export interface Staff {
   Verified: boolean
 
   /**
-   * 员工创建时间戳
+   * 员工创建时间戳，单位秒
    */
   CreatedOn: number
 
   /**
-   * 员工实名时间戳
+   * 员工实名时间戳，单位秒
    */
   VerifiedOn: number
 
@@ -2315,7 +2314,7 @@ export interface ChannelDescribeEmployeesRequest {
  */
 export interface AuthorizedUser {
   /**
-   * 用户openid
+   * 第三方应用平台的用户openid
    */
   OpenId: string
 }
@@ -2588,7 +2587,7 @@ ENTERPRISESERVER-企业静默签（文件发起时的企业静默签字）。
   RecipientId?: string
 
   /**
-   * 签署截止时间，默认一年
+   * 签署截止时间戳，默认一年
    */
   Deadline?: number
 
@@ -2614,7 +2613,7 @@ HANDWRITE -手写签名
   PreReadTime?: number
 
   /**
-   * 签署完前端跳转的url，暂未使用
+   * 签署完前端跳转的url，此字段的用法场景请联系客户经理确认
    */
   JumpUrl?: string
 
@@ -2639,6 +2638,13 @@ HANDWRITE -手写签名
 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
       */
   ApproverSignTypes?: Array<number>
+
+  /**
+      * 签署ID
+- 发起流程时系统自动补充
+- 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
+      */
+  SignId?: string
 }
 
 /**
@@ -2705,12 +2711,12 @@ RELIEVED 解除
   FlowMessage: string
 
   /**
-   * 合同(流程)的创建时间戳
+   * 合同(流程)的创建时间戳，单位秒
    */
   CreateOn: number
 
   /**
-   * 合同(流程)的签署截止时间戳
+   * 合同(流程)的签署截止时间戳，单位秒
    */
   DeadLine: number
 
@@ -2875,7 +2881,7 @@ export interface ExtentServiceAuthInfo {
   OVERSEA_SIGN          企业与港澳台居民*签署合同
   MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
   PAGING_SEAL           骑缝章
-  DOWNLOAD_FLOW         授权渠道下载合同 
+  DOWNLOAD_FLOW         授权平台企业下载合同 
       */
   Type?: string
 
@@ -2892,13 +2898,13 @@ DISABLE 关闭
   Status?: string
 
   /**
-      * 最近操作人openid（经办人openid）
+      * 最近操作人第三方应用平台的用户openid
 注意：此字段可能返回 null，表示取不到有效值。
       */
   OperatorOpenId?: string
 
   /**
-      * 最近操作时间
+      * 最近操作时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
       */
   OperateOn?: number
@@ -2943,6 +2949,7 @@ export interface ReleasedApprover {
   /**
       * 签署人类型，目前仅支持
 ORGANIZATION-企业
+ENTERPRISESERVER-企业静默签
       */
   ApproverType: string
 
@@ -3051,22 +3058,22 @@ export interface ChannelCreateBatchCancelFlowUrlRequest {
  */
 export interface ApproverRestriction {
   /**
-   * 指定签署人名字
+   * 指定签署人姓名
    */
   Name?: string
 
   /**
-   * 指定签署人手机号
+   * 指定签署人手机号，11位数字
    */
   Mobile?: string
 
   /**
-   * 指定签署人证件类型
+   * 指定签署人证件类型，ID_CARD-身份证，HONGKONG_AND_MACAO-港澳居民来往内地通行证，HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证
    */
   IdCardType?: string
 
   /**
-   * 指定签署人证件号码
+   * 指定签署人证件号码，其中字母大写
    */
   IdCardNumber?: string
 }
@@ -3375,7 +3382,7 @@ export interface ChannelCreateUserRolesRequest {
   Agent: Agent
 
   /**
-   * 绑定角色的员工id列表
+   * 绑定角色的员工id列表，电子签的UserId
    */
   UserIds: Array<string>
 
@@ -3823,14 +3830,14 @@ export interface ChannelUpdateSealStatusRequest {
   SealId: string
 
   /**
-   * 操作者的信息
+   * 更新印章状态原因说明
    */
-  Operator?: UserInfo
+  Reason?: string
 
   /**
-   * 更新印章状态原因说明
+   * 操作者的信息
    */
-  Reason?: string
+  Operator?: UserInfo
 }
 
 /**
@@ -3926,11 +3933,6 @@ export interface DescribeTemplatesRequest {
    */
   TemplateName?: string
 
-  /**
-   * 操作者的信息
-   */
-  Operator?: UserInfo
-
   /**
    * 是否获取模板预览链接
    */
@@ -3942,9 +3944,14 @@ export interface DescribeTemplatesRequest {
   WithPdfUrl?: boolean
 
   /**
-   * 模板ID
+   * 对应第三方应用平台企业的模板ID
    */
   ChannelTemplateId?: string
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
 }
 
 /**
@@ -3992,19 +3999,19 @@ export interface ChannelCreateSealPolicyRequest {
   SealId: string
 
   /**
-   * 指定待授权的用户ID数组
+   * 指定待授权的用户ID数组,电子签的用户ID
    */
   UserIds: Array<string>
 
   /**
-   * 企业机构信息，不用传
+   * 操作人（用户）信息，不用传
    */
-  Organization?: OrganizationInfo
+  Operator?: UserInfo
 
   /**
-   * 操作人（用户）信息，不用传
+   * 企业机构信息，不用传
    */
-  Operator?: UserInfo
+  Organization?: OrganizationInfo
 }
 
 /**
@@ -4022,12 +4029,12 @@ export interface OccupiedSeal {
   SealName: string
 
   /**
-   * 电子印章授权时间戳
+   * 电子印章授权时间戳，单位秒
    */
   CreateOn: number
 
   /**
-   * 电子印章授权人
+   * 电子印章授权人，电子签的UserId
    */
   Creator: string
 
@@ -4053,7 +4060,7 @@ export interface OccupiedSeal {
   Url: string
 
   /**
-   * 印章类型
+   * 印章类型，OFFICIAL-企业公章，CONTRACT-合同专用章，LEGAL_PERSON_SEAL-法人章
    */
   SealType: string
 
@@ -4233,7 +4240,7 @@ export interface CreateChannelFlowEvidenceReportResponse {
  */
 export interface SyncFailReason {
   /**
-   * 经办人Id
+   * 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义，对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工，不可在其他子客企业内重复使用。（例如，可以使用经办人企业名+员工身份证的hash值，需要第三方应用平台保存），最大64位字符串
    */
   Id: string
 
@@ -4400,20 +4407,15 @@ export interface DescribeExtendedServiceAuthInfoResponse {
  * ChannelCreateEmbedWebUrl请求参数结构体
  */
 export interface ChannelCreateEmbedWebUrlRequest {
-  /**
-   * WEB嵌入资源类型，取值范围：CREATE_SEAL创建印章，CREATE_TEMPLATE创建模板，MODIFY_TEMPLATE修改模板，PREVIEW_TEMPLATE预览模板，PREVIEW_FLOW预览流程
-   */
-  EmbedType: string
-
   /**
    * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
    */
   Agent: Agent
 
   /**
-   * 渠道操作者信息
+   * WEB嵌入资源类型，取值范围：CREATE_SEAL创建印章，CREATE_TEMPLATE创建模板，MODIFY_TEMPLATE修改模板，PREVIEW_TEMPLATE预览模板，PREVIEW_FLOW预览流程
    */
-  Operator?: UserInfo
+  EmbedType: string
 
   /**
    * WEB嵌入的业务资源ID，EmbedType取值MODIFY_TEMPLATE或PREVIEW_TEMPLATE或 PREVIEW_FLOW时BusinessId必填
@@ -4424,6 +4426,11 @@ export interface ChannelCreateEmbedWebUrlRequest {
    * 是否隐藏控件，只有预览模板时生效
    */
   HiddenComponents?: boolean
+
+  /**
+   * 渠道操作者信息
+   */
+  Operator?: UserInfo
 }
 
 /**

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

@@ -156,6 +156,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
   当前接口限制最多合同（流程）50个.
+  返回的链接只能使用一次
        */
     GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
     /**

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

@@ -225,6 +225,7 @@ class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
   当前接口限制最多合同（流程）50个.
+  返回的链接只能使用一次
        */
     async GetDownloadFlowUrl(req, cb) {
         return this.request("GetDownloadFlowUrl", req, cb);