@aurigma/axios-design-atoms-api-client 2.17.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +9 -0
- package/README.md +94 -0
- package/dist/cjs/design-atoms-api-client.d.ts +1139 -0
- package/dist/cjs/design-atoms-api-client.js +4215 -0
- package/dist/cjs/design-atoms-api-client.js.map +1 -0
- package/dist/esm/design-atoms-api-client.d.ts +1139 -0
- package/dist/esm/design-atoms-api-client.js +4205 -0
- package/dist/esm/design-atoms-api-client.js.map +1 -0
- package/package.json +36 -0
|
@@ -0,0 +1,1139 @@
|
|
|
1
|
+
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
|
|
2
|
+
export declare class ApiClientConfiguration {
|
|
3
|
+
apiUrl: string;
|
|
4
|
+
apiKey: string;
|
|
5
|
+
private authorizationToken;
|
|
6
|
+
getAuthorizationToken(): Promise<string>;
|
|
7
|
+
setAuthorizationToken(token: string): void;
|
|
8
|
+
}
|
|
9
|
+
export declare class ApiClientBase {
|
|
10
|
+
private configuration;
|
|
11
|
+
constructor(configuration: ApiClientConfiguration);
|
|
12
|
+
protected transformOptions(options: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
|
13
|
+
protected getBaseUrl(defultUrl: string): string;
|
|
14
|
+
protected transformResult(url: string, res: AxiosResponse, cb: (res: AxiosResponse) => Promise<any>): Promise<any>;
|
|
15
|
+
}
|
|
16
|
+
export interface IBuildInfoApiClient {
|
|
17
|
+
/**
|
|
18
|
+
* Gets assembly build info
|
|
19
|
+
* @return Success
|
|
20
|
+
*/
|
|
21
|
+
headInfo(): Promise<void>;
|
|
22
|
+
/**
|
|
23
|
+
* Gets assembly build info
|
|
24
|
+
* @return Success
|
|
25
|
+
*/
|
|
26
|
+
getInfo(): Promise<BuildInfoModel>;
|
|
27
|
+
}
|
|
28
|
+
export declare class BuildInfoApiClient extends ApiClientBase implements IBuildInfoApiClient {
|
|
29
|
+
private instance;
|
|
30
|
+
private baseUrl;
|
|
31
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
32
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
33
|
+
/**
|
|
34
|
+
* Gets assembly build info
|
|
35
|
+
* @return Success
|
|
36
|
+
*/
|
|
37
|
+
headInfo(cancelToken?: CancelToken | undefined): Promise<void>;
|
|
38
|
+
protected processHeadInfo(response: AxiosResponse): Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* Gets assembly build info
|
|
41
|
+
* @return Success
|
|
42
|
+
*/
|
|
43
|
+
getInfo(cancelToken?: CancelToken | undefined): Promise<BuildInfoModel>;
|
|
44
|
+
protected processGetInfo(response: AxiosResponse): Promise<BuildInfoModel>;
|
|
45
|
+
}
|
|
46
|
+
export interface IDesignAtomsCompatibilityApiClient {
|
|
47
|
+
/**
|
|
48
|
+
* @param body (optional)
|
|
49
|
+
* @return Success
|
|
50
|
+
*/
|
|
51
|
+
cssFonts(tenantId: number, body?: FontsMethodData | null | undefined): Promise<string>;
|
|
52
|
+
/**
|
|
53
|
+
* @return Success
|
|
54
|
+
*/
|
|
55
|
+
fonts(tenantId: number, psName: string | null): Promise<FileResponse>;
|
|
56
|
+
/**
|
|
57
|
+
* @param fontKey (optional)
|
|
58
|
+
* @return Success
|
|
59
|
+
*/
|
|
60
|
+
getCssFont(tenantId: number, fontKey?: string | null | undefined): Promise<FileResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* @param body (optional)
|
|
63
|
+
* @return Success
|
|
64
|
+
*/
|
|
65
|
+
getImageSize(tenantId: number, body?: GetImageSizeRequest | null | undefined): Promise<NullAbleSize>;
|
|
66
|
+
/**
|
|
67
|
+
* @param body (optional)
|
|
68
|
+
* @return Success
|
|
69
|
+
*/
|
|
70
|
+
getShapeBounds(tenantId: number, body?: GetShapeBoundsRequest | null | undefined): Promise<RectangleF>;
|
|
71
|
+
/**
|
|
72
|
+
* @param body (optional)
|
|
73
|
+
* @return Success
|
|
74
|
+
*/
|
|
75
|
+
getWatermarkItems(tenantId: number, body?: any | null | undefined): Promise<any>;
|
|
76
|
+
/**
|
|
77
|
+
* @param f (optional)
|
|
78
|
+
* @param w (optional)
|
|
79
|
+
* @param h (optional)
|
|
80
|
+
* @param cmyk (optional)
|
|
81
|
+
* @param rgb (optional)
|
|
82
|
+
* @param grayscale (optional)
|
|
83
|
+
* @param target (optional)
|
|
84
|
+
* @param sq (optional)
|
|
85
|
+
* @param effect (optional)
|
|
86
|
+
* @param kp (optional)
|
|
87
|
+
* @param color (optional)
|
|
88
|
+
* @param obm (optional)
|
|
89
|
+
* @param oo (optional)
|
|
90
|
+
* @param alphaMask (optional)
|
|
91
|
+
* @param page (optional)
|
|
92
|
+
* @param colorizeColor (optional)
|
|
93
|
+
* @return Success
|
|
94
|
+
*/
|
|
95
|
+
img(tenantId: number, f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined): Promise<FileResponse>;
|
|
96
|
+
/**
|
|
97
|
+
* @return Success
|
|
98
|
+
*/
|
|
99
|
+
getLicense(tenantId: number): Promise<string>;
|
|
100
|
+
/**
|
|
101
|
+
* @param f (optional)
|
|
102
|
+
* @return Success
|
|
103
|
+
*/
|
|
104
|
+
pth(tenantId: number, f?: string | null | undefined): Promise<FileResponse>;
|
|
105
|
+
/**
|
|
106
|
+
* @param image (optional)
|
|
107
|
+
* @return Success
|
|
108
|
+
*/
|
|
109
|
+
resource(tenantId: number, image?: string | null | undefined): Promise<FileResponse>;
|
|
110
|
+
/**
|
|
111
|
+
* @param f (optional)
|
|
112
|
+
* @return Success
|
|
113
|
+
*/
|
|
114
|
+
svg(tenantId: number, f?: string | null | undefined): Promise<FileResponse>;
|
|
115
|
+
/**
|
|
116
|
+
* @param f (optional)
|
|
117
|
+
* @return Success
|
|
118
|
+
*/
|
|
119
|
+
txt(tenantId: number, f?: string | null | undefined): Promise<FileResponse>;
|
|
120
|
+
/**
|
|
121
|
+
* @param body (optional)
|
|
122
|
+
* @return Success
|
|
123
|
+
*/
|
|
124
|
+
updateArchedTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
125
|
+
/**
|
|
126
|
+
* @param body (optional)
|
|
127
|
+
* @return Success
|
|
128
|
+
*/
|
|
129
|
+
updateAutoScaledTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
130
|
+
/**
|
|
131
|
+
* @param body (optional)
|
|
132
|
+
* @return Success
|
|
133
|
+
*/
|
|
134
|
+
updateBarcodeItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
135
|
+
/**
|
|
136
|
+
* @param body (optional)
|
|
137
|
+
* @return Success
|
|
138
|
+
*/
|
|
139
|
+
updateBoundedTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
140
|
+
/**
|
|
141
|
+
* @param body (optional)
|
|
142
|
+
* @return Success
|
|
143
|
+
*/
|
|
144
|
+
updateByColorData(tenantId: number, body?: UpdateColorsRequest | null | undefined): Promise<string>;
|
|
145
|
+
/**
|
|
146
|
+
* @param body (optional)
|
|
147
|
+
* @return Success
|
|
148
|
+
*/
|
|
149
|
+
updateByMultiCallRequest(tenantId: number, body?: MultiCallRequest | null | undefined): Promise<any>;
|
|
150
|
+
/**
|
|
151
|
+
* @param body (optional)
|
|
152
|
+
* @return Success
|
|
153
|
+
*/
|
|
154
|
+
updateCurvedTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
155
|
+
/**
|
|
156
|
+
* @param body (optional)
|
|
157
|
+
* @return Success
|
|
158
|
+
*/
|
|
159
|
+
updateImageItemHandler(tenantId: number, body?: UpdateImageHandlerRequest | null | undefined): Promise<any>;
|
|
160
|
+
/**
|
|
161
|
+
* @param body (optional)
|
|
162
|
+
* @return Success
|
|
163
|
+
*/
|
|
164
|
+
updatePathBoundedTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
165
|
+
/**
|
|
166
|
+
* @param body (optional)
|
|
167
|
+
* @return Success
|
|
168
|
+
*/
|
|
169
|
+
updatePlainTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
170
|
+
/**
|
|
171
|
+
* @param body (optional)
|
|
172
|
+
* @return Success
|
|
173
|
+
*/
|
|
174
|
+
updateShapeItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
175
|
+
}
|
|
176
|
+
export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase implements IDesignAtomsCompatibilityApiClient {
|
|
177
|
+
private instance;
|
|
178
|
+
private baseUrl;
|
|
179
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
180
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
181
|
+
/**
|
|
182
|
+
* @param body (optional)
|
|
183
|
+
* @return Success
|
|
184
|
+
*/
|
|
185
|
+
cssFonts(tenantId: number, body?: FontsMethodData | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
|
|
186
|
+
protected processCssFonts(response: AxiosResponse): Promise<string>;
|
|
187
|
+
/**
|
|
188
|
+
* @return Success
|
|
189
|
+
*/
|
|
190
|
+
fonts(tenantId: number, psName: string | null, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
191
|
+
protected processFonts(response: AxiosResponse): Promise<FileResponse>;
|
|
192
|
+
/**
|
|
193
|
+
* @param fontKey (optional)
|
|
194
|
+
* @return Success
|
|
195
|
+
*/
|
|
196
|
+
getCssFont(tenantId: number, fontKey?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
197
|
+
protected processGetCssFont(response: AxiosResponse): Promise<FileResponse>;
|
|
198
|
+
/**
|
|
199
|
+
* @param body (optional)
|
|
200
|
+
* @return Success
|
|
201
|
+
*/
|
|
202
|
+
getImageSize(tenantId: number, body?: GetImageSizeRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<NullAbleSize>;
|
|
203
|
+
protected processGetImageSize(response: AxiosResponse): Promise<NullAbleSize>;
|
|
204
|
+
/**
|
|
205
|
+
* @param body (optional)
|
|
206
|
+
* @return Success
|
|
207
|
+
*/
|
|
208
|
+
getShapeBounds(tenantId: number, body?: GetShapeBoundsRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<RectangleF>;
|
|
209
|
+
protected processGetShapeBounds(response: AxiosResponse): Promise<RectangleF>;
|
|
210
|
+
/**
|
|
211
|
+
* @param body (optional)
|
|
212
|
+
* @return Success
|
|
213
|
+
*/
|
|
214
|
+
getWatermarkItems(tenantId: number, body?: any | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
215
|
+
protected processGetWatermarkItems(response: AxiosResponse): Promise<any>;
|
|
216
|
+
/**
|
|
217
|
+
* @param f (optional)
|
|
218
|
+
* @param w (optional)
|
|
219
|
+
* @param h (optional)
|
|
220
|
+
* @param cmyk (optional)
|
|
221
|
+
* @param rgb (optional)
|
|
222
|
+
* @param grayscale (optional)
|
|
223
|
+
* @param target (optional)
|
|
224
|
+
* @param sq (optional)
|
|
225
|
+
* @param effect (optional)
|
|
226
|
+
* @param kp (optional)
|
|
227
|
+
* @param color (optional)
|
|
228
|
+
* @param obm (optional)
|
|
229
|
+
* @param oo (optional)
|
|
230
|
+
* @param alphaMask (optional)
|
|
231
|
+
* @param page (optional)
|
|
232
|
+
* @param colorizeColor (optional)
|
|
233
|
+
* @return Success
|
|
234
|
+
*/
|
|
235
|
+
img(tenantId: number, f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
236
|
+
protected processImg(response: AxiosResponse): Promise<FileResponse>;
|
|
237
|
+
/**
|
|
238
|
+
* @return Success
|
|
239
|
+
*/
|
|
240
|
+
getLicense(tenantId: number, cancelToken?: CancelToken | undefined): Promise<string>;
|
|
241
|
+
protected processGetLicense(response: AxiosResponse): Promise<string>;
|
|
242
|
+
/**
|
|
243
|
+
* @param f (optional)
|
|
244
|
+
* @return Success
|
|
245
|
+
*/
|
|
246
|
+
pth(tenantId: number, f?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
247
|
+
protected processPth(response: AxiosResponse): Promise<FileResponse>;
|
|
248
|
+
/**
|
|
249
|
+
* @param image (optional)
|
|
250
|
+
* @return Success
|
|
251
|
+
*/
|
|
252
|
+
resource(tenantId: number, image?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
253
|
+
protected processResource(response: AxiosResponse): Promise<FileResponse>;
|
|
254
|
+
/**
|
|
255
|
+
* @param f (optional)
|
|
256
|
+
* @return Success
|
|
257
|
+
*/
|
|
258
|
+
svg(tenantId: number, f?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
259
|
+
protected processSvg(response: AxiosResponse): Promise<FileResponse>;
|
|
260
|
+
/**
|
|
261
|
+
* @param f (optional)
|
|
262
|
+
* @return Success
|
|
263
|
+
*/
|
|
264
|
+
txt(tenantId: number, f?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
265
|
+
protected processTxt(response: AxiosResponse): Promise<FileResponse>;
|
|
266
|
+
/**
|
|
267
|
+
* @param body (optional)
|
|
268
|
+
* @return Success
|
|
269
|
+
*/
|
|
270
|
+
updateArchedTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
271
|
+
protected processUpdateArchedTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
272
|
+
/**
|
|
273
|
+
* @param body (optional)
|
|
274
|
+
* @return Success
|
|
275
|
+
*/
|
|
276
|
+
updateAutoScaledTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
277
|
+
protected processUpdateAutoScaledTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
278
|
+
/**
|
|
279
|
+
* @param body (optional)
|
|
280
|
+
* @return Success
|
|
281
|
+
*/
|
|
282
|
+
updateBarcodeItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
283
|
+
protected processUpdateBarcodeItemHandler(response: AxiosResponse): Promise<any>;
|
|
284
|
+
/**
|
|
285
|
+
* @param body (optional)
|
|
286
|
+
* @return Success
|
|
287
|
+
*/
|
|
288
|
+
updateBoundedTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
289
|
+
protected processUpdateBoundedTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
290
|
+
/**
|
|
291
|
+
* @param body (optional)
|
|
292
|
+
* @return Success
|
|
293
|
+
*/
|
|
294
|
+
updateByColorData(tenantId: number, body?: UpdateColorsRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
|
|
295
|
+
protected processUpdateByColorData(response: AxiosResponse): Promise<string>;
|
|
296
|
+
/**
|
|
297
|
+
* @param body (optional)
|
|
298
|
+
* @return Success
|
|
299
|
+
*/
|
|
300
|
+
updateByMultiCallRequest(tenantId: number, body?: MultiCallRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
301
|
+
protected processUpdateByMultiCallRequest(response: AxiosResponse): Promise<any>;
|
|
302
|
+
/**
|
|
303
|
+
* @param body (optional)
|
|
304
|
+
* @return Success
|
|
305
|
+
*/
|
|
306
|
+
updateCurvedTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
307
|
+
protected processUpdateCurvedTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
308
|
+
/**
|
|
309
|
+
* @param body (optional)
|
|
310
|
+
* @return Success
|
|
311
|
+
*/
|
|
312
|
+
updateImageItemHandler(tenantId: number, body?: UpdateImageHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
313
|
+
protected processUpdateImageItemHandler(response: AxiosResponse): Promise<any>;
|
|
314
|
+
/**
|
|
315
|
+
* @param body (optional)
|
|
316
|
+
* @return Success
|
|
317
|
+
*/
|
|
318
|
+
updatePathBoundedTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
319
|
+
protected processUpdatePathBoundedTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
320
|
+
/**
|
|
321
|
+
* @param body (optional)
|
|
322
|
+
* @return Success
|
|
323
|
+
*/
|
|
324
|
+
updatePlainTextItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
325
|
+
protected processUpdatePlainTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
326
|
+
/**
|
|
327
|
+
* @param body (optional)
|
|
328
|
+
* @return Success
|
|
329
|
+
*/
|
|
330
|
+
updateShapeItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
331
|
+
protected processUpdateShapeItemHandler(response: AxiosResponse): Promise<any>;
|
|
332
|
+
}
|
|
333
|
+
export interface IDesignAtomsServiceApiClient {
|
|
334
|
+
/**
|
|
335
|
+
* Converts colors
|
|
336
|
+
* @param tenantId (optional) Tenant identifier
|
|
337
|
+
* @param body (optional) Convert colors operation parameters
|
|
338
|
+
* @return Success
|
|
339
|
+
*/
|
|
340
|
+
convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | null | undefined): Promise<any>;
|
|
341
|
+
/**
|
|
342
|
+
* Creates new design file with specified parameters and saves it in storage.
|
|
343
|
+
* @param privateStorage (optional) If set to 'true' design will be saved to private storage
|
|
344
|
+
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
345
|
+
* @param tenantId (optional) Tenant identifier
|
|
346
|
+
* @param body (optional) Design creation parameters
|
|
347
|
+
* @return Success
|
|
348
|
+
*/
|
|
349
|
+
createDesign(privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | null | undefined): Promise<DesignInfo>;
|
|
350
|
+
/**
|
|
351
|
+
* Loads product (design model) from design file taken from storage
|
|
352
|
+
* @param id Design identifier
|
|
353
|
+
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
354
|
+
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
355
|
+
* @param tenantId (optional) Tenant identifier
|
|
356
|
+
* @return Success
|
|
357
|
+
*/
|
|
358
|
+
loadProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
|
|
359
|
+
/**
|
|
360
|
+
* Saves product (design model) to design file and updates design in storage.
|
|
361
|
+
* @param id Design identifier
|
|
362
|
+
* @param privateStorage (optional) If set to 'true' design will be saved to private storage
|
|
363
|
+
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
364
|
+
* @param tenantId (optional) Tenant identifier
|
|
365
|
+
* @param body (optional) Serialized product description
|
|
366
|
+
* @return Success
|
|
367
|
+
*/
|
|
368
|
+
saveProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | null | undefined): Promise<void>;
|
|
369
|
+
/**
|
|
370
|
+
* Patches product (design model) in design file
|
|
371
|
+
* @param id Design identifier
|
|
372
|
+
* @param tenantId (optional) Tenant identifier
|
|
373
|
+
* @param patchType (optional)
|
|
374
|
+
* @param replaceImageItemFileInfo_itemName (optional)
|
|
375
|
+
* @param replaceImageItemFileInfo_sourceFile (optional)
|
|
376
|
+
* @return Success
|
|
377
|
+
*/
|
|
378
|
+
patchProduct(id: string | null, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
|
|
379
|
+
/**
|
|
380
|
+
* Loads data schema from design file taken from storage
|
|
381
|
+
* @param id Design identifier
|
|
382
|
+
* @param tenantId (optional) Tenant identifier
|
|
383
|
+
* @return Success
|
|
384
|
+
*/
|
|
385
|
+
loadDataSchema(id: string | null, tenantId?: number | undefined): Promise<FileResponse>;
|
|
386
|
+
/**
|
|
387
|
+
* Gets variable items information for design file taken from storage
|
|
388
|
+
* @param id Design identifier
|
|
389
|
+
* @param tenantId (optional) Tenant identifier
|
|
390
|
+
* @return Success
|
|
391
|
+
*/
|
|
392
|
+
getVariables(id: string | null, tenantId?: number | undefined): Promise<VariablesModel>;
|
|
393
|
+
/**
|
|
394
|
+
* Sets variable items values for design file taken from storage
|
|
395
|
+
* @param id Design identifier
|
|
396
|
+
* @param tenantId (optional) Tenant identifier
|
|
397
|
+
* @param body (optional) Design variable values
|
|
398
|
+
* @return Success
|
|
399
|
+
*/
|
|
400
|
+
setVariables(id: string | null, tenantId?: number | undefined, body?: VariablesModel | null | undefined): Promise<VariablesModel>;
|
|
401
|
+
/**
|
|
402
|
+
* Loads variable data printing information from design file taken from storage
|
|
403
|
+
* @param id Design identifier
|
|
404
|
+
* @param tenantId (optional) Tenant identifier
|
|
405
|
+
* @return Success
|
|
406
|
+
*/
|
|
407
|
+
loadVdpData(id: string | null, tenantId?: number | undefined): Promise<VdpDataModel>;
|
|
408
|
+
/**
|
|
409
|
+
* Saves variable data printing information to design file and updates design in storage.
|
|
410
|
+
* @param id Design identifier
|
|
411
|
+
* @param tenantId (optional) Tenant identifier
|
|
412
|
+
* @param body (optional) Serialized vdp data
|
|
413
|
+
* @return Success
|
|
414
|
+
*/
|
|
415
|
+
saveVdpData(id: string | null, tenantId?: number | undefined, body?: VdpDataModel | null | undefined): Promise<void>;
|
|
416
|
+
/**
|
|
417
|
+
* Deletes variable data printing inforamtion from design file and updates design in storage.
|
|
418
|
+
* @param id Design identifier
|
|
419
|
+
* @param tenantId (optional) Tenant identifier
|
|
420
|
+
* @return Success
|
|
421
|
+
*/
|
|
422
|
+
deleteVdpData(id: string | null, tenantId?: number | undefined): Promise<void>;
|
|
423
|
+
/**
|
|
424
|
+
* Flatten items
|
|
425
|
+
* @param tenantId (optional) Tenant identifier
|
|
426
|
+
* @param body (optional) Items to flatten
|
|
427
|
+
* @return Success
|
|
428
|
+
*/
|
|
429
|
+
flattenItems(tenantId?: number | undefined, body?: any[] | null | undefined): Promise<any>;
|
|
430
|
+
/**
|
|
431
|
+
* Creates product item
|
|
432
|
+
* @param itemType (optional) Desired item type
|
|
433
|
+
* @param tenantId (optional) Tenant identifier
|
|
434
|
+
* @param sourceType (optional)
|
|
435
|
+
* @param sourceId (optional)
|
|
436
|
+
* @param sourceOwnerId (optional)
|
|
437
|
+
* @param sourceFile (optional)
|
|
438
|
+
* @return Success
|
|
439
|
+
*/
|
|
440
|
+
createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
|
|
441
|
+
/**
|
|
442
|
+
* Render product proof image with specified parameters.
|
|
443
|
+
* @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false')
|
|
444
|
+
* @param tenantId (optional) Tenant identifier
|
|
445
|
+
* @param body (optional) Preview parameters
|
|
446
|
+
* @return Success
|
|
447
|
+
*/
|
|
448
|
+
renderProduct(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderProductModel | null | undefined): Promise<FileResponse>;
|
|
449
|
+
}
|
|
450
|
+
export declare class DesignAtomsServiceApiClient extends ApiClientBase implements IDesignAtomsServiceApiClient {
|
|
451
|
+
private instance;
|
|
452
|
+
private baseUrl;
|
|
453
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
454
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
455
|
+
/**
|
|
456
|
+
* Converts colors
|
|
457
|
+
* @param tenantId (optional) Tenant identifier
|
|
458
|
+
* @param body (optional) Convert colors operation parameters
|
|
459
|
+
* @return Success
|
|
460
|
+
*/
|
|
461
|
+
convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
462
|
+
protected processConvertColors(response: AxiosResponse): Promise<any>;
|
|
463
|
+
/**
|
|
464
|
+
* Creates new design file with specified parameters and saves it in storage.
|
|
465
|
+
* @param privateStorage (optional) If set to 'true' design will be saved to private storage
|
|
466
|
+
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
467
|
+
* @param tenantId (optional) Tenant identifier
|
|
468
|
+
* @param body (optional) Design creation parameters
|
|
469
|
+
* @return Success
|
|
470
|
+
*/
|
|
471
|
+
createDesign(privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<DesignInfo>;
|
|
472
|
+
protected processCreateDesign(response: AxiosResponse): Promise<DesignInfo>;
|
|
473
|
+
/**
|
|
474
|
+
* Loads product (design model) from design file taken from storage
|
|
475
|
+
* @param id Design identifier
|
|
476
|
+
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
477
|
+
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
478
|
+
* @param tenantId (optional) Tenant identifier
|
|
479
|
+
* @return Success
|
|
480
|
+
*/
|
|
481
|
+
loadProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
482
|
+
protected processLoadProduct(response: AxiosResponse): Promise<any>;
|
|
483
|
+
/**
|
|
484
|
+
* Saves product (design model) to design file and updates design in storage.
|
|
485
|
+
* @param id Design identifier
|
|
486
|
+
* @param privateStorage (optional) If set to 'true' design will be saved to private storage
|
|
487
|
+
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
488
|
+
* @param tenantId (optional) Tenant identifier
|
|
489
|
+
* @param body (optional) Serialized product description
|
|
490
|
+
* @return Success
|
|
491
|
+
*/
|
|
492
|
+
saveProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
493
|
+
protected processSaveProduct(response: AxiosResponse): Promise<void>;
|
|
494
|
+
/**
|
|
495
|
+
* Patches product (design model) in design file
|
|
496
|
+
* @param id Design identifier
|
|
497
|
+
* @param tenantId (optional) Tenant identifier
|
|
498
|
+
* @param patchType (optional)
|
|
499
|
+
* @param replaceImageItemFileInfo_itemName (optional)
|
|
500
|
+
* @param replaceImageItemFileInfo_sourceFile (optional)
|
|
501
|
+
* @return Success
|
|
502
|
+
*/
|
|
503
|
+
patchProduct(id: string | null, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
504
|
+
protected processPatchProduct(response: AxiosResponse): Promise<void>;
|
|
505
|
+
/**
|
|
506
|
+
* Loads data schema from design file taken from storage
|
|
507
|
+
* @param id Design identifier
|
|
508
|
+
* @param tenantId (optional) Tenant identifier
|
|
509
|
+
* @return Success
|
|
510
|
+
*/
|
|
511
|
+
loadDataSchema(id: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
512
|
+
protected processLoadDataSchema(response: AxiosResponse): Promise<FileResponse>;
|
|
513
|
+
/**
|
|
514
|
+
* Gets variable items information for design file taken from storage
|
|
515
|
+
* @param id Design identifier
|
|
516
|
+
* @param tenantId (optional) Tenant identifier
|
|
517
|
+
* @return Success
|
|
518
|
+
*/
|
|
519
|
+
getVariables(id: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
|
|
520
|
+
protected processGetVariables(response: AxiosResponse): Promise<VariablesModel>;
|
|
521
|
+
/**
|
|
522
|
+
* Sets variable items values for design file taken from storage
|
|
523
|
+
* @param id Design identifier
|
|
524
|
+
* @param tenantId (optional) Tenant identifier
|
|
525
|
+
* @param body (optional) Design variable values
|
|
526
|
+
* @return Success
|
|
527
|
+
*/
|
|
528
|
+
setVariables(id: string | null, tenantId?: number | undefined, body?: VariablesModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
|
|
529
|
+
protected processSetVariables(response: AxiosResponse): Promise<VariablesModel>;
|
|
530
|
+
/**
|
|
531
|
+
* Loads variable data printing information from design file taken from storage
|
|
532
|
+
* @param id Design identifier
|
|
533
|
+
* @param tenantId (optional) Tenant identifier
|
|
534
|
+
* @return Success
|
|
535
|
+
*/
|
|
536
|
+
loadVdpData(id: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VdpDataModel>;
|
|
537
|
+
protected processLoadVdpData(response: AxiosResponse): Promise<VdpDataModel>;
|
|
538
|
+
/**
|
|
539
|
+
* Saves variable data printing information to design file and updates design in storage.
|
|
540
|
+
* @param id Design identifier
|
|
541
|
+
* @param tenantId (optional) Tenant identifier
|
|
542
|
+
* @param body (optional) Serialized vdp data
|
|
543
|
+
* @return Success
|
|
544
|
+
*/
|
|
545
|
+
saveVdpData(id: string | null, tenantId?: number | undefined, body?: VdpDataModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
546
|
+
protected processSaveVdpData(response: AxiosResponse): Promise<void>;
|
|
547
|
+
/**
|
|
548
|
+
* Deletes variable data printing inforamtion from design file and updates design in storage.
|
|
549
|
+
* @param id Design identifier
|
|
550
|
+
* @param tenantId (optional) Tenant identifier
|
|
551
|
+
* @return Success
|
|
552
|
+
*/
|
|
553
|
+
deleteVdpData(id: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
554
|
+
protected processDeleteVdpData(response: AxiosResponse): Promise<void>;
|
|
555
|
+
/**
|
|
556
|
+
* Flatten items
|
|
557
|
+
* @param tenantId (optional) Tenant identifier
|
|
558
|
+
* @param body (optional) Items to flatten
|
|
559
|
+
* @return Success
|
|
560
|
+
*/
|
|
561
|
+
flattenItems(tenantId?: number | undefined, body?: any[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
562
|
+
protected processFlattenItems(response: AxiosResponse): Promise<any>;
|
|
563
|
+
/**
|
|
564
|
+
* Creates product item
|
|
565
|
+
* @param itemType (optional) Desired item type
|
|
566
|
+
* @param tenantId (optional) Tenant identifier
|
|
567
|
+
* @param sourceType (optional)
|
|
568
|
+
* @param sourceId (optional)
|
|
569
|
+
* @param sourceOwnerId (optional)
|
|
570
|
+
* @param sourceFile (optional)
|
|
571
|
+
* @return Success
|
|
572
|
+
*/
|
|
573
|
+
createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
574
|
+
protected processCreateItem(response: AxiosResponse): Promise<any>;
|
|
575
|
+
/**
|
|
576
|
+
* Render product proof image with specified parameters.
|
|
577
|
+
* @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false')
|
|
578
|
+
* @param tenantId (optional) Tenant identifier
|
|
579
|
+
* @param body (optional) Preview parameters
|
|
580
|
+
* @return Success
|
|
581
|
+
*/
|
|
582
|
+
renderProduct(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderProductModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
583
|
+
protected processRenderProduct(response: AxiosResponse): Promise<FileResponse>;
|
|
584
|
+
}
|
|
585
|
+
export interface IDesignAtomsViewerApiClient {
|
|
586
|
+
/**
|
|
587
|
+
* @param tenantId (optional) Tenant identifier
|
|
588
|
+
* @param body (optional)
|
|
589
|
+
* @return Success
|
|
590
|
+
*/
|
|
591
|
+
cssFonts(tenantId?: number | undefined, body?: FontsMethodData | null | undefined): Promise<string>;
|
|
592
|
+
/**
|
|
593
|
+
* @param tenantId (optional) Tenant identifier
|
|
594
|
+
* @return Success
|
|
595
|
+
*/
|
|
596
|
+
fonts(psName: string | null, tenantId?: number | undefined): Promise<FileResponse>;
|
|
597
|
+
/**
|
|
598
|
+
* @param fontKey (optional)
|
|
599
|
+
* @param tenantId (optional) Tenant identifier
|
|
600
|
+
* @return Success
|
|
601
|
+
*/
|
|
602
|
+
getCssFont(fontKey?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
|
|
603
|
+
/**
|
|
604
|
+
* @param tenantId (optional) Tenant identifier
|
|
605
|
+
* @param body (optional)
|
|
606
|
+
* @return Success
|
|
607
|
+
*/
|
|
608
|
+
getImageSize(tenantId?: number | undefined, body?: GetImageSizeRequest | null | undefined): Promise<NullAbleSize>;
|
|
609
|
+
/**
|
|
610
|
+
* @param tenantId (optional) Tenant identifier
|
|
611
|
+
* @param body (optional)
|
|
612
|
+
* @return Success
|
|
613
|
+
*/
|
|
614
|
+
getShapeBounds(tenantId?: number | undefined, body?: GetShapeBoundsRequest | null | undefined): Promise<RectangleF>;
|
|
615
|
+
/**
|
|
616
|
+
* @param tenantId (optional) Tenant identifier
|
|
617
|
+
* @param body (optional)
|
|
618
|
+
* @return Success
|
|
619
|
+
*/
|
|
620
|
+
getWatermarkItems(tenantId?: number | undefined, body?: any | null | undefined): Promise<any>;
|
|
621
|
+
/**
|
|
622
|
+
* @param f (optional)
|
|
623
|
+
* @param w (optional)
|
|
624
|
+
* @param h (optional)
|
|
625
|
+
* @param cmyk (optional)
|
|
626
|
+
* @param rgb (optional)
|
|
627
|
+
* @param grayscale (optional)
|
|
628
|
+
* @param target (optional)
|
|
629
|
+
* @param sq (optional)
|
|
630
|
+
* @param effect (optional)
|
|
631
|
+
* @param kp (optional)
|
|
632
|
+
* @param color (optional)
|
|
633
|
+
* @param obm (optional)
|
|
634
|
+
* @param oo (optional)
|
|
635
|
+
* @param alphaMask (optional)
|
|
636
|
+
* @param page (optional)
|
|
637
|
+
* @param colorizeColor (optional)
|
|
638
|
+
* @param tenantId (optional) Tenant identifier
|
|
639
|
+
* @return Success
|
|
640
|
+
*/
|
|
641
|
+
img(f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
|
|
642
|
+
/**
|
|
643
|
+
* @param tenantId (optional) Tenant identifier
|
|
644
|
+
* @return Success
|
|
645
|
+
*/
|
|
646
|
+
getLicense(tenantId?: number | undefined): Promise<string>;
|
|
647
|
+
/**
|
|
648
|
+
* @param f (optional)
|
|
649
|
+
* @param tenantId (optional) Tenant identifier
|
|
650
|
+
* @return Success
|
|
651
|
+
*/
|
|
652
|
+
pth(f?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
|
|
653
|
+
/**
|
|
654
|
+
* @param image (optional)
|
|
655
|
+
* @param tenantId (optional) Tenant identifier
|
|
656
|
+
* @return Success
|
|
657
|
+
*/
|
|
658
|
+
resource(image?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
|
|
659
|
+
/**
|
|
660
|
+
* @param f (optional)
|
|
661
|
+
* @param tenantId (optional) Tenant identifier
|
|
662
|
+
* @return Success
|
|
663
|
+
*/
|
|
664
|
+
svg(f?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
|
|
665
|
+
/**
|
|
666
|
+
* @param f (optional)
|
|
667
|
+
* @param tenantId (optional) Tenant identifier
|
|
668
|
+
* @return Success
|
|
669
|
+
*/
|
|
670
|
+
txt(f?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
|
|
671
|
+
/**
|
|
672
|
+
* @param tenantId (optional) Tenant identifier
|
|
673
|
+
* @param body (optional)
|
|
674
|
+
* @return Success
|
|
675
|
+
*/
|
|
676
|
+
updateArchedTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
677
|
+
/**
|
|
678
|
+
* @param tenantId (optional) Tenant identifier
|
|
679
|
+
* @param body (optional)
|
|
680
|
+
* @return Success
|
|
681
|
+
*/
|
|
682
|
+
updateAutoScaledTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
683
|
+
/**
|
|
684
|
+
* @param tenantId (optional) Tenant identifier
|
|
685
|
+
* @param body (optional)
|
|
686
|
+
* @return Success
|
|
687
|
+
*/
|
|
688
|
+
updateBarcodeItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
689
|
+
/**
|
|
690
|
+
* @param tenantId (optional) Tenant identifier
|
|
691
|
+
* @param body (optional)
|
|
692
|
+
* @return Success
|
|
693
|
+
*/
|
|
694
|
+
updateBoundedTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
695
|
+
/**
|
|
696
|
+
* @param tenantId (optional) Tenant identifier
|
|
697
|
+
* @param body (optional)
|
|
698
|
+
* @return Success
|
|
699
|
+
*/
|
|
700
|
+
updateByColorData(tenantId?: number | undefined, body?: UpdateColorsRequest | null | undefined): Promise<string>;
|
|
701
|
+
/**
|
|
702
|
+
* @param tenantId (optional) Tenant identifier
|
|
703
|
+
* @param body (optional)
|
|
704
|
+
* @return Success
|
|
705
|
+
*/
|
|
706
|
+
updateByMultiCallRequest(tenantId?: number | undefined, body?: MultiCallRequest | null | undefined): Promise<any>;
|
|
707
|
+
/**
|
|
708
|
+
* @param tenantId (optional) Tenant identifier
|
|
709
|
+
* @param body (optional)
|
|
710
|
+
* @return Success
|
|
711
|
+
*/
|
|
712
|
+
updateCurvedTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
713
|
+
/**
|
|
714
|
+
* @param tenantId (optional) Tenant identifier
|
|
715
|
+
* @param body (optional)
|
|
716
|
+
* @return Success
|
|
717
|
+
*/
|
|
718
|
+
updateImageItemHandler(tenantId?: number | undefined, body?: UpdateImageHandlerRequest | null | undefined): Promise<any>;
|
|
719
|
+
/**
|
|
720
|
+
* @param tenantId (optional) Tenant identifier
|
|
721
|
+
* @param body (optional)
|
|
722
|
+
* @return Success
|
|
723
|
+
*/
|
|
724
|
+
updatePathBoundedTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
725
|
+
/**
|
|
726
|
+
* @param tenantId (optional) Tenant identifier
|
|
727
|
+
* @param body (optional)
|
|
728
|
+
* @return Success
|
|
729
|
+
*/
|
|
730
|
+
updatePlainTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
731
|
+
/**
|
|
732
|
+
* @param tenantId (optional) Tenant identifier
|
|
733
|
+
* @param body (optional)
|
|
734
|
+
* @return Success
|
|
735
|
+
*/
|
|
736
|
+
updateShapeItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined): Promise<any>;
|
|
737
|
+
}
|
|
738
|
+
export declare class DesignAtomsViewerApiClient extends ApiClientBase implements IDesignAtomsViewerApiClient {
|
|
739
|
+
private instance;
|
|
740
|
+
private baseUrl;
|
|
741
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
742
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
743
|
+
/**
|
|
744
|
+
* @param tenantId (optional) Tenant identifier
|
|
745
|
+
* @param body (optional)
|
|
746
|
+
* @return Success
|
|
747
|
+
*/
|
|
748
|
+
cssFonts(tenantId?: number | undefined, body?: FontsMethodData | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
|
|
749
|
+
protected processCssFonts(response: AxiosResponse): Promise<string>;
|
|
750
|
+
/**
|
|
751
|
+
* @param tenantId (optional) Tenant identifier
|
|
752
|
+
* @return Success
|
|
753
|
+
*/
|
|
754
|
+
fonts(psName: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
755
|
+
protected processFonts(response: AxiosResponse): Promise<FileResponse>;
|
|
756
|
+
/**
|
|
757
|
+
* @param fontKey (optional)
|
|
758
|
+
* @param tenantId (optional) Tenant identifier
|
|
759
|
+
* @return Success
|
|
760
|
+
*/
|
|
761
|
+
getCssFont(fontKey?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
762
|
+
protected processGetCssFont(response: AxiosResponse): Promise<FileResponse>;
|
|
763
|
+
/**
|
|
764
|
+
* @param tenantId (optional) Tenant identifier
|
|
765
|
+
* @param body (optional)
|
|
766
|
+
* @return Success
|
|
767
|
+
*/
|
|
768
|
+
getImageSize(tenantId?: number | undefined, body?: GetImageSizeRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<NullAbleSize>;
|
|
769
|
+
protected processGetImageSize(response: AxiosResponse): Promise<NullAbleSize>;
|
|
770
|
+
/**
|
|
771
|
+
* @param tenantId (optional) Tenant identifier
|
|
772
|
+
* @param body (optional)
|
|
773
|
+
* @return Success
|
|
774
|
+
*/
|
|
775
|
+
getShapeBounds(tenantId?: number | undefined, body?: GetShapeBoundsRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<RectangleF>;
|
|
776
|
+
protected processGetShapeBounds(response: AxiosResponse): Promise<RectangleF>;
|
|
777
|
+
/**
|
|
778
|
+
* @param tenantId (optional) Tenant identifier
|
|
779
|
+
* @param body (optional)
|
|
780
|
+
* @return Success
|
|
781
|
+
*/
|
|
782
|
+
getWatermarkItems(tenantId?: number | undefined, body?: any | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
783
|
+
protected processGetWatermarkItems(response: AxiosResponse): Promise<any>;
|
|
784
|
+
/**
|
|
785
|
+
* @param f (optional)
|
|
786
|
+
* @param w (optional)
|
|
787
|
+
* @param h (optional)
|
|
788
|
+
* @param cmyk (optional)
|
|
789
|
+
* @param rgb (optional)
|
|
790
|
+
* @param grayscale (optional)
|
|
791
|
+
* @param target (optional)
|
|
792
|
+
* @param sq (optional)
|
|
793
|
+
* @param effect (optional)
|
|
794
|
+
* @param kp (optional)
|
|
795
|
+
* @param color (optional)
|
|
796
|
+
* @param obm (optional)
|
|
797
|
+
* @param oo (optional)
|
|
798
|
+
* @param alphaMask (optional)
|
|
799
|
+
* @param page (optional)
|
|
800
|
+
* @param colorizeColor (optional)
|
|
801
|
+
* @param tenantId (optional) Tenant identifier
|
|
802
|
+
* @return Success
|
|
803
|
+
*/
|
|
804
|
+
img(f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
805
|
+
protected processImg(response: AxiosResponse): Promise<FileResponse>;
|
|
806
|
+
/**
|
|
807
|
+
* @param tenantId (optional) Tenant identifier
|
|
808
|
+
* @return Success
|
|
809
|
+
*/
|
|
810
|
+
getLicense(tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
|
|
811
|
+
protected processGetLicense(response: AxiosResponse): Promise<string>;
|
|
812
|
+
/**
|
|
813
|
+
* @param f (optional)
|
|
814
|
+
* @param tenantId (optional) Tenant identifier
|
|
815
|
+
* @return Success
|
|
816
|
+
*/
|
|
817
|
+
pth(f?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
818
|
+
protected processPth(response: AxiosResponse): Promise<FileResponse>;
|
|
819
|
+
/**
|
|
820
|
+
* @param image (optional)
|
|
821
|
+
* @param tenantId (optional) Tenant identifier
|
|
822
|
+
* @return Success
|
|
823
|
+
*/
|
|
824
|
+
resource(image?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
825
|
+
protected processResource(response: AxiosResponse): Promise<FileResponse>;
|
|
826
|
+
/**
|
|
827
|
+
* @param f (optional)
|
|
828
|
+
* @param tenantId (optional) Tenant identifier
|
|
829
|
+
* @return Success
|
|
830
|
+
*/
|
|
831
|
+
svg(f?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
832
|
+
protected processSvg(response: AxiosResponse): Promise<FileResponse>;
|
|
833
|
+
/**
|
|
834
|
+
* @param f (optional)
|
|
835
|
+
* @param tenantId (optional) Tenant identifier
|
|
836
|
+
* @return Success
|
|
837
|
+
*/
|
|
838
|
+
txt(f?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
839
|
+
protected processTxt(response: AxiosResponse): Promise<FileResponse>;
|
|
840
|
+
/**
|
|
841
|
+
* @param tenantId (optional) Tenant identifier
|
|
842
|
+
* @param body (optional)
|
|
843
|
+
* @return Success
|
|
844
|
+
*/
|
|
845
|
+
updateArchedTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
846
|
+
protected processUpdateArchedTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
847
|
+
/**
|
|
848
|
+
* @param tenantId (optional) Tenant identifier
|
|
849
|
+
* @param body (optional)
|
|
850
|
+
* @return Success
|
|
851
|
+
*/
|
|
852
|
+
updateAutoScaledTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
853
|
+
protected processUpdateAutoScaledTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
854
|
+
/**
|
|
855
|
+
* @param tenantId (optional) Tenant identifier
|
|
856
|
+
* @param body (optional)
|
|
857
|
+
* @return Success
|
|
858
|
+
*/
|
|
859
|
+
updateBarcodeItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
860
|
+
protected processUpdateBarcodeItemHandler(response: AxiosResponse): Promise<any>;
|
|
861
|
+
/**
|
|
862
|
+
* @param tenantId (optional) Tenant identifier
|
|
863
|
+
* @param body (optional)
|
|
864
|
+
* @return Success
|
|
865
|
+
*/
|
|
866
|
+
updateBoundedTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
867
|
+
protected processUpdateBoundedTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
868
|
+
/**
|
|
869
|
+
* @param tenantId (optional) Tenant identifier
|
|
870
|
+
* @param body (optional)
|
|
871
|
+
* @return Success
|
|
872
|
+
*/
|
|
873
|
+
updateByColorData(tenantId?: number | undefined, body?: UpdateColorsRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
|
|
874
|
+
protected processUpdateByColorData(response: AxiosResponse): Promise<string>;
|
|
875
|
+
/**
|
|
876
|
+
* @param tenantId (optional) Tenant identifier
|
|
877
|
+
* @param body (optional)
|
|
878
|
+
* @return Success
|
|
879
|
+
*/
|
|
880
|
+
updateByMultiCallRequest(tenantId?: number | undefined, body?: MultiCallRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
881
|
+
protected processUpdateByMultiCallRequest(response: AxiosResponse): Promise<any>;
|
|
882
|
+
/**
|
|
883
|
+
* @param tenantId (optional) Tenant identifier
|
|
884
|
+
* @param body (optional)
|
|
885
|
+
* @return Success
|
|
886
|
+
*/
|
|
887
|
+
updateCurvedTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
888
|
+
protected processUpdateCurvedTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
889
|
+
/**
|
|
890
|
+
* @param tenantId (optional) Tenant identifier
|
|
891
|
+
* @param body (optional)
|
|
892
|
+
* @return Success
|
|
893
|
+
*/
|
|
894
|
+
updateImageItemHandler(tenantId?: number | undefined, body?: UpdateImageHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
895
|
+
protected processUpdateImageItemHandler(response: AxiosResponse): Promise<any>;
|
|
896
|
+
/**
|
|
897
|
+
* @param tenantId (optional) Tenant identifier
|
|
898
|
+
* @param body (optional)
|
|
899
|
+
* @return Success
|
|
900
|
+
*/
|
|
901
|
+
updatePathBoundedTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
902
|
+
protected processUpdatePathBoundedTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
903
|
+
/**
|
|
904
|
+
* @param tenantId (optional) Tenant identifier
|
|
905
|
+
* @param body (optional)
|
|
906
|
+
* @return Success
|
|
907
|
+
*/
|
|
908
|
+
updatePlainTextItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
909
|
+
protected processUpdatePlainTextItemHandler(response: AxiosResponse): Promise<any>;
|
|
910
|
+
/**
|
|
911
|
+
* @param tenantId (optional) Tenant identifier
|
|
912
|
+
* @param body (optional)
|
|
913
|
+
* @return Success
|
|
914
|
+
*/
|
|
915
|
+
updateShapeItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
916
|
+
protected processUpdateShapeItemHandler(response: AxiosResponse): Promise<any>;
|
|
917
|
+
}
|
|
918
|
+
/** Information about a service */
|
|
919
|
+
export interface BuildInfoModel {
|
|
920
|
+
/** Version number */
|
|
921
|
+
version?: string | null;
|
|
922
|
+
/** Build date (UTC) */
|
|
923
|
+
buildDate?: string | null;
|
|
924
|
+
/** Build configuration (Debug | Release) */
|
|
925
|
+
configuration?: string | null;
|
|
926
|
+
/** Service name */
|
|
927
|
+
appName?: string | null;
|
|
928
|
+
}
|
|
929
|
+
export interface FontsMethodData {
|
|
930
|
+
requestedFontsByPsName?: string[] | null;
|
|
931
|
+
advancedMode?: boolean;
|
|
932
|
+
baseUrl?: string | null;
|
|
933
|
+
}
|
|
934
|
+
export interface ProblemDetails {
|
|
935
|
+
type?: string | null;
|
|
936
|
+
title?: string | null;
|
|
937
|
+
status?: number | null;
|
|
938
|
+
detail?: string | null;
|
|
939
|
+
instance?: string | null;
|
|
940
|
+
}
|
|
941
|
+
export interface GetImageSizeRequest {
|
|
942
|
+
imageId?: string | null;
|
|
943
|
+
pageIndex?: number;
|
|
944
|
+
}
|
|
945
|
+
export interface NullAbleSize {
|
|
946
|
+
width?: number | null;
|
|
947
|
+
height?: number | null;
|
|
948
|
+
}
|
|
949
|
+
export interface GetShapeBoundsRequest {
|
|
950
|
+
path?: string | null;
|
|
951
|
+
}
|
|
952
|
+
export interface PointF {
|
|
953
|
+
readonly isEmpty?: boolean;
|
|
954
|
+
x?: number;
|
|
955
|
+
y?: number;
|
|
956
|
+
}
|
|
957
|
+
export interface RectangleF {
|
|
958
|
+
location?: PointF;
|
|
959
|
+
size?: string;
|
|
960
|
+
x?: number;
|
|
961
|
+
y?: number;
|
|
962
|
+
width?: number;
|
|
963
|
+
height?: number;
|
|
964
|
+
readonly left?: number;
|
|
965
|
+
readonly top?: number;
|
|
966
|
+
readonly right?: number;
|
|
967
|
+
readonly bottom?: number;
|
|
968
|
+
readonly isEmpty?: boolean;
|
|
969
|
+
}
|
|
970
|
+
export interface UpdateHandlerRequest {
|
|
971
|
+
canvasData?: string | null;
|
|
972
|
+
itemHandlerData?: string | null;
|
|
973
|
+
itemData?: any | null;
|
|
974
|
+
}
|
|
975
|
+
export interface UpdateColorsRequest {
|
|
976
|
+
canvasData?: string | null;
|
|
977
|
+
colorData?: string | null;
|
|
978
|
+
}
|
|
979
|
+
export interface MultiCallRequestItem {
|
|
980
|
+
canvasData?: string | null;
|
|
981
|
+
itemHandlersData?: string | null;
|
|
982
|
+
colorData?: string | null;
|
|
983
|
+
actualSize?: boolean | null;
|
|
984
|
+
preserveAspectRatio?: boolean | null;
|
|
985
|
+
url?: string | null;
|
|
986
|
+
imageId?: string | null;
|
|
987
|
+
pageIndex?: number | null;
|
|
988
|
+
methodName?: string | null;
|
|
989
|
+
itemData?: any | null;
|
|
990
|
+
}
|
|
991
|
+
export interface MultiCallRequest {
|
|
992
|
+
items?: MultiCallRequestItem[] | null;
|
|
993
|
+
}
|
|
994
|
+
export interface UpdateImageHandlerRequest {
|
|
995
|
+
actualSize?: boolean;
|
|
996
|
+
preserveAspectRatio?: boolean;
|
|
997
|
+
url?: string | null;
|
|
998
|
+
canvasData?: string | null;
|
|
999
|
+
itemHandlerData?: string | null;
|
|
1000
|
+
itemData?: any | null;
|
|
1001
|
+
}
|
|
1002
|
+
/** Convert colors operation parameters */
|
|
1003
|
+
export interface ConvertColorsModel {
|
|
1004
|
+
/** Serialized color description */
|
|
1005
|
+
colors: any[];
|
|
1006
|
+
/** Source color profile description */
|
|
1007
|
+
sourceColorProfile?: string | null;
|
|
1008
|
+
/** Destination color profile description */
|
|
1009
|
+
destinationColorProfile?: string | null;
|
|
1010
|
+
/** Targent color profile description */
|
|
1011
|
+
targetDeviceColorProfile?: string | null;
|
|
1012
|
+
}
|
|
1013
|
+
/** Design creation parameters */
|
|
1014
|
+
export interface CreateDesignModel {
|
|
1015
|
+
/** Serialized product description */
|
|
1016
|
+
product?: any | null;
|
|
1017
|
+
/** Serialized product data schema (base64 file stream) */
|
|
1018
|
+
dataSchema?: string | null;
|
|
1019
|
+
/** Design name */
|
|
1020
|
+
name?: string | null;
|
|
1021
|
+
/** Design location (folder path) */
|
|
1022
|
+
path?: string | null;
|
|
1023
|
+
}
|
|
1024
|
+
export interface DesignInfo {
|
|
1025
|
+
id?: string | null;
|
|
1026
|
+
ownerId?: string | null;
|
|
1027
|
+
name?: string | null;
|
|
1028
|
+
private?: boolean;
|
|
1029
|
+
}
|
|
1030
|
+
/** Available patch type */
|
|
1031
|
+
export declare enum ProductPatchType {
|
|
1032
|
+
Undefined = "Undefined",
|
|
1033
|
+
ReplaceImageItemFile = "ReplaceImageItemFile"
|
|
1034
|
+
}
|
|
1035
|
+
/** Variable information */
|
|
1036
|
+
export interface VariableInfo {
|
|
1037
|
+
/** Variable name */
|
|
1038
|
+
name?: string | null;
|
|
1039
|
+
/** Variable value */
|
|
1040
|
+
value?: string | null;
|
|
1041
|
+
/** Variable type */
|
|
1042
|
+
type?: string | null;
|
|
1043
|
+
}
|
|
1044
|
+
/** Variables information */
|
|
1045
|
+
export interface VariablesModel {
|
|
1046
|
+
/** List of variables */
|
|
1047
|
+
items?: VariableInfo[] | null;
|
|
1048
|
+
}
|
|
1049
|
+
/** Variable data printing information */
|
|
1050
|
+
export interface VdpDataModel {
|
|
1051
|
+
/** Serialized vdp dataset */
|
|
1052
|
+
vdpDataSet?: any | null;
|
|
1053
|
+
/** Serialized vdp items data */
|
|
1054
|
+
vdpItemsData?: any | null;
|
|
1055
|
+
}
|
|
1056
|
+
export declare enum ItemType {
|
|
1057
|
+
Image = "Image",
|
|
1058
|
+
Shape = "Shape",
|
|
1059
|
+
Clipart = "Clipart",
|
|
1060
|
+
Group = "Group"
|
|
1061
|
+
}
|
|
1062
|
+
/** Item souce types */
|
|
1063
|
+
export declare enum ItemSourceType {
|
|
1064
|
+
File = "File",
|
|
1065
|
+
ImageStorage = "ImageStorage",
|
|
1066
|
+
PrivateImageStorage = "PrivateImageStorage"
|
|
1067
|
+
}
|
|
1068
|
+
export declare enum ProductProofFormat {
|
|
1069
|
+
Jpeg = "Jpeg",
|
|
1070
|
+
Png = "Png",
|
|
1071
|
+
Tiff = "Tiff",
|
|
1072
|
+
Pdf = "Pdf"
|
|
1073
|
+
}
|
|
1074
|
+
export declare enum ProductProofInterpolationMode {
|
|
1075
|
+
High = "High",
|
|
1076
|
+
Medium = "Medium",
|
|
1077
|
+
Low = "Low",
|
|
1078
|
+
NearestNeighbour = "NearestNeighbour",
|
|
1079
|
+
Linear = "Linear",
|
|
1080
|
+
Cubic = "Cubic",
|
|
1081
|
+
Supersampling = "Supersampling",
|
|
1082
|
+
Lanczos = "Lanczos",
|
|
1083
|
+
Anisotropic4 = "Anisotropic4",
|
|
1084
|
+
Anisotropic9 = "Anisotropic9",
|
|
1085
|
+
Lanczos3 = "Lanczos3"
|
|
1086
|
+
}
|
|
1087
|
+
export interface ProductProofRenderingConfig {
|
|
1088
|
+
/** Surface to render */
|
|
1089
|
+
surfaceIndex?: number | null;
|
|
1090
|
+
/** Desired proof image width */
|
|
1091
|
+
width?: number;
|
|
1092
|
+
/** Desired proof image height */
|
|
1093
|
+
height?: number;
|
|
1094
|
+
/** Desired proof image format */
|
|
1095
|
+
format?: ProductProofFormat | null;
|
|
1096
|
+
/** Desired proof image interpolation */
|
|
1097
|
+
interpolationMode?: ProductProofInterpolationMode | null;
|
|
1098
|
+
/** Defines whether safety lines should be visualized */
|
|
1099
|
+
safetyLinesEnabled?: boolean | null;
|
|
1100
|
+
/** Defines whether watermark should be included */
|
|
1101
|
+
watermarkEnabled?: boolean | null;
|
|
1102
|
+
/** Defines watermark opacity (in range 0 .. 1.0) */
|
|
1103
|
+
watermarkOpacity?: number | null;
|
|
1104
|
+
/** Defines whether watermark should be repeated */
|
|
1105
|
+
watermarkRepeat?: boolean | null;
|
|
1106
|
+
}
|
|
1107
|
+
/** Render product parameters */
|
|
1108
|
+
export interface RenderProductModel {
|
|
1109
|
+
/** Serialized product description */
|
|
1110
|
+
product: any;
|
|
1111
|
+
/** Proof Image rendering config */
|
|
1112
|
+
renderingConfig?: ProductProofRenderingConfig | null;
|
|
1113
|
+
}
|
|
1114
|
+
export interface FileParameter {
|
|
1115
|
+
data: any;
|
|
1116
|
+
fileName: string;
|
|
1117
|
+
}
|
|
1118
|
+
export interface FileResponse {
|
|
1119
|
+
data: Blob;
|
|
1120
|
+
status: number;
|
|
1121
|
+
fileName?: string;
|
|
1122
|
+
headers?: {
|
|
1123
|
+
[name: string]: any;
|
|
1124
|
+
};
|
|
1125
|
+
}
|
|
1126
|
+
export declare class ApiException extends Error {
|
|
1127
|
+
message: string;
|
|
1128
|
+
status: number;
|
|
1129
|
+
response: string;
|
|
1130
|
+
headers: {
|
|
1131
|
+
[key: string]: any;
|
|
1132
|
+
};
|
|
1133
|
+
result: any;
|
|
1134
|
+
constructor(message: string, status: number, response: string, headers: {
|
|
1135
|
+
[key: string]: any;
|
|
1136
|
+
}, result: any);
|
|
1137
|
+
protected isApiException: boolean;
|
|
1138
|
+
static isApiException(obj: any): obj is ApiException;
|
|
1139
|
+
}
|