@ikas/storefront-models 5.0.56 → 5.0.58

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.
Files changed (15) hide show
  1. package/build/index.d.ts +2 -0
  2. package/build/models/loyalty-program/index.d.ts +9 -0
  3. package/build/models/order/adjustment/index.d.ts +3 -1
  4. package/build/models/order/index.d.ts +2 -0
  5. package/build/models/order/loyalty-line/index.d.ts +7 -0
  6. package/build/models/product/campaign/data/index.d.ts +3 -1
  7. package/build/models/product/campaign/data/index.js +1 -1
  8. package/build-cjs/index.d.ts +2 -0
  9. package/build-cjs/models/loyalty-program/index.d.ts +9 -0
  10. package/build-cjs/models/order/adjustment/index.d.ts +3 -1
  11. package/build-cjs/models/order/index.d.ts +2 -0
  12. package/build-cjs/models/order/loyalty-line/index.d.ts +7 -0
  13. package/build-cjs/models/product/campaign/data/index.d.ts +3 -1
  14. package/build-cjs/models/product/campaign/data/index.js +1 -1
  15. package/package.json +1 -1
package/build/index.d.ts CHANGED
@@ -65,6 +65,7 @@ export * from "./models/html-meta-data/init";
65
65
  export * from "./models/html-meta-data";
66
66
  export * from "./models/image";
67
67
  export * from "./models/last-viewed-product";
68
+ export * from "./models/loyalty-program";
68
69
  export * from "./models/merchant-settings/init";
69
70
  export * from "./models/merchant-settings";
70
71
  export * from "./models/merchant-settings/address";
@@ -104,6 +105,7 @@ export * from "./models/order/line-item/variant/unit";
104
105
  export * from "./models/order/line-item/variant/value";
105
106
  export * from "./models/order/line-item/variant";
106
107
  export * from "./models/order/line-item";
108
+ export * from "./models/order/loyalty-line";
107
109
  export * from "./models/order/package/tracking-info";
108
110
  export * from "./models/order/package";
109
111
  export * from "./models/order/payment-method";
package/build/models/loyalty-program/index.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ export interface IkasLoyaltyProgramSaleChannel {
2
+ salesChannelId: string;
3
+ storefrontId?: string | null;
4
+ routingIds?: string[] | null;
5
+ }
6
+ export interface IkasLoyaltyProgram {
7
+ id: string;
8
+ salesChannels?: IkasLoyaltyProgramSaleChannel[] | null;
9
+ }
package/build/models/order/adjustment/index.d.ts CHANGED
@@ -1,15 +1,17 @@
1
- import { IkasCampaignType } from "../../../models/product/campaign/data";
1
+ import { IkasCampaignType, IkasCampaignCreatedFor } from "../../../models/product/campaign/data";
2
2
  import { IkasOrderAdjustmentAppliedOrderLine } from "./applied-order-line";
3
3
  export declare type IkasOrderAdjustment = {
4
4
  amount: number;
5
5
  appliedOrderLines: IkasOrderAdjustmentAppliedOrderLine[] | null;
6
6
  campaignId: string | null;
7
7
  couponId: string | null;
8
+ createdFor: IkasCampaignCreatedFor | null;
8
9
  name: string;
9
10
  order: number;
10
11
  amountType: IkasAmountType;
11
12
  type: IkasAdjustmentType;
12
13
  campaignType: IkasCampaignType | null;
14
+ usedLoyaltyPoints: number | null;
13
15
  };
14
16
  export declare enum IkasAmountType {
15
17
  AMOUNT = "AMOUNT",
package/build/models/order/index.d.ts CHANGED
@@ -10,6 +10,7 @@ import { IkasOrderPackage } from "./package";
10
10
  import { IkasOrderTaxLine } from "./tax-line";
11
11
  import { IkasBaseModel } from "../base";
12
12
  import { IkasOrderGiftCardLine } from "./gift-card-line";
13
+ import { IkasOrderLoyaltyLine } from "./loyalty-line";
13
14
  export declare type IkasOrder = {
14
15
  billingAddress: IkasOrderAddress | null;
15
16
  cancelReason: IkasOrderCancelReason | null;
@@ -24,6 +25,7 @@ export declare type IkasOrder = {
24
25
  giftPackageNote: string | null;
25
26
  invoices: IkasInvoice[] | null;
26
27
  isGiftPackage: boolean | null;
28
+ loyaltyLines: IkasOrderLoyaltyLine[] | null;
27
29
  note: string | null;
28
30
  orderAdjustments: IkasOrderAdjustment[] | null;
29
31
  orderLineItems: IkasOrderLineItem[];
package/build/models/order/loyalty-line/index.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ export declare type IkasOrderLoyaltyLine = {
2
+ amount: number;
3
+ id: string;
4
+ loyaltyProgramCustomerId: string;
5
+ loyaltyProgramId: string;
6
+ loyaltySpendingMethodId: string;
7
+ };
package/build/models/product/campaign/data/index.d.ts CHANGED
@@ -31,7 +31,9 @@ export declare enum IkasCampaignApplicablePrice {
31
31
  export declare enum IkasCampaignCreatedFor {
32
32
  ABANDONED_CHECKOUT = "ABANDONED_CHECKOUT",
33
33
  CART = "CART",
34
- CUSTOMER_REVIEW = "CUSTOMER_REVIEW"
34
+ CUSTOMER_REVIEW = "CUSTOMER_REVIEW",
35
+ LOYALTY_SPEND = "LOYALTY_SPEND",
36
+ MARKETING_CAMPAIGN = "MARKETING_CAMPAIGN"
35
37
  }
36
38
  export declare enum IkasCampaignType {
37
39
  BUY_X_THEN_GET_Y = "BUY_X_THEN_GET_Y",
package/build/models/product/campaign/data/index.js CHANGED
@@ -1 +1 @@
1
- var E,_,I;!function(E){E.DISCOUNT_PRICE="DISCOUNT_PRICE",E.SELL_PRICE="SELL_PRICE"}(E||(E={})),function(E){E.ABANDONED_CHECKOUT="ABANDONED_CHECKOUT",E.CART="CART",E.CUSTOMER_REVIEW="CUSTOMER_REVIEW"}(_||(_={})),function(E){E.BUY_X_THEN_GET_Y="BUY_X_THEN_GET_Y",E.FIXED_AMOUNT="FIXED_AMOUNT",E.FREE_SHIPPING="FREE_SHIPPING",E.RATIO="RATIO"}(I||(I={}));export{E as IkasCampaignApplicablePrice,_ as IkasCampaignCreatedFor,I as IkasCampaignType};
1
+ var E,_,I;!function(E){E.DISCOUNT_PRICE="DISCOUNT_PRICE",E.SELL_PRICE="SELL_PRICE"}(E||(E={})),function(E){E.ABANDONED_CHECKOUT="ABANDONED_CHECKOUT",E.CART="CART",E.CUSTOMER_REVIEW="CUSTOMER_REVIEW",E.LOYALTY_SPEND="LOYALTY_SPEND",E.MARKETING_CAMPAIGN="MARKETING_CAMPAIGN"}(_||(_={})),function(E){E.BUY_X_THEN_GET_Y="BUY_X_THEN_GET_Y",E.FIXED_AMOUNT="FIXED_AMOUNT",E.FREE_SHIPPING="FREE_SHIPPING",E.RATIO="RATIO"}(I||(I={}));export{E as IkasCampaignApplicablePrice,_ as IkasCampaignCreatedFor,I as IkasCampaignType};
package/build-cjs/index.d.ts CHANGED
@@ -65,6 +65,7 @@ export * from "./models/html-meta-data/init";
65
65
  export * from "./models/html-meta-data";
66
66
  export * from "./models/image";
67
67
  export * from "./models/last-viewed-product";
68
+ export * from "./models/loyalty-program";
68
69
  export * from "./models/merchant-settings/init";
69
70
  export * from "./models/merchant-settings";
70
71
  export * from "./models/merchant-settings/address";
@@ -104,6 +105,7 @@ export * from "./models/order/line-item/variant/unit";
104
105
  export * from "./models/order/line-item/variant/value";
105
106
  export * from "./models/order/line-item/variant";
106
107
  export * from "./models/order/line-item";
108
+ export * from "./models/order/loyalty-line";
107
109
  export * from "./models/order/package/tracking-info";
108
110
  export * from "./models/order/package";
109
111
  export * from "./models/order/payment-method";
package/build-cjs/models/loyalty-program/index.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ export interface IkasLoyaltyProgramSaleChannel {
2
+ salesChannelId: string;
3
+ storefrontId?: string | null;
4
+ routingIds?: string[] | null;
5
+ }
6
+ export interface IkasLoyaltyProgram {
7
+ id: string;
8
+ salesChannels?: IkasLoyaltyProgramSaleChannel[] | null;
9
+ }
package/build-cjs/models/order/adjustment/index.d.ts CHANGED
@@ -1,15 +1,17 @@
1
- import { IkasCampaignType } from "../../../models/product/campaign/data";
1
+ import { IkasCampaignType, IkasCampaignCreatedFor } from "../../../models/product/campaign/data";
2
2
  import { IkasOrderAdjustmentAppliedOrderLine } from "./applied-order-line";
3
3
  export declare type IkasOrderAdjustment = {
4
4
  amount: number;
5
5
  appliedOrderLines: IkasOrderAdjustmentAppliedOrderLine[] | null;
6
6
  campaignId: string | null;
7
7
  couponId: string | null;
8
+ createdFor: IkasCampaignCreatedFor | null;
8
9
  name: string;
9
10
  order: number;
10
11
  amountType: IkasAmountType;
11
12
  type: IkasAdjustmentType;
12
13
  campaignType: IkasCampaignType | null;
14
+ usedLoyaltyPoints: number | null;
13
15
  };
14
16
  export declare enum IkasAmountType {
15
17
  AMOUNT = "AMOUNT",
package/build-cjs/models/order/index.d.ts CHANGED
@@ -10,6 +10,7 @@ import { IkasOrderPackage } from "./package";
10
10
  import { IkasOrderTaxLine } from "./tax-line";
11
11
  import { IkasBaseModel } from "../base";
12
12
  import { IkasOrderGiftCardLine } from "./gift-card-line";
13
+ import { IkasOrderLoyaltyLine } from "./loyalty-line";
13
14
  export declare type IkasOrder = {
14
15
  billingAddress: IkasOrderAddress | null;
15
16
  cancelReason: IkasOrderCancelReason | null;
@@ -24,6 +25,7 @@ export declare type IkasOrder = {
24
25
  giftPackageNote: string | null;
25
26
  invoices: IkasInvoice[] | null;
26
27
  isGiftPackage: boolean | null;
28
+ loyaltyLines: IkasOrderLoyaltyLine[] | null;
27
29
  note: string | null;
28
30
  orderAdjustments: IkasOrderAdjustment[] | null;
29
31
  orderLineItems: IkasOrderLineItem[];
package/build-cjs/models/order/loyalty-line/index.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ export declare type IkasOrderLoyaltyLine = {
2
+ amount: number;
3
+ id: string;
4
+ loyaltyProgramCustomerId: string;
5
+ loyaltyProgramId: string;
6
+ loyaltySpendingMethodId: string;
7
+ };
package/build-cjs/models/product/campaign/data/index.d.ts CHANGED
@@ -31,7 +31,9 @@ export declare enum IkasCampaignApplicablePrice {
31
31
  export declare enum IkasCampaignCreatedFor {
32
32
  ABANDONED_CHECKOUT = "ABANDONED_CHECKOUT",
33
33
  CART = "CART",
34
- CUSTOMER_REVIEW = "CUSTOMER_REVIEW"
34
+ CUSTOMER_REVIEW = "CUSTOMER_REVIEW",
35
+ LOYALTY_SPEND = "LOYALTY_SPEND",
36
+ MARKETING_CAMPAIGN = "MARKETING_CAMPAIGN"
35
37
  }
36
38
  export declare enum IkasCampaignType {
37
39
  BUY_X_THEN_GET_Y = "BUY_X_THEN_GET_Y",
package/build-cjs/models/product/campaign/data/index.js CHANGED
@@ -1 +1 @@
1
- "use strict";var a,e,p;Object.defineProperty(exports,"__esModule",{value:!0}),exports.IkasCampaignApplicablePrice=void 0,(a=exports.IkasCampaignApplicablePrice||(exports.IkasCampaignApplicablePrice={})).DISCOUNT_PRICE="DISCOUNT_PRICE",a.SELL_PRICE="SELL_PRICE",exports.IkasCampaignCreatedFor=void 0,(e=exports.IkasCampaignCreatedFor||(exports.IkasCampaignCreatedFor={})).ABANDONED_CHECKOUT="ABANDONED_CHECKOUT",e.CART="CART",e.CUSTOMER_REVIEW="CUSTOMER_REVIEW",exports.IkasCampaignType=void 0,(p=exports.IkasCampaignType||(exports.IkasCampaignType={})).BUY_X_THEN_GET_Y="BUY_X_THEN_GET_Y",p.FIXED_AMOUNT="FIXED_AMOUNT",p.FREE_SHIPPING="FREE_SHIPPING",p.RATIO="RATIO";
1
+ "use strict";var a,e,E;Object.defineProperty(exports,"__esModule",{value:!0}),exports.IkasCampaignApplicablePrice=void 0,(a=exports.IkasCampaignApplicablePrice||(exports.IkasCampaignApplicablePrice={})).DISCOUNT_PRICE="DISCOUNT_PRICE",a.SELL_PRICE="SELL_PRICE",exports.IkasCampaignCreatedFor=void 0,(e=exports.IkasCampaignCreatedFor||(exports.IkasCampaignCreatedFor={})).ABANDONED_CHECKOUT="ABANDONED_CHECKOUT",e.CART="CART",e.CUSTOMER_REVIEW="CUSTOMER_REVIEW",e.LOYALTY_SPEND="LOYALTY_SPEND",e.MARKETING_CAMPAIGN="MARKETING_CAMPAIGN",exports.IkasCampaignType=void 0,(E=exports.IkasCampaignType||(exports.IkasCampaignType={})).BUY_X_THEN_GET_Y="BUY_X_THEN_GET_Y",E.FIXED_AMOUNT="FIXED_AMOUNT",E.FREE_SHIPPING="FREE_SHIPPING",E.RATIO="RATIO";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ikas/storefront-models",
3
- "version": "5.0.56",
3
+ "version": "5.0.58",
4
4
  "author": "ikas",
5
5
  "license": "ISC",
6
6
  "description": "Data models to be used in an ikas storefront application.",