tencentcloud-sdk-nodejs-essbasic 4.0.527 → 4.0.529
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 +211 -0
- package/SERVICE_CHANGELOG.md +248 -10
- package/package.json +1 -1
- package/products.md +32 -31
- package/src/services/essbasic/v20210526/essbasic_client.ts +41 -24
- package/src/services/essbasic/v20210526/essbasic_models.ts +209 -153
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +18 -10
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +21 -11
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +183 -134
|
@@ -21,13 +21,13 @@ export interface ChannelCreateConvertTaskApiResponse {
|
|
|
21
21
|
RequestId?: string;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* ChannelCreateFlowReminds返回参数结构体
|
|
25
25
|
*/
|
|
26
|
-
export interface
|
|
26
|
+
export interface ChannelCreateFlowRemindsResponse {
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* 合同催办详情信息
|
|
29
29
|
*/
|
|
30
|
-
|
|
30
|
+
RemindFlowRecords: Array<RemindFlowRecords>;
|
|
31
31
|
/**
|
|
32
32
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
33
33
|
*/
|
|
@@ -130,8 +130,10 @@ export interface DescribeFlowDetailInfoRequest {
|
|
|
130
130
|
*/
|
|
131
131
|
export interface ModifyExtendedServiceRequest {
|
|
132
132
|
/**
|
|
133
|
-
|
|
134
|
-
|
|
133
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
134
|
+
|
|
135
|
+
注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
|
|
136
|
+
*/
|
|
135
137
|
Agent: Agent;
|
|
136
138
|
/**
|
|
137
139
|
* 扩展服务类型
|
|
@@ -167,6 +169,36 @@ export interface DescribeResourceUrlsByFlowsRequest {
|
|
|
167
169
|
*/
|
|
168
170
|
Operator?: UserInfo;
|
|
169
171
|
}
|
|
172
|
+
/**
|
|
173
|
+
* 催办接口返回详细信息
|
|
174
|
+
*/
|
|
175
|
+
export interface RemindFlowRecords {
|
|
176
|
+
/**
|
|
177
|
+
* 是否能够催办
|
|
178
|
+
*/
|
|
179
|
+
CanRemind: boolean;
|
|
180
|
+
/**
|
|
181
|
+
* 合同id
|
|
182
|
+
*/
|
|
183
|
+
FlowId: string;
|
|
184
|
+
/**
|
|
185
|
+
* 催办详情
|
|
186
|
+
*/
|
|
187
|
+
RemindMessage: string;
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* ChannelCreateFlowSignUrl返回参数结构体
|
|
191
|
+
*/
|
|
192
|
+
export interface ChannelCreateFlowSignUrlResponse {
|
|
193
|
+
/**
|
|
194
|
+
* 签署人签署链接信息
|
|
195
|
+
*/
|
|
196
|
+
FlowApproverUrlInfos: Array<FlowApproverUrlInfo>;
|
|
197
|
+
/**
|
|
198
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
199
|
+
*/
|
|
200
|
+
RequestId?: string;
|
|
201
|
+
}
|
|
170
202
|
/**
|
|
171
203
|
* CreateSealByImage返回参数结构体
|
|
172
204
|
*/
|
|
@@ -346,29 +378,17 @@ export interface CreateSealByImageRequest {
|
|
|
346
378
|
Operator?: UserInfo;
|
|
347
379
|
}
|
|
348
380
|
/**
|
|
349
|
-
*
|
|
381
|
+
* ChannelCreateFlowReminds请求参数结构体
|
|
350
382
|
*/
|
|
351
|
-
export interface
|
|
383
|
+
export interface ChannelCreateFlowRemindsRequest {
|
|
352
384
|
/**
|
|
353
|
-
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId
|
|
385
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
354
386
|
*/
|
|
355
387
|
Agent: Agent;
|
|
356
388
|
/**
|
|
357
|
-
*
|
|
358
|
-
*/
|
|
359
|
-
FlowId: string;
|
|
360
|
-
/**
|
|
361
|
-
* 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
|
|
362
|
-
*/
|
|
363
|
-
FlowApproverInfos: Array<FlowApproverInfo>;
|
|
364
|
-
/**
|
|
365
|
-
* 用户信息,暂未开放
|
|
366
|
-
*/
|
|
367
|
-
Operator?: UserInfo;
|
|
368
|
-
/**
|
|
369
|
-
* 机构信息,暂未开放
|
|
389
|
+
* 签署流程Id数组,最多100个,超过100不处理
|
|
370
390
|
*/
|
|
371
|
-
|
|
391
|
+
FlowIds: Array<string>;
|
|
372
392
|
}
|
|
373
393
|
/**
|
|
374
394
|
* ChannelCancelFlow返回参数结构体
|
|
@@ -894,6 +914,47 @@ export interface GetDownloadFlowUrlResponse {
|
|
|
894
914
|
*/
|
|
895
915
|
RequestId?: string;
|
|
896
916
|
}
|
|
917
|
+
/**
|
|
918
|
+
* 签署参与者信息
|
|
919
|
+
*/
|
|
920
|
+
export interface Recipient {
|
|
921
|
+
/**
|
|
922
|
+
* 签署人唯一标识
|
|
923
|
+
*/
|
|
924
|
+
RecipientId?: string;
|
|
925
|
+
/**
|
|
926
|
+
* 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
|
|
927
|
+
*/
|
|
928
|
+
RecipientType?: string;
|
|
929
|
+
/**
|
|
930
|
+
* 描述
|
|
931
|
+
*/
|
|
932
|
+
Description?: string;
|
|
933
|
+
/**
|
|
934
|
+
* 签署方备注信息
|
|
935
|
+
*/
|
|
936
|
+
RoleName?: string;
|
|
937
|
+
/**
|
|
938
|
+
* 是否需要校验
|
|
939
|
+
*/
|
|
940
|
+
RequireValidation?: boolean;
|
|
941
|
+
/**
|
|
942
|
+
* 是否必须填写
|
|
943
|
+
*/
|
|
944
|
+
RequireSign?: boolean;
|
|
945
|
+
/**
|
|
946
|
+
* 签署类型
|
|
947
|
+
*/
|
|
948
|
+
SignType?: number;
|
|
949
|
+
/**
|
|
950
|
+
* 签署顺序:数字越小优先级越高
|
|
951
|
+
*/
|
|
952
|
+
RoutingOrder?: number;
|
|
953
|
+
/**
|
|
954
|
+
* 是否是发起方
|
|
955
|
+
*/
|
|
956
|
+
IsPromoter?: boolean;
|
|
957
|
+
}
|
|
897
958
|
/**
|
|
898
959
|
* DescribeTemplates返回参数结构体
|
|
899
960
|
*/
|
|
@@ -986,23 +1047,6 @@ export interface ChannelVerifyPdfResponse {
|
|
|
986
1047
|
*/
|
|
987
1048
|
RequestId?: string;
|
|
988
1049
|
}
|
|
989
|
-
/**
|
|
990
|
-
* DescribeChannelFlowEvidenceReport请求参数结构体
|
|
991
|
-
*/
|
|
992
|
-
export interface DescribeChannelFlowEvidenceReportRequest {
|
|
993
|
-
/**
|
|
994
|
-
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
995
|
-
*/
|
|
996
|
-
Agent: Agent;
|
|
997
|
-
/**
|
|
998
|
-
* 出证报告编号
|
|
999
|
-
*/
|
|
1000
|
-
ReportId: string;
|
|
1001
|
-
/**
|
|
1002
|
-
* 操作者的信息
|
|
1003
|
-
*/
|
|
1004
|
-
Operator?: UserInfo;
|
|
1005
|
-
}
|
|
1006
1050
|
/**
|
|
1007
1051
|
* CreateConsoleLoginUrl请求参数结构体
|
|
1008
1052
|
*/
|
|
@@ -1205,40 +1249,51 @@ export interface ChannelDescribeOrganizationSealsRequest {
|
|
|
1205
1249
|
SealId?: string;
|
|
1206
1250
|
}
|
|
1207
1251
|
/**
|
|
1208
|
-
*
|
|
1252
|
+
* DescribeUsage请求参数结构体
|
|
1209
1253
|
*/
|
|
1210
|
-
export interface
|
|
1254
|
+
export interface DescribeUsageRequest {
|
|
1211
1255
|
/**
|
|
1212
|
-
*
|
|
1256
|
+
* 应用信息,此接口Agent.AppId必填
|
|
1213
1257
|
*/
|
|
1214
|
-
|
|
1258
|
+
Agent: Agent;
|
|
1215
1259
|
/**
|
|
1216
|
-
*
|
|
1260
|
+
* 开始时间,例如:2021-03-21
|
|
1217
1261
|
*/
|
|
1218
|
-
|
|
1262
|
+
StartDate: string;
|
|
1219
1263
|
/**
|
|
1220
|
-
*
|
|
1221
|
-
|
|
1222
|
-
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
1223
|
-
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
1264
|
+
* 结束时间,例如:2021-06-21;
|
|
1265
|
+
开始时间到结束时间的区间长度小于等于90天。
|
|
1224
1266
|
*/
|
|
1225
|
-
|
|
1267
|
+
EndDate: string;
|
|
1226
1268
|
/**
|
|
1227
|
-
|
|
1269
|
+
* 是否汇总数据,默认不汇总。
|
|
1270
|
+
不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
1271
|
+
汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
|
|
1272
|
+
*/
|
|
1273
|
+
NeedAggregate?: boolean;
|
|
1274
|
+
/**
|
|
1275
|
+
* 单次返回的最多条目数量。默认为1000,且不能超过1000。
|
|
1228
1276
|
*/
|
|
1229
|
-
|
|
1277
|
+
Limit?: number;
|
|
1230
1278
|
/**
|
|
1231
|
-
*
|
|
1279
|
+
* 偏移量,默认是0。
|
|
1232
1280
|
*/
|
|
1233
|
-
|
|
1281
|
+
Offset?: number;
|
|
1282
|
+
/**
|
|
1283
|
+
* 操作者的信息
|
|
1284
|
+
*/
|
|
1285
|
+
Operator?: UserInfo;
|
|
1234
1286
|
}
|
|
1235
1287
|
/**
|
|
1236
1288
|
* DescribeExtendedServiceAuthInfo请求参数结构体
|
|
1237
1289
|
*/
|
|
1238
1290
|
export interface DescribeExtendedServiceAuthInfoRequest {
|
|
1239
1291
|
/**
|
|
1240
|
-
|
|
1241
|
-
|
|
1292
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
1293
|
+
|
|
1294
|
+
注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
|
|
1295
|
+
|
|
1296
|
+
*/
|
|
1242
1297
|
Agent: Agent;
|
|
1243
1298
|
}
|
|
1244
1299
|
/**
|
|
@@ -1864,45 +1919,25 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
1864
1919
|
RequestId?: string;
|
|
1865
1920
|
}
|
|
1866
1921
|
/**
|
|
1867
|
-
*
|
|
1922
|
+
* PrepareFlows请求参数结构体
|
|
1868
1923
|
*/
|
|
1869
|
-
export interface
|
|
1870
|
-
/**
|
|
1871
|
-
* 签署人唯一标识
|
|
1872
|
-
*/
|
|
1873
|
-
RecipientId?: string;
|
|
1874
|
-
/**
|
|
1875
|
-
* 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
|
|
1876
|
-
*/
|
|
1877
|
-
RecipientType?: string;
|
|
1878
|
-
/**
|
|
1879
|
-
* 描述
|
|
1880
|
-
*/
|
|
1881
|
-
Description?: string;
|
|
1882
|
-
/**
|
|
1883
|
-
* 签署方备注信息
|
|
1884
|
-
*/
|
|
1885
|
-
RoleName?: string;
|
|
1886
|
-
/**
|
|
1887
|
-
* 是否需要校验
|
|
1888
|
-
*/
|
|
1889
|
-
RequireValidation?: boolean;
|
|
1924
|
+
export interface PrepareFlowsRequest {
|
|
1890
1925
|
/**
|
|
1891
|
-
*
|
|
1926
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1892
1927
|
*/
|
|
1893
|
-
|
|
1928
|
+
Agent: Agent;
|
|
1894
1929
|
/**
|
|
1895
|
-
*
|
|
1930
|
+
* 多个合同(签署流程)信息,最大支持20个签署流程。
|
|
1896
1931
|
*/
|
|
1897
|
-
|
|
1932
|
+
FlowInfos: Array<FlowInfo>;
|
|
1898
1933
|
/**
|
|
1899
|
-
*
|
|
1934
|
+
* 操作完成后的跳转地址,最大长度200
|
|
1900
1935
|
*/
|
|
1901
|
-
|
|
1936
|
+
JumpUrl: string;
|
|
1902
1937
|
/**
|
|
1903
|
-
*
|
|
1938
|
+
* 操作者的信息
|
|
1904
1939
|
*/
|
|
1905
|
-
|
|
1940
|
+
Operator?: UserInfo;
|
|
1906
1941
|
}
|
|
1907
1942
|
/**
|
|
1908
1943
|
* SyncProxyOrganizationOperators返回参数结构体
|
|
@@ -2125,42 +2160,6 @@ export interface ReleasedApprover {
|
|
|
2125
2160
|
*/
|
|
2126
2161
|
OpenId?: string;
|
|
2127
2162
|
}
|
|
2128
|
-
/**
|
|
2129
|
-
* DescribeUsage请求参数结构体
|
|
2130
|
-
*/
|
|
2131
|
-
export interface DescribeUsageRequest {
|
|
2132
|
-
/**
|
|
2133
|
-
* 应用信息,此接口Agent.AppId必填
|
|
2134
|
-
*/
|
|
2135
|
-
Agent: Agent;
|
|
2136
|
-
/**
|
|
2137
|
-
* 开始时间,例如:2021-03-21
|
|
2138
|
-
*/
|
|
2139
|
-
StartDate: string;
|
|
2140
|
-
/**
|
|
2141
|
-
* 结束时间,例如:2021-06-21;
|
|
2142
|
-
开始时间到结束时间的区间长度小于等于90天。
|
|
2143
|
-
*/
|
|
2144
|
-
EndDate: string;
|
|
2145
|
-
/**
|
|
2146
|
-
* 是否汇总数据,默认不汇总。
|
|
2147
|
-
不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
2148
|
-
汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
|
|
2149
|
-
*/
|
|
2150
|
-
NeedAggregate?: boolean;
|
|
2151
|
-
/**
|
|
2152
|
-
* 单次返回的最多条目数量。默认为1000,且不能超过1000。
|
|
2153
|
-
*/
|
|
2154
|
-
Limit?: number;
|
|
2155
|
-
/**
|
|
2156
|
-
* 偏移量,默认是0。
|
|
2157
|
-
*/
|
|
2158
|
-
Offset?: number;
|
|
2159
|
-
/**
|
|
2160
|
-
* 操作者的信息
|
|
2161
|
-
*/
|
|
2162
|
-
Operator?: UserInfo;
|
|
2163
|
-
}
|
|
2164
2163
|
/**
|
|
2165
2164
|
* CreateSignUrls返回参数结构体
|
|
2166
2165
|
*/
|
|
@@ -2238,21 +2237,17 @@ export interface ApproverRestriction {
|
|
|
2238
2237
|
IdCardNumber?: string;
|
|
2239
2238
|
}
|
|
2240
2239
|
/**
|
|
2241
|
-
*
|
|
2240
|
+
* DescribeChannelFlowEvidenceReport请求参数结构体
|
|
2242
2241
|
*/
|
|
2243
|
-
export interface
|
|
2242
|
+
export interface DescribeChannelFlowEvidenceReportRequest {
|
|
2244
2243
|
/**
|
|
2245
|
-
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId
|
|
2244
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
2246
2245
|
*/
|
|
2247
2246
|
Agent: Agent;
|
|
2248
2247
|
/**
|
|
2249
|
-
*
|
|
2250
|
-
*/
|
|
2251
|
-
FlowInfos: Array<FlowInfo>;
|
|
2252
|
-
/**
|
|
2253
|
-
* 操作完成后的跳转地址,最大长度200
|
|
2248
|
+
* 出证报告编号
|
|
2254
2249
|
*/
|
|
2255
|
-
|
|
2250
|
+
ReportId: string;
|
|
2256
2251
|
/**
|
|
2257
2252
|
* 操作者的信息
|
|
2258
2253
|
*/
|
|
@@ -2394,15 +2389,44 @@ export interface ChannelCreateBoundFlowsResponse {
|
|
|
2394
2389
|
*/
|
|
2395
2390
|
RequestId?: string;
|
|
2396
2391
|
}
|
|
2392
|
+
/**
|
|
2393
|
+
* 合作企业经办人列表信息
|
|
2394
|
+
*/
|
|
2395
|
+
export interface ProxyOrganizationOperator {
|
|
2396
|
+
/**
|
|
2397
|
+
* 对应Agent-ProxyOperator-OpenId。渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
|
|
2398
|
+
*/
|
|
2399
|
+
Id: string;
|
|
2400
|
+
/**
|
|
2401
|
+
* 经办人姓名,最大长度50个字符
|
|
2402
|
+
*/
|
|
2403
|
+
Name?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* 经办人身份证件类型
|
|
2406
|
+
1.ID_CARD 居民身份证
|
|
2407
|
+
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2408
|
+
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2409
|
+
*/
|
|
2410
|
+
IdCardType?: string;
|
|
2411
|
+
/**
|
|
2412
|
+
* 经办人证件号
|
|
2413
|
+
*/
|
|
2414
|
+
IdCardNumber?: string;
|
|
2415
|
+
/**
|
|
2416
|
+
* 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
|
|
2417
|
+
*/
|
|
2418
|
+
Mobile?: string;
|
|
2419
|
+
}
|
|
2397
2420
|
/**
|
|
2398
2421
|
* ModifyExtendedService返回参数结构体
|
|
2399
2422
|
*/
|
|
2400
2423
|
export interface ModifyExtendedServiceResponse {
|
|
2401
2424
|
/**
|
|
2402
2425
|
* 操作跳转链接,有效期24小时
|
|
2403
|
-
|
|
2426
|
+
若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
|
|
2404
2427
|
|
|
2405
|
-
|
|
2428
|
+
当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
|
|
2429
|
+
返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
|
|
2406
2430
|
*/
|
|
2407
2431
|
OperateUrl?: string;
|
|
2408
2432
|
/**
|
|
@@ -3110,6 +3134,31 @@ export interface DescribeChannelFlowEvidenceReportResponse {
|
|
|
3110
3134
|
*/
|
|
3111
3135
|
RequestId?: string;
|
|
3112
3136
|
}
|
|
3137
|
+
/**
|
|
3138
|
+
* ChannelCreateFlowSignUrl请求参数结构体
|
|
3139
|
+
*/
|
|
3140
|
+
export interface ChannelCreateFlowSignUrlRequest {
|
|
3141
|
+
/**
|
|
3142
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
3143
|
+
*/
|
|
3144
|
+
Agent: Agent;
|
|
3145
|
+
/**
|
|
3146
|
+
* 流程编号
|
|
3147
|
+
*/
|
|
3148
|
+
FlowId: string;
|
|
3149
|
+
/**
|
|
3150
|
+
* 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
|
|
3151
|
+
*/
|
|
3152
|
+
FlowApproverInfos: Array<FlowApproverInfo>;
|
|
3153
|
+
/**
|
|
3154
|
+
* 用户信息,暂未开放
|
|
3155
|
+
*/
|
|
3156
|
+
Operator?: UserInfo;
|
|
3157
|
+
/**
|
|
3158
|
+
* 机构信息,暂未开放
|
|
3159
|
+
*/
|
|
3160
|
+
Organization?: OrganizationInfo;
|
|
3161
|
+
}
|
|
3113
3162
|
/**
|
|
3114
3163
|
* 抄送信息
|
|
3115
3164
|
*/
|