@orderingstack/ordering-types 1.13.1 → 1.14.0

package/dist/cjs/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./kiosk";
 export * from "./kioskErrors";
 export * from "./api";
+export * from "./loyalty";
 export interface IRestaurant {
     id: string;
     name: string;

package/dist/cjs/index.js

@@ -18,6 +18,7 @@ exports.ENotificationType = exports.EChannelName = exports.EOrderProductKind = e
 __exportStar(require("./kiosk"), exports);
 __exportStar(require("./kioskErrors"), exports);
 __exportStar(require("./api"), exports);
+__exportStar(require("./loyalty"), exports);
 var ECouponViewType;
 (function (ECouponViewType) {
     ECouponViewType["CAROUSEL"] = "carousel";

package/dist/cjs/loyalty.d.ts

@@ -0,0 +1,102 @@
+import { IOrder } from "./index";
+export interface Campaign {
+    /**
+     * @minLength 0
+     * @maxLength 64
+     * @pattern [a-zA-Z0-9_-]+
+     */
+    id: string;
+    initialized?: boolean;
+    /**
+     * @minLength 0
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * @maxItems 16
+     * @minItems 1
+     */
+    constraints: Constraint[];
+    /** @format date-time */
+    initializedAt?: string;
+    initializedBy?: string;
+    /** @format int64 */
+    cnt?: number;
+    /** @format date-time */
+    previewedAt?: string;
+    samples?: string[];
+}
+interface Constraint {
+    /**
+     * @minLength 0
+     * @maxLength 64
+     * @pattern ((counters|properties|venues|tags)\.[a-zA-Z0-9_-]+)|(header\.(firstName|created|lastOrder|birthdate))
+     */
+    field: string;
+    op: "EQ" | "NE" | "IN" | "GT" | "GTE" | "LT" | "LTE" | "EXISTS";
+    /**
+     * @maxItems 16
+     * @minItems 0
+     */
+    value?: string[];
+}
+interface AccountHeader {
+    phone?: string;
+    email?: string;
+    pushId?: string;
+    firstName?: string;
+    lastName?: string;
+    /** @format date */
+    birthdate?: string;
+    /** @format date-time */
+    created?: string;
+    /** @format date-time */
+    lastEvent?: string;
+    /** @format date-time */
+    lastLogged?: string;
+    /** @format date-time */
+    lastOrder?: string;
+}
+export interface ApiAccount {
+    id?: string;
+    card?: string;
+    mgm?: string;
+    header?: AccountHeader;
+    consents?: Consents;
+    /** @uniqueItems true */
+    tags?: string[];
+    /** @uniqueItems true */
+    importantTags?: string[];
+    /** @uniqueItems true */
+    venues?: string[];
+    properties?: Record<string, string>;
+    counters?: Record<string, number>;
+    relations?: Relation[];
+    openedOrders?: IOrder[];
+    previousOrders?: IOrder[];
+    /** @uniqueItems true */
+    coupons?: string[];
+    campaigns?: CampaignState[];
+    segment?: string;
+}
+interface CampaignState {
+    id?: string;
+    state?: string;
+}
+interface Consents {
+    scope: "ACCOUNT" | "TRANSACTION";
+    /**
+     * @minLength 0
+     * @maxLength 128
+     * @pattern [a-zA-Z0-9_.-]+
+     */
+    transaction?: string;
+    consents: Record<string, string>;
+}
+interface Relation {
+    id?: string;
+    /** @format date-time */
+    at?: string;
+    type?: "INVITED_BY" | "INVITED" | "FRIEND" | "UNKNOWN";
+}
+export {};

package/dist/cjs/loyalty.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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_",
+];