tencentcloud-sdk-nodejs 4.0.499 → 4.0.500

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.
@@ -63,118 +63,6 @@ export declare class Client extends AbstractClient {
63
63
  * 创建签署流程电子文档
64
64
  适用场景:见创建签署流程接口。
65
65
  注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
66
-
67
- 【动态表格传参说明】
68
- 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
69
- 输入示例1:
70
-
71
- ```
72
- {
73
- "headers":[
74
- {
75
- "content":"head1"
76
- },
77
- {
78
- "content":"head2"
79
- },
80
- {
81
- "content":"head3"
82
- }
83
- ],
84
- "rowCount":3,
85
- "body":{
86
- "cells":[
87
- {
88
- "rowStart":1,
89
- "rowEnd":1,
90
- "columnStart":1,
91
- "columnEnd":1,
92
- "content":"123"
93
- },
94
- {
95
- "rowStart":2,
96
- "rowEnd":3,
97
- "columnStart":1,
98
- "columnEnd":2,
99
- "content":"456"
100
- },
101
- {
102
- "rowStart":3,
103
- "rowEnd":3,
104
- "columnStart":3,
105
- "columnEnd":3,
106
- "content":"789"
107
- }
108
- ]
109
- }
110
- }
111
-
112
- ```
113
-
114
- 输入示例2(表格表头宽度比例配置):
115
-
116
- ```
117
- {
118
- "headers":[
119
- {
120
- "content":"head1",
121
- "widthPercent": 30
122
- },
123
- {
124
- "content":"head2",
125
- "widthPercent": 30
126
- },
127
- {
128
- "content":"head3",
129
- "widthPercent": 40
130
- }
131
- ],
132
- "rowCount":3,
133
- "body":{
134
- "cells":[
135
- {
136
- "rowStart":1,
137
- "rowEnd":1,
138
- "columnStart":1,
139
- "columnEnd":1,
140
- "content":"123"
141
- },
142
- {
143
- "rowStart":2,
144
- "rowEnd":3,
145
- "columnStart":1,
146
- "columnEnd":2,
147
- "content":"456"
148
- },
149
- {
150
- "rowStart":3,
151
- "rowEnd":3,
152
- "columnStart":3,
153
- "columnEnd":3,
154
- "content":"789"
155
- }
156
- ]
157
- }
158
- }
159
-
160
- ```
161
- 表格参数说明
162
-
163
- | 名称 | 类型 | 描述 |
164
- | ------------------- | ------- | ------------------------------------------------- |
165
- | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
166
- | rowCount | Integer | 表格内容最大行数 |
167
- | cells.N.rowStart | Integer | 单元格坐标:行起始index |
168
- | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
169
- | cells.N.columnStart | Integer | 单元格坐标:列起始index |
170
- | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
171
- | cells.N.content | String | 单元格内容,字数不超过100 |
172
-
173
- 表格参数headers说明
174
- | 名称 | 类型 | 描述 |
175
- | ------------------- | ------- | ------------------------------------------------- |
176
- | widthPercent | Integer | 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35 |
177
- | content | String | 表头单元格内容,字数不超过100 |
178
66
  */
179
67
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
180
68
  /**
@@ -234,7 +122,7 @@ export declare class Client extends AbstractClient {
234
122
  /**
235
123
  * 此接口(UploadFiles)用于文件上传。
236
124
  适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
237
- 调用时需要设置Domain file.ess.tencent.cn,设置Version2020-12-22
125
+ 调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,并设置参数Version/版本号为2020-12-22
238
126
  */
239
127
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
240
128
  /**
@@ -101,118 +101,6 @@ class Client extends abstract_client_1.AbstractClient {
101
101
  * 创建签署流程电子文档
102
102
  适用场景:见创建签署流程接口。
103
103
  注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
104
-
105
- 【动态表格传参说明】
106
- 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
107
- 输入示例1:
108
-
109
- ```
110
- {
111
- "headers":[
112
- {
113
- "content":"head1"
114
- },
115
- {
116
- "content":"head2"
117
- },
118
- {
119
- "content":"head3"
120
- }
121
- ],
122
- "rowCount":3,
123
- "body":{
124
- "cells":[
125
- {
126
- "rowStart":1,
127
- "rowEnd":1,
128
- "columnStart":1,
129
- "columnEnd":1,
130
- "content":"123"
131
- },
132
- {
133
- "rowStart":2,
134
- "rowEnd":3,
135
- "columnStart":1,
136
- "columnEnd":2,
137
- "content":"456"
138
- },
139
- {
140
- "rowStart":3,
141
- "rowEnd":3,
142
- "columnStart":3,
143
- "columnEnd":3,
144
- "content":"789"
145
- }
146
- ]
147
- }
148
- }
149
-
150
- ```
151
-
152
- 输入示例2(表格表头宽度比例配置):
153
-
154
- ```
155
- {
156
- "headers":[
157
- {
158
- "content":"head1",
159
- "widthPercent": 30
160
- },
161
- {
162
- "content":"head2",
163
- "widthPercent": 30
164
- },
165
- {
166
- "content":"head3",
167
- "widthPercent": 40
168
- }
169
- ],
170
- "rowCount":3,
171
- "body":{
172
- "cells":[
173
- {
174
- "rowStart":1,
175
- "rowEnd":1,
176
- "columnStart":1,
177
- "columnEnd":1,
178
- "content":"123"
179
- },
180
- {
181
- "rowStart":2,
182
- "rowEnd":3,
183
- "columnStart":1,
184
- "columnEnd":2,
185
- "content":"456"
186
- },
187
- {
188
- "rowStart":3,
189
- "rowEnd":3,
190
- "columnStart":3,
191
- "columnEnd":3,
192
- "content":"789"
193
- }
194
- ]
195
- }
196
- }
197
-
198
- ```
199
- 表格参数说明
200
-
201
- | 名称 | 类型 | 描述 |
202
- | ------------------- | ------- | ------------------------------------------------- |
203
- | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
204
- | rowCount | Integer | 表格内容最大行数 |
205
- | cells.N.rowStart | Integer | 单元格坐标:行起始index |
206
- | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
207
- | cells.N.columnStart | Integer | 单元格坐标:列起始index |
208
- | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
209
- | cells.N.content | String | 单元格内容,字数不超过100 |
210
-
211
- 表格参数headers说明
212
- | 名称 | 类型 | 描述 |
213
- | ------------------- | ------- | ------------------------------------------------- |
214
- | widthPercent | Integer | 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35 |
215
- | content | String | 表头单元格内容,字数不超过100 |
216
104
  */
217
105
  async CreateDocument(req, cb) {
218
106
  return this.request("CreateDocument", req, cb);
@@ -296,7 +184,7 @@ class Client extends abstract_client_1.AbstractClient {
296
184
  /**
297
185
  * 此接口(UploadFiles)用于文件上传。
298
186
  适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
299
- 调用时需要设置Domain file.ess.tencent.cn,设置Version2020-12-22
187
+ 调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,并设置参数Version/版本号为2020-12-22
300
188
  */
301
189
  async UploadFiles(req, cb) {
302
190
  return this.request("UploadFiles", req, cb);
@@ -98,7 +98,7 @@ export interface UploadFilesRequest {
98
98
  */
99
99
  BusinessType: string;
100
100
  /**
101
- * 调用方信息
101
+ * 调用方信息,其中OperatorId为必填字段,即用户的UserId
102
102
  */
103
103
  Caller?: Caller;
104
104
  /**
@@ -106,24 +106,24 @@ export interface UploadFilesRequest {
106
106
  */
107
107
  FileInfos?: Array<UploadFile>;
108
108
  /**
109
- * 不再使用,上传文件链接数组,最多支持20个URL
109
+ * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
110
+ 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
110
111
  */
111
- FileUrls?: string;
112
+ FileType?: string;
112
113
  /**
113
114
  * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
114
115
  true--是,处理置白
115
- false--否,不处理
116
+ 默认为false--否,不处理
116
117
  */
117
118
  CoverRect?: boolean;
118
- /**
119
- * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
120
- 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
121
- */
122
- FileType?: string;
123
119
  /**
124
120
  * 用户自定义ID数组,与上传文件一一对应
125
121
  */
126
122
  CustomIds?: Array<string>;
123
+ /**
124
+ * 不再使用,上传文件链接数组,最多支持20个URL
125
+ */
126
+ FileUrls?: string;
127
127
  }
128
128
  /**
129
129
  * CreateMultiFlowSignQRCode返回参数结构体
@@ -1088,7 +1088,117 @@ export interface DescribeFileUrlsRequest {
1088
1088
  Agent?: Agent;
1089
1089
  }
1090
1090
  /**
1091
- * 电子文档的控件填充信息
1091
+ * 电子文档的控件填充信息。按照控件类型进行相应的填充。
1092
+
1093
+ 【数据表格传参说明】
1094
+ 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
1095
+ 输入示例1:
1096
+
1097
+ ```
1098
+ {
1099
+ "headers":[
1100
+ {
1101
+ "content":"head1"
1102
+ },
1103
+ {
1104
+ "content":"head2"
1105
+ },
1106
+ {
1107
+ "content":"head3"
1108
+ }
1109
+ ],
1110
+ "rowCount":3,
1111
+ "body":{
1112
+ "cells":[
1113
+ {
1114
+ "rowStart":1,
1115
+ "rowEnd":1,
1116
+ "columnStart":1,
1117
+ "columnEnd":1,
1118
+ "content":"123"
1119
+ },
1120
+ {
1121
+ "rowStart":2,
1122
+ "rowEnd":3,
1123
+ "columnStart":1,
1124
+ "columnEnd":2,
1125
+ "content":"456"
1126
+ },
1127
+ {
1128
+ "rowStart":3,
1129
+ "rowEnd":3,
1130
+ "columnStart":3,
1131
+ "columnEnd":3,
1132
+ "content":"789"
1133
+ }
1134
+ ]
1135
+ }
1136
+ }
1137
+
1138
+ ```
1139
+
1140
+ 输入示例2(表格表头宽度比例配置):
1141
+
1142
+ ```
1143
+ {
1144
+ "headers":[
1145
+ {
1146
+ "content":"head1",
1147
+ "widthPercent": 30
1148
+ },
1149
+ {
1150
+ "content":"head2",
1151
+ "widthPercent": 30
1152
+ },
1153
+ {
1154
+ "content":"head3",
1155
+ "widthPercent": 40
1156
+ }
1157
+ ],
1158
+ "rowCount":3,
1159
+ "body":{
1160
+ "cells":[
1161
+ {
1162
+ "rowStart":1,
1163
+ "rowEnd":1,
1164
+ "columnStart":1,
1165
+ "columnEnd":1,
1166
+ "content":"123"
1167
+ },
1168
+ {
1169
+ "rowStart":2,
1170
+ "rowEnd":3,
1171
+ "columnStart":1,
1172
+ "columnEnd":2,
1173
+ "content":"456"
1174
+ },
1175
+ {
1176
+ "rowStart":3,
1177
+ "rowEnd":3,
1178
+ "columnStart":3,
1179
+ "columnEnd":3,
1180
+ "content":"789"
1181
+ }
1182
+ ]
1183
+ }
1184
+ }
1185
+
1186
+ ```
1187
+ 表格参数说明
1188
+
1189
+ | 名称 | 类型 | 描述 |
1190
+ | ------------------- | ------- | ------------------------------------------------- |
1191
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
1192
+ | rowCount | Integer | 表格内容最大行数 |
1193
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
1194
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
1195
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
1196
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
1197
+ | cells.N.content | String | 单元格内容,字数不超过100 |
1198
+
1199
+ 表格参数headers说明
1200
+ widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
1201
+ content String 表头单元格内容,字数不超过100
1092
1202
  */
1093
1203
  export interface FormField {
1094
1204
  /**
@@ -1768,7 +1878,7 @@ export interface CreatePrepareFlowRequest {
1768
1878
  */
1769
1879
  Operator: UserInfo;
1770
1880
  /**
1771
- * 资源Id,通过上传uploadfile接口获得
1881
+ * 资源Id,通过多文件上传(UploadFiles)接口获得
1772
1882
  */
1773
1883
  ResourceId: string;
1774
1884
  /**
@@ -1161,8 +1161,8 @@ CreateFlowsByTemplates 接口不使用此字段。
1161
1161
  /**
1162
1162
  * 此结构体 (FlowInfo) 用于描述签署流程信息。
1163
1163
 
1164
- 【动态表格传参说明】
1165
- 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
1164
+ 【数据表格传参说明】
1165
+ 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
1166
1166
  输入示例1:
1167
1167
 
1168
1168
  ```