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.
- package/CHANGELOG.md +648 -0
- package/SERVICE_CHANGELOG.md +367 -82
- package/package.json +1 -1
- package/products.md +16 -16
- package/src/services/essbasic/v20210526/essbasic_client.ts +72 -24
- package/src/services/essbasic/v20210526/essbasic_models.ts +329 -140
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +60 -21
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +61 -20
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +323 -137
|
@@ -1817,22 +1817,26 @@ export interface DescribeFlowDetailInfoResponse {
|
|
|
1817
1817
|
*/
|
|
1818
1818
|
export interface RecipientComponentInfo {
|
|
1819
1819
|
/**
|
|
1820
|
-
*
|
|
1821
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1820
|
+
* 参与方的角色ID
|
|
1822
1821
|
*/
|
|
1823
1822
|
RecipientId?: string;
|
|
1824
1823
|
/**
|
|
1825
1824
|
* 参与方填写状态
|
|
1826
|
-
|
|
1825
|
+
|
|
1826
|
+
<ul><li> **0** : 还没有填写</li>
|
|
1827
|
+
<li> **1** : 已经填写</li></ul>
|
|
1827
1828
|
*/
|
|
1828
1829
|
RecipientFillStatus?: string;
|
|
1829
1830
|
/**
|
|
1830
|
-
*
|
|
1831
|
+
* 此角色是否是发起方角色
|
|
1832
|
+
|
|
1833
|
+
<ul><li> **true** : 是发起方角色</li>
|
|
1834
|
+
<li> **false** : 不是发起方角色</li></ul>
|
|
1831
1835
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1832
1836
|
*/
|
|
1833
1837
|
IsPromoter?: boolean;
|
|
1834
1838
|
/**
|
|
1835
|
-
*
|
|
1839
|
+
* 此角色的填写控件列表
|
|
1836
1840
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1837
1841
|
*/
|
|
1838
1842
|
Components?: Array<FilledComponent>;
|
|
@@ -1879,6 +1883,49 @@ export interface PrepareFlowsResponse {
|
|
|
1879
1883
|
*/
|
|
1880
1884
|
RequestId?: string;
|
|
1881
1885
|
}
|
|
1886
|
+
/**
|
|
1887
|
+
* ChannelCancelFlow请求参数结构体
|
|
1888
|
+
*/
|
|
1889
|
+
export interface ChannelCancelFlowRequest {
|
|
1890
|
+
/**
|
|
1891
|
+
* 要撤销的合同流程ID
|
|
1892
|
+
*/
|
|
1893
|
+
FlowId: string;
|
|
1894
|
+
/**
|
|
1895
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1896
|
+
|
|
1897
|
+
此接口下面信息必填。
|
|
1898
|
+
<ul>
|
|
1899
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
1900
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1901
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
1902
|
+
</ul>
|
|
1903
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
1904
|
+
*/
|
|
1905
|
+
Agent?: Agent;
|
|
1906
|
+
/**
|
|
1907
|
+
* 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
1908
|
+
*/
|
|
1909
|
+
CancelMessage?: string;
|
|
1910
|
+
/**
|
|
1911
|
+
* 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
|
|
1912
|
+
|
|
1913
|
+
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
1914
|
+
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
|
1915
|
+
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
|
1916
|
+
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
1917
|
+
|
|
1918
|
+
注: `CancelMessage为撤销当前合同的理由`
|
|
1919
|
+
|
|
1920
|
+

|
|
1921
|
+
*/
|
|
1922
|
+
CancelMessageFormat?: number;
|
|
1923
|
+
/**
|
|
1924
|
+
* 暂未开放
|
|
1925
|
+
* @deprecated
|
|
1926
|
+
*/
|
|
1927
|
+
Operator?: UserInfo;
|
|
1928
|
+
}
|
|
1882
1929
|
/**
|
|
1883
1930
|
* 此结构体 (TemplateInfo) 用于描述模板的信息。
|
|
1884
1931
|
|
|
@@ -2233,6 +2280,60 @@ export interface CreateChannelFlowEvidenceReportRequest {
|
|
|
2233
2280
|
*/
|
|
2234
2281
|
Operator?: UserInfo;
|
|
2235
2282
|
}
|
|
2283
|
+
/**
|
|
2284
|
+
* ChannelDescribeBillUsageDetail请求参数结构体
|
|
2285
|
+
*/
|
|
2286
|
+
export interface ChannelDescribeBillUsageDetailRequest {
|
|
2287
|
+
/**
|
|
2288
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2289
|
+
|
|
2290
|
+
此接口下面信息必填。
|
|
2291
|
+
<ul>
|
|
2292
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2293
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2294
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2295
|
+
</ul>
|
|
2296
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
2297
|
+
*/
|
|
2298
|
+
Agent: Agent;
|
|
2299
|
+
/**
|
|
2300
|
+
* 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
2301
|
+
*/
|
|
2302
|
+
StartTime: string;
|
|
2303
|
+
/**
|
|
2304
|
+
* 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
2305
|
+
*/
|
|
2306
|
+
EndTime: string;
|
|
2307
|
+
/**
|
|
2308
|
+
* 查询的套餐类型 (选填 )不传则查询所有套餐;
|
|
2309
|
+
目前支持:
|
|
2310
|
+
<ul>
|
|
2311
|
+
<li>**CloudEnterprise**: 企业版合同</li>
|
|
2312
|
+
<li>**SingleSignature**: 单方签章</li>
|
|
2313
|
+
<li>**CloudProve**: 签署报告</li>
|
|
2314
|
+
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
|
|
2315
|
+
<li>**ChannelWeCard**: 微工卡</li>
|
|
2316
|
+
<li>**SignFlow**: 合同套餐</li>
|
|
2317
|
+
<li>**SignFace**: 签署意愿(人脸识别)</li>
|
|
2318
|
+
<li>**SignPassword**: 签署意愿(密码)</li>
|
|
2319
|
+
<li>**SignSMS**: 签署意愿(短信)</li>
|
|
2320
|
+
<li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
|
|
2321
|
+
<li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
|
|
2322
|
+
<li>**OrgEssAuth**: 签署企业实名</li>
|
|
2323
|
+
<li>**FlowNotify**: 短信通知</li>
|
|
2324
|
+
<li>**AuthService**: 企业工商信息查询</li>
|
|
2325
|
+
</ul>
|
|
2326
|
+
*/
|
|
2327
|
+
QuotaType?: string;
|
|
2328
|
+
/**
|
|
2329
|
+
* 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
|
|
2330
|
+
*/
|
|
2331
|
+
Offset?: number;
|
|
2332
|
+
/**
|
|
2333
|
+
* 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
|
|
2334
|
+
*/
|
|
2335
|
+
Limit?: number;
|
|
2336
|
+
}
|
|
2236
2337
|
/**
|
|
2237
2338
|
* ChannelCancelUserAutoSignEnableUrl请求参数结构体
|
|
2238
2339
|
*/
|
|
@@ -3016,14 +3117,15 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
|
3016
3117
|
|
|
3017
3118
|
此接口下面信息必填。
|
|
3018
3119
|
<ul>
|
|
3019
|
-
<li>渠道应用标识: Agent.
|
|
3020
|
-
<li>第三方平台子客企业标识: Agent.
|
|
3021
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
3120
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3121
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3122
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3022
3123
|
</ul>
|
|
3124
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
3023
3125
|
*/
|
|
3024
3126
|
Agent: Agent;
|
|
3025
3127
|
/**
|
|
3026
|
-
*
|
|
3128
|
+
* 需要取消签署的二维码ID,为32位字符串。由[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
|
|
3027
3129
|
*/
|
|
3028
3130
|
QrCodeId: string;
|
|
3029
3131
|
/**
|
|
@@ -3089,30 +3191,43 @@ export interface ChannelDescribeOrganizationSealsRequest {
|
|
|
3089
3191
|
*/
|
|
3090
3192
|
export interface DescribeUsageRequest {
|
|
3091
3193
|
/**
|
|
3092
|
-
*
|
|
3194
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3195
|
+
|
|
3196
|
+
此接口下面信息必填。
|
|
3197
|
+
<ul>
|
|
3198
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3199
|
+
</ul>
|
|
3093
3200
|
*/
|
|
3094
3201
|
Agent: Agent;
|
|
3095
3202
|
/**
|
|
3096
|
-
*
|
|
3203
|
+
* 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-03-21)
|
|
3204
|
+
|
|
3205
|
+
注: `查询日期范围区间长度大于90天`。
|
|
3097
3206
|
*/
|
|
3098
3207
|
StartDate: string;
|
|
3099
3208
|
/**
|
|
3100
|
-
*
|
|
3101
|
-
|
|
3209
|
+
* 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-04-21)
|
|
3210
|
+
|
|
3211
|
+
注: `查询日期范围区间长度大于90天`。
|
|
3102
3212
|
*/
|
|
3103
3213
|
EndDate: string;
|
|
3104
3214
|
/**
|
|
3105
3215
|
* 是否汇总数据,默认不汇总。
|
|
3106
|
-
|
|
3107
|
-
|
|
3216
|
+
<ul><li> **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加</li>
|
|
3217
|
+
<li> **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)</li></ul>
|
|
3218
|
+
|
|
3108
3219
|
*/
|
|
3109
3220
|
NeedAggregate?: boolean;
|
|
3110
3221
|
/**
|
|
3111
|
-
*
|
|
3222
|
+
* 指定每页返回的数据条数,和Offset参数配合使用。
|
|
3223
|
+
|
|
3224
|
+
注: `默认值为1000,单页做大值为1000`
|
|
3112
3225
|
*/
|
|
3113
3226
|
Limit?: number;
|
|
3114
3227
|
/**
|
|
3115
|
-
*
|
|
3228
|
+
* 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
|
|
3229
|
+
|
|
3230
|
+
注:`offset从0开始,即第一页为0。`
|
|
3116
3231
|
*/
|
|
3117
3232
|
Offset?: number;
|
|
3118
3233
|
/**
|
|
@@ -3735,12 +3850,19 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
|
|
|
3735
3850
|
*/
|
|
3736
3851
|
export interface ChannelCreateBoundFlowsRequest {
|
|
3737
3852
|
/**
|
|
3738
|
-
*
|
|
3739
|
-
|
|
3853
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3854
|
+
|
|
3855
|
+
此接口下面信息必填。
|
|
3856
|
+
<ul>
|
|
3857
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3858
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3859
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3860
|
+
</ul>
|
|
3861
|
+
第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
|
|
3740
3862
|
*/
|
|
3741
3863
|
Agent: Agent;
|
|
3742
3864
|
/**
|
|
3743
|
-
*
|
|
3865
|
+
* 需要领取的合同流程的ID列表
|
|
3744
3866
|
*/
|
|
3745
3867
|
FlowIds?: Array<string>;
|
|
3746
3868
|
/**
|
|
@@ -3989,15 +4111,15 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
3989
4111
|
|
|
3990
4112
|
此接口下面信息必填。
|
|
3991
4113
|
<ul>
|
|
3992
|
-
<li>渠道应用标识: Agent.
|
|
3993
|
-
<li>第三方平台子客企业标识: Agent.
|
|
3994
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
4114
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
4115
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4116
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3995
4117
|
</ul>
|
|
4118
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
3996
4119
|
*/
|
|
3997
4120
|
Agent: Agent;
|
|
3998
4121
|
/**
|
|
3999
4122
|
* 合同模板ID,为32位字符串。
|
|
4000
|
-
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
4001
4123
|
*/
|
|
4002
4124
|
TemplateId: string;
|
|
4003
4125
|
/**
|
|
@@ -4048,6 +4170,8 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
4048
4170
|
export interface SignQrCode {
|
|
4049
4171
|
/**
|
|
4050
4172
|
* 二维码ID,为32位字符串。
|
|
4173
|
+
|
|
4174
|
+
注: 需要保留此二维码ID, 用于后序通过<a href="https://qian.tencent.com/developers/partnerApis/templates/ChannelCancelMultiFlowSignQRCode" target="_blank">取消一码多扫二维码</a>关闭这个二维码的签署功能。
|
|
4051
4175
|
*/
|
|
4052
4176
|
QrCodeId?: string;
|
|
4053
4177
|
/**
|
|
@@ -4055,7 +4179,8 @@ export interface SignQrCode {
|
|
|
4055
4179
|
*/
|
|
4056
4180
|
QrCodeUrl?: string;
|
|
4057
4181
|
/**
|
|
4058
|
-
* 二维码的有截止时间,格式为Unix
|
|
4182
|
+
* 二维码的有截止时间,格式为Unix标准时间戳(秒),可以通过入参的QrEffectiveDay来设置有效期,默认为7天有效期。
|
|
4183
|
+
一旦超过二维码的有效期限,该二维码将自动失效。
|
|
4059
4184
|
*/
|
|
4060
4185
|
ExpiredTime?: number;
|
|
4061
4186
|
}
|
|
@@ -4359,21 +4484,6 @@ export interface ChannelGetTaskResultApiRequest {
|
|
|
4359
4484
|
*/
|
|
4360
4485
|
Organization?: OrganizationInfo;
|
|
4361
4486
|
}
|
|
4362
|
-
/**
|
|
4363
|
-
* 批量补充签署人时,补充失败的报错说明
|
|
4364
|
-
*/
|
|
4365
|
-
export interface FillError {
|
|
4366
|
-
/**
|
|
4367
|
-
* 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
|
|
4368
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4369
|
-
*/
|
|
4370
|
-
RecipientId?: string;
|
|
4371
|
-
/**
|
|
4372
|
-
* 补充失败错误说明
|
|
4373
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4374
|
-
*/
|
|
4375
|
-
ErrMessage?: string;
|
|
4376
|
-
}
|
|
4377
4487
|
/**
|
|
4378
4488
|
* ChannelCreatePreparedPersonalEsign请求参数结构体
|
|
4379
4489
|
*/
|
|
@@ -4436,6 +4546,38 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
|
|
|
4436
4546
|
*/
|
|
4437
4547
|
LicenseType?: number;
|
|
4438
4548
|
}
|
|
4549
|
+
/**
|
|
4550
|
+
* 批量补充签署人时,补充失败的报错说明
|
|
4551
|
+
*/
|
|
4552
|
+
export interface FillError {
|
|
4553
|
+
/**
|
|
4554
|
+
* 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
|
|
4555
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4556
|
+
*/
|
|
4557
|
+
RecipientId?: string;
|
|
4558
|
+
/**
|
|
4559
|
+
* 补充失败错误说明
|
|
4560
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4561
|
+
*/
|
|
4562
|
+
ErrMessage?: string;
|
|
4563
|
+
}
|
|
4564
|
+
/**
|
|
4565
|
+
* ChannelDescribeBillUsageDetail返回参数结构体
|
|
4566
|
+
*/
|
|
4567
|
+
export interface ChannelDescribeBillUsageDetailResponse {
|
|
4568
|
+
/**
|
|
4569
|
+
* 返回查询记录总数
|
|
4570
|
+
*/
|
|
4571
|
+
Total?: number;
|
|
4572
|
+
/**
|
|
4573
|
+
* 消耗记录详情
|
|
4574
|
+
*/
|
|
4575
|
+
Details?: Array<ChannelBillUsageDetail>;
|
|
4576
|
+
/**
|
|
4577
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4578
|
+
*/
|
|
4579
|
+
RequestId?: string;
|
|
4580
|
+
}
|
|
4439
4581
|
/**
|
|
4440
4582
|
* 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
|
|
4441
4583
|
*/
|
|
@@ -4729,28 +4871,27 @@ export interface Filter {
|
|
|
4729
4871
|
*/
|
|
4730
4872
|
export interface FilledComponent {
|
|
4731
4873
|
/**
|
|
4732
|
-
*
|
|
4733
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4874
|
+
* 填写控件ID
|
|
4734
4875
|
*/
|
|
4735
4876
|
ComponentId?: string;
|
|
4736
4877
|
/**
|
|
4737
4878
|
* 控件名称
|
|
4738
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4739
4879
|
*/
|
|
4740
4880
|
ComponentName?: string;
|
|
4741
4881
|
/**
|
|
4742
|
-
*
|
|
4743
|
-
|
|
4882
|
+
* 此填写控件的填写状态
|
|
4883
|
+
**0** : 此填写控件**未填写**
|
|
4884
|
+
**1** : 此填写控件**已填写**
|
|
4744
4885
|
*/
|
|
4745
4886
|
ComponentFillStatus?: string;
|
|
4746
4887
|
/**
|
|
4747
4888
|
* 控件填写内容
|
|
4748
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4749
4889
|
*/
|
|
4750
4890
|
ComponentValue?: string;
|
|
4751
4891
|
/**
|
|
4752
4892
|
* 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
|
|
4753
|
-
|
|
4893
|
+
|
|
4894
|
+
注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
|
|
4754
4895
|
*/
|
|
4755
4896
|
ImageUrl?: string;
|
|
4756
4897
|
}
|
|
@@ -5079,8 +5220,7 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
5079
5220
|
*/
|
|
5080
5221
|
export interface ChannelDescribeFlowComponentsResponse {
|
|
5081
5222
|
/**
|
|
5082
|
-
*
|
|
5083
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
5223
|
+
* 合同填写控件信息列表,填写控件会按照参与方角色进行分类。
|
|
5084
5224
|
*/
|
|
5085
5225
|
RecipientComponentInfos?: Array<RecipientComponentInfo>;
|
|
5086
5226
|
/**
|
|
@@ -5159,6 +5299,37 @@ export interface ApproverOption {
|
|
|
5159
5299
|
*/
|
|
5160
5300
|
FlowReadLimit?: string;
|
|
5161
5301
|
}
|
|
5302
|
+
/**
|
|
5303
|
+
* ChannelDescribeUserAutoSignStatus返回参数结构体
|
|
5304
|
+
*/
|
|
5305
|
+
export interface ChannelDescribeUserAutoSignStatusResponse {
|
|
5306
|
+
/**
|
|
5307
|
+
* 查询用户是否已开通自动签
|
|
5308
|
+
*/
|
|
5309
|
+
IsOpen?: boolean;
|
|
5310
|
+
/**
|
|
5311
|
+
* 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
|
|
5312
|
+
|
|
5313
|
+
值为unix时间戳,单位为秒。
|
|
5314
|
+
*/
|
|
5315
|
+
LicenseFrom?: number;
|
|
5316
|
+
/**
|
|
5317
|
+
* 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
|
|
5318
|
+
|
|
5319
|
+
值为unix时间戳,单位为秒。
|
|
5320
|
+
*/
|
|
5321
|
+
LicenseTo?: number;
|
|
5322
|
+
/**
|
|
5323
|
+
* 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
5324
|
+
|
|
5325
|
+
<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
|
|
5326
|
+
*/
|
|
5327
|
+
LicenseType?: number;
|
|
5328
|
+
/**
|
|
5329
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5330
|
+
*/
|
|
5331
|
+
RequestId?: string;
|
|
5332
|
+
}
|
|
5162
5333
|
/**
|
|
5163
5334
|
* 同步的员工的信息
|
|
5164
5335
|
*/
|
|
@@ -5629,47 +5800,85 @@ export interface SignUrl {
|
|
|
5629
5800
|
HttpSignUrl?: string;
|
|
5630
5801
|
}
|
|
5631
5802
|
/**
|
|
5632
|
-
*
|
|
5803
|
+
* 用户计费使用情况详情
|
|
5633
5804
|
*/
|
|
5634
|
-
export interface
|
|
5805
|
+
export interface ChannelBillUsageDetail {
|
|
5635
5806
|
/**
|
|
5636
|
-
*
|
|
5807
|
+
* 合同流程ID,为32位字符串。
|
|
5637
5808
|
*/
|
|
5638
|
-
FlowId
|
|
5809
|
+
FlowId?: string;
|
|
5639
5810
|
/**
|
|
5640
|
-
*
|
|
5641
|
-
|
|
5642
|
-
|
|
5811
|
+
* 合同经办人名称
|
|
5812
|
+
如果有多个经办人用分号隔开。
|
|
5813
|
+
*/
|
|
5814
|
+
OperatorName?: string;
|
|
5815
|
+
/**
|
|
5816
|
+
* 发起方组织机构名称
|
|
5817
|
+
*/
|
|
5818
|
+
CreateOrganizationName?: string;
|
|
5819
|
+
/**
|
|
5820
|
+
* 合同流程的名称。
|
|
5821
|
+
*/
|
|
5822
|
+
FlowName?: string;
|
|
5823
|
+
/**
|
|
5824
|
+
* 合同流程当前的签署状态, 会存在下列的状态值
|
|
5643
5825
|
<ul>
|
|
5644
|
-
<li
|
|
5645
|
-
<li
|
|
5646
|
-
<li
|
|
5826
|
+
<li>**INIT**: 合同创建</li>
|
|
5827
|
+
<li>**PART**: 合同签署中(至少有一个签署方已经签署)</li>
|
|
5828
|
+
<li>**REJECT**: 合同拒签</li>
|
|
5829
|
+
<li>**ALL**: 合同签署完成</li>
|
|
5830
|
+
<li>**DEADLINE**: 合同流签(合同过期)</li>
|
|
5831
|
+
<li>**CANCEL**: 合同撤回</li>
|
|
5832
|
+
<li>**RELIEVED**: 解除协议(已解除)</li>
|
|
5833
|
+
<li>**WILLEXPIRE**: 合同即将过期</li>
|
|
5834
|
+
<li>**EXCEPTION**: 合同异常</li>
|
|
5647
5835
|
</ul>
|
|
5648
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
5649
5836
|
*/
|
|
5650
|
-
|
|
5837
|
+
FlowStatus?: string;
|
|
5651
5838
|
/**
|
|
5652
|
-
*
|
|
5839
|
+
* 查询的套餐类型
|
|
5840
|
+
对应关系如下:
|
|
5841
|
+
<ul>
|
|
5842
|
+
<li>**CloudEnterprise**: 企业版合同</li>
|
|
5843
|
+
<li>**SingleSignature**: 单方签章</li>
|
|
5844
|
+
<li>**CloudProve**: 签署报告</li>
|
|
5845
|
+
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
|
|
5846
|
+
<li>**ChannelWeCard**: 微工卡</li>
|
|
5847
|
+
<li>**SignFlow**: 合同套餐</li>
|
|
5848
|
+
<li>**SignFace**: 签署意愿(人脸识别)</li>
|
|
5849
|
+
<li>**SignPassword**: 签署意愿(密码)</li>
|
|
5850
|
+
<li>**SignSMS**: 签署意愿(短信)</li>
|
|
5851
|
+
<li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
|
|
5852
|
+
<li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
|
|
5853
|
+
<li>**OrgEssAuth**: 签署企业实名</li>
|
|
5854
|
+
<li>**FlowNotify**: 短信通知</li>
|
|
5855
|
+
<li>**AuthService**: 企业工商信息查询</li>
|
|
5856
|
+
</ul>
|
|
5653
5857
|
*/
|
|
5654
|
-
|
|
5858
|
+
QuotaType?: string;
|
|
5655
5859
|
/**
|
|
5656
|
-
*
|
|
5657
|
-
|
|
5658
|
-
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
5659
|
-
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
|
5660
|
-
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
|
5661
|
-
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
5662
|
-
|
|
5663
|
-
注: `CancelMessage为撤销当前合同的理由`
|
|
5664
|
-
|
|
5665
|
-

|
|
5860
|
+
* 合同使用量
|
|
5861
|
+
注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量`
|
|
5666
5862
|
*/
|
|
5667
|
-
|
|
5863
|
+
UseCount?: number;
|
|
5668
5864
|
/**
|
|
5669
|
-
*
|
|
5670
|
-
* @deprecated
|
|
5865
|
+
* 消耗的时间戳,格式为Unix标准时间戳(秒)。
|
|
5671
5866
|
*/
|
|
5672
|
-
|
|
5867
|
+
CostTime?: number;
|
|
5868
|
+
/**
|
|
5869
|
+
* 消耗的套餐名称
|
|
5870
|
+
*/
|
|
5871
|
+
QuotaName?: string;
|
|
5872
|
+
/**
|
|
5873
|
+
* 消耗类型
|
|
5874
|
+
**1**.扣费
|
|
5875
|
+
**2**.撤销返还
|
|
5876
|
+
*/
|
|
5877
|
+
CostType?: number;
|
|
5878
|
+
/**
|
|
5879
|
+
* 备注
|
|
5880
|
+
*/
|
|
5881
|
+
Remark?: string;
|
|
5673
5882
|
}
|
|
5674
5883
|
/**
|
|
5675
5884
|
* DescribeBillUsageDetail请求参数结构体
|
|
@@ -5949,33 +6158,33 @@ export interface ChannelCreateOrganizationBatchSignUrlResponse {
|
|
|
5949
6158
|
*/
|
|
5950
6159
|
export interface UsageDetail {
|
|
5951
6160
|
/**
|
|
5952
|
-
*
|
|
6161
|
+
* 子客企业标识
|
|
5953
6162
|
*/
|
|
5954
|
-
ProxyOrganizationOpenId
|
|
6163
|
+
ProxyOrganizationOpenId?: string;
|
|
5955
6164
|
/**
|
|
5956
6165
|
* 子客企业名
|
|
5957
6166
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5958
6167
|
*/
|
|
5959
|
-
ProxyOrganizationName
|
|
6168
|
+
ProxyOrganizationName?: string;
|
|
5960
6169
|
/**
|
|
5961
|
-
*
|
|
6170
|
+
* 对应的消耗日期, **如果是汇总数据则为1970-01-01**
|
|
5962
6171
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5963
6172
|
*/
|
|
5964
|
-
Date
|
|
6173
|
+
Date?: string;
|
|
5965
6174
|
/**
|
|
5966
|
-
*
|
|
6175
|
+
* 消耗合同数量
|
|
5967
6176
|
*/
|
|
5968
|
-
Usage
|
|
6177
|
+
Usage?: number;
|
|
5969
6178
|
/**
|
|
5970
|
-
*
|
|
6179
|
+
* 撤回合同数量
|
|
5971
6180
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5972
6181
|
*/
|
|
5973
|
-
Cancel
|
|
6182
|
+
Cancel?: number;
|
|
5974
6183
|
/**
|
|
5975
6184
|
* 消耗渠道
|
|
5976
6185
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5977
6186
|
*/
|
|
5978
|
-
FlowChannel
|
|
6187
|
+
FlowChannel?: string;
|
|
5979
6188
|
}
|
|
5980
6189
|
/**
|
|
5981
6190
|
* ChannelCreateBatchCancelFlowUrl返回参数结构体
|
|
@@ -6126,37 +6335,6 @@ export interface ChannelDescribeEmployeesResponse {
|
|
|
6126
6335
|
*/
|
|
6127
6336
|
RequestId?: string;
|
|
6128
6337
|
}
|
|
6129
|
-
/**
|
|
6130
|
-
* ChannelCreateFlowApprovers请求参数结构体
|
|
6131
|
-
*/
|
|
6132
|
-
export interface ChannelCreateFlowApproversRequest {
|
|
6133
|
-
/**
|
|
6134
|
-
* 渠道应用相关信息
|
|
6135
|
-
*/
|
|
6136
|
-
Agent: Agent;
|
|
6137
|
-
/**
|
|
6138
|
-
* 合同唯一编号
|
|
6139
|
-
*/
|
|
6140
|
-
FlowId: string;
|
|
6141
|
-
/**
|
|
6142
|
-
* 补充企业签署人信息。
|
|
6143
|
-
|
|
6144
|
-
- 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
|
|
6145
|
-
|
|
6146
|
-
- 如果不指定,则使用姓名和手机号进行补充。
|
|
6147
|
-
*/
|
|
6148
|
-
Approvers: Array<FillApproverInfo>;
|
|
6149
|
-
/**
|
|
6150
|
-
* 操作人信息
|
|
6151
|
-
*/
|
|
6152
|
-
Operator?: UserInfo;
|
|
6153
|
-
/**
|
|
6154
|
-
* 签署人信息补充方式
|
|
6155
|
-
|
|
6156
|
-
<ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
|
|
6157
|
-
*/
|
|
6158
|
-
FillApproverType?: number;
|
|
6159
|
-
}
|
|
6160
6338
|
/**
|
|
6161
6339
|
* ChannelDeleteRole返回参数结构体
|
|
6162
6340
|
*/
|
|
@@ -6276,35 +6454,35 @@ export interface CreateSealByImageRequest {
|
|
|
6276
6454
|
SealSize?: string;
|
|
6277
6455
|
}
|
|
6278
6456
|
/**
|
|
6279
|
-
*
|
|
6457
|
+
* ChannelCreateFlowApprovers请求参数结构体
|
|
6280
6458
|
*/
|
|
6281
|
-
export interface
|
|
6459
|
+
export interface ChannelCreateFlowApproversRequest {
|
|
6282
6460
|
/**
|
|
6283
|
-
*
|
|
6461
|
+
* 渠道应用相关信息
|
|
6284
6462
|
*/
|
|
6285
|
-
|
|
6463
|
+
Agent: Agent;
|
|
6286
6464
|
/**
|
|
6287
|
-
*
|
|
6288
|
-
|
|
6289
|
-
值为unix时间戳,单位为秒。
|
|
6465
|
+
* 合同唯一编号
|
|
6290
6466
|
*/
|
|
6291
|
-
|
|
6467
|
+
FlowId: string;
|
|
6292
6468
|
/**
|
|
6293
|
-
*
|
|
6469
|
+
* 补充企业签署人信息。
|
|
6294
6470
|
|
|
6295
|
-
|
|
6471
|
+
- 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
|
|
6472
|
+
|
|
6473
|
+
- 如果不指定,则使用姓名和手机号进行补充。
|
|
6296
6474
|
*/
|
|
6297
|
-
|
|
6475
|
+
Approvers: Array<FillApproverInfo>;
|
|
6298
6476
|
/**
|
|
6299
|
-
*
|
|
6300
|
-
|
|
6301
|
-
<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
|
|
6477
|
+
* 操作人信息
|
|
6302
6478
|
*/
|
|
6303
|
-
|
|
6479
|
+
Operator?: UserInfo;
|
|
6304
6480
|
/**
|
|
6305
|
-
*
|
|
6481
|
+
* 签署人信息补充方式
|
|
6482
|
+
|
|
6483
|
+
<ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
|
|
6306
6484
|
*/
|
|
6307
|
-
|
|
6485
|
+
FillApproverType?: number;
|
|
6308
6486
|
}
|
|
6309
6487
|
/**
|
|
6310
6488
|
* ChannelUpdateSealStatus返回参数结构体
|
|
@@ -6442,11 +6620,19 @@ export interface CcInfo {
|
|
|
6442
6620
|
*/
|
|
6443
6621
|
export interface ChannelDescribeFlowComponentsRequest {
|
|
6444
6622
|
/**
|
|
6445
|
-
*
|
|
6623
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6624
|
+
|
|
6625
|
+
此接口下面信息必填。
|
|
6626
|
+
<ul>
|
|
6627
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6628
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6629
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
6630
|
+
</ul>
|
|
6631
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6446
6632
|
*/
|
|
6447
6633
|
Agent: Agent;
|
|
6448
6634
|
/**
|
|
6449
|
-
*
|
|
6635
|
+
* 需要获取填写控件填写内容的合同流程ID
|
|
6450
6636
|
*/
|
|
6451
6637
|
FlowId: string;
|
|
6452
6638
|
}
|