@aurigma/ng-design-atoms-api-client 2.69.1 → 2.70.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.
Files changed (13) hide show
  1. package/aurigma-ng-design-atoms-api-client.metadata.json +1 -1
  2. package/bundles/aurigma-ng-design-atoms-api-client.umd.js +119 -72
  3. package/bundles/aurigma-ng-design-atoms-api-client.umd.js.map +1 -1
  4. package/bundles/aurigma-ng-design-atoms-api-client.umd.min.js +1 -1
  5. package/bundles/aurigma-ng-design-atoms-api-client.umd.min.js.map +1 -1
  6. package/esm2015/aurigma-ng-design-atoms-api-client.js +1 -1
  7. package/esm2015/lib/design-atoms-api-client.js +120 -73
  8. package/esm2015/lib/design-atoms-api.module.js +1 -1
  9. package/esm2015/public-api.js +1 -1
  10. package/fesm2015/aurigma-ng-design-atoms-api-client.js +119 -72
  11. package/fesm2015/aurigma-ng-design-atoms-api-client.js.map +1 -1
  12. package/lib/design-atoms-api-client.d.ts +184 -154
  13. package/package.json +1 -1
package/lib/design-atoms-api-client.d.ts CHANGED
@@ -91,24 +91,28 @@ export interface IDesignAtomsCompatibilityApiClient {
91
91
  */
92
92
  getWatermarkItems(tenantId: number, body?: any | undefined): Observable<any>;
93
93
  /**
94
- * @param f (optional)
95
- * @param w (optional)
96
- * @param h (optional)
97
- * @param cmyk (optional)
98
- * @param rgb (optional)
99
- * @param grayscale (optional)
100
- * @param target (optional)
101
- * @param sq (optional)
102
- * @param effect (optional)
103
- * @param kp (optional)
104
- * @param color (optional)
105
- * @param obm (optional)
106
- * @param oo (optional)
107
- * @param alphaMask (optional)
108
- * @param page (optional)
109
- * @param colorizeColor (optional)
110
- * @param rw (optional)
111
- * @param rh (optional)
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
+ * @param f (optional) The identifier of the original image file.
97
+ * @param w (optional) Target width of the resulting image.
98
+ * @param h (optional) Target height of the resulting image.
99
+ * @param cmyk (optional) Name of the CMYK profile used for color conversion.
100
+ * @param rgb (optional) Name of the RGB profile used for color conversion.
101
+ * @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`.
112
116
  * @return Success
113
117
  */
114
118
  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>;
@@ -127,24 +131,26 @@ export interface IDesignAtomsCompatibilityApiClient {
127
131
  */
128
132
  resource(tenantId: number, image?: string | null | undefined): Observable<FileResponse>;
129
133
  /**
130
- * @param f (optional)
131
- * @param w (optional)
132
- * @param h (optional)
133
- * @param cmyk (optional)
134
- * @param rgb (optional)
135
- * @param grayscale (optional)
136
- * @param target (optional)
137
- * @param sq (optional)
138
- * @param effect (optional)
139
- * @param kp (optional)
140
- * @param color (optional)
141
- * @param obm (optional)
142
- * @param oo (optional)
143
- * @param alphaMask (optional)
144
- * @param page (optional)
145
- * @param colorizeColor (optional)
146
- * @param rw (optional)
147
- * @param rh (optional)
134
+ * @param f (optional) The identifier of the original image file.
135
+ * @param w (optional) Target width of the resulting image.
136
+ * @param h (optional) Target height of the resulting image.
137
+ * @param cmyk (optional) Name of the CMYK profile used for color conversion.
138
+ * @param rgb (optional) Name of the RGB profile used for color conversion.
139
+ * @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`.
148
154
  * @return Success
149
155
  */
150
156
  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>;
@@ -267,24 +273,28 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
267
273
  getWatermarkItems(tenantId: number, body?: any | undefined): Observable<any>;
268
274
  protected processGetWatermarkItems(response: HttpResponseBase): Observable<any>;
269
275
  /**
270
- * @param f (optional)
271
- * @param w (optional)
272
- * @param h (optional)
273
- * @param cmyk (optional)
274
- * @param rgb (optional)
275
- * @param grayscale (optional)
276
- * @param target (optional)
277
- * @param sq (optional)
278
- * @param effect (optional)
279
- * @param kp (optional)
280
- * @param color (optional)
281
- * @param obm (optional)
282
- * @param oo (optional)
283
- * @param alphaMask (optional)
284
- * @param page (optional)
285
- * @param colorizeColor (optional)
286
- * @param rw (optional)
287
- * @param rh (optional)
276
+ * 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
+ * @param f (optional) The identifier of the original image file.
279
+ * @param w (optional) Target width of the resulting image.
280
+ * @param h (optional) Target height of the resulting image.
281
+ * @param cmyk (optional) Name of the CMYK profile used for color conversion.
282
+ * @param rgb (optional) Name of the RGB profile used for color conversion.
283
+ * @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`.
288
298
  * @return Success
289
299
  */
290
300
  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>;
@@ -307,24 +317,26 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
307
317
  resource(tenantId: number, image?: string | null | undefined): Observable<FileResponse>;
308
318
  protected processResource(response: HttpResponseBase): Observable<FileResponse>;
309
319
  /**
310
- * @param f (optional)
311
- * @param w (optional)
312
- * @param h (optional)
313
- * @param cmyk (optional)
314
- * @param rgb (optional)
315
- * @param grayscale (optional)
316
- * @param target (optional)
317
- * @param sq (optional)
318
- * @param effect (optional)
319
- * @param kp (optional)
320
- * @param color (optional)
321
- * @param obm (optional)
322
- * @param oo (optional)
323
- * @param alphaMask (optional)
324
- * @param page (optional)
325
- * @param colorizeColor (optional)
326
- * @param rw (optional)
327
- * @param rh (optional)
320
+ * @param f (optional) The identifier of the original image file.
321
+ * @param w (optional) Target width of the resulting image.
322
+ * @param h (optional) Target height of the resulting image.
323
+ * @param cmyk (optional) Name of the CMYK profile used for color conversion.
324
+ * @param rgb (optional) Name of the RGB profile used for color conversion.
325
+ * @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`.
328
340
  * @return Success
329
341
  */
330
342
  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>;
@@ -2046,24 +2058,28 @@ export interface IDesignAtomsViewerApiClient {
2046
2058
  */
2047
2059
  getWatermarkItems(tenantId?: number | undefined, body?: any | undefined): Observable<any>;
2048
2060
  /**
2049
- * @param f (optional)
2050
- * @param w (optional)
2051
- * @param h (optional)
2052
- * @param cmyk (optional)
2053
- * @param rgb (optional)
2054
- * @param grayscale (optional)
2055
- * @param target (optional)
2056
- * @param sq (optional)
2057
- * @param effect (optional)
2058
- * @param kp (optional)
2059
- * @param color (optional)
2060
- * @param obm (optional)
2061
- * @param oo (optional)
2062
- * @param alphaMask (optional)
2063
- * @param page (optional)
2064
- * @param colorizeColor (optional)
2065
- * @param rw (optional)
2066
- * @param rh (optional)
2061
+ * 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
+ * @param f (optional) The identifier of the original image file.
2064
+ * @param w (optional) Target width of the resulting image.
2065
+ * @param h (optional) Target height of the resulting image.
2066
+ * @param cmyk (optional) Name of the CMYK profile used for color conversion.
2067
+ * @param rgb (optional) Name of the RGB profile used for color conversion.
2068
+ * @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`.
2067
2083
  * @param tenantId (optional) Tenant ID.
2068
2084
  * @return Success
2069
2085
  */
@@ -2086,24 +2102,26 @@ export interface IDesignAtomsViewerApiClient {
2086
2102
  */
2087
2103
  resource(image?: string | null | undefined, tenantId?: number | undefined): Observable<FileResponse>;
2088
2104
  /**
2089
- * @param f (optional)
2090
- * @param w (optional)
2091
- * @param h (optional)
2092
- * @param cmyk (optional)
2093
- * @param rgb (optional)
2094
- * @param grayscale (optional)
2095
- * @param target (optional)
2096
- * @param sq (optional)
2097
- * @param effect (optional)
2098
- * @param kp (optional)
2099
- * @param color (optional)
2100
- * @param obm (optional)
2101
- * @param oo (optional)
2102
- * @param alphaMask (optional)
2103
- * @param page (optional)
2104
- * @param colorizeColor (optional)
2105
- * @param rw (optional)
2106
- * @param rh (optional)
2105
+ * @param f (optional) The identifier of the original image file.
2106
+ * @param w (optional) Target width of the resulting image.
2107
+ * @param h (optional) Target height of the resulting image.
2108
+ * @param cmyk (optional) Name of the CMYK profile used for color conversion.
2109
+ * @param rgb (optional) Name of the RGB profile used for color conversion.
2110
+ * @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`.
2107
2125
  * @param tenantId (optional) Tenant ID.
2108
2126
  * @return Success
2109
2127
  */
@@ -2248,24 +2266,28 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
2248
2266
  getWatermarkItems(tenantId?: number | undefined, body?: any | undefined): Observable<any>;
2249
2267
  protected processGetWatermarkItems(response: HttpResponseBase): Observable<any>;
2250
2268
  /**
2251
- * @param f (optional)
2252
- * @param w (optional)
2253
- * @param h (optional)
2254
- * @param cmyk (optional)
2255
- * @param rgb (optional)
2256
- * @param grayscale (optional)
2257
- * @param target (optional)
2258
- * @param sq (optional)
2259
- * @param effect (optional)
2260
- * @param kp (optional)
2261
- * @param color (optional)
2262
- * @param obm (optional)
2263
- * @param oo (optional)
2264
- * @param alphaMask (optional)
2265
- * @param page (optional)
2266
- * @param colorizeColor (optional)
2267
- * @param rw (optional)
2268
- * @param rh (optional)
2269
+ * 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
+ * @param f (optional) The identifier of the original image file.
2272
+ * @param w (optional) Target width of the resulting image.
2273
+ * @param h (optional) Target height of the resulting image.
2274
+ * @param cmyk (optional) Name of the CMYK profile used for color conversion.
2275
+ * @param rgb (optional) Name of the RGB profile used for color conversion.
2276
+ * @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`.
2269
2291
  * @param tenantId (optional) Tenant ID.
2270
2292
  * @return Success
2271
2293
  */
@@ -2292,24 +2314,26 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
2292
2314
  resource(image?: string | null | undefined, tenantId?: number | undefined): Observable<FileResponse>;
2293
2315
  protected processResource(response: HttpResponseBase): Observable<FileResponse>;
2294
2316
  /**
2295
- * @param f (optional)
2296
- * @param w (optional)
2297
- * @param h (optional)
2298
- * @param cmyk (optional)
2299
- * @param rgb (optional)
2300
- * @param grayscale (optional)
2301
- * @param target (optional)
2302
- * @param sq (optional)
2303
- * @param effect (optional)
2304
- * @param kp (optional)
2305
- * @param color (optional)
2306
- * @param obm (optional)
2307
- * @param oo (optional)
2308
- * @param alphaMask (optional)
2309
- * @param page (optional)
2310
- * @param colorizeColor (optional)
2311
- * @param rw (optional)
2312
- * @param rh (optional)
2317
+ * @param f (optional) The identifier of the original image file.
2318
+ * @param w (optional) Target width of the resulting image.
2319
+ * @param h (optional) Target height of the resulting image.
2320
+ * @param cmyk (optional) Name of the CMYK profile used for color conversion.
2321
+ * @param rgb (optional) Name of the RGB profile used for color conversion.
2322
+ * @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`.
2313
2337
  * @param tenantId (optional) Tenant ID.
2314
2338
  * @return Success
2315
2339
  */
@@ -2501,6 +2525,16 @@ For example, `Authorization` header can be placed here to provide access to imag
2501
2525
  /** Indicates if resulting item should store original source file. */
2502
2526
  preserveOriginalFile?: boolean | null;
2503
2527
  }
2528
+ export interface DesignElementProcessingConflictDto {
2529
+ /** Missing element type. */
2530
+ readonly missingElementType?: DesignElementType | null;
2531
+ /** Missing element type. */
2532
+ readonly unprocessedElementType?: DesignElementType | null;
2533
+ /** Problem description. */
2534
+ description?: string | null;
2535
+ /** Coflict type. */
2536
+ type?: ConflictType;
2537
+ }
2504
2538
  export declare enum DesignElementType {
2505
2539
  Product = "Product",
2506
2540
  Design = "Design",
@@ -2837,9 +2871,15 @@ export declare enum ProductPreviewFormat {
2837
2871
  Png = "Png"
2838
2872
  }
2839
2873
  export interface ProductPreviewRenderingConfig {
2874
+ /** Surface index. */
2840
2875
  surfaceIndex?: number | null;
2876
+ /** Indicates whether to show stub content for preview image. */
2877
+ stub?: boolean | null;
2878
+ /** Preview image width. */
2841
2879
  width?: number;
2880
+ /** Preview image height. */
2842
2881
  height?: number;
2882
+ /** Preview image file format. */
2843
2883
  fileFormat?: ProductPreviewFormat | null;
2844
2884
  }
2845
2885
  export declare enum ProductProofFormat {
@@ -3084,16 +3124,6 @@ export declare enum TextVerticalAlignment {
3084
3124
  Center = "Center",
3085
3125
  Bottom = "Bottom"
3086
3126
  }
3087
- export interface UnprocessableDesignElementDto {
3088
- /** Missing element type. */
3089
- readonly missingElementType?: DesignElementType | null;
3090
- /** Missing element type. */
3091
- readonly unprocessedElementType?: DesignElementType | null;
3092
- /** Problem description. */
3093
- description?: string | null;
3094
- /** Coflict type. */
3095
- type?: ConflictType;
3096
- }
3097
3127
  export interface UpdateColorsRequest {
3098
3128
  canvasData?: string | null;
3099
3129
  colorData?: string | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aurigma/ng-design-atoms-api-client",
3
- "version": "2.69.1",
3
+ "version": "2.70.1",
4
4
  "license": "SEE LICENSE IN License.md",
5
5
  "description": "Angular API Client for Design Atoms API service of Customer's Canvas web-to-print system.",
6
6
  "author": "Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)",