@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
@@ -1889,17 +1889,23 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
1889
1889
  /**
1890
1890
  * Patches product (design model) in design file
1891
1891
  * @param id Design identifier
1892
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
1893
+ * @param privateStorageOwner (optional) Private storage owner identifier
1892
1894
  * @param tenantId (optional) Tenant identifier
1893
1895
  * @param patchType (optional)
1894
1896
  * @param replaceImageItemFileInfo_itemName (optional)
1895
1897
  * @param replaceImageItemFileInfo_sourceFile (optional)
1896
1898
  * @return Success
1897
1899
  */
1898
- patchProduct(id, tenantId, patchType, replaceImageItemFileInfo_itemName, replaceImageItemFileInfo_sourceFile, cancelToken) {
1900
+ patchProduct(id, privateStorage, privateStorageOwner, tenantId, patchType, replaceImageItemFileInfo_itemName, replaceImageItemFileInfo_sourceFile, cancelToken) {
1899
1901
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/model?";
1900
1902
  if (id === undefined || id === null)
1901
1903
  throw new Error("The parameter 'id' must be defined.");
1902
1904
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
1905
+ if (privateStorage !== undefined && privateStorage !== null)
1906
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
1907
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
1908
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
1903
1909
  if (tenantId === null)
1904
1910
  throw new Error("The parameter 'tenantId' cannot be null.");
1905
1911
  else if (tenantId !== undefined)
@@ -1972,14 +1978,20 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
1972
1978
  /**
1973
1979
  * Loads data schema from design file taken from storage
1974
1980
  * @param id Design identifier
1981
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
1982
+ * @param privateStorageOwner (optional) Private storage owner identifier
1975
1983
  * @param tenantId (optional) Tenant identifier
1976
1984
  * @return Success
1977
1985
  */
1978
- loadDataSchema(id, tenantId, cancelToken) {
1986
+ loadDataSchema(id, privateStorage, privateStorageOwner, tenantId, cancelToken) {
1979
1987
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/schema?";
1980
1988
  if (id === undefined || id === null)
1981
1989
  throw new Error("The parameter 'id' must be defined.");
1982
1990
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
1991
+ if (privateStorage !== undefined && privateStorage !== null)
1992
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
1993
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
1994
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
1983
1995
  if (tenantId === null)
1984
1996
  throw new Error("The parameter 'tenantId' cannot be null.");
1985
1997
  else if (tenantId !== undefined)
@@ -2054,14 +2066,20 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
2054
2066
  /**
2055
2067
  * Gets variable items information for design file taken from storage
2056
2068
  * @param id Design identifier
2069
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2070
+ * @param privateStorageOwner (optional) Private storage owner identifier
2057
2071
  * @param tenantId (optional) Tenant identifier
2058
2072
  * @return Success
2059
2073
  */
2060
- getVariables(id, tenantId, cancelToken) {
2074
+ getVariables(id, privateStorage, privateStorageOwner, tenantId, cancelToken) {
2061
2075
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/variables?";
2062
2076
  if (id === undefined || id === null)
2063
2077
  throw new Error("The parameter 'id' must be defined.");
2064
2078
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2079
+ if (privateStorage !== undefined && privateStorage !== null)
2080
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2081
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2082
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2065
2083
  if (tenantId === null)
2066
2084
  throw new Error("The parameter 'tenantId' cannot be null.");
2067
2085
  else if (tenantId !== undefined)
@@ -2129,15 +2147,21 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
2129
2147
  /**
2130
2148
  * Sets variable items values for design file taken from storage
2131
2149
  * @param id Design identifier
2150
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2151
+ * @param privateStorageOwner (optional) Private storage owner identifier
2132
2152
  * @param tenantId (optional) Tenant identifier
2133
2153
  * @param body (optional) Design variable values
2134
2154
  * @return Success
2135
2155
  */
2136
- setVariables(id, tenantId, body, cancelToken) {
2156
+ setVariables(id, privateStorage, privateStorageOwner, tenantId, body, cancelToken) {
2137
2157
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/variables?";
2138
2158
  if (id === undefined || id === null)
2139
2159
  throw new Error("The parameter 'id' must be defined.");
2140
2160
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2161
+ if (privateStorage !== undefined && privateStorage !== null)
2162
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2163
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2164
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2141
2165
  if (tenantId === null)
2142
2166
  throw new Error("The parameter 'tenantId' cannot be null.");
2143
2167
  else if (tenantId !== undefined)
@@ -2215,14 +2239,20 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
2215
2239
  /**
2216
2240
  * Loads variable data printing information from design file taken from storage
2217
2241
  * @param id Design identifier
2242
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2243
+ * @param privateStorageOwner (optional) Private storage owner identifier
2218
2244
  * @param tenantId (optional) Tenant identifier
2219
2245
  * @return Success
2220
2246
  */
2221
- loadVdpData(id, tenantId, cancelToken) {
2247
+ loadVdpData(id, privateStorage, privateStorageOwner, tenantId, cancelToken) {
2222
2248
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/vdpData?";
2223
2249
  if (id === undefined || id === null)
2224
2250
  throw new Error("The parameter 'id' must be defined.");
2225
2251
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2252
+ if (privateStorage !== undefined && privateStorage !== null)
2253
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2254
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2255
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2226
2256
  if (tenantId === null)
2227
2257
  throw new Error("The parameter 'tenantId' cannot be null.");
2228
2258
  else if (tenantId !== undefined)
@@ -2297,15 +2327,21 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
2297
2327
  /**
2298
2328
  * Saves variable data printing information to design file and updates design in storage.
2299
2329
  * @param id Design identifier
2330
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2331
+ * @param privateStorageOwner (optional) Private storage owner identifier
2300
2332
  * @param tenantId (optional) Tenant identifier
2301
2333
  * @param body (optional) Serialized vdp data
2302
2334
  * @return Success
2303
2335
  */
2304
- saveVdpData(id, tenantId, body, cancelToken) {
2336
+ saveVdpData(id, privateStorage, privateStorageOwner, tenantId, body, cancelToken) {
2305
2337
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/vdpData?";
2306
2338
  if (id === undefined || id === null)
2307
2339
  throw new Error("The parameter 'id' must be defined.");
2308
2340
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2341
+ if (privateStorage !== undefined && privateStorage !== null)
2342
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2343
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2344
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2309
2345
  if (tenantId === null)
2310
2346
  throw new Error("The parameter 'tenantId' cannot be null.");
2311
2347
  else if (tenantId !== undefined)
@@ -2372,14 +2408,20 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
2372
2408
  /**
2373
2409
  * Deletes variable data printing inforamtion from design file and updates design in storage.
2374
2410
  * @param id Design identifier
2411
+ * @param privateStorage (optional) If set to 'true' design will be taken from private storage
2412
+ * @param privateStorageOwner (optional) Private storage owner identifier
2375
2413
  * @param tenantId (optional) Tenant identifier
2376
2414
  * @return Success
2377
2415
  */
2378
- deleteVdpData(id, tenantId, cancelToken) {
2416
+ deleteVdpData(id, privateStorage, privateStorageOwner, tenantId, cancelToken) {
2379
2417
  let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/vdpData?";
2380
2418
  if (id === undefined || id === null)
2381
2419
  throw new Error("The parameter 'id' must be defined.");
2382
2420
  url_ = url_.replace("{id}", encodeURIComponent("" + id));
2421
+ if (privateStorage !== undefined && privateStorage !== null)
2422
+ url_ += "privateStorage=" + encodeURIComponent("" + privateStorage) + "&";
2423
+ if (privateStorageOwner !== undefined && privateStorageOwner !== null)
2424
+ url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
2383
2425
  if (tenantId === null)
2384
2426
  throw new Error("The parameter 'tenantId' cannot be null.");
2385
2427
  else if (tenantId !== undefined)