@orderingstack/ordering-types 1.18.0 → 1.18.2

package/dist/cjs/api.d.ts

@@ -1,7 +1,7 @@
 import { EOrderPaymentType, EOrderStatus, EOrderType, IProductState, IStringKeyRecord } from "./index";
 export declare const aggregators: readonly ["GLOVO", "JUSTEAT", "UBER", "WOLT", "BOLT", "TAZZ", "_ANY_"];
-export declare type TAggregator = typeof aggregators[number];
-declare type TOrderDir = "DESC" | "ASC";
+export type TAggregator = typeof aggregators[number];
+type TOrderDir = "DESC" | "ASC";
 interface ApiParams {
     query?: any;
     headers?: IStringKeyRecord<string>;

package/dist/cjs/index.d.ts

@@ -39,7 +39,7 @@ export interface ILanguage {
     key: string;
     icon: any;
 }
-export declare type TStringBoolean = "true" | "false";
+export type TStringBoolean = "true" | "false";
 export declare enum EProductKind {
     GROUP = "3e/group",
     PRODUCT = "3e/product",
@@ -54,14 +54,14 @@ export declare enum EProductKindBucket {
     GROUP = "group",
     PRODUCT = "product"
 }
-export declare type TLiterals = {
+export type TLiterals = {
     name: string;
     upsizeName?: string;
     fiscal?: string;
     "target-product-id"?: string;
     description?: string;
 } & IStringKeyRecord<string | undefined>;
-export declare type TMedia = {
+export type TMedia = {
     url: string;
     name: string;
 };
@@ -448,7 +448,7 @@ export interface ISubTotalDiscount {
     discount: number;
     vat: string;
 }
-export declare type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
+export type IOrderGroupProduct = Pick<IOrderProduct, "kind" | "id" | "literals" | "items" | "extra">;
 export interface IOrderProduct {
     id: string;
     kind: EOrderProductKind;
@@ -472,11 +472,11 @@ export declare enum EOrderLineStatus {
 export interface IDiscount {
     layer: string;
     name?: string;
-    discountPrice: number;
+    discountPrice: number | string;
     type: string;
-    product: string;
+    product?: string;
     path?: string;
-    price: number;
+    price?: number | string;
 }
 export declare enum EOrderProductKind {
     GROUP = "group",
@@ -485,8 +485,8 @@ export declare enum EOrderProductKind {
 export interface IProductLiterals {
     [propName: string]: any;
 }
-declare type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
-export declare type TSaleChannelWeek = Partial<Record<TWeekDay, {
+type TWeekDay = "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN";
+export type TSaleChannelWeek = Partial<Record<TWeekDay, {
     from: string;
     to: string;
 }[]>>;
@@ -560,14 +560,14 @@ export interface IFiscalizeData {
     };
 }
 declare const sizes: readonly [48, 57, 70, 100, 160, 250, 300, 500, 600, 900, 1000, 1920, 1080, 900];
-export declare type TMediaSize = (typeof sizes)[number];
+export type TMediaSize = (typeof sizes)[number];
 export declare enum ENotificationType {
     ORDER_EVENT_ERROR = "OrderEventError",
     ORDER_APPLIED_EVENTS = "OrderAppliedEvents",
     ORDER_EVENT_FISCAL = "OrderEventFiscal",
     ORDER_UPSELL = "OrderUpsell"
 }
-export declare type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
+export type TUpsellKind = "ANY" | "POPUP" | "SIDE" | "BASKET";
 export interface IUpsellNotification {
     details: {
         literals?: IStringKeyRecord<string>;

package/dist/cjs/kioskErrors.d.ts

@@ -138,7 +138,7 @@ export declare const KioskErrors: {
     x500: string;
     x501: string;
 };
-export declare type TErrorCode = keyof typeof KioskErrors;
+export type TErrorCode = keyof typeof KioskErrors;
 export interface IKioskError {
     errorType: string;
     errorCode: TErrorCode;

package/dist/cjs/loyalty.d.ts

@@ -1,4 +1,42 @@
 import { IOrder } from "./index";
+/** States define flow of campaign */
+interface CampaignStateDefinition {
+    /**
+     * @minLength 1
+     * @maxLength 32
+     * @pattern [a-zA-Z0-9_-]+
+     */
+    id: string;
+    /**
+     * @minLength 1
+     * @maxLength 32
+     * @pattern [a-zA-Z0-9_-]+
+     */
+    transitionTo?: string;
+    /** @format int64 */
+    stats?: number;
+    type: string;
+}
+/** Define push notification templates */
+export interface CampaignNotification {
+    /**
+     * @minLength 0
+     * @maxLength 256
+     */
+    title: string;
+    /**
+     * @minLength 0
+     * @maxLength 256
+     */
+    message: string;
+    /**
+     * @minLength 0
+     * @maxLength 256
+     */
+    image?: string;
+    payload?: Record<string, string>;
+    type: string;
+}
 export interface Campaign {
     /**
      * @minLength 0
@@ -6,24 +44,58 @@ export interface Campaign {
      * @pattern [a-zA-Z0-9_-]+
      */
     id: string;
-    initialized?: boolean;
     /**
-     * @minLength 0
+     * Name of a campaign
+     * @minLength 3
      * @maxLength 128
      */
     name: string;
+    /** @format date-time */
+    activeFrom?: string;
+    /** @format date-time */
+    activeTo?: string;
     /**
+     * Constraints are rules that specify which accounts fall info the campaign.
      * @maxItems 16
      * @minItems 1
      */
     constraints: Constraint[];
-    /** @format date-time */
+    /**
+     * States define flow of campaign
+     * @maxItems 10
+     * @minItems 1
+     */
+    states: CampaignStateDefinition[];
+    /** Flag that determine if campaign can be dynamically joined upon account change or only initially assigned accounts take part in campaign. */
+    dynamic?: boolean;
+    /**
+     * Define push notification templates
+     * @maxItems 3
+     * @minItems 0
+     */
+    notifications?: CampaignNotification[];
+    /**
+     * When campaign was initialized
+     * @format date-time
+     */
     initializedAt?: string;
+    /** Who initialized the campaign */
     initializedBy?: string;
-    /** @format int64 */
+    /** Whether campaign is initialized and running. There is a limit of simultaneously running campaigns. */
+    initialized?: boolean;
+    /**
+     * Number of accounts that fall info the campaign. Before initialization this is a predicted value, after initialization it is current value updated upon dynamic joins etc.
+     * @format int64
+     */
     cnt?: number;
-    /** @format date-time */
+    /** How many accounts finished each campaign state */
+    stateStats?: Record<string, number>;
+    /**
+     * Preview generated at
+     * @format date-time
+     */
     previewedAt?: string;
+    /** Sample account ids for preview */
     samples?: string[];
 }
 interface Constraint {

package/dist/cjs/src/api.d.ts

@@ -0,0 +1,97 @@
+import { EOrderPaymentType, EOrderStatus, EOrderType, IProductState, IStringKeyRecord } from "./index";
+export declare const aggregators: readonly ["GLOVO", "JUSTEAT", "UBER", "WOLT", "BOLT", "TAZZ", "_ANY_"];
+export type TAggregator = typeof aggregators[number];
+type TOrderDir = "DESC" | "ASC";
+interface ApiParams {
+    query?: any;
+    headers?: IStringKeyRecord<string>;
+    data?: any;
+}
+export interface IOrderApiGetListParams extends ApiParams {
+    query: {
+        _sort?: string;
+        _order?: TOrderDir;
+        _start?: number;
+        _end?: number;
+        id?: string;
+        extId?: string;
+        status?: EOrderStatus;
+        type?: EOrderType;
+        completed?: boolean;
+        closed?: boolean;
+        phone?: string;
+        mail?: string;
+        createdFrom?: string;
+        createdTo?: string;
+        completedFrom?: string;
+        completedTo?: string;
+        venue?: string;
+        aggregator?: TAggregator;
+        payment?: EOrderPaymentType;
+    };
+    headers: {
+        "x-tenant"?: string;
+    };
+}
+interface IDiscount {
+    /**
+     * Discount layer. It is used to distinguish discounts from loyalty, manual discounts, etc.
+     * @pattern [a-zA-Z0-9_.-]+
+     */
+    layer: string;
+    /**
+     * Name that describes this discount
+     * @minLength 0
+     * @maxLength 128
+     */
+    name?: string;
+    /** Discount price (subtracted from line total) */
+    discountPrice: number;
+    /** Extra params */
+    extra?: IStringKeyRecord<string>;
+    type: string;
+}
+interface ILineDiscount {
+    /** Applied discounts */
+    discount: IDiscount;
+    /** @format date-time */
+    expires?: string;
+    /**
+     * @minLength 0
+     * @maxLength 128
+     * @pattern [a-zA-Z0-9_. -]+
+     */
+    sign: string;
+}
+export interface IAppendedLine {
+    /**
+     * @format int32
+     * @min 1
+     * @max 100000
+     */
+    quantity: number;
+    /**
+     * One should not provide price - it will be automatically calculated. If user is privileged (internal system user or has role 'SU' or 'ALTERPRICE') OrderingStack will use provided price and override one from menu. Please be careful when providing value '0' as privileged user here! If you do not want to override price - do not provide 'price' attribute at all (null).
+     * @min 0
+     * @exclusiveMin false
+     */
+    price?: number;
+    /** @pattern [a-zA-Z0-9_.-]+ */
+    productId: string;
+    /** Configuration of product */
+    productConfig?: IProductState;
+    /** @default "NEW" */
+    status: "NEW" | "CONFIRMED";
+    /**
+     * @minLength 0
+     * @maxLength 255
+     */
+    comment?: string;
+    /**
+     * @maxItems 10
+     * @minItems 0
+     */
+    discounts?: ILineDiscount[];
+    extra?: IStringKeyRecord<string>;
+}
+export {};

package/dist/cjs/src/api.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.aggregators = void 0;
+exports.aggregators = [
+    "GLOVO",
+    "JUSTEAT",
+    "UBER",
+    "WOLT",
+    "BOLT",
+    "TAZZ",
+    "_ANY_",
+];