@aurigma/axios-design-atoms-api-client 2.69.1 → 2.70.4
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 +184 -154
- package/dist/cjs/design-atoms-api-client.js +119 -72
- package/dist/cjs/design-atoms-api-client.js.map +1 -1
- package/dist/esm/design-atoms-api-client.d.ts +184 -154
- package/dist/esm/design-atoms-api-client.js +119 -72
- package/dist/esm/design-atoms-api-client.js.map +1 -1
- package/package.json +1 -1
|
@@ -88,24 +88,28 @@ export interface IDesignAtomsCompatibilityApiClient {
|
|
|
88
88
|
*/
|
|
89
89
|
getWatermarkItems(tenantId: number, body?: any | undefined): Promise<any>;
|
|
90
90
|
/**
|
|
91
|
-
*
|
|
92
|
-
|
|
93
|
-
* @param
|
|
94
|
-
* @param
|
|
95
|
-
* @param
|
|
96
|
-
* @param
|
|
97
|
-
* @param
|
|
98
|
-
* @param
|
|
99
|
-
* @param
|
|
100
|
-
* @param
|
|
101
|
-
* @param
|
|
102
|
-
|
|
103
|
-
* @param
|
|
104
|
-
* @param
|
|
105
|
-
* @param
|
|
106
|
-
|
|
107
|
-
* @param
|
|
108
|
-
* @param
|
|
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
|
+
* @param f (optional) The identifier of the original image file.
|
|
94
|
+
* @param w (optional) Target width of the resulting image.
|
|
95
|
+
* @param h (optional) Target height of the resulting image.
|
|
96
|
+
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
97
|
+
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
98
|
+
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
99
|
+
* @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
|
|
100
|
+
* @param sq (optional) Indicates that the image is squared. The default value is `false`.
|
|
101
|
+
* @param effect (optional) Effect applied to the image. The default value is `"None"`.
|
|
102
|
+
Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
|
|
103
|
+
* @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
|
|
104
|
+
* @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
|
|
105
|
+
* @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
|
|
106
|
+
Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
|
|
107
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
|
|
108
|
+
* @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
|
|
109
|
+
* @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
|
|
110
|
+
* @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
|
|
111
|
+
* @param rw (optional) Rectangle width for area selection. The default value is `0`.
|
|
112
|
+
* @param rh (optional) Rectangle height for area selection. The default value is `0`.
|
|
109
113
|
* @return Success
|
|
110
114
|
*/
|
|
111
115
|
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>;
|
|
@@ -124,24 +128,26 @@ export interface IDesignAtomsCompatibilityApiClient {
|
|
|
124
128
|
*/
|
|
125
129
|
resource(tenantId: number, image?: string | null | undefined): Promise<FileResponse>;
|
|
126
130
|
/**
|
|
127
|
-
* @param f (optional)
|
|
128
|
-
* @param w (optional)
|
|
129
|
-
* @param h (optional)
|
|
130
|
-
* @param cmyk (optional)
|
|
131
|
-
* @param rgb (optional)
|
|
132
|
-
* @param grayscale (optional)
|
|
133
|
-
* @param target (optional)
|
|
134
|
-
* @param sq (optional)
|
|
135
|
-
* @param effect (optional)
|
|
136
|
-
|
|
137
|
-
* @param
|
|
138
|
-
* @param
|
|
139
|
-
* @param
|
|
140
|
-
|
|
141
|
-
* @param
|
|
142
|
-
* @param
|
|
143
|
-
* @param
|
|
144
|
-
* @param
|
|
131
|
+
* @param f (optional) The identifier of the original image file.
|
|
132
|
+
* @param w (optional) Target width of the resulting image.
|
|
133
|
+
* @param h (optional) Target height of the resulting image.
|
|
134
|
+
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
135
|
+
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
136
|
+
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
137
|
+
* @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
|
|
138
|
+
* @param sq (optional) Indicates that the image is squared. The default value is `false`.
|
|
139
|
+
* @param effect (optional) Effect applied to the image. The default value is `"None"`.
|
|
140
|
+
Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
|
|
141
|
+
* @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
|
|
142
|
+
* @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
|
|
143
|
+
* @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
|
|
144
|
+
Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
|
|
145
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
|
|
146
|
+
* @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
|
|
147
|
+
* @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
|
|
148
|
+
* @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
|
|
149
|
+
* @param rw (optional) Rectangle width for area selection. The default value is `0`.
|
|
150
|
+
* @param rh (optional) Rectangle height for area selection. The default value is `0`.
|
|
145
151
|
* @return Success
|
|
146
152
|
*/
|
|
147
153
|
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>;
|
|
@@ -264,24 +270,28 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
|
|
|
264
270
|
getWatermarkItems(tenantId: number, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
265
271
|
protected processGetWatermarkItems(response: AxiosResponse): Promise<any>;
|
|
266
272
|
/**
|
|
267
|
-
*
|
|
268
|
-
|
|
269
|
-
* @param
|
|
270
|
-
* @param
|
|
271
|
-
* @param
|
|
272
|
-
* @param
|
|
273
|
-
* @param
|
|
274
|
-
* @param
|
|
275
|
-
* @param
|
|
276
|
-
* @param
|
|
277
|
-
* @param
|
|
278
|
-
|
|
279
|
-
* @param
|
|
280
|
-
* @param
|
|
281
|
-
* @param
|
|
282
|
-
|
|
283
|
-
* @param
|
|
284
|
-
* @param
|
|
273
|
+
* 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
|
+
* @param f (optional) The identifier of the original image file.
|
|
276
|
+
* @param w (optional) Target width of the resulting image.
|
|
277
|
+
* @param h (optional) Target height of the resulting image.
|
|
278
|
+
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
279
|
+
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
280
|
+
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
281
|
+
* @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
|
|
282
|
+
* @param sq (optional) Indicates that the image is squared. The default value is `false`.
|
|
283
|
+
* @param effect (optional) Effect applied to the image. The default value is `"None"`.
|
|
284
|
+
Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
|
|
285
|
+
* @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
|
|
286
|
+
* @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
|
|
287
|
+
* @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
|
|
288
|
+
Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
|
|
289
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
|
|
290
|
+
* @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
|
|
291
|
+
* @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
|
|
292
|
+
* @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
|
|
293
|
+
* @param rw (optional) Rectangle width for area selection. The default value is `0`.
|
|
294
|
+
* @param rh (optional) Rectangle height for area selection. The default value is `0`.
|
|
285
295
|
* @return Success
|
|
286
296
|
*/
|
|
287
297
|
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>;
|
|
@@ -304,24 +314,26 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
|
|
|
304
314
|
resource(tenantId: number, image?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
305
315
|
protected processResource(response: AxiosResponse): Promise<FileResponse>;
|
|
306
316
|
/**
|
|
307
|
-
* @param f (optional)
|
|
308
|
-
* @param w (optional)
|
|
309
|
-
* @param h (optional)
|
|
310
|
-
* @param cmyk (optional)
|
|
311
|
-
* @param rgb (optional)
|
|
312
|
-
* @param grayscale (optional)
|
|
313
|
-
* @param target (optional)
|
|
314
|
-
* @param sq (optional)
|
|
315
|
-
* @param effect (optional)
|
|
316
|
-
|
|
317
|
-
* @param
|
|
318
|
-
* @param
|
|
319
|
-
* @param
|
|
320
|
-
|
|
321
|
-
* @param
|
|
322
|
-
* @param
|
|
323
|
-
* @param
|
|
324
|
-
* @param
|
|
317
|
+
* @param f (optional) The identifier of the original image file.
|
|
318
|
+
* @param w (optional) Target width of the resulting image.
|
|
319
|
+
* @param h (optional) Target height of the resulting image.
|
|
320
|
+
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
321
|
+
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
322
|
+
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
323
|
+
* @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
|
|
324
|
+
* @param sq (optional) Indicates that the image is squared. The default value is `false`.
|
|
325
|
+
* @param effect (optional) Effect applied to the image. The default value is `"None"`.
|
|
326
|
+
Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
|
|
327
|
+
* @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
|
|
328
|
+
* @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
|
|
329
|
+
* @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
|
|
330
|
+
Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
|
|
331
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
|
|
332
|
+
* @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
|
|
333
|
+
* @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
|
|
334
|
+
* @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
|
|
335
|
+
* @param rw (optional) Rectangle width for area selection. The default value is `0`.
|
|
336
|
+
* @param rh (optional) Rectangle height for area selection. The default value is `0`.
|
|
325
337
|
* @return Success
|
|
326
338
|
*/
|
|
327
339
|
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>;
|
|
@@ -2043,24 +2055,28 @@ export interface IDesignAtomsViewerApiClient {
|
|
|
2043
2055
|
*/
|
|
2044
2056
|
getWatermarkItems(tenantId?: number | undefined, body?: any | undefined): Promise<any>;
|
|
2045
2057
|
/**
|
|
2046
|
-
*
|
|
2047
|
-
|
|
2048
|
-
* @param
|
|
2049
|
-
* @param
|
|
2050
|
-
* @param
|
|
2051
|
-
* @param
|
|
2052
|
-
* @param
|
|
2053
|
-
* @param
|
|
2054
|
-
* @param
|
|
2055
|
-
* @param
|
|
2056
|
-
* @param
|
|
2057
|
-
|
|
2058
|
-
* @param
|
|
2059
|
-
* @param
|
|
2060
|
-
* @param
|
|
2061
|
-
|
|
2062
|
-
* @param
|
|
2063
|
-
* @param
|
|
2058
|
+
* 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
|
+
* @param f (optional) The identifier of the original image file.
|
|
2061
|
+
* @param w (optional) Target width of the resulting image.
|
|
2062
|
+
* @param h (optional) Target height of the resulting image.
|
|
2063
|
+
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
2064
|
+
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
2065
|
+
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
2066
|
+
* @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
|
|
2067
|
+
* @param sq (optional) Indicates that the image is squared. The default value is `false`.
|
|
2068
|
+
* @param effect (optional) Effect applied to the image. The default value is `"None"`.
|
|
2069
|
+
Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
|
|
2070
|
+
* @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
|
|
2071
|
+
* @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
|
|
2072
|
+
* @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
|
|
2073
|
+
Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
|
|
2074
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
|
|
2075
|
+
* @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
|
|
2076
|
+
* @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
|
|
2077
|
+
* @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
|
|
2078
|
+
* @param rw (optional) Rectangle width for area selection. The default value is `0`.
|
|
2079
|
+
* @param rh (optional) Rectangle height for area selection. The default value is `0`.
|
|
2064
2080
|
* @param tenantId (optional) Tenant ID.
|
|
2065
2081
|
* @return Success
|
|
2066
2082
|
*/
|
|
@@ -2083,24 +2099,26 @@ export interface IDesignAtomsViewerApiClient {
|
|
|
2083
2099
|
*/
|
|
2084
2100
|
resource(image?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
|
|
2085
2101
|
/**
|
|
2086
|
-
* @param f (optional)
|
|
2087
|
-
* @param w (optional)
|
|
2088
|
-
* @param h (optional)
|
|
2089
|
-
* @param cmyk (optional)
|
|
2090
|
-
* @param rgb (optional)
|
|
2091
|
-
* @param grayscale (optional)
|
|
2092
|
-
* @param target (optional)
|
|
2093
|
-
* @param sq (optional)
|
|
2094
|
-
* @param effect (optional)
|
|
2095
|
-
|
|
2096
|
-
* @param
|
|
2097
|
-
* @param
|
|
2098
|
-
* @param
|
|
2099
|
-
|
|
2100
|
-
* @param
|
|
2101
|
-
* @param
|
|
2102
|
-
* @param
|
|
2103
|
-
* @param
|
|
2102
|
+
* @param f (optional) The identifier of the original image file.
|
|
2103
|
+
* @param w (optional) Target width of the resulting image.
|
|
2104
|
+
* @param h (optional) Target height of the resulting image.
|
|
2105
|
+
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
2106
|
+
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
2107
|
+
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
2108
|
+
* @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
|
|
2109
|
+
* @param sq (optional) Indicates that the image is squared. The default value is `false`.
|
|
2110
|
+
* @param effect (optional) Effect applied to the image. The default value is `"None"`.
|
|
2111
|
+
Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
|
|
2112
|
+
* @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
|
|
2113
|
+
* @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
|
|
2114
|
+
* @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
|
|
2115
|
+
Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
|
|
2116
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
|
|
2117
|
+
* @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
|
|
2118
|
+
* @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
|
|
2119
|
+
* @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
|
|
2120
|
+
* @param rw (optional) Rectangle width for area selection. The default value is `0`.
|
|
2121
|
+
* @param rh (optional) Rectangle height for area selection. The default value is `0`.
|
|
2104
2122
|
* @param tenantId (optional) Tenant ID.
|
|
2105
2123
|
* @return Success
|
|
2106
2124
|
*/
|
|
@@ -2245,24 +2263,28 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
|
|
|
2245
2263
|
getWatermarkItems(tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
2246
2264
|
protected processGetWatermarkItems(response: AxiosResponse): Promise<any>;
|
|
2247
2265
|
/**
|
|
2248
|
-
*
|
|
2249
|
-
|
|
2250
|
-
* @param
|
|
2251
|
-
* @param
|
|
2252
|
-
* @param
|
|
2253
|
-
* @param
|
|
2254
|
-
* @param
|
|
2255
|
-
* @param
|
|
2256
|
-
* @param
|
|
2257
|
-
* @param
|
|
2258
|
-
* @param
|
|
2259
|
-
|
|
2260
|
-
* @param
|
|
2261
|
-
* @param
|
|
2262
|
-
* @param
|
|
2263
|
-
|
|
2264
|
-
* @param
|
|
2265
|
-
* @param
|
|
2266
|
+
* 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
|
+
* @param f (optional) The identifier of the original image file.
|
|
2269
|
+
* @param w (optional) Target width of the resulting image.
|
|
2270
|
+
* @param h (optional) Target height of the resulting image.
|
|
2271
|
+
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
2272
|
+
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
2273
|
+
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
2274
|
+
* @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
|
|
2275
|
+
* @param sq (optional) Indicates that the image is squared. The default value is `false`.
|
|
2276
|
+
* @param effect (optional) Effect applied to the image. The default value is `"None"`.
|
|
2277
|
+
Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
|
|
2278
|
+
* @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
|
|
2279
|
+
* @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
|
|
2280
|
+
* @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
|
|
2281
|
+
Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
|
|
2282
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
|
|
2283
|
+
* @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
|
|
2284
|
+
* @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
|
|
2285
|
+
* @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
|
|
2286
|
+
* @param rw (optional) Rectangle width for area selection. The default value is `0`.
|
|
2287
|
+
* @param rh (optional) Rectangle height for area selection. The default value is `0`.
|
|
2266
2288
|
* @param tenantId (optional) Tenant ID.
|
|
2267
2289
|
* @return Success
|
|
2268
2290
|
*/
|
|
@@ -2289,24 +2311,26 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
|
|
|
2289
2311
|
resource(image?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
2290
2312
|
protected processResource(response: AxiosResponse): Promise<FileResponse>;
|
|
2291
2313
|
/**
|
|
2292
|
-
* @param f (optional)
|
|
2293
|
-
* @param w (optional)
|
|
2294
|
-
* @param h (optional)
|
|
2295
|
-
* @param cmyk (optional)
|
|
2296
|
-
* @param rgb (optional)
|
|
2297
|
-
* @param grayscale (optional)
|
|
2298
|
-
* @param target (optional)
|
|
2299
|
-
* @param sq (optional)
|
|
2300
|
-
* @param effect (optional)
|
|
2301
|
-
|
|
2302
|
-
* @param
|
|
2303
|
-
* @param
|
|
2304
|
-
* @param
|
|
2305
|
-
|
|
2306
|
-
* @param
|
|
2307
|
-
* @param
|
|
2308
|
-
* @param
|
|
2309
|
-
* @param
|
|
2314
|
+
* @param f (optional) The identifier of the original image file.
|
|
2315
|
+
* @param w (optional) Target width of the resulting image.
|
|
2316
|
+
* @param h (optional) Target height of the resulting image.
|
|
2317
|
+
* @param cmyk (optional) Name of the CMYK profile used for color conversion.
|
|
2318
|
+
* @param rgb (optional) Name of the RGB profile used for color conversion.
|
|
2319
|
+
* @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
|
|
2320
|
+
* @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
|
|
2321
|
+
* @param sq (optional) Indicates that the image is squared. The default value is `false`.
|
|
2322
|
+
* @param effect (optional) Effect applied to the image. The default value is `"None"`.
|
|
2323
|
+
Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
|
|
2324
|
+
* @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
|
|
2325
|
+
* @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
|
|
2326
|
+
* @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
|
|
2327
|
+
Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
|
|
2328
|
+
* @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
|
|
2329
|
+
* @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
|
|
2330
|
+
* @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
|
|
2331
|
+
* @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
|
|
2332
|
+
* @param rw (optional) Rectangle width for area selection. The default value is `0`.
|
|
2333
|
+
* @param rh (optional) Rectangle height for area selection. The default value is `0`.
|
|
2310
2334
|
* @param tenantId (optional) Tenant ID.
|
|
2311
2335
|
* @return Success
|
|
2312
2336
|
*/
|
|
@@ -2498,6 +2522,16 @@ For example, `Authorization` header can be placed here to provide access to imag
|
|
|
2498
2522
|
/** Indicates if resulting item should store original source file. */
|
|
2499
2523
|
preserveOriginalFile?: boolean | null;
|
|
2500
2524
|
}
|
|
2525
|
+
export interface DesignElementProcessingConflictDto {
|
|
2526
|
+
/** Missing element type. */
|
|
2527
|
+
readonly missingElementType?: DesignElementType | null;
|
|
2528
|
+
/** Missing element type. */
|
|
2529
|
+
readonly unprocessedElementType?: DesignElementType | null;
|
|
2530
|
+
/** Problem description. */
|
|
2531
|
+
description?: string | null;
|
|
2532
|
+
/** Coflict type. */
|
|
2533
|
+
type?: ConflictType;
|
|
2534
|
+
}
|
|
2501
2535
|
export declare enum DesignElementType {
|
|
2502
2536
|
Product = "Product",
|
|
2503
2537
|
Design = "Design",
|
|
@@ -2834,9 +2868,15 @@ export declare enum ProductPreviewFormat {
|
|
|
2834
2868
|
Png = "Png"
|
|
2835
2869
|
}
|
|
2836
2870
|
export interface ProductPreviewRenderingConfig {
|
|
2871
|
+
/** Surface index. */
|
|
2837
2872
|
surfaceIndex?: number | null;
|
|
2873
|
+
/** Indicates whether to show stub content for preview image. */
|
|
2874
|
+
stub?: boolean | null;
|
|
2875
|
+
/** Preview image width. */
|
|
2838
2876
|
width?: number;
|
|
2877
|
+
/** Preview image height. */
|
|
2839
2878
|
height?: number;
|
|
2879
|
+
/** Preview image file format. */
|
|
2840
2880
|
fileFormat?: ProductPreviewFormat | null;
|
|
2841
2881
|
}
|
|
2842
2882
|
export declare enum ProductProofFormat {
|
|
@@ -3081,16 +3121,6 @@ export declare enum TextVerticalAlignment {
|
|
|
3081
3121
|
Center = "Center",
|
|
3082
3122
|
Bottom = "Bottom"
|
|
3083
3123
|
}
|
|
3084
|
-
export interface UnprocessableDesignElementDto {
|
|
3085
|
-
/** Missing element type. */
|
|
3086
|
-
readonly missingElementType?: DesignElementType | null;
|
|
3087
|
-
/** Missing element type. */
|
|
3088
|
-
readonly unprocessedElementType?: DesignElementType | null;
|
|
3089
|
-
/** Problem description. */
|
|
3090
|
-
description?: string | null;
|
|
3091
|
-
/** Coflict type. */
|
|
3092
|
-
type?: ConflictType;
|
|
3093
|
-
}
|
|
3094
3124
|
export interface UpdateColorsRequest {
|
|
3095
3125
|
canvasData?: string | null;
|
|
3096
3126
|
colorData?: string | null;
|