tencentcloud-sdk-nodejs 4.0.724 → 4.0.726

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.
Files changed (100) hide show
  1. package/CHANGELOG.md +386 -0
  2. package/SERVICE_CHANGELOG.md +310 -53
  3. package/package.json +1 -1
  4. package/products.md +16 -16
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/btoe/index.ts +2 -2
  7. package/src/services/cfs/v20190719/cfs_client.ts +12 -0
  8. package/src/services/cfs/v20190719/cfs_models.ts +24 -0
  9. package/src/services/dasb/v20191018/dasb_models.ts +37 -15
  10. package/src/services/dnspod/v20210323/dnspod_models.ts +22 -22
  11. package/src/services/dts/index.ts +2 -2
  12. package/src/services/dts/v20211206/dts_models.ts +1 -1
  13. package/src/services/eis/index.ts +2 -2
  14. package/src/services/ess/v20201111/ess_client.ts +16 -15
  15. package/src/services/ess/v20201111/ess_models.ts +43 -10
  16. package/src/services/essbasic/v20210526/essbasic_client.ts +39 -17
  17. package/src/services/essbasic/v20210526/essbasic_models.ts +325 -128
  18. package/src/services/facefusion/index.ts +2 -2
  19. package/src/services/iotvideo/index.ts +2 -2
  20. package/src/services/irp/index.ts +2 -2
  21. package/src/services/lcic/v20220817/lcic_client.ts +28 -1
  22. package/src/services/lcic/v20220817/lcic_models.ts +95 -14
  23. package/src/services/lighthouse/v20200324/lighthouse_models.ts +4 -4
  24. package/src/services/mgobe/index.ts +2 -2
  25. package/src/services/mongodb/index.ts +2 -2
  26. package/src/services/organization/index.ts +2 -2
  27. package/src/services/tdmq/v20200217/tdmq_client.ts +13 -1
  28. package/src/services/tdmq/v20200217/tdmq_models.ts +84 -10
  29. package/src/services/tem/index.ts +2 -2
  30. package/src/services/thpc/index.ts +2 -2
  31. package/src/services/tione/index.ts +2 -2
  32. package/src/services/tke/v20180525/tke_client.ts +8 -8
  33. package/src/services/tke/v20180525/tke_models.ts +4 -4
  34. package/src/services/tsf/v20180326/tsf_client.ts +2 -1
  35. package/src/services/tsf/v20180326/tsf_models.ts +149 -41
  36. package/src/services/vm/index.ts +2 -2
  37. package/src/services/vpc/v20170312/vpc_models.ts +4 -0
  38. package/src/services/waf/v20180125/waf_client.ts +4 -6
  39. package/src/services/waf/v20180125/waf_models.ts +60 -2
  40. package/tencentcloud/common/sdk_version.d.ts +1 -1
  41. package/tencentcloud/common/sdk_version.js +1 -1
  42. package/tencentcloud/services/btoe/index.d.ts +4 -4
  43. package/tencentcloud/services/btoe/index.js +2 -2
  44. package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +5 -1
  45. package/tencentcloud/services/cfs/v20190719/cfs_client.js +6 -0
  46. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +22 -0
  47. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +37 -15
  48. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +22 -22
  49. package/tencentcloud/services/dts/index.d.ts +4 -4
  50. package/tencentcloud/services/dts/index.js +2 -2
  51. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  52. package/tencentcloud/services/eis/index.d.ts +4 -4
  53. package/tencentcloud/services/eis/index.js +2 -2
  54. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +14 -13
  55. package/tencentcloud/services/ess/v20201111/ess_client.js +14 -13
  56. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +43 -10
  57. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +30 -17
  58. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +31 -16
  59. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +322 -128
  60. package/tencentcloud/services/facefusion/index.d.ts +4 -4
  61. package/tencentcloud/services/facefusion/index.js +2 -2
  62. package/tencentcloud/services/iotvideo/index.d.ts +4 -4
  63. package/tencentcloud/services/iotvideo/index.js +2 -2
  64. package/tencentcloud/services/irp/index.d.ts +4 -4
  65. package/tencentcloud/services/irp/index.js +2 -2
  66. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +11 -1
  67. package/tencentcloud/services/lcic/v20220817/lcic_client.js +14 -0
  68. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +90 -14
  69. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +4 -4
  70. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  71. package/tencentcloud/services/mgobe/index.js +2 -2
  72. package/tencentcloud/services/mongodb/index.d.ts +4 -4
  73. package/tencentcloud/services/mongodb/index.js +2 -2
  74. package/tencentcloud/services/organization/index.d.ts +4 -4
  75. package/tencentcloud/services/organization/index.js +2 -2
  76. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +5 -1
  77. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +6 -0
  78. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +82 -10
  79. package/tencentcloud/services/tem/index.d.ts +4 -4
  80. package/tencentcloud/services/tem/index.js +2 -2
  81. package/tencentcloud/services/thpc/index.d.ts +4 -4
  82. package/tencentcloud/services/thpc/index.js +2 -2
  83. package/tencentcloud/services/tione/index.d.ts +4 -4
  84. package/tencentcloud/services/tione/index.js +2 -2
  85. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +8 -8
  86. package/tencentcloud/services/tke/v20180525/tke_client.js +8 -8
  87. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +4 -4
  88. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +1 -1
  89. package/tencentcloud/services/tsf/v20180326/tsf_client.js +1 -1
  90. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +148 -41
  91. package/tencentcloud/services/vm/index.d.ts +4 -4
  92. package/tencentcloud/services/vm/index.js +2 -2
  93. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +4 -0
  94. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +3 -5
  95. package/tencentcloud/services/waf/v20180125/waf_client.js +1 -3
  96. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +60 -2
  97. package/test/cfs.v20190719.test.js +10 -0
  98. package/test/essbasic.v20210526.test.js +10 -0
  99. package/test/lcic.v20220817.test.js +20 -0
  100. package/test/tdmq.v20200217.test.js +10 -0
@@ -1 +1 @@
1
- export const sdkVersion = "4.0.724"
1
+ export const sdkVersion = "4.0.726"
@@ -1,7 +1,7 @@
1
- import { v20210303 } from "./v20210303"
2
1
  import { v20210514 } from "./v20210514"
2
+ import { v20210303 } from "./v20210303"
3
3
 
4
4
  export const btoe = {
5
- v20210303: v20210303,
6
5
  v20210514: v20210514,
6
+ v20210303: v20210303,
7
7
  }
@@ -58,9 +58,11 @@ import {
58
58
  DeleteCfsRuleRequest,
59
59
  UpdateCfsRuleResponse,
60
60
  DeleteMigrationTaskResponse,
61
+ UpdateFileSystemBandwidthLimitResponse,
61
62
  DescribeSnapshotOperationLogsResponse,
62
63
  UpdateCfsFileSystemPGroupResponse,
63
64
  DeleteCfsFileSystemRequest,
65
+ UpdateFileSystemBandwidthLimitRequest,
64
66
  CreateCfsPGroupResponse,
65
67
  DescribeCfsServiceStatusRequest,
66
68
  DeleteUserQuotaResponse,
@@ -184,6 +186,16 @@ export class Client extends AbstractClient {
184
186
  return this.request("DescribeCfsPGroups", req, cb)
185
187
  }
186
188
 
189
+ /**
190
+ * 更新文件系统带宽
191
+ */
192
+ async UpdateFileSystemBandwidthLimit(
193
+ req: UpdateFileSystemBandwidthLimitRequest,
194
+ cb?: (error: string, rep: UpdateFileSystemBandwidthLimitResponse) => void
195
+ ): Promise<UpdateFileSystemBandwidthLimitResponse> {
196
+ return this.request("UpdateFileSystemBandwidthLimit", req, cb)
197
+ }
198
+
187
199
  /**
188
200
  * 设置文件系统配额,提供UID/GID的配额设置的接口
189
201
  */
@@ -1003,6 +1003,16 @@ export interface DeleteMigrationTaskResponse {
1003
1003
  RequestId?: string
1004
1004
  }
1005
1005
 
1006
+ /**
1007
+ * UpdateFileSystemBandwidthLimit返回参数结构体
1008
+ */
1009
+ export interface UpdateFileSystemBandwidthLimitResponse {
1010
+ /**
1011
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1012
+ */
1013
+ RequestId?: string
1014
+ }
1015
+
1006
1016
  /**
1007
1017
  * DescribeSnapshotOperationLogs返回参数结构体
1008
1018
  */
@@ -1049,6 +1059,20 @@ export interface DeleteCfsFileSystemRequest {
1049
1059
  FileSystemId: string
1050
1060
  }
1051
1061
 
1062
+ /**
1063
+ * UpdateFileSystemBandwidthLimit请求参数结构体
1064
+ */
1065
+ export interface UpdateFileSystemBandwidthLimitRequest {
1066
+ /**
1067
+ * 文件系统 ID
1068
+ */
1069
+ FileSystemId: string
1070
+ /**
1071
+ * 文件系统带宽,仅吞吐型可填。单位MiB/s,最小为1GiB/s,最大200GiB/s。
1072
+ */
1073
+ BandwidthLimit: number
1074
+ }
1075
+
1052
1076
  /**
1053
1077
  * CreateCfsPGroup返回参数结构体
1054
1078
  */
@@ -677,47 +677,47 @@ export interface SearchCommandResult {
677
677
  /**
678
678
  * 命令输入的时间
679
679
  */
680
- Time: string
680
+ Time?: string
681
681
  /**
682
682
  * 用户名
683
683
  */
684
- UserName: string
684
+ UserName?: string
685
685
  /**
686
686
  * 姓名
687
687
  */
688
- RealName: string
688
+ RealName?: string
689
689
  /**
690
690
  * 资产ID
691
691
  */
692
- InstanceId: string
692
+ InstanceId?: string
693
693
  /**
694
694
  * 资产名称
695
695
  */
696
- DeviceName: string
696
+ DeviceName?: string
697
697
  /**
698
698
  * 资产公网IP
699
699
  */
700
- PublicIp: string
700
+ PublicIp?: string
701
701
  /**
702
702
  * 资产内网IP
703
703
  */
704
- PrivateIp: string
704
+ PrivateIp?: string
705
705
  /**
706
706
  * 命令
707
707
  */
708
- Cmd: string
708
+ Cmd?: string
709
709
  /**
710
710
  * 命令执行情况,1--允许,2--拒绝
711
711
  */
712
- Action: number
712
+ Action?: number
713
713
  /**
714
714
  * 命令所属的会话ID
715
715
  */
716
- Sid: string
716
+ Sid?: string
717
717
  /**
718
718
  * 命令执行时间相对于所属会话开始时间的偏移量,单位ms
719
719
  */
720
- TimeOffset: number
720
+ TimeOffset?: number
721
721
  /**
722
722
  * 账号
723
723
  注意:此字段可能返回 null,表示取不到有效值。
@@ -732,6 +732,12 @@ export interface SearchCommandResult {
732
732
  * 该命令所属会话的会话开始时间
733
733
  注意:此字段可能返回 null,表示取不到有效值。
734
734
  */
735
+ SessionTime?: string
736
+ /**
737
+ * 该命令所属会话的会话开始时间(废弃,使用SessionTime)
738
+ 注意:此字段可能返回 null,表示取不到有效值。
739
+ * @deprecated
740
+ */
735
741
  SessTime?: string
736
742
  /**
737
743
  * 复核时间
@@ -1283,19 +1289,19 @@ export interface Command {
1283
1289
  /**
1284
1290
  * 命令
1285
1291
  */
1286
- Cmd: string
1292
+ Cmd?: string
1287
1293
  /**
1288
1294
  * 命令输入的时间
1289
1295
  */
1290
- Time: string
1296
+ Time?: string
1291
1297
  /**
1292
1298
  * 命令执行时间相对于所属会话开始时间的偏移量,单位ms
1293
1299
  */
1294
- TimeOffset: number
1300
+ TimeOffset?: number
1295
1301
  /**
1296
1302
  * 命令执行情况,1--允许,2--拒绝,3--确认
1297
1303
  */
1298
- Action: number
1304
+ Action?: number
1299
1305
  /**
1300
1306
  * 会话id
1301
1307
  注意:此字段可能返回 null,表示取不到有效值。
@@ -1325,6 +1331,12 @@ export interface Command {
1325
1331
  * 该命令所属会话的会话开始时间
1326
1332
  注意:此字段可能返回 null,表示取不到有效值。
1327
1333
  */
1334
+ SessionTime?: string
1335
+ /**
1336
+ * 该命令所属会话的会话开始时间
1337
+ 注意:此字段可能返回 null,表示取不到有效值。
1338
+ * @deprecated
1339
+ */
1328
1340
  SessTime?: string
1329
1341
  /**
1330
1342
  * 复核时间
@@ -1499,6 +1511,11 @@ export interface SearchAuditLogRequest {
1499
1511
  * CreateResource返回参数结构体
1500
1512
  */
1501
1513
  export interface CreateResourceResponse {
1514
+ /**
1515
+ * 实例Id
1516
+ 注意:此字段可能返回 null,表示取不到有效值。
1517
+ */
1518
+ ResourceId?: string
1502
1519
  /**
1503
1520
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1504
1521
  */
@@ -1969,6 +1986,11 @@ export interface DescribeUserGroupMembersResponse {
1969
1986
  * ImportExternalDevice返回参数结构体
1970
1987
  */
1971
1988
  export interface ImportExternalDeviceResponse {
1989
+ /**
1990
+ * 资产ID列表
1991
+ 注意:此字段可能返回 null,表示取不到有效值。
1992
+ */
1993
+ DeviceIdSet?: Array<number | bigint>
1972
1994
  /**
1973
1995
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1974
1996
  */
@@ -791,91 +791,91 @@ export interface DomainListItem {
791
791
  /**
792
792
  * 系统分配给域名的唯一标识
793
793
  */
794
- DomainId: number
794
+ DomainId?: number
795
795
  /**
796
796
  * 域名的原始格式
797
797
  */
798
- Name: string
798
+ Name?: string
799
799
  /**
800
800
  * 域名的状态,正常:ENABLE,暂停:PAUSE,封禁:SPAM
801
801
  */
802
- Status: string
802
+ Status?: string
803
803
  /**
804
804
  * 域名默认的解析记录默认TTL值
805
805
  */
806
- TTL: number
806
+ TTL?: number
807
807
  /**
808
808
  * 是否开启CNAME加速,开启:ENABLE,未开启:DISABLE
809
809
  */
810
- CNAMESpeedup: string
810
+ CNAMESpeedup?: string
811
811
  /**
812
812
  * DNS 设置状态,错误:DNSERROR,正常:空字符串
813
813
  */
814
- DNSStatus: string
814
+ DNSStatus?: string
815
815
  /**
816
816
  * 域名的套餐等级代码
817
817
  */
818
- Grade: string
818
+ Grade?: string
819
819
  /**
820
820
  * 域名所属的分组Id
821
821
  */
822
- GroupId: number
822
+ GroupId?: number
823
823
  /**
824
824
  * 是否开启搜索引擎推送优化,是:YES,否:NO
825
825
  */
826
- SearchEnginePush: string
826
+ SearchEnginePush?: string
827
827
  /**
828
828
  * 域名备注说明
829
829
  */
830
- Remark: string
830
+ Remark?: string
831
831
  /**
832
832
  * 经过punycode编码后的域名格式
833
833
  */
834
- Punycode: string
834
+ Punycode?: string
835
835
  /**
836
836
  * 系统为域名分配的有效DNS
837
837
  */
838
- EffectiveDNS: Array<string>
838
+ EffectiveDNS?: Array<string>
839
839
  /**
840
840
  * 域名套餐等级对应的序号
841
841
  */
842
- GradeLevel: number
842
+ GradeLevel?: number
843
843
  /**
844
844
  * 套餐名称
845
845
  */
846
- GradeTitle: string
846
+ GradeTitle?: string
847
847
  /**
848
848
  * 是否是付费套餐
849
849
  */
850
- IsVip: string
850
+ IsVip?: string
851
851
  /**
852
852
  * 付费套餐开通时间
853
853
  */
854
- VipStartAt: string
854
+ VipStartAt?: string
855
855
  /**
856
856
  * 付费套餐到期时间
857
857
  */
858
- VipEndAt: string
858
+ VipEndAt?: string
859
859
  /**
860
860
  * 域名是否开通VIP自动续费,是:YES,否:NO,默认:DEFAULT
861
861
  */
862
- VipAutoRenew: string
862
+ VipAutoRenew?: string
863
863
  /**
864
864
  * 域名下的记录数量
865
865
  */
866
- RecordCount: number
866
+ RecordCount?: number
867
867
  /**
868
868
  * 域名添加时间
869
869
  */
870
- CreatedOn: string
870
+ CreatedOn?: string
871
871
  /**
872
872
  * 域名更新时间
873
873
  */
874
- UpdatedOn: string
874
+ UpdatedOn?: string
875
875
  /**
876
876
  * 域名所属账号
877
877
  */
878
- Owner: string
878
+ Owner?: string
879
879
  /**
880
880
  * 域名关联的标签列表
881
881
  注意:此字段可能返回 null,表示取不到有效值。
@@ -1,7 +1,7 @@
1
- import { v20211206 } from "./v20211206"
2
1
  import { v20180330 } from "./v20180330"
2
+ import { v20211206 } from "./v20211206"
3
3
 
4
4
  export const dts = {
5
- v20211206: v20211206,
6
5
  v20180330: v20180330,
6
+ v20211206: v20211206,
7
7
  }
@@ -930,7 +930,7 @@ export interface CompareObject {
930
930
  */
931
931
  ObjectItems?: Array<CompareObjectItem>
932
932
  /**
933
- * 高级对象类型,如account(账号),index(索引),shardkey(片建,后面可能会调整),schema(库表结构)
933
+ * 高级对象类型,如account(账号),index(索引),shardkey(片键,后面可能会调整),schema(库表结构)
934
934
  注意:此字段可能返回 null,表示取不到有效值。
935
935
  */
936
936
  AdvancedObjects?: Array<string>
@@ -1,7 +1,7 @@
1
- import { v20210601 } from "./v20210601"
2
1
  import { v20200715 } from "./v20200715"
2
+ import { v20210601 } from "./v20210601"
3
3
 
4
4
  export const eis = {
5
- v20210601: v20210601,
6
5
  v20200715: v20200715,
6
+ v20210601: v20210601,
7
7
  }
@@ -304,20 +304,23 @@ export class Client extends AbstractClient {
304
304
 
305
305
  /**
306
306
  * 此接口(DescribeFlowTemplates)用于查询本企业模板列表信息。
307
- > 一个模板通常会包含以下结构信息
308
- >- 模板基本信息
309
- >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
310
- >- 填写控件 Components
311
- >- 签署控件 SignComponents
312
- >- 生成模板的文件基础信息 FileInfos
313
307
 
314
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
315
-
316
- 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
317
308
 
318
- 适用场景:
309
+ **适用场景**
319
310
  该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口,作为创建电子文档的前置接口使用。
320
311
  通过此接口查询到模板信息后,再通过调用创建电子文档接口,指定模板ID,指定模板中需要的填写控件内容等,完成电子文档的创建。
312
+
313
+ **一个模板通常会包含以下结构信息**
314
+
315
+ - 模板模版ID, 模板名字等基本信息
316
+ - 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
317
+ - 发起方和签署方的填写控件 Components
318
+ - 签署方的签署控件 SignComponents
319
+
320
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
321
+
322
+ 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
323
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
321
324
  */
322
325
  async DescribeFlowTemplates(
323
326
  req: DescribeFlowTemplatesRequest,
@@ -763,10 +766,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
763
766
  }
764
767
 
765
768
  /**
766
- * 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
767
-
768
- 注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`
769
- */
769
+ * 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
770
+ */
770
771
  async DescribeIntegrationRoles(
771
772
  req: DescribeIntegrationRolesRequest,
772
773
  cb?: (error: string, rep: DescribeIntegrationRolesResponse) => void
@@ -1124,7 +1125,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1124
1125
  }
1125
1126
 
1126
1127
  /**
1127
- * 查询企业使用情况
1128
+ * 通过此接口(DescribeBillUsageDetail)查询该企业的套餐消耗详情。
1128
1129
  */
1129
1130
  async DescribeBillUsageDetail(
1130
1131
  req: DescribeBillUsageDetailRequest,
@@ -41,7 +41,8 @@ export interface BillUsageDetail {
41
41
  */
42
42
  FlowId?: string
43
43
  /**
44
- * 经办人名称
44
+ * 合同经办人名称
45
+ 如果有多个经办人用分号隔开。
45
46
  注意:此字段可能返回 null,表示取不到有效值。
46
47
  */
47
48
  OperatorName?: string
@@ -57,12 +58,39 @@ export interface BillUsageDetail {
57
58
  */
58
59
  FlowName?: string
59
60
  /**
60
- * 0 还没有发起 1等待签署 2部分签署 3拒签 4已签署 5已过期 6已撤销 7还没有预发起 8等待填写 9部分填写 10拒填 11已解除
61
+ * 当前合同状态,如下是状态码对应的状态。
62
+ 0-还没有发起
63
+ 1-等待签署
64
+ 2-部分签署
65
+ 3-拒签
66
+ 4-已签署
67
+ 5-已过期
68
+ 6-已撤销
69
+ 7-还没有预发起
70
+ 8-等待填写
71
+ 9-部分填写
72
+ 10-拒填
73
+ 11-已解除
61
74
  注意:此字段可能返回 null,表示取不到有效值。
62
75
  */
63
76
  Status?: number
64
77
  /**
65
78
  * 套餐类型
79
+ 对应关系如下
80
+ CloudEnterprise-企业版合同
81
+ SingleSignature-单方签章
82
+ CloudProve-签署报告
83
+ CloudOnlineSign-腾讯会议在线签约
84
+ ChannelWeCard-微工卡
85
+ SignFlow-合同套餐
86
+ SignFace-签署意愿(人脸识别)
87
+ SignPassword-签署意愿(密码)
88
+ SignSMS-签署意愿(短信)
89
+ PersonalEssAuth-签署人实名(腾讯电子签认证)
90
+ PersonalThirdAuth-签署人实名(信任第三方认证)
91
+ OrgEssAuth-签署企业实名
92
+ FlowNotify-短信通知
93
+ AuthService-企业工商信息查询
66
94
  注意:此字段可能返回 null,表示取不到有效值。
67
95
  */
68
96
  QuotaType?: string
@@ -72,17 +100,18 @@ export interface BillUsageDetail {
72
100
  */
73
101
  UseCount?: number
74
102
  /**
75
- * 消耗的时间戳
103
+ * 消耗的时间戳,格式为Unix标准时间戳(秒)。
76
104
  注意:此字段可能返回 null,表示取不到有效值。
77
105
  */
78
106
  CostTime?: number
79
107
  /**
80
- * 套餐名称
108
+ * 消耗的套餐名称
81
109
  注意:此字段可能返回 null,表示取不到有效值。
82
110
  */
83
111
  QuotaName?: string
84
112
  /**
85
- * 消耗类型 1.扣费 2.撤销返还
113
+ * 消耗类型
114
+ 1.扣费 2.撤销返还
86
115
  注意:此字段可能返回 null,表示取不到有效值。
87
116
  */
88
117
  CostType?: number
@@ -5202,6 +5231,10 @@ export interface CreatePrepareFlowResponse {
5202
5231
  * 发起流程的web页面链接,有效期5分钟
5203
5232
  */
5204
5233
  Url?: string
5234
+ /**
5235
+ * 创建的合同id(还未实际发起),每次调用会生成新的id,用户可以记录此字段对应后续页面发起的合同,若在页面上未成功发起,则此字段无效。
5236
+ */
5237
+ FlowId?: string
5205
5238
  /**
5206
5239
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5207
5240
  */
@@ -6398,17 +6431,17 @@ export interface DeleteStaffsResult {
6398
6431
  */
6399
6432
  export interface DescribeBillUsageDetailRequest {
6400
6433
  /**
6401
- * 查询开始时间,时间跨度不能大于31天
6434
+ * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
6402
6435
  */
6403
6436
  StartTime: string
6404
6437
  /**
6405
- * 查询结束时间,时间跨度不能大于31天
6438
+ * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
6406
6439
  */
6407
6440
  EndTime: string
6408
6441
  /**
6409
6442
  * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
6410
6443
  */
6411
- Offset: number
6444
+ Offset?: number
6412
6445
  /**
6413
6446
  * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
6414
6447
  */
@@ -6433,8 +6466,8 @@ AuthService-企业工商信息查询
6433
6466
  */
6434
6467
  QuotaType?: string
6435
6468
  /**
6436
- * 非必填,查询某个渠道企业的消耗情况。
6437
- 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6469
+ * 代理企业和员工的信息。
6470
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6438
6471
  */
6439
6472
  Agent?: Agent
6440
6473
  }
@@ -19,6 +19,7 @@ import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
21
  SyncProxyOrganizationResponse,
22
+ BillUsageDetail,
22
23
  ChannelCreateConvertTaskApiResponse,
23
24
  ChannelCreateFlowRemindsResponse,
24
25
  Component,
@@ -83,6 +84,7 @@ import {
83
84
  CreateChannelFlowEvidenceReportRequest,
84
85
  ChannelCancelUserAutoSignEnableUrlRequest,
85
86
  Permission,
87
+ DescribeTemplatesRequest,
86
88
  Staff,
87
89
  ComponentLimit,
88
90
  ChannelVerifyPdfResponse,
@@ -115,6 +117,7 @@ import {
115
117
  ChannelDeleteRoleUsersResponse,
116
118
  SyncProxyOrganizationOperatorsRequest,
117
119
  ChannelCreateFlowApproversResponse,
120
+ DescribeBillUsageDetailResponse,
118
121
  CreateSignUrlsRequest,
119
122
  ChannelCreateMultiFlowSignQRCodeRequest,
120
123
  SignQrCode,
@@ -173,7 +176,7 @@ import {
173
176
  ChannelCreateFlowGroupByTemplatesRequest,
174
177
  SignUrl,
175
178
  ChannelCancelFlowRequest,
176
- DescribeTemplatesRequest,
179
+ DescribeBillUsageDetailRequest,
177
180
  RelieveInfo,
178
181
  ChannelCreateSealPolicyRequest,
179
182
  OccupiedSeal,
@@ -479,12 +482,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
479
482
  }
480
483
 
481
484
  /**
482
- * 通过此接口,创建小程序批量签署链接,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
485
+ * 通过此接口,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
483
486
 
484
487
  注:
485
488
  - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
486
489
  - 仅支持传入待签署或者待领取的合同,待填写暂不支持。
487
- - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章,暂不支持签批控件
490
+ - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
488
491
  */
489
492
  async ChannelCreateOrganizationBatchSignUrl(
490
493
  req: ChannelCreateOrganizationBatchSignUrlRequest,
@@ -623,6 +626,15 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
623
626
  /**
624
627
  * 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
625
628
 
629
+ **适用场景**
630
+ 该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
631
+ 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
632
+
633
+ **模版的来源**
634
+ 子客企业的模板有两种途径获取
635
+ - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
636
+ - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
637
+
626
638
  **一个模板通常会包含以下结构信息**
627
639
 
628
640
  - 模板模版ID, 模板名字等基本信息
@@ -632,14 +644,8 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
632
644
 
633
645
  ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
634
646
 
635
- **适用场景**
636
- 该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
637
- 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
638
-
639
- **模版的来源**
640
- 子客企业的模板有两种途径获取
641
- - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
642
- - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
647
+ 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
648
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
643
649
 
644
650
 
645
651
  **注意**
@@ -715,6 +721,9 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
715
721
 
716
722
  1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。
717
723
  2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
724
+
725
+ 系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
726
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
718
727
  */
719
728
  async CreateConsoleLoginUrl(
720
729
  req: CreateConsoleLoginUrlRequest,
@@ -1031,10 +1040,10 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1031
1040
  **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
1032
1041
  授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
1033
1042
 
1034
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows2.png)
1043
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
1035
1044
 
1036
1045
  **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
1037
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows_appilications2.png)
1046
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
1038
1047
  */
1039
1048
  async DescribeResourceUrlsByFlows(
1040
1049
  req: DescribeResourceUrlsByFlowsRequest,
@@ -1086,12 +1095,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1086
1095
  }
1087
1096
 
1088
1097
  /**
1089
- * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
1098
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办
1099
+ 1. 合同中当前状态为 **待签署** 的签署人是催办的对象
1100
+ 2. **每个合同只能催办一次**
1101
+
1102
+ **催办的效果**: 对方会受到如下的短信通知
1103
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
1090
1104
 
1091
- 1. 合同中当前状态为“待签署”的签署人是催办的对象
1092
- 2. 每个合同只能催办一次
1093
1105
 
1094
- 注意:该接口无法直接调用,请联系客户经理申请使用。
1106
+ **注**:`合同催办是白名单功能,请联系客户经理申请开白后使用`
1095
1107
  */
1096
1108
  async ChannelCreateFlowReminds(
1097
1109
  req: ChannelCreateFlowRemindsRequest,
@@ -1308,6 +1320,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1308
1320
  return this.request("ChannelCreatePreparedPersonalEsign", req, cb)
1309
1321
  }
1310
1322
 
1323
+ /**
1324
+ * 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1325
+ */
1326
+ async DescribeBillUsageDetail(
1327
+ req: DescribeBillUsageDetailRequest,
1328
+ cb?: (error: string, rep: DescribeBillUsageDetailResponse) => void
1329
+ ): Promise<DescribeBillUsageDetailResponse> {
1330
+ return this.request("DescribeBillUsageDetail", req, cb)
1331
+ }
1332
+
1311
1333
  /**
1312
1334
  * 接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。
1313
1335