@aurigma/ng-storefront-api-client 2.54.19 → 2.54.43

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.
@@ -200,14 +200,6 @@ export interface IProductReferencesApiClient {
200
200
  * @return Success
201
201
  */
202
202
  getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductReferenceDto>;
203
- /**
204
- * Creates a new storefront product reference.
205
- * @param storefrontId Storefront identifier.
206
- * @param tenantId (optional) Tenant identifier.
207
- * @param body (optional) Create operation parameters.
208
- * @return Success
209
- */
210
- create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Observable<ProductReferenceDto>;
211
203
  /**
212
204
  * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
213
205
  * @param storefrontId Storefront identifier.
@@ -273,14 +265,6 @@ export interface IProductReferencesApiClient {
273
265
  * @return Success
274
266
  */
275
267
  get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductReferenceDto>;
276
- /**
277
- * Deletes the storefront product reference.
278
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
279
- * @param storefrontId Storefront identifier.
280
- * @param tenantId (optional) Tenant identifier.
281
- * @return Success
282
- */
283
- delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductReferenceDto>;
284
268
  /**
285
269
  * Returns a product specification by the storefront product reference.
286
270
  * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
@@ -335,15 +319,6 @@ export interface IProductReferencesApiClient {
335
319
  * @return Success
336
320
  */
337
321
  getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined): Observable<PersonalizationWorkflowDto>;
338
- /**
339
- * Returns a product personalization workflow configuration by storefront product reference.
340
- * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
341
- * @param storefrontId Storefront identifier.
342
- * @param tenantId (optional) Tenant identifier.
343
- * @return Success
344
- * @deprecated
345
- */
346
- getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<string>;
347
322
  }
348
323
  export declare class ProductReferencesApiClient extends ApiClientBase implements IProductReferencesApiClient {
349
324
  private http;
@@ -370,15 +345,6 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
370
345
  */
371
346
  getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductReferenceDto>;
372
347
  protected processGetAll(response: HttpResponseBase): Observable<PagedOfProductReferenceDto>;
373
- /**
374
- * Creates a new storefront product reference.
375
- * @param storefrontId Storefront identifier.
376
- * @param tenantId (optional) Tenant identifier.
377
- * @param body (optional) Create operation parameters.
378
- * @return Success
379
- */
380
- create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Observable<ProductReferenceDto>;
381
- protected processCreate(response: HttpResponseBase): Observable<ProductReferenceDto>;
382
348
  /**
383
349
  * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
384
350
  * @param storefrontId Storefront identifier.
@@ -448,15 +414,6 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
448
414
  */
449
415
  get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductReferenceDto>;
450
416
  protected processGet(response: HttpResponseBase): Observable<ProductReferenceDto>;
451
- /**
452
- * Deletes the storefront product reference.
453
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
454
- * @param storefrontId Storefront identifier.
455
- * @param tenantId (optional) Tenant identifier.
456
- * @return Success
457
- */
458
- delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductReferenceDto>;
459
- protected processDelete(response: HttpResponseBase): Observable<ProductReferenceDto>;
460
417
  /**
461
418
  * Returns a product specification by the storefront product reference.
462
419
  * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
@@ -517,16 +474,6 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
517
474
  */
518
475
  getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined): Observable<PersonalizationWorkflowDto>;
519
476
  protected processGetPersonalizationWorkflow(response: HttpResponseBase): Observable<PersonalizationWorkflowDto>;
520
- /**
521
- * Returns a product personalization workflow configuration by storefront product reference.
522
- * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
523
- * @param storefrontId Storefront identifier.
524
- * @param tenantId (optional) Tenant identifier.
525
- * @return Success
526
- * @deprecated
527
- */
528
- getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<string>;
529
- protected processGetProductConfig(response: HttpResponseBase): Observable<string>;
530
477
  }
531
478
  export interface IProductsApiClient {
532
479
  /**
@@ -681,15 +628,6 @@ export interface IProductsApiClient {
681
628
  * @return Success
682
629
  */
683
630
  updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<void>;
684
- /**
685
- * Set product variant price.
686
- * @param id Product identifier.
687
- * @param productVersionId (optional) Product version identifier.
688
- * @param tenantId (optional) Tenant identifier.
689
- * @param body (optional) Set product variant price operation parameters.
690
- * @return Success
691
- */
692
- setProductVariantPrice(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto[] | null | undefined): Observable<void>;
693
631
  /**
694
632
  * Returns a list of all available product tags.
695
633
  * @param search (optional) Search string for partial match.
@@ -878,16 +816,6 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
878
816
  */
879
817
  updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<void>;
880
818
  protected processUpdateProductVariantResources(response: HttpResponseBase): Observable<void>;
881
- /**
882
- * Set product variant price.
883
- * @param id Product identifier.
884
- * @param productVersionId (optional) Product version identifier.
885
- * @param tenantId (optional) Tenant identifier.
886
- * @param body (optional) Set product variant price operation parameters.
887
- * @return Success
888
- */
889
- setProductVariantPrice(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto[] | null | undefined): Observable<void>;
890
- protected processSetProductVariantPrice(response: HttpResponseBase): Observable<void>;
891
819
  /**
892
820
  * Returns a list of all available product tags.
893
821
  * @param search (optional) Search string for partial match.
@@ -933,14 +861,6 @@ export interface IProductSpecificationsApiClient {
933
861
  * @return Success
934
862
  */
935
863
  getPersonalizationWorkflow(id: number, tenantId?: number | null | undefined): Observable<PersonalizationWorkflowDto>;
936
- /**
937
- * Returns a product personalization workflow configuration by product specification identifier.
938
- * @param id Product specification identifier.
939
- * @param tenantId (optional) Tenant identifier.
940
- * @return Success
941
- * @deprecated
942
- */
943
- getConfiguration(id: number, tenantId?: number | null | undefined): Observable<string>;
944
864
  }
945
865
  export declare class ProductSpecificationsApiClient extends ApiClientBase implements IProductSpecificationsApiClient {
946
866
  private http;
@@ -974,15 +894,6 @@ export declare class ProductSpecificationsApiClient extends ApiClientBase implem
974
894
  */
975
895
  getPersonalizationWorkflow(id: number, tenantId?: number | null | undefined): Observable<PersonalizationWorkflowDto>;
976
896
  protected processGetPersonalizationWorkflow(response: HttpResponseBase): Observable<PersonalizationWorkflowDto>;
977
- /**
978
- * Returns a product personalization workflow configuration by product specification identifier.
979
- * @param id Product specification identifier.
980
- * @param tenantId (optional) Tenant identifier.
981
- * @return Success
982
- * @deprecated
983
- */
984
- getConfiguration(id: number, tenantId?: number | null | undefined): Observable<string>;
985
- protected processGetConfiguration(response: HttpResponseBase): Observable<string>;
986
897
  }
987
898
  export interface IProjectsApiClient {
988
899
  /**
@@ -1106,27 +1017,6 @@ export interface IProjectsApiClient {
1106
1017
  * @return Success
1107
1018
  */
1108
1019
  getAllTransitions(tenantId?: number | null | undefined): Observable<PagedOfProjectTransitionDto>;
1109
- /**
1110
- * Returns an url to download project print file.
1111
- * @param id Project identifier.
1112
- * @param designUserId Design owner identifier.
1113
- * @param designId Design identifier.
1114
- * @param tenantId (optional) Tenant identifier.
1115
- * @return Success
1116
- * @deprecated
1117
- */
1118
- getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined): Observable<ProjectPdfResultDto>;
1119
- /**
1120
- * Returns an archive file, which contains all project print files.
1121
- * @param id Project identifier.
1122
- * @param designUserId Design owner identifier.
1123
- * @param designId Design identifier.
1124
- * @param attachment (optional) If set to 'true', the requested file will be provided as an attachment with proper filename supplied (default value is 'false').
1125
- * @param tenantId (optional) Tenant identifier.
1126
- * @return Success
1127
- * @deprecated
1128
- */
1129
- getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined): Observable<FileResponse>;
1130
1020
  /**
1131
1021
  * Returns a project processing results.
1132
1022
  * @param id Project identifier.
@@ -1309,29 +1199,6 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
1309
1199
  */
1310
1200
  getAllTransitions(tenantId?: number | null | undefined): Observable<PagedOfProjectTransitionDto>;
1311
1201
  protected processGetAllTransitions(response: HttpResponseBase): Observable<PagedOfProjectTransitionDto>;
1312
- /**
1313
- * Returns an url to download project print file.
1314
- * @param id Project identifier.
1315
- * @param designUserId Design owner identifier.
1316
- * @param designId Design identifier.
1317
- * @param tenantId (optional) Tenant identifier.
1318
- * @return Success
1319
- * @deprecated
1320
- */
1321
- getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined): Observable<ProjectPdfResultDto>;
1322
- protected processGetProjectPdfUrl(response: HttpResponseBase): Observable<ProjectPdfResultDto>;
1323
- /**
1324
- * Returns an archive file, which contains all project print files.
1325
- * @param id Project identifier.
1326
- * @param designUserId Design owner identifier.
1327
- * @param designId Design identifier.
1328
- * @param attachment (optional) If set to 'true', the requested file will be provided as an attachment with proper filename supplied (default value is 'false').
1329
- * @param tenantId (optional) Tenant identifier.
1330
- * @return Success
1331
- * @deprecated
1332
- */
1333
- getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined): Observable<FileResponse>;
1334
- protected processGetProjectPdfZip(response: HttpResponseBase): Observable<FileResponse>;
1335
1202
  /**
1336
1203
  * Returns a project processing results.
1337
1204
  * @param id Project identifier.
@@ -1890,47 +1757,6 @@ export interface PagedOfProductReferenceDto {
1890
1757
  /** Items list. */
1891
1758
  items?: ProductReferenceDto[] | null;
1892
1759
  }
1893
- /** Dto class, containing create operation parameters for storefront product reference. */
1894
- export interface CreateProductReferenceDto {
1895
- /** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
1896
- productReference: string;
1897
- /** Product reference target type. */
1898
- productReferenceType?: ProductReferenceType;
1899
- /** Product reference name, e.g. online store product name. */
1900
- productReferenceName?: string | null;
1901
- /** Customer's Canvas product specification identifier. */
1902
- productSpecificationId?: number | null;
1903
- /** Customer's Canvas product identifier. */
1904
- productId?: number | null;
1905
- /** Customer's Canvas product link identifier. */
1906
- productLinkId?: number | null;
1907
- }
1908
- /** DTO class, containing information about storefront product reference. */
1909
- export interface ProductReferenceInfo {
1910
- /** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
1911
- productReference?: string | null;
1912
- /** Product reference target type. */
1913
- productReferenceType?: ProductReferenceType;
1914
- /** Product reference name, e.g. online store product name. */
1915
- productReferenceName?: string | null;
1916
- /** Customer's Canvas product specification identifier. */
1917
- productSpecificationId?: number;
1918
- /** Customer's Canvas product identifier. */
1919
- productId?: number;
1920
- /** Customer's Canvas product link identifier. */
1921
- productLinkId?: number;
1922
- /** Storefront identifier. */
1923
- storefrontId?: number;
1924
- }
1925
- /** DTO class, containing information about storefront product reference creation conflict. */
1926
- export interface ProductReferenceCreationConflictDto {
1927
- /** List of storefront product references, which are already exist. */
1928
- existingReferences?: ProductReferenceInfo[] | null;
1929
- /** Problem description. */
1930
- description?: string | null;
1931
- /** Coflict type. */
1932
- type?: ConflictType;
1933
- }
1934
1760
  /** Dto class, containing information about product attribute. */
1935
1761
  export interface ProductAttributeDto {
1936
1762
  /** Product attribute name. */
@@ -1948,6 +1774,8 @@ export interface ProductSpecificationDto {
1948
1774
  tenantId?: number;
1949
1775
  /** Product specification name. */
1950
1776
  name?: string | null;
1777
+ /** Product specification description. */
1778
+ description?: string | null;
1951
1779
  /** List of product attributes. */
1952
1780
  productAttributes?: ProductAttributeDto[] | null;
1953
1781
  /** Product specification creation time. */
@@ -2118,6 +1946,8 @@ export interface ProductVariantOptionDto {
2118
1946
  export interface ProductVariantDto {
2119
1947
  /** Product variant identifier. */
2120
1948
  id?: number;
1949
+ /** Product variant unique identifier. */
1950
+ uid?: string | null;
2121
1951
  /** Product version identifier. */
2122
1952
  productVersionId?: number;
2123
1953
  /** Product identifier. */
@@ -2132,6 +1962,8 @@ export interface ProductVariantDto {
2132
1962
  sortIndex?: number;
2133
1963
  /** Product variant identifier (usually SKU) in storefront / online store. */
2134
1964
  storefrontProductVariantId?: string | null;
1965
+ /** Product variant SKU. */
1966
+ sku?: string | null;
2135
1967
  /** A list of product variant options. */
2136
1968
  productVariantOptions?: ProductVariantOptionDto[] | null;
2137
1969
  }
@@ -2190,6 +2022,8 @@ export interface ProductVariantDesignDto {
2190
2022
  sortIndex?: number;
2191
2023
  /** Product variant identifier (usually SKU) in storefront / online store. */
2192
2024
  storefrontProductVariantId?: string | null;
2025
+ /** Product variant SKU. */
2026
+ sku?: string | null;
2193
2027
  /** Design identifier. */
2194
2028
  designId?: string | null;
2195
2029
  /** Design name. */
@@ -2236,6 +2070,8 @@ export interface ProductVariantMockupDto {
2236
2070
  tenantId?: number | null;
2237
2071
  /** Product variant identifier in online store (usually SKU). */
2238
2072
  storefrontProductVariantId?: string | null;
2073
+ /** Product variant SKU. */
2074
+ sku?: string | null;
2239
2075
  /** Mockup identifier. */
2240
2076
  mockupId?: string | null;
2241
2077
  /** Mockup name. */
@@ -2274,6 +2110,8 @@ export interface ProductVariantDocumentDto {
2274
2110
  sortIndex?: number;
2275
2111
  /** Product variant identifier (usually SKU) in storefront / online store. */
2276
2112
  storefrontProductVariantId?: string | null;
2113
+ /** Product variant SKU. */
2114
+ sku?: string | null;
2277
2115
  /** Document identifier. */
2278
2116
  documentId?: string | null;
2279
2117
  /** Document name. */
@@ -2292,13 +2130,6 @@ export interface PagedOfProductVariantDocumentDto {
2292
2130
  /** Items list. */
2293
2131
  items?: ProductVariantDocumentDto[] | null;
2294
2132
  }
2295
- /** Parameters for setting product variants price. */
2296
- export interface SetProductVariantPriceDto {
2297
- /** Price. */
2298
- price?: number | null;
2299
- /** Identifiers of variants for price setting. */
2300
- variantIds?: number[] | null;
2301
- }
2302
2133
  /** Defines all available date period filter values for queries. */
2303
2134
  export declare enum DatePeriod {
2304
2135
  All = "All",
@@ -2641,11 +2472,6 @@ export interface PagedOfProjectStatusDto {
2641
2472
  /** Items list. */
2642
2473
  items?: ProjectStatusDto[] | null;
2643
2474
  }
2644
- /** Dto class, containing result of 'get project pdf url' operation. */
2645
- export interface ProjectPdfResultDto {
2646
- /** Project pdf url. */
2647
- url?: string | null;
2648
- }
2649
2475
  /** Dto class, containing description of a project output file. */
2650
2476
  export interface ProjectOutputFileDetailsDto {
2651
2477
  /** Project item identifier. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aurigma/ng-storefront-api-client",
3
- "version": "2.54.19",
3
+ "version": "2.54.43",
4
4
  "license": "SEE LICENSE IN License.md",
5
5
  "description": "Angular API Client for Storefront API service of Customer's Canvas web-to-print system.",
6
6
  "author": "Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)",