tencentcloud-sdk-nodejs 4.0.200 → 4.0.204

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 +504 -56
  2. package/package.json +1 -1
  3. package/products.md +153 -152
  4. package/src/common/sdk_version.ts +1 -1
  5. package/src/services/af/v20200226/af_client.ts +24 -1
  6. package/src/services/af/v20200226/af_models.ts +243 -0
  7. package/src/services/billing/v20180709/billing_models.ts +34 -4
  8. package/src/services/cdn/v20180606/cdn_models.ts +14 -6
  9. package/src/services/cfw/v20190904/cfw_client.ts +15 -2
  10. package/src/services/cfw/v20190904/cfw_models.ts +138 -37
  11. package/src/services/clb/v20180317/clb_client.ts +17 -0
  12. package/src/services/clb/v20180317/clb_models.ts +165 -0
  13. package/src/services/cme/v20191029/cme_models.ts +11 -3
  14. package/src/services/cvm/v20170312/cvm_models.ts +2 -2
  15. package/src/services/cwp/v20180228/cwp_models.ts +5 -6
  16. package/src/services/dcdb/v20180411/dcdb_models.ts +1 -1
  17. package/src/services/ecm/v20190719/ecm_client.ts +401 -290
  18. package/src/services/ecm/v20190719/ecm_models.ts +4533 -3879
  19. package/src/services/essbasic/index.ts +7 -0
  20. package/src/services/essbasic/v20201222/essbasic_client.ts +736 -0
  21. package/src/services/essbasic/v20201222/essbasic_models.ts +3792 -0
  22. package/src/services/essbasic/v20201222/index.ts +6 -0
  23. package/src/services/essbasic/v20210526/essbasic_client.ts +139 -0
  24. package/src/services/essbasic/v20210526/essbasic_models.ts +822 -0
  25. package/src/services/essbasic/v20210526/index.ts +6 -0
  26. package/src/services/gme/v20180711/gme_models.ts +5 -0
  27. package/src/services/ims/v20201229/ims_client.ts +0 -12
  28. package/src/services/ims/v20201229/ims_models.ts +0 -150
  29. package/src/services/index.ts +1 -0
  30. package/src/services/mariadb/v20170312/mariadb_models.ts +7 -7
  31. package/src/services/partners/v20180321/partners_client.ts +80 -95
  32. package/src/services/partners/v20180321/partners_models.ts +31 -91
  33. package/src/services/rum/v20210622/rum_client.ts +14 -0
  34. package/src/services/rum/v20210622/rum_models.ts +142 -0
  35. package/src/services/sqlserver/v20180328/sqlserver_client.ts +31 -18
  36. package/src/services/sqlserver/v20180328/sqlserver_models.ts +208 -86
  37. package/src/services/tcb/v20180608/tcb_client.ts +1 -0
  38. package/src/services/tcb/v20180608/tcb_models.ts +33 -0
  39. package/src/services/vod/v20180717/vod_client.ts +97 -45
  40. package/src/services/vod/v20180717/vod_models.ts +148 -10
  41. package/tencentcloud/common/sdk_version.d.ts +1 -1
  42. package/tencentcloud/common/sdk_version.js +1 -1
  43. package/tencentcloud/services/af/v20200226/af_client.d.ts +7 -1
  44. package/tencentcloud/services/af/v20200226/af_client.js +8 -0
  45. package/tencentcloud/services/af/v20200226/af_models.d.ts +204 -0
  46. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +31 -1
  47. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +13 -6
  48. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +5 -1
  49. package/tencentcloud/services/cfw/v20190904/cfw_client.js +6 -0
  50. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +117 -33
  51. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +5 -1
  52. package/tencentcloud/services/clb/v20180317/clb_client.js +6 -0
  53. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +140 -0
  54. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +10 -3
  55. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +2 -2
  56. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +5 -6
  57. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +1 -1
  58. package/tencentcloud/services/ecm/v20190719/ecm_client.d.ts +65 -14
  59. package/tencentcloud/services/ecm/v20190719/ecm_client.js +84 -19
  60. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +4147 -3602
  61. package/tencentcloud/services/essbasic/index.d.ts +10 -0
  62. package/tencentcloud/services/essbasic/index.js +9 -0
  63. package/tencentcloud/services/essbasic/v20201222/essbasic_client.d.ts +271 -0
  64. package/tencentcloud/services/essbasic/v20201222/essbasic_client.js +398 -0
  65. package/tencentcloud/services/essbasic/v20201222/essbasic_models.d.ts +3212 -0
  66. package/tencentcloud/services/essbasic/v20201222/essbasic_models.js +18 -0
  67. package/tencentcloud/services/essbasic/v20201222/index.d.ts +6 -0
  68. package/tencentcloud/services/essbasic/v20201222/index.js +9 -0
  69. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +44 -0
  70. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +81 -0
  71. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +683 -0
  72. package/tencentcloud/services/essbasic/v20210526/essbasic_models.js +18 -0
  73. package/tencentcloud/services/essbasic/v20210526/index.d.ts +6 -0
  74. package/tencentcloud/services/essbasic/v20210526/index.js +9 -0
  75. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +4 -0
  76. package/tencentcloud/services/ims/v20201229/ims_client.d.ts +1 -5
  77. package/tencentcloud/services/ims/v20201229/ims_client.js +0 -6
  78. package/tencentcloud/services/ims/v20201229/ims_models.d.ts +0 -124
  79. package/tencentcloud/services/index.d.ts +1 -0
  80. package/tencentcloud/services/index.js +2 -0
  81. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +7 -7
  82. package/tencentcloud/services/partners/v20180321/partners_client.d.ts +29 -35
  83. package/tencentcloud/services/partners/v20180321/partners_client.js +42 -50
  84. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +29 -80
  85. package/tencentcloud/services/rum/v20210622/rum_client.d.ts +5 -1
  86. package/tencentcloud/services/rum/v20210622/rum_client.js +6 -0
  87. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +119 -0
  88. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +10 -6
  89. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +13 -7
  90. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +183 -82
  91. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +28 -0
  92. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +36 -16
  93. package/tencentcloud/services/vod/v20180717/vod_client.js +50 -22
  94. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +129 -8
  95. package/test/af.v20200226.test.js +10 -0
  96. package/test/cfw.v20190904.test.js +10 -0
  97. package/test/clb.v20180317.test.js +10 -0
  98. package/test/ecm.v20190719.test.js +88 -18
  99. package/test/essbasic.v20201222.test.js +551 -0
  100. package/test/essbasic.v20210526.test.js +101 -0
  101. package/test/ims.v20201229.test.js +0 -10
  102. package/test/partners.v20180321.test.js +42 -52
  103. package/test/rum.v20210622.test.js +10 -0
  104. package/test/sqlserver.v20180328.test.js +14 -4
  105. package/test/vod.v20180717.test.js +60 -20
@@ -0,0 +1,6 @@
1
+ import * as Models from "./essbasic_models"
2
+ import { Client } from "./essbasic_client"
3
+ export const v20201222 = {
4
+ Client: Client,
5
+ Models: Models,
6
+ }
@@ -0,0 +1,139 @@
1
+ /* eslint-disable @typescript-eslint/no-unused-vars */
2
+ /*
3
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing,
12
+ * software distributed under the License is distributed on an
13
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ * KIND, either express or implied. See the License for the
15
+ * specific language governing permissions and limitations
16
+ * under the License.
17
+ */
18
+ import { AbstractClient } from "../../../common/abstract_client"
19
+ import { ClientConfig } from "../../../common/interface"
20
+ import {
21
+ SyncProxyOrganizationResponse,
22
+ FlowApproverInfo,
23
+ PrepareFlowsResponse,
24
+ TemplateInfo,
25
+ DescribeTemplatesResponse,
26
+ SyncProxyOrganizationOperatorsRequest,
27
+ CreateSignUrlsRequest,
28
+ Component,
29
+ SignUrlInfo,
30
+ CreateConsoleLoginUrlRequest,
31
+ CreateFlowsByTemplatesResponse,
32
+ ProxyOrganizationOperator,
33
+ SyncProxyOrganizationOperatorsResponse,
34
+ DescribeTemplatesRequest,
35
+ CreateConsoleLoginUrlResponse,
36
+ CreateFlowsByTemplatesRequest,
37
+ SyncProxyOrganizationRequest,
38
+ UsageDetail,
39
+ CreateSignUrlsResponse,
40
+ DescribeUsageRequest,
41
+ PrepareFlowsRequest,
42
+ Agent,
43
+ FormField,
44
+ FlowInfo,
45
+ UserInfo,
46
+ DescribeUsageResponse,
47
+ } from "./essbasic_models"
48
+
49
+ /**
50
+ * essbasic client
51
+ * @class
52
+ */
53
+ export class Client extends AbstractClient {
54
+ constructor(clientConfig: ClientConfig) {
55
+ super("essbasic.tencentcloudapi.com", "2021-05-26", clientConfig)
56
+ }
57
+
58
+ /**
59
+ * 接口(CreateFlowsByTemplates)用于使用多个模板批量创建流程
60
+ */
61
+ async CreateFlowsByTemplates(
62
+ req: CreateFlowsByTemplatesRequest,
63
+ cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void
64
+ ): Promise<CreateFlowsByTemplatesResponse> {
65
+ return this.request("CreateFlowsByTemplates", req, cb)
66
+ }
67
+
68
+ /**
69
+ * 该接口 (PrepareFlows) 用于创建待发起文件
70
+ */
71
+ async PrepareFlows(
72
+ req: PrepareFlowsRequest,
73
+ cb?: (error: string, rep: PrepareFlowsResponse) => void
74
+ ): Promise<PrepareFlowsResponse> {
75
+ return this.request("PrepareFlows", req, cb)
76
+ }
77
+
78
+ /**
79
+ * 根据流程Id批量创建签署参与者签署H5链接
80
+ */
81
+ async CreateSignUrls(
82
+ req: CreateSignUrlsRequest,
83
+ cb?: (error: string, rep: CreateSignUrlsResponse) => void
84
+ ): Promise<CreateSignUrlsResponse> {
85
+ return this.request("CreateSignUrls", req, cb)
86
+ }
87
+
88
+ /**
89
+ * 此接口(CreateConsoleLoginUrl)用于创建电子签控制台登录链接。若企业未激活,调用同步企业信息、同步经办人信息
90
+
91
+ */
92
+ async CreateConsoleLoginUrl(
93
+ req: CreateConsoleLoginUrlRequest,
94
+ cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void
95
+ ): Promise<CreateConsoleLoginUrlResponse> {
96
+ return this.request("CreateConsoleLoginUrl", req, cb)
97
+ }
98
+
99
+ /**
100
+ * 此接口(SyncProxyOrganizationOperators)用于同步渠道合作企业经办人列表
101
+ */
102
+ async SyncProxyOrganizationOperators(
103
+ req: SyncProxyOrganizationOperatorsRequest,
104
+ cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void
105
+ ): Promise<SyncProxyOrganizationOperatorsResponse> {
106
+ return this.request("SyncProxyOrganizationOperators", req, cb)
107
+ }
108
+
109
+ /**
110
+ * 此接口(DescribeUsage)用于获取渠道所有合作企业流量消耗情况。
111
+ 注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
112
+ */
113
+ async DescribeUsage(
114
+ req: DescribeUsageRequest,
115
+ cb?: (error: string, rep: DescribeUsageResponse) => void
116
+ ): Promise<DescribeUsageResponse> {
117
+ return this.request("DescribeUsage", req, cb)
118
+ }
119
+
120
+ /**
121
+ * 此接口(SyncProxyOrganization)用于同步渠道侧企业信息
122
+ */
123
+ async SyncProxyOrganization(
124
+ req: SyncProxyOrganizationRequest,
125
+ cb?: (error: string, rep: SyncProxyOrganizationResponse) => void
126
+ ): Promise<SyncProxyOrganizationResponse> {
127
+ return this.request("SyncProxyOrganization", req, cb)
128
+ }
129
+
130
+ /**
131
+ * 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
132
+ */
133
+ async DescribeTemplates(
134
+ req: DescribeTemplatesRequest,
135
+ cb?: (error: string, rep: DescribeTemplatesResponse) => void
136
+ ): Promise<DescribeTemplatesResponse> {
137
+ return this.request("DescribeTemplates", req, cb)
138
+ }
139
+ }
@@ -0,0 +1,822 @@
1
+ /*
2
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing,
11
+ * software distributed under the License is distributed on an
12
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13
+ * KIND, either express or implied. See the License for the
14
+ * specific language governing permissions and limitations
15
+ * under the License.
16
+ */
17
+
18
+ /**
19
+ * SyncProxyOrganization返回参数结构体
20
+ */
21
+ export interface SyncProxyOrganizationResponse {
22
+ /**
23
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
24
+ */
25
+ RequestId?: string
26
+ }
27
+
28
+ /**
29
+ * 创建流程签署人入参
30
+ */
31
+ export interface FlowApproverInfo {
32
+ /**
33
+ * 签署人姓名
34
+ */
35
+ Name: string
36
+
37
+ /**
38
+ * 签署人手机号,脱敏显示
39
+ */
40
+ Mobile: string
41
+
42
+ /**
43
+ * 经办人身份证号
44
+ */
45
+ IdCardNumber?: string
46
+
47
+ /**
48
+ * 签署完前端跳转的url,暂未使用
49
+ */
50
+ JumpUrl?: string
51
+
52
+ /**
53
+ * 签署截止时间
54
+ */
55
+ Deadline?: number
56
+
57
+ /**
58
+ * 签署完回调url
59
+ */
60
+ CallbackUrl?: string
61
+ }
62
+
63
+ /**
64
+ * PrepareFlows返回参数结构体
65
+ */
66
+ export interface PrepareFlowsResponse {
67
+ /**
68
+ * 待发起文件确认页
69
+ */
70
+ ConfirmUrl: string
71
+
72
+ /**
73
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
74
+ */
75
+ RequestId?: string
76
+ }
77
+
78
+ /**
79
+ * 此结构体 (TemplateInfo) 用于描述模板的信息。
80
+ */
81
+ export interface TemplateInfo {
82
+ /**
83
+ * 模板ID
84
+ */
85
+ TemplateId: string
86
+
87
+ /**
88
+ * 模板名字
89
+ */
90
+ TemplateName: string
91
+
92
+ /**
93
+ * 模板描述信息
94
+ */
95
+ Description: string
96
+
97
+ /**
98
+ * 模板控件信息结构
99
+ */
100
+ Components: Array<Component>
101
+
102
+ /**
103
+ * 签署区模板信息结构
104
+ */
105
+ SignComponents: Array<Component>
106
+
107
+ /**
108
+ * 模板的创建者信息
109
+ */
110
+ Creator: string
111
+
112
+ /**
113
+ * 模板创建的时间戳(精确到秒)
114
+ */
115
+ CreatedOn: number
116
+ }
117
+
118
+ /**
119
+ * DescribeTemplates返回参数结构体
120
+ */
121
+ export interface DescribeTemplatesResponse {
122
+ /**
123
+ * 模板详情
124
+ */
125
+ Templates: Array<TemplateInfo>
126
+
127
+ /**
128
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
129
+ */
130
+ RequestId?: string
131
+ }
132
+
133
+ /**
134
+ * SyncProxyOrganizationOperators请求参数结构体
135
+ */
136
+ export interface SyncProxyOrganizationOperatorsRequest {
137
+ /**
138
+ * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
139
+ */
140
+ OperatorType: string
141
+
142
+ /**
143
+ * 应用信息
144
+ */
145
+ Agent: Agent
146
+
147
+ /**
148
+ * 经办人信息列表
149
+ */
150
+ ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
151
+
152
+ /**
153
+ * 操作者的信息
154
+ */
155
+ Operator?: UserInfo
156
+ }
157
+
158
+ /**
159
+ * CreateSignUrls请求参数结构体
160
+ */
161
+ export interface CreateSignUrlsRequest {
162
+ /**
163
+ * 渠道应用相关信息
164
+ */
165
+ Agent: Agent
166
+
167
+ /**
168
+ * 所签署合同ID数组
169
+ */
170
+ FlowIds: Array<string>
171
+
172
+ /**
173
+ * 操作者的信息
174
+ */
175
+ Operator?: UserInfo
176
+
177
+ /**
178
+ * 签署链接类型,默认:“WEIXINAPP”-直接跳小程序; “CHANNEL”-跳转H5页面
179
+ */
180
+ Endpoint?: string
181
+
182
+ /**
183
+ * 签署完成后H5引导页跳转URL
184
+ */
185
+ JumpUrl?: string
186
+ }
187
+
188
+ /**
189
+ * 此结构体 (Component) 用于描述控件属性。
190
+ */
191
+ export interface Component {
192
+ /**
193
+ * 控件编号
194
+
195
+ 注:
196
+ 当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
197
+ 例:
198
+ 当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
199
+ 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
200
+
201
+ 创建控件时,此值为空
202
+ 查询时返回完整结构
203
+ */
204
+ ComponentId?: string
205
+
206
+ /**
207
+ * 如果是Component控件类型,则可选的字段为:
208
+ TEXT - 普通文本控件;
209
+ DATE - 普通日期控件;跟TEXT相比会有校验逻辑
210
+ 如果是SignComponent控件类型,则可选的字段为
211
+ SIGN_SEAL - 签署印章控件;
212
+ SIGN_DATE - 签署日期控件;
213
+ SIGN_SIGNATURE - 用户签名控件;
214
+ SIGN_PERSONAL_SEAL - 个人签署印章控件;
215
+
216
+ 表单域的控件不能作为印章和签名控件
217
+ */
218
+ ComponentType?: string
219
+
220
+ /**
221
+ * 控件名称
222
+ */
223
+ ComponentName?: string
224
+
225
+ /**
226
+ * 定义控件是否为必填项,默认为false
227
+ */
228
+ ComponentRequired?: boolean
229
+
230
+ /**
231
+ * 控件所属文件的序号 (文档中文件的排列序号)
232
+ */
233
+ FileIndex?: number
234
+
235
+ /**
236
+ * 控件生成的方式:
237
+ NORMAL - 普通控件
238
+ FIELD - 表单域
239
+ KEYWORD - 关键字
240
+ */
241
+ GenerateMode?: string
242
+
243
+ /**
244
+ * 参数控件宽度,默认100,单位px
245
+ 表单域和关键字转换控件不用填
246
+ */
247
+ ComponentWidth?: number
248
+
249
+ /**
250
+ * 参数控件高度,默认100,单位px
251
+ 表单域和关键字转换控件不用填
252
+ */
253
+ ComponentHeight?: number
254
+
255
+ /**
256
+ * 参数控件所在页码
257
+ */
258
+ ComponentPage?: number
259
+
260
+ /**
261
+ * 参数控件X位置,单位px
262
+ */
263
+ ComponentPosX?: number
264
+
265
+ /**
266
+ * 参数控件Y位置,单位px
267
+ */
268
+ ComponentPosY?: number
269
+
270
+ /**
271
+ * 参数控件样式,json格式表述
272
+ 不同类型的控件会有部分非通用参数
273
+ TEXT控件可以指定字体
274
+ 例如:{"FontSize":12}
275
+ */
276
+ ComponentExtra?: string
277
+
278
+ /**
279
+ * 印章 ID,传参 DEFAULT_COMPANY_SEAL 表示使用默认印章。
280
+ 控件填入内容,印章控件里面,如果是手写签名内容为PNG图片格式的base64编码
281
+ */
282
+ ComponentValue?: string
283
+
284
+ /**
285
+ * 日期签署控件的字号,默认为 12
286
+
287
+ 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
288
+ */
289
+ ComponentDateFontSize?: number
290
+
291
+ /**
292
+ * 控件所属文档的Id, 模块相关接口为空值
293
+ */
294
+ DocumentId?: string
295
+
296
+ /**
297
+ * 控件描述
298
+ */
299
+ ComponentDescription?: string
300
+ }
301
+
302
+ /**
303
+ * 签署链接内容
304
+ */
305
+ export interface SignUrlInfo {
306
+ /**
307
+ * 签署链接
308
+ 注意:此字段可能返回 null,表示取不到有效值。
309
+ */
310
+ SignUrl: string
311
+
312
+ /**
313
+ * 链接失效时间
314
+ 注意:此字段可能返回 null,表示取不到有效值。
315
+ */
316
+ Deadline: number
317
+
318
+ /**
319
+ * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
320
+ 注意:此字段可能返回 null,表示取不到有效值。
321
+ */
322
+ SignOrder: number
323
+
324
+ /**
325
+ * 签署人编号
326
+ 注意:此字段可能返回 null,表示取不到有效值。
327
+ */
328
+ SignId: string
329
+
330
+ /**
331
+ * 自定义用户编号
332
+ 注意:此字段可能返回 null,表示取不到有效值。
333
+ */
334
+ CustomUserId: string
335
+
336
+ /**
337
+ * 用户姓名
338
+ 注意:此字段可能返回 null,表示取不到有效值。
339
+ */
340
+ Name: string
341
+
342
+ /**
343
+ * 用户手机号码
344
+ 注意:此字段可能返回 null,表示取不到有效值。
345
+ */
346
+ Mobile: string
347
+
348
+ /**
349
+ * 签署参与者机构名字
350
+ 注意:此字段可能返回 null,表示取不到有效值。
351
+ */
352
+ OrganizationName: string
353
+
354
+ /**
355
+ * 参与者类型:
356
+ ORGANIZATION 企业经办人
357
+ PERSON 自然人
358
+ 注意:此字段可能返回 null,表示取不到有效值。
359
+ */
360
+ ApproverType: string
361
+
362
+ /**
363
+ * 经办人身份证号
364
+ 注意:此字段可能返回 null,表示取不到有效值。
365
+ */
366
+ IdCardNumber: string
367
+
368
+ /**
369
+ * 签署链接对应流程Id
370
+ 注意:此字段可能返回 null,表示取不到有效值。
371
+ */
372
+ FlowId: string
373
+ }
374
+
375
+ /**
376
+ * CreateConsoleLoginUrl请求参数结构体
377
+ */
378
+ export interface CreateConsoleLoginUrlRequest {
379
+ /**
380
+ * 应用信息
381
+ 此接口Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
382
+ */
383
+ Agent: Agent
384
+
385
+ /**
386
+ * 渠道侧合作企业名称
387
+ */
388
+ ProxyOrganizationName: string
389
+
390
+ /**
391
+ * 渠道侧合作企业统一社会信用代码
392
+ */
393
+ UniformSocialCreditCode?: string
394
+
395
+ /**
396
+ * 渠道侧合作企业经办人的姓名
397
+ */
398
+ ProxyOperatorName?: string
399
+
400
+ /**
401
+ * 操作者的信息
402
+ */
403
+ Operator?: UserInfo
404
+ }
405
+
406
+ /**
407
+ * CreateFlowsByTemplates返回参数结构体
408
+ */
409
+ export interface CreateFlowsByTemplatesResponse {
410
+ /**
411
+ * 多个合同ID
412
+ */
413
+ FlowIds: Array<string>
414
+
415
+ /**
416
+ * 渠道的业务信息,限制1024字符
417
+ */
418
+ CustomerData: Array<string>
419
+
420
+ /**
421
+ * 创建消息,对应多个合同ID,
422
+ 成功为“”,创建失败则对应失败消息
423
+ */
424
+ ErrorMessages: Array<string>
425
+
426
+ /**
427
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
428
+ */
429
+ RequestId?: string
430
+ }
431
+
432
+ /**
433
+ * 合作企业经办人列表信息
434
+ */
435
+ export interface ProxyOrganizationOperator {
436
+ /**
437
+ * 经办人ID(渠道颁发)
438
+ */
439
+ Id: string
440
+
441
+ /**
442
+ * 经办人姓名
443
+ */
444
+ Name?: string
445
+
446
+ /**
447
+ * 经办人身份证件类型
448
+ 用户证件类型:默认ID_CARD
449
+ 1. ID_CARD - 居民身份证
450
+ 2. HOUSEHOLD_REGISTER - 户口本
451
+ 3. TEMP_ID_CARD - 临时居民身份证
452
+ */
453
+ IdCardType?: string
454
+
455
+ /**
456
+ * 经办人身份证号
457
+ */
458
+ IdCardNumber?: string
459
+
460
+ /**
461
+ * 经办人手机号
462
+ */
463
+ Mobile?: string
464
+ }
465
+
466
+ /**
467
+ * SyncProxyOrganizationOperators返回参数结构体
468
+ */
469
+ export interface SyncProxyOrganizationOperatorsResponse {
470
+ /**
471
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
472
+ */
473
+ RequestId?: string
474
+ }
475
+
476
+ /**
477
+ * DescribeTemplates请求参数结构体
478
+ */
479
+ export interface DescribeTemplatesRequest {
480
+ /**
481
+ * 渠道应用相关信息
482
+ */
483
+ Agent: Agent
484
+
485
+ /**
486
+ * 操作者的信息
487
+ */
488
+ Operator?: UserInfo
489
+ }
490
+
491
+ /**
492
+ * CreateConsoleLoginUrl返回参数结构体
493
+ */
494
+ export interface CreateConsoleLoginUrlResponse {
495
+ /**
496
+ * 控制台url
497
+ */
498
+ ConsoleUrl: string
499
+
500
+ /**
501
+ * 渠道合作企业是否认证开通腾讯电子签。
502
+ 当渠道合作企业未完成认证开通腾讯电子签,建议先调用同步企业信息(SyncProxyOrganization)和同步经办人信息(SyncProxyOrganizationOperators)接口成功后再跳转到登录页面。
503
+ */
504
+ IsActivated: boolean
505
+
506
+ /**
507
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
508
+ */
509
+ RequestId?: string
510
+ }
511
+
512
+ /**
513
+ * CreateFlowsByTemplates请求参数结构体
514
+ */
515
+ export interface CreateFlowsByTemplatesRequest {
516
+ /**
517
+ * 渠道应用相关信息
518
+ */
519
+ Agent: Agent
520
+
521
+ /**
522
+ * 多个合同(流程)信息
523
+ */
524
+ FlowInfos: Array<FlowInfo>
525
+
526
+ /**
527
+ * 操作者的信息
528
+ */
529
+ Operator?: UserInfo
530
+ }
531
+
532
+ /**
533
+ * SyncProxyOrganization请求参数结构体
534
+ */
535
+ export interface SyncProxyOrganizationRequest {
536
+ /**
537
+ * 应用信息
538
+ 此接口Agent.ProxyOrganizationOpenId必填
539
+ */
540
+ Agent: Agent
541
+
542
+ /**
543
+ * 渠道侧合作企业名称
544
+ */
545
+ ProxyOrganizationName: string
546
+
547
+ /**
548
+ * 渠道侧合作企业统一社会信用代码
549
+ */
550
+ UniformSocialCreditCode?: string
551
+
552
+ /**
553
+ * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
554
+ */
555
+ BusinessLicense?: string
556
+
557
+ /**
558
+ * 操作者的信息
559
+ */
560
+ Operator?: UserInfo
561
+ }
562
+
563
+ /**
564
+ * 用量明细
565
+ */
566
+ export interface UsageDetail {
567
+ /**
568
+ * 渠道侧合作企业唯一标识
569
+ */
570
+ ProxyOrganizationOpenId: string
571
+
572
+ /**
573
+ * 消耗量
574
+ */
575
+ Usage: number
576
+
577
+ /**
578
+ * 日期,当需要汇总数据时日期为空
579
+ 注意:此字段可能返回 null,表示取不到有效值。
580
+ */
581
+ Date: string
582
+ }
583
+
584
+ /**
585
+ * CreateSignUrls返回参数结构体
586
+ */
587
+ export interface CreateSignUrlsResponse {
588
+ /**
589
+ * 签署参与者签署H5链接信息数组
590
+ */
591
+ SignUrlInfos: Array<SignUrlInfo>
592
+
593
+ /**
594
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
595
+ */
596
+ RequestId?: string
597
+ }
598
+
599
+ /**
600
+ * DescribeUsage请求参数结构体
601
+ */
602
+ export interface DescribeUsageRequest {
603
+ /**
604
+ * 应用信息
605
+ */
606
+ Agent: Agent
607
+
608
+ /**
609
+ * 开始时间 eg:2021-03-21
610
+ */
611
+ StartDate: string
612
+
613
+ /**
614
+ * 结束时间 eg:2021-06-21
615
+ 开始时间到结束时间的区间长度小于等于90天
616
+ */
617
+ EndDate: string
618
+
619
+ /**
620
+ * 操作者的信息
621
+ */
622
+ Operator?: UserInfo
623
+
624
+ /**
625
+ * 是否汇总数据,默认不汇总
626
+ 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数
627
+ 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据
628
+ */
629
+ NeedAggregate?: boolean
630
+
631
+ /**
632
+ * 单次返回的最多条目数量,默认为1000,且不能超过1000
633
+ */
634
+ Limit?: number
635
+
636
+ /**
637
+ * 偏移量,默认是0
638
+ */
639
+ Offset?: number
640
+ }
641
+
642
+ /**
643
+ * PrepareFlows请求参数结构体
644
+ */
645
+ export interface PrepareFlowsRequest {
646
+ /**
647
+ * 渠道应用相关信息
648
+ */
649
+ Agent: Agent
650
+
651
+ /**
652
+ * 多个合同(流程)信息
653
+ */
654
+ FlowInfos: Array<FlowInfo>
655
+
656
+ /**
657
+ * 操作完成后的跳转地址
658
+ */
659
+ JumpUrl: string
660
+
661
+ /**
662
+ * 操作者的信息
663
+ */
664
+ Operator?: UserInfo
665
+ }
666
+
667
+ /**
668
+ * 应用相关信息
669
+ */
670
+ export interface Agent {
671
+ /**
672
+ * 腾讯电子签颁发给渠道的应用ID,32位字符串
673
+ */
674
+ AppId: string
675
+
676
+ /**
677
+ * 腾讯电子签颁发给渠道侧合作企业的企业ID
678
+ */
679
+ ProxyOrganizationId?: string
680
+
681
+ /**
682
+ * 腾讯电子签颁发给渠道侧合作企业的应用ID
683
+ */
684
+ ProxyAppId?: string
685
+
686
+ /**
687
+ * 渠道/平台合作企业经办人(操作员)
688
+ */
689
+ ProxyOperator?: UserInfo
690
+
691
+ /**
692
+ * 渠道/平台合作企业的企业ID
693
+ */
694
+ ProxyOrganizationOpenId?: string
695
+ }
696
+
697
+ /**
698
+ * 此结构 (FormField) 用于描述内容控件填充结构。
699
+ */
700
+ export interface FormField {
701
+ /**
702
+ * 表单域或控件的Value
703
+ */
704
+ ComponentValue: string
705
+
706
+ /**
707
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空
708
+ 注意:此字段可能返回 null,表示取不到有效值。
709
+ */
710
+ ComponentId?: string
711
+
712
+ /**
713
+ * 控件的名字,跟ComponentId二选一,不能全为空
714
+ 注意:此字段可能返回 null,表示取不到有效值。
715
+ */
716
+ ComponentName?: string
717
+ }
718
+
719
+ /**
720
+ * 此结构体 (FlowInfo) 用于描述流程信息。
721
+ */
722
+ export interface FlowInfo {
723
+ /**
724
+ * 合同名字
725
+ */
726
+ FlowName: string
727
+
728
+ /**
729
+ * 签署截止时间戳,超过有效签署时间则该签署流程失败
730
+ */
731
+ Deadline: number
732
+
733
+ /**
734
+ * 模版ID
735
+ */
736
+ TemplateId?: string
737
+
738
+ /**
739
+ * 合同类型:
740
+ 1. “劳务”
741
+ 2. “销售”
742
+ 3. “租赁”
743
+ 4. “其他”
744
+ */
745
+ FlowType?: string
746
+
747
+ /**
748
+ * 回调地址
749
+ */
750
+ CallbackUrl?: string
751
+
752
+ /**
753
+ * 多个签署人信息
754
+ */
755
+ FlowApprovers?: Array<FlowApproverInfo>
756
+
757
+ /**
758
+ * 表单K-V对列表
759
+ */
760
+ FormFields?: Array<FormField>
761
+
762
+ /**
763
+ * 合同描述
764
+ */
765
+ FlowDescription?: string
766
+
767
+ /**
768
+ * 渠道的业务信息,限制1024字符
769
+ */
770
+ CustomerData?: string
771
+ }
772
+
773
+ /**
774
+ * 接口调用者信息
775
+ */
776
+ export interface UserInfo {
777
+ /**
778
+ * 自定义用户编号
779
+ */
780
+ CustomUserId?: string
781
+
782
+ /**
783
+ * 用户的来源渠道
784
+ */
785
+ Channel?: string
786
+
787
+ /**
788
+ * 用户在渠道的编号
789
+ */
790
+ OpenId?: string
791
+
792
+ /**
793
+ * 用户真实IP
794
+ */
795
+ ClientIp?: string
796
+
797
+ /**
798
+ * 用户代理IP
799
+ */
800
+ ProxyIp?: string
801
+ }
802
+
803
+ /**
804
+ * DescribeUsage返回参数结构体
805
+ */
806
+ export interface DescribeUsageResponse {
807
+ /**
808
+ * 用量明细条数
809
+ */
810
+ Total: number
811
+
812
+ /**
813
+ * 用量明细
814
+ 注意:此字段可能返回 null,表示取不到有效值。
815
+ */
816
+ Details: Array<UsageDetail>
817
+
818
+ /**
819
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
820
+ */
821
+ RequestId?: string
822
+ }