tencentcloud-sdk-nodejs 4.0.681 → 4.0.683
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 +407 -0
- package/SERVICE_CHANGELOG.md +553 -81
- package/package.json +1 -1
- package/products.md +38 -38
- package/src/common/sdk_version.ts +1 -1
- package/src/services/ams/index.ts +2 -2
- package/src/services/batch/v20170312/batch_models.ts +22 -22
- package/src/services/bma/index.ts +2 -2
- package/src/services/btoe/index.ts +2 -2
- package/src/services/cbs/v20170312/cbs_client.ts +2 -2
- package/src/services/ccc/v20200210/ccc_client.ts +2 -1
- package/src/services/ccc/v20200210/ccc_models.ts +21 -2
- package/src/services/cdwch/v20200915/cdwch_client.ts +5 -3
- package/src/services/cdwch/v20200915/cdwch_models.ts +79 -20
- package/src/services/cii/index.ts +2 -2
- package/src/services/ckafka/v20190819/ckafka_models.ts +4 -4
- package/src/services/clb/v20180317/clb_models.ts +88 -68
- package/src/services/cloudstudio/index.ts +2 -2
- package/src/services/cls/v20201016/cls_models.ts +31 -21
- package/src/services/cvm/v20170312/cvm_client.ts +1 -0
- package/src/services/cvm/v20170312/cvm_models.ts +23 -27
- package/src/services/cynosdb/v20190107/cynosdb_models.ts +10 -7
- package/src/services/dnspod/v20210323/dnspod_models.ts +11 -11
- package/src/services/dts/index.ts +2 -2
- package/src/services/ecm/v20190719/ecm_models.ts +4 -0
- package/src/services/ess/v20201111/ess_client.ts +52 -30
- package/src/services/ess/v20201111/ess_models.ts +224 -150
- package/src/services/essbasic/index.ts +2 -2
- package/src/services/essbasic/v20210526/essbasic_client.ts +7 -0
- package/src/services/essbasic/v20210526/essbasic_models.ts +34 -27
- package/src/services/faceid/v20180301/faceid_models.ts +14 -9
- package/src/services/iai/index.ts +2 -2
- package/src/services/iai/v20180301/iai_models.ts +8 -12
- package/src/services/iai/v20200303/iai_models.ts +8 -12
- package/src/services/ims/index.ts +2 -2
- package/src/services/iotcloud/index.ts +2 -2
- package/src/services/iotvideo/index.ts +4 -4
- package/src/services/lcic/v20220817/lcic_models.ts +26 -0
- package/src/services/mgobe/index.ts +2 -2
- package/src/services/monitor/v20180724/monitor_client.ts +15 -2
- package/src/services/monitor/v20180724/monitor_models.ts +107 -49
- package/src/services/mrs/v20200910/mrs_models.ts +48 -25
- package/src/services/oceanus/v20190422/oceanus_models.ts +7 -1
- package/src/services/ses/v20201002/ses_models.ts +1 -1
- package/src/services/sqlserver/v20180328/sqlserver_client.ts +2 -3
- package/src/services/sqlserver/v20180328/sqlserver_models.ts +3 -3
- package/src/services/ssl/v20191205/ssl_client.ts +64 -6
- package/src/services/ssl/v20191205/ssl_models.ts +564 -0
- package/src/services/tdmq/v20200217/tdmq_client.ts +29 -3
- package/src/services/tdmq/v20200217/tdmq_models.ts +251 -29
- package/src/services/tem/index.ts +2 -2
- package/src/services/teo/v20220901/teo_client.ts +12 -0
- package/src/services/teo/v20220901/teo_models.ts +34 -0
- package/src/services/thpc/index.ts +4 -4
- package/src/services/thpc/v20230321/thpc_models.ts +17 -0
- package/src/services/tione/index.ts +2 -2
- package/src/services/tione/v20211111/tione_models.ts +48 -5
- package/src/services/tms/index.ts +2 -2
- package/src/services/trtc/v20190722/trtc_models.ts +5 -2
- package/src/services/tse/v20201207/tse_models.ts +5 -0
- package/src/services/tsf/v20180326/tsf_models.ts +4 -3
- package/src/services/tsw/index.ts +2 -2
- package/src/services/vm/index.ts +2 -2
- package/src/services/waf/v20180125/waf_client.ts +12 -0
- package/src/services/waf/v20180125/waf_models.ts +28 -0
- package/src/services/yunsou/index.ts +2 -2
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/ams/index.d.ts +4 -4
- package/tencentcloud/services/ams/index.js +2 -2
- package/tencentcloud/services/batch/v20170312/batch_models.d.ts +22 -22
- package/tencentcloud/services/bma/index.d.ts +4 -4
- package/tencentcloud/services/bma/index.js +2 -2
- package/tencentcloud/services/btoe/index.d.ts +4 -4
- package/tencentcloud/services/btoe/index.js +2 -2
- package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +2 -2
- package/tencentcloud/services/cbs/v20170312/cbs_client.js +2 -2
- package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -1
- package/tencentcloud/services/ccc/v20200210/ccc_client.js +1 -1
- package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -2
- package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts +2 -2
- package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +77 -20
- package/tencentcloud/services/cii/index.d.ts +4 -4
- package/tencentcloud/services/cii/index.js +2 -2
- package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +4 -4
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +88 -68
- package/tencentcloud/services/cloudstudio/index.d.ts +4 -4
- package/tencentcloud/services/cloudstudio/index.js +2 -2
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +31 -21
- package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +1 -0
- package/tencentcloud/services/cvm/v20170312/cvm_client.js +1 -0
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +23 -27
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +10 -7
- package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +11 -11
- package/tencentcloud/services/dts/index.d.ts +4 -4
- package/tencentcloud/services/dts/index.js +2 -2
- package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +4 -0
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +46 -24
- package/tencentcloud/services/ess/v20201111/ess_client.js +46 -24
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +224 -150
- package/tencentcloud/services/essbasic/index.d.ts +4 -4
- package/tencentcloud/services/essbasic/index.js +2 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +7 -0
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +7 -0
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +34 -27
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +14 -9
- package/tencentcloud/services/iai/index.d.ts +4 -4
- package/tencentcloud/services/iai/index.js +2 -2
- package/tencentcloud/services/iai/v20180301/iai_models.d.ts +8 -12
- package/tencentcloud/services/iai/v20200303/iai_models.d.ts +8 -12
- package/tencentcloud/services/ims/index.d.ts +4 -4
- package/tencentcloud/services/ims/index.js +2 -2
- package/tencentcloud/services/iotcloud/index.d.ts +4 -4
- package/tencentcloud/services/iotcloud/index.js +2 -2
- package/tencentcloud/services/iotvideo/index.d.ts +6 -6
- package/tencentcloud/services/iotvideo/index.js +4 -4
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +26 -0
- package/tencentcloud/services/mgobe/index.d.ts +4 -4
- package/tencentcloud/services/mgobe/index.js +2 -2
- package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +5 -1
- package/tencentcloud/services/monitor/v20180724/monitor_client.js +6 -0
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +104 -49
- package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +48 -25
- package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +7 -1
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +1 -1
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +0 -1
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +0 -1
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +3 -3
- package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +15 -3
- package/tencentcloud/services/ssl/v20191205/ssl_client.js +21 -3
- package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +536 -0
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +9 -1
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +12 -0
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +245 -29
- package/tencentcloud/services/tem/index.d.ts +4 -4
- package/tencentcloud/services/tem/index.js +2 -2
- package/tencentcloud/services/teo/v20220901/teo_client.d.ts +5 -1
- package/tencentcloud/services/teo/v20220901/teo_client.js +6 -0
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +32 -0
- package/tencentcloud/services/thpc/index.d.ts +6 -6
- package/tencentcloud/services/thpc/index.js +4 -4
- package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +17 -0
- package/tencentcloud/services/tione/index.d.ts +4 -4
- package/tencentcloud/services/tione/index.js +2 -2
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +48 -5
- package/tencentcloud/services/tms/index.d.ts +4 -4
- package/tencentcloud/services/tms/index.js +2 -2
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +5 -2
- package/tencentcloud/services/tse/v20201207/tse_models.d.ts +5 -0
- package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +4 -3
- package/tencentcloud/services/tsw/index.d.ts +4 -4
- package/tencentcloud/services/tsw/index.js +2 -2
- package/tencentcloud/services/vm/index.d.ts +4 -4
- package/tencentcloud/services/vm/index.js +2 -2
- package/tencentcloud/services/waf/v20180125/waf_client.d.ts +5 -1
- package/tencentcloud/services/waf/v20180125/waf_client.js +6 -0
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +26 -0
- package/tencentcloud/services/yunsou/index.d.ts +4 -4
- package/tencentcloud/services/yunsou/index.js +2 -2
- package/test/monitor.v20180724.test.js +10 -0
- package/test/ssl.v20191205.test.js +32 -2
- package/test/tdmq.v20200217.test.js +20 -0
- package/test/teo.v20220901.test.js +10 -0
- package/test/waf.v20180125.test.js +10 -0
|
@@ -1638,7 +1638,7 @@ export interface ModifyInstancesAttributeRequest {
|
|
|
1638
1638
|
*/
|
|
1639
1639
|
CamRoleName?: string;
|
|
1640
1640
|
/**
|
|
1641
|
-
* 实例的主机名。<br><li>点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。<br><li>Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。<br><li>其他类型(Linux 等)实例:主机名字符长度为[2, 60]
|
|
1641
|
+
* 实例的主机名。<br><li>点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。<br><li>Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。<br><li>其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。<br> 注意点:修改主机名后实例会立即重启,重启后新的主机名生效。
|
|
1642
1642
|
*/
|
|
1643
1643
|
HostName?: string;
|
|
1644
1644
|
/**
|
|
@@ -1790,10 +1790,6 @@ export interface Placement {
|
|
|
1790
1790
|
* 实例所属的专用宿主机ID列表,仅用于入参。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。
|
|
1791
1791
|
*/
|
|
1792
1792
|
HostIds?: Array<string>;
|
|
1793
|
-
/**
|
|
1794
|
-
* 指定母机IP生产子机
|
|
1795
|
-
*/
|
|
1796
|
-
HostIps?: Array<string>;
|
|
1797
1793
|
/**
|
|
1798
1794
|
* 实例所属的专用宿主机ID,仅用于出参。
|
|
1799
1795
|
*/
|
|
@@ -4306,93 +4302,93 @@ export interface InstanceTypeQuotaItem {
|
|
|
4306
4302
|
/**
|
|
4307
4303
|
* 可用区。
|
|
4308
4304
|
*/
|
|
4309
|
-
Zone
|
|
4305
|
+
Zone?: string;
|
|
4310
4306
|
/**
|
|
4311
4307
|
* 实例机型。
|
|
4312
4308
|
*/
|
|
4313
|
-
InstanceType
|
|
4309
|
+
InstanceType?: string;
|
|
4314
4310
|
/**
|
|
4315
4311
|
* 实例计费模式。取值范围: <br><li>PREPAID:表示预付费,即包年包月<br><li>POSTPAID_BY_HOUR:表示后付费,即按量计费<br><li>CDHPAID:表示[专用宿主机](https://cloud.tencent.com/document/product/416)付费,即只对`专用宿主机`计费,不对`专用宿主机`上的实例计费。<br><li>`SPOTPAID`:表示竞价实例付费。
|
|
4316
4312
|
*/
|
|
4317
|
-
InstanceChargeType
|
|
4313
|
+
InstanceChargeType?: string;
|
|
4318
4314
|
/**
|
|
4319
4315
|
* 网卡类型,例如:25代表25G网卡
|
|
4320
4316
|
*/
|
|
4321
|
-
NetworkCard
|
|
4317
|
+
NetworkCard?: number;
|
|
4322
4318
|
/**
|
|
4323
4319
|
* 扩展属性。
|
|
4324
4320
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4325
4321
|
*/
|
|
4326
|
-
Externals
|
|
4322
|
+
Externals?: Externals;
|
|
4327
4323
|
/**
|
|
4328
4324
|
* 实例的CPU核数,单位:核。
|
|
4329
4325
|
*/
|
|
4330
|
-
Cpu
|
|
4326
|
+
Cpu?: number;
|
|
4331
4327
|
/**
|
|
4332
4328
|
* 实例内存容量,单位:`GB`。
|
|
4333
4329
|
*/
|
|
4334
|
-
Memory
|
|
4330
|
+
Memory?: number;
|
|
4335
4331
|
/**
|
|
4336
4332
|
* 实例机型系列。
|
|
4337
4333
|
*/
|
|
4338
|
-
InstanceFamily
|
|
4334
|
+
InstanceFamily?: string;
|
|
4339
4335
|
/**
|
|
4340
4336
|
* 机型名称。
|
|
4341
4337
|
*/
|
|
4342
|
-
TypeName
|
|
4338
|
+
TypeName?: string;
|
|
4343
4339
|
/**
|
|
4344
4340
|
* 本地磁盘规格列表。当该参数返回为空值时,表示当前情况下无法创建本地盘。
|
|
4345
4341
|
*/
|
|
4346
|
-
LocalDiskTypeList
|
|
4342
|
+
LocalDiskTypeList?: Array<LocalDiskType>;
|
|
4347
4343
|
/**
|
|
4348
4344
|
* 实例是否售卖。取值范围: <br><li>SELL:表示实例可购买<br><li>SOLD_OUT:表示实例已售罄。
|
|
4349
4345
|
*/
|
|
4350
|
-
Status
|
|
4346
|
+
Status?: string;
|
|
4351
4347
|
/**
|
|
4352
4348
|
* 实例的售卖价格。
|
|
4353
4349
|
*/
|
|
4354
|
-
Price
|
|
4350
|
+
Price?: ItemPrice;
|
|
4355
4351
|
/**
|
|
4356
4352
|
* 售罄原因。
|
|
4357
4353
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4358
4354
|
*/
|
|
4359
|
-
SoldOutReason
|
|
4355
|
+
SoldOutReason?: string;
|
|
4360
4356
|
/**
|
|
4361
4357
|
* 内网带宽,单位Gbps。
|
|
4362
4358
|
*/
|
|
4363
|
-
InstanceBandwidth
|
|
4359
|
+
InstanceBandwidth?: number;
|
|
4364
4360
|
/**
|
|
4365
4361
|
* 网络收发包能力,单位万PPS。
|
|
4366
4362
|
*/
|
|
4367
|
-
InstancePps
|
|
4363
|
+
InstancePps?: number;
|
|
4368
4364
|
/**
|
|
4369
4365
|
* 本地存储块数量。
|
|
4370
4366
|
*/
|
|
4371
|
-
StorageBlockAmount
|
|
4367
|
+
StorageBlockAmount?: number;
|
|
4372
4368
|
/**
|
|
4373
4369
|
* 处理器型号。
|
|
4374
4370
|
*/
|
|
4375
|
-
CpuType
|
|
4371
|
+
CpuType?: string;
|
|
4376
4372
|
/**
|
|
4377
4373
|
* 实例的GPU数量。
|
|
4378
4374
|
*/
|
|
4379
|
-
Gpu
|
|
4375
|
+
Gpu?: number;
|
|
4380
4376
|
/**
|
|
4381
4377
|
* 实例的FPGA数量。
|
|
4382
4378
|
*/
|
|
4383
|
-
Fpga
|
|
4379
|
+
Fpga?: number;
|
|
4384
4380
|
/**
|
|
4385
4381
|
* 实例备注信息。
|
|
4386
4382
|
*/
|
|
4387
|
-
Remark
|
|
4383
|
+
Remark?: string;
|
|
4388
4384
|
/**
|
|
4389
4385
|
* 实例机型映射的物理GPU卡数,单位:卡。vGPU卡型小于1,直通卡型大于等于1。vGPU是通过分片虚拟化技术,将物理GPU卡重新划分,同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。
|
|
4390
4386
|
*/
|
|
4391
|
-
GpuCount
|
|
4387
|
+
GpuCount?: number;
|
|
4392
4388
|
/**
|
|
4393
4389
|
* 实例的CPU主频信息
|
|
4394
4390
|
*/
|
|
4395
|
-
Frequency
|
|
4391
|
+
Frequency?: string;
|
|
4396
4392
|
}
|
|
4397
4393
|
/**
|
|
4398
4394
|
* InquiryPriceTerminateInstances请求参数结构体
|
|
@@ -155,7 +155,7 @@ export interface InquirePriceRenewRequest {
|
|
|
155
155
|
*/
|
|
156
156
|
export interface DescribeAccountPrivilegesResponse {
|
|
157
157
|
/**
|
|
158
|
-
* 权限列表,示例值为:["select","update","delete","create","drop","references","index","alter","show_db","create_tmp_table","lock_tables","execute","create_view","show_view","create_routine","alter_routine","event","trigger"]
|
|
158
|
+
* 权限列表,示例值为:["","select","update","delete","create","drop","references","index","alter","show_db","create_tmp_table","lock_tables","execute","create_view","show_view","create_routine","alter_routine","event","trigger"]
|
|
159
159
|
*/
|
|
160
160
|
Privileges?: Array<string>;
|
|
161
161
|
/**
|
|
@@ -2563,7 +2563,7 @@ export interface ModifyInstanceParamRequest {
|
|
|
2563
2563
|
*/
|
|
2564
2564
|
InstanceIds?: Array<string>;
|
|
2565
2565
|
/**
|
|
2566
|
-
* 集群参数列表,例如 [{ "CurrentValue":"2", "ParamName":"
|
|
2566
|
+
* 集群参数列表,例如 [{ "CurrentValue":"2", "ParamName":"auto_increment_increment"}]
|
|
2567
2567
|
*/
|
|
2568
2568
|
ClusterParamList?: Array<ModifyParamItem>;
|
|
2569
2569
|
/**
|
|
@@ -3625,7 +3625,8 @@ export interface CreateClustersRequest {
|
|
|
3625
3625
|
*/
|
|
3626
3626
|
TimeUnit?: string;
|
|
3627
3627
|
/**
|
|
3628
|
-
* 包年包月购买是否自动续费,默认为0
|
|
3628
|
+
* 包年包月购买是否自动续费,默认为0。
|
|
3629
|
+
0标识默认续费方式,1表示自动续费,2表示手不自动续费。
|
|
3629
3630
|
*/
|
|
3630
3631
|
AutoRenewFlag?: number;
|
|
3631
3632
|
/**
|
|
@@ -4114,7 +4115,7 @@ export interface ModifyClusterParamResponse {
|
|
|
4114
4115
|
/**
|
|
4115
4116
|
* 异步请求Id,用于查询结果
|
|
4116
4117
|
*/
|
|
4117
|
-
AsyncRequestId
|
|
4118
|
+
AsyncRequestId?: string;
|
|
4118
4119
|
/**
|
|
4119
4120
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4120
4121
|
*/
|
|
@@ -4696,11 +4697,13 @@ export interface AssociateSecurityGroupsResponse {
|
|
|
4696
4697
|
*/
|
|
4697
4698
|
export interface DescribeResourcesByDealNameRequest {
|
|
4698
4699
|
/**
|
|
4699
|
-
* 计费订单ID(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName
|
|
4700
|
+
* 计费订单ID(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName接口直到成功)。
|
|
4701
|
+
DealName与DealNames至少应输入一项,两者都传时以DealName为准。
|
|
4700
4702
|
*/
|
|
4701
4703
|
DealName?: string;
|
|
4702
4704
|
/**
|
|
4703
|
-
* 计费订单ID列表,可以一次查询若干条订单ID对应资源信息(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName
|
|
4705
|
+
* 计费订单ID列表,可以一次查询若干条订单ID对应资源信息(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName接口直到成功)。
|
|
4706
|
+
DealName与DealNames至少应输入一项,两者都传时以DealName为准。
|
|
4704
4707
|
*/
|
|
4705
4708
|
DealNames?: Array<string>;
|
|
4706
4709
|
}
|
|
@@ -6473,7 +6476,7 @@ export interface AddInstancesRequest {
|
|
|
6473
6476
|
*/
|
|
6474
6477
|
Memory: number;
|
|
6475
6478
|
/**
|
|
6476
|
-
* 新增只读实例数,取值范围为
|
|
6479
|
+
* 新增只读实例数,取值范围为(0,15]
|
|
6477
6480
|
*/
|
|
6478
6481
|
ReadOnlyCount: number;
|
|
6479
6482
|
/**
|
|
@@ -3836,52 +3836,52 @@ export interface WhoisInfo {
|
|
|
3836
3836
|
* 联系信息
|
|
3837
3837
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3838
3838
|
*/
|
|
3839
|
-
Contacts
|
|
3839
|
+
Contacts?: WhoisContact;
|
|
3840
3840
|
/**
|
|
3841
3841
|
* 域名注册时间
|
|
3842
3842
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3843
3843
|
*/
|
|
3844
|
-
CreationDate
|
|
3844
|
+
CreationDate?: string;
|
|
3845
3845
|
/**
|
|
3846
3846
|
* 域名到期时间
|
|
3847
3847
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3848
3848
|
*/
|
|
3849
|
-
ExpirationDate
|
|
3849
|
+
ExpirationDate?: string;
|
|
3850
3850
|
/**
|
|
3851
3851
|
* 是否是在腾讯云注册的域名
|
|
3852
3852
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3853
3853
|
*/
|
|
3854
|
-
IsQcloud
|
|
3854
|
+
IsQcloud?: boolean;
|
|
3855
3855
|
/**
|
|
3856
|
-
*
|
|
3856
|
+
* 是否当前操作账号注册的域名
|
|
3857
3857
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3858
3858
|
*/
|
|
3859
|
-
IsQcloudOwner
|
|
3859
|
+
IsQcloudOwner?: boolean;
|
|
3860
3860
|
/**
|
|
3861
3861
|
* 域名配置的NS
|
|
3862
3862
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3863
3863
|
*/
|
|
3864
|
-
NameServers
|
|
3864
|
+
NameServers?: Array<string>;
|
|
3865
3865
|
/**
|
|
3866
3866
|
* Whois原始信息
|
|
3867
3867
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3868
3868
|
*/
|
|
3869
|
-
Raw
|
|
3869
|
+
Raw?: Array<string>;
|
|
3870
3870
|
/**
|
|
3871
3871
|
* 域名注册商
|
|
3872
3872
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3873
3873
|
*/
|
|
3874
|
-
Registrar
|
|
3874
|
+
Registrar?: Array<string>;
|
|
3875
3875
|
/**
|
|
3876
3876
|
* 状态
|
|
3877
3877
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3878
3878
|
*/
|
|
3879
|
-
Status
|
|
3879
|
+
Status?: Array<string>;
|
|
3880
3880
|
/**
|
|
3881
3881
|
* 更新日期
|
|
3882
3882
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3883
3883
|
*/
|
|
3884
|
-
UpdatedDate
|
|
3884
|
+
UpdatedDate?: string;
|
|
3885
3885
|
}
|
|
3886
3886
|
/**
|
|
3887
3887
|
* DownloadSnapshot返回参数结构体
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export declare const dts: {
|
|
2
|
-
v20180330: {
|
|
3
|
-
Client: typeof import("./v20180330/dts_client").Client;
|
|
4
|
-
Models: typeof import("./v20180330/dts_models");
|
|
5
|
-
};
|
|
6
2
|
v20211206: {
|
|
7
3
|
Client: typeof import("./v20211206/dts_client").Client;
|
|
8
4
|
Models: typeof import("./v20211206/dts_models");
|
|
9
5
|
};
|
|
6
|
+
v20180330: {
|
|
7
|
+
Client: typeof import("./v20180330/dts_client").Client;
|
|
8
|
+
Models: typeof import("./v20180330/dts_models");
|
|
9
|
+
};
|
|
10
10
|
};
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.dts = void 0;
|
|
4
|
-
const v20180330_1 = require("./v20180330");
|
|
5
4
|
const v20211206_1 = require("./v20211206");
|
|
5
|
+
const v20180330_1 = require("./v20180330");
|
|
6
6
|
exports.dts = {
|
|
7
|
-
v20180330: v20180330_1.v20180330,
|
|
8
7
|
v20211206: v20211206_1.v20211206,
|
|
8
|
+
v20180330: v20180330_1.v20180330,
|
|
9
9
|
};
|
|
@@ -13,21 +13,22 @@ export declare class Client extends AbstractClient {
|
|
|
13
13
|
*/
|
|
14
14
|
DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
* 新增/删除企业应用集成中的回调配置。
|
|
17
|
+
新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
|
|
18
|
+
请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
|
|
19
|
+
更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
|
|
19
20
|
*/
|
|
20
21
|
ModifyApplicationCallbackInfo(req: ModifyApplicationCallbackInfoRequest, cb?: (error: string, rep: ModifyApplicationCallbackInfoResponse) => void): Promise<ModifyApplicationCallbackInfoResponse>;
|
|
21
22
|
/**
|
|
22
|
-
*
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
* 此接口用于启动流程。它是模板发起合同的最后一步。
|
|
24
|
+
在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
|
|
25
|
+
流程激活后,将生成一份待签署的电子合同。
|
|
25
26
|
*/
|
|
26
27
|
StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
|
|
27
28
|
/**
|
|
28
|
-
*
|
|
29
|
-
|
|
30
|
-
|
|
29
|
+
* 用于撤销签署流程<br/>
|
|
30
|
+
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
|
|
31
|
+
`注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
|
|
31
32
|
*/
|
|
32
33
|
CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
|
|
33
34
|
/**
|
|
@@ -144,7 +145,8 @@ callbackinfo包含: 回调地址和签名key
|
|
|
144
145
|
CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
|
|
145
146
|
/**
|
|
146
147
|
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
147
|
-
适用场景:无需填写签署人信息,可通过模板id
|
|
148
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
|
|
149
|
+
常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
148
150
|
|
|
149
151
|
**本接口适用于发起方没有填写控件的 B2C或者单C模板**
|
|
150
152
|
|
|
@@ -173,6 +175,13 @@ callbackinfo包含: 回调地址和签名key
|
|
|
173
175
|
CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
|
|
174
176
|
/**
|
|
175
177
|
* 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
|
178
|
+
|
|
179
|
+
`注意:原合同必须签署完成后,才能发起解除协议。` <br/>
|
|
180
|
+
`注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
|
|
181
|
+
`注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
|
|
182
|
+
`注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
|
|
183
|
+
`注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
|
|
184
|
+
`注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
|
|
176
185
|
*/
|
|
177
186
|
CreateReleaseFlow(req: CreateReleaseFlowRequest, cb?: (error: string, rep: CreateReleaseFlowResponse) => void): Promise<CreateReleaseFlowResponse>;
|
|
178
187
|
/**
|
|
@@ -185,7 +194,12 @@ callbackinfo包含: 回调地址和签名key
|
|
|
185
194
|
*/
|
|
186
195
|
CreateFlowGroupByTemplates(req: CreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: CreateFlowGroupByTemplatesResponse) => void): Promise<CreateFlowGroupByTemplatesResponse>;
|
|
187
196
|
/**
|
|
188
|
-
*
|
|
197
|
+
* 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
|
|
198
|
+
1. 企业静默签
|
|
199
|
+
2. 企业与港澳台居民签署合同
|
|
200
|
+
3. 使用手机号验证签署方身份
|
|
201
|
+
4. 骑缝章
|
|
202
|
+
5. 批量签署能力
|
|
189
203
|
*/
|
|
190
204
|
DescribeExtendedServiceAuthInfos(req: DescribeExtendedServiceAuthInfosRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthInfosResponse) => void): Promise<DescribeExtendedServiceAuthInfosResponse>;
|
|
191
205
|
/**
|
|
@@ -209,7 +223,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
209
223
|
*/
|
|
210
224
|
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
211
225
|
/**
|
|
212
|
-
*
|
|
226
|
+
* 查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
|
|
213
227
|
*/
|
|
214
228
|
DescribeFlowEvidenceReport(req: DescribeFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeFlowEvidenceReportResponse) => void): Promise<DescribeFlowEvidenceReportResponse>;
|
|
215
229
|
/**
|
|
@@ -237,7 +251,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
237
251
|
*/
|
|
238
252
|
GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
|
|
239
253
|
/**
|
|
240
|
-
* 此接口(CancelMultiFlowSignQRCode
|
|
254
|
+
* 此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
|
|
255
|
+
该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
|
|
256
|
+
如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
|
|
241
257
|
*/
|
|
242
258
|
CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
|
|
243
259
|
/**
|
|
@@ -245,13 +261,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
245
261
|
*/
|
|
246
262
|
DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
|
|
247
263
|
/**
|
|
248
|
-
*
|
|
249
|
-
|
|
250
|
-
该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
|
|
264
|
+
* 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
|
|
251
265
|
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
266
|
+
注:
|
|
267
|
+
`1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
|
|
268
|
+
`2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
|
|
269
|
+
`3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
255
270
|
*/
|
|
256
271
|
CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
|
|
257
272
|
/**
|
|
@@ -335,21 +350,28 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
335
350
|
*/
|
|
336
351
|
DeleteIntegrationEmployees(req: DeleteIntegrationEmployeesRequest, cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void): Promise<DeleteIntegrationEmployeesResponse>;
|
|
337
352
|
/**
|
|
338
|
-
*
|
|
353
|
+
* 获取跳转至腾讯电子签小程序的签署链接
|
|
339
354
|
|
|
340
355
|
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
341
356
|
|
|
342
|
-
|
|
357
|
+
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
343
358
|
|
|
359
|
+
注:
|
|
360
|
+
`1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
|
|
361
|
+
`2. 签署链接的有效期为90天,超过有效期链接不可用`
|
|
344
362
|
|
|
345
|
-
|
|
363
|
+
其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
|
346
364
|
|
|
347
|
-
|
|
348
|
-
|
|
365
|
+
| 小程序 | AppID | 原始ID |
|
|
366
|
+
| ------------ | ------------ | ------------ |
|
|
367
|
+
| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
368
|
+
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
349
369
|
*/
|
|
350
370
|
CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
|
|
351
371
|
/**
|
|
352
372
|
* 此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
|
|
373
|
+
|
|
374
|
+
注: `在调用此接口时,请确保指定的用户已生成自动签开通链接并且未完成开通,否则无法撤销`
|
|
353
375
|
*/
|
|
354
376
|
CancelUserAutoSignEnableUrl(req: CancelUserAutoSignEnableUrlRequest, cb?: (error: string, rep: CancelUserAutoSignEnableUrlResponse) => void): Promise<CancelUserAutoSignEnableUrlResponse>;
|
|
355
377
|
/**
|
|
@@ -35,25 +35,26 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
35
35
|
return this.request("DescribeFlowInfo", req, cb);
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
39
|
-
|
|
40
|
-
|
|
38
|
+
* 新增/删除企业应用集成中的回调配置。
|
|
39
|
+
新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
|
|
40
|
+
请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
|
|
41
|
+
更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
|
|
41
42
|
*/
|
|
42
43
|
async ModifyApplicationCallbackInfo(req, cb) {
|
|
43
44
|
return this.request("ModifyApplicationCallbackInfo", req, cb);
|
|
44
45
|
}
|
|
45
46
|
/**
|
|
46
|
-
*
|
|
47
|
-
|
|
48
|
-
|
|
47
|
+
* 此接口用于启动流程。它是模板发起合同的最后一步。
|
|
48
|
+
在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
|
|
49
|
+
流程激活后,将生成一份待签署的电子合同。
|
|
49
50
|
*/
|
|
50
51
|
async StartFlow(req, cb) {
|
|
51
52
|
return this.request("StartFlow", req, cb);
|
|
52
53
|
}
|
|
53
54
|
/**
|
|
54
|
-
*
|
|
55
|
-
|
|
56
|
-
|
|
55
|
+
* 用于撤销签署流程<br/>
|
|
56
|
+
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
|
|
57
|
+
`注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
|
|
57
58
|
*/
|
|
58
59
|
async CancelFlow(req, cb) {
|
|
59
60
|
return this.request("CancelFlow", req, cb);
|
|
@@ -210,7 +211,8 @@ callbackinfo包含: 回调地址和签名key
|
|
|
210
211
|
}
|
|
211
212
|
/**
|
|
212
213
|
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
213
|
-
适用场景:无需填写签署人信息,可通过模板id
|
|
214
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
|
|
215
|
+
常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
214
216
|
|
|
215
217
|
**本接口适用于发起方没有填写控件的 B2C或者单C模板**
|
|
216
218
|
|
|
@@ -245,6 +247,13 @@ callbackinfo包含: 回调地址和签名key
|
|
|
245
247
|
}
|
|
246
248
|
/**
|
|
247
249
|
* 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
|
250
|
+
|
|
251
|
+
`注意:原合同必须签署完成后,才能发起解除协议。` <br/>
|
|
252
|
+
`注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
|
|
253
|
+
`注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
|
|
254
|
+
`注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
|
|
255
|
+
`注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
|
|
256
|
+
`注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
|
|
248
257
|
*/
|
|
249
258
|
async CreateReleaseFlow(req, cb) {
|
|
250
259
|
return this.request("CreateReleaseFlow", req, cb);
|
|
@@ -263,7 +272,12 @@ callbackinfo包含: 回调地址和签名key
|
|
|
263
272
|
return this.request("CreateFlowGroupByTemplates", req, cb);
|
|
264
273
|
}
|
|
265
274
|
/**
|
|
266
|
-
*
|
|
275
|
+
* 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
|
|
276
|
+
1. 企业静默签
|
|
277
|
+
2. 企业与港澳台居民签署合同
|
|
278
|
+
3. 使用手机号验证签署方身份
|
|
279
|
+
4. 骑缝章
|
|
280
|
+
5. 批量签署能力
|
|
267
281
|
*/
|
|
268
282
|
async DescribeExtendedServiceAuthInfos(req, cb) {
|
|
269
283
|
return this.request("DescribeExtendedServiceAuthInfos", req, cb);
|
|
@@ -293,7 +307,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
293
307
|
return this.request("UploadFiles", req, cb);
|
|
294
308
|
}
|
|
295
309
|
/**
|
|
296
|
-
*
|
|
310
|
+
* 查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
|
|
297
311
|
*/
|
|
298
312
|
async DescribeFlowEvidenceReport(req, cb) {
|
|
299
313
|
return this.request("DescribeFlowEvidenceReport", req, cb);
|
|
@@ -333,7 +347,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
333
347
|
return this.request("GetTaskResultApi", req, cb);
|
|
334
348
|
}
|
|
335
349
|
/**
|
|
336
|
-
* 此接口(CancelMultiFlowSignQRCode
|
|
350
|
+
* 此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
|
|
351
|
+
该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
|
|
352
|
+
如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
|
|
337
353
|
*/
|
|
338
354
|
async CancelMultiFlowSignQRCode(req, cb) {
|
|
339
355
|
return this.request("CancelMultiFlowSignQRCode", req, cb);
|
|
@@ -345,13 +361,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
345
361
|
return this.request("DescribeIntegrationEmployees", req, cb);
|
|
346
362
|
}
|
|
347
363
|
/**
|
|
348
|
-
*
|
|
349
|
-
|
|
350
|
-
该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
|
|
364
|
+
* 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
|
|
351
365
|
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
366
|
+
注:
|
|
367
|
+
`1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
|
|
368
|
+
`2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
|
|
369
|
+
`3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
355
370
|
*/
|
|
356
371
|
async CreateFlowSignUrl(req, cb) {
|
|
357
372
|
return this.request("CreateFlowSignUrl", req, cb);
|
|
@@ -465,23 +480,30 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
465
480
|
return this.request("DeleteIntegrationEmployees", req, cb);
|
|
466
481
|
}
|
|
467
482
|
/**
|
|
468
|
-
*
|
|
483
|
+
* 获取跳转至腾讯电子签小程序的签署链接
|
|
469
484
|
|
|
470
485
|
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
471
486
|
|
|
472
|
-
|
|
487
|
+
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
473
488
|
|
|
489
|
+
注:
|
|
490
|
+
`1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
|
|
491
|
+
`2. 签署链接的有效期为90天,超过有效期链接不可用`
|
|
474
492
|
|
|
475
|
-
|
|
493
|
+
其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
|
476
494
|
|
|
477
|
-
|
|
478
|
-
|
|
495
|
+
| 小程序 | AppID | 原始ID |
|
|
496
|
+
| ------------ | ------------ | ------------ |
|
|
497
|
+
| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
498
|
+
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
479
499
|
*/
|
|
480
500
|
async CreateSchemeUrl(req, cb) {
|
|
481
501
|
return this.request("CreateSchemeUrl", req, cb);
|
|
482
502
|
}
|
|
483
503
|
/**
|
|
484
504
|
* 此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
|
|
505
|
+
|
|
506
|
+
注: `在调用此接口时,请确保指定的用户已生成自动签开通链接并且未完成开通,否则无法撤销`
|
|
485
507
|
*/
|
|
486
508
|
async CancelUserAutoSignEnableUrl(req, cb) {
|
|
487
509
|
return this.request("CancelUserAutoSignEnableUrl", req, cb);
|