@onylab/common-api 2.0.10 → 2.1.1

package/dist/common-api.d.ts

@@ -1,10 +1,3 @@
-declare module "api/mockup/ApiMockup" {
-    export class ApiMockup {
-        static isDone(): boolean;
-        static pending(): string;
-        static reset(): void;
-    }
-}
 declare module "api/hubrise/model/order/HubriseOrderStatus" {
     export enum HubriseOrderStatus {
         new = "new",
@@ -22,6 +15,7 @@ declare module "api/hubrise/model/order/HubriseOrderStatus" {
 }
 declare module "api/hubrise/model/customer/HubriseCustomerContract" {
     export interface HubriseCustomerContract {
+        id?: string;
         first_name?: string;
         last_name?: string;
         gender?: string;
@@ -45,9 +39,11 @@ declare module "api/hubrise/model/customer/HubriseCustomerContract" {
 }
 declare module "api/hubrise/model/order/HubriseOrderOptionContract" {
     export interface HubriseOrderOptionContract {
+        id?: string;
+        ref?: string;
         option_list_name: string;
         name: string;
-        ref?: string;
+        quantity: number;
         price?: string;
         removed?: boolean;
     }
@@ -55,12 +51,13 @@ declare module "api/hubrise/model/order/HubriseOrderOptionContract" {
 declare module "api/hubrise/model/order/HubriseOrderItemContract" {
     import { HubriseOrderOptionContract } from "api/hubrise/model/order/HubriseOrderOptionContract";
     export interface HubriseOrderItemContract {
+        id?: string;
         private_ref?: string;
-        product_name: string;
-        sku_name?: string;
         sku_ref?: string;
+        sku_name?: string;
+        product_name: string;
+        quantity: number;
         price?: string;
-        quantity?: string;
         subtotal?: string;
         tax_rate?: string;
         customer_notes?: string;
@@ -116,6 +113,13 @@ declare module "api/hubrise/model/order/HubriseOrderDealContract" {
         ref?: string;
     }
 }
+declare module "api/hubrise/model/order/HubriseServiceType" {
+    export enum HubriseServiceType {
+        DELIVERY = "delivery",
+        COLLECTION = "collection",// = pickup
+        EAT_IN = "eat_in"
+    }
+}
 declare module "api/hubrise/model/order/HubriseOrderContract" {
     import { HubriseOrderStatus } from "api/hubrise/model/order/HubriseOrderStatus";
     import { HubriseCustomerContract } from "api/hubrise/model/customer/HubriseCustomerContract";
@@ -125,12 +129,13 @@ declare module "api/hubrise/model/order/HubriseOrderContract" {
     import { HubriseOrderPaymentContract } from "api/hubrise/model/order/HubriseOrderPaymentContract";
     import { HubriseOrderDiscountContract } from "api/hubrise/model/order/HubriseOrderDiscountContract";
     import { HubriseOrderDealContract } from "api/hubrise/model/order/HubriseOrderDealContract";
+    import { HubriseServiceType } from "api/hubrise/model/order/HubriseServiceType";
     export interface HubriseOrderContract {
         id?: string;
         location_id?: string;
         private_ref?: string;
         status: HubriseOrderStatus;
-        service_type?: 'delivery' | 'collection' | 'eat_in';
+        service_type?: HubriseServiceType;
         service_type_ref?: string;
         channel?: string;
         expected_time?: string;
@@ -155,26 +160,9 @@ declare module "api/hubrise/model/order/HubriseOrderContract" {
         created_by?: string;
     }
 }
-declare module "api/hubrise/mockup/HubriseApiMockup" {
-    import { ApiMockup } from "api/mockup/ApiMockup";
-    export class HubriseApiMockup extends ApiMockup {
-        static readonly BASE_URL: string;
-        static getUser(times?: number): void;
-        static getLocations(times?: number): void;
-        static createCustomer(times?: number): void;
-        static getCustomer(times?: number): void;
-        static getCustomers(times?: number): void;
-        static getCustomerLists(times?: number): void;
-        static createOrder(times?: number): void;
-        static getOrder(times?: number, generateRandomId?: boolean): void;
-        static setOrderStatus(times?: number): void;
-        static getCatalog(times?: number): void;
-        static getCatalogs(times?: number): void;
-        static createWebhook(times?: number): void;
-    }
-}
 declare module "api/hubrise/model/menu/HubriseMenuCategoryContract" {
     export interface HubriseMenuCategoryContract {
+        id: string;
         ref: string;
         parent_ref?: string;
         name: string;
@@ -197,13 +185,14 @@ declare module "api/hubrise/model/menu/HubriseMenuRestrictionsContract" {
     }
 }
 declare module "api/hubrise/model/menu/HubriseMenuPriceOverrideContract" {
+    import { HubriseServiceType } from "api/hubrise/model/order/HubriseServiceType";
     export interface HubriseMenuPriceOverrideContract {
         dow?: string;
         start_time?: string;
         end_time?: string;
         start_date?: string;
         end_date?: string;
-        service_types?: ('delivery' | 'collection' | 'eat_in')[];
+        service_types?: HubriseServiceType[];
         price: string;
     }
 }
@@ -211,30 +200,38 @@ declare module "api/hubrise/model/menu/HubriseMenuSkuContract" {
     import { HubriseMenuRestrictionsContract } from "api/hubrise/model/menu/HubriseMenuRestrictionsContract";
     import { HubriseMenuPriceOverrideContract } from "api/hubrise/model/menu/HubriseMenuPriceOverrideContract";
     export interface HubriseMenuSkuContract {
+        id: string;
         ref?: string;
         name?: string;
         restrictions?: HubriseMenuRestrictionsContract;
         price: string;
         price_overrides: HubriseMenuPriceOverrideContract[];
-        option_list_refs?: string[];
+        option_list_ids?: string[];
         tags?: string[];
     }
 }
 declare module "api/hubrise/model/menu/HubriseMenuProductContract" {
     import { HubriseMenuSkuContract } from "api/hubrise/model/menu/HubriseMenuSkuContract";
     export interface HubriseMenuProductContract {
+        id: string;
         ref?: string;
-        category_ref: string;
+        category_id: string;
         name: string;
         description?: string;
         tags?: string[];
         image_ids: string[];
         skus: HubriseMenuSkuContract[];
+        tax_rate: {
+            delivery?: string;
+            collection?: string;
+            eat_in?: string;
+        };
     }
 }
 declare module "api/hubrise/model/menu/HubriseMenuProductOptionContract" {
     import { HubriseMenuPriceOverrideContract } from "api/hubrise/model/menu/HubriseMenuPriceOverrideContract";
     export interface HubriseMenuProductOptionContract {
+        id: string;
         ref?: string;
         name: string;
         price: string;
@@ -246,6 +243,7 @@ declare module "api/hubrise/model/menu/HubriseMenuProductOptionContract" {
 declare module "api/hubrise/model/menu/HubriseMenuProductOptionListContract" {
     import { HubriseMenuProductOptionContract } from "api/hubrise/model/menu/HubriseMenuProductOptionContract";
     export interface HubriseMenuProductOptionListContract {
+        id: string;
         ref: string;
         name: string;
         min_selections?: number;
@@ -309,7 +307,7 @@ declare module "api/hubrise/model/menu/HubriseMenuCatalogContract" {
     import { HubriseMenuDiscountContract } from "api/hubrise/model/menu/HubriseMenuDiscountContract";
     import { HubriseMenuChargeContract } from "api/hubrise/model/menu/HubriseMenuChargeContract";
     export interface HubriseMenuCatalogContract {
-        id?: string;
+        id: string;
         location_id?: string;
         name: string;
         created_at?: string;
@@ -1212,10 +1210,143 @@ declare module "api/hubrise/model/menu/HubriseMenuImageContract" {
         seconds_before_removal: number;
     }
 }
-declare module "api/index" {
-    export * from "api/hubrise/mockup/HubriseApiMockup";
-    export * from "api/hubrise/service/HubriseApiContract";
-    export * from "api/hubrise/service/HubriseApi";
+declare module "api/hubrise/model/order/HubriseOrderEditableOptionContract" {
+    export interface HubriseOrderEditableOptionContract {
+        id: string;
+        ref?: string;
+        option_list_name: string;
+        name: string;
+        quantity: number;
+        price: string;
+    }
+}
+declare module "api/hubrise/model/order/HubriseOrderEditableItemContract" {
+    import { HubriseOrderEditableOptionContract } from "api/hubrise/model/order/HubriseOrderEditableOptionContract";
+    export interface HubriseOrderEditableItemContract {
+        id: string;
+        sku_ref?: string;
+        sku_name?: string;
+        category_name?: string;
+        product_name: string;
+        quantity: number;
+        price: string;
+        tax_rate?: {
+            delivery?: string;
+            collection?: string;
+            eat_in?: string;
+        };
+        customer_notes?: string;
+        options?: HubriseOrderEditableOptionContract[];
+    }
+}
+declare module "api/hubrise/service/HubriseCatalogConverterContract" {
+    import { HubriseMenuCatalogContract } from "api/hubrise/model/menu/HubriseMenuCatalogContract";
+    import { HubriseOrderEditableItemContract } from "api/hubrise/model/order/HubriseOrderEditableItemContract";
+    import { HubriseOrderEditableOptionContract } from "api/hubrise/model/order/HubriseOrderEditableOptionContract";
+    export interface HubriseCatalogConverterContract {
+        editableItems(catalog: HubriseMenuCatalogContract): {
+            withRef: HubriseOrderEditableItemContract[];
+            withName: HubriseOrderEditableItemContract[];
+        };
+        editableItemOptions(catalog: HubriseMenuCatalogContract): {
+            withRef: Record<string, HubriseOrderEditableOptionContract[]>;
+            withName: Record<string, HubriseOrderEditableOptionContract[]>;
+        };
+    }
+}
+declare module "util/MathUtil" {
+    export class MathUtil {
+        static sum(values: number[]): number;
+        static avg(values: number[]): number;
+        static applyVariation(value: number, variation: number): number;
+        static median(values: number[]): number;
+        static percentage(part: number, total: number): number;
+        static round(value: number, decimals: number): number;
+        static variation(originalValue: number, newValue: number): number;
+    }
+}
+declare module "api/hubrise/util/HubrisePriceUtil" {
+    import { HubriseCurrencyCode } from "api/hubrise/model/common/HubriseCurrencyCode";
+    export class HubrisePriceUtil {
+        static sum(prices: string[], defaultCurrency?: HubriseCurrencyCode): string;
+        static multiply(price: string, multiplier: number): string;
+        static priceToAmount(price: string): {
+            amount: number;
+            currency: HubriseCurrencyCode;
+        };
+        static amountToPrice(amount: number, currency: HubriseCurrencyCode): string;
+    }
+}
+declare module "api/hubrise/service/HubriseCatalogConverter" {
+    import { HubriseCatalogConverterContract } from "api/hubrise/service/HubriseCatalogConverterContract";
+    import { HubriseMenuCatalogContract } from "api/hubrise/model/menu/HubriseMenuCatalogContract";
+    import { HubriseOrderEditableItemContract } from "api/hubrise/model/order/HubriseOrderEditableItemContract";
+    import { HubriseOrderEditableOptionContract } from "api/hubrise/model/order/HubriseOrderEditableOptionContract";
+    export class HubriseCatalogConverter implements HubriseCatalogConverterContract {
+        editableItems(catalog: HubriseMenuCatalogContract): {
+            withRef: HubriseOrderEditableItemContract[];
+            withName: HubriseOrderEditableItemContract[];
+        };
+        editableItemOptions(catalog: HubriseMenuCatalogContract): {
+            withRef: Record<string, HubriseOrderEditableOptionContract[]>;
+            withName: Record<string, HubriseOrderEditableOptionContract[]>;
+        };
+    }
+}
+declare module "api/hubrise/service/HubriseOrderConverterContract" {
+    import { HubriseOrderEditableItemContract } from "api/hubrise/model/order/HubriseOrderEditableItemContract";
+    import { HubriseOrderItemContract } from "api/hubrise/model/order/HubriseOrderItemContract";
+    import { HubriseServiceType } from "api/hubrise/model/order/HubriseServiceType";
+    export interface HubriseOrderConverterContract {
+        items(editableItems: HubriseOrderEditableItemContract[], serviceType: HubriseServiceType): HubriseOrderItemContract[];
+    }
+}
+declare module "util/ObjectUtil" {
+    export class ObjectUtil {
+        static compact(obj: any, options?: {
+            removeEmptyString?: boolean;
+        }): any;
+        static update(source: Record<string, unknown>, target: Record<string, unknown>): void;
+    }
+}
+declare module "api/hubrise/service/HubriseOrderConverter" {
+    import { HubriseOrderConverterContract } from "api/hubrise/service/HubriseOrderConverterContract";
+    import { HubriseOrderItemContract } from "api/hubrise/model/order/HubriseOrderItemContract";
+    import { HubriseOrderEditableItemContract } from "api/hubrise/model/order/HubriseOrderEditableItemContract";
+    import { HubriseServiceType } from "api/hubrise/model/order/HubriseServiceType";
+    export class HubriseOrderConverter implements HubriseOrderConverterContract {
+        items(editableItems: HubriseOrderEditableItemContract[], serviceType: HubriseServiceType): HubriseOrderItemContract[];
+    }
+}
+declare module "api/hubrise/service/TotalHubriseCalculatorContract" {
+    import { HubriseCurrencyCode } from "api/hubrise/model/common/HubriseCurrencyCode";
+    import { HubriseOrderContract } from "api/hubrise/model/order/HubriseOrderContract";
+    export interface TotalHubriseCalculatorContract {
+        calculateTotals(order: HubriseOrderContract, defaultCurrency: HubriseCurrencyCode): {
+            subtotal: string;
+            minimumOrderFee: string;
+            deliveryFee: string;
+            totalDiscount: string;
+            total: string;
+        };
+    }
+}
+declare module "api/hubrise/service/TotalHubriseCalculator" {
+    import { TotalHubriseCalculatorContract } from "api/hubrise/service/TotalHubriseCalculatorContract";
+    import { HubriseCurrencyCode } from "api/hubrise/model/common/HubriseCurrencyCode";
+    import { HubriseOrderContract } from "api/hubrise/model/order/HubriseOrderContract";
+    export class TotalHubriseCalculator implements TotalHubriseCalculatorContract {
+        calculateTotals(order: HubriseOrderContract, defaultCurrency: HubriseCurrencyCode): {
+            subtotal: string;
+            minimumOrderFee: string;
+            deliveryFee: string;
+            totalDiscount: string;
+            total: string;
+        };
+        private findCurrency;
+    }
+}
+declare module "api/web" {
     export * from "api/hubrise/model/account/HubriseAccountContract";
     export * from "api/hubrise/model/account/HubriseAuthContract";
     export * from "api/hubrise/model/account/HubriseAuthResource";
@@ -1254,7 +1385,22 @@ declare module "api/index" {
     export * from "api/hubrise/model/order/HubriseOrderOptionContract";
     export * from "api/hubrise/model/order/HubriseOrderPaymentContract";
     export * from "api/hubrise/model/order/HubriseOrderStatus";
+    export * from "api/hubrise/model/order/HubriseServiceType";
     export * from "api/hubrise/model/user/HubriseUserContract";
+    export * from "api/hubrise/model/order/HubriseOrderEditableItemContract";
+    export * from "api/hubrise/model/order/HubriseOrderEditableOptionContract";
+    export * from "api/hubrise/service/HubriseCatalogConverter";
+    export * from "api/hubrise/service/HubriseCatalogConverterContract";
+    export * from "api/hubrise/service/HubriseOrderConverter";
+    export * from "api/hubrise/service/HubriseOrderConverterContract";
+    export * from "api/hubrise/service/TotalHubriseCalculator";
+    export * from "api/hubrise/service/TotalHubriseCalculatorContract";
+    export * from "api/hubrise/util/HubrisePriceUtil";
+}
+declare module "api/index" {
+    export * from "api/hubrise/service/HubriseApiContract";
+    export * from "api/hubrise/service/HubriseApi";
+    export * from "api/web";
 }
 declare module "constant/Path" {
     export class Path {
@@ -1434,6 +1580,35 @@ declare module "http/index" {
     export * from "http/ServerContract";
     export * from "http/HandlerController";
 }
+declare module "mockup/ApiMockup" {
+    export class ApiMockup {
+        static isDone(): boolean;
+        static pending(): string;
+        static reset(): void;
+    }
+}
+declare module "mockup/HubriseApiMockup" {
+    import { ApiMockup } from "mockup/ApiMockup";
+    export class HubriseApiMockup extends ApiMockup {
+        static readonly BASE_URL: string;
+        static getUser(times?: number): void;
+        static getLocations(times?: number): void;
+        static createCustomer(times?: number): void;
+        static getCustomer(times?: number): void;
+        static getCustomers(times?: number): void;
+        static getCustomerLists(times?: number): void;
+        static createOrder(times?: number): void;
+        static getOrder(times?: number, generateRandomId?: boolean): void;
+        static setOrderStatus(times?: number): void;
+        static getCatalog(times?: number): void;
+        static getCatalogs(times?: number): void;
+        static createWebhook(times?: number): void;
+    }
+}
+declare module "mockup/index" {
+    export * from "mockup/ApiMockup";
+    export * from "mockup/HubriseApiMockup";
+}
 declare module "service/sender/SmsSenderServiceContract" {
     export interface SmsSenderServiceContract {
         send(senderName: string, message: string, phones: string[], isCommercial?: boolean, sendAt?: string): Promise<void>;
@@ -1927,24 +2102,6 @@ declare module "util/ExtractorUtil" {
         static phone(raw: string, locale: 'fr'): string;
     }
 }
-declare module "util/MathUtil" {
-    export class MathUtil {
-        static sum(values: number[]): number;
-        static avg(values: number[]): number;
-        static applyVariation(value: number, variation: number): number;
-        static median(values: number[]): number;
-        static percentage(part: number, total: number): number;
-        static round(value: number, decimals: number): number;
-        static variation(originalValue: number, newValue: number): number;
-    }
-}
-declare module "util/ObjectUtil" {
-    export class ObjectUtil {
-        static compact(obj: any, options?: {
-            removeEmptyString?: boolean;
-        }): any;
-    }
-}
 declare module "util/PriceUtil" {
     export class PriceUtil {
         private static readonly currencies;
@@ -1975,11 +2132,18 @@ declare module "@onylab/common-api" {
     import * as Constant from "constant/index";
     import * as Exception from "exception/index";
     import * as Http from "http/index";
+    import * as Mockup from "mockup/index";
     import * as Service from "service/index";
     import * as Template from "templating/index";
     import * as Tool from "tool/index";
     import * as Util from "util/index";
-    export { Api, Constant, Exception, Http, Service, Template, Tool, Util };
+    export { Api, Constant, Exception, Http, Mockup, Service, Template, Tool, Util };
+}
+declare module "web" {
+    import * as Api from "api/web";
+    import * as Exception from "exception/index";
+    import * as Util from "util/index";
+    export { Api, Exception, Util };
 }
 declare module "exception/ForbiddenException" {
     import { MainException } from "exception/MainException";