tencentcloud-sdk-nodejs-essbasic 4.0.453 → 4.0.455

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.
@@ -244,27 +244,29 @@ export interface TemplateInfo {
244
244
  CreatedOn: number;
245
245
  }
246
246
  /**
247
- * UploadFiles请求参数结构体
247
+ * ChannelDescribeEmployees请求参数结构体
248
248
  */
249
- export interface UploadFilesRequest {
249
+ export interface ChannelDescribeEmployeesRequest {
250
250
  /**
251
- * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
251
+ * 返回最大数量,最大为20
252
252
  */
253
- Agent: Agent;
254
- /**
255
- * 文件对应业务类型,用于区分文件存储路径:
256
- 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
257
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
258
- */
259
- BusinessType: string;
253
+ Limit: number;
260
254
  /**
261
- * 上传文件内容数组,最多支持20个文件
255
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
262
256
  */
263
- FileInfos?: Array<UploadFile>;
257
+ Agent?: Agent;
264
258
  /**
265
259
  * 操作者的信息
266
260
  */
267
261
  Operator?: UserInfo;
262
+ /**
263
+ * 查询过滤实名用户,key为Status,Values为["IsVerified"]
264
+ */
265
+ Filters?: Array<Filter>;
266
+ /**
267
+ * 偏移量,默认为0,最大为20000
268
+ */
269
+ Offset?: number;
268
270
  }
269
271
  /**
270
272
  * SyncProxyOrganization返回参数结构体
@@ -301,6 +303,31 @@ export interface GetDownloadFlowUrlResponse {
301
303
  */
302
304
  RequestId?: string;
303
305
  }
306
+ /**
307
+ * DescribeTemplates返回参数结构体
308
+ */
309
+ export interface DescribeTemplatesResponse {
310
+ /**
311
+ * 模板详情
312
+ */
313
+ Templates: Array<TemplateInfo>;
314
+ /**
315
+ * 查询总数
316
+ */
317
+ TotalCount: number;
318
+ /**
319
+ * 查询数量
320
+ */
321
+ Limit: number;
322
+ /**
323
+ * 查询起始偏移
324
+ */
325
+ Offset: number;
326
+ /**
327
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
328
+ */
329
+ RequestId?: string;
330
+ }
304
331
  /**
305
332
  * DescribeResourceUrlsByFlows返回参数结构体
306
333
  */
@@ -378,29 +405,19 @@ export interface Recipient {
378
405
  IsPromoter?: boolean;
379
406
  }
380
407
  /**
381
- * DescribeTemplates返回参数结构体
408
+ * 渠道版员工部门信息
382
409
  */
383
- export interface DescribeTemplatesResponse {
384
- /**
385
- * 模板详情
386
- */
387
- Templates: Array<TemplateInfo>;
410
+ export interface Department {
388
411
  /**
389
- * 查询总数
390
- */
391
- TotalCount: number;
392
- /**
393
- * 查询数量
394
- */
395
- Limit: number;
396
- /**
397
- * 查询起始偏移
398
- */
399
- Offset: number;
412
+ * 部门id
413
+ 注意:此字段可能返回 null,表示取不到有效值。
414
+ */
415
+ DepartmentId: string;
400
416
  /**
401
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
402
- */
403
- RequestId?: string;
417
+ * 部门名称
418
+ 注意:此字段可能返回 null,表示取不到有效值。
419
+ */
420
+ DepartmentName: string;
404
421
  }
405
422
  /**
406
423
  * OperateChannelTemplate返回参数结构体
@@ -441,6 +458,21 @@ export interface OperateChannelTemplateResponse {
441
458
  */
442
459
  RequestId?: string;
443
460
  }
461
+ /**
462
+ * 渠道版员工角色信息
463
+ */
464
+ export interface StaffRole {
465
+ /**
466
+ * 角色id
467
+ 注意:此字段可能返回 null,表示取不到有效值。
468
+ */
469
+ RoleId: string;
470
+ /**
471
+ * 角色名称
472
+ 注意:此字段可能返回 null,表示取不到有效值。
473
+ */
474
+ RoleName: string;
475
+ }
444
476
  /**
445
477
  * CreateSignUrls返回参数结构体
446
478
  */
@@ -1004,6 +1036,21 @@ export interface FlowDetailInfo {
1004
1036
  */
1005
1037
  FlowApproverInfos: Array<FlowApproverDetail>;
1006
1038
  }
1039
+ /**
1040
+ * 同步经办人失败原因
1041
+ */
1042
+ export interface SyncFailReason {
1043
+ /**
1044
+ * 经办人Id
1045
+ */
1046
+ Id: string;
1047
+ /**
1048
+ * 失败原因
1049
+ 例如:Id不符合规范、证件号码不合法等
1050
+ 注意:此字段可能返回 null,表示取不到有效值。
1051
+ */
1052
+ Message: string;
1053
+ }
1007
1054
  /**
1008
1055
  * CreateConsoleLoginUrl请求参数结构体
1009
1056
  */
@@ -1351,6 +1398,19 @@ export interface CreateFlowsByTemplatesRequest {
1351
1398
  */
1352
1399
  Operator?: UserInfo;
1353
1400
  }
1401
+ /**
1402
+ * 此结构体 (Filter) 用于描述查询过滤条件。
1403
+ */
1404
+ export interface Filter {
1405
+ /**
1406
+ * 查询过滤条件的Key
1407
+ */
1408
+ Key: string;
1409
+ /**
1410
+ * 查询过滤条件的Value列表
1411
+ */
1412
+ Values: Array<string>;
1413
+ }
1354
1414
  /**
1355
1415
  * SyncProxyOrganization请求参数结构体
1356
1416
  */
@@ -1583,33 +1643,60 @@ export interface CreateChannelFlowEvidenceReportResponse {
1583
1643
  RequestId?: string;
1584
1644
  }
1585
1645
  /**
1586
- * 同步经办人失败原因
1646
+ * PrepareFlows返回参数结构体
1587
1647
  */
1588
- export interface SyncFailReason {
1648
+ export interface PrepareFlowsResponse {
1589
1649
  /**
1590
- * 经办人Id
1650
+ * 待发起文件确认页
1591
1651
  */
1592
- Id: string;
1652
+ ConfirmUrl: string;
1593
1653
  /**
1594
- * 失败原因
1595
- 例如:Id不符合规范、证件号码不合法等
1596
- 注意:此字段可能返回 null,表示取不到有效值。
1597
- */
1598
- Message: string;
1654
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1655
+ */
1656
+ RequestId?: string;
1599
1657
  }
1600
1658
  /**
1601
- * PrepareFlows返回参数结构体
1659
+ * ChannelDescribeEmployees返回参数结构体
1602
1660
  */
1603
- export interface PrepareFlowsResponse {
1661
+ export interface ChannelDescribeEmployeesResponse {
1604
1662
  /**
1605
- * 待发起文件确认页
1663
+ * 员工数据列表
1664
+ 注意:此字段可能返回 null,表示取不到有效值。
1665
+ */
1666
+ Employees: Array<Staff>;
1667
+ /**
1668
+ * 偏移量,默认为0,最大为20000
1669
+ 注意:此字段可能返回 null,表示取不到有效值。
1670
+ */
1671
+ Offset: number;
1672
+ /**
1673
+ * 返回最大数量,最大为20
1606
1674
  */
1607
- ConfirmUrl: string;
1675
+ Limit: number;
1676
+ /**
1677
+ * 符合条件的员工数量
1678
+ */
1679
+ TotalCount: number;
1608
1680
  /**
1609
1681
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1610
1682
  */
1611
1683
  RequestId?: string;
1612
1684
  }
1685
+ /**
1686
+ * 复杂文档合成任务的任务信息
1687
+ */
1688
+ export interface TaskInfo {
1689
+ /**
1690
+ * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
1691
+ 注意:此字段可能返回 null,表示取不到有效值。
1692
+ */
1693
+ TaskId: string;
1694
+ /**
1695
+ * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
1696
+ 注意:此字段可能返回 null,表示取不到有效值。
1697
+ */
1698
+ TaskStatus: string;
1699
+ }
1613
1700
  /**
1614
1701
  * DescribeUsage请求参数结构体
1615
1702
  */
@@ -2087,19 +2174,76 @@ export interface ChannelCreateFlowGroupByFilesRequest {
2087
2174
  Operator?: UserInfo;
2088
2175
  }
2089
2176
  /**
2090
- * 复杂文档合成任务的任务信息
2177
+ * UploadFiles请求参数结构体
2091
2178
  */
2092
- export interface TaskInfo {
2179
+ export interface UploadFilesRequest {
2093
2180
  /**
2094
- * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
2181
+ * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
2182
+ */
2183
+ Agent: Agent;
2184
+ /**
2185
+ * 文件对应业务类型,用于区分文件存储路径:
2186
+ 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
2187
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
2188
+ */
2189
+ BusinessType: string;
2190
+ /**
2191
+ * 上传文件内容数组,最多支持20个文件
2192
+ */
2193
+ FileInfos?: Array<UploadFile>;
2194
+ /**
2195
+ * 操作者的信息
2196
+ */
2197
+ Operator?: UserInfo;
2198
+ }
2199
+ /**
2200
+ * 企业员工信息
2201
+ */
2202
+ export interface Staff {
2203
+ /**
2204
+ * 员工在电子签平台的id
2205
+ */
2206
+ UserId: string;
2207
+ /**
2208
+ * 显示的员工名
2209
+ */
2210
+ DisplayName: string;
2211
+ /**
2212
+ * 员工手机号
2213
+ */
2214
+ Mobile: string;
2215
+ /**
2216
+ * 员工邮箱
2095
2217
  注意:此字段可能返回 null,表示取不到有效值。
2096
2218
  */
2097
- TaskId: string;
2219
+ Email: string;
2098
2220
  /**
2099
- * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
2221
+ * 员工在第三方平台id
2100
2222
  注意:此字段可能返回 null,表示取不到有效值。
2101
2223
  */
2102
- TaskStatus: string;
2224
+ OpenId: string;
2225
+ /**
2226
+ * 员工角色
2227
+ 注意:此字段可能返回 null,表示取不到有效值。
2228
+ */
2229
+ Roles: Array<StaffRole>;
2230
+ /**
2231
+ * 员工部门
2232
+ 注意:此字段可能返回 null,表示取不到有效值。
2233
+ */
2234
+ Department: Department;
2235
+ /**
2236
+ * 员工是否实名
2237
+ */
2238
+ Verified: boolean;
2239
+ /**
2240
+ * 员工创建时间戳
2241
+ */
2242
+ CreatedOn: number;
2243
+ /**
2244
+ * 员工实名时间戳
2245
+ */
2246
+ VerifiedOn: number;
2103
2247
  }
2104
2248
  /**
2105
2249
  * 抄送信息