@aurigma/axios-design-atoms-api-client 2.46.1 → 2.50.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.
@@ -58,7 +58,7 @@ export class BuildInfoApiClient extends ApiClientBase {
58
58
  this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : this.getBaseUrl("");
59
59
  }
60
60
  /**
61
- * Gets assembly build info
61
+ * Get assembly build info.
62
62
  * @return Success
63
63
  */
64
64
  headInfo(cancelToken) {
@@ -111,7 +111,7 @@ export class BuildInfoApiClient extends ApiClientBase {
111
111
  return Promise.resolve(null);
112
112
  }
113
113
  /**
114
- * Gets assembly build info
114
+ * Get assembly build info.
115
115
  * @return Success
116
116
  */
117
117
  getInfo(cancelToken) {
@@ -2083,6 +2083,81 @@ export class DesignAtomsImagesApiClient extends ApiClientBase {
2083
2083
  }
2084
2084
  return Promise.resolve(null);
2085
2085
  }
2086
+ /**
2087
+ * Renders a web image preview with the specified parameters and saves rendering result as resource.
2088
+ * @param tenantId (optional) Tenant identifier
2089
+ * @param body (optional) Render model with preview parameters.
2090
+ * @return Success
2091
+ */
2092
+ renderImagePreviewToResource(tenantId, body, cancelToken) {
2093
+ let url_ = this.baseUrl + "/api/atoms/v1/images/render-image-preview/to-resource?";
2094
+ if (tenantId === null)
2095
+ throw new Error("The parameter 'tenantId' cannot be null.");
2096
+ else if (tenantId !== undefined)
2097
+ url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
2098
+ url_ = url_.replace(/[?&]$/, "");
2099
+ const content_ = JSON.stringify(body);
2100
+ let options_ = {
2101
+ data: content_,
2102
+ method: "POST",
2103
+ url: url_,
2104
+ headers: {
2105
+ "Content-Type": "application/json",
2106
+ "Accept": "application/json"
2107
+ },
2108
+ cancelToken
2109
+ };
2110
+ return this.transformOptions(options_).then(transformedOptions_ => {
2111
+ return this.instance.request(transformedOptions_);
2112
+ }).catch((_error) => {
2113
+ if (isAxiosError(_error) && _error.response) {
2114
+ return _error.response;
2115
+ }
2116
+ else {
2117
+ throw _error;
2118
+ }
2119
+ }).then((_response) => {
2120
+ return this.transformResult(url_, _response, (_response) => this.processRenderImagePreviewToResource(_response));
2121
+ });
2122
+ }
2123
+ processRenderImagePreviewToResource(response) {
2124
+ const status = response.status;
2125
+ let _headers = {};
2126
+ if (response.headers && typeof response.headers === "object") {
2127
+ for (let k in response.headers) {
2128
+ if (response.headers.hasOwnProperty(k)) {
2129
+ _headers[k] = response.headers[k];
2130
+ }
2131
+ }
2132
+ }
2133
+ if (status === 200) {
2134
+ const _responseText = response.data;
2135
+ let result200 = null;
2136
+ let resultData200 = _responseText;
2137
+ result200 = JSON.parse(resultData200);
2138
+ return Promise.resolve(result200);
2139
+ }
2140
+ else if (status === 401) {
2141
+ const _responseText = response.data;
2142
+ return throwException("Unauthorized", status, _responseText, _headers);
2143
+ }
2144
+ else if (status === 403) {
2145
+ const _responseText = response.data;
2146
+ return throwException("Forbidden", status, _responseText, _headers);
2147
+ }
2148
+ else if (status === 500) {
2149
+ const _responseText = response.data;
2150
+ let result500 = null;
2151
+ let resultData500 = _responseText;
2152
+ result500 = JSON.parse(resultData500);
2153
+ return throwException("Internal server error", status, _responseText, _headers, result500);
2154
+ }
2155
+ else if (status !== 200 && status !== 204) {
2156
+ const _responseText = response.data;
2157
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
2158
+ }
2159
+ return Promise.resolve(null);
2160
+ }
2086
2161
  }
2087
2162
  export class DesignAtomsMockups3dApiClient extends ApiClientBase {
2088
2163
  instance;
@@ -2920,6 +2995,91 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
2920
2995
  }
2921
2996
  return Promise.resolve(null);
2922
2997
  }
2998
+ /**
2999
+ * Returns design parameters stored in product model.
3000
+ * @param id Design identifier.
3001
+ * @param privateStorageOwner (optional) Private storage owner identifier.
3002
+ * @param tenantId (optional) Tenant identifier
3003
+ * @return Success
3004
+ */
3005
+ getDesignParameters(id, privateStorageOwner, tenantId, cancelToken) {
3006
+ let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/parameters?";
3007
+ if (id === undefined || id === null)
3008
+ throw new Error("The parameter 'id' must be defined.");
3009
+ url_ = url_.replace("{id}", encodeURIComponent("" + id));
3010
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
3011
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
3012
+ if (tenantId === null)
3013
+ throw new Error("The parameter 'tenantId' cannot be null.");
3014
+ else if (tenantId !== undefined)
3015
+ url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
3016
+ url_ = url_.replace(/[?&]$/, "");
3017
+ let options_ = {
3018
+ method: "GET",
3019
+ url: url_,
3020
+ headers: {
3021
+ "Accept": "application/json"
3022
+ },
3023
+ cancelToken
3024
+ };
3025
+ return this.transformOptions(options_).then(transformedOptions_ => {
3026
+ return this.instance.request(transformedOptions_);
3027
+ }).catch((_error) => {
3028
+ if (isAxiosError(_error) && _error.response) {
3029
+ return _error.response;
3030
+ }
3031
+ else {
3032
+ throw _error;
3033
+ }
3034
+ }).then((_response) => {
3035
+ return this.transformResult(url_, _response, (_response) => this.processGetDesignParameters(_response));
3036
+ });
3037
+ }
3038
+ processGetDesignParameters(response) {
3039
+ const status = response.status;
3040
+ let _headers = {};
3041
+ if (response.headers && typeof response.headers === "object") {
3042
+ for (let k in response.headers) {
3043
+ if (response.headers.hasOwnProperty(k)) {
3044
+ _headers[k] = response.headers[k];
3045
+ }
3046
+ }
3047
+ }
3048
+ if (status === 200) {
3049
+ const _responseText = response.data;
3050
+ let result200 = null;
3051
+ let resultData200 = _responseText;
3052
+ result200 = JSON.parse(resultData200);
3053
+ return Promise.resolve(result200);
3054
+ }
3055
+ else if (status === 404) {
3056
+ const _responseText = response.data;
3057
+ let result404 = null;
3058
+ let resultData404 = _responseText;
3059
+ result404 = JSON.parse(resultData404);
3060
+ return throwException("Not Found", status, _responseText, _headers, result404);
3061
+ }
3062
+ else if (status === 401) {
3063
+ const _responseText = response.data;
3064
+ return throwException("Unauthorized", status, _responseText, _headers);
3065
+ }
3066
+ else if (status === 403) {
3067
+ const _responseText = response.data;
3068
+ return throwException("Forbidden", status, _responseText, _headers);
3069
+ }
3070
+ else if (status === 500) {
3071
+ const _responseText = response.data;
3072
+ let result500 = null;
3073
+ let resultData500 = _responseText;
3074
+ result500 = JSON.parse(resultData500);
3075
+ return throwException("Internal server error", status, _responseText, _headers, result500);
3076
+ }
3077
+ else if (status !== 200 && status !== 204) {
3078
+ const _responseText = response.data;
3079
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
3080
+ }
3081
+ return Promise.resolve(null);
3082
+ }
2923
3083
  /**
2924
3084
  * Loads data schema from design file taken from storage
2925
3085
  * @param id Design identifier
@@ -3634,6 +3794,81 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
3634
3794
  }
3635
3795
  return Promise.resolve(null);
3636
3796
  }
3797
+ /**
3798
+ * Extracts product item image.
3799
+ * @param tenantId (optional) Tenant identifier
3800
+ * @param body (optional) Extraction parameters.
3801
+ * @return Success
3802
+ */
3803
+ extractItemImage(tenantId, body, cancelToken) {
3804
+ let url_ = this.baseUrl + "/api/atoms/v1/itemExtractor?";
3805
+ if (tenantId === null)
3806
+ throw new Error("The parameter 'tenantId' cannot be null.");
3807
+ else if (tenantId !== undefined)
3808
+ url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
3809
+ url_ = url_.replace(/[?&]$/, "");
3810
+ const content_ = JSON.stringify(body);
3811
+ let options_ = {
3812
+ data: content_,
3813
+ responseType: "blob",
3814
+ method: "POST",
3815
+ url: url_,
3816
+ headers: {
3817
+ "Content-Type": "application/json",
3818
+ "Accept": "application/octet-stream"
3819
+ },
3820
+ cancelToken
3821
+ };
3822
+ return this.transformOptions(options_).then(transformedOptions_ => {
3823
+ return this.instance.request(transformedOptions_);
3824
+ }).catch((_error) => {
3825
+ if (isAxiosError(_error) && _error.response) {
3826
+ return _error.response;
3827
+ }
3828
+ else {
3829
+ throw _error;
3830
+ }
3831
+ }).then((_response) => {
3832
+ return this.transformResult(url_, _response, (_response) => this.processExtractItemImage(_response));
3833
+ });
3834
+ }
3835
+ processExtractItemImage(response) {
3836
+ const status = response.status;
3837
+ let _headers = {};
3838
+ if (response.headers && typeof response.headers === "object") {
3839
+ for (let k in response.headers) {
3840
+ if (response.headers.hasOwnProperty(k)) {
3841
+ _headers[k] = response.headers[k];
3842
+ }
3843
+ }
3844
+ }
3845
+ if (status === 200 || status === 206) {
3846
+ const contentDisposition = response.headers ? response.headers["content-disposition"] : undefined;
3847
+ const fileNameMatch = contentDisposition ? /filename="?([^"]*?)"?(;|$)/g.exec(contentDisposition) : undefined;
3848
+ const fileName = fileNameMatch && fileNameMatch.length > 1 ? fileNameMatch[1] : undefined;
3849
+ return Promise.resolve({ fileName: fileName, status: status, data: new Blob([response.data]), headers: _headers });
3850
+ }
3851
+ else if (status === 401) {
3852
+ const _responseText = response.data;
3853
+ return throwException("Unauthorized", status, _responseText, _headers);
3854
+ }
3855
+ else if (status === 403) {
3856
+ const _responseText = response.data;
3857
+ return throwException("Forbidden", status, _responseText, _headers);
3858
+ }
3859
+ else if (status === 500) {
3860
+ const _responseText = response.data;
3861
+ let result500 = null;
3862
+ let resultData500 = _responseText;
3863
+ result500 = JSON.parse(resultData500);
3864
+ return throwException("Internal server error", status, _responseText, _headers, result500);
3865
+ }
3866
+ else if (status !== 200 && status !== 204) {
3867
+ const _responseText = response.data;
3868
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
3869
+ }
3870
+ return Promise.resolve(null);
3871
+ }
3637
3872
  /**
3638
3873
  * Creates a private design from a public design.
3639
3874
  * @param designId (optional) Public design ID.
@@ -3863,6 +4098,81 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
3863
4098
  }
3864
4099
  return Promise.resolve(null);
3865
4100
  }
4101
+ /**
4102
+ * Renders a design preview with the specified parameters and saves rendering result as resource.
4103
+ * @param tenantId (optional) Tenant identifier
4104
+ * @param body (optional) Render model with preview parameters.
4105
+ * @return Success
4106
+ */
4107
+ renderDesignPreviewToResource(tenantId, body, cancelToken) {
4108
+ let url_ = this.baseUrl + "/api/atoms/v1/render-design-preview/to-resource?";
4109
+ if (tenantId === null)
4110
+ throw new Error("The parameter 'tenantId' cannot be null.");
4111
+ else if (tenantId !== undefined)
4112
+ url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
4113
+ url_ = url_.replace(/[?&]$/, "");
4114
+ const content_ = JSON.stringify(body);
4115
+ let options_ = {
4116
+ data: content_,
4117
+ method: "POST",
4118
+ url: url_,
4119
+ headers: {
4120
+ "Content-Type": "application/json",
4121
+ "Accept": "application/json"
4122
+ },
4123
+ cancelToken
4124
+ };
4125
+ return this.transformOptions(options_).then(transformedOptions_ => {
4126
+ return this.instance.request(transformedOptions_);
4127
+ }).catch((_error) => {
4128
+ if (isAxiosError(_error) && _error.response) {
4129
+ return _error.response;
4130
+ }
4131
+ else {
4132
+ throw _error;
4133
+ }
4134
+ }).then((_response) => {
4135
+ return this.transformResult(url_, _response, (_response) => this.processRenderDesignPreviewToResource(_response));
4136
+ });
4137
+ }
4138
+ processRenderDesignPreviewToResource(response) {
4139
+ const status = response.status;
4140
+ let _headers = {};
4141
+ if (response.headers && typeof response.headers === "object") {
4142
+ for (let k in response.headers) {
4143
+ if (response.headers.hasOwnProperty(k)) {
4144
+ _headers[k] = response.headers[k];
4145
+ }
4146
+ }
4147
+ }
4148
+ if (status === 200) {
4149
+ const _responseText = response.data;
4150
+ let result200 = null;
4151
+ let resultData200 = _responseText;
4152
+ result200 = JSON.parse(resultData200);
4153
+ return Promise.resolve(result200);
4154
+ }
4155
+ else if (status === 401) {
4156
+ const _responseText = response.data;
4157
+ return throwException("Unauthorized", status, _responseText, _headers);
4158
+ }
4159
+ else if (status === 403) {
4160
+ const _responseText = response.data;
4161
+ return throwException("Forbidden", status, _responseText, _headers);
4162
+ }
4163
+ else if (status === 500) {
4164
+ const _responseText = response.data;
4165
+ let result500 = null;
4166
+ let resultData500 = _responseText;
4167
+ result500 = JSON.parse(resultData500);
4168
+ return throwException("Internal server error", status, _responseText, _headers, result500);
4169
+ }
4170
+ else if (status !== 200 && status !== 204) {
4171
+ const _responseText = response.data;
4172
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
4173
+ }
4174
+ return Promise.resolve(null);
4175
+ }
3866
4176
  /**
3867
4177
  * Renders a design proof with the specified parameters.
3868
4178
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
@@ -3942,6 +4252,81 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
3942
4252
  }
3943
4253
  return Promise.resolve(null);
3944
4254
  }
4255
+ /**
4256
+ * Renders a design proof with the specified parameters and saves rendering result as resource.
4257
+ * @param tenantId (optional) Tenant identifier
4258
+ * @param body (optional) Render model with preview parameters.
4259
+ * @return Success
4260
+ */
4261
+ renderDesignProofToResource(tenantId, body, cancelToken) {
4262
+ let url_ = this.baseUrl + "/api/atoms/v1/render-design-proof/to-resource?";
4263
+ if (tenantId === null)
4264
+ throw new Error("The parameter 'tenantId' cannot be null.");
4265
+ else if (tenantId !== undefined)
4266
+ url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
4267
+ url_ = url_.replace(/[?&]$/, "");
4268
+ const content_ = JSON.stringify(body);
4269
+ let options_ = {
4270
+ data: content_,
4271
+ method: "POST",
4272
+ url: url_,
4273
+ headers: {
4274
+ "Content-Type": "application/json",
4275
+ "Accept": "application/json"
4276
+ },
4277
+ cancelToken
4278
+ };
4279
+ return this.transformOptions(options_).then(transformedOptions_ => {
4280
+ return this.instance.request(transformedOptions_);
4281
+ }).catch((_error) => {
4282
+ if (isAxiosError(_error) && _error.response) {
4283
+ return _error.response;
4284
+ }
4285
+ else {
4286
+ throw _error;
4287
+ }
4288
+ }).then((_response) => {
4289
+ return this.transformResult(url_, _response, (_response) => this.processRenderDesignProofToResource(_response));
4290
+ });
4291
+ }
4292
+ processRenderDesignProofToResource(response) {
4293
+ const status = response.status;
4294
+ let _headers = {};
4295
+ if (response.headers && typeof response.headers === "object") {
4296
+ for (let k in response.headers) {
4297
+ if (response.headers.hasOwnProperty(k)) {
4298
+ _headers[k] = response.headers[k];
4299
+ }
4300
+ }
4301
+ }
4302
+ if (status === 200) {
4303
+ const _responseText = response.data;
4304
+ let result200 = null;
4305
+ let resultData200 = _responseText;
4306
+ result200 = JSON.parse(resultData200);
4307
+ return Promise.resolve(result200);
4308
+ }
4309
+ else if (status === 401) {
4310
+ const _responseText = response.data;
4311
+ return throwException("Unauthorized", status, _responseText, _headers);
4312
+ }
4313
+ else if (status === 403) {
4314
+ const _responseText = response.data;
4315
+ return throwException("Forbidden", status, _responseText, _headers);
4316
+ }
4317
+ else if (status === 500) {
4318
+ const _responseText = response.data;
4319
+ let result500 = null;
4320
+ let resultData500 = _responseText;
4321
+ result500 = JSON.parse(resultData500);
4322
+ return throwException("Internal server error", status, _responseText, _headers, result500);
4323
+ }
4324
+ else if (status !== 200 && status !== 204) {
4325
+ const _responseText = response.data;
4326
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
4327
+ }
4328
+ return Promise.resolve(null);
4329
+ }
3945
4330
  /**
3946
4331
  * Render product proof image with specified parameters.
3947
4332
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
@@ -6008,6 +6393,14 @@ export var ImagePreviewFormat;
6008
6393
  ImagePreviewFormat["Jpeg"] = "Jpeg";
6009
6394
  ImagePreviewFormat["Png"] = "Png";
6010
6395
  })(ImagePreviewFormat || (ImagePreviewFormat = {}));
6396
+ /** Image preview fit mode. */
6397
+ export var ImagePreviewFitMode;
6398
+ (function (ImagePreviewFitMode) {
6399
+ ImagePreviewFitMode["Fit"] = "Fit";
6400
+ ImagePreviewFitMode["Shrink"] = "Shrink";
6401
+ ImagePreviewFitMode["Resize"] = "Resize";
6402
+ ImagePreviewFitMode["Fill"] = "Fill";
6403
+ })(ImagePreviewFitMode || (ImagePreviewFitMode = {}));
6011
6404
  export var DesignElementType;
6012
6405
  (function (DesignElementType) {
6013
6406
  DesignElementType["Product"] = "Product";