addio-ecomm-sdk 1.3.36 → 1.3.37

package/dist/index.d.ts

@@ -1,202 +1,203 @@
-import Wishlist from './lib/models/wishlist';
-import StockNotification from './lib/models/stockNotification';
-import { SearchResponse } from '@algolia/client-search';
-import IEndpointResult from './utils/interfaces/IEndpointResult';
-import IOrder from 'addio-admin-sdk/dist/Interfaces/Order';
-import ICustomer from 'addio-admin-sdk/dist/Interfaces/Customer';
-import ISpaceData from './utils/interfaces/ISpaceData';
-import IWishlist from 'addio-admin-sdk/dist/Interfaces/Wishlist';
-import IStockNotification from 'addio-admin-sdk/dist/Interfaces/StockNotification';
-import { IIndexedProductAlgolia } from 'addio-admin-sdk/dist/Interfaces/Algolia';
-import IIndexedLastSavedProduct from 'addio-admin-sdk/dist/Interfaces/Indexed/Product/IIndexedLastSavedProduct';
-import IIndexedProduct from 'addio-admin-sdk/dist/Interfaces/Indexed/Product';
-import ICart, { IProductUpsell } from 'addio-admin-sdk/dist/Interfaces/Cart';
-import ISDKConfig from './utils/interfaces/ISDKConfig';
-import ICategory from 'addio-admin-sdk/dist/Interfaces/Category';
-import IInventoryItem from 'addio-admin-sdk/dist/Interfaces/Product/IInventoryItem';
-import IBrand from 'addio-admin-sdk/dist/Interfaces/Brand';
-import IPreMeetingFormEmail from 'addio-admin-sdk/dist/Interfaces/Email/CustomGR/IPreMeetingFormEmail';
-import IWishlistEmail from 'addio-admin-sdk/dist/Interfaces/Email/CustomGR/IWishlistEmail';
-import ISponsorRequestEmail from 'addio-admin-sdk/dist/Interfaces/Email/CustomGR/ISponsorRequestEmail';
-import { ICustomPriceItem } from 'addio-admin-sdk/dist/Interfaces/G2';
-import { IFixedPromoBanner } from 'addio-admin-sdk/dist/Interfaces/Space';
-import IAddress from 'addio-admin-sdk/dist/Interfaces/Address';
-import { ICustomerGroup } from 'addio-admin-sdk/dist/Interfaces/Space';
-export default class SDK {
-    private _api;
-    private _imgPath;
-    private _token;
-    private _url;
-    private _org;
-    private _userToken;
-    private _storeData;
-    private _wishlist;
-    private _stockNotif;
-    constructor();
-    init: (sdk_config: ISDKConfig) => Promise<void>;
-    getAPIInfos: () => {
-        api: string;
-        token: string;
-        userToken: string;
-        org: string;
-    };
-    getSDKOrgInitials: () => string;
-    initWishlist: (wishlist: IWishlist) => Promise<Wishlist | undefined>;
-    initStockNotif: (stockNotif: IStockNotification) => Promise<StockNotification | undefined>;
-    initStoreData: (defaultData?: ISpaceData) => Promise<ISpaceData | undefined>;
-    shouldShowFixedPromoBanner: (fixedPromoBannerData: IFixedPromoBanner) => boolean;
-    private getInventoryItem;
-    private getFullInventory;
-    inventory: {
-        getFullInventory: (locale: string) => Promise<IInventoryItem[] | undefined>;
-        getInventoryItem: (sku: string, locale: string) => Promise<IInventoryItem | undefined>;
-    };
-    setUserToken: (token: string) => void;
-    private loginUserWithFacebook;
-    private anonymousResetPassword;
-    private loginUser;
-    private loginUserWithID;
-    private checkG2ForCustomer;
-    private createProCustomer;
-    private fetchCustomPriceList;
-    private validateAccount;
-    private logout;
-    private registerUser;
-    private getUser;
-    private saveUser;
-    private deleteUser;
-    private getOrders;
-    private killRepCart;
-    private getOrder;
-    private changeProfilePicture;
-    private changePassword;
-    private sendResetPasswordEmail;
-    sendApplicationEmail: (locale: string, form: any) => Promise<any>;
-    sendContactEmail: (locale: string, form: any) => Promise<any>;
-    sendGenericOtherEmail: (locale: string, form: any, templateId: string, to: string, replyTo?: string) => Promise<any>;
-    sendServicePageEmail: (locale: string, form: any, type: string, testEmail?: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | {
-        status: number;
-        error: {
-            fr: string;
-            en: string;
-        };
-    } | undefined>;
-    sendSponsorRequestEmail: (locale: string, form: ISponsorRequestEmail, template_name: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | undefined>;
-    sendPreMeetingFormEmail: (locale: string, form: IPreMeetingFormEmail, proId?: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | undefined>;
-    sendWishlistByEmail: (locale: string, contenu: IWishlistEmail, template_name: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | undefined>;
-    private resetPassword;
-    user: {
-        getUser: (keepTempHash?: boolean) => Promise<ICustomer>;
-        saveUser: (userData: ICustomer) => Promise<boolean>;
-        deleteUser: () => Promise<boolean>;
-        loginUser: (locale: string, email: string, password: string, keepCart?: boolean, isClerk?: boolean) => Promise<{
-            cart: ICart | null;
-            userData: ICustomer;
-        } | string>;
-        loginUserWithID: (locale: string, id: string, password: string, keepCart?: boolean, isClerk?: boolean) => Promise<{
-            cart: ICart;
-            userData: ICustomer;
-        } | string>;
-        loginUserWithFacebook: (fb: any) => Promise<{
-            cart: ICart | null;
-            userData: ICustomer;
-        } | string>;
-        logout: () => void;
-        registerUser: (locale: string, userData: ICustomer, password: string) => Promise<IEndpointResult>;
-        killRepCart: (hashed_cart_id: string) => Promise<boolean | "">;
-        getOrder: (orderID: string, token?: string) => Promise<string | IOrder>;
-        getOrders: (lastID?: string, iteration?: number) => Promise<ICart[] | string>;
-        changePassword: (currentPassword: string, newPassword: string) => Promise<any>;
-        changeProfilePicture: (file?: string) => Promise<any>;
-        validateAccount: (code: string) => Promise<ICustomer>;
-        sendResetPasswordEmail: (locale: string, userEmail: string, forPro?: boolean, withEmail?: boolean, isTest?: boolean) => Promise<any>;
-        resetPassword: (token: string, newPassword: string, withEmail?: boolean) => Promise<any>;
-        sendApplicationEmail: (locale: string, form: any) => Promise<any>;
-        sendContactEmail: (locale: string, form: any) => Promise<any>;
-        sendServiceEmail: (locale: string, form: any, type: string, testEmail?: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | {
-            status: number;
-            error: {
-                fr: string;
-                en: string;
-            };
-        } | undefined>;
-        anonymousResetPassword: (locale: string, id: string, oldPassword: string, newPassword: string, confirmPassword: string) => Promise<IEndpointResult>;
-        checkG2: (id: string, currentCustomer?: ICustomer, customerGroups?: ICustomerGroup[]) => Promise<ICustomer | undefined>;
-        createPro: (customer: ICustomer) => Promise<any>;
-        fetchCustomPriceList: (customerID: string, isPA?: boolean) => Promise<any>;
-    };
-    getImage: (imgName: string, formatQuery?: string, addImgPath?: boolean) => string;
-    private getProducts;
-    private getProduct;
-    private getUpsellOfProducts;
-    private getAttributes;
-    private getCategories;
-    private getBrands;
-    private getInventoryItems;
-    private getOneInventoryItem;
-    getLatestProducts: () => Promise<IIndexedLastSavedProduct[] | undefined>;
-    private _getFees;
-    products: {
-        getProducts: (page?: number, hpp?: number, query?: string, filters?: string, indice?: string, f?: string, useProspr?: boolean) => Promise<SearchResponse<IIndexedProductAlgolia>>;
-        getProduct: (parent_slug: string, locale: string, useProdArray?: IIndexedProduct[], noDrafts?: boolean) => Promise<IIndexedProduct | undefined>;
-        getUpsellOfProducts: (slugs: string[], customPriceList?: ICustomPriceItem[]) => Promise<{
-            upsell: IProductUpsell;
-            prod: IIndexedProduct;
-        }[]>;
-        getAttributes: () => Promise<{
-            slug: string;
-            id?: string | undefined;
-            name: import("addio-admin-sdk/dist/Interfaces/Translation").default[];
-            values: import("addio-admin-sdk/dist/Interfaces/Attribute").IAttributeValue[];
-            description: string;
-            type?: import("addio-admin-sdk/dist/Interfaces/Attribute").AttributeTypeEnum | undefined;
-            is_facet: boolean;
-            is_searchable: boolean;
-            is_multiple: boolean;
-            is_service_related?: boolean | undefined;
-            has_price_rules?: boolean | undefined;
-            draft?: boolean | undefined;
-            prefix?: string | undefined;
-            suffix?: string | undefined;
-            show_in_cart?: boolean | undefined;
-            service_related_name?: string | undefined;
-            service_links_to_attribute?: {
-                readonly value_slugs: {
-                    readonly slug: string;
-                    readonly percent_variation?: number | undefined;
-                }[];
-                readonly service_field: string;
-            }[] | undefined;
-        }[] | undefined>;
-        getCategories: () => Promise<ICategory[] | undefined>;
-        getBrands: () => Promise<IBrand[] | undefined>;
-        getInventoryItems: (parentSlug: string) => Promise<IInventoryItem[] | undefined>;
-        getOneInventoryItem: (sku: string) => Promise<IInventoryItem | undefined>;
-        getLatestProducts: () => Promise<IIndexedLastSavedProduct[] | undefined>;
-        getFees: () => Promise<IIndexedProduct[] | undefined>;
-    };
-    getIfAddressIsInsideZones: (address: IAddress | string) => Promise<string[]>;
-    private _pricingByQuery;
-    private _buyFromForm;
-    private _getSearchServices;
-    services: {
-        pricingByQuery: (query: string) => Promise<any>;
-        buy: {
-            fromForm: (form: any) => Promise<boolean>;
-        };
-        searchServices: () => Promise<any>;
-    };
-    private _getAllCatalogues;
-    private _getCatalogueBySlug;
-    catalogues: {
-        getAll: (locale: string) => Promise<any>;
-        getOne: (slug: string, locale: string) => Promise<any>;
-    };
-    saveCustomerToMailchimpList: (customerEmail: string, listID: string, mergeFields?: {
-        [key: string]: any;
-    } | undefined, tags?: {
-        name: string;
-        status: string;
-    }[]) => Promise<boolean>;
-    getProductListForSitemap: () => Promise<any>;
-}
+import Wishlist from './lib/models/wishlist';
+import StockNotification from './lib/models/stockNotification';
+import { SearchResponse } from '@algolia/client-search';
+import IEndpointResult from './utils/interfaces/IEndpointResult';
+import IOrder from 'addio-admin-sdk/dist/Interfaces/Order';
+import ICustomer from 'addio-admin-sdk/dist/Interfaces/Customer';
+import ISpaceData from './utils/interfaces/ISpaceData';
+import IWishlist from 'addio-admin-sdk/dist/Interfaces/Wishlist';
+import IStockNotification from 'addio-admin-sdk/dist/Interfaces/StockNotification';
+import { IIndexedProductAlgolia } from 'addio-admin-sdk/dist/Interfaces/Algolia';
+import IIndexedLastSavedProduct from 'addio-admin-sdk/dist/Interfaces/Indexed/Product/IIndexedLastSavedProduct';
+import IIndexedProduct from 'addio-admin-sdk/dist/Interfaces/Indexed/Product';
+import ICart, { IProductUpsell } from 'addio-admin-sdk/dist/Interfaces/Cart';
+import ISDKConfig from './utils/interfaces/ISDKConfig';
+import ICategory from 'addio-admin-sdk/dist/Interfaces/Category';
+import IInventoryItem from 'addio-admin-sdk/dist/Interfaces/Product/IInventoryItem';
+import IBrand from 'addio-admin-sdk/dist/Interfaces/Brand';
+import IPreMeetingFormEmail from 'addio-admin-sdk/dist/Interfaces/Email/CustomGR/IPreMeetingFormEmail';
+import IWishlistEmail from 'addio-admin-sdk/dist/Interfaces/Email/CustomGR/IWishlistEmail';
+import ISponsorRequestEmail from 'addio-admin-sdk/dist/Interfaces/Email/CustomGR/ISponsorRequestEmail';
+import { ICustomPriceItem } from 'addio-admin-sdk/dist/Interfaces/G2';
+import { IFixedPromoBanner } from 'addio-admin-sdk/dist/Interfaces/Space';
+import IAddress from 'addio-admin-sdk/dist/Interfaces/Address';
+import { ICustomerGroup } from 'addio-admin-sdk/dist/Interfaces/Space';
+import { LogType } from 'addio-admin-sdk/dist/services/logs';
+export default class SDK {
+    private _api;
+    private _imgPath;
+    private _token;
+    private _url;
+    private _org;
+    private _userToken;
+    private _storeData;
+    private _wishlist;
+    private _stockNotif;
+    constructor();
+    init: (sdk_config: ISDKConfig) => Promise<void>;
+    getAPIInfos: () => {
+        api: string;
+        token: string;
+        userToken: string;
+        org: string;
+    };
+    getSDKOrgInitials: () => string;
+    initWishlist: (wishlist: IWishlist) => Promise<Wishlist | undefined>;
+    initStockNotif: (stockNotif: IStockNotification) => Promise<StockNotification | undefined>;
+    initStoreData: (defaultData?: ISpaceData) => Promise<ISpaceData | undefined>;
+    shouldShowFixedPromoBanner: (fixedPromoBannerData: IFixedPromoBanner) => boolean;
+    private getInventoryItem;
+    private getFullInventory;
+    inventory: {
+        getFullInventory: (locale: string) => Promise<IInventoryItem[] | undefined>;
+        getInventoryItem: (sku: string, locale: string) => Promise<IInventoryItem | undefined>;
+    };
+    setUserToken: (token: string) => void;
+    private loginUserWithFacebook;
+    private anonymousResetPassword;
+    private loginUser;
+    private loginUserWithID;
+    private checkG2ForCustomer;
+    private createProCustomer;
+    private fetchCustomPriceList;
+    private validateAccount;
+    private logout;
+    private registerUser;
+    private getUser;
+    private saveUser;
+    private deleteUser;
+    private getOrders;
+    private killRepCart;
+    private getOrder;
+    private changeProfilePicture;
+    private changePassword;
+    private sendResetPasswordEmail;
+    sendApplicationEmail: (locale: string, form: any) => Promise<any>;
+    sendContactEmail: (locale: string, form: any) => Promise<any>;
+    sendGenericOtherEmail: (locale: string, form: any, templateId: string, to: string, replyTo?: string) => Promise<any>;
+    sendServicePageEmail: (locale: string, form: any, type: string, testEmail?: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | {
+        status: number;
+        error: {
+            fr: string;
+            en: string;
+        };
+    } | undefined>;
+    sendSponsorRequestEmail: (locale: string, form: ISponsorRequestEmail, template_name: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | undefined>;
+    sendPreMeetingFormEmail: (locale: string, form: IPreMeetingFormEmail, proId?: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | undefined>;
+    sendWishlistByEmail: (locale: string, contenu: IWishlistEmail, template_name: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | undefined>;
+    private resetPassword;
+    user: {
+        getUser: (keepTempHash?: boolean) => Promise<ICustomer>;
+        saveUser: (userData: ICustomer) => Promise<boolean>;
+        deleteUser: () => Promise<boolean>;
+        loginUser: (locale: string, email: string, password: string, keepCart?: boolean, isClerk?: boolean) => Promise<{
+            cart: ICart | null;
+            userData: ICustomer;
+        } | string>;
+        loginUserWithID: (locale: string, id: string, password: string, keepCart?: boolean, isClerk?: boolean) => Promise<{
+            cart: ICart;
+            userData: ICustomer;
+        } | string>;
+        loginUserWithFacebook: (fb: any) => Promise<{
+            cart: ICart | null;
+            userData: ICustomer;
+        } | string>;
+        logout: () => void;
+        registerUser: (locale: string, userData: ICustomer, password: string) => Promise<IEndpointResult>;
+        killRepCart: (hashed_cart_id: string) => Promise<boolean | "">;
+        getOrder: (orderID: string, token?: string) => Promise<string | IOrder>;
+        getOrders: (lastID?: string, iteration?: number) => Promise<ICart[] | string>;
+        changePassword: (currentPassword: string, newPassword: string) => Promise<any>;
+        changeProfilePicture: (file?: string) => Promise<any>;
+        validateAccount: (code: string) => Promise<ICustomer>;
+        sendResetPasswordEmail: (locale: string, userEmail: string, forPro?: boolean, withEmail?: boolean, isTest?: boolean) => Promise<any>;
+        resetPassword: (token: string, newPassword: string, withEmail?: boolean) => Promise<any>;
+        sendApplicationEmail: (locale: string, form: any) => Promise<any>;
+        sendContactEmail: (locale: string, form: any) => Promise<any>;
+        sendServiceEmail: (locale: string, form: any, type: string, testEmail?: string) => Promise<string | true | import("addio-admin-sdk/dist/utils/string").default | {
+            status: number;
+            error: {
+                fr: string;
+                en: string;
+            };
+        } | undefined>;
+        anonymousResetPassword: (locale: string, id: string, oldPassword: string, newPassword: string, confirmPassword: string) => Promise<IEndpointResult>;
+        checkG2: (id: string, currentCustomer?: ICustomer, customerGroups?: ICustomerGroup[]) => Promise<ICustomer | undefined>;
+        createPro: (customer: ICustomer) => Promise<any>;
+        fetchCustomPriceList: (customerID: string, isPA?: boolean) => Promise<any>;
+    };
+    getImage: (imgName: string, formatQuery?: string, addImgPath?: boolean) => string;
+    private getProducts;
+    private getProduct;
+    private getUpsellOfProducts;
+    private getAttributes;
+    private getCategories;
+    private getBrands;
+    private getInventoryItems;
+    private getOneInventoryItem;
+    getLatestProducts: () => Promise<IIndexedLastSavedProduct[] | undefined>;
+    private _getFees;
+    products: {
+        getProducts: (page?: number, hpp?: number, query?: string, filters?: string, indice?: string, f?: string, useProspr?: boolean) => Promise<SearchResponse<IIndexedProductAlgolia>>;
+        getProduct: (parent_slug: string, locale: string, useProdArray?: IIndexedProduct[], noDrafts?: boolean) => Promise<IIndexedProduct | undefined>;
+        getUpsellOfProducts: (slugs: string[], customPriceList?: ICustomPriceItem[]) => Promise<{
+            upsell: IProductUpsell;
+            prod: IIndexedProduct;
+        }[]>;
+        getAttributes: () => Promise<{
+            slug: string;
+            id?: string | undefined;
+            name: import("addio-admin-sdk/dist/Interfaces/Translation").default[];
+            values: import("addio-admin-sdk/dist/Interfaces/Attribute").IAttributeValue[];
+            description: string;
+            type?: import("addio-admin-sdk/dist/Interfaces/Attribute").AttributeTypeEnum | undefined;
+            is_facet: boolean;
+            is_searchable: boolean;
+            is_multiple: boolean;
+            is_service_related?: boolean | undefined;
+            has_price_rules?: boolean | undefined;
+            draft?: boolean | undefined;
+            prefix?: string | undefined;
+            suffix?: string | undefined;
+            show_in_cart?: boolean | undefined;
+            service_related_name?: string | undefined;
+            service_links_to_attribute?: {
+                readonly value_slugs: {
+                    readonly slug: string;
+                    readonly percent_variation?: number | undefined;
+                }[];
+                readonly service_field: string;
+            }[] | undefined;
+        }[] | undefined>;
+        getCategories: () => Promise<ICategory[] | undefined>;
+        getBrands: () => Promise<IBrand[] | undefined>;
+        getInventoryItems: (parentSlug: string) => Promise<IInventoryItem[] | undefined>;
+        getOneInventoryItem: (sku: string) => Promise<IInventoryItem | undefined>;
+        getLatestProducts: () => Promise<IIndexedLastSavedProduct[] | undefined>;
+        getFees: () => Promise<IIndexedProduct[] | undefined>;
+    };
+    getIfAddressIsInsideZones: (address: IAddress | string, customLogCallback?: ((message: string, type?: LogType, logLocalToo?: boolean) => Promise<void>) | undefined) => Promise<string[]>;
+    private _pricingByQuery;
+    private _buyFromForm;
+    private _getSearchServices;
+    services: {
+        pricingByQuery: (query: string) => Promise<any>;
+        buy: {
+            fromForm: (form: any) => Promise<boolean>;
+        };
+        searchServices: () => Promise<any>;
+    };
+    private _getAllCatalogues;
+    private _getCatalogueBySlug;
+    catalogues: {
+        getAll: (locale: string) => Promise<any>;
+        getOne: (slug: string, locale: string) => Promise<any>;
+    };
+    saveCustomerToMailchimpList: (customerEmail: string, listID: string, mergeFields?: {
+        [key: string]: any;
+    } | undefined, tags?: {
+        name: string;
+        status: string;
+    }[]) => Promise<boolean>;
+    getProductListForSitemap: () => Promise<any>;
+}