@aurigma/axios-design-atoms-api-client 2.17.1 → 2.20.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.
@@ -369,57 +369,71 @@ export interface IDesignAtomsServiceApiClient {
369
369
  /**
370
370
  * Patches product (design model) in design file
371
371
  * @param id Design identifier
372
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
373
+ * @param privateStorageOwner (optional) Private storage owner identifier
372
374
  * @param tenantId (optional) Tenant identifier
373
375
  * @param patchType (optional)
374
376
  * @param replaceImageItemFileInfo_itemName (optional)
375
377
  * @param replaceImageItemFileInfo_sourceFile (optional)
376
378
  * @return Success
377
379
  */
378
- patchProduct(id: string | null, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
380
+ patchProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
379
381
  /**
380
382
  * Loads data schema from design file taken from storage
381
383
  * @param id Design identifier
384
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
385
+ * @param privateStorageOwner (optional) Private storage owner identifier
382
386
  * @param tenantId (optional) Tenant identifier
383
387
  * @return Success
384
388
  */
385
- loadDataSchema(id: string | null, tenantId?: number | undefined): Promise<FileResponse>;
389
+ loadDataSchema(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
386
390
  /**
387
391
  * Gets variable items information for design file taken from storage
388
392
  * @param id Design identifier
393
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
394
+ * @param privateStorageOwner (optional) Private storage owner identifier
389
395
  * @param tenantId (optional) Tenant identifier
390
396
  * @return Success
391
397
  */
392
- getVariables(id: string | null, tenantId?: number | undefined): Promise<VariablesModel>;
398
+ getVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<VariablesModel>;
393
399
  /**
394
400
  * Sets variable items values for design file taken from storage
395
401
  * @param id Design identifier
402
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
403
+ * @param privateStorageOwner (optional) Private storage owner identifier
396
404
  * @param tenantId (optional) Tenant identifier
397
405
  * @param body (optional) Design variable values
398
406
  * @return Success
399
407
  */
400
- setVariables(id: string | null, tenantId?: number | undefined, body?: VariablesModel | null | undefined): Promise<VariablesModel>;
408
+ setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined): Promise<VariablesModel>;
401
409
  /**
402
410
  * Loads variable data printing information from design file taken from storage
403
411
  * @param id Design identifier
412
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
413
+ * @param privateStorageOwner (optional) Private storage owner identifier
404
414
  * @param tenantId (optional) Tenant identifier
405
415
  * @return Success
406
416
  */
407
- loadVdpData(id: string | null, tenantId?: number | undefined): Promise<VdpDataModel>;
417
+ loadVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<VdpDataModel>;
408
418
  /**
409
419
  * Saves variable data printing information to design file and updates design in storage.
410
420
  * @param id Design identifier
421
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
422
+ * @param privateStorageOwner (optional) Private storage owner identifier
411
423
  * @param tenantId (optional) Tenant identifier
412
424
  * @param body (optional) Serialized vdp data
413
425
  * @return Success
414
426
  */
415
- saveVdpData(id: string | null, tenantId?: number | undefined, body?: VdpDataModel | null | undefined): Promise<void>;
427
+ saveVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VdpDataModel | null | undefined): Promise<void>;
416
428
  /**
417
429
  * Deletes variable data printing inforamtion from design file and updates design in storage.
418
430
  * @param id Design identifier
431
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
432
+ * @param privateStorageOwner (optional) Private storage owner identifier
419
433
  * @param tenantId (optional) Tenant identifier
420
434
  * @return Success
421
435
  */
422
- deleteVdpData(id: string | null, tenantId?: number | undefined): Promise<void>;
436
+ deleteVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
423
437
  /**
424
438
  * Flatten items
425
439
  * @param tenantId (optional) Tenant identifier
@@ -494,63 +508,77 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
494
508
  /**
495
509
  * Patches product (design model) in design file
496
510
  * @param id Design identifier
511
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
512
+ * @param privateStorageOwner (optional) Private storage owner identifier
497
513
  * @param tenantId (optional) Tenant identifier
498
514
  * @param patchType (optional)
499
515
  * @param replaceImageItemFileInfo_itemName (optional)
500
516
  * @param replaceImageItemFileInfo_sourceFile (optional)
501
517
  * @return Success
502
518
  */
503
- patchProduct(id: string | null, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
519
+ patchProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
504
520
  protected processPatchProduct(response: AxiosResponse): Promise<void>;
505
521
  /**
506
522
  * Loads data schema from design file taken from storage
507
523
  * @param id Design identifier
524
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
525
+ * @param privateStorageOwner (optional) Private storage owner identifier
508
526
  * @param tenantId (optional) Tenant identifier
509
527
  * @return Success
510
528
  */
511
- loadDataSchema(id: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
529
+ loadDataSchema(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
512
530
  protected processLoadDataSchema(response: AxiosResponse): Promise<FileResponse>;
513
531
  /**
514
532
  * Gets variable items information for design file taken from storage
515
533
  * @param id Design identifier
534
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
535
+ * @param privateStorageOwner (optional) Private storage owner identifier
516
536
  * @param tenantId (optional) Tenant identifier
517
537
  * @return Success
518
538
  */
519
- getVariables(id: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
539
+ getVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
520
540
  protected processGetVariables(response: AxiosResponse): Promise<VariablesModel>;
521
541
  /**
522
542
  * Sets variable items values for design file taken from storage
523
543
  * @param id Design identifier
544
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
545
+ * @param privateStorageOwner (optional) Private storage owner identifier
524
546
  * @param tenantId (optional) Tenant identifier
525
547
  * @param body (optional) Design variable values
526
548
  * @return Success
527
549
  */
528
- setVariables(id: string | null, tenantId?: number | undefined, body?: VariablesModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
550
+ setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
529
551
  protected processSetVariables(response: AxiosResponse): Promise<VariablesModel>;
530
552
  /**
531
553
  * Loads variable data printing information from design file taken from storage
532
554
  * @param id Design identifier
555
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
556
+ * @param privateStorageOwner (optional) Private storage owner identifier
533
557
  * @param tenantId (optional) Tenant identifier
534
558
  * @return Success
535
559
  */
536
- loadVdpData(id: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VdpDataModel>;
560
+ loadVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VdpDataModel>;
537
561
  protected processLoadVdpData(response: AxiosResponse): Promise<VdpDataModel>;
538
562
  /**
539
563
  * Saves variable data printing information to design file and updates design in storage.
540
564
  * @param id Design identifier
565
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
566
+ * @param privateStorageOwner (optional) Private storage owner identifier
541
567
  * @param tenantId (optional) Tenant identifier
542
568
  * @param body (optional) Serialized vdp data
543
569
  * @return Success
544
570
  */
545
- saveVdpData(id: string | null, tenantId?: number | undefined, body?: VdpDataModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
571
+ saveVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VdpDataModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
546
572
  protected processSaveVdpData(response: AxiosResponse): Promise<void>;
547
573
  /**
548
574
  * Deletes variable data printing inforamtion from design file and updates design in storage.
549
575
  * @param id Design identifier
576
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
577
+ * @param privateStorageOwner (optional) Private storage owner identifier
550
578
  * @param tenantId (optional) Tenant identifier
551
579
  * @return Success
552
580
  */
553
- deleteVdpData(id: string | null, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
581
+ deleteVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
554
582
  protected processDeleteVdpData(response: AxiosResponse): Promise<void>;
555
583
  /**
556
584
  * Flatten items
@@ -1896,17 +1896,23 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
1896
1896
  /**
1897
1897
  * Patches product (design model) in design file
1898
1898
  * @param id Design identifier
1899
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
1900
+ * @param privateStorageOwner (optional) Private storage owner identifier
1899
1901
  * @param tenantId (optional) Tenant identifier
1900
1902
  * @param patchType (optional)
1901
1903
  * @param replaceImageItemFileInfo_itemName (optional)
1902
1904
  * @param replaceImageItemFileInfo_sourceFile (optional)
1903
1905
  * @return Success
1904
1906
  */
1905
- patchProduct(id, tenantId, patchType, replaceImageItemFileInfo_itemName, replaceImageItemFileInfo_sourceFile, cancelToken) {
1907
+ patchProduct(id, privateStorage, privateStorageOwner, tenantId, patchType, replaceImageItemFileInfo_itemName, replaceImageItemFileInfo_sourceFile, cancelToken) {
1906
1908
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/model?";
1907
1909
  if (id === undefined || id === null)
1908
1910
  throw new Error("The parameter 'id' must be defined.");
1909
1911
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
1912
+ if (privateStorage !== undefined && privateStorage !== null)
1913
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
1914
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
1915
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
1910
1916
  if (tenantId === null)
1911
1917
  throw new Error("The parameter 'tenantId' cannot be null.");
1912
1918
  else if (tenantId !== undefined)
@@ -1979,14 +1985,20 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
1979
1985
  /**
1980
1986
  * Loads data schema from design file taken from storage
1981
1987
  * @param id Design identifier
1988
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
1989
+ * @param privateStorageOwner (optional) Private storage owner identifier
1982
1990
  * @param tenantId (optional) Tenant identifier
1983
1991
  * @return Success
1984
1992
  */
1985
- loadDataSchema(id, tenantId, cancelToken) {
1993
+ loadDataSchema(id, privateStorage, privateStorageOwner, tenantId, cancelToken) {
1986
1994
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/schema?";
1987
1995
  if (id === undefined || id === null)
1988
1996
  throw new Error("The parameter 'id' must be defined.");
1989
1997
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
1998
+ if (privateStorage !== undefined && privateStorage !== null)
1999
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2000
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2001
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
1990
2002
  if (tenantId === null)
1991
2003
  throw new Error("The parameter 'tenantId' cannot be null.");
1992
2004
  else if (tenantId !== undefined)
@@ -2061,14 +2073,20 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
2061
2073
  /**
2062
2074
  * Gets variable items information for design file taken from storage
2063
2075
  * @param id Design identifier
2076
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2077
+ * @param privateStorageOwner (optional) Private storage owner identifier
2064
2078
  * @param tenantId (optional) Tenant identifier
2065
2079
  * @return Success
2066
2080
  */
2067
- getVariables(id, tenantId, cancelToken) {
2081
+ getVariables(id, privateStorage, privateStorageOwner, tenantId, cancelToken) {
2068
2082
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/variables?";
2069
2083
  if (id === undefined || id === null)
2070
2084
  throw new Error("The parameter 'id' must be defined.");
2071
2085
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2086
+ if (privateStorage !== undefined && privateStorage !== null)
2087
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2088
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2089
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2072
2090
  if (tenantId === null)
2073
2091
  throw new Error("The parameter 'tenantId' cannot be null.");
2074
2092
  else if (tenantId !== undefined)
@@ -2136,15 +2154,21 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
2136
2154
  /**
2137
2155
  * Sets variable items values for design file taken from storage
2138
2156
  * @param id Design identifier
2157
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2158
+ * @param privateStorageOwner (optional) Private storage owner identifier
2139
2159
  * @param tenantId (optional) Tenant identifier
2140
2160
  * @param body (optional) Design variable values
2141
2161
  * @return Success
2142
2162
  */
2143
- setVariables(id, tenantId, body, cancelToken) {
2163
+ setVariables(id, privateStorage, privateStorageOwner, tenantId, body, cancelToken) {
2144
2164
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/variables?";
2145
2165
  if (id === undefined || id === null)
2146
2166
  throw new Error("The parameter 'id' must be defined.");
2147
2167
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2168
+ if (privateStorage !== undefined && privateStorage !== null)
2169
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2170
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2171
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2148
2172
  if (tenantId === null)
2149
2173
  throw new Error("The parameter 'tenantId' cannot be null.");
2150
2174
  else if (tenantId !== undefined)
@@ -2222,14 +2246,20 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
2222
2246
  /**
2223
2247
  * Loads variable data printing information from design file taken from storage
2224
2248
  * @param id Design identifier
2249
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2250
+ * @param privateStorageOwner (optional) Private storage owner identifier
2225
2251
  * @param tenantId (optional) Tenant identifier
2226
2252
  * @return Success
2227
2253
  */
2228
- loadVdpData(id, tenantId, cancelToken) {
2254
+ loadVdpData(id, privateStorage, privateStorageOwner, tenantId, cancelToken) {
2229
2255
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/vdpData?";
2230
2256
  if (id === undefined || id === null)
2231
2257
  throw new Error("The parameter 'id' must be defined.");
2232
2258
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2259
+ if (privateStorage !== undefined && privateStorage !== null)
2260
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2261
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2262
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2233
2263
  if (tenantId === null)
2234
2264
  throw new Error("The parameter 'tenantId' cannot be null.");
2235
2265
  else if (tenantId !== undefined)
@@ -2304,15 +2334,21 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
2304
2334
  /**
2305
2335
  * Saves variable data printing information to design file and updates design in storage.
2306
2336
  * @param id Design identifier
2337
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2338
+ * @param privateStorageOwner (optional) Private storage owner identifier
2307
2339
  * @param tenantId (optional) Tenant identifier
2308
2340
  * @param body (optional) Serialized vdp data
2309
2341
  * @return Success
2310
2342
  */
2311
- saveVdpData(id, tenantId, body, cancelToken) {
2343
+ saveVdpData(id, privateStorage, privateStorageOwner, tenantId, body, cancelToken) {
2312
2344
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/vdpData?";
2313
2345
  if (id === undefined || id === null)
2314
2346
  throw new Error("The parameter 'id' must be defined.");
2315
2347
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2348
+ if (privateStorage !== undefined && privateStorage !== null)
2349
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2350
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2351
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2316
2352
  if (tenantId === null)
2317
2353
  throw new Error("The parameter 'tenantId' cannot be null.");
2318
2354
  else if (tenantId !== undefined)
@@ -2379,14 +2415,20 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
2379
2415
  /**
2380
2416
  * Deletes variable data printing inforamtion from design file and updates design in storage.
2381
2417
  * @param id Design identifier
2418
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2419
+ * @param privateStorageOwner (optional) Private storage owner identifier
2382
2420
  * @param tenantId (optional) Tenant identifier
2383
2421
  * @return Success
2384
2422
  */
2385
- deleteVdpData(id, tenantId, cancelToken) {
2423
+ deleteVdpData(id, privateStorage, privateStorageOwner, tenantId, cancelToken) {
2386
2424
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/vdpData?";
2387
2425
  if (id === undefined || id === null)
2388
2426
  throw new Error("The parameter 'id' must be defined.");
2389
2427
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2428
+ if (privateStorage !== undefined && privateStorage !== null)
2429
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2430
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2431
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2390
2432
  if (tenantId === null)
2391
2433
  throw new Error("The parameter 'tenantId' cannot be null.");
2392
2434
  else if (tenantId !== undefined)