@aurigma/ng-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.
@@ -92,27 +92,38 @@ export interface IDesignAtomsCompatibilityApiClient {
92
92
  getWatermarkItems(tenantId: number, body?: any | undefined): Observable<any>;
93
93
  /**
94
94
  * Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
95
- This method accepts query parameters that control the output of the image.
96
95
  * @param f (optional) The identifier of the original image file.
97
96
  * @param w (optional) Target width of the resulting image.
98
97
  * @param h (optional) Target height of the resulting image.
99
98
  * @param cmyk (optional) Name of the CMYK profile used for color conversion.
100
99
  * @param rgb (optional) Name of the RGB profile used for color conversion.
101
100
  * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
102
- * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
103
- * @param sq (optional) Indicates that the image is squared. The default value is `false`.
104
- * @param effect (optional) Effect applied to the image. The default value is `"None"`.
105
- Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
106
- * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
107
- * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
108
- * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
109
- Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
110
- * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
111
- * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
112
- * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
113
- * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
114
- * @param rw (optional) Rectangle width for area selection. The default value is `0`.
115
- * @param rh (optional) Rectangle height for area selection. The default value is `0`.
101
+ * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
102
+ * @param sq (optional) Indicates that the image is squared.
103
+ The default value is "false".
104
+ * @param effect (optional) Effect applied to the image.
105
+ Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
106
+ The default value is "None".
107
+ * @param kp (optional) Indicates that image proportions should be maintained.
108
+ The default value is "false".
109
+ * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
110
+ By default, it's an empty string.
111
+ * @param obm (optional) Overlay blend mode used for blending colors.
112
+ Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
113
+ "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
114
+ By default, it's an empty string.
115
+ * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
116
+ The default value is "null".
117
+ * @param alphaMask (optional) Enables alpha mask processing.
118
+ The default value is "false".
119
+ * @param page (optional) Page index in a PDF document that needs to be processed.
120
+ The default value is "0".
121
+ * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
122
+ By default, it's an empty string.
123
+ * @param rw (optional) Rectangle width for area selection.
124
+ The default value is "0".
125
+ * @param rh (optional) Rectangle height for area selection.
126
+ The default value is "0".
116
127
  * @return Success
117
128
  */
118
129
  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): Observable<FileResponse>;
@@ -137,20 +148,32 @@ export interface IDesignAtomsCompatibilityApiClient {
137
148
  * @param cmyk (optional) Name of the CMYK profile used for color conversion.
138
149
  * @param rgb (optional) Name of the RGB profile used for color conversion.
139
150
  * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
140
- * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
141
- * @param sq (optional) Indicates that the image is squared. The default value is `false`.
142
- * @param effect (optional) Effect applied to the image. The default value is `"None"`.
143
- Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
144
- * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
145
- * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
146
- * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
147
- Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
148
- * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
149
- * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
150
- * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
151
- * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
152
- * @param rw (optional) Rectangle width for area selection. The default value is `0`.
153
- * @param rh (optional) Rectangle height for area selection. The default value is `0`.
151
+ * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
152
+ * @param sq (optional) Indicates that the image is squared.
153
+ The default value is "false".
154
+ * @param effect (optional) Effect applied to the image.
155
+ Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
156
+ The default value is "None".
157
+ * @param kp (optional) Indicates that image proportions should be maintained.
158
+ The default value is "false".
159
+ * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
160
+ By default, it's an empty string.
161
+ * @param obm (optional) Overlay blend mode used for blending colors.
162
+ Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
163
+ "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
164
+ By default, it's an empty string.
165
+ * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
166
+ The default value is "null".
167
+ * @param alphaMask (optional) Enables alpha mask processing.
168
+ The default value is "false".
169
+ * @param page (optional) Page index in a PDF document that needs to be processed.
170
+ The default value is "0".
171
+ * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
172
+ By default, it's an empty string.
173
+ * @param rw (optional) Rectangle width for area selection.
174
+ The default value is "0".
175
+ * @param rh (optional) Rectangle height for area selection.
176
+ The default value is "0".
154
177
  * @return Success
155
178
  */
156
179
  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): Observable<FileResponse>;
@@ -274,27 +297,38 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
274
297
  protected processGetWatermarkItems(response: HttpResponseBase): Observable<any>;
275
298
  /**
276
299
  * Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
277
- This method accepts query parameters that control the output of the image.
278
300
  * @param f (optional) The identifier of the original image file.
279
301
  * @param w (optional) Target width of the resulting image.
280
302
  * @param h (optional) Target height of the resulting image.
281
303
  * @param cmyk (optional) Name of the CMYK profile used for color conversion.
282
304
  * @param rgb (optional) Name of the RGB profile used for color conversion.
283
305
  * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
284
- * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
285
- * @param sq (optional) Indicates that the image is squared. The default value is `false`.
286
- * @param effect (optional) Effect applied to the image. The default value is `"None"`.
287
- Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
288
- * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
289
- * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
290
- * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
291
- Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
292
- * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
293
- * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
294
- * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
295
- * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
296
- * @param rw (optional) Rectangle width for area selection. The default value is `0`.
297
- * @param rh (optional) Rectangle height for area selection. The default value is `0`.
306
+ * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
307
+ * @param sq (optional) Indicates that the image is squared.
308
+ The default value is "false".
309
+ * @param effect (optional) Effect applied to the image.
310
+ Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
311
+ The default value is "None".
312
+ * @param kp (optional) Indicates that image proportions should be maintained.
313
+ The default value is "false".
314
+ * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
315
+ By default, it's an empty string.
316
+ * @param obm (optional) Overlay blend mode used for blending colors.
317
+ Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
318
+ "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
319
+ By default, it's an empty string.
320
+ * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
321
+ The default value is "null".
322
+ * @param alphaMask (optional) Enables alpha mask processing.
323
+ The default value is "false".
324
+ * @param page (optional) Page index in a PDF document that needs to be processed.
325
+ The default value is "0".
326
+ * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
327
+ By default, it's an empty string.
328
+ * @param rw (optional) Rectangle width for area selection.
329
+ The default value is "0".
330
+ * @param rh (optional) Rectangle height for area selection.
331
+ The default value is "0".
298
332
  * @return Success
299
333
  */
300
334
  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): Observable<FileResponse>;
@@ -323,20 +357,32 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
323
357
  * @param cmyk (optional) Name of the CMYK profile used for color conversion.
324
358
  * @param rgb (optional) Name of the RGB profile used for color conversion.
325
359
  * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
326
- * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
327
- * @param sq (optional) Indicates that the image is squared. The default value is `false`.
328
- * @param effect (optional) Effect applied to the image. The default value is `"None"`.
329
- Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
330
- * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
331
- * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
332
- * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
333
- Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
334
- * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
335
- * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
336
- * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
337
- * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
338
- * @param rw (optional) Rectangle width for area selection. The default value is `0`.
339
- * @param rh (optional) Rectangle height for area selection. The default value is `0`.
360
+ * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
361
+ * @param sq (optional) Indicates that the image is squared.
362
+ The default value is "false".
363
+ * @param effect (optional) Effect applied to the image.
364
+ Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
365
+ The default value is "None".
366
+ * @param kp (optional) Indicates that image proportions should be maintained.
367
+ The default value is "false".
368
+ * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
369
+ By default, it's an empty string.
370
+ * @param obm (optional) Overlay blend mode used for blending colors.
371
+ Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
372
+ "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
373
+ By default, it's an empty string.
374
+ * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
375
+ The default value is "null".
376
+ * @param alphaMask (optional) Enables alpha mask processing.
377
+ The default value is "false".
378
+ * @param page (optional) Page index in a PDF document that needs to be processed.
379
+ The default value is "0".
380
+ * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
381
+ By default, it's an empty string.
382
+ * @param rw (optional) Rectangle width for area selection.
383
+ The default value is "0".
384
+ * @param rh (optional) Rectangle height for area selection.
385
+ The default value is "0".
340
386
  * @return Success
341
387
  */
342
388
  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): Observable<FileResponse>;
@@ -436,9 +482,10 @@ export interface IDesignAtomsImagesApiClient {
436
482
  * @param height (optional)
437
483
  * @param fileFormat (optional)
438
484
  * @param fitMode (optional)
485
+ * @param pageIndex (optional)
439
486
  * @return Success
440
487
  */
441
- 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): Observable<FileResponse>;
488
+ 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): Observable<FileResponse>;
442
489
  /**
443
490
  * Renders a preview of an uploaded image with the specified parameters and saves rendering result as resource.
444
491
  * @param tenantId (optional) Tenant ID.
@@ -456,9 +503,10 @@ export interface IDesignAtomsImagesApiClient {
456
503
  * @param height (optional)
457
504
  * @param fileFormat (optional)
458
505
  * @param fitMode (optional)
506
+ * @param pageIndex (optional)
459
507
  * @return Success
460
508
  */
461
- 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): Observable<ResourceInfoDto>;
509
+ 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): Observable<ResourceInfoDto>;
462
510
  /**
463
511
  * Renders a preview of a web image with the specified parameters.
464
512
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
@@ -510,9 +558,10 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
510
558
  * @param height (optional)
511
559
  * @param fileFormat (optional)
512
560
  * @param fitMode (optional)
561
+ * @param pageIndex (optional)
513
562
  * @return Success
514
563
  */
515
- 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): Observable<FileResponse>;
564
+ 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): Observable<FileResponse>;
516
565
  protected processRenderImagePreviewFromFile(response: HttpResponseBase): Observable<FileResponse>;
517
566
  /**
518
567
  * Renders a preview of an uploaded image with the specified parameters and saves rendering result as resource.
@@ -531,9 +580,10 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
531
580
  * @param height (optional)
532
581
  * @param fileFormat (optional)
533
582
  * @param fitMode (optional)
583
+ * @param pageIndex (optional)
534
584
  * @return Success
535
585
  */
536
- 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): Observable<ResourceInfoDto>;
586
+ 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): Observable<ResourceInfoDto>;
537
587
  protected processRenderImagePreviewFromFileToResource(response: HttpResponseBase): Observable<ResourceInfoDto>;
538
588
  /**
539
589
  * Renders a preview of a web image with the specified parameters.
@@ -1339,6 +1389,13 @@ export interface IDesignAtomsPrintProductItemsApiClient {
1339
1389
  * @return Success
1340
1390
  */
1341
1391
  extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined): Observable<FileResponse>;
1392
+ /**
1393
+ * Extracts print-product item image.
1394
+ * @param tenantId (optional) Tenant ID.
1395
+ * @param body (optional) Extraction parameters.
1396
+ * @return Success
1397
+ */
1398
+ extractItemImageToResource(tenantId?: number | undefined, body?: ExtractItemImageToResourceModel | undefined): Observable<ResourceInfoDto>;
1342
1399
  /**
1343
1400
  * Flattens print-product items.
1344
1401
  * @param paletteUID (optional)
@@ -1353,10 +1410,11 @@ export interface IDesignAtomsPrintProductItemsApiClient {
1353
1410
  * @param tenantId (optional) Tenant ID.
1354
1411
  * @param sourceFile (optional)
1355
1412
  * @param paletteUID (optional)
1413
+ * @param pageIndex (optional)
1356
1414
  * @param preserveOriginalFile (optional)
1357
1415
  * @return Success
1358
1416
  */
1359
- createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, paletteUID?: string | null | undefined, preserveOriginalFile?: boolean | null | undefined): Observable<any>;
1417
+ createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, paletteUID?: string | null | undefined, pageIndex?: number | null | undefined, preserveOriginalFile?: boolean | null | undefined): Observable<any>;
1360
1418
  /**
1361
1419
  * Creates multiple print-product items from input image files.
1362
1420
  * @param itemType (optional) Desired print-product items type.
@@ -1421,6 +1479,14 @@ export declare class DesignAtomsPrintProductItemsApiClient extends ApiClientBase
1421
1479
  */
1422
1480
  extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined): Observable<FileResponse>;
1423
1481
  protected processExtractItemImage(response: HttpResponseBase): Observable<FileResponse>;
1482
+ /**
1483
+ * Extracts print-product item image.
1484
+ * @param tenantId (optional) Tenant ID.
1485
+ * @param body (optional) Extraction parameters.
1486
+ * @return Success
1487
+ */
1488
+ extractItemImageToResource(tenantId?: number | undefined, body?: ExtractItemImageToResourceModel | undefined): Observable<ResourceInfoDto>;
1489
+ protected processExtractItemImageToResource(response: HttpResponseBase): Observable<ResourceInfoDto>;
1424
1490
  /**
1425
1491
  * Flattens print-product items.
1426
1492
  * @param paletteUID (optional)
@@ -1436,10 +1502,11 @@ export declare class DesignAtomsPrintProductItemsApiClient extends ApiClientBase
1436
1502
  * @param tenantId (optional) Tenant ID.
1437
1503
  * @param sourceFile (optional)
1438
1504
  * @param paletteUID (optional)
1505
+ * @param pageIndex (optional)
1439
1506
  * @param preserveOriginalFile (optional)
1440
1507
  * @return Success
1441
1508
  */
1442
- createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, paletteUID?: string | null | undefined, preserveOriginalFile?: boolean | null | undefined): Observable<any>;
1509
+ createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, paletteUID?: string | null | undefined, pageIndex?: number | null | undefined, preserveOriginalFile?: boolean | null | undefined): Observable<any>;
1443
1510
  protected processCreateItemFromFile(response: HttpResponseBase): Observable<any>;
1444
1511
  /**
1445
1512
  * Creates multiple print-product items from input image files.
@@ -2059,27 +2126,38 @@ export interface IDesignAtomsViewerApiClient {
2059
2126
  getWatermarkItems(tenantId?: number | undefined, body?: any | undefined): Observable<any>;
2060
2127
  /**
2061
2128
  * Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
2062
- This method accepts query parameters that control the output of the image.
2063
2129
  * @param f (optional) The identifier of the original image file.
2064
2130
  * @param w (optional) Target width of the resulting image.
2065
2131
  * @param h (optional) Target height of the resulting image.
2066
2132
  * @param cmyk (optional) Name of the CMYK profile used for color conversion.
2067
2133
  * @param rgb (optional) Name of the RGB profile used for color conversion.
2068
2134
  * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
2069
- * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
2070
- * @param sq (optional) Indicates that the image is squared. The default value is `false`.
2071
- * @param effect (optional) Effect applied to the image. The default value is `"None"`.
2072
- Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
2073
- * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
2074
- * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
2075
- * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
2076
- Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
2077
- * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
2078
- * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
2079
- * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
2080
- * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
2081
- * @param rw (optional) Rectangle width for area selection. The default value is `0`.
2082
- * @param rh (optional) Rectangle height for area selection. The default value is `0`.
2135
+ * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
2136
+ * @param sq (optional) Indicates that the image is squared.
2137
+ The default value is "false".
2138
+ * @param effect (optional) Effect applied to the image.
2139
+ Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
2140
+ The default value is "None".
2141
+ * @param kp (optional) Indicates that image proportions should be maintained.
2142
+ The default value is "false".
2143
+ * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
2144
+ By default, it's an empty string.
2145
+ * @param obm (optional) Overlay blend mode used for blending colors.
2146
+ Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
2147
+ "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
2148
+ By default, it's an empty string.
2149
+ * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
2150
+ The default value is "null".
2151
+ * @param alphaMask (optional) Enables alpha mask processing.
2152
+ The default value is "false".
2153
+ * @param page (optional) Page index in a PDF document that needs to be processed.
2154
+ The default value is "0".
2155
+ * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
2156
+ By default, it's an empty string.
2157
+ * @param rw (optional) Rectangle width for area selection.
2158
+ The default value is "0".
2159
+ * @param rh (optional) Rectangle height for area selection.
2160
+ The default value is "0".
2083
2161
  * @param tenantId (optional) Tenant ID.
2084
2162
  * @return Success
2085
2163
  */
@@ -2108,20 +2186,32 @@ export interface IDesignAtomsViewerApiClient {
2108
2186
  * @param cmyk (optional) Name of the CMYK profile used for color conversion.
2109
2187
  * @param rgb (optional) Name of the RGB profile used for color conversion.
2110
2188
  * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
2111
- * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
2112
- * @param sq (optional) Indicates that the image is squared. The default value is `false`.
2113
- * @param effect (optional) Effect applied to the image. The default value is `"None"`.
2114
- Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
2115
- * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
2116
- * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
2117
- * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
2118
- Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
2119
- * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
2120
- * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
2121
- * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
2122
- * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
2123
- * @param rw (optional) Rectangle width for area selection. The default value is `0`.
2124
- * @param rh (optional) Rectangle height for area selection. The default value is `0`.
2189
+ * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
2190
+ * @param sq (optional) Indicates that the image is squared.
2191
+ The default value is "false".
2192
+ * @param effect (optional) Effect applied to the image.
2193
+ Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
2194
+ The default value is "None".
2195
+ * @param kp (optional) Indicates that image proportions should be maintained.
2196
+ The default value is "false".
2197
+ * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
2198
+ By default, it's an empty string.
2199
+ * @param obm (optional) Overlay blend mode used for blending colors.
2200
+ Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
2201
+ "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
2202
+ By default, it's an empty string.
2203
+ * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
2204
+ The default value is "null".
2205
+ * @param alphaMask (optional) Enables alpha mask processing.
2206
+ The default value is "false".
2207
+ * @param page (optional) Page index in a PDF document that needs to be processed.
2208
+ The default value is "0".
2209
+ * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
2210
+ By default, it's an empty string.
2211
+ * @param rw (optional) Rectangle width for area selection.
2212
+ The default value is "0".
2213
+ * @param rh (optional) Rectangle height for area selection.
2214
+ The default value is "0".
2125
2215
  * @param tenantId (optional) Tenant ID.
2126
2216
  * @return Success
2127
2217
  */
@@ -2267,27 +2357,38 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
2267
2357
  protected processGetWatermarkItems(response: HttpResponseBase): Observable<any>;
2268
2358
  /**
2269
2359
  * Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
2270
- This method accepts query parameters that control the output of the image.
2271
2360
  * @param f (optional) The identifier of the original image file.
2272
2361
  * @param w (optional) Target width of the resulting image.
2273
2362
  * @param h (optional) Target height of the resulting image.
2274
2363
  * @param cmyk (optional) Name of the CMYK profile used for color conversion.
2275
2364
  * @param rgb (optional) Name of the RGB profile used for color conversion.
2276
2365
  * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
2277
- * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
2278
- * @param sq (optional) Indicates that the image is squared. The default value is `false`.
2279
- * @param effect (optional) Effect applied to the image. The default value is `"None"`.
2280
- Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
2281
- * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
2282
- * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
2283
- * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
2284
- Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
2285
- * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
2286
- * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
2287
- * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
2288
- * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
2289
- * @param rw (optional) Rectangle width for area selection. The default value is `0`.
2290
- * @param rh (optional) Rectangle height for area selection. The default value is `0`.
2366
+ * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
2367
+ * @param sq (optional) Indicates that the image is squared.
2368
+ The default value is "false".
2369
+ * @param effect (optional) Effect applied to the image.
2370
+ Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
2371
+ The default value is "None".
2372
+ * @param kp (optional) Indicates that image proportions should be maintained.
2373
+ The default value is "false".
2374
+ * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
2375
+ By default, it's an empty string.
2376
+ * @param obm (optional) Overlay blend mode used for blending colors.
2377
+ Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
2378
+ "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
2379
+ By default, it's an empty string.
2380
+ * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
2381
+ The default value is "null".
2382
+ * @param alphaMask (optional) Enables alpha mask processing.
2383
+ The default value is "false".
2384
+ * @param page (optional) Page index in a PDF document that needs to be processed.
2385
+ The default value is "0".
2386
+ * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
2387
+ By default, it's an empty string.
2388
+ * @param rw (optional) Rectangle width for area selection.
2389
+ The default value is "0".
2390
+ * @param rh (optional) Rectangle height for area selection.
2391
+ The default value is "0".
2291
2392
  * @param tenantId (optional) Tenant ID.
2292
2393
  * @return Success
2293
2394
  */
@@ -2320,20 +2421,32 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
2320
2421
  * @param cmyk (optional) Name of the CMYK profile used for color conversion.
2321
2422
  * @param rgb (optional) Name of the RGB profile used for color conversion.
2322
2423
  * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
2323
- * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
2324
- * @param sq (optional) Indicates that the image is squared. The default value is `false`.
2325
- * @param effect (optional) Effect applied to the image. The default value is `"None"`.
2326
- Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
2327
- * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
2328
- * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
2329
- * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
2330
- Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
2331
- * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
2332
- * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
2333
- * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
2334
- * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
2335
- * @param rw (optional) Rectangle width for area selection. The default value is `0`.
2336
- * @param rh (optional) Rectangle height for area selection. The default value is `0`.
2424
+ * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
2425
+ * @param sq (optional) Indicates that the image is squared.
2426
+ The default value is "false".
2427
+ * @param effect (optional) Effect applied to the image.
2428
+ Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
2429
+ The default value is "None".
2430
+ * @param kp (optional) Indicates that image proportions should be maintained.
2431
+ The default value is "false".
2432
+ * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
2433
+ By default, it's an empty string.
2434
+ * @param obm (optional) Overlay blend mode used for blending colors.
2435
+ Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
2436
+ "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
2437
+ By default, it's an empty string.
2438
+ * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
2439
+ The default value is "null".
2440
+ * @param alphaMask (optional) Enables alpha mask processing.
2441
+ The default value is "false".
2442
+ * @param page (optional) Page index in a PDF document that needs to be processed.
2443
+ The default value is "0".
2444
+ * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
2445
+ By default, it's an empty string.
2446
+ * @param rw (optional) Rectangle width for area selection.
2447
+ The default value is "0".
2448
+ * @param rh (optional) Rectangle height for area selection.
2449
+ The default value is "0".
2337
2450
  * @param tenantId (optional) Tenant ID.
2338
2451
  * @return Success
2339
2452
  */
@@ -2508,6 +2621,9 @@ export interface CreateItemFromStorageModel {
2508
2621
  sourceId?: string | null;
2509
2622
  /** Target palette UID. */
2510
2623
  paletteUID?: string | null;
2624
+ /** Index of image page (applies to multi-page image formats only, e.g. PDF and TIFF).
2625
+ Zero by default. */
2626
+ pageIndex?: number | null;
2511
2627
  /** Indicates if resulting item should store original source file. */
2512
2628
  preserveOriginalFile?: boolean | null;
2513
2629
  }
@@ -2517,6 +2633,9 @@ export interface CreateItemFromUrlModel {
2517
2633
  url?: string | null;
2518
2634
  /** Target palette UID. */
2519
2635
  paletteUID?: string | null;
2636
+ /** Index of image page (applies to multi-page image formats only, e.g. PDF and TIFF).
2637
+ Zero by default. */
2638
+ pageIndex?: number | null;
2520
2639
  /** Headers that will be used to download remote image by URL.
2521
2640
  For example, `Authorization` header can be placed here to provide access to image. */
2522
2641
  headers?: {
@@ -2703,10 +2822,23 @@ export interface EditorMockupBindingModel {
2703
2822
  /** Target surface index. */
2704
2823
  surfaceIndex?: number;
2705
2824
  }
2706
- /** Item extraction operation parameters. */
2825
+ /** Image extraction operation parameters. */
2707
2826
  export interface ExtractItemImageModel {
2708
2827
  /** Serialized item description. */
2709
2828
  item: any;
2829
+ /** Extraction format. */
2830
+ format?: ImageExtractionFormat | null;
2831
+ }
2832
+ /** Image extraction operation parameters. */
2833
+ export interface ExtractItemImageToResourceModel {
2834
+ /** Parameters of resource that should be created for a preview rendering result. */
2835
+ previewResourceParams?: ResourceParams | null;
2836
+ /** Flag that indicates if an existing resource should be overwritten. */
2837
+ overwriteExistingResource?: boolean | null;
2838
+ /** Serialized item description. */
2839
+ item: any;
2840
+ /** Extraction format. */
2841
+ format?: ImageExtractionFormat | null;
2710
2842
  }
2711
2843
  export interface FontsMethodData {
2712
2844
  requestedFontsByPsName?: string[] | null;
@@ -2735,6 +2867,11 @@ export interface GetImageSizeRequest {
2735
2867
  export interface GetShapeBoundsRequest {
2736
2868
  path?: string | null;
2737
2869
  }
2870
+ /** Image preview file format. */
2871
+ export declare enum ImageExtractionFormat {
2872
+ Jpeg = "Jpeg",
2873
+ Png = "Png"
2874
+ }
2738
2875
  /** Image preview fit mode. */
2739
2876
  export declare enum ImagePreviewFitMode {
2740
2877
  Fit = "Fit",
@@ -2757,6 +2894,9 @@ export interface ImagePreviewRenderingConfig {
2757
2894
  fileFormat?: ImagePreviewFormat | null;
2758
2895
  /** Image preview fit mode. */
2759
2896
  fitMode?: ImagePreviewFitMode | null;
2897
+ /** Index of image page (applies to multi-page image formats only, e.g. PDF and TIFF).
2898
+ Zero by default. */
2899
+ pageIndex?: number | null;
2760
2900
  }
2761
2901
  /** Item source types. */
2762
2902
  export declare enum ItemSourceType {