@aurigma/axios-storefront-api-client 2.63.14 → 2.66.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.
- package/dist/cjs/storefront-api-client.d.ts +45 -22
- package/dist/cjs/storefront-api-client.js +17 -8
- package/dist/cjs/storefront-api-client.js.map +1 -1
- package/dist/esm/storefront-api-client.d.ts +45 -22
- package/dist/esm/storefront-api-client.js +16 -7
- package/dist/esm/storefront-api-client.js.map +1 -1
- package/package.json +1 -1
|
@@ -704,7 +704,7 @@ export interface IProductsApiClient {
|
|
|
704
704
|
* @param tenantId (optional) Tenant identifier.
|
|
705
705
|
* @return Success
|
|
706
706
|
*/
|
|
707
|
-
|
|
707
|
+
getPersonalizationParameters(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
|
|
708
708
|
/**
|
|
709
709
|
* Returns a product summary by product identifier.
|
|
710
710
|
* @param id Product identifier.
|
|
@@ -715,7 +715,7 @@ export interface IProductsApiClient {
|
|
|
715
715
|
* @param tenantId (optional) Tenant identifier.
|
|
716
716
|
* @return Success
|
|
717
717
|
*/
|
|
718
|
-
|
|
718
|
+
getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
|
|
719
719
|
/**
|
|
720
720
|
* Returns a list of product options.
|
|
721
721
|
* @param id Product identifier.
|
|
@@ -889,8 +889,8 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
|
|
|
889
889
|
* @param tenantId (optional) Tenant identifier.
|
|
890
890
|
* @return Success
|
|
891
891
|
*/
|
|
892
|
-
|
|
893
|
-
protected
|
|
892
|
+
getPersonalizationParameters(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
|
|
893
|
+
protected processGetPersonalizationParameters(response: AxiosResponse): Promise<PersonalizationParametersDto>;
|
|
894
894
|
/**
|
|
895
895
|
* Returns a product summary by product identifier.
|
|
896
896
|
* @param id Product identifier.
|
|
@@ -901,8 +901,8 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
|
|
|
901
901
|
* @param tenantId (optional) Tenant identifier.
|
|
902
902
|
* @return Success
|
|
903
903
|
*/
|
|
904
|
-
|
|
905
|
-
protected
|
|
904
|
+
getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
|
|
905
|
+
protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
|
|
906
906
|
/**
|
|
907
907
|
* Returns a list of product options.
|
|
908
908
|
* @param id Product identifier.
|
|
@@ -1212,7 +1212,7 @@ export interface IProjectsApiClient {
|
|
|
1212
1212
|
* @param tenantId (optional) Tenant identifier.
|
|
1213
1213
|
* @return Success
|
|
1214
1214
|
*/
|
|
1215
|
-
getAvailableTransitions(id: number, tenantId?: number | null | undefined): Promise<
|
|
1215
|
+
getAvailableTransitions(id: number, tenantId?: number | null | undefined): Promise<PagedOfProjectStatusTransitionDto>;
|
|
1216
1216
|
/**
|
|
1217
1217
|
* Changes the project status.
|
|
1218
1218
|
* @param id Project identifier
|
|
@@ -1248,7 +1248,7 @@ export interface IProjectsApiClient {
|
|
|
1248
1248
|
* @param tenantId (optional) Tenant identifier.
|
|
1249
1249
|
* @return Success
|
|
1250
1250
|
*/
|
|
1251
|
-
getAllTransitions(tenantId?: number | null | undefined): Promise<
|
|
1251
|
+
getAllTransitions(tenantId?: number | null | undefined): Promise<PagedOfProjectStatusTransitionDto>;
|
|
1252
1252
|
/**
|
|
1253
1253
|
* Returns a project processing results.
|
|
1254
1254
|
* @param id Project identifier.
|
|
@@ -1388,8 +1388,8 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
|
|
|
1388
1388
|
* @param tenantId (optional) Tenant identifier.
|
|
1389
1389
|
* @return Success
|
|
1390
1390
|
*/
|
|
1391
|
-
getAvailableTransitions(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<
|
|
1392
|
-
protected processGetAvailableTransitions(response: AxiosResponse): Promise<
|
|
1391
|
+
getAvailableTransitions(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusTransitionDto>;
|
|
1392
|
+
protected processGetAvailableTransitions(response: AxiosResponse): Promise<PagedOfProjectStatusTransitionDto>;
|
|
1393
1393
|
/**
|
|
1394
1394
|
* Changes the project status.
|
|
1395
1395
|
* @param id Project identifier
|
|
@@ -1429,8 +1429,8 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
|
|
|
1429
1429
|
* @param tenantId (optional) Tenant identifier.
|
|
1430
1430
|
* @return Success
|
|
1431
1431
|
*/
|
|
1432
|
-
getAllTransitions(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<
|
|
1433
|
-
protected processGetAllTransitions(response: AxiosResponse): Promise<
|
|
1432
|
+
getAllTransitions(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusTransitionDto>;
|
|
1433
|
+
protected processGetAllTransitions(response: AxiosResponse): Promise<PagedOfProjectStatusTransitionDto>;
|
|
1434
1434
|
/**
|
|
1435
1435
|
* Returns a project processing results.
|
|
1436
1436
|
* @param id Project identifier.
|
|
@@ -1485,10 +1485,11 @@ export interface IStorefrontsApiClient {
|
|
|
1485
1485
|
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
1486
1486
|
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
1487
1487
|
* @param search (optional) Search string for partial match.
|
|
1488
|
+
* @param status (optional) Storefront status.
|
|
1488
1489
|
* @param tenantId (optional) Tenant identifier.
|
|
1489
1490
|
* @return Success
|
|
1490
1491
|
*/
|
|
1491
|
-
getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
|
|
1492
|
+
getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
|
|
1492
1493
|
/**
|
|
1493
1494
|
* Returns a storefront by identifier.
|
|
1494
1495
|
* @param id Storefront identifier.
|
|
@@ -1509,10 +1510,11 @@ export declare class StorefrontsApiClient extends ApiClientBase implements IStor
|
|
|
1509
1510
|
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
1510
1511
|
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
1511
1512
|
* @param search (optional) Search string for partial match.
|
|
1513
|
+
* @param status (optional) Storefront status.
|
|
1512
1514
|
* @param tenantId (optional) Tenant identifier.
|
|
1513
1515
|
* @return Success
|
|
1514
1516
|
*/
|
|
1515
|
-
getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
|
|
1517
|
+
getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
|
|
1516
1518
|
protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontDto>;
|
|
1517
1519
|
/**
|
|
1518
1520
|
* Returns a storefront by identifier.
|
|
@@ -2610,6 +2612,8 @@ export interface ProjectDto {
|
|
|
2610
2612
|
orderUrl?: string | null;
|
|
2611
2613
|
/** Order number in ecommerce system. */
|
|
2612
2614
|
orderNumber?: number | null;
|
|
2615
|
+
/** Order name in ecommerce system. */
|
|
2616
|
+
orderName?: string | null;
|
|
2613
2617
|
/** Order item identifier from storefront order. */
|
|
2614
2618
|
orderLineItemId?: string | null;
|
|
2615
2619
|
/** Order item index from storefront order. */
|
|
@@ -2717,6 +2721,8 @@ export interface CreateSingleItemProjectDto {
|
|
|
2717
2721
|
orderUrl?: string | null;
|
|
2718
2722
|
/** Order number in ecommerce system. */
|
|
2719
2723
|
orderNumber?: number | null;
|
|
2724
|
+
/** Order name in ecommerce system. */
|
|
2725
|
+
orderName?: string | null;
|
|
2720
2726
|
/** Customer identifier in ecommerce system. */
|
|
2721
2727
|
customerId?: string | null;
|
|
2722
2728
|
/** Customer name in ecommerce system. */
|
|
@@ -2738,6 +2744,8 @@ export interface CreateMultiItemProjectDto {
|
|
|
2738
2744
|
orderUrl?: string | null;
|
|
2739
2745
|
/** Order number in ecommerce system. */
|
|
2740
2746
|
orderNumber?: number | null;
|
|
2747
|
+
/** Order name in ecommerce system. */
|
|
2748
|
+
orderName?: string | null;
|
|
2741
2749
|
/** Customer identifier in ecommerce system. */
|
|
2742
2750
|
customerId?: string | null;
|
|
2743
2751
|
/** Customer name in ecommerce system. */
|
|
@@ -2759,6 +2767,8 @@ export interface OrderDetailsDto {
|
|
|
2759
2767
|
orderUrl?: string | null;
|
|
2760
2768
|
/** Order number in ecommerce system. */
|
|
2761
2769
|
orderNumber?: number | null;
|
|
2770
|
+
/** Order name in ecommerce system. */
|
|
2771
|
+
orderName?: string | null;
|
|
2762
2772
|
/** Line item index from ecommerce system order. */
|
|
2763
2773
|
orderLineItemIndex?: number | null;
|
|
2764
2774
|
/** Line Item identifier from ecommerce system order. */
|
|
@@ -2857,8 +2867,10 @@ export interface CreateProjectBySpecificPipelineScenarioDto {
|
|
|
2857
2867
|
/** 'Specific Pipeline' scenario params. For more information check BackOffice.Web.PublicApi.ApiStorefront.Models.SpecificPipelineScenarioDto. */
|
|
2858
2868
|
scenario: SpecificPipelineScenarioDto;
|
|
2859
2869
|
}
|
|
2860
|
-
/** Project transition dto class. */
|
|
2861
|
-
export interface
|
|
2870
|
+
/** Project status transition dto class. */
|
|
2871
|
+
export interface ProjectStatusTransitionDto {
|
|
2872
|
+
/** Transition identifier. */
|
|
2873
|
+
id?: number;
|
|
2862
2874
|
/** Transition identifying name. */
|
|
2863
2875
|
name?: string | null;
|
|
2864
2876
|
/** Transition display name. */
|
|
@@ -2869,23 +2881,27 @@ export interface ProjectTransitionDto {
|
|
|
2869
2881
|
resultStatus?: number;
|
|
2870
2882
|
}
|
|
2871
2883
|
/** Paged list of items. */
|
|
2872
|
-
export interface
|
|
2884
|
+
export interface PagedOfProjectStatusTransitionDto {
|
|
2873
2885
|
/** Items count. */
|
|
2874
2886
|
total?: number;
|
|
2875
2887
|
/** Items list. */
|
|
2876
|
-
items?:
|
|
2888
|
+
items?: ProjectStatusTransitionDto[] | null;
|
|
2877
2889
|
}
|
|
2878
|
-
/**
|
|
2890
|
+
/** Project status parameters. */
|
|
2879
2891
|
export interface ProjectStatusDto {
|
|
2892
|
+
/** Project status identifier. */
|
|
2893
|
+
id?: number;
|
|
2880
2894
|
/** Status code. */
|
|
2881
2895
|
code?: number;
|
|
2896
|
+
/** Status mark color. */
|
|
2897
|
+
color?: string | null;
|
|
2882
2898
|
/** Status display name. */
|
|
2883
2899
|
displayName?: string | null;
|
|
2884
2900
|
}
|
|
2885
|
-
/** Dto class, containing information about the project transition conflict. */
|
|
2886
|
-
export interface
|
|
2901
|
+
/** Dto class, containing information about the project status transition conflict. */
|
|
2902
|
+
export interface ProjectStatusTransitionConflictDto {
|
|
2887
2903
|
/** A list of all available status transitions for the project. */
|
|
2888
|
-
availableTransitions?:
|
|
2904
|
+
availableTransitions?: ProjectStatusTransitionDto[] | null;
|
|
2889
2905
|
/** Problem description. */
|
|
2890
2906
|
description?: string | null;
|
|
2891
2907
|
/** Coflict type. */
|
|
@@ -2961,6 +2977,11 @@ export declare enum StorefrontType {
|
|
|
2961
2977
|
Shopify = "Shopify",
|
|
2962
2978
|
ShopifyCustom = "ShopifyCustom"
|
|
2963
2979
|
}
|
|
2980
|
+
/** Storefront status. */
|
|
2981
|
+
export declare enum StorefrontStatus {
|
|
2982
|
+
Dev = "Dev",
|
|
2983
|
+
Prod = "Prod"
|
|
2984
|
+
}
|
|
2964
2985
|
/** Dto class, containing information about a storefront. */
|
|
2965
2986
|
export interface StorefrontDto {
|
|
2966
2987
|
/** Storefront identifier. */
|
|
@@ -2973,6 +2994,8 @@ export interface StorefrontDto {
|
|
|
2973
2994
|
type?: StorefrontType;
|
|
2974
2995
|
/** Storefront entity creation date and time. */
|
|
2975
2996
|
created?: string;
|
|
2997
|
+
/** Storefront status. */
|
|
2998
|
+
status?: StorefrontStatus;
|
|
2976
2999
|
}
|
|
2977
3000
|
/** Paged list of items. */
|
|
2978
3001
|
export interface PagedOfStorefrontDto {
|
|
@@ -2702,7 +2702,7 @@ export class ProductsApiClient extends ApiClientBase {
|
|
|
2702
2702
|
* @param tenantId (optional) Tenant identifier.
|
|
2703
2703
|
* @return Success
|
|
2704
2704
|
*/
|
|
2705
|
-
|
|
2705
|
+
getPersonalizationParameters(id, productVersionId, tenantId, cancelToken) {
|
|
2706
2706
|
let url_ = this.baseUrl + "/api/storefront/v1/products/{id}/personalization-parameters?";
|
|
2707
2707
|
if (id === undefined || id === null)
|
|
2708
2708
|
throw new Error("The parameter 'id' must be defined.");
|
|
@@ -2730,10 +2730,10 @@ export class ProductsApiClient extends ApiClientBase {
|
|
|
2730
2730
|
throw _error;
|
|
2731
2731
|
}
|
|
2732
2732
|
}).then((_response) => {
|
|
2733
|
-
return this.transformResult(url_, _response, (_response) => this.
|
|
2733
|
+
return this.transformResult(url_, _response, (_response) => this.processGetPersonalizationParameters(_response));
|
|
2734
2734
|
});
|
|
2735
2735
|
}
|
|
2736
|
-
|
|
2736
|
+
processGetPersonalizationParameters(response) {
|
|
2737
2737
|
const status = response.status;
|
|
2738
2738
|
let _headers = {};
|
|
2739
2739
|
if (response.headers && typeof response.headers === "object") {
|
|
@@ -2788,7 +2788,7 @@ export class ProductsApiClient extends ApiClientBase {
|
|
|
2788
2788
|
* @param tenantId (optional) Tenant identifier.
|
|
2789
2789
|
* @return Success
|
|
2790
2790
|
*/
|
|
2791
|
-
|
|
2791
|
+
getProductSummary(id, productVersionId, productLinkId, productVariantId, sku, tenantId, cancelToken) {
|
|
2792
2792
|
let url_ = this.baseUrl + "/api/storefront/v1/products/{id}/summary?";
|
|
2793
2793
|
if (id === undefined || id === null)
|
|
2794
2794
|
throw new Error("The parameter 'id' must be defined.");
|
|
@@ -2822,10 +2822,10 @@ export class ProductsApiClient extends ApiClientBase {
|
|
|
2822
2822
|
throw _error;
|
|
2823
2823
|
}
|
|
2824
2824
|
}).then((_response) => {
|
|
2825
|
-
return this.transformResult(url_, _response, (_response) => this.
|
|
2825
|
+
return this.transformResult(url_, _response, (_response) => this.processGetProductSummary(_response));
|
|
2826
2826
|
});
|
|
2827
2827
|
}
|
|
2828
|
-
|
|
2828
|
+
processGetProductSummary(response) {
|
|
2829
2829
|
const status = response.status;
|
|
2830
2830
|
let _headers = {};
|
|
2831
2831
|
if (response.headers && typeof response.headers === "object") {
|
|
@@ -5919,10 +5919,11 @@ export class StorefrontsApiClient extends ApiClientBase {
|
|
|
5919
5919
|
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
5920
5920
|
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
5921
5921
|
* @param search (optional) Search string for partial match.
|
|
5922
|
+
* @param status (optional) Storefront status.
|
|
5922
5923
|
* @param tenantId (optional) Tenant identifier.
|
|
5923
5924
|
* @return Success
|
|
5924
5925
|
*/
|
|
5925
|
-
getAll(types, skip, take, sorting, search, tenantId, cancelToken) {
|
|
5926
|
+
getAll(types, skip, take, sorting, search, status, tenantId, cancelToken) {
|
|
5926
5927
|
let url_ = this.baseUrl + "/api/storefront/v1/storefronts?";
|
|
5927
5928
|
if (types !== undefined && types !== null)
|
|
5928
5929
|
types && types.forEach(item => { url_ += "types=" + encodeURIComponent("" + item) + "&"; });
|
|
@@ -5934,6 +5935,8 @@ export class StorefrontsApiClient extends ApiClientBase {
|
|
|
5934
5935
|
url_ += "sorting=" + encodeURIComponent("" + sorting) + "&";
|
|
5935
5936
|
if (search !== undefined && search !== null)
|
|
5936
5937
|
url_ += "search=" + encodeURIComponent("" + search) + "&";
|
|
5938
|
+
if (status !== undefined && status !== null)
|
|
5939
|
+
url_ += "status=" + encodeURIComponent("" + status) + "&";
|
|
5937
5940
|
if (tenantId !== undefined && tenantId !== null)
|
|
5938
5941
|
url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
|
|
5939
5942
|
url_ = url_.replace(/[?&]$/, "");
|
|
@@ -7000,6 +7003,12 @@ export var StorefrontType;
|
|
|
7000
7003
|
StorefrontType["Shopify"] = "Shopify";
|
|
7001
7004
|
StorefrontType["ShopifyCustom"] = "ShopifyCustom";
|
|
7002
7005
|
})(StorefrontType || (StorefrontType = {}));
|
|
7006
|
+
/** Storefront status. */
|
|
7007
|
+
export var StorefrontStatus;
|
|
7008
|
+
(function (StorefrontStatus) {
|
|
7009
|
+
StorefrontStatus["Dev"] = "Dev";
|
|
7010
|
+
StorefrontStatus["Prod"] = "Prod";
|
|
7011
|
+
})(StorefrontStatus || (StorefrontStatus = {}));
|
|
7003
7012
|
export class ApiException extends Error {
|
|
7004
7013
|
message;
|
|
7005
7014
|
status;
|