tencentcloud-sdk-nodejs 4.0.375 → 4.0.378

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 (94) hide show
  1. package/CHANGELOG.md +715 -0
  2. package/SERVICE_CHANGELOG.md +689 -105
  3. package/package.json +1 -1
  4. package/products.md +27 -27
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cat/v20180409/cat_client.ts +1 -1
  7. package/src/services/cat/v20180409/cat_models.ts +17 -10
  8. package/src/services/cbs/v20170312/cbs_models.ts +23 -23
  9. package/src/services/cdb/v20170320/cdb_client.ts +21 -9
  10. package/src/services/cdb/v20170320/cdb_models.ts +96 -43
  11. package/src/services/ckafka/v20190819/ckafka_client.ts +1 -1
  12. package/src/services/ckafka/v20190819/ckafka_models.ts +17 -1
  13. package/src/services/clb/v20180317/clb_models.ts +1 -1
  14. package/src/services/cpdp/v20190820/cpdp_client.ts +80 -29
  15. package/src/services/cpdp/v20190820/cpdp_models.ts +325 -33
  16. package/src/services/cvm/v20170312/cvm_client.ts +721 -661
  17. package/src/services/cvm/v20170312/cvm_models.ts +221 -66
  18. package/src/services/cwp/v20180228/cwp_models.ts +6 -0
  19. package/src/services/dcdb/v20180411/dcdb_models.ts +15 -0
  20. package/src/services/dlc/v20210125/dlc_client.ts +3 -3
  21. package/src/services/dlc/v20210125/dlc_models.ts +177 -4
  22. package/src/services/es/v20180416/es_models.ts +12 -0
  23. package/src/services/ess/v20201111/ess_client.ts +36 -16
  24. package/src/services/ess/v20201111/ess_models.ts +9 -12
  25. package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
  26. package/src/services/essbasic/v20210526/essbasic_models.ts +45 -5
  27. package/src/services/ie/v20200304/ie_client.ts +5 -0
  28. package/src/services/ie/v20200304/ie_models.ts +261 -15
  29. package/src/services/mariadb/v20170312/mariadb_client.ts +25 -13
  30. package/src/services/mariadb/v20170312/mariadb_models.ts +53 -8
  31. package/src/services/ms/v20180408/ms_models.ts +23 -23
  32. package/src/services/redis/v20180412/redis_models.ts +6 -1
  33. package/src/services/sts/v20180813/sts_models.ts +5 -0
  34. package/src/services/tcr/v20190924/tcr_models.ts +22 -1
  35. package/src/services/tcss/v20201101/tcss_models.ts +82 -2
  36. package/src/services/tdcpg/v20211118/tdcpg_models.ts +42 -6
  37. package/src/services/tdmq/v20200217/tdmq_models.ts +2 -2
  38. package/src/services/teo/v20220106/teo_client.ts +7 -2
  39. package/src/services/teo/v20220106/teo_models.ts +256 -101
  40. package/src/services/tiia/v20190529/tiia_models.ts +6 -0
  41. package/src/services/tke/v20180525/tke_client.ts +1 -1
  42. package/src/services/tke/v20180525/tke_models.ts +65 -0
  43. package/src/services/vpc/v20170312/vpc_client.ts +1 -1
  44. package/tencentcloud/common/sdk_version.d.ts +1 -1
  45. package/tencentcloud/common/sdk_version.js +1 -1
  46. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +1 -1
  47. package/tencentcloud/services/cat/v20180409/cat_client.js +1 -1
  48. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +14 -7
  49. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +22 -22
  50. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +7 -3
  51. package/tencentcloud/services/cdb/v20170320/cdb_client.js +9 -3
  52. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +83 -35
  53. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +1 -1
  54. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +15 -1
  55. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +1 -1
  56. package/tencentcloud/services/cpdp/v20190820/cpdp_client.d.ts +26 -10
  57. package/tencentcloud/services/cpdp/v20190820/cpdp_client.js +37 -13
  58. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +278 -29
  59. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +335 -315
  60. package/tencentcloud/services/cvm/v20170312/cvm_client.js +430 -400
  61. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +192 -58
  62. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +5 -0
  63. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +12 -0
  64. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +3 -3
  65. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +148 -4
  66. package/tencentcloud/services/es/v20180416/es_models.d.ts +10 -0
  67. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +21 -1
  68. package/tencentcloud/services/ess/v20201111/ess_client.js +21 -1
  69. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +8 -11
  70. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  71. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  72. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +38 -5
  73. package/tencentcloud/services/ie/v20200304/ie_models.d.ts +223 -14
  74. package/tencentcloud/services/mariadb/v20170312/mariadb_client.d.ts +12 -8
  75. package/tencentcloud/services/mariadb/v20170312/mariadb_client.js +14 -8
  76. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +46 -8
  77. package/tencentcloud/services/ms/v20180408/ms_models.d.ts +22 -22
  78. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +5 -1
  79. package/tencentcloud/services/sts/v20180813/sts_models.d.ts +4 -0
  80. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +18 -1
  81. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +75 -2
  82. package/tencentcloud/services/tdcpg/v20211118/tdcpg_models.d.ts +35 -5
  83. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +2 -2
  84. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +221 -86
  85. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +5 -0
  86. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +1 -1
  87. package/tencentcloud/services/tke/v20180525/tke_client.js +1 -1
  88. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +53 -0
  89. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -1
  90. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  91. package/test/cdb.v20170320.test.js +12 -2
  92. package/test/cpdp.v20190820.test.js +48 -8
  93. package/test/cvm.v20170312.test.js +206 -156
  94. package/test/mariadb.v20170312.test.js +12 -2
@@ -9,23 +9,30 @@ export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
10
  /**
11
11
  * 此接口用于发起流程
12
+ 适用场景:见创建签署流程接口。
13
+ 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
12
14
  */
13
15
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
14
16
  /**
15
17
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
18
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
16
19
  适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
17
20
  */
18
21
  CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
19
22
  /**
20
23
  * 用于撤销签署流程
24
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
25
+ 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
21
26
  */
22
27
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
23
28
  /**
24
29
  * 创建电子文档
30
+ 适用场景:见创建签署流程接口。 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
25
31
  */
26
32
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
27
33
  /**
28
34
  * 查询文件下载URL
35
+ 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
29
36
  */
30
37
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
31
38
  /**
@@ -34,6 +41,8 @@ export declare class Client extends AbstractClient {
34
41
  DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
35
42
  /**
36
43
  * 创建签署流程
44
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
45
+ 注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
37
46
  */
38
47
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
39
48
  /**
@@ -43,6 +52,11 @@ export declare class Client extends AbstractClient {
43
52
  /**
44
53
  * 获取小程序跳转链接
45
54
 
55
+ 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
56
+
57
+ 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
58
+
59
+
46
60
  跳转到小程序的实现,参考官方文档(分为<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>两种方式)
47
61
 
48
62
 
@@ -51,18 +65,24 @@ export declare class Client extends AbstractClient {
51
65
  CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
52
66
  /**
53
67
  * 二期接口-查询模板
68
+ 适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
54
69
  */
55
70
  DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
56
71
  /**
57
72
  * 查询流程摘要
73
+ 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
58
74
  */
59
75
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
60
76
  /**
61
- * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建签署流程。
77
+ * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
78
+ 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
79
+ 适用场景2:可通过改接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
80
+ 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
62
81
  */
63
82
  CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
64
83
  /**
65
84
  * 此接口(UploadFiles)用于文件上传。
85
+ 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
66
86
  调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
67
87
  */
68
88
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
@@ -29,12 +29,15 @@ class Client extends abstract_client_1.AbstractClient {
29
29
  }
30
30
  /**
31
31
  * 此接口用于发起流程
32
+ 适用场景:见创建签署流程接口。
33
+ 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
32
34
  */
33
35
  async StartFlow(req, cb) {
34
36
  return this.request("StartFlow", req, cb);
35
37
  }
36
38
  /**
37
39
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
40
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
38
41
  适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
39
42
  */
40
43
  async CreateMultiFlowSignQRCode(req, cb) {
@@ -42,18 +45,22 @@ class Client extends abstract_client_1.AbstractClient {
42
45
  }
43
46
  /**
44
47
  * 用于撤销签署流程
48
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
49
+ 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
45
50
  */
46
51
  async CancelFlow(req, cb) {
47
52
  return this.request("CancelFlow", req, cb);
48
53
  }
49
54
  /**
50
55
  * 创建电子文档
56
+ 适用场景:见创建签署流程接口。 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
51
57
  */
52
58
  async CreateDocument(req, cb) {
53
59
  return this.request("CreateDocument", req, cb);
54
60
  }
55
61
  /**
56
62
  * 查询文件下载URL
63
+ 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
57
64
  */
58
65
  async DescribeFileUrls(req, cb) {
59
66
  return this.request("DescribeFileUrls", req, cb);
@@ -66,6 +73,8 @@ class Client extends abstract_client_1.AbstractClient {
66
73
  }
67
74
  /**
68
75
  * 创建签署流程
76
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
77
+ 注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
69
78
  */
70
79
  async CreateFlow(req, cb) {
71
80
  return this.request("CreateFlow", req, cb);
@@ -79,6 +88,11 @@ class Client extends abstract_client_1.AbstractClient {
79
88
  /**
80
89
  * 获取小程序跳转链接
81
90
 
91
+ 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
92
+
93
+ 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
94
+
95
+
82
96
  跳转到小程序的实现,参考官方文档(分为<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>两种方式)
83
97
 
84
98
 
@@ -89,24 +103,30 @@ class Client extends abstract_client_1.AbstractClient {
89
103
  }
90
104
  /**
91
105
  * 二期接口-查询模板
106
+ 适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
92
107
  */
93
108
  async DescribeFlowTemplates(req, cb) {
94
109
  return this.request("DescribeFlowTemplates", req, cb);
95
110
  }
96
111
  /**
97
112
  * 查询流程摘要
113
+ 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
98
114
  */
99
115
  async DescribeFlowBriefs(req, cb) {
100
116
  return this.request("DescribeFlowBriefs", req, cb);
101
117
  }
102
118
  /**
103
- * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建签署流程。
119
+ * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
120
+ 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
121
+ 适用场景2:可通过改接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
122
+ 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
104
123
  */
105
124
  async CreateFlowByFiles(req, cb) {
106
125
  return this.request("CreateFlowByFiles", req, cb);
107
126
  }
108
127
  /**
109
128
  * 此接口(UploadFiles)用于文件上传。
129
+ 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
110
130
  调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
111
131
  */
112
132
  async UploadFiles(req, cb) {
@@ -338,20 +338,17 @@ export interface SignQrCode {
338
338
  * UploadFiles请求参数结构体
339
339
  */
340
340
  export interface UploadFilesRequest {
341
- /**
342
- * 调用方信息
343
- */
344
- Caller: Caller;
345
341
  /**
346
342
  * 文件对应业务类型,用于区分文件存储路径:
347
343
  1. TEMPLATE - 模板; 文件类型:.pdf/.html
348
344
  2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
349
- 3. FLOW - 签署过程 文件类型:.pdf/.html
350
- 4. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
351
- 5. BUSINESSLICENSE - 营业执照 文件类型:.jpg/.jpeg/.png
352
- 6. IDCARD - 身份证 文件类型:.jpg/.jpeg/.png
345
+ 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
353
346
  */
354
347
  BusinessType: string;
348
+ /**
349
+ * 调用方信息
350
+ */
351
+ Caller?: Caller;
355
352
  /**
356
353
  * 上传文件内容数组,最多支持20个文件
357
354
  */
@@ -361,14 +358,14 @@ export interface UploadFilesRequest {
361
358
  */
362
359
  FileUrls?: string;
363
360
  /**
364
- * 是否将pdf灰色矩阵置白
361
+ * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
365
362
  true--是,处理置白
366
363
  false--否,不处理
367
364
  */
368
365
  CoverRect?: boolean;
369
366
  /**
370
- * 特殊文件类型需要指定文件类型:
371
- HTML-- .html文件
367
+ * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
368
+ 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
372
369
  */
373
370
  FileType?: string;
374
371
  /**
@@ -45,7 +45,7 @@ export declare class Client extends AbstractClient {
45
45
  */
46
46
  PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
47
47
  /**
48
- * 创建参与者签署短链
48
+ * 创建跳转小程序查看或签署的链接
49
49
  */
50
50
  CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
51
51
  /**
@@ -79,7 +79,7 @@ class Client extends abstract_client_1.AbstractClient {
79
79
  return this.request("PrepareFlows", req, cb);
80
80
  }
81
81
  /**
82
- * 创建参与者签署短链
82
+ * 创建跳转小程序查看或签署的链接
83
83
  */
84
84
  async CreateSignUrls(req, cb) {
85
85
  return this.request("CreateSignUrls", req, cb);
@@ -350,17 +350,45 @@ export interface CreateSignUrlsRequest {
350
350
  */
351
351
  FlowIds: Array<string>;
352
352
  /**
353
- * 签署链接类型:“WEIXINAPP”-直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;默认“WEIXINAPP”类型,即跳转至小程序。
353
+ * 签署链接类型:“WEIXINAPP”-直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;默认“WEIXINAPP”类型,即跳转至小程序;
354
354
  */
355
355
  Endpoint?: string;
356
356
  /**
357
- * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
357
+ * 签署链接生成类型,默认是 "ALL";
358
+ "ALL":全部签署方签署链接;
359
+ "CHANNEL":渠道合作企业;
360
+ "NOT_CHANNEL":非渠道合作企业;
361
+ "PERSON":个人;
358
362
  */
359
- JumpUrl?: string;
363
+ GenerateType?: string;
364
+ /**
365
+ * 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
366
+ */
367
+ OrganizationName?: string;
368
+ /**
369
+ * 参与人姓名,GenerateType为"PERSON"时必填
370
+ */
371
+ Name?: string;
372
+ /**
373
+ * 参与人手机号,GenerateType为"PERSON"时必填
374
+ */
375
+ Mobile?: string;
376
+ /**
377
+ * 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
378
+ */
379
+ OrganizationOpenId?: string;
380
+ /**
381
+ * 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
382
+ */
383
+ OpenId?: string;
360
384
  /**
361
385
  * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
362
386
  */
363
387
  AutoJumpBack?: boolean;
388
+ /**
389
+ * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
390
+ */
391
+ JumpUrl?: string;
364
392
  /**
365
393
  * 操作者的信息
366
394
  */
@@ -1000,9 +1028,14 @@ export interface UsageDetail {
1000
1028
  */
1001
1029
  Date: string;
1002
1030
  /**
1003
- * 消耗量
1031
+ * 消耗数量
1004
1032
  */
1005
1033
  Usage: number;
1034
+ /**
1035
+ * 撤回数量
1036
+ 注意:此字段可能返回 null,表示取不到有效值。
1037
+ */
1038
+ Cancel: number;
1006
1039
  }
1007
1040
  /**
1008
1041
  * CreateSignUrls返回参数结构体
@@ -1203,7 +1236,7 @@ export interface ChannelCreateFlowByFilesResponse {
1203
1236
  */
1204
1237
  export interface UploadFilesResponse {
1205
1238
  /**
1206
- * 文件id数组
1239
+ * 文件id数组,有效期一个小时
1207
1240
  */
1208
1241
  FileIds: Array<string>;
1209
1242
  /**
@@ -15,6 +15,17 @@ hq: 针对高清晰度视频超分;
15
15
  */
16
16
  Size?: number;
17
17
  }
18
+ /**
19
+ * 动图参数
20
+ */
21
+ export interface DynamicImageInfo {
22
+ /**
23
+ * 画面质量,范围:1~100。
24
+ <li>对于webp格式,默认:75</li>
25
+ <li>对于gif格式,小于10为低质量,大于50为高质量,其它为普通。默认:低质量。</li>
26
+ */
27
+ Quality?: number;
28
+ }
18
29
  /**
19
30
  * 编辑处理/拼接任务/处理结果
20
31
  */
@@ -137,6 +148,14 @@ export interface MediaCuttingTaskResult {
137
148
  注意:此字段可能返回 null,表示取不到有效值。
138
149
  */
139
150
  LastFile: TaskResultFile;
151
+ /**
152
+ * 任务结果包含的图片总数。
153
+ 静态图:总数即为文件数;
154
+ 雪碧图:所有小图总数;
155
+ 动图、视频:不计算图片数,为 0。
156
+ 注意:此字段可能返回 null,表示取不到有效值。
157
+ */
158
+ ImageCount: number;
140
159
  }
141
160
  /**
142
161
  * 智能封面结果项
@@ -152,7 +171,8 @@ export interface CoverTaskResultItem {
152
171
  Confidence: number;
153
172
  }
154
173
  /**
155
- * 编辑处理/剪切任务信息
174
+ * 编辑处理/剪切任务信息。
175
+ 截图结果默认存在 SaveInfoSet 的第一个存储位置。
156
176
  */
157
177
  export interface MediaCuttingInfo {
158
178
  /**
@@ -169,10 +189,19 @@ export interface MediaCuttingInfo {
169
189
  OutForm: MediaCuttingOutForm;
170
190
  /**
171
191
  * 列表文件形式,存储到用户存储服务中,可选值:
172
- UseSaveInfo:默认,结果列表和结果存储同一位置;
173
- NoListFile:不存储结果列表。
192
+ <li>NoListFile:不存储结果列表; </li>
193
+ <li>UseSaveInfo:默认,结果列表和结果存储同一位置(即SaveInfoSet 的第一个存储位置);</li>
194
+ <li>SaveInfoSet 存储的Id:存储在指定的存储位置。</li>
174
195
  */
175
196
  ResultListSaveType?: string;
197
+ /**
198
+ * 水印信息,最多支持 10 个水印。
199
+ */
200
+ WatermarkInfoSet?: Array<MediaCuttingWatermark>;
201
+ /**
202
+ * 是否去除纯色截图,如果值为 True ,对应时间点的截图如果是纯色,将略过。
203
+ */
204
+ DropPureColor?: string;
176
205
  }
177
206
  /**
178
207
  * 周期时间点信息。
@@ -214,11 +243,11 @@ export interface MuxInfo {
214
243
  */
215
244
  export interface TargetVideoInfo {
216
245
  /**
217
- * 视频宽度,单位像素
246
+ * 视频宽度,单位像素,一般要求是偶数,否则会向下对齐。
218
247
  */
219
248
  Width?: number;
220
249
  /**
221
- * 视频高度,单位像素
250
+ * 视频高度,单位像素,一般要求是偶数,否则会向下对齐。
222
251
  */
223
252
  Height?: number;
224
253
  /**
@@ -537,6 +566,11 @@ export interface SaveInfo {
537
566
  * Cos形式存储信息,当Type等于1时必选。
538
567
  */
539
568
  CosInfo?: CosInfo;
569
+ /**
570
+ * 存储信息ID标记,用于多个输出场景。部分任务支持多输出时,一般要求必选。
571
+ ID只能包含字母、数字、下划线、中划线,长读不能超过128。
572
+ */
573
+ Id?: string;
540
574
  }
541
575
  /**
542
576
  * 去划痕参数
@@ -670,7 +704,7 @@ export interface CreateMediaProcessTaskResponse {
670
704
  * 编辑任务 ID,可以通过该 ID 查询任务状态和结果。
671
705
  注意:此字段可能返回 null,表示取不到有效值。
672
706
  */
673
- TaskId?: string;
707
+ TaskId: string;
674
708
  /**
675
709
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
676
710
  */
@@ -695,6 +729,11 @@ export interface TaskResultFile {
695
729
  注意:此字段可能返回 null,表示取不到有效值。
696
730
  */
697
731
  MediaInfo: MediaResultInfo;
732
+ /**
733
+ * 文件对应的md5。
734
+ 注意:此字段可能返回 null,表示取不到有效值。
735
+ */
736
+ Md5: string;
698
737
  }
699
738
  /**
700
739
  * CreateEditingTask返回参数结构体
@@ -703,7 +742,7 @@ export interface CreateEditingTaskResponse {
703
742
  /**
704
743
  * 编辑任务 ID,可以通过该 ID 查询任务状态。
705
744
  */
706
- TaskId?: string;
745
+ TaskId: string;
707
746
  /**
708
747
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
709
748
  */
@@ -815,7 +854,7 @@ export interface ResultVideoInfo {
815
854
  */
816
855
  Height: number;
817
856
  /**
818
- * 视频帧率
857
+ * 视频帧率,如果高于原始帧率,部分服务将无效。
819
858
  注意:此字段可能返回 null,表示取不到有效值。
820
859
  */
821
860
  Fps: number;
@@ -866,6 +905,59 @@ export interface MediaJoiningInfo {
866
905
  其中Format只支持mp4.
867
906
  */
868
907
  TargetInfo: MediaTargetInfo;
908
+ /**
909
+ * 拼接模式:
910
+ Fast:快速;
911
+ Normal:正常;
912
+ */
913
+ Mode?: string;
914
+ }
915
+ /**
916
+ * 媒体剪切文字水印参数。
917
+ */
918
+ export interface MediaCuttingWatermarkText {
919
+ /**
920
+ * 水印文字。
921
+ */
922
+ Text: string;
923
+ /**
924
+ * 文字大小
925
+ */
926
+ FontSize: number;
927
+ /**
928
+ * 水印水平坐标,单位像素,默认:0。
929
+ */
930
+ PosX?: number;
931
+ /**
932
+ * 水印垂直坐标,单位像素,默认:0。
933
+ */
934
+ PosY?: number;
935
+ /**
936
+ * 文字颜色,格式为:#RRGGBBAA,默认值:#000000。
937
+ */
938
+ FontColor?: string;
939
+ /**
940
+ * 文字透明度,范围:0~100,默认值:100。
941
+ */
942
+ FontAlpha?: number;
943
+ /**
944
+ * 指定坐标原点,可选值:
945
+ <li>LeftTop:PosXY 表示水印左上点到图片左上点的相对位置</li>
946
+ <li>RightTop:PosXY 表示水印右上点到图片右上点的相对位置</li>
947
+ <li>LeftBottom:PosXY 表示水印左下点到图片左下点的相对位置</li>
948
+ <li>RightBottom:PosXY 表示水印右下点到图片右下点的相对位置</li>
949
+ <li>Center:PosXY 表示水印中心点到图片中心点的相对位置</li>
950
+ 默认:LeftTop。
951
+ */
952
+ PosOriginType?: string;
953
+ /**
954
+ * 字体,可选值:
955
+ <li>SimHei</li>
956
+ <li>SimKai</li>
957
+ <li>Arial</li>
958
+ 默认 SimHei。
959
+ */
960
+ Font?: string;
869
961
  }
870
962
  /**
871
963
  * DescribeMediaQualityRestorationTaskRusult请求参数结构体
@@ -943,9 +1035,7 @@ index:序号;
943
1035
  */
944
1036
  TargetVideoInfo?: TargetVideoInfo;
945
1037
  /**
946
- * 【不再使用】 对于多输出任务,部分子服务推荐结果信息以列表文件形式,存储到用户存储服务中,可选值:
947
- UseSaveInfo:默认,结果列表和结果存储同一位置;
948
- NoListFile:不存储结果列表。
1038
+ * 【不再使用】
949
1039
  */
950
1040
  ResultListSaveType?: string;
951
1041
  }
@@ -1327,13 +1417,21 @@ Gaussian:高斯模糊;
1327
1417
  */
1328
1418
  FillType?: string;
1329
1419
  /**
1330
- * Type=Sprite时有效,表示雪碧图行数,范围为 [1,200],默认100。
1420
+ * 【废弃】参考SpriteInfo
1331
1421
  */
1332
1422
  SpriteRowCount?: number;
1333
1423
  /**
1334
- * Type=Sprite时有效,表示雪碧图列数,范围为 [1,200],默认100。
1424
+ * 【废弃】参考SpriteInfo
1335
1425
  */
1336
1426
  SpriteColumnCount?: number;
1427
+ /**
1428
+ * Type=Sprite时有效,表示雪碧图参数信息。
1429
+ */
1430
+ SpriteInfo?: SpriteImageInfo;
1431
+ /**
1432
+ * Type=Dynamic时有效,表示动图参数信息。
1433
+ */
1434
+ DynamicInfo?: DynamicImageInfo;
1337
1435
  }
1338
1436
  /**
1339
1437
  * StopMediaQualityRestorationTask请求参数结构体
@@ -1769,6 +1867,48 @@ export interface CosInfo {
1769
1867
  */
1770
1868
  CosAuthMode?: CosAuthMode;
1771
1869
  }
1870
+ /**
1871
+ * 媒体剪切图像水印参数。
1872
+ */
1873
+ export interface MediaCuttingWatermarkImage {
1874
+ /**
1875
+ * 水印源的ID,对应SourceInfoSet内的源。
1876
+ 注意1:对应的 MediaSourceInfo.Type需要为Image。
1877
+ 注意2:对于动图,只取第一帧图像作为水印源。
1878
+ */
1879
+ SourceId: string;
1880
+ /**
1881
+ * 水印水平坐标,单位像素,默认:0。
1882
+ */
1883
+ PosX?: number;
1884
+ /**
1885
+ * 水印垂直坐标,单位像素,默认:0。
1886
+ */
1887
+ PosY?: number;
1888
+ /**
1889
+ * 水印宽度,单位像素,默认:0。
1890
+ */
1891
+ Width?: number;
1892
+ /**
1893
+ * 水印高度,单位像素,默认:0。
1894
+ 注意:对于宽高符合以下规则:
1895
+ 1、Width>0 且 Height>0,按指定宽高拉伸;
1896
+ 2、Width=0 且 Height>0,以Height为基准等比缩放;
1897
+ 3、Width>0 且 Height=0,以Width为基准等比缩放;
1898
+ 4、Width=0 且 Height=0,采用源的宽高。
1899
+ */
1900
+ Height?: number;
1901
+ /**
1902
+ * 指定坐标原点,可选值:
1903
+ <li>LeftTop:PosXY 表示水印左上点到图片左上点的相对位置</li>
1904
+ <li>RightTop:PosXY 表示水印右上点到图片右上点的相对位置</li>
1905
+ <li>LeftBottom:PosXY 表示水印左下点到图片左下点的相对位置</li>
1906
+ <li>RightBottom:PosXY 表示水印右下点到图片右下点的相对位置</li>
1907
+ <li>Center:PosXY 表示水印中心点到图片中心点的相对位置</li>
1908
+ 默认:LeftTop。
1909
+ */
1910
+ PosOriginType?: string;
1911
+ }
1772
1912
  /**
1773
1913
  * 结果文件媒体信息
1774
1914
  */
@@ -2066,6 +2206,56 @@ export interface DescribeMediaProcessTaskResultRequest {
2066
2206
  */
2067
2207
  TaskId: string;
2068
2208
  }
2209
+ /**
2210
+ * 雪碧图参数信息
2211
+ 注意:雪碧图大图整体的宽和高都不能大于 65000 像素。
2212
+ */
2213
+ export interface SpriteImageInfo {
2214
+ /**
2215
+ * 表示雪碧图行数,默认:10。
2216
+ */
2217
+ RowCount?: number;
2218
+ /**
2219
+ * 表示雪碧图列数,默认:10。
2220
+ */
2221
+ ColumnCount?: number;
2222
+ /**
2223
+ * 第一行元素与顶部像素距离,默认:0。
2224
+ */
2225
+ MarginTop?: number;
2226
+ /**
2227
+ * 最后一行元素与底部像素距离,默认:0。
2228
+ */
2229
+ MarginBottom?: number;
2230
+ /**
2231
+ * 最左一行元素与左边像素距离,默认:0。
2232
+ */
2233
+ MarginLeft?: number;
2234
+ /**
2235
+ * 最右一行元素与右边像素距离,默认:0。
2236
+ */
2237
+ MarginRight?: number;
2238
+ /**
2239
+ * 小图与元素顶部像素距离,默认:0。
2240
+ */
2241
+ PaddingTop?: number;
2242
+ /**
2243
+ * 小图与元素底部像素距离,默认:0。
2244
+ */
2245
+ PaddingBottom?: number;
2246
+ /**
2247
+ * 小图与元素左边像素距离,默认:0。
2248
+ */
2249
+ PaddingLeft?: number;
2250
+ /**
2251
+ * 小图与元素右边像素距离,默认:0。
2252
+ */
2253
+ PaddingRight?: number;
2254
+ /**
2255
+ * 背景颜色,格式:#RRGGBB,默认:#FFFFFF。
2256
+ */
2257
+ BackgroundColor?: string;
2258
+ }
2069
2259
  /**
2070
2260
  * 编辑处理/任务处理结果
2071
2261
  */
@@ -2248,7 +2438,7 @@ export interface DescribeMediaProcessTaskResultResponse {
2248
2438
  * 任务处理结果。
2249
2439
  注意:此字段可能返回 null,表示取不到有效值。
2250
2440
  */
2251
- TaskResult?: MediaProcessTaskResult;
2441
+ TaskResult: MediaProcessTaskResult;
2252
2442
  /**
2253
2443
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2254
2444
  */
@@ -2271,3 +2461,22 @@ export interface HighlightsTaskResultItemSegment {
2271
2461
  */
2272
2462
  EndTimeOffset: number;
2273
2463
  }
2464
+ /**
2465
+ * 媒体剪切水印信息。
2466
+ */
2467
+ export interface MediaCuttingWatermark {
2468
+ /**
2469
+ * 水印类型,可选值:
2470
+ <li>Image:图像水印;</li>
2471
+ <li>Text:文字水印。</li>
2472
+ */
2473
+ Type: string;
2474
+ /**
2475
+ * 图像水印信息,当 Type=Image 时必选。
2476
+ */
2477
+ Image?: MediaCuttingWatermarkImage;
2478
+ /**
2479
+ * 文字水印信息,当 Type=Text 时必选。
2480
+ */
2481
+ Text?: MediaCuttingWatermarkText;
2482
+ }