tencentcloud-sdk-nodejs-essbasic 4.0.725 → 4.0.728

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1885,22 +1885,26 @@ export interface DescribeFlowDetailInfoResponse {
1885
1885
  */
1886
1886
  export interface RecipientComponentInfo {
1887
1887
  /**
1888
- * 参与方Id
1889
- 注意:此字段可能返回 null,表示取不到有效值。
1888
+ * 参与方的角色ID
1890
1889
  */
1891
1890
  RecipientId?: string
1892
1891
  /**
1893
1892
  * 参与方填写状态
1894
- 注意:此字段可能返回 null,表示取不到有效值。
1893
+
1894
+ <ul><li> **0** : 还没有填写</li>
1895
+ <li> **1** : 已经填写</li></ul>
1895
1896
  */
1896
1897
  RecipientFillStatus?: string
1897
1898
  /**
1898
- * 是否发起方
1899
+ * 此角色是否是发起方角色
1900
+
1901
+ <ul><li> **true** : 是发起方角色</li>
1902
+ <li> **false** : 不是发起方角色</li></ul>
1899
1903
  注意:此字段可能返回 null,表示取不到有效值。
1900
1904
  */
1901
1905
  IsPromoter?: boolean
1902
1906
  /**
1903
- * 填写控件内容
1907
+ * 此角色的填写控件列表
1904
1908
  注意:此字段可能返回 null,表示取不到有效值。
1905
1909
  */
1906
1910
  Components?: Array<FilledComponent>
@@ -1950,6 +1954,50 @@ export interface PrepareFlowsResponse {
1950
1954
  RequestId?: string
1951
1955
  }
1952
1956
 
1957
+ /**
1958
+ * ChannelCancelFlow请求参数结构体
1959
+ */
1960
+ export interface ChannelCancelFlowRequest {
1961
+ /**
1962
+ * 要撤销的合同流程ID
1963
+ */
1964
+ FlowId: string
1965
+ /**
1966
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1967
+
1968
+ 此接口下面信息必填。
1969
+ <ul>
1970
+ <li>渠道应用标识: Agent.AppId</li>
1971
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1972
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1973
+ </ul>
1974
+ 第三方平台子客企业和员工必须已经经过实名认证
1975
+ */
1976
+ Agent?: Agent
1977
+ /**
1978
+ * 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
1979
+ */
1980
+ CancelMessage?: string
1981
+ /**
1982
+ * 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
1983
+
1984
+ **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
1985
+ **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
1986
+ **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
1987
+ **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
1988
+
1989
+ 注: `CancelMessage为撤销当前合同的理由`
1990
+
1991
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
1992
+ */
1993
+ CancelMessageFormat?: number
1994
+ /**
1995
+ * 暂未开放
1996
+ * @deprecated
1997
+ */
1998
+ Operator?: UserInfo
1999
+ }
2000
+
1953
2001
  /**
1954
2002
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
1955
2003
 
@@ -2314,6 +2362,61 @@ export interface CreateChannelFlowEvidenceReportRequest {
2314
2362
  Operator?: UserInfo
2315
2363
  }
2316
2364
 
2365
+ /**
2366
+ * ChannelDescribeBillUsageDetail请求参数结构体
2367
+ */
2368
+ export interface ChannelDescribeBillUsageDetailRequest {
2369
+ /**
2370
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2371
+
2372
+ 此接口下面信息必填。
2373
+ <ul>
2374
+ <li>渠道应用标识: Agent.AppId</li>
2375
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2376
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2377
+ </ul>
2378
+ 第三方平台子客企业和员工必须已经经过实名认证
2379
+ */
2380
+ Agent: Agent
2381
+ /**
2382
+ * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
2383
+ */
2384
+ StartTime: string
2385
+ /**
2386
+ * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
2387
+ */
2388
+ EndTime: string
2389
+ /**
2390
+ * 查询的套餐类型 (选填 )不传则查询所有套餐;
2391
+ 目前支持:
2392
+ <ul>
2393
+ <li>**CloudEnterprise**: 企业版合同</li>
2394
+ <li>**SingleSignature**: 单方签章</li>
2395
+ <li>**CloudProve**: 签署报告</li>
2396
+ <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
2397
+ <li>**ChannelWeCard**: 微工卡</li>
2398
+ <li>**SignFlow**: 合同套餐</li>
2399
+ <li>**SignFace**: 签署意愿(人脸识别)</li>
2400
+ <li>**SignPassword**: 签署意愿(密码)</li>
2401
+ <li>**SignSMS**: 签署意愿(短信)</li>
2402
+ <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
2403
+ <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
2404
+ <li>**OrgEssAuth**: 签署企业实名</li>
2405
+ <li>**FlowNotify**: 短信通知</li>
2406
+ <li>**AuthService**: 企业工商信息查询</li>
2407
+ </ul>
2408
+ */
2409
+ QuotaType?: string
2410
+ /**
2411
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
2412
+ */
2413
+ Offset?: number
2414
+ /**
2415
+ * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
2416
+ */
2417
+ Limit?: number
2418
+ }
2419
+
2317
2420
  /**
2318
2421
  * ChannelCancelUserAutoSignEnableUrl请求参数结构体
2319
2422
  */
@@ -3112,14 +3215,15 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
3112
3215
 
3113
3216
  此接口下面信息必填。
3114
3217
  <ul>
3115
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
3116
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
3117
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3218
+ <li>渠道应用标识: Agent.AppId</li>
3219
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3220
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3118
3221
  </ul>
3222
+ 第三方平台子客企业和员工必须已经经过实名认证
3119
3223
  */
3120
3224
  Agent: Agent
3121
3225
  /**
3122
- * 二维码ID,为32位字符串。
3226
+ * 需要取消签署的二维码ID,为32位字符串。由[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
3123
3227
  */
3124
3228
  QrCodeId: string
3125
3229
  /**
@@ -3188,30 +3292,43 @@ LEGAL_PERSON_SEAL:法定代表人章
3188
3292
  */
3189
3293
  export interface DescribeUsageRequest {
3190
3294
  /**
3191
- * 应用信息,此接口Agent.AppId必填
3295
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3296
+
3297
+ 此接口下面信息必填。
3298
+ <ul>
3299
+ <li>渠道应用标识: Agent.AppId</li>
3300
+ </ul>
3192
3301
  */
3193
3302
  Agent: Agent
3194
3303
  /**
3195
- * 开始时间,例如:2021-03-21
3304
+ * 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-03-21)
3305
+
3306
+ 注: `查询日期范围区间长度大于90天`。
3196
3307
  */
3197
3308
  StartDate: string
3198
3309
  /**
3199
- * 结束时间,例如:2021-06-21
3200
- 开始时间到结束时间的区间长度小于等于90天。
3310
+ * 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-04-21)
3311
+
3312
+ 注: `查询日期范围区间长度大于90天`。
3201
3313
  */
3202
3314
  EndDate: string
3203
3315
  /**
3204
3316
  * 是否汇总数据,默认不汇总。
3205
- 不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
3206
- 汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
3317
+ <ul><li> **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加</li>
3318
+ <li> **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)</li></ul>
3319
+
3207
3320
  */
3208
3321
  NeedAggregate?: boolean
3209
3322
  /**
3210
- * 单次返回的最多条目数量。默认为1000,且不能超过1000。
3323
+ * 指定每页返回的数据条数,和Offset参数配合使用。
3324
+
3325
+ 注: `默认值为1000,单页做大值为1000`
3211
3326
  */
3212
3327
  Limit?: number
3213
3328
  /**
3214
- * 偏移量,默认是0。
3329
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
3330
+
3331
+ 注:`offset从0开始,即第一页为0。`
3215
3332
  */
3216
3333
  Offset?: number
3217
3334
  /**
@@ -3845,12 +3962,19 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
3845
3962
  */
3846
3963
  export interface ChannelCreateBoundFlowsRequest {
3847
3964
  /**
3848
- * 应用信息
3849
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
3965
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3966
+
3967
+ 此接口下面信息必填。
3968
+ <ul>
3969
+ <li>渠道应用标识: Agent.AppId</li>
3970
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3971
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3972
+ </ul>
3973
+ 第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
3850
3974
  */
3851
3975
  Agent: Agent
3852
3976
  /**
3853
- * 领取的合同id列表
3977
+ * 需要领取的合同流程的ID列表
3854
3978
  */
3855
3979
  FlowIds?: Array<string>
3856
3980
  /**
@@ -4107,15 +4231,15 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
4107
4231
 
4108
4232
  此接口下面信息必填。
4109
4233
  <ul>
4110
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4111
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4112
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4234
+ <li>渠道应用标识: Agent.AppId</li>
4235
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4236
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4113
4237
  </ul>
4238
+ 第三方平台子客企业和员工必须已经经过实名认证
4114
4239
  */
4115
4240
  Agent: Agent
4116
4241
  /**
4117
4242
  * 合同模板ID,为32位字符串。
4118
- 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
4119
4243
  */
4120
4244
  TemplateId: string
4121
4245
  /**
@@ -4166,7 +4290,9 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
4166
4290
  */
4167
4291
  export interface SignQrCode {
4168
4292
  /**
4169
- * 二维码ID,为32位字符串。
4293
+ * 二维码ID,为32位字符串。
4294
+
4295
+ 注: 需要保留此二维码ID, 用于后序通过<a href="https://qian.tencent.com/developers/partnerApis/templates/ChannelCancelMultiFlowSignQRCode" target="_blank">取消一码多扫二维码</a>关闭这个二维码的签署功能。
4170
4296
  */
4171
4297
  QrCodeId?: string
4172
4298
  /**
@@ -4174,7 +4300,8 @@ export interface SignQrCode {
4174
4300
  */
4175
4301
  QrCodeUrl?: string
4176
4302
  /**
4177
- * 二维码的有截止时间,格式为Unix标准时间戳(秒)。 一旦超过二维码的有效期限,该二维码将自动失效。
4303
+ * 二维码的有截止时间,格式为Unix标准时间戳(秒),可以通过入参的QrEffectiveDay来设置有效期,默认为7天有效期。
4304
+ 一旦超过二维码的有效期限,该二维码将自动失效。
4178
4305
  */
4179
4306
  ExpiredTime?: number
4180
4307
  }
@@ -4482,22 +4609,6 @@ export interface ChannelGetTaskResultApiRequest {
4482
4609
  Organization?: OrganizationInfo
4483
4610
  }
4484
4611
 
4485
- /**
4486
- * 批量补充签署人时,补充失败的报错说明
4487
- */
4488
- export interface FillError {
4489
- /**
4490
- * 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
4491
- 注意:此字段可能返回 null,表示取不到有效值。
4492
- */
4493
- RecipientId?: string
4494
- /**
4495
- * 补充失败错误说明
4496
- 注意:此字段可能返回 null,表示取不到有效值。
4497
- */
4498
- ErrMessage?: string
4499
- }
4500
-
4501
4612
  /**
4502
4613
  * ChannelCreatePreparedPersonalEsign请求参数结构体
4503
4614
  */
@@ -4561,6 +4672,40 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
4561
4672
  LicenseType?: number
4562
4673
  }
4563
4674
 
4675
+ /**
4676
+ * 批量补充签署人时,补充失败的报错说明
4677
+ */
4678
+ export interface FillError {
4679
+ /**
4680
+ * 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
4681
+ 注意:此字段可能返回 null,表示取不到有效值。
4682
+ */
4683
+ RecipientId?: string
4684
+ /**
4685
+ * 补充失败错误说明
4686
+ 注意:此字段可能返回 null,表示取不到有效值。
4687
+ */
4688
+ ErrMessage?: string
4689
+ }
4690
+
4691
+ /**
4692
+ * ChannelDescribeBillUsageDetail返回参数结构体
4693
+ */
4694
+ export interface ChannelDescribeBillUsageDetailResponse {
4695
+ /**
4696
+ * 返回查询记录总数
4697
+ */
4698
+ Total?: number
4699
+ /**
4700
+ * 消耗记录详情
4701
+ */
4702
+ Details?: Array<ChannelBillUsageDetail>
4703
+ /**
4704
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4705
+ */
4706
+ RequestId?: string
4707
+ }
4708
+
4564
4709
  /**
4565
4710
  * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
4566
4711
  */
@@ -4866,28 +5011,27 @@ export interface Filter {
4866
5011
  */
4867
5012
  export interface FilledComponent {
4868
5013
  /**
4869
- * 控件Id
4870
- 注意:此字段可能返回 null,表示取不到有效值。
5014
+ * 填写控件ID
4871
5015
  */
4872
5016
  ComponentId?: string
4873
5017
  /**
4874
5018
  * 控件名称
4875
- 注意:此字段可能返回 null,表示取不到有效值。
4876
5019
  */
4877
5020
  ComponentName?: string
4878
5021
  /**
4879
- * 控件填写状态;0-未填写;1-已填写
4880
- 注意:此字段可能返回 null,表示取不到有效值。
5022
+ * 此填写控件的填写状态
5023
+ **0** : 此填写控件**未填写**
5024
+ **1** : 此填写控件**已填写**
4881
5025
  */
4882
5026
  ComponentFillStatus?: string
4883
5027
  /**
4884
5028
  * 控件填写内容
4885
- 注意:此字段可能返回 null,表示取不到有效值。
4886
5029
  */
4887
5030
  ComponentValue?: string
4888
5031
  /**
4889
5032
  * 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
4890
- 注意:此字段可能返回 null,表示取不到有效值。
5033
+
5034
+ 注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
4891
5035
  */
4892
5036
  ImageUrl?: string
4893
5037
  }
@@ -5232,8 +5376,7 @@ export interface ChannelCreateReleaseFlowRequest {
5232
5376
  */
5233
5377
  export interface ChannelDescribeFlowComponentsResponse {
5234
5378
  /**
5235
- * 流程关联的填写控件信息,控件会按照参与方进行分类。
5236
- 注意:此字段可能返回 null,表示取不到有效值。
5379
+ * 合同填写控件信息列表,填写控件会按照参与方角色进行分类。
5237
5380
  */
5238
5381
  RecipientComponentInfos?: Array<RecipientComponentInfo>
5239
5382
  /**
@@ -5316,6 +5459,38 @@ export interface ApproverOption {
5316
5459
  FlowReadLimit?: string
5317
5460
  }
5318
5461
 
5462
+ /**
5463
+ * ChannelDescribeUserAutoSignStatus返回参数结构体
5464
+ */
5465
+ export interface ChannelDescribeUserAutoSignStatusResponse {
5466
+ /**
5467
+ * 查询用户是否已开通自动签
5468
+ */
5469
+ IsOpen?: boolean
5470
+ /**
5471
+ * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
5472
+
5473
+ 值为unix时间戳,单位为秒。
5474
+ */
5475
+ LicenseFrom?: number
5476
+ /**
5477
+ * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
5478
+
5479
+ 值为unix时间戳,单位为秒。
5480
+ */
5481
+ LicenseTo?: number
5482
+ /**
5483
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。
5484
+
5485
+ <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
5486
+ */
5487
+ LicenseType?: number
5488
+ /**
5489
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5490
+ */
5491
+ RequestId?: string
5492
+ }
5493
+
5319
5494
  /**
5320
5495
  * 同步的员工的信息
5321
5496
  */
@@ -5803,47 +5978,85 @@ export interface SignUrl {
5803
5978
  }
5804
5979
 
5805
5980
  /**
5806
- * ChannelCancelFlow请求参数结构体
5981
+ * 用户计费使用情况详情
5807
5982
  */
5808
- export interface ChannelCancelFlowRequest {
5983
+ export interface ChannelBillUsageDetail {
5809
5984
  /**
5810
- * 要撤销的合同流程ID
5985
+ * 合同流程ID,为32位字符串。
5811
5986
  */
5812
- FlowId: string
5987
+ FlowId?: string
5813
5988
  /**
5814
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5815
-
5816
- 此接口下面信息必填。
5989
+ * 合同经办人名称
5990
+ 如果有多个经办人用分号隔开。
5991
+ */
5992
+ OperatorName?: string
5993
+ /**
5994
+ * 发起方组织机构名称
5995
+ */
5996
+ CreateOrganizationName?: string
5997
+ /**
5998
+ * 合同流程的名称。
5999
+ */
6000
+ FlowName?: string
6001
+ /**
6002
+ * 合同流程当前的签署状态, 会存在下列的状态值
5817
6003
  <ul>
5818
- <li>渠道应用标识: Agent.AppId</li>
5819
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5820
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6004
+ <li>**INIT**: 合同创建</li>
6005
+ <li>**PART**: 合同签署中(至少有一个签署方已经签署)</li>
6006
+ <li>**REJECT**: 合同拒签</li>
6007
+ <li>**ALL**: 合同签署完成</li>
6008
+ <li>**DEADLINE**: 合同流签(合同过期)</li>
6009
+ <li>**CANCEL**: 合同撤回</li>
6010
+ <li>**RELIEVED**: 解除协议(已解除)</li>
6011
+ <li>**WILLEXPIRE**: 合同即将过期</li>
6012
+ <li>**EXCEPTION**: 合同异常</li>
5821
6013
  </ul>
5822
- 第三方平台子客企业和员工必须已经经过实名认证
5823
6014
  */
5824
- Agent?: Agent
6015
+ FlowStatus?: string
5825
6016
  /**
5826
- * 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
6017
+ * 查询的套餐类型
6018
+ 对应关系如下:
6019
+ <ul>
6020
+ <li>**CloudEnterprise**: 企业版合同</li>
6021
+ <li>**SingleSignature**: 单方签章</li>
6022
+ <li>**CloudProve**: 签署报告</li>
6023
+ <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
6024
+ <li>**ChannelWeCard**: 微工卡</li>
6025
+ <li>**SignFlow**: 合同套餐</li>
6026
+ <li>**SignFace**: 签署意愿(人脸识别)</li>
6027
+ <li>**SignPassword**: 签署意愿(密码)</li>
6028
+ <li>**SignSMS**: 签署意愿(短信)</li>
6029
+ <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
6030
+ <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
6031
+ <li>**OrgEssAuth**: 签署企业实名</li>
6032
+ <li>**FlowNotify**: 短信通知</li>
6033
+ <li>**AuthService**: 企业工商信息查询</li>
6034
+ </ul>
5827
6035
  */
5828
- CancelMessage?: string
6036
+ QuotaType?: string
5829
6037
  /**
5830
- * 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
5831
-
5832
- **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
5833
- **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
5834
- **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
5835
- **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
5836
-
5837
- 注: `CancelMessage为撤销当前合同的理由`
5838
-
5839
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
6038
+ * 合同使用量
6039
+ 注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量`
5840
6040
  */
5841
- CancelMessageFormat?: number
6041
+ UseCount?: number
5842
6042
  /**
5843
- * 暂未开放
5844
- * @deprecated
6043
+ * 消耗的时间戳,格式为Unix标准时间戳(秒)。
5845
6044
  */
5846
- Operator?: UserInfo
6045
+ CostTime?: number
6046
+ /**
6047
+ * 消耗的套餐名称
6048
+ */
6049
+ QuotaName?: string
6050
+ /**
6051
+ * 消耗类型
6052
+ **1**.扣费
6053
+ **2**.撤销返还
6054
+ */
6055
+ CostType?: number
6056
+ /**
6057
+ * 备注
6058
+ */
6059
+ Remark?: string
5847
6060
  }
5848
6061
 
5849
6062
  /**
@@ -6132,33 +6345,33 @@ export interface ChannelCreateOrganizationBatchSignUrlResponse {
6132
6345
  */
6133
6346
  export interface UsageDetail {
6134
6347
  /**
6135
- * 子客企业唯一标识
6348
+ * 子客企业标识
6136
6349
  */
6137
- ProxyOrganizationOpenId: string
6350
+ ProxyOrganizationOpenId?: string
6138
6351
  /**
6139
6352
  * 子客企业名
6140
6353
  注意:此字段可能返回 null,表示取不到有效值。
6141
6354
  */
6142
- ProxyOrganizationName: string
6355
+ ProxyOrganizationName?: string
6143
6356
  /**
6144
- * 日期,当需要汇总数据时日期为空
6357
+ * 对应的消耗日期, **如果是汇总数据则为1970-01-01**
6145
6358
  注意:此字段可能返回 null,表示取不到有效值。
6146
6359
  */
6147
- Date: string
6360
+ Date?: string
6148
6361
  /**
6149
- * 消耗数量
6362
+ * 消耗合同数量
6150
6363
  */
6151
- Usage: number
6364
+ Usage?: number
6152
6365
  /**
6153
- * 撤回数量
6366
+ * 撤回合同数量
6154
6367
  注意:此字段可能返回 null,表示取不到有效值。
6155
6368
  */
6156
- Cancel: number
6369
+ Cancel?: number
6157
6370
  /**
6158
6371
  * 消耗渠道
6159
6372
  注意:此字段可能返回 null,表示取不到有效值。
6160
6373
  */
6161
- FlowChannel: string
6374
+ FlowChannel?: string
6162
6375
  }
6163
6376
 
6164
6377
  /**
@@ -6315,38 +6528,6 @@ export interface ChannelDescribeEmployeesResponse {
6315
6528
  RequestId?: string
6316
6529
  }
6317
6530
 
6318
- /**
6319
- * ChannelCreateFlowApprovers请求参数结构体
6320
- */
6321
- export interface ChannelCreateFlowApproversRequest {
6322
- /**
6323
- * 渠道应用相关信息
6324
- */
6325
- Agent: Agent
6326
- /**
6327
- * 合同唯一编号
6328
- */
6329
- FlowId: string
6330
- /**
6331
- * 补充企业签署人信息。
6332
-
6333
- - 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
6334
-
6335
- - 如果不指定,则使用姓名和手机号进行补充。
6336
- */
6337
- Approvers: Array<FillApproverInfo>
6338
- /**
6339
- * 操作人信息
6340
- */
6341
- Operator?: UserInfo
6342
- /**
6343
- * 签署人信息补充方式
6344
-
6345
- <ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
6346
- */
6347
- FillApproverType?: number
6348
- }
6349
-
6350
6531
  /**
6351
6532
  * ChannelDeleteRole返回参数结构体
6352
6533
  */
@@ -6470,35 +6651,35 @@ export interface CreateSealByImageRequest {
6470
6651
  }
6471
6652
 
6472
6653
  /**
6473
- * ChannelDescribeUserAutoSignStatus返回参数结构体
6654
+ * ChannelCreateFlowApprovers请求参数结构体
6474
6655
  */
6475
- export interface ChannelDescribeUserAutoSignStatusResponse {
6656
+ export interface ChannelCreateFlowApproversRequest {
6476
6657
  /**
6477
- * 查询用户是否已开通自动签
6658
+ * 渠道应用相关信息
6478
6659
  */
6479
- IsOpen?: boolean
6660
+ Agent: Agent
6480
6661
  /**
6481
- * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
6482
-
6483
- 值为unix时间戳,单位为秒。
6662
+ * 合同唯一编号
6484
6663
  */
6485
- LicenseFrom?: number
6664
+ FlowId: string
6486
6665
  /**
6487
- * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
6666
+ * 补充企业签署人信息。
6488
6667
 
6489
- 值为unix时间戳,单位为秒。
6668
+ - 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
6669
+
6670
+ - 如果不指定,则使用姓名和手机号进行补充。
6490
6671
  */
6491
- LicenseTo?: number
6672
+ Approvers: Array<FillApproverInfo>
6492
6673
  /**
6493
- * 设置用户开通自动签时是否绑定个人自动签账号许可。
6494
-
6495
- <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
6674
+ * 操作人信息
6496
6675
  */
6497
- LicenseType?: number
6676
+ Operator?: UserInfo
6498
6677
  /**
6499
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6678
+ * 签署人信息补充方式
6679
+
6680
+ <ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
6500
6681
  */
6501
- RequestId?: string
6682
+ FillApproverType?: number
6502
6683
  }
6503
6684
 
6504
6685
  /**
@@ -6642,11 +6823,19 @@ export interface CcInfo {
6642
6823
  */
6643
6824
  export interface ChannelDescribeFlowComponentsRequest {
6644
6825
  /**
6645
- * 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
6826
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6827
+
6828
+ 此接口下面信息必填。
6829
+ <ul>
6830
+ <li>渠道应用标识: Agent.AppId</li>
6831
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6832
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6833
+ </ul>
6834
+ 第三方平台子客企业和员工必须已经经过实名认证
6646
6835
  */
6647
6836
  Agent: Agent
6648
6837
  /**
6649
- * 电子签流程的Id
6838
+ * 需要获取填写控件填写内容的合同流程ID
6650
6839
  */
6651
6840
  FlowId: string
6652
6841
  }