tencentcloud-sdk-nodejs 4.0.711 → 4.0.712

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 (105) hide show
  1. package/CHANGELOG.md +144 -0
  2. package/SERVICE_CHANGELOG.md +216 -143
  3. package/package.json +1 -1
  4. package/products.md +17 -17
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/index.ts +2 -2
  7. package/src/services/billing/v20180709/billing_models.ts +8 -0
  8. package/src/services/bma/index.ts +2 -2
  9. package/src/services/bsca/v20210811/bsca_client.ts +2 -1
  10. package/src/services/bsca/v20210811/bsca_models.ts +55 -22
  11. package/src/services/btoe/index.ts +2 -2
  12. package/src/services/cdwpg/v20201230/cdwpg_client.ts +17 -2
  13. package/src/services/cdwpg/v20201230/cdwpg_models.ts +203 -37
  14. package/src/services/chdfs/index.ts +2 -2
  15. package/src/services/cii/index.ts +2 -2
  16. package/src/services/clb/v20180317/clb_models.ts +5 -3
  17. package/src/services/cloudstudio/index.ts +2 -2
  18. package/src/services/dlc/v20210125/dlc_client.ts +1 -0
  19. package/src/services/dlc/v20210125/dlc_models.ts +21 -0
  20. package/src/services/dts/v20211206/dts_client.ts +12 -0
  21. package/src/services/dts/v20211206/dts_models.ts +25 -1
  22. package/src/services/ess/v20201111/ess_models.ts +16 -4
  23. package/src/services/essbasic/v20210526/essbasic_client.ts +3 -1
  24. package/src/services/essbasic/v20210526/essbasic_models.ts +82 -57
  25. package/src/services/facefusion/index.ts +2 -2
  26. package/src/services/iai/v20200303/iai_client.ts +1 -1
  27. package/src/services/iotcloud/index.ts +2 -2
  28. package/src/services/iotvideo/index.ts +4 -4
  29. package/src/services/irp/index.ts +2 -2
  30. package/src/services/lighthouse/v20200324/lighthouse_models.ts +5 -15
  31. package/src/services/mgobe/index.ts +2 -2
  32. package/src/services/monitor/v20180724/monitor_models.ts +1 -1
  33. package/src/services/oceanus/v20190422/oceanus_client.ts +3 -0
  34. package/src/services/oceanus/v20190422/oceanus_models.ts +189 -25
  35. package/src/services/sms/index.ts +2 -2
  36. package/src/services/ssl/v20191205/ssl_models.ts +1 -1
  37. package/src/services/tat/v20201028/tat_models.ts +3 -3
  38. package/src/services/tem/index.ts +2 -2
  39. package/src/services/teo/index.ts +2 -2
  40. package/src/services/tione/index.ts +2 -2
  41. package/src/services/tsw/index.ts +2 -2
  42. package/src/services/vm/index.ts +2 -2
  43. package/src/services/wedata/v20210820/wedata_models.ts +7 -5
  44. package/tencentcloud/common/sdk_version.d.ts +1 -1
  45. package/tencentcloud/common/sdk_version.js +1 -1
  46. package/tencentcloud/services/ams/index.d.ts +4 -4
  47. package/tencentcloud/services/ams/index.js +2 -2
  48. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +8 -0
  49. package/tencentcloud/services/bma/index.d.ts +4 -4
  50. package/tencentcloud/services/bma/index.js +2 -2
  51. package/tencentcloud/services/bsca/v20210811/bsca_client.d.ts +1 -1
  52. package/tencentcloud/services/bsca/v20210811/bsca_client.js +1 -1
  53. package/tencentcloud/services/bsca/v20210811/bsca_models.d.ts +54 -22
  54. package/tencentcloud/services/btoe/index.d.ts +4 -4
  55. package/tencentcloud/services/btoe/index.js +2 -2
  56. package/tencentcloud/services/cdwpg/v20201230/cdwpg_client.d.ts +5 -1
  57. package/tencentcloud/services/cdwpg/v20201230/cdwpg_client.js +6 -0
  58. package/tencentcloud/services/cdwpg/v20201230/cdwpg_models.d.ts +198 -37
  59. package/tencentcloud/services/chdfs/index.d.ts +4 -4
  60. package/tencentcloud/services/chdfs/index.js +2 -2
  61. package/tencentcloud/services/cii/index.d.ts +4 -4
  62. package/tencentcloud/services/cii/index.js +2 -2
  63. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +5 -3
  64. package/tencentcloud/services/cloudstudio/index.d.ts +4 -4
  65. package/tencentcloud/services/cloudstudio/index.js +2 -2
  66. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +20 -0
  67. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +5 -1
  68. package/tencentcloud/services/dts/v20211206/dts_client.js +6 -0
  69. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +23 -1
  70. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +16 -4
  71. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -1
  72. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -1
  73. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +82 -57
  74. package/tencentcloud/services/facefusion/index.d.ts +4 -4
  75. package/tencentcloud/services/facefusion/index.js +2 -2
  76. package/tencentcloud/services/iai/v20200303/iai_client.d.ts +1 -1
  77. package/tencentcloud/services/iai/v20200303/iai_client.js +1 -1
  78. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  79. package/tencentcloud/services/iotcloud/index.js +2 -2
  80. package/tencentcloud/services/iotvideo/index.d.ts +6 -6
  81. package/tencentcloud/services/iotvideo/index.js +4 -4
  82. package/tencentcloud/services/irp/index.d.ts +4 -4
  83. package/tencentcloud/services/irp/index.js +2 -2
  84. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +5 -15
  85. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  86. package/tencentcloud/services/mgobe/index.js +2 -2
  87. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +1 -1
  88. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +186 -25
  89. package/tencentcloud/services/sms/index.d.ts +4 -4
  90. package/tencentcloud/services/sms/index.js +2 -2
  91. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +1 -1
  92. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +3 -3
  93. package/tencentcloud/services/tem/index.d.ts +4 -4
  94. package/tencentcloud/services/tem/index.js +2 -2
  95. package/tencentcloud/services/teo/index.d.ts +4 -4
  96. package/tencentcloud/services/teo/index.js +2 -2
  97. package/tencentcloud/services/tione/index.d.ts +4 -4
  98. package/tencentcloud/services/tione/index.js +2 -2
  99. package/tencentcloud/services/tsw/index.d.ts +4 -4
  100. package/tencentcloud/services/tsw/index.js +2 -2
  101. package/tencentcloud/services/vm/index.d.ts +4 -4
  102. package/tencentcloud/services/vm/index.js +2 -2
  103. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +7 -5
  104. package/test/cdwpg.v20201230.test.js +10 -0
  105. package/test/dts.v20211206.test.js +10 -0
@@ -6122,6 +6122,11 @@ export interface CreateSparkSessionBatchSQLResponse {
6122
6122
  * 批任务唯一标识
6123
6123
  */
6124
6124
  BatchId?: string;
6125
+ /**
6126
+ * Statement任务列表信息
6127
+ 注意:此字段可能返回 null,表示取不到有效值。
6128
+ */
6129
+ Statements?: Array<StatementInformation>;
6125
6130
  /**
6126
6131
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6127
6132
  */
@@ -7531,6 +7536,21 @@ export interface CheckDataEngineImageCanBeUpgradeRequest {
7531
7536
  */
7532
7537
  DataEngineId: string;
7533
7538
  }
7539
+ /**
7540
+ * statement信息
7541
+ */
7542
+ export interface StatementInformation {
7543
+ /**
7544
+ * SQL任务唯一ID
7545
+ 注意:此字段可能返回 null,表示取不到有效值。
7546
+ */
7547
+ TaskId?: string;
7548
+ /**
7549
+ * SQL内容
7550
+ 注意:此字段可能返回 null,表示取不到有效值。
7551
+ */
7552
+ SQL?: string;
7553
+ }
7534
7554
  /**
7535
7555
  * SQL查询任务
7536
7556
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { ModifyCompareTaskResponse, DescribeSyncJobsResponse, ModifyMigrationJobResponse, ModifyMigrateRateLimitResponse, ModifyMigrateJobSpecRequest, StartMigrateJobRequest, ModifySyncRateLimitResponse, DestroyMigrateJobRequest, SkipCheckItemResponse, IsolateMigrateJobRequest, ResizeSyncJobResponse, ResumeMigrateJobResponse, CreateModifyCheckSyncJobRequest, IsolateSyncJobRequest, PauseMigrateJobRequest, ContinueMigrateJobRequest, ModifySyncRateLimitRequest, DescribeCheckSyncJobResultRequest, DestroySyncJobResponse, DescribeCompareReportResponse, StopMigrateJobResponse, ModifyCompareTaskNameRequest, CompleteMigrateJobResponse, DescribeMigrateDBInstancesResponse, CreateCheckSyncJobRequest, DescribeModifyCheckSyncJobResultResponse, StopSyncJobRequest, DescribeMigrationDetailRequest, DestroySyncJobRequest, ResizeSyncJobRequest, ResumeSyncJobResponse, ModifyCompareTaskNameResponse, StartSyncJobRequest, PauseSyncJobRequest, CreateMigrateCheckJobResponse, ModifySyncJobConfigRequest, ContinueMigrateJobResponse, CreateMigrationServiceRequest, DescribeCompareTasksRequest, RecoverSyncJobResponse, DeleteCompareTaskResponse, ContinueSyncJobResponse, CompleteMigrateJobRequest, DescribeCompareTasksResponse, StopCompareRequest, StartModifySyncJobRequest, DescribeCheckSyncJobResultResponse, StopSyncJobResponse, ModifyMigrateNameResponse, DescribeMigrationJobsResponse, ModifyMigrationJobRequest, StopCompareResponse, DestroyMigrateJobResponse, SkipSyncCheckItemRequest, DescribeModifyCheckSyncJobResultRequest, SkipSyncCheckItemResponse, IsolateSyncJobResponse, CreateMigrateCheckJobRequest, DescribeMigrationJobsRequest, ContinueSyncJobRequest, CreateMigrationServiceResponse, DescribeMigrationCheckJobResponse, CreateCheckSyncJobResponse, ConfigureSyncJobRequest, StartModifySyncJobResponse, DescribeMigrateDBInstancesRequest, ModifyCompareTaskRequest, RecoverSyncJobRequest, DescribeSyncJobsRequest, ResumeSyncJobRequest, ModifyMigrateRateLimitRequest, ConfigureSyncJobResponse, ResumeMigrateJobRequest, PauseSyncJobResponse, StartCompareResponse, CreateCompareTaskResponse, SkipCheckItemRequest, ModifyMigrateJobSpecResponse, CreateSyncJobResponse, CreateCompareTaskRequest, StartCompareRequest, DescribeMigrationCheckJobRequest, DescribeMigrationDetailResponse, CreateModifyCheckSyncJobResponse, ModifyMigrateNameRequest, StartSyncJobResponse, RecoverMigrateJobResponse, DeleteCompareTaskRequest, StopMigrateJobRequest, IsolateMigrateJobResponse, ModifySyncJobConfigResponse, CreateSyncJobRequest, DescribeCompareReportRequest, RecoverMigrateJobRequest, PauseMigrateJobResponse, StartMigrateJobResponse } from "./dts_models";
3
+ import { ModifyCompareTaskResponse, DescribeSyncJobsResponse, ModifyMigrationJobResponse, ModifyMigrateRateLimitResponse, ModifyMigrateJobSpecRequest, StartMigrateJobRequest, ModifySyncRateLimitResponse, DestroyMigrateJobRequest, SkipCheckItemResponse, IsolateMigrateJobRequest, ResizeSyncJobResponse, ResumeMigrateJobResponse, CreateModifyCheckSyncJobRequest, IsolateSyncJobRequest, PauseMigrateJobRequest, ContinueMigrateJobRequest, ModifySyncRateLimitRequest, DescribeCheckSyncJobResultRequest, DestroySyncJobResponse, DescribeCompareReportResponse, StopMigrateJobResponse, ModifyCompareTaskNameRequest, CompleteMigrateJobResponse, DescribeMigrateDBInstancesResponse, CreateCheckSyncJobRequest, DescribeModifyCheckSyncJobResultResponse, StopSyncJobRequest, DescribeMigrationDetailRequest, DestroySyncJobRequest, ResizeSyncJobRequest, ResumeSyncJobResponse, ModifyCompareTaskNameResponse, StartSyncJobRequest, ModifyMigrateRuntimeAttributeResponse, PauseSyncJobRequest, CreateMigrateCheckJobResponse, ModifySyncJobConfigRequest, ContinueMigrateJobResponse, CreateMigrationServiceRequest, DescribeCompareTasksRequest, RecoverSyncJobResponse, DeleteCompareTaskResponse, ContinueSyncJobResponse, CompleteMigrateJobRequest, DescribeCompareTasksResponse, StopCompareRequest, StartModifySyncJobRequest, DescribeCheckSyncJobResultResponse, StopSyncJobResponse, ModifyMigrateNameResponse, DescribeMigrationJobsResponse, ModifyMigrationJobRequest, StopCompareResponse, DestroyMigrateJobResponse, SkipSyncCheckItemRequest, DescribeModifyCheckSyncJobResultRequest, SkipSyncCheckItemResponse, IsolateSyncJobResponse, CreateMigrateCheckJobRequest, DescribeMigrationJobsRequest, ContinueSyncJobRequest, CreateMigrationServiceResponse, DescribeMigrationCheckJobResponse, CreateCheckSyncJobResponse, ConfigureSyncJobRequest, StartModifySyncJobResponse, DescribeMigrateDBInstancesRequest, ModifyCompareTaskRequest, RecoverSyncJobRequest, DescribeSyncJobsRequest, ResumeSyncJobRequest, ModifyMigrateRateLimitRequest, ConfigureSyncJobResponse, ResumeMigrateJobRequest, PauseSyncJobResponse, StartCompareResponse, CreateCompareTaskResponse, SkipCheckItemRequest, ModifyMigrateJobSpecResponse, CreateSyncJobResponse, CreateCompareTaskRequest, StartCompareRequest, DescribeMigrationCheckJobRequest, DescribeMigrationDetailResponse, CreateModifyCheckSyncJobResponse, ModifyMigrateNameRequest, StartSyncJobResponse, RecoverMigrateJobResponse, DeleteCompareTaskRequest, StopMigrateJobRequest, IsolateMigrateJobResponse, ModifySyncJobConfigResponse, CreateSyncJobRequest, DescribeCompareReportRequest, RecoverMigrateJobRequest, ModifyMigrateRuntimeAttributeRequest, PauseMigrateJobResponse, StartMigrateJobResponse } from "./dts_models";
4
4
  /**
5
5
  * dts client
6
6
  * @class
@@ -19,6 +19,10 @@ export declare class Client extends AbstractClient {
19
19
  * 查询同步任务信息
20
20
  */
21
21
  DescribeSyncJobs(req: DescribeSyncJobsRequest, cb?: (error: string, rep: DescribeSyncJobsResponse) => void): Promise<DescribeSyncJobsResponse>;
22
+ /**
23
+ * 修改任务运行时属性,此接口不同于配置类接口,不会进行状态机判断。
24
+ */
25
+ ModifyMigrateRuntimeAttribute(req: ModifyMigrateRuntimeAttributeRequest, cb?: (error: string, rep: ModifyMigrateRuntimeAttributeResponse) => void): Promise<ModifyMigrateRuntimeAttributeResponse>;
22
26
  /**
23
27
  * 购买迁移任务。购买成功后会返回随机生成的迁移任务id列表,也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意,一旦购买成功后源及目标数据库类型,源及目标实例地域不可修改。
24
28
  */
@@ -45,6 +45,12 @@ class Client extends abstract_client_1.AbstractClient {
45
45
  async DescribeSyncJobs(req, cb) {
46
46
  return this.request("DescribeSyncJobs", req, cb);
47
47
  }
48
+ /**
49
+ * 修改任务运行时属性,此接口不同于配置类接口,不会进行状态机判断。
50
+ */
51
+ async ModifyMigrateRuntimeAttribute(req, cb) {
52
+ return this.request("ModifyMigrateRuntimeAttribute", req, cb);
53
+ }
48
54
  /**
49
55
  * 购买迁移任务。购买成功后会返回随机生成的迁移任务id列表,也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意,一旦购买成功后源及目标数据库类型,源及目标实例地域不可修改。
50
56
  */
@@ -690,6 +690,15 @@ export interface StartSyncJobRequest {
690
690
  */
691
691
  JobId?: string;
692
692
  }
693
+ /**
694
+ * ModifyMigrateRuntimeAttribute返回参数结构体
695
+ */
696
+ export interface ModifyMigrateRuntimeAttributeResponse {
697
+ /**
698
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
699
+ */
700
+ RequestId?: string;
701
+ }
693
702
  /**
694
703
  * PauseSyncJob请求参数结构体
695
704
  */
@@ -939,7 +948,7 @@ export interface DBEndpointInfo {
939
948
  */
940
949
  DatabaseType: string;
941
950
  /**
942
- * 节点类型,为空或者"simple":表示普通节点,"cluster": 集群节点
951
+ * 节点类型,为空或者"simple"表示普通节点、"cluster"表示集群节点;对于mongo业务,取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群)
943
952
  注意:此字段可能返回 null,表示取不到有效值。
944
953
  */
945
954
  NodeType: string;
@@ -3730,6 +3739,19 @@ export interface DatabaseTableObject {
3730
3739
  */
3731
3740
  AdvancedObjects?: Array<string>;
3732
3741
  }
3742
+ /**
3743
+ * ModifyMigrateRuntimeAttribute请求参数结构体
3744
+ */
3745
+ export interface ModifyMigrateRuntimeAttributeRequest {
3746
+ /**
3747
+ * 迁移任务id,如:dts-2rgv0f09
3748
+ */
3749
+ JobId: string;
3750
+ /**
3751
+ * 需要修改的属性,此结构设计为通用结构,用于屏蔽多个业务的定制属性。<br>例如对于Redis:<br>{<br> "Key": "DstWriteMode", //目标库写入模式<br> "Value": "normal" //clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作,默认为此值) <br>},<br>{<br/> "Key": "IsDstReadOnly", //是否在迁移时设置目标库只读<br/> "Value": "true" //true(设置只读)、false(不设置只读) <br/>}
3752
+ */
3753
+ OtherOptions: Array<KeyValuePairOption>;
3754
+ }
3733
3755
  /**
3734
3756
  * PauseMigrateJob返回参数结构体
3735
3757
  */
@@ -1979,6 +1979,10 @@ export interface DescribeFlowTemplatesRequest {
1979
1979
  * @deprecated
1980
1980
  */
1981
1981
  GenerateSource?: number;
1982
+ /**
1983
+ * 是否获取模板预览链接
1984
+ */
1985
+ WithPreviewUrl?: boolean;
1982
1986
  }
1983
1987
  /**
1984
1988
  * DeleteSealPolicies返回参数结构体
@@ -5421,7 +5425,14 @@ export interface UploadFile {
5421
5425
  FileName?: string;
5422
5426
  }
5423
5427
  /**
5424
- * 模板/流程中控件信息,可以是填充控件或签署控件
5428
+ * 此结构体 (Component) 用于描述控件属性。
5429
+
5430
+ 在通过文件发起合同时,对应的component有三种定位方式
5431
+ 1. 绝对定位方式
5432
+ 2. 表单域(FIELD)定位方式
5433
+ 3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
5434
+ 可以参考官网说明
5435
+ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
5425
5436
  */
5426
5437
  export interface Component {
5427
5438
  /**
@@ -5616,9 +5627,10 @@ export interface Component {
5616
5627
  */
5617
5628
  ComponentValue?: string;
5618
5629
  /**
5619
- * NORMAL 正常模式,使用坐标制定签署控件位置
5620
- FIELD 表单域,需使用ComponentName指定表单域名称
5621
- KEYWORD 关键字,使用ComponentId指定关键字
5630
+ * 控件生成的方式:
5631
+ NORMAL - 普通控件
5632
+ FIELD - 表单域
5633
+ KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
5622
5634
  */
5623
5635
  GenerateMode?: string;
5624
5636
  /**
@@ -20,7 +20,9 @@ export declare class Client extends AbstractClient {
20
20
  */
21
21
  ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise<ChannelCreateFlowSignReviewResponse>;
22
22
  /**
23
- * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
23
+ * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
24
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
25
+ 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
24
26
 
25
27
  **本接口适用于发起方没有填写控件的 B2C或者单C模板**
26
28
 
@@ -44,7 +44,9 @@ class Client extends abstract_client_1.AbstractClient {
44
44
  return this.request("ChannelCreateFlowSignReview", req, cb);
45
45
  }
46
46
  /**
47
- * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
47
+ * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
48
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
49
+ 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
48
50
 
49
51
  **本接口适用于发起方没有填写控件的 B2C或者单C模板**
50
52
 
@@ -39,7 +39,7 @@ export interface ChannelCreateFlowRemindsResponse {
39
39
  在通过文件发起合同时,对应的component有三种定位方式
40
40
  1. 绝对定位方式
41
41
  2. 表单域(FIELD)定位方式
42
- 3. 关键字(KEYWORD)定位方式
42
+ 3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
43
43
  可以参考官网说明
44
44
  https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
45
45
  */
@@ -103,7 +103,7 @@ export interface Component {
103
103
  * 控件生成的方式:
104
104
  NORMAL - 普通控件
105
105
  FIELD - 表单域
106
- KEYWORD - 关键字
106
+ KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
107
107
  */
108
108
  GenerateMode?: string;
109
109
  /**
@@ -456,13 +456,15 @@ export interface ChannelCreateFlowSignReviewRequest {
456
456
  */
457
457
  export interface AuthFailMessage {
458
458
  /**
459
- * 第三方应用平台的子客企业OpenId
459
+ * 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
460
+
461
+ 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
460
462
  */
461
- ProxyOrganizationOpenId: string;
463
+ ProxyOrganizationOpenId?: string;
462
464
  /**
463
465
  * 错误信息
464
466
  */
465
- Message: string;
467
+ Message?: string;
466
468
  }
467
469
  /**
468
470
  * DescribeFlowDetailInfo请求参数结构体
@@ -667,27 +669,33 @@ export interface OperateChannelTemplateResponse {
667
669
  */
668
670
  AppId?: string;
669
671
  /**
670
- * 第三方应用平台模板库模板唯一标识
672
+ * 合同模板ID,为32位字符串。此处为第三方应用平台模板库模板ID,非子客模板ID。
671
673
  注意:此字段可能返回 null,表示取不到有效值。
672
674
  */
673
675
  TemplateId?: string;
674
676
  /**
675
677
  * 描述模板可见性更改的结果,和参数中Available无关。
676
- 全部成功-"all-success",
677
- 部分成功-"part-success",
678
- 全部失败-"fail",失败的会在FailMessageList中展示。
678
+ <ul>
679
+ <li>全部成功-"all-success"</li>
680
+ <li>部分成功-"part-success"</li>
681
+ <li>全部失败-"fail",失败的会在FailMessageList中展示</li>
682
+ </ul>
679
683
  注意:此字段可能返回 null,表示取不到有效值。
680
684
  */
681
685
  OperateResult?: string;
682
686
  /**
683
687
  * 模板可见性,
684
- 全部可见-"all",
685
- 部分可见-"part"
688
+ <ul>
689
+ <li>全部可见-"all"</li>
690
+ <li>部分可见-"part"</li>
691
+ </ul>
686
692
  注意:此字段可能返回 null,表示取不到有效值。
687
693
  */
688
694
  AuthTag?: string;
689
695
  /**
690
- * 合作企业方第三方机构唯一标识数据
696
+ * 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
697
+
698
+ 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
691
699
  注意:此字段可能返回 null,表示取不到有效值。
692
700
  */
693
701
  ProxyOrganizationOpenIds?: Array<string>;
@@ -3454,37 +3462,45 @@ export interface CreateSignUrlsRequest {
3454
3462
  */
3455
3463
  export interface ChannelCreateMultiFlowSignQRCodeRequest {
3456
3464
  /**
3457
- * 应用相关信息。
3458
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3465
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3466
+
3467
+ 此接口下面信息必填。
3468
+ <ul>
3469
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
3470
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
3471
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3472
+ </ul>
3459
3473
  */
3460
3474
  Agent: Agent;
3461
3475
  /**
3462
- * 模版ID
3476
+ * 合同模板ID,为32位字符串。
3477
+ 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
3463
3478
  */
3464
3479
  TemplateId: string;
3465
3480
  /**
3466
- * 签署流程名称,最大长度200个字符。
3481
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
3467
3482
  */
3468
3483
  FlowName: string;
3469
3484
  /**
3470
- * 最大可发起签署流程份数
3471
- <br/>默认5份
3472
- <br/>备注:发起签署流程数量超过此上限后,二维码自动失效。
3485
+ * 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。 一旦发起流程数超越该限制,该二维码将自动失效。
3473
3486
  */
3474
3487
  MaxFlowNum?: number;
3475
3488
  /**
3476
- * 签署流程有效天数 默认7 最高设置不超过30
3489
+ * 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。
3477
3490
  */
3478
3491
  FlowEffectiveDay?: number;
3479
3492
  /**
3480
- * 二维码有效天数 默认7 最高设置不超过90天
3493
+ * 二维码的有效期限,默认为7天,最高设定不得超过90天。 一旦超过二维码的有效期限,该二维码将自动失效。
3481
3494
  */
3482
3495
  QrEffectiveDay?: number;
3483
3496
  /**
3484
- * 指定的签署二维码签署人
3485
- <br/>指定后,只允许知道的人操作和签署
3497
+ * 指定签署人信息。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
3486
3498
  */
3487
3499
  Restrictions?: Array<ApproverRestriction>;
3500
+ /**
3501
+ * 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
3502
+ */
3503
+ ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
3488
3504
  /**
3489
3505
  * 已废弃,回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
3490
3506
  <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
@@ -3502,27 +3518,23 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
3502
3518
  * @deprecated
3503
3519
  */
3504
3520
  Operator?: UserInfo;
3505
- /**
3506
- * 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
3507
- */
3508
- ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
3509
3521
  }
3510
3522
  /**
3511
- * 一码多扫签署二维码对象
3523
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
3512
3524
  */
3513
3525
  export interface SignQrCode {
3514
3526
  /**
3515
- * 二维码id
3527
+ * 二维码ID,为32位字符串。
3516
3528
  */
3517
- QrCodeId: string;
3529
+ QrCodeId?: string;
3518
3530
  /**
3519
- * 二维码url
3531
+ * 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
3520
3532
  */
3521
- QrCodeUrl: string;
3533
+ QrCodeUrl?: string;
3522
3534
  /**
3523
- * 二维码过期时间
3535
+ * 二维码的有截止时间,格式为Unix标准时间戳(秒)。 一旦超过二维码的有效期限,该二维码将自动失效。
3524
3536
  */
3525
- ExpiredTime: number;
3537
+ ExpiredTime?: number;
3526
3538
  }
3527
3539
  /**
3528
3540
  * 创建签署流程签署人入参。
@@ -4493,11 +4505,11 @@ export interface ChannelCreateFlowGroupByFilesResponse {
4493
4505
  */
4494
4506
  export interface ChannelCreateMultiFlowSignQRCodeResponse {
4495
4507
  /**
4496
- * 签署二维码对象
4508
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
4497
4509
  */
4498
4510
  QrCode?: SignQrCode;
4499
4511
  /**
4500
- * 签署链接对象
4512
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
4501
4513
  */
4502
4514
  SignUrls?: SignUrl;
4503
4515
  /**
@@ -4946,21 +4958,21 @@ export interface ChannelCreateFlowGroupByTemplatesRequest {
4946
4958
  FlowGroupName: string;
4947
4959
  }
4948
4960
  /**
4949
- * 一码多扫签署二维码签署信息
4961
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。 通过链接,用户可直接访问电子签名小程序并签署合同。
4950
4962
  */
4951
4963
  export interface SignUrl {
4952
4964
  /**
4953
- * 小程序签署链接
4965
+ * 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
4954
4966
  */
4955
- AppSignUrl: string;
4967
+ AppSignUrl?: string;
4956
4968
  /**
4957
- * 签署链接有效时间
4969
+ * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
4958
4970
  */
4959
- EffectiveTime: string;
4971
+ EffectiveTime?: string;
4960
4972
  /**
4961
- * 移动端签署链接
4973
+ * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
4962
4974
  */
4963
- HttpSignUrl: string;
4975
+ HttpSignUrl?: string;
4964
4976
  }
4965
4977
  /**
4966
4978
  * ChannelCancelFlow请求参数结构体
@@ -5317,38 +5329,51 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
5317
5329
  */
5318
5330
  export interface OperateChannelTemplateRequest {
5319
5331
  /**
5320
- * 应用相关信息。
5321
- 此接口Agent.AppId必填。
5332
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5333
+
5334
+ 此接口下面信息必填。
5335
+ <ul>
5336
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
5337
+ </ul>
5322
5338
  */
5323
5339
  Agent: Agent;
5324
5340
  /**
5325
5341
  * 操作类型,
5326
- 查询:"SELECT",
5327
- 删除:"DELETE"
5328
- 更新:"UPDATE"
5342
+ <ul>
5343
+ <li>查询:"SELECT"</li>
5344
+ <li>删除:"DELETE"</li>
5345
+ <li>更新:"UPDATE"</li>
5346
+ </ul>
5329
5347
  */
5330
5348
  OperateType: string;
5331
5349
  /**
5332
- * 第三方应用平台模板库模板唯一标识
5350
+ * 合同模板ID,为32位字符串。此处为第三方应用平台模板库模板ID,非子客模板ID。
5333
5351
  */
5334
5352
  TemplateId: string;
5335
5353
  /**
5336
- * 合作企业方第三方机构唯一标识数据.
5337
- 支持多个, 用","进行分隔
5354
+ * 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
5355
+
5356
+ 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
5338
5357
  */
5339
5358
  ProxyOrganizationOpenIds?: string;
5340
5359
  /**
5341
5360
  * 模板可见性,
5342
- 全部可见-"all",
5343
- 部分可见-"part"
5361
+ <ul>
5362
+ <li>全部可见-"all"</li>
5363
+ <li>部分可见-"part"</li>
5364
+ </ul>
5344
5365
  */
5345
5366
  AuthTag?: string;
5346
5367
  /**
5347
5368
  * 当OperateType=UPDATE时,可以通过设置此字段对模板启停用状态进行操作。
5348
- 若此字段值为0,则不会修改模板Available,
5349
- 1为启用模板,
5350
- 2为停用模板。
5351
- 启用后模板可以正常领取。停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败,会直接返回错误。
5369
+ <ul>
5370
+ <li>若此字段值为0,则不会修改模板Available</li>
5371
+ <li>1为启用模板</li>
5372
+ <li>2为停用模板</li>
5373
+ </ul>
5374
+ 启用后模板可以正常领取。
5375
+ 停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
5376
+ 如果Available更新失败,会直接返回错误。
5352
5377
  */
5353
5378
  Available?: number;
5354
5379
  /**
@@ -1,10 +1,10 @@
1
1
  export declare const facefusion: {
2
- v20220927: {
3
- Client: typeof import("./v20220927/facefusion_client").Client;
4
- Models: typeof import("./v20220927/facefusion_models");
5
- };
6
2
  v20181201: {
7
3
  Client: typeof import("./v20181201/facefusion_client").Client;
8
4
  Models: typeof import("./v20181201/facefusion_models");
9
5
  };
6
+ v20220927: {
7
+ Client: typeof import("./v20220927/facefusion_client").Client;
8
+ Models: typeof import("./v20220927/facefusion_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.facefusion = void 0;
4
- const v20220927_1 = require("./v20220927");
5
4
  const v20181201_1 = require("./v20181201");
5
+ const v20220927_1 = require("./v20220927");
6
6
  exports.facefusion = {
7
- v20220927: v20220927_1.v20220927,
8
7
  v20181201: v20181201_1.v20181201,
8
+ v20220927: v20220927_1.v20220927,
9
9
  };
@@ -216,7 +216,7 @@ export declare class Client extends AbstractClient {
216
216
  */
217
217
  VerifyPerson(req: VerifyPersonRequest, cb?: (error: string, rep: VerifyPersonResponse) => void): Promise<VerifyPersonResponse>;
218
218
  /**
219
- * 检测给定图片中的人脸(Face)的位置、相应的面部属性和人脸质量信息,位置包括 (x,y,w,h),面部属性包括性别(gender)、年龄(age)、表情(expression)、魅力(beauty)、眼镜(glass)、发型(hair)、口罩(mask)和姿态 (pitch,roll,yaw),人脸质量信息包括整体质量分(score)、模糊分(sharpness)、光照分(brightness)和五官遮挡分(completeness)。
219
+ * 检测给定图片中的人脸(Face)的位置、相应的面部属性和人脸质量信息,位置包括 (x,y,w,h),面部属性包括性别(gender)、年龄(age)、表情(expression)、魅力(beauty)、眼镜(glass)、发型(hair)、口罩(mask)和姿态 (pitch,roll,yaw)
220
220
 
221
221
 
222
222
  其中,人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时,建议您对输入的人脸图片进行质量检测,提升后续业务处理的效果。该功能的应用场景包括:
@@ -288,7 +288,7 @@ class Client extends abstract_client_1.AbstractClient {
288
288
  return this.request("VerifyPerson", req, cb);
289
289
  }
290
290
  /**
291
- * 检测给定图片中的人脸(Face)的位置、相应的面部属性和人脸质量信息,位置包括 (x,y,w,h),面部属性包括性别(gender)、年龄(age)、表情(expression)、魅力(beauty)、眼镜(glass)、发型(hair)、口罩(mask)和姿态 (pitch,roll,yaw),人脸质量信息包括整体质量分(score)、模糊分(sharpness)、光照分(brightness)和五官遮挡分(completeness)。
291
+ * 检测给定图片中的人脸(Face)的位置、相应的面部属性和人脸质量信息,位置包括 (x,y,w,h),面部属性包括性别(gender)、年龄(age)、表情(expression)、魅力(beauty)、眼镜(glass)、发型(hair)、口罩(mask)和姿态 (pitch,roll,yaw)
292
292
 
293
293
 
294
294
  其中,人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时,建议您对输入的人脸图片进行质量检测,提升后续业务处理的效果。该功能的应用场景包括:
@@ -1,10 +1,10 @@
1
1
  export declare const iotcloud: {
2
- v20180614: {
3
- Client: typeof import("./v20180614/iotcloud_client").Client;
4
- Models: typeof import("./v20180614/iotcloud_models");
5
- };
6
2
  v20210408: {
7
3
  Client: typeof import("./v20210408/iotcloud_client").Client;
8
4
  Models: typeof import("./v20210408/iotcloud_models");
9
5
  };
6
+ v20180614: {
7
+ Client: typeof import("./v20180614/iotcloud_client").Client;
8
+ Models: typeof import("./v20180614/iotcloud_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.iotcloud = void 0;
4
- const v20180614_1 = require("./v20180614");
5
4
  const v20210408_1 = require("./v20210408");
5
+ const v20180614_1 = require("./v20180614");
6
6
  exports.iotcloud = {
7
- v20180614: v20180614_1.v20180614,
8
7
  v20210408: v20210408_1.v20210408,
8
+ v20180614: v20180614_1.v20180614,
9
9
  };
@@ -1,14 +1,14 @@
1
1
  export declare const iotvideo: {
2
- v20211125: {
3
- Client: typeof import("./v20211125/iotvideo_client").Client;
4
- Models: typeof import("./v20211125/iotvideo_models");
2
+ v20201215: {
3
+ Client: typeof import("./v20201215/iotvideo_client").Client;
4
+ Models: typeof import("./v20201215/iotvideo_models");
5
5
  };
6
6
  v20191126: {
7
7
  Client: typeof import("./v20191126/iotvideo_client").Client;
8
8
  Models: typeof import("./v20191126/iotvideo_models");
9
9
  };
10
- v20201215: {
11
- Client: typeof import("./v20201215/iotvideo_client").Client;
12
- Models: typeof import("./v20201215/iotvideo_models");
10
+ v20211125: {
11
+ Client: typeof import("./v20211125/iotvideo_client").Client;
12
+ Models: typeof import("./v20211125/iotvideo_models");
13
13
  };
14
14
  };
@@ -1,11 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.iotvideo = void 0;
4
- const v20211125_1 = require("./v20211125");
5
- const v20191126_1 = require("./v20191126");
6
4
  const v20201215_1 = require("./v20201215");
5
+ const v20191126_1 = require("./v20191126");
6
+ const v20211125_1 = require("./v20211125");
7
7
  exports.iotvideo = {
8
- v20211125: v20211125_1.v20211125,
9
- v20191126: v20191126_1.v20191126,
10
8
  v20201215: v20201215_1.v20201215,
9
+ v20191126: v20191126_1.v20191126,
10
+ v20211125: v20211125_1.v20211125,
11
11
  };
@@ -1,10 +1,10 @@
1
1
  export declare const irp: {
2
- v20220324: {
3
- Client: typeof import("./v20220324/irp_client").Client;
4
- Models: typeof import("./v20220324/irp_models");
5
- };
6
2
  v20220805: {
7
3
  Client: typeof import("./v20220805/irp_client").Client;
8
4
  Models: typeof import("./v20220805/irp_models");
9
5
  };
6
+ v20220324: {
7
+ Client: typeof import("./v20220324/irp_client").Client;
8
+ Models: typeof import("./v20220324/irp_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.irp = void 0;
4
- const v20220324_1 = require("./v20220324");
5
4
  const v20220805_1 = require("./v20220805");
5
+ const v20220324_1 = require("./v20220324");
6
6
  exports.irp = {
7
- v20220324: v20220324_1.v20220324,
8
7
  v20220805: v20220805_1.v20220805,
8
+ v20220324: v20220324_1.v20220324,
9
9
  };