tencentcloud-sdk-nodejs-essbasic 4.0.636 → 4.0.638

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

@@ -38,7 +38,7 @@ export interface ChannelCreateFlowRemindsResponse {
  */
 export interface ChannelDeleteSealPoliciesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -103,7 +103,7 @@ export interface CommonApproverOption {
  */
 export interface ChannelCreateFlowSignReviewRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -153,7 +153,7 @@ export interface AuthFailMessage {
  */
 export interface DescribeFlowDetailInfoRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -176,7 +176,7 @@ export interface DescribeFlowDetailInfoRequest {
  */
 export interface ModifyExtendedServiceRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
   
   注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
      */
@@ -203,7 +203,7 @@ export interface ModifyExtendedServiceRequest {
 export interface DescribeResourceUrlsByFlowsRequest {
     /**
      * 应用相关信息。
-  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -274,7 +274,7 @@ export interface OperateChannelTemplateResponse {
      */
     TemplateId?: string;
     /**
-     * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
+     * 描述模版可见性更改的结果，和参数中Available无关，全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     OperateResult?: string;
@@ -502,7 +502,7 @@ export interface CreateConsoleLoginUrlResponse {
  */
 export interface ChannelDeleteRoleUsersRequest {
     /**
-     * 代理信息
+     * 代理信息此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -588,11 +588,11 @@ export interface ChannelCreatePrepareFlowRequest {
      */
     FlowApproverList: Array<CommonFlowApprover>;
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
      */
     Agent?: Agent;
     /**
-     * 合同流程配置信息
+     * 合同流程配置信息，用于配置发起合同时定制化
      */
     FlowOption?: CreateFlowOption;
     /**
@@ -601,6 +601,7 @@ export interface ChannelCreatePrepareFlowRequest {
     FlowId?: string;
     /**
      * 该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL
+     * @deprecated
      */
     NeedPreview?: boolean;
     /**
@@ -619,7 +620,7 @@ export interface ChannelCreatePrepareFlowRequest {
  */
 export interface ChannelCreateFlowRemindsRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -694,7 +695,7 @@ export interface FlowApproverUrlInfo {
  */
 export interface ChannelCreateConvertTaskApiRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -725,7 +726,7 @@ export interface ChannelCreateConvertTaskApiRequest {
  */
 export interface ChannelCreateFlowByFilesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
      */
     Agent?: Agent;
     /**
@@ -924,7 +925,7 @@ export interface ChannelCreateFlowGroupByFilesRequest {
      */
     FlowGroupName: string;
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent?: Agent;
     /**
@@ -1002,7 +1003,7 @@ export interface RecipientComponentInfo {
  */
 export interface ChannelDescribeRolesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -1148,7 +1149,7 @@ export interface Agent {
      */
     ProxyOperator?: UserInfo;
     /**
-     * 在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。
+     * 非必需参数，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。
      */
     ProxyAppId?: string;
     /**
@@ -1247,7 +1248,7 @@ export interface ChannelVerifyPdfRequest {
      */
     FlowId: string;
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent?: Agent;
     /**
@@ -1261,7 +1262,7 @@ export interface ChannelVerifyPdfRequest {
  */
 export interface CreateChannelFlowEvidenceReportRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
      */
     Agent: Agent;
     /**
@@ -1571,7 +1572,7 @@ export interface PdfVerifyResult {
  */
 export interface ChannelCancelMultiFlowSignQRCodeRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
      */
     Agent: Agent;
     /**
@@ -1613,7 +1614,7 @@ export interface UploadFilesRequest {
  */
 export interface ChannelDescribeOrganizationSealsRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -1685,7 +1686,7 @@ export interface DescribeUsageRequest {
  */
 export interface DescribeExtendedServiceAuthInfoRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
   
   注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
   
@@ -2049,7 +2050,7 @@ export interface ChannelDescribeEmployeesRequest {
      */
     Limit: number;
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent?: Agent;
     /**
@@ -2117,7 +2118,7 @@ export interface SyncProxyOrganizationOperatorsRequest {
  */
 export interface CreateSignUrlsRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -2182,7 +2183,7 @@ export interface CreateSignUrlsRequest {
 export interface ChannelCreateMultiFlowSignQRCodeRequest {
     /**
      * 应用相关信息。
-  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
+  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -2362,7 +2363,7 @@ export interface FlowApproverInfo {
  */
 export interface ChannelGetTaskResultApiRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
      */
     Agent: Agent;
     /**
@@ -2474,7 +2475,7 @@ export interface CreateFlowsByTemplatesResponse {
  */
 export interface DescribeChannelFlowEvidenceReportRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
      */
     Agent: Agent;
     /**
@@ -2671,7 +2672,7 @@ export interface UploadFilesResponse {
  */
 export interface ChannelCreateBatchCancelFlowUrlRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -2710,7 +2711,7 @@ export interface ApproverRestriction {
  */
 export interface PrepareFlowsRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -2824,7 +2825,7 @@ export interface ChannelDescribeRolesResponse {
  */
 export interface ChannelCreateReleaseFlowRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -2974,7 +2975,7 @@ export interface ModifyExtendedServiceResponse {
  */
 export interface ChannelCreateUserRolesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -3316,7 +3317,7 @@ export interface Component {
  */
 export interface GetDownloadFlowUrlRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -3347,7 +3348,7 @@ export interface ChannelCreateEmbedWebUrlResponse {
  */
 export interface ChannelBatchCancelFlowsRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -3377,7 +3378,7 @@ export interface ChannelBatchCancelFlowsRequest {
  */
 export interface ChannelUpdateSealStatusRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -3424,7 +3425,7 @@ export interface ChannelCancelFlowRequest {
      */
     FlowId: string;
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent?: Agent;
     /**
@@ -3450,7 +3451,7 @@ export interface ChannelCancelFlowRequest {
  */
 export interface DescribeTemplatesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
      */
     Agent: Agent;
     /**
@@ -3525,7 +3526,7 @@ export interface RelieveInfo {
  */
 export interface ChannelCreateSealPolicyRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -3603,7 +3604,7 @@ export interface OccupiedSeal {
  */
 export interface CreateFlowsByTemplatesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
      */
     Agent: Agent;
     /**
@@ -3727,6 +3728,11 @@ export interface OperateChannelTemplateRequest {
      * @deprecated
      */
     Operator?: UserInfo;
+    /**
+     * 当OperateType=UPADATE时，可以通过设置此字段对模板启停用状态进行操作。若此字段值为0，则不会修改模板Available，1为启用模板，2为停用模板。
+  启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。
+     */
+    Available?: number;
 }
 /**
  * CreateChannelFlowEvidenceReport返回参数结构体
@@ -3833,7 +3839,7 @@ export interface DescribeChannelFlowEvidenceReportResponse {
  */
 export interface CreateSealByImageRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -3864,7 +3870,7 @@ export interface ChannelUpdateSealStatusResponse {
  */
 export interface ChannelCreateFlowSignUrlRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
+     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
      */
     Agent: Agent;
     /**
@@ -3905,7 +3911,7 @@ export interface DescribeExtendedServiceAuthInfoResponse {
  */
 export interface ChannelCreateEmbedWebUrlRequest {
     /**
-     * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
+     * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
     /**
@@ -3967,7 +3973,7 @@ export interface CcInfo {
  */
 export interface ChannelDescribeFlowComponentsRequest {
     /**
-     * 应用相关信息
+     * 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
      */
     Agent: Agent;
     /**