tencentcloud-sdk-nodejs 4.0.616 → 4.0.617

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.
@@ -389,6 +389,21 @@ export interface DescribeApiResponse {
389
389
  RequestId?: string
390
390
  }
391
391
 
392
+ /**
393
+ * DescribeServiceForApiApp请求参数结构体
394
+ */
395
+ export interface DescribeServiceForApiAppRequest {
396
+ /**
397
+ * 待查询的服务唯一 ID。
398
+ */
399
+ ServiceId: string
400
+
401
+ /**
402
+ * 服务所属的地域
403
+ */
404
+ ApiRegion: string
405
+ }
406
+
392
407
  /**
393
408
  * UnReleaseService请求参数结构体
394
409
  */
@@ -3589,6 +3604,11 @@ export interface DescribeApisStatusResultInfo {
3589
3604
  * 符合条件的 API 接口数量。
3590
3605
  */
3591
3606
  TotalCount: number
3607
+
3608
+ /**
3609
+ * API 接口列表。
3610
+ */
3611
+ ApiIdStatusSet: Array<DescribeApisStatusResultApiIdStatusSetInfo>
3592
3612
  }
3593
3613
 
3594
3614
  /**
@@ -3643,6 +3663,11 @@ export interface UpdateApiAppKeyRequest {
3643
3663
  ApiAppSecret?: string
3644
3664
  }
3645
3665
 
3666
+ /**
3667
+ * key-value
3668
+ */
3669
+ export type ApigatewayTags = null
3670
+
3646
3671
  /**
3647
3672
  * 服务自定义域名列表
3648
3673
  */
@@ -6124,18 +6149,120 @@ export interface AttachPluginRequest {
6124
6149
  }
6125
6150
 
6126
6151
  /**
6127
- * DescribeServiceForApiApp请求参数结构体
6152
+ * api状态详情
6128
6153
  */
6129
- export interface DescribeServiceForApiAppRequest {
6154
+ export interface DescribeApisStatusResultApiIdStatusSetInfo {
6130
6155
  /**
6131
- * 待查询的服务唯一 ID。
6156
+ * 服务唯一ID。
6132
6157
  */
6133
6158
  ServiceId: string
6134
6159
 
6135
6160
  /**
6136
- * 服务所属的地域
6161
+ * API唯一ID。
6137
6162
  */
6138
- ApiRegion: string
6163
+ ApiId: string
6164
+
6165
+ /**
6166
+ * 用户自定义的 API 接口描述。
6167
+ 注意:此字段可能返回 null,表示取不到有效值。
6168
+ */
6169
+ ApiDesc: string
6170
+
6171
+ /**
6172
+ * 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
6173
+ 注意:此字段可能返回 null,表示取不到有效值。
6174
+ */
6175
+ CreatedTime: string
6176
+
6177
+ /**
6178
+ * 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
6179
+ 注意:此字段可能返回 null,表示取不到有效值。
6180
+ */
6181
+ ModifiedTime: string
6182
+
6183
+ /**
6184
+ * API 接口的名称。
6185
+ 注意:此字段可能返回 null,表示取不到有效值。
6186
+ */
6187
+ ApiName: string
6188
+
6189
+ /**
6190
+ * VPCID。
6191
+ 注意:此字段可能返回 null,表示取不到有效值。
6192
+ */
6193
+ VpcId: number
6194
+
6195
+ /**
6196
+ * VPC唯一ID。
6197
+ 注意:此字段可能返回 null,表示取不到有效值。
6198
+ */
6199
+ UniqVpcId: string
6200
+
6201
+ /**
6202
+ * API类型。取值为NORMAL(普通API)和TSF(微服务API)。
6203
+ 注意:此字段可能返回 null,表示取不到有效值。
6204
+ */
6205
+ ApiType: string
6206
+
6207
+ /**
6208
+ * API协议。
6209
+ 注意:此字段可能返回 null,表示取不到有效值。
6210
+ */
6211
+ Protocol: string
6212
+
6213
+ /**
6214
+ * 是否买后调试。(云市场预留字段)
6215
+ 注意:此字段可能返回 null,表示取不到有效值。
6216
+ */
6217
+ IsDebugAfterCharge: boolean
6218
+
6219
+ /**
6220
+ * API 鉴权类型。取值为SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH、EIAM。
6221
+ 注意:此字段可能返回 null,表示取不到有效值。
6222
+ */
6223
+ AuthType: string
6224
+
6225
+ /**
6226
+ * OAUTH API的类型。当AuthType 为 OAUTH时该字段有效, 取值为NORMAL(业务API)和 OAUTH(授权API)。
6227
+ 注意:此字段可能返回 null,表示取不到有效值。
6228
+ */
6229
+ ApiBusinessType: string
6230
+
6231
+ /**
6232
+ * 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
6233
+ 注意:此字段可能返回 null,表示取不到有效值。
6234
+ */
6235
+ AuthRelationApiId: string
6236
+
6237
+ /**
6238
+ * OAUTH 配置信息。当AuthType是OAUTH时生效。
6239
+ 注意:此字段可能返回 null,表示取不到有效值。
6240
+ */
6241
+ OauthConfig: OauthConfig
6242
+
6243
+ /**
6244
+ * 授权API关联的业务API列表。
6245
+ 注意:此字段可能返回 null,表示取不到有效值。
6246
+ */
6247
+ RelationBuniessApiIds?: Array<string>
6248
+
6249
+ /**
6250
+ * API关联的标签信息。
6251
+ 注意:此字段可能返回 null,表示取不到有效值。
6252
+ */
6253
+ Tags: Array<ApigatewayTags>
6254
+
6255
+ /**
6256
+ * API 的路径,如 /path。
6257
+ 注意:此字段可能返回 null,表示取不到有效值。
6258
+ */
6259
+ Path: string
6260
+
6261
+ /**
6262
+ * API 的请求方法,如 GET。
6263
+ 注意:此字段可能返回 null,表示取不到有效值。
6264
+ */
6265
+ Method: string
6139
6266
  }
6140
6267
 
6141
6268
  /**
@@ -18,11 +18,13 @@
18
18
  import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
+ ModifyIntegrationDepartmentResponse,
21
22
  CancelFlowResponse,
22
23
  DescribeFlowEvidenceReportRequest,
23
24
  UpdateIntegrationEmployeesResponse,
24
25
  Department,
25
26
  CreatePreparedPersonalEsignRequest,
27
+ DescribeIntegrationDepartmentsResponse,
26
28
  FileInfo,
27
29
  CreateFlowApproversResponse,
28
30
  DescribeIntegrationMainOrganizationUserRequest,
@@ -33,13 +35,13 @@ import {
33
35
  DisableUserAutoSignResponse,
34
36
  BindEmployeeUserIdWithClientOpenIdResponse,
35
37
  CreateIntegrationEmployeesRequest,
36
- CreateConvertTaskApiRequest,
38
+ DescribeIntegrationRolesRequest,
37
39
  CreateFlowEvidenceReportRequest,
38
40
  StartFlowResponse,
39
41
  StaffRole,
40
42
  FlowApproverUrlInfo,
41
43
  AuthorizedUser,
42
- DescribeIntegrationRolesRequest,
44
+ CreateConvertTaskApiRequest,
43
45
  CreateFlowRemindsResponse,
44
46
  DescribeOrganizationGroupOrganizationsRequest,
45
47
  Agent,
@@ -53,11 +55,14 @@ import {
53
55
  CreateIntegrationUserRolesResponse,
54
56
  CreateFlowRequest,
55
57
  CreateSchemeUrlRequest,
58
+ DeleteIntegrationDepartmentResponse,
56
59
  AutoSignConfig,
57
60
  DescribeThirdPartyAuthCodeRequest,
58
61
  UnbindEmployeeUserIdWithClientOpenIdResponse,
59
62
  CreateReleaseFlowResponse,
60
63
  BindEmployeeUserIdWithClientOpenIdRequest,
64
+ DescribeIntegrationDepartmentsRequest,
65
+ CreateIntegrationDepartmentResponse,
61
66
  DeleteSealPoliciesResponse,
62
67
  OrganizationInfo,
63
68
  DescribeUserAutoSignStatusResponse,
@@ -86,6 +91,7 @@ import {
86
91
  Staff,
87
92
  CreateFlowEvidenceReportResponse,
88
93
  DescribeFileUrlsResponse,
94
+ CreateIntegrationDepartmentRequest,
89
95
  GroupOrganization,
90
96
  DeleteIntegrationRoleUsersResponse,
91
97
  CreateDocumentRequest,
@@ -111,6 +117,7 @@ import {
111
117
  FailedCreateRoleData,
112
118
  ApproverInfo,
113
119
  CreateFlowSignReviewResponse,
120
+ ModifyIntegrationDepartmentRequest,
114
121
  Filter,
115
122
  CreateStaffResult,
116
123
  CreateUserAutoSignEnableUrlRequest,
@@ -124,6 +131,7 @@ import {
124
131
  CreatePrepareFlowResponse,
125
132
  GetTaskResultApiResponse,
126
133
  CancelMultiFlowSignQRCodeRequest,
134
+ DeleteIntegrationDepartmentRequest,
127
135
  ModifyApplicationCallbackInfoRequest,
128
136
  IntegrationMainOrganizationUser,
129
137
  StartFlowRequest,
@@ -135,6 +143,7 @@ import {
135
143
  CancelFlowRequest,
136
144
  UploadFile,
137
145
  Component,
146
+ IntegrationDepartment,
138
147
  DescribeIntegrationRolesResponse,
139
148
  CreateFlowRemindsRequest,
140
149
  UpdateIntegrationEmployeesRequest,
@@ -172,13 +181,14 @@ export class Client extends AbstractClient {
172
181
  }
173
182
 
174
183
  /**
175
- * 此API接口用户查询加入集团的成员企业
176
- */
177
- async DescribeOrganizationGroupOrganizations(
178
- req: DescribeOrganizationGroupOrganizationsRequest,
179
- cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void
180
- ): Promise<DescribeOrganizationGroupOrganizationsResponse> {
181
- return this.request("DescribeOrganizationGroupOrganizations", req, cb)
184
+ * 查询合同详情
185
+ 适用场景:可用于主动查询某个合同详情信息。
186
+ */
187
+ async DescribeFlowInfo(
188
+ req: DescribeFlowInfoRequest,
189
+ cb?: (error: string, rep: DescribeFlowInfoResponse) => void
190
+ ): Promise<DescribeFlowInfoResponse> {
191
+ return this.request("DescribeFlowInfo", req, cb)
182
192
  }
183
193
 
184
194
  /**
@@ -260,14 +270,23 @@ callbackinfo包含: 回调地址和签名key
260
270
  }
261
271
 
262
272
  /**
263
- * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
264
- 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
265
- */
266
- async CreateFlowEvidenceReport(
267
- req: CreateFlowEvidenceReportRequest,
268
- cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void
269
- ): Promise<CreateFlowEvidenceReportResponse> {
270
- return this.request("CreateFlowEvidenceReport", req, cb)
273
+ * 对企业员工进行印章授权
274
+ */
275
+ async CreateSealPolicy(
276
+ req: CreateSealPolicyRequest,
277
+ cb?: (error: string, rep: CreateSealPolicyResponse) => void
278
+ ): Promise<CreateSealPolicyResponse> {
279
+ return this.request("CreateSealPolicy", req, cb)
280
+ }
281
+
282
+ /**
283
+ * 此API接口用户查询加入集团的成员企业
284
+ */
285
+ async DescribeOrganizationGroupOrganizations(
286
+ req: DescribeOrganizationGroupOrganizationsRequest,
287
+ cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void
288
+ ): Promise<DescribeOrganizationGroupOrganizationsResponse> {
289
+ return this.request("DescribeOrganizationGroupOrganizations", req, cb)
271
290
  }
272
291
 
273
292
  /**
@@ -302,6 +321,16 @@ callbackinfo包含: 回调地址和签名key
302
321
  return this.request("CreateBatchCancelFlowUrl", req, cb)
303
322
  }
304
323
 
324
+ /**
325
+ * 通过此接口,删除企业的部门。
326
+ */
327
+ async DeleteIntegrationDepartment(
328
+ req: DeleteIntegrationDepartmentRequest,
329
+ cb?: (error: string, rep: DeleteIntegrationDepartmentResponse) => void
330
+ ): Promise<DeleteIntegrationDepartmentResponse> {
331
+ return this.request("DeleteIntegrationDepartment", req, cb)
332
+ }
333
+
305
334
  /**
306
335
  * 将电子签系统员工userId与客户系统员工openId进行绑定
307
336
  */
@@ -394,24 +423,32 @@ callbackinfo包含: 回调地址和签名key
394
423
  }
395
424
 
396
425
  /**
397
- * 查询合同详情
398
- 适用场景:可用于主动查询某个合同详情信息。
426
+ * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
427
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
428
+
429
+ **本接口适用于发起方没有填写控件的 B2C或者单C模板**
430
+
431
+ **若是B2C模板,还要满足以下任意一个条件**
432
+ - 模板中配置的签署顺序是无序
433
+ - B端企业的签署方式是静默签署
434
+ - B端企业是非首位签署
399
435
  */
400
- async DescribeFlowInfo(
401
- req: DescribeFlowInfoRequest,
402
- cb?: (error: string, rep: DescribeFlowInfoResponse) => void
403
- ): Promise<DescribeFlowInfoResponse> {
404
- return this.request("DescribeFlowInfo", req, cb)
436
+ async CreateMultiFlowSignQRCode(
437
+ req: CreateMultiFlowSignQRCodeRequest,
438
+ cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void
439
+ ): Promise<CreateMultiFlowSignQRCodeResponse> {
440
+ return this.request("CreateMultiFlowSignQRCode", req, cb)
405
441
  }
406
442
 
407
443
  /**
408
- * 对企业员工进行印章授权
409
- */
410
- async CreateSealPolicy(
411
- req: CreateSealPolicyRequest,
412
- cb?: (error: string, rep: CreateSealPolicyResponse) => void
413
- ): Promise<CreateSealPolicyResponse> {
414
- return this.request("CreateSealPolicy", req, cb)
444
+ * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
445
+ 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
446
+ */
447
+ async CreateFlowEvidenceReport(
448
+ req: CreateFlowEvidenceReportRequest,
449
+ cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void
450
+ ): Promise<CreateFlowEvidenceReportResponse> {
451
+ return this.request("CreateFlowEvidenceReport", req, cb)
415
452
  }
416
453
 
417
454
  /**
@@ -491,21 +528,13 @@ callbackinfo包含: 回调地址和签名key
491
528
  }
492
529
 
493
530
  /**
494
- * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
495
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
496
-
497
- **本接口适用于发起方没有填写控件的 B2C或者单C模板**
498
-
499
- **若是B2C模板,还要满足以下任意一个条件**
500
- - 模板中配置的签署顺序是无序
501
- - B端企业的签署方式是静默签署
502
- - B端企业是非首位签署
503
- */
504
- async CreateMultiFlowSignQRCode(
505
- req: CreateMultiFlowSignQRCodeRequest,
506
- cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void
507
- ): Promise<CreateMultiFlowSignQRCodeResponse> {
508
- return this.request("CreateMultiFlowSignQRCode", req, cb)
531
+ * 通过此接口,创建企业的部门,支持绑定客户系统部门ID。
532
+ */
533
+ async CreateIntegrationDepartment(
534
+ req: CreateIntegrationDepartmentRequest,
535
+ cb?: (error: string, rep: CreateIntegrationDepartmentResponse) => void
536
+ ): Promise<CreateIntegrationDepartmentResponse> {
537
+ return this.request("CreateIntegrationDepartment", req, cb)
509
538
  }
510
539
 
511
540
  /**
@@ -676,6 +705,26 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
676
705
  return this.request("CreateSchemeUrl", req, cb)
677
706
  }
678
707
 
708
+ /**
709
+ * 通过此接口,查询企业的部门,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
710
+ */
711
+ async DescribeIntegrationDepartments(
712
+ req: DescribeIntegrationDepartmentsRequest,
713
+ cb?: (error: string, rep: DescribeIntegrationDepartmentsResponse) => void
714
+ ): Promise<DescribeIntegrationDepartmentsResponse> {
715
+ return this.request("DescribeIntegrationDepartments", req, cb)
716
+ }
717
+
718
+ /**
719
+ * 通过此接口,更新企业的部门信息,支持更新部门名、客户系统部门ID、部门序列号。
720
+ */
721
+ async ModifyIntegrationDepartment(
722
+ req: ModifyIntegrationDepartmentRequest,
723
+ cb?: (error: string, rep: ModifyIntegrationDepartmentResponse) => void
724
+ ): Promise<ModifyIntegrationDepartmentResponse> {
725
+ return this.request("ModifyIntegrationDepartment", req, cb)
726
+ }
727
+
679
728
  /**
680
729
  * 创建员工,如需在此接口提醒员工实名,入参Employees的OpenId不传
681
730
  */