tencentcloud-sdk-nodejs 4.0.822 → 4.0.823
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 +298 -0
- package/SERVICE_CHANGELOG.md +411 -199
- package/package.json +1 -1
- package/products.md +15 -15
- package/src/common/sdk_version.ts +1 -1
- package/src/services/asr/v20190614/asr_models.ts +2 -2
- package/src/services/bi/v20220105/bi_models.ts +12 -0
- package/src/services/billing/v20180709/billing_models.ts +189 -72
- package/src/services/cloudstudio/v20230508/cloudstudio_models.ts +20 -4
- package/src/services/cwp/v20180228/cwp_client.ts +9 -4
- package/src/services/cwp/v20180228/cwp_models.ts +57 -4
- package/src/services/cynosdb/v20190107/cynosdb_client.ts +12 -0
- package/src/services/cynosdb/v20190107/cynosdb_models.ts +130 -0
- package/src/services/dts/v20211206/dts_models.ts +20 -0
- package/src/services/ess/v20201111/ess_models.ts +35 -25
- package/src/services/essbasic/v20210526/essbasic_models.ts +4 -0
- package/src/services/lcic/v20220817/lcic_client.ts +1 -0
- package/src/services/lcic/v20220817/lcic_models.ts +31 -0
- package/src/services/mps/v20190612/mps_models.ts +69 -25
- package/src/services/tione/v20211111/tione_client.ts +2 -1
- package/src/services/tione/v20211111/tione_models.ts +34 -1
- package/src/services/tms/v20201229/tms_client.ts +1 -1
- package/src/services/vod/v20180717/vod_models.ts +7 -2
- package/src/services/wedata/v20210820/wedata_models.ts +81 -46
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +2 -2
- package/tencentcloud/services/bi/v20220105/bi_models.d.ts +12 -0
- package/tencentcloud/services/billing/v20180709/billing_models.d.ts +189 -72
- package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_models.d.ts +20 -4
- package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +6 -2
- package/tencentcloud/services/cwp/v20180228/cwp_client.js +6 -2
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +56 -4
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -0
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +128 -0
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +20 -0
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +35 -25
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +4 -0
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +30 -0
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +69 -25
- package/tencentcloud/services/tione/v20211111/tione_client.d.ts +1 -1
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +33 -1
- package/tencentcloud/services/tms/v20201229/tms_client.d.ts +1 -1
- package/tencentcloud/services/tms/v20201229/tms_client.js +1 -1
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +7 -2
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +81 -46
- package/test/cynosdb.v20190107.test.js +10 -0
|
@@ -784,6 +784,18 @@ export interface ModifyBaselineRuleRequest {
|
|
|
784
784
|
* <li>ItemName - string - 是否必填:否 - 项名称</li>
|
|
785
785
|
*/
|
|
786
786
|
Filters?: Array<Filter>
|
|
787
|
+
/**
|
|
788
|
+
* 0:检测项,1:检测项分类
|
|
789
|
+
*/
|
|
790
|
+
IdType?: number
|
|
791
|
+
/**
|
|
792
|
+
* 需要排除的检测项id
|
|
793
|
+
*/
|
|
794
|
+
ExcludeIds?: Array<number | bigint>
|
|
795
|
+
/**
|
|
796
|
+
* 勾选的检测项分类
|
|
797
|
+
*/
|
|
798
|
+
CategoryIds?: Array<number | bigint>
|
|
787
799
|
}
|
|
788
800
|
|
|
789
801
|
/**
|
|
@@ -4916,6 +4928,11 @@ export interface DescribeBaselineItemInfoResponse {
|
|
|
4916
4928
|
* 总条目数
|
|
4917
4929
|
*/
|
|
4918
4930
|
Total?: number
|
|
4931
|
+
/**
|
|
4932
|
+
* 基线分类列表
|
|
4933
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4934
|
+
*/
|
|
4935
|
+
CategoryList?: Array<BaselineItemsCategory>
|
|
4919
4936
|
/**
|
|
4920
4937
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4921
4938
|
*/
|
|
@@ -7865,15 +7882,20 @@ export interface BaselineCategory {
|
|
|
7865
7882
|
/**
|
|
7866
7883
|
* 分类Id
|
|
7867
7884
|
*/
|
|
7868
|
-
CategoryId
|
|
7885
|
+
CategoryId?: number
|
|
7869
7886
|
/**
|
|
7870
7887
|
* 分类名称
|
|
7871
7888
|
*/
|
|
7872
|
-
CategoryName
|
|
7889
|
+
CategoryName?: string
|
|
7873
7890
|
/**
|
|
7874
7891
|
* 父分类ID,如果为0则没有父分类
|
|
7875
7892
|
*/
|
|
7876
|
-
ParentCategoryId
|
|
7893
|
+
ParentCategoryId?: number
|
|
7894
|
+
/**
|
|
7895
|
+
* 子分类下检测项总数
|
|
7896
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7897
|
+
*/
|
|
7898
|
+
ItemCount?: number
|
|
7877
7899
|
}
|
|
7878
7900
|
|
|
7879
7901
|
/**
|
|
@@ -17300,7 +17322,11 @@ export interface CreateSearchTemplateResponse {
|
|
|
17300
17322
|
/**
|
|
17301
17323
|
* 0:成功,非0:失败
|
|
17302
17324
|
*/
|
|
17303
|
-
Status
|
|
17325
|
+
Status?: number
|
|
17326
|
+
/**
|
|
17327
|
+
* 失败原因
|
|
17328
|
+
*/
|
|
17329
|
+
Message?: string
|
|
17304
17330
|
/**
|
|
17305
17331
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
17306
17332
|
*/
|
|
@@ -22413,6 +22439,11 @@ export interface Item {
|
|
|
22413
22439
|
* 名称
|
|
22414
22440
|
*/
|
|
22415
22441
|
ItemName?: string
|
|
22442
|
+
/**
|
|
22443
|
+
* 自定义阈值
|
|
22444
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
22445
|
+
*/
|
|
22446
|
+
CustomItemValues?: Array<number | bigint>
|
|
22416
22447
|
}
|
|
22417
22448
|
|
|
22418
22449
|
/**
|
|
@@ -28885,6 +28916,28 @@ export interface OrderModifyObject {
|
|
|
28885
28916
|
InquireNum?: number
|
|
28886
28917
|
}
|
|
28887
28918
|
|
|
28919
|
+
/**
|
|
28920
|
+
* 基线检测项分类树状结构
|
|
28921
|
+
*/
|
|
28922
|
+
export interface BaselineItemsCategory {
|
|
28923
|
+
/**
|
|
28924
|
+
* 基线检测项父分类id
|
|
28925
|
+
*/
|
|
28926
|
+
ParentCategoryId?: number
|
|
28927
|
+
/**
|
|
28928
|
+
* 基线检测项父分类名称
|
|
28929
|
+
*/
|
|
28930
|
+
ParentCategoryName?: string
|
|
28931
|
+
/**
|
|
28932
|
+
* 基线检测项子分类数目
|
|
28933
|
+
*/
|
|
28934
|
+
CategoryCount?: number
|
|
28935
|
+
/**
|
|
28936
|
+
* 基线检测项子分类列表
|
|
28937
|
+
*/
|
|
28938
|
+
CategoryLists?: Array<BaselineCategory>
|
|
28939
|
+
}
|
|
28940
|
+
|
|
28888
28941
|
/**
|
|
28889
28942
|
* 帐号统计数据。
|
|
28890
28943
|
*/
|
|
@@ -244,6 +244,7 @@ import {
|
|
|
244
244
|
ModifyProxyDescResponse,
|
|
245
245
|
DbTable,
|
|
246
246
|
ModifyClusterSlaveZoneResponse,
|
|
247
|
+
RollbackToNewClusterRequest,
|
|
247
248
|
BinlogItem,
|
|
248
249
|
ModifyProxyDescRequest,
|
|
249
250
|
ReloadBalanceProxyNodeResponse,
|
|
@@ -347,6 +348,7 @@ import {
|
|
|
347
348
|
ModifyInstanceParamResponse,
|
|
348
349
|
TemplateParamInfo,
|
|
349
350
|
CreateBackupResponse,
|
|
351
|
+
RollbackToNewClusterResponse,
|
|
350
352
|
ResourcePackage,
|
|
351
353
|
DescribeBinlogSaveDaysResponse,
|
|
352
354
|
BillingResourceInfo,
|
|
@@ -962,6 +964,16 @@ export class Client extends AbstractClient {
|
|
|
962
964
|
return this.request("CreateAccounts", req, cb)
|
|
963
965
|
}
|
|
964
966
|
|
|
967
|
+
/**
|
|
968
|
+
* 回档到新集群
|
|
969
|
+
*/
|
|
970
|
+
async RollbackToNewCluster(
|
|
971
|
+
req: RollbackToNewClusterRequest,
|
|
972
|
+
cb?: (error: string, rep: RollbackToNewClusterResponse) => void
|
|
973
|
+
): Promise<RollbackToNewClusterResponse> {
|
|
974
|
+
return this.request("RollbackToNewCluster", req, cb)
|
|
975
|
+
}
|
|
976
|
+
|
|
965
977
|
/**
|
|
966
978
|
* 新购资源包
|
|
967
979
|
*/
|
|
@@ -5937,6 +5937,101 @@ export interface ModifyClusterSlaveZoneResponse {
|
|
|
5937
5937
|
RequestId?: string
|
|
5938
5938
|
}
|
|
5939
5939
|
|
|
5940
|
+
/**
|
|
5941
|
+
* RollbackToNewCluster请求参数结构体
|
|
5942
|
+
*/
|
|
5943
|
+
export interface RollbackToNewClusterRequest {
|
|
5944
|
+
/**
|
|
5945
|
+
* 可用区
|
|
5946
|
+
*/
|
|
5947
|
+
Zone: string
|
|
5948
|
+
/**
|
|
5949
|
+
* 回档时,传入源集群ID,用于查找源poolId
|
|
5950
|
+
*/
|
|
5951
|
+
OriginalClusterId: string
|
|
5952
|
+
/**
|
|
5953
|
+
* 集群名称,长度小于64个字符,每个字符取值范围:大/小写字母,数字,特殊符号('-','_','.')
|
|
5954
|
+
*/
|
|
5955
|
+
ClusterName?: string
|
|
5956
|
+
/**
|
|
5957
|
+
* 所属VPC网络ID
|
|
5958
|
+
*/
|
|
5959
|
+
UniqVpcId?: string
|
|
5960
|
+
/**
|
|
5961
|
+
* 所属子网ID
|
|
5962
|
+
*/
|
|
5963
|
+
UniqSubnetId?: string
|
|
5964
|
+
/**
|
|
5965
|
+
* 是否自动选择代金券 1是 0否 默认为0
|
|
5966
|
+
*/
|
|
5967
|
+
AutoVoucher?: number
|
|
5968
|
+
/**
|
|
5969
|
+
* Db类型
|
|
5970
|
+
当DbType为MYSQL时可选(默认NORMAL):
|
|
5971
|
+
<li>NORMAL</li>
|
|
5972
|
+
<li>SERVERLESS</li>
|
|
5973
|
+
*/
|
|
5974
|
+
DbMode?: string
|
|
5975
|
+
/**
|
|
5976
|
+
* 当DbMode为SEVERLESS时必填
|
|
5977
|
+
cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回
|
|
5978
|
+
*/
|
|
5979
|
+
MinCpu?: number
|
|
5980
|
+
/**
|
|
5981
|
+
* 当DbMode为SEVERLESS时必填:
|
|
5982
|
+
cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回
|
|
5983
|
+
*/
|
|
5984
|
+
MaxCpu?: number
|
|
5985
|
+
/**
|
|
5986
|
+
* 当DbMode为SEVERLESS时,指定集群是否自动暂停,可选范围
|
|
5987
|
+
<li>yes</li>
|
|
5988
|
+
<li>no</li>
|
|
5989
|
+
默认值:yes
|
|
5990
|
+
*/
|
|
5991
|
+
AutoPause?: string
|
|
5992
|
+
/**
|
|
5993
|
+
* 当DbMode为SEVERLESS时,指定集群自动暂停的延迟,单位秒,可选范围[600,691200]
|
|
5994
|
+
默认值:600
|
|
5995
|
+
*/
|
|
5996
|
+
AutoPauseDelay?: number
|
|
5997
|
+
/**
|
|
5998
|
+
* 安全组id数组
|
|
5999
|
+
*/
|
|
6000
|
+
SecurityGroupIds?: Array<string>
|
|
6001
|
+
/**
|
|
6002
|
+
* 告警策略Id数组
|
|
6003
|
+
*/
|
|
6004
|
+
AlarmPolicyIds?: Array<string>
|
|
6005
|
+
/**
|
|
6006
|
+
* 参数数组,暂时支持character_set_server (utf8|latin1|gbk|utf8mb4) ,lower_case_table_names,1-大小写不敏感,0-大小写敏感
|
|
6007
|
+
*/
|
|
6008
|
+
ClusterParams?: Array<ParamItem>
|
|
6009
|
+
/**
|
|
6010
|
+
* 0-下单并支付 1-下单
|
|
6011
|
+
*/
|
|
6012
|
+
DealMode?: number
|
|
6013
|
+
/**
|
|
6014
|
+
* 参数模板ID,可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID
|
|
6015
|
+
*/
|
|
6016
|
+
ParamTemplateId?: number
|
|
6017
|
+
/**
|
|
6018
|
+
* 集群创建需要绑定的tag数组信息
|
|
6019
|
+
*/
|
|
6020
|
+
ResourceTags?: Array<Tag>
|
|
6021
|
+
/**
|
|
6022
|
+
* 实例初始化配置信息,主要用于购买集群时选不同规格实例
|
|
6023
|
+
*/
|
|
6024
|
+
InstanceInitInfos?: Array<InstanceInitInfo>
|
|
6025
|
+
/**
|
|
6026
|
+
* 快照回档,表示snapshotId;时间点回档,表示queryId,为0,表示需要判断时间点是否有效
|
|
6027
|
+
*/
|
|
6028
|
+
RollbackId?: number
|
|
6029
|
+
/**
|
|
6030
|
+
* 时间点回档,指定时间;快照回档,快照时间
|
|
6031
|
+
*/
|
|
6032
|
+
ExpectTime?: string
|
|
6033
|
+
}
|
|
6034
|
+
|
|
5940
6035
|
/**
|
|
5941
6036
|
* Binlog描述
|
|
5942
6037
|
*/
|
|
@@ -8635,6 +8730,41 @@ export interface CreateBackupResponse {
|
|
|
8635
8730
|
RequestId?: string
|
|
8636
8731
|
}
|
|
8637
8732
|
|
|
8733
|
+
/**
|
|
8734
|
+
* RollbackToNewCluster返回参数结构体
|
|
8735
|
+
*/
|
|
8736
|
+
export interface RollbackToNewClusterResponse {
|
|
8737
|
+
/**
|
|
8738
|
+
* 冻结流水ID
|
|
8739
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
8740
|
+
*/
|
|
8741
|
+
TranId?: string
|
|
8742
|
+
/**
|
|
8743
|
+
* 订单号
|
|
8744
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
8745
|
+
*/
|
|
8746
|
+
DealNames?: Array<string>
|
|
8747
|
+
/**
|
|
8748
|
+
* 资源ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID)
|
|
8749
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
8750
|
+
*/
|
|
8751
|
+
ResourceIds?: Array<string>
|
|
8752
|
+
/**
|
|
8753
|
+
* 集群ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID)
|
|
8754
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
8755
|
+
*/
|
|
8756
|
+
ClusterIds?: Array<string>
|
|
8757
|
+
/**
|
|
8758
|
+
* 大订单号
|
|
8759
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
8760
|
+
*/
|
|
8761
|
+
BigDealIds?: Array<string>
|
|
8762
|
+
/**
|
|
8763
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
8764
|
+
*/
|
|
8765
|
+
RequestId?: string
|
|
8766
|
+
}
|
|
8767
|
+
|
|
8638
8768
|
/**
|
|
8639
8769
|
* 资源包信息
|
|
8640
8770
|
*/
|
|
@@ -4154,6 +4154,16 @@ export interface EndpointItem {
|
|
|
4154
4154
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4155
4155
|
*/
|
|
4156
4156
|
ExtraAttr?: Array<KeyValuePairOption>
|
|
4157
|
+
/**
|
|
4158
|
+
* 数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的ID
|
|
4159
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4160
|
+
*/
|
|
4161
|
+
ChildInstanceId?: string
|
|
4162
|
+
/**
|
|
4163
|
+
* 数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的类型、比如:只读实例传ro、读写实例传rw
|
|
4164
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4165
|
+
*/
|
|
4166
|
+
ChildInstanceType?: string
|
|
4157
4167
|
}
|
|
4158
4168
|
|
|
4159
4169
|
/**
|
|
@@ -4727,6 +4737,16 @@ export interface Endpoint {
|
|
|
4727
4737
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4728
4738
|
*/
|
|
4729
4739
|
CcnOwnerUin?: string
|
|
4740
|
+
/**
|
|
4741
|
+
* 数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的ID
|
|
4742
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4743
|
+
*/
|
|
4744
|
+
ChildInstanceId?: string
|
|
4745
|
+
/**
|
|
4746
|
+
* 数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的类型、比如:只读实例传ro、读写实例传rw
|
|
4747
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4748
|
+
*/
|
|
4749
|
+
ChildInstanceType?: string
|
|
4730
4750
|
}
|
|
4731
4751
|
|
|
4732
4752
|
/**
|
|
@@ -4159,13 +4159,12 @@ export interface ExtendAuthInfo {
|
|
|
4159
4159
|
*/
|
|
4160
4160
|
export interface FlowCreateApprover {
|
|
4161
4161
|
/**
|
|
4162
|
-
*
|
|
4163
|
-
|
|
4164
|
-
|
|
4165
|
-
|
|
4166
|
-
|
|
4167
|
-
7
|
|
4168
|
-
注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
|
|
4162
|
+
* 在指定签署方时,可以选择企业B端或个人C端等不同的参与者类型,可选类型如下:
|
|
4163
|
+
|
|
4164
|
+
<ul><li> <b>0</b> :企业B端。</li>
|
|
4165
|
+
<li> <b>1</b> :个人C端。</li>
|
|
4166
|
+
<li> <b>3</b> :企业B端静默(自动)签署,无需签署人参与,自动签署可以参考<a href="https://qian.tencent.com/developers/company/autosign_guide" target="_blank" rel="noopener noreferrer">自动签署使用说明</a>文档。</li>
|
|
4167
|
+
<li> <b>7</b> :个人C端自动签署,适用于个人自动签场景。注: <b>个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。</b> </li></ul>
|
|
4169
4168
|
*/
|
|
4170
4169
|
ApproverType: number
|
|
4171
4170
|
/**
|
|
@@ -4186,18 +4185,17 @@ export interface FlowCreateApprover {
|
|
|
4186
4185
|
*/
|
|
4187
4186
|
ApproverName?: string
|
|
4188
4187
|
/**
|
|
4189
|
-
* 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
|
4190
|
-
请确认手机号所有方为此合同签署方。
|
|
4188
|
+
* 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。
|
|
4191
4189
|
|
|
4192
|
-
|
|
4190
|
+
注:`在未指定签署人电子签UserId情况下,为必填参数`
|
|
4193
4191
|
|
|
4194
4192
|
*/
|
|
4195
4193
|
ApproverMobile?: string
|
|
4196
4194
|
/**
|
|
4197
4195
|
* 证件类型,支持以下类型
|
|
4198
|
-
<ul><li>ID_CARD
|
|
4199
|
-
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
4200
|
-
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
4196
|
+
<ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li>
|
|
4197
|
+
<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>
|
|
4198
|
+
<li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
4201
4199
|
*/
|
|
4202
4200
|
ApproverIdCardType?: string
|
|
4203
4201
|
/**
|
|
@@ -4209,15 +4207,17 @@ export interface FlowCreateApprover {
|
|
|
4209
4207
|
ApproverIdCardNumber?: string
|
|
4210
4208
|
/**
|
|
4211
4209
|
* 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
|
|
4212
|
-
|
|
4213
|
-
|
|
4210
|
+
|
|
4211
|
+
<b>模板发起合同时,该参数为必填项,可以通过[查询模版信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>
|
|
4212
|
+
<b>文件发起合同时,该参数无需传值。</b>
|
|
4213
|
+
|
|
4214
4214
|
如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
|
|
4215
4215
|
*/
|
|
4216
4216
|
RecipientId?: string
|
|
4217
4217
|
/**
|
|
4218
4218
|
* 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
|
|
4219
4219
|
|
|
4220
|
-
注:
|
|
4220
|
+
注: <font color="red">将要废弃</font >, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
|
|
4221
4221
|
*/
|
|
4222
4222
|
VerifyChannel?: Array<string>
|
|
4223
4223
|
/**
|
|
@@ -4225,7 +4225,7 @@ export interface FlowCreateApprover {
|
|
|
4225
4225
|
<ul><li> **sms** : (默认)短信</li>
|
|
4226
4226
|
<li> **none** : 不通知</li></ul>
|
|
4227
4227
|
|
|
4228
|
-
注:
|
|
4228
|
+
注: `既是发起方又是签署方时,不给此签署方发送短信`
|
|
4229
4229
|
*/
|
|
4230
4230
|
NotifyType?: string
|
|
4231
4231
|
/**
|
|
@@ -4233,17 +4233,25 @@ export interface FlowCreateApprover {
|
|
|
4233
4233
|
*/
|
|
4234
4234
|
IsFullText?: boolean
|
|
4235
4235
|
/**
|
|
4236
|
-
*
|
|
4236
|
+
* 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
|
|
4237
|
+
|
|
4238
|
+
若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
|
|
4239
|
+
<ul>
|
|
4240
|
+
<li>合同页数少于等于2页,阅读时间为3秒;</li>
|
|
4241
|
+
<li>合同页数为3到5页,阅读时间为5秒;</li>
|
|
4242
|
+
<li>合同页数大于等于6页,阅读时间为10秒。</li>
|
|
4243
|
+
</ul>
|
|
4237
4244
|
*/
|
|
4238
4245
|
PreReadTime?: number
|
|
4239
4246
|
/**
|
|
4240
4247
|
* 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
|
|
4241
4248
|
|
|
4242
|
-
|
|
4249
|
+
注:
|
|
4250
|
+
如果传进来的<font color="red">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)
|
|
4243
4251
|
*/
|
|
4244
4252
|
UserId?: string
|
|
4245
4253
|
/**
|
|
4246
|
-
*
|
|
4254
|
+
* <font color="red">字段已经废弃</font>,当前只支持true,默认为true
|
|
4247
4255
|
*/
|
|
4248
4256
|
Required?: boolean
|
|
4249
4257
|
/**
|
|
@@ -4271,9 +4279,12 @@ export interface FlowCreateApprover {
|
|
|
4271
4279
|
*/
|
|
4272
4280
|
JumpUrl?: string
|
|
4273
4281
|
/**
|
|
4274
|
-
*
|
|
4275
|
-
|
|
4276
|
-
|
|
4282
|
+
* 签署人的签署ID
|
|
4283
|
+
|
|
4284
|
+
<ul>
|
|
4285
|
+
<li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数,电子签后台系统会自动生成。</li>
|
|
4286
|
+
<li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时,可以通过查询详情接口获取签署人的SignId,然后可以将此值传入,为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li>
|
|
4287
|
+
</ul>
|
|
4277
4288
|
*/
|
|
4278
4289
|
SignId?: string
|
|
4279
4290
|
/**
|
|
@@ -4361,8 +4372,7 @@ export interface FlowCreateApprover {
|
|
|
4361
4372
|
*/
|
|
4362
4373
|
SignTypeSelector?: number
|
|
4363
4374
|
/**
|
|
4364
|
-
*
|
|
4365
|
-
签署人的签署截止时间,格式为Unix标准时间戳(秒)
|
|
4375
|
+
* 签署人的签署截止时间,格式为Unix标准时间戳(秒), 超过此时间未签署的合同变成已过期状态,不能在继续签署
|
|
4366
4376
|
|
|
4367
4377
|
注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
|
|
4368
4378
|
*/
|
|
@@ -3130,6 +3130,10 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
3130
3130
|
注:`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业,这里修改经办人名字传入将不会生效`
|
|
3131
3131
|
*/
|
|
3132
3132
|
ProxyOperatorName?: string
|
|
3133
|
+
/**
|
|
3134
|
+
* 子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注:`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业,这里修改经办人手机号传入将不会生效`
|
|
3135
|
+
*/
|
|
3136
|
+
ProxyOperatorMobile?: string
|
|
3133
3137
|
/**
|
|
3134
3138
|
* Web控制台登录后进入的功能模块, 支持的模块包括:
|
|
3135
3139
|
<ul>
|
|
@@ -1395,6 +1395,11 @@ export interface MessageItem {
|
|
|
1395
1395
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1396
1396
|
*/
|
|
1397
1397
|
ImageMessage?: string
|
|
1398
|
+
/**
|
|
1399
|
+
* 自定义消息内容。message type为2时有效。
|
|
1400
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1401
|
+
*/
|
|
1402
|
+
CustomMessage?: CustomMsgContent
|
|
1398
1403
|
}
|
|
1399
1404
|
|
|
1400
1405
|
/**
|
|
@@ -2985,6 +2990,27 @@ export interface DescribeRoomStatisticsRequest {
|
|
|
2985
2990
|
Limit: number
|
|
2986
2991
|
}
|
|
2987
2992
|
|
|
2993
|
+
/**
|
|
2994
|
+
* 自定义消息
|
|
2995
|
+
*/
|
|
2996
|
+
export interface CustomMsgContent {
|
|
2997
|
+
/**
|
|
2998
|
+
* 自定义消息数据。
|
|
2999
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3000
|
+
*/
|
|
3001
|
+
Data?: string
|
|
3002
|
+
/**
|
|
3003
|
+
* 自定义消息描述信息。
|
|
3004
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3005
|
+
*/
|
|
3006
|
+
Desc?: string
|
|
3007
|
+
/**
|
|
3008
|
+
* 扩展字段。
|
|
3009
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3010
|
+
*/
|
|
3011
|
+
Ext?: string
|
|
3012
|
+
}
|
|
3013
|
+
|
|
2988
3014
|
/**
|
|
2989
3015
|
* DescribeDocumentsByRoom返回参数结构体
|
|
2990
3016
|
*/
|
|
@@ -3345,6 +3371,7 @@ export interface MsgBody {
|
|
|
3345
3371
|
TIMTextElem(文本消息)
|
|
3346
3372
|
TIMFaceElem(表情消息)
|
|
3347
3373
|
TIMImageElem(图像消息)
|
|
3374
|
+
TIMCustomElem(自定义消息)
|
|
3348
3375
|
*/
|
|
3349
3376
|
MsgType: string
|
|
3350
3377
|
/**
|
|
@@ -3359,6 +3386,10 @@ TIMImageElem(图像消息)
|
|
|
3359
3386
|
* 图像消息,当MsgType为TIMImageElem(图像消息)必选。
|
|
3360
3387
|
*/
|
|
3361
3388
|
ImageMsgContent?: ImageMsgContent
|
|
3389
|
+
/**
|
|
3390
|
+
* 自定义消息,TIMCustomElem(自定义消息)必选。
|
|
3391
|
+
*/
|
|
3392
|
+
CustomMsgContent?: CustomMsgContent
|
|
3362
3393
|
}
|
|
3363
3394
|
|
|
3364
3395
|
/**
|