@aurigma/axios-design-atoms-api-client 2.70.1 → 2.71.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/dist/cjs/design-atoms-api-client.d.ts +263 -123
- package/dist/cjs/design-atoms-api-client.js +275 -62
- package/dist/cjs/design-atoms-api-client.js.map +1 -1
- package/dist/esm/design-atoms-api-client.d.ts +263 -123
- package/dist/esm/design-atoms-api-client.js +274 -61
- package/dist/esm/design-atoms-api-client.js.map +1 -1
- package/package.json +1 -1
|
@@ -89,27 +89,38 @@ export interface IDesignAtomsCompatibilityApiClient {
|
|
|
89
89
|
getWatermarkItems(tenantId: number, body?: any | undefined): Promise<any>;
|
|
90
90
|
/**
|
|
91
91
|
* Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
|
|
92
|
-
This method accepts query parameters that control the output of the image.
|
|
93
92
|
* @param f (optional) The identifier of the original image file.
|
|
94
93
|
* @param w (optional) Target width of the resulting image.
|
|
95
94
|
* @param h (optional) Target height of the resulting image.
|
|
96
95
|
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
97
96
|
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
98
97
|
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
99
|
-
* @param target (optional) Target color space, one of
|
|
100
|
-
* @param sq (optional) Indicates that the image is squared.
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
* @param
|
|
106
|
-
|
|
107
|
-
* @param
|
|
108
|
-
|
|
109
|
-
* @param
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
98
|
+
* @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
|
|
99
|
+
* @param sq (optional) Indicates that the image is squared.
|
|
100
|
+
The default value is "false".
|
|
101
|
+
* @param effect (optional) Effect applied to the image.
|
|
102
|
+
Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
|
|
103
|
+
The default value is "None".
|
|
104
|
+
* @param kp (optional) Indicates that image proportions should be maintained.
|
|
105
|
+
The default value is "false".
|
|
106
|
+
* @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
|
|
107
|
+
By default, it's an empty string.
|
|
108
|
+
* @param obm (optional) Overlay blend mode used for blending colors.
|
|
109
|
+
Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
|
|
110
|
+
"ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
|
|
111
|
+
By default, it's an empty string.
|
|
112
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
|
|
113
|
+
The default value is "null".
|
|
114
|
+
* @param alphaMask (optional) Enables alpha mask processing.
|
|
115
|
+
The default value is "false".
|
|
116
|
+
* @param page (optional) Page index in a PDF document that needs to be processed.
|
|
117
|
+
The default value is "0".
|
|
118
|
+
* @param colorizeColor (optional) Color applied for the "Colorize" image effect.
|
|
119
|
+
By default, it's an empty string.
|
|
120
|
+
* @param rw (optional) Rectangle width for area selection.
|
|
121
|
+
The default value is "0".
|
|
122
|
+
* @param rh (optional) Rectangle height for area selection.
|
|
123
|
+
The default value is "0".
|
|
113
124
|
* @return Success
|
|
114
125
|
*/
|
|
115
126
|
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, rw?: number | null | undefined, rh?: number | null | undefined): Promise<FileResponse>;
|
|
@@ -134,20 +145,32 @@ export interface IDesignAtomsCompatibilityApiClient {
|
|
|
134
145
|
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
135
146
|
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
136
147
|
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
137
|
-
* @param target (optional) Target color space, one of
|
|
138
|
-
* @param sq (optional) Indicates that the image is squared.
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
* @param
|
|
144
|
-
|
|
145
|
-
* @param
|
|
146
|
-
|
|
147
|
-
* @param
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
148
|
+
* @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
|
|
149
|
+
* @param sq (optional) Indicates that the image is squared.
|
|
150
|
+
The default value is "false".
|
|
151
|
+
* @param effect (optional) Effect applied to the image.
|
|
152
|
+
Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
|
|
153
|
+
The default value is "None".
|
|
154
|
+
* @param kp (optional) Indicates that image proportions should be maintained.
|
|
155
|
+
The default value is "false".
|
|
156
|
+
* @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
|
|
157
|
+
By default, it's an empty string.
|
|
158
|
+
* @param obm (optional) Overlay blend mode used for blending colors.
|
|
159
|
+
Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
|
|
160
|
+
"ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
|
|
161
|
+
By default, it's an empty string.
|
|
162
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
|
|
163
|
+
The default value is "null".
|
|
164
|
+
* @param alphaMask (optional) Enables alpha mask processing.
|
|
165
|
+
The default value is "false".
|
|
166
|
+
* @param page (optional) Page index in a PDF document that needs to be processed.
|
|
167
|
+
The default value is "0".
|
|
168
|
+
* @param colorizeColor (optional) Color applied for the "Colorize" image effect.
|
|
169
|
+
By default, it's an empty string.
|
|
170
|
+
* @param rw (optional) Rectangle width for area selection.
|
|
171
|
+
The default value is "0".
|
|
172
|
+
* @param rh (optional) Rectangle height for area selection.
|
|
173
|
+
The default value is "0".
|
|
151
174
|
* @return Success
|
|
152
175
|
*/
|
|
153
176
|
svg(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, rw?: number | null | undefined, rh?: number | null | undefined): Promise<FileResponse>;
|
|
@@ -271,27 +294,38 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
|
|
|
271
294
|
protected processGetWatermarkItems(response: AxiosResponse): Promise<any>;
|
|
272
295
|
/**
|
|
273
296
|
* Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
|
|
274
|
-
This method accepts query parameters that control the output of the image.
|
|
275
297
|
* @param f (optional) The identifier of the original image file.
|
|
276
298
|
* @param w (optional) Target width of the resulting image.
|
|
277
299
|
* @param h (optional) Target height of the resulting image.
|
|
278
300
|
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
279
301
|
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
280
302
|
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
281
|
-
* @param target (optional) Target color space, one of
|
|
282
|
-
* @param sq (optional) Indicates that the image is squared.
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
* @param
|
|
288
|
-
|
|
289
|
-
* @param
|
|
290
|
-
|
|
291
|
-
* @param
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
303
|
+
* @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
|
|
304
|
+
* @param sq (optional) Indicates that the image is squared.
|
|
305
|
+
The default value is "false".
|
|
306
|
+
* @param effect (optional) Effect applied to the image.
|
|
307
|
+
Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
|
|
308
|
+
The default value is "None".
|
|
309
|
+
* @param kp (optional) Indicates that image proportions should be maintained.
|
|
310
|
+
The default value is "false".
|
|
311
|
+
* @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
|
|
312
|
+
By default, it's an empty string.
|
|
313
|
+
* @param obm (optional) Overlay blend mode used for blending colors.
|
|
314
|
+
Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
|
|
315
|
+
"ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
|
|
316
|
+
By default, it's an empty string.
|
|
317
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
|
|
318
|
+
The default value is "null".
|
|
319
|
+
* @param alphaMask (optional) Enables alpha mask processing.
|
|
320
|
+
The default value is "false".
|
|
321
|
+
* @param page (optional) Page index in a PDF document that needs to be processed.
|
|
322
|
+
The default value is "0".
|
|
323
|
+
* @param colorizeColor (optional) Color applied for the "Colorize" image effect.
|
|
324
|
+
By default, it's an empty string.
|
|
325
|
+
* @param rw (optional) Rectangle width for area selection.
|
|
326
|
+
The default value is "0".
|
|
327
|
+
* @param rh (optional) Rectangle height for area selection.
|
|
328
|
+
The default value is "0".
|
|
295
329
|
* @return Success
|
|
296
330
|
*/
|
|
297
331
|
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, rw?: number | null | undefined, rh?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
@@ -320,20 +354,32 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
|
|
|
320
354
|
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
321
355
|
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
322
356
|
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
323
|
-
* @param target (optional) Target color space, one of
|
|
324
|
-
* @param sq (optional) Indicates that the image is squared.
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
* @param
|
|
330
|
-
|
|
331
|
-
* @param
|
|
332
|
-
|
|
333
|
-
* @param
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
357
|
+
* @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
|
|
358
|
+
* @param sq (optional) Indicates that the image is squared.
|
|
359
|
+
The default value is "false".
|
|
360
|
+
* @param effect (optional) Effect applied to the image.
|
|
361
|
+
Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
|
|
362
|
+
The default value is "None".
|
|
363
|
+
* @param kp (optional) Indicates that image proportions should be maintained.
|
|
364
|
+
The default value is "false".
|
|
365
|
+
* @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
|
|
366
|
+
By default, it's an empty string.
|
|
367
|
+
* @param obm (optional) Overlay blend mode used for blending colors.
|
|
368
|
+
Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
|
|
369
|
+
"ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
|
|
370
|
+
By default, it's an empty string.
|
|
371
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
|
|
372
|
+
The default value is "null".
|
|
373
|
+
* @param alphaMask (optional) Enables alpha mask processing.
|
|
374
|
+
The default value is "false".
|
|
375
|
+
* @param page (optional) Page index in a PDF document that needs to be processed.
|
|
376
|
+
The default value is "0".
|
|
377
|
+
* @param colorizeColor (optional) Color applied for the "Colorize" image effect.
|
|
378
|
+
By default, it's an empty string.
|
|
379
|
+
* @param rw (optional) Rectangle width for area selection.
|
|
380
|
+
The default value is "0".
|
|
381
|
+
* @param rh (optional) Rectangle height for area selection.
|
|
382
|
+
The default value is "0".
|
|
337
383
|
* @return Success
|
|
338
384
|
*/
|
|
339
385
|
svg(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, rw?: number | null | undefined, rh?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
@@ -433,9 +479,10 @@ export interface IDesignAtomsImagesApiClient {
|
|
|
433
479
|
* @param height (optional)
|
|
434
480
|
* @param fileFormat (optional)
|
|
435
481
|
* @param fitMode (optional)
|
|
482
|
+
* @param pageIndex (optional)
|
|
436
483
|
* @return Success
|
|
437
484
|
*/
|
|
438
|
-
renderImagePreviewFromFile(attachment?: boolean | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined): Promise<FileResponse>;
|
|
485
|
+
renderImagePreviewFromFile(attachment?: boolean | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined, pageIndex?: number | null | undefined): Promise<FileResponse>;
|
|
439
486
|
/**
|
|
440
487
|
* Renders a preview of an uploaded image with the specified parameters and saves rendering result as resource.
|
|
441
488
|
* @param tenantId (optional) Tenant ID.
|
|
@@ -453,9 +500,10 @@ export interface IDesignAtomsImagesApiClient {
|
|
|
453
500
|
* @param height (optional)
|
|
454
501
|
* @param fileFormat (optional)
|
|
455
502
|
* @param fitMode (optional)
|
|
503
|
+
* @param pageIndex (optional)
|
|
456
504
|
* @return Success
|
|
457
505
|
*/
|
|
458
|
-
renderImagePreviewFromFileToResource(tenantId?: number | undefined, resourceOwnerId?: string | null | undefined, resourceNamespace?: string | null | undefined, resourceName?: string | null | undefined, resourceSourceId?: string | null | undefined, resourceType?: string | null | undefined, anonymousAccess?: boolean | null | undefined, overwriteExistingResource?: boolean | null | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined): Promise<ResourceInfoDto>;
|
|
506
|
+
renderImagePreviewFromFileToResource(tenantId?: number | undefined, resourceOwnerId?: string | null | undefined, resourceNamespace?: string | null | undefined, resourceName?: string | null | undefined, resourceSourceId?: string | null | undefined, resourceType?: string | null | undefined, anonymousAccess?: boolean | null | undefined, overwriteExistingResource?: boolean | null | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined, pageIndex?: number | null | undefined): Promise<ResourceInfoDto>;
|
|
459
507
|
/**
|
|
460
508
|
* Renders a preview of a web image with the specified parameters.
|
|
461
509
|
* @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
|
|
@@ -507,9 +555,10 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
|
|
|
507
555
|
* @param height (optional)
|
|
508
556
|
* @param fileFormat (optional)
|
|
509
557
|
* @param fitMode (optional)
|
|
558
|
+
* @param pageIndex (optional)
|
|
510
559
|
* @return Success
|
|
511
560
|
*/
|
|
512
|
-
renderImagePreviewFromFile(attachment?: boolean | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
561
|
+
renderImagePreviewFromFile(attachment?: boolean | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined, pageIndex?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
513
562
|
protected processRenderImagePreviewFromFile(response: AxiosResponse): Promise<FileResponse>;
|
|
514
563
|
/**
|
|
515
564
|
* Renders a preview of an uploaded image with the specified parameters and saves rendering result as resource.
|
|
@@ -528,9 +577,10 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
|
|
|
528
577
|
* @param height (optional)
|
|
529
578
|
* @param fileFormat (optional)
|
|
530
579
|
* @param fitMode (optional)
|
|
580
|
+
* @param pageIndex (optional)
|
|
531
581
|
* @return Success
|
|
532
582
|
*/
|
|
533
|
-
renderImagePreviewFromFileToResource(tenantId?: number | undefined, resourceOwnerId?: string | null | undefined, resourceNamespace?: string | null | undefined, resourceName?: string | null | undefined, resourceSourceId?: string | null | undefined, resourceType?: string | null | undefined, anonymousAccess?: boolean | null | undefined, overwriteExistingResource?: boolean | null | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
|
|
583
|
+
renderImagePreviewFromFileToResource(tenantId?: number | undefined, resourceOwnerId?: string | null | undefined, resourceNamespace?: string | null | undefined, resourceName?: string | null | undefined, resourceSourceId?: string | null | undefined, resourceType?: string | null | undefined, anonymousAccess?: boolean | null | undefined, overwriteExistingResource?: boolean | null | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined, pageIndex?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
|
|
534
584
|
protected processRenderImagePreviewFromFileToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
|
|
535
585
|
/**
|
|
536
586
|
* Renders a preview of a web image with the specified parameters.
|
|
@@ -1336,6 +1386,13 @@ export interface IDesignAtomsPrintProductItemsApiClient {
|
|
|
1336
1386
|
* @return Success
|
|
1337
1387
|
*/
|
|
1338
1388
|
extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined): Promise<FileResponse>;
|
|
1389
|
+
/**
|
|
1390
|
+
* Extracts print-product item image.
|
|
1391
|
+
* @param tenantId (optional) Tenant ID.
|
|
1392
|
+
* @param body (optional) Extraction parameters.
|
|
1393
|
+
* @return Success
|
|
1394
|
+
*/
|
|
1395
|
+
extractItemImageToResource(tenantId?: number | undefined, body?: ExtractItemImageToResourceModel | undefined): Promise<ResourceInfoDto>;
|
|
1339
1396
|
/**
|
|
1340
1397
|
* Flattens print-product items.
|
|
1341
1398
|
* @param paletteUID (optional)
|
|
@@ -1350,10 +1407,11 @@ export interface IDesignAtomsPrintProductItemsApiClient {
|
|
|
1350
1407
|
* @param tenantId (optional) Tenant ID.
|
|
1351
1408
|
* @param sourceFile (optional)
|
|
1352
1409
|
* @param paletteUID (optional)
|
|
1410
|
+
* @param pageIndex (optional)
|
|
1353
1411
|
* @param preserveOriginalFile (optional)
|
|
1354
1412
|
* @return Success
|
|
1355
1413
|
*/
|
|
1356
|
-
createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, paletteUID?: string | null | undefined, preserveOriginalFile?: boolean | null | undefined): Promise<any>;
|
|
1414
|
+
createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, paletteUID?: string | null | undefined, pageIndex?: number | null | undefined, preserveOriginalFile?: boolean | null | undefined): Promise<any>;
|
|
1357
1415
|
/**
|
|
1358
1416
|
* Creates multiple print-product items from input image files.
|
|
1359
1417
|
* @param itemType (optional) Desired print-product items type.
|
|
@@ -1418,6 +1476,14 @@ export declare class DesignAtomsPrintProductItemsApiClient extends ApiClientBase
|
|
|
1418
1476
|
*/
|
|
1419
1477
|
extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
1420
1478
|
protected processExtractItemImage(response: AxiosResponse): Promise<FileResponse>;
|
|
1479
|
+
/**
|
|
1480
|
+
* Extracts print-product item image.
|
|
1481
|
+
* @param tenantId (optional) Tenant ID.
|
|
1482
|
+
* @param body (optional) Extraction parameters.
|
|
1483
|
+
* @return Success
|
|
1484
|
+
*/
|
|
1485
|
+
extractItemImageToResource(tenantId?: number | undefined, body?: ExtractItemImageToResourceModel | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
|
|
1486
|
+
protected processExtractItemImageToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
|
|
1421
1487
|
/**
|
|
1422
1488
|
* Flattens print-product items.
|
|
1423
1489
|
* @param paletteUID (optional)
|
|
@@ -1433,10 +1499,11 @@ export declare class DesignAtomsPrintProductItemsApiClient extends ApiClientBase
|
|
|
1433
1499
|
* @param tenantId (optional) Tenant ID.
|
|
1434
1500
|
* @param sourceFile (optional)
|
|
1435
1501
|
* @param paletteUID (optional)
|
|
1502
|
+
* @param pageIndex (optional)
|
|
1436
1503
|
* @param preserveOriginalFile (optional)
|
|
1437
1504
|
* @return Success
|
|
1438
1505
|
*/
|
|
1439
|
-
createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, paletteUID?: string | null | undefined, preserveOriginalFile?: boolean | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
1506
|
+
createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, paletteUID?: string | null | undefined, pageIndex?: number | null | undefined, preserveOriginalFile?: boolean | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
1440
1507
|
protected processCreateItemFromFile(response: AxiosResponse): Promise<any>;
|
|
1441
1508
|
/**
|
|
1442
1509
|
* Creates multiple print-product items from input image files.
|
|
@@ -2056,27 +2123,38 @@ export interface IDesignAtomsViewerApiClient {
|
|
|
2056
2123
|
getWatermarkItems(tenantId?: number | undefined, body?: any | undefined): Promise<any>;
|
|
2057
2124
|
/**
|
|
2058
2125
|
* Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
|
|
2059
|
-
This method accepts query parameters that control the output of the image.
|
|
2060
2126
|
* @param f (optional) The identifier of the original image file.
|
|
2061
2127
|
* @param w (optional) Target width of the resulting image.
|
|
2062
2128
|
* @param h (optional) Target height of the resulting image.
|
|
2063
2129
|
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
2064
2130
|
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
2065
2131
|
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
2066
|
-
* @param target (optional) Target color space, one of
|
|
2067
|
-
* @param sq (optional) Indicates that the image is squared.
|
|
2068
|
-
|
|
2069
|
-
|
|
2070
|
-
|
|
2071
|
-
|
|
2072
|
-
* @param
|
|
2073
|
-
|
|
2074
|
-
* @param
|
|
2075
|
-
|
|
2076
|
-
* @param
|
|
2077
|
-
|
|
2078
|
-
|
|
2079
|
-
|
|
2132
|
+
* @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
|
|
2133
|
+
* @param sq (optional) Indicates that the image is squared.
|
|
2134
|
+
The default value is "false".
|
|
2135
|
+
* @param effect (optional) Effect applied to the image.
|
|
2136
|
+
Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
|
|
2137
|
+
The default value is "None".
|
|
2138
|
+
* @param kp (optional) Indicates that image proportions should be maintained.
|
|
2139
|
+
The default value is "false".
|
|
2140
|
+
* @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
|
|
2141
|
+
By default, it's an empty string.
|
|
2142
|
+
* @param obm (optional) Overlay blend mode used for blending colors.
|
|
2143
|
+
Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
|
|
2144
|
+
"ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
|
|
2145
|
+
By default, it's an empty string.
|
|
2146
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
|
|
2147
|
+
The default value is "null".
|
|
2148
|
+
* @param alphaMask (optional) Enables alpha mask processing.
|
|
2149
|
+
The default value is "false".
|
|
2150
|
+
* @param page (optional) Page index in a PDF document that needs to be processed.
|
|
2151
|
+
The default value is "0".
|
|
2152
|
+
* @param colorizeColor (optional) Color applied for the "Colorize" image effect.
|
|
2153
|
+
By default, it's an empty string.
|
|
2154
|
+
* @param rw (optional) Rectangle width for area selection.
|
|
2155
|
+
The default value is "0".
|
|
2156
|
+
* @param rh (optional) Rectangle height for area selection.
|
|
2157
|
+
The default value is "0".
|
|
2080
2158
|
* @param tenantId (optional) Tenant ID.
|
|
2081
2159
|
* @return Success
|
|
2082
2160
|
*/
|
|
@@ -2105,20 +2183,32 @@ export interface IDesignAtomsViewerApiClient {
|
|
|
2105
2183
|
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
2106
2184
|
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
2107
2185
|
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
2108
|
-
* @param target (optional) Target color space, one of
|
|
2109
|
-
* @param sq (optional) Indicates that the image is squared.
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
* @param
|
|
2115
|
-
|
|
2116
|
-
* @param
|
|
2117
|
-
|
|
2118
|
-
* @param
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2186
|
+
* @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
|
|
2187
|
+
* @param sq (optional) Indicates that the image is squared.
|
|
2188
|
+
The default value is "false".
|
|
2189
|
+
* @param effect (optional) Effect applied to the image.
|
|
2190
|
+
Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
|
|
2191
|
+
The default value is "None".
|
|
2192
|
+
* @param kp (optional) Indicates that image proportions should be maintained.
|
|
2193
|
+
The default value is "false".
|
|
2194
|
+
* @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
|
|
2195
|
+
By default, it's an empty string.
|
|
2196
|
+
* @param obm (optional) Overlay blend mode used for blending colors.
|
|
2197
|
+
Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
|
|
2198
|
+
"ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
|
|
2199
|
+
By default, it's an empty string.
|
|
2200
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
|
|
2201
|
+
The default value is "null".
|
|
2202
|
+
* @param alphaMask (optional) Enables alpha mask processing.
|
|
2203
|
+
The default value is "false".
|
|
2204
|
+
* @param page (optional) Page index in a PDF document that needs to be processed.
|
|
2205
|
+
The default value is "0".
|
|
2206
|
+
* @param colorizeColor (optional) Color applied for the "Colorize" image effect.
|
|
2207
|
+
By default, it's an empty string.
|
|
2208
|
+
* @param rw (optional) Rectangle width for area selection.
|
|
2209
|
+
The default value is "0".
|
|
2210
|
+
* @param rh (optional) Rectangle height for area selection.
|
|
2211
|
+
The default value is "0".
|
|
2122
2212
|
* @param tenantId (optional) Tenant ID.
|
|
2123
2213
|
* @return Success
|
|
2124
2214
|
*/
|
|
@@ -2264,27 +2354,38 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
|
|
|
2264
2354
|
protected processGetWatermarkItems(response: AxiosResponse): Promise<any>;
|
|
2265
2355
|
/**
|
|
2266
2356
|
* Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
|
|
2267
|
-
This method accepts query parameters that control the output of the image.
|
|
2268
2357
|
* @param f (optional) The identifier of the original image file.
|
|
2269
2358
|
* @param w (optional) Target width of the resulting image.
|
|
2270
2359
|
* @param h (optional) Target height of the resulting image.
|
|
2271
2360
|
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
2272
2361
|
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
2273
2362
|
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
2274
|
-
* @param target (optional) Target color space, one of
|
|
2275
|
-
* @param sq (optional) Indicates that the image is squared.
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
* @param
|
|
2281
|
-
|
|
2282
|
-
* @param
|
|
2283
|
-
|
|
2284
|
-
* @param
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2363
|
+
* @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
|
|
2364
|
+
* @param sq (optional) Indicates that the image is squared.
|
|
2365
|
+
The default value is "false".
|
|
2366
|
+
* @param effect (optional) Effect applied to the image.
|
|
2367
|
+
Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
|
|
2368
|
+
The default value is "None".
|
|
2369
|
+
* @param kp (optional) Indicates that image proportions should be maintained.
|
|
2370
|
+
The default value is "false".
|
|
2371
|
+
* @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
|
|
2372
|
+
By default, it's an empty string.
|
|
2373
|
+
* @param obm (optional) Overlay blend mode used for blending colors.
|
|
2374
|
+
Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
|
|
2375
|
+
"ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
|
|
2376
|
+
By default, it's an empty string.
|
|
2377
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
|
|
2378
|
+
The default value is "null".
|
|
2379
|
+
* @param alphaMask (optional) Enables alpha mask processing.
|
|
2380
|
+
The default value is "false".
|
|
2381
|
+
* @param page (optional) Page index in a PDF document that needs to be processed.
|
|
2382
|
+
The default value is "0".
|
|
2383
|
+
* @param colorizeColor (optional) Color applied for the "Colorize" image effect.
|
|
2384
|
+
By default, it's an empty string.
|
|
2385
|
+
* @param rw (optional) Rectangle width for area selection.
|
|
2386
|
+
The default value is "0".
|
|
2387
|
+
* @param rh (optional) Rectangle height for area selection.
|
|
2388
|
+
The default value is "0".
|
|
2288
2389
|
* @param tenantId (optional) Tenant ID.
|
|
2289
2390
|
* @return Success
|
|
2290
2391
|
*/
|
|
@@ -2317,20 +2418,32 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
|
|
|
2317
2418
|
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
2318
2419
|
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
2319
2420
|
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
2320
|
-
* @param target (optional) Target color space, one of
|
|
2321
|
-
* @param sq (optional) Indicates that the image is squared.
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
* @param
|
|
2327
|
-
|
|
2328
|
-
* @param
|
|
2329
|
-
|
|
2330
|
-
* @param
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2421
|
+
* @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
|
|
2422
|
+
* @param sq (optional) Indicates that the image is squared.
|
|
2423
|
+
The default value is "false".
|
|
2424
|
+
* @param effect (optional) Effect applied to the image.
|
|
2425
|
+
Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
|
|
2426
|
+
The default value is "None".
|
|
2427
|
+
* @param kp (optional) Indicates that image proportions should be maintained.
|
|
2428
|
+
The default value is "false".
|
|
2429
|
+
* @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
|
|
2430
|
+
By default, it's an empty string.
|
|
2431
|
+
* @param obm (optional) Overlay blend mode used for blending colors.
|
|
2432
|
+
Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
|
|
2433
|
+
"ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
|
|
2434
|
+
By default, it's an empty string.
|
|
2435
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
|
|
2436
|
+
The default value is "null".
|
|
2437
|
+
* @param alphaMask (optional) Enables alpha mask processing.
|
|
2438
|
+
The default value is "false".
|
|
2439
|
+
* @param page (optional) Page index in a PDF document that needs to be processed.
|
|
2440
|
+
The default value is "0".
|
|
2441
|
+
* @param colorizeColor (optional) Color applied for the "Colorize" image effect.
|
|
2442
|
+
By default, it's an empty string.
|
|
2443
|
+
* @param rw (optional) Rectangle width for area selection.
|
|
2444
|
+
The default value is "0".
|
|
2445
|
+
* @param rh (optional) Rectangle height for area selection.
|
|
2446
|
+
The default value is "0".
|
|
2334
2447
|
* @param tenantId (optional) Tenant ID.
|
|
2335
2448
|
* @return Success
|
|
2336
2449
|
*/
|
|
@@ -2505,6 +2618,9 @@ export interface CreateItemFromStorageModel {
|
|
|
2505
2618
|
sourceId?: string | null;
|
|
2506
2619
|
/** Target palette UID. */
|
|
2507
2620
|
paletteUID?: string | null;
|
|
2621
|
+
/** Index of image page (applies to multi-page image formats only, e.g. PDF and TIFF).
|
|
2622
|
+
Zero by default. */
|
|
2623
|
+
pageIndex?: number | null;
|
|
2508
2624
|
/** Indicates if resulting item should store original source file. */
|
|
2509
2625
|
preserveOriginalFile?: boolean | null;
|
|
2510
2626
|
}
|
|
@@ -2514,6 +2630,9 @@ export interface CreateItemFromUrlModel {
|
|
|
2514
2630
|
url?: string | null;
|
|
2515
2631
|
/** Target palette UID. */
|
|
2516
2632
|
paletteUID?: string | null;
|
|
2633
|
+
/** Index of image page (applies to multi-page image formats only, e.g. PDF and TIFF).
|
|
2634
|
+
Zero by default. */
|
|
2635
|
+
pageIndex?: number | null;
|
|
2517
2636
|
/** Headers that will be used to download remote image by URL.
|
|
2518
2637
|
For example, `Authorization` header can be placed here to provide access to image. */
|
|
2519
2638
|
headers?: {
|
|
@@ -2700,10 +2819,23 @@ export interface EditorMockupBindingModel {
|
|
|
2700
2819
|
/** Target surface index. */
|
|
2701
2820
|
surfaceIndex?: number;
|
|
2702
2821
|
}
|
|
2703
|
-
/**
|
|
2822
|
+
/** Image extraction operation parameters. */
|
|
2704
2823
|
export interface ExtractItemImageModel {
|
|
2705
2824
|
/** Serialized item description. */
|
|
2706
2825
|
item: any;
|
|
2826
|
+
/** Extraction format. */
|
|
2827
|
+
format?: ImageExtractionFormat | null;
|
|
2828
|
+
}
|
|
2829
|
+
/** Image extraction operation parameters. */
|
|
2830
|
+
export interface ExtractItemImageToResourceModel {
|
|
2831
|
+
/** Parameters of resource that should be created for a preview rendering result. */
|
|
2832
|
+
previewResourceParams?: ResourceParams | null;
|
|
2833
|
+
/** Flag that indicates if an existing resource should be overwritten. */
|
|
2834
|
+
overwriteExistingResource?: boolean | null;
|
|
2835
|
+
/** Serialized item description. */
|
|
2836
|
+
item: any;
|
|
2837
|
+
/** Extraction format. */
|
|
2838
|
+
format?: ImageExtractionFormat | null;
|
|
2707
2839
|
}
|
|
2708
2840
|
export interface FontsMethodData {
|
|
2709
2841
|
requestedFontsByPsName?: string[] | null;
|
|
@@ -2732,6 +2864,11 @@ export interface GetImageSizeRequest {
|
|
|
2732
2864
|
export interface GetShapeBoundsRequest {
|
|
2733
2865
|
path?: string | null;
|
|
2734
2866
|
}
|
|
2867
|
+
/** Image preview file format. */
|
|
2868
|
+
export declare enum ImageExtractionFormat {
|
|
2869
|
+
Jpeg = "Jpeg",
|
|
2870
|
+
Png = "Png"
|
|
2871
|
+
}
|
|
2735
2872
|
/** Image preview fit mode. */
|
|
2736
2873
|
export declare enum ImagePreviewFitMode {
|
|
2737
2874
|
Fit = "Fit",
|
|
@@ -2754,6 +2891,9 @@ export interface ImagePreviewRenderingConfig {
|
|
|
2754
2891
|
fileFormat?: ImagePreviewFormat | null;
|
|
2755
2892
|
/** Image preview fit mode. */
|
|
2756
2893
|
fitMode?: ImagePreviewFitMode | null;
|
|
2894
|
+
/** Index of image page (applies to multi-page image formats only, e.g. PDF and TIFF).
|
|
2895
|
+
Zero by default. */
|
|
2896
|
+
pageIndex?: number | null;
|
|
2757
2897
|
}
|
|
2758
2898
|
/** Item source types. */
|
|
2759
2899
|
export declare enum ItemSourceType {
|