tencentcloud-sdk-nodejs 4.0.878 → 4.0.880

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

@@ -450,19 +450,17 @@ BLUE 蓝色。
 }
 
 /**
- * 删除员工结果
+ * CreateLegalSealQrCode返回参数结构体
  */
-export interface DeleteStaffsResult {
+export interface CreateLegalSealQrCodeResponse {
   /**
-   * 删除员工的成功数据
-注意：此字段可能返回 null，表示取不到有效值。
+   * 二维码图片base64值
    */
-  SuccessEmployeeData: Array<SuccessDeleteStaffData>
+  QrcodeBase64?: string
   /**
-   * 删除员工的失败数据
-注意：此字段可能返回 null，表示取不到有效值。
+   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
    */
-  FailedEmployeeData: Array<FailedDeleteStaffData>
+  RequestId?: string
 }
 
 /**
@@ -1137,48 +1135,39 @@ export interface CreateFlowOption {
 }
 
 /**
- * 解除协议的签署人，如不指定，默认使用原流程中的签署人。<br/>
-`注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。`<br/>
-`注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。`<br/>
-`注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。`<br/>
+ * 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
  */
-export interface ReleasedApprover {
-  /**
-   * 签署人姓名，最大长度50个字。
-
-   */
-  Name: string
+export interface FilledComponent {
   /**
-   * 签署人手机号。
+   * 控件Id
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  Mobile: string
+  ComponentId?: string
   /**
-   * 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
+   * 控件名称
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  RelievedApproverReceiptId: string
+  ComponentName?: string
   /**
-   * 指定签署人类型，目前仅支持
-<ul><li> **ORGANIZATION**：企业（默认值）</li>
-<li> **ENTERPRISESERVER**：企业静默签</li></ul>
+   * 控件填写状态；0-未填写；1-已填写
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  ApproverType?: string
+  ComponentFillStatus?: string
   /**
-   * 签署控件类型，支持自定义企业签署方的签署控件类型
-<ul><li> **SIGN_SEAL**：默认为印章控件类型（默认值）</li>
-<li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
+   * 控件填写内容
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  ApproverSignComponentType?: string
+  ComponentValue?: string
   /**
-   * 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`,  第三个叫`丙方`，以此类推。
-
-如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
-
+   * 控件所属参与方Id
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  ApproverSignRole?: string
+  ComponentRecipientId?: string
   /**
-   * 印章Id，签署控件类型为印章时，用于指定本企业签署方在解除协议中使用那个印章进行签署
+   * 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  ApproverSignSealId?: string
+  ImageUrl?: string
 }
 
 /**
@@ -1398,6 +1387,37 @@ export interface GroupOrganization {
   FlowEngineEnable?: boolean
 }
 
+/**
+ * 机构信息
+ */
+export interface OrganizationInfo {
+  /**
+   * 机构在平台的编号，内部字段，暂未开放
+   * @deprecated
+   */
+  OrganizationId?: string
+  /**
+   * 用户渠道，内部字段，暂未开放
+   * @deprecated
+   */
+  Channel?: string
+  /**
+   * 用户在渠道的机构编号，内部字段，暂未开放
+   * @deprecated
+   */
+  OrganizationOpenId?: string
+  /**
+   * 用户真实的IP，内部字段，暂未开放
+   * @deprecated
+   */
+  ClientIp?: string
+  /**
+   * 机构的代理IP，内部字段，暂未开放
+   * @deprecated
+   */
+  ProxyIp?: string
+}
+
 /**
  * CreateOrganizationAuthUrl请求参数结构体
  */
@@ -3158,34 +3178,23 @@ export interface DeleteSealPoliciesResponse {
 }
 
 /**
- * 机构信息
+ * CreateLegalSealQrCode请求参数结构体
  */
-export interface OrganizationInfo {
-  /**
-   * 机构在平台的编号，内部字段，暂未开放
-   * @deprecated
-   */
-  OrganizationId?: string
-  /**
-   * 用户渠道，内部字段，暂未开放
-   * @deprecated
-   */
-  Channel?: string
+export interface CreateLegalSealQrCodeRequest {
   /**
-   * 用户在渠道的机构编号，内部字段，暂未开放
-   * @deprecated
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
-  OrganizationOpenId?: string
+  Operator?: UserInfo
   /**
-   * 用户真实的IP，内部字段，暂未开放
-   * @deprecated
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
-  ClientIp?: string
+  Agent?: Agent
   /**
-   * 机构的代理IP，内部字段，暂未开放
-   * @deprecated
+   * 机构信息，暂未开放
    */
-  ProxyIp?: string
+  Organization?: OrganizationInfo
 }
 
 /**
@@ -5158,6 +5167,28 @@ export interface Intention {
   IntentionActions?: Array<IntentionAction>
 }
 
+/**
+ * CreateFlowBlockchainEvidenceUrl返回参数结构体
+ */
+export interface CreateFlowBlockchainEvidenceUrlResponse {
+  /**
+   * 二维码图片下载链接，下载链接有效时间5分钟，请尽快下载保存。
+   */
+  QrCode?: string
+  /**
+   * 查看短链，可直接点击短链查看报告。
+   */
+  Url?: string
+  /**
+   * 二维码和短链的过期时间戳，过期时间默认为生成链接后7天。
+   */
+  ExpiredOn?: number
+  /**
+   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CreateDocument请求参数结构体
  */
@@ -6951,6 +6982,22 @@ export interface SubOrgBillSummary {
   Usage?: Array<SubOrgBillUsage>
 }
 
+/**
+ * 删除员工结果
+ */
+export interface DeleteStaffsResult {
+  /**
+   * 删除员工的成功数据
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  SuccessEmployeeData: Array<SuccessDeleteStaffData>
+  /**
+   * 删除员工的失败数据
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  FailedEmployeeData: Array<FailedDeleteStaffData>
+}
+
 /**
  * CancelMultiFlowSignQRCode请求参数结构体
  */
@@ -8289,6 +8336,51 @@ export interface VerifyPdfResponse {
   RequestId?: string
 }
 
+/**
+ * 解除协议的签署人，如不指定，默认使用原流程中的签署人。<br/>
+`注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。`<br/>
+`注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。`<br/>
+`注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。`<br/>
+ */
+export interface ReleasedApprover {
+  /**
+   * 签署人姓名，最大长度50个字。
+
+   */
+  Name: string
+  /**
+   * 签署人手机号。
+   */
+  Mobile: string
+  /**
+   * 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
+   */
+  RelievedApproverReceiptId: string
+  /**
+   * 指定签署人类型，目前仅支持
+<ul><li> **ORGANIZATION**：企业（默认值）</li>
+<li> **ENTERPRISESERVER**：企业静默签</li></ul>
+   */
+  ApproverType?: string
+  /**
+   * 签署控件类型，支持自定义企业签署方的签署控件类型
+<ul><li> **SIGN_SEAL**：默认为印章控件类型（默认值）</li>
+<li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
+   */
+  ApproverSignComponentType?: string
+  /**
+   * 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`,  第三个叫`丙方`，以此类推。
+
+如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
+
+   */
+  ApproverSignRole?: string
+  /**
+   * 印章Id，签署控件类型为印章时，用于指定本企业签署方在解除协议中使用那个印章进行签署
+   */
+  ApproverSignSealId?: string
+}
+
 /**
  * CreateFlowGroupSignReview请求参数结构体
  */
@@ -8908,39 +9000,25 @@ export interface CreateIntegrationSubOrganizationActiveRecordRequest {
 }
 
 /**
- * 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
+ * CreateFlowBlockchainEvidenceUrl请求参数结构体
  */
-export interface FilledComponent {
-  /**
-   * 控件Id
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  ComponentId?: string
+export interface CreateFlowBlockchainEvidenceUrlRequest {
   /**
-   * 控件名称
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  ComponentName?: string
-  /**
-   * 控件填写状态；0-未填写；1-已填写
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  ComponentFillStatus?: string
-  /**
-   * 控件填写内容
-注意：此字段可能返回 null，表示取不到有效值。
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
-  ComponentValue?: string
+  Operator: UserInfo
   /**
-   * 控件所属参与方Id
-注意：此字段可能返回 null，表示取不到有效值。
+   * 合同流程ID，为32位字符串。
+建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
    */
-  ComponentRecipientId?: string
+  FlowId: string
   /**
-   * 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
-注意：此字段可能返回 null，表示取不到有效值。
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
-  ImageUrl?: string
+  Agent?: Agent
 }
 
 /**

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

@@ -30,6 +30,7 @@ import {
   ChannelDisableUserAutoSignResponse,
   DescribeExtendedServiceAuthDetailResponse,
   Department,
+  CreateLegalSealQrCodeResponse,
   CommonApproverOption,
   DescribeCancelFlowsTaskResponse,
   ChannelCreateFlowGroupByTemplatesResponse,
@@ -62,7 +63,7 @@ import {
   ChannelCreatePrepareFlowRequest,
   ChannelCreateFlowRemindsRequest,
   ChannelCreateSealPolicyResponse,
-  PrepareFlowsRequest,
+  OrganizationInfo,
   ChannelDescribeSignFaceVideoResponse,
   ChannelCancelFlowResponse,
   DownloadFlowInfo,
@@ -111,7 +112,7 @@ import {
   ComponentLimit,
   ChannelVerifyPdfResponse,
   CreateConsoleLoginUrlRequest,
-  OrganizationInfo,
+  CreateLegalSealQrCodeRequest,
   SignUrlInfo,
   CommonFlowApprover,
   FillApproverInfo,
@@ -141,6 +142,7 @@ import {
   ChannelDescribeEmployeesRequest,
   AuthorizedUser,
   Intention,
+  CreateFlowBlockchainEvidenceUrlResponse,
   ChannelDeleteRoleUsersResponse,
   SyncProxyOrganizationOperatorsRequest,
   ChannelCreateFlowApproversResponse,
@@ -223,6 +225,7 @@ import {
   CreateFlowsByTemplatesRequest,
   DescribeBatchOrganizationRegistrationUrlsResponse,
   UploadFilesRequest,
+  CreateSealByImageRequest,
   DescribeChannelOrganizationsResponse,
   ChannelCreateOrganizationBatchSignUrlResponse,
   EmbedUrlOption,
@@ -237,7 +240,7 @@ import {
   ChannelCreateReleaseFlowResponse,
   DescribeChannelFlowEvidenceReportResponse,
   IntentionQuestion,
-  CreateSealByImageRequest,
+  CreateFlowBlockchainEvidenceUrlRequest,
   ChannelCreateFlowApproversRequest,
   ChannelUpdateSealStatusResponse,
   ChannelCreateFlowSignUrlRequest,
@@ -245,6 +248,7 @@ import {
   ChannelCreateEmbedWebUrlRequest,
   CcInfo,
   ChannelDescribeFlowComponentsRequest,
+  PrepareFlowsRequest,
 } from "./essbasic_models"
 
 /**
@@ -408,6 +412,26 @@ export class Client extends AbstractClient {
     return this.request("ChannelCreateFlowByFiles", req, cb)
   }
 
+  /**
+     * 获取区块链存证报告查看链接/二维码接口
+
+适用场景：企业员工可以通过此接口生成合同区块链存证报告的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。
+
+[点击查看区块链存证报告样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
+
+注：
+<ul><li>1. 二维码下载链接过期时间为5分钟，请尽快下载保存。二维码/短链的过期时间为<font color="red">7天</font>，超过有效期则不可用。</li>
+<li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成报告查看二维码/短链。</li>
+<li>3. 调用接口时，需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>
+<li>4. 通过扫码或者点击链接，用户无需登录或者鉴权即可查看对应合同的区块链存证报告，请妥善保管好二维码或链接。</li></ul>
+     */
+  async CreateFlowBlockchainEvidenceUrl(
+    req: CreateFlowBlockchainEvidenceUrlRequest,
+    cb?: (error: string, rep: CreateFlowBlockchainEvidenceUrlResponse) => void
+  ): Promise<CreateFlowBlockchainEvidenceUrlResponse> {
+    return this.request("CreateFlowBlockchainEvidenceUrl", req, cb)
+  }
+
   /**
      * 此接口用于获取企业批量认证异步任务的状态及结果。
 
@@ -692,6 +716,10 @@ export class Client extends AbstractClient {
 4. <font color="red">静默（自动）签署不支持合同签署方存在填写</font>
 
 5.  <font color="red">在下一步创建签署链接前，建议等待DocumentFill </font> <a href="https://qian.tencent.com/developers/partner/callback_types_file_resources">PDF合成完成的回调</a>或者睡眠几秒，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
+
+
+<font color="red">相关视频指引</font> <br>
+1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4" target="_blank">创建模板&设置成本企业自动签署</a><br>
      */
   async CreateFlowsByTemplates(
     req: CreateFlowsByTemplatesRequest,
@@ -789,6 +817,9 @@ export class Client extends AbstractClient {
 
 >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。
 >2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准
+
+<font color="red">相关视频指引</font> <br>
+1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4" target="_blank">创建模板&设置成本企业自动签署</a><br>
      */
   async DescribeTemplates(
     req: DescribeTemplatesRequest,
@@ -1135,6 +1166,16 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
     return this.request("ChannelDescribeUserAutoSignStatus", req, cb)
   }
 
+  /**
+   * 此接口用于获取创建法人章二维码图片base64
+   */
+  async CreateLegalSealQrCode(
+    req: CreateLegalSealQrCodeRequest,
+    cb?: (error: string, rep: CreateLegalSealQrCodeResponse) => void
+  ): Promise<CreateLegalSealQrCodeResponse> {
+    return this.request("CreateLegalSealQrCode", req, cb)
+  }
+
   /**
    * 对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。
    */