addio-admin-sdk 1.6.5

package/dist/utils/cart.d.ts

@@ -0,0 +1,505 @@
+import Space from '../lib/Space';
+import ICart, { CartCustomerEnum, ICartItem, PaymentTypeEnum } from '../Interfaces/Cart';
+import { ICustomPriceItem } from '../Interfaces/G2';
+import IInventoryItem from '../Interfaces/Product/IInventoryItem';
+import ILang from './string';
+import ISpace from '../Interfaces/Space';
+import IAddress from '../Interfaces/Address';
+import ICustomer from '../Interfaces/Customer';
+export declare const updateCartItems: (currentCart: ICart, items: {
+    sku: string;
+    qte: number;
+    qte_override?: boolean;
+}[], fetchInventory: (sku: string) => Promise<IInventoryItem | undefined>, shouldCheckInventory?: boolean, handleInventoryError?: ((shouldSave?: boolean) => Promise<void>) | undefined) => Promise<{
+    updatedCart: {
+        id?: string | undefined;
+        cart_type: import("../Interfaces/Cart").CartTypeEnum;
+        current_store_id?: string | null | undefined;
+        customer_id?: string | undefined;
+        user_email?: string | undefined;
+        customer_info?: {
+            readonly customer_type?: string | undefined;
+            readonly pro_title?: string | undefined;
+            readonly pro_proof_doc?: string | undefined;
+            readonly customer_default_email?: string | undefined;
+            readonly customer_external_code?: string | undefined;
+            readonly customer_external_group?: string | undefined;
+            readonly terms_code?: string | undefined;
+            readonly previous_terms_code?: string | undefined;
+            readonly company_name?: string | undefined;
+        } | undefined;
+        discount_rules: import("../Interfaces/Rules/IDiscountRule").default[];
+        error?: string | undefined;
+        errors?: import("../Interfaces/Cart").CartErrorEnum[] | undefined;
+        message?: string | undefined;
+        items: ICartItem[];
+        subtotalWithoutPromotions?: number | null | undefined;
+        subtotal: number;
+        shipping: number;
+        shipping_selected?: import("../Interfaces/Cart").IShippingQuote | undefined;
+        shipping_message: string;
+        free_shipping?: boolean | undefined;
+        taxes: import("../Interfaces/Tax").default[];
+        promo_after_taxes_amount?: number | null | undefined;
+        total: number;
+        clerk_id?: string | undefined;
+        total_taxes?: number | undefined;
+        cart_promo_applied?: import("../Interfaces/Cart").ICartPromoApplied | null | undefined;
+        cart_promos_applied?: import("../Interfaces/Cart").ICartPromoApplied[] | null | undefined;
+        billing_address?: import("../Interfaces/Customer").IExpeditionInfo | undefined;
+        shipping_address?: import("../Interfaces/Customer").IExpeditionInfo | undefined;
+        is_pickup?: boolean | undefined;
+        is_booking?: string | false | undefined;
+        is_booking_beton?: boolean | undefined;
+        status: import("../Interfaces/Cart").CartStatusEnum;
+        paid_by?: PaymentTypeEnum | null | undefined;
+        custom_payment_type?: {
+            method: import("../Interfaces/Cart").CustomPaymentTypeEnum;
+            amount?: number | undefined;
+        } | null | undefined;
+        payment_details?: import("../Interfaces/Payment").default[] | undefined;
+        paid_at?: Date | undefined;
+        payment_reference?: string | undefined;
+        invoice_access_token?: string | undefined;
+        paypal_secure_token?: string | undefined;
+        boxes: import("../Interfaces/Cart").IBoxItem[];
+        shipping_payload?: any;
+        stripe_payload?: import("../Interfaces/Cart/IStripePayload").default | undefined;
+        pandapay_payload?: import("../Interfaces/Cart/IPandaPayload").default | undefined;
+        paysafe_payload?: import("../Interfaces/Cart/IPaysafePayload").IPaysafePayload | undefined;
+        paypal_payload?: import("../Interfaces/Cart/IPaypalPayload").default | undefined;
+        refund_payload?: any;
+        ref?: string | undefined;
+        invoice_ref?: string | undefined;
+        currency?: string | undefined;
+        locale: string;
+        comfirmation_email_sent?: Date | undefined;
+        receip_sent?: Date | undefined;
+        shipping_comfirmation_sent?: Date | undefined;
+        pickup_ready_sent?: Date | undefined;
+        is_test?: boolean | undefined;
+        no_email_receipt?: boolean | undefined;
+        check_marketing_emails?: boolean | undefined;
+        check_sms_to_send?: boolean | undefined;
+        check_retarget_marketing_emails?: boolean | undefined;
+        other_emails_sent?: {
+            readonly photo_shoot_admin_email?: Date | undefined;
+            readonly photo_shoot_client_email?: Date | undefined;
+            readonly sms_survey_sent?: Date | undefined;
+            readonly retarget_marketing_email?: Date | undefined;
+            readonly billing_invoice_email?: Date | undefined;
+        } | undefined;
+        is?: string[] | undefined;
+        assigned_to?: import("../Interfaces/Cart").ICartAssignedUser[] | undefined;
+        created_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+        processed_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+        from_marketplace?: import("../Interfaces/MarketplacePublication").MarketplaceTypeEnum | undefined;
+        marketplace_data?: import("../Interfaces/MarketplacePublication/MarketplaceOrderData").default | undefined;
+        promise_to_purchase?: import("../Interfaces/Cart").ICartPromiseToPurchase | null | undefined;
+        cart_content_type?: import("../Interfaces/Cart").CartContentTypeEnum | undefined;
+        updated_by?: import("../Interfaces/Cart").ICartAssignedUser[] | undefined;
+        canceled_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+        updates?: any[] | undefined;
+        last_update?: Date | undefined;
+        last_update_by?: string | undefined;
+        created?: Date | undefined;
+        created_by_email?: string | undefined;
+    };
+    updatedItems: {
+        sku: string;
+        updated: boolean;
+        error?: ILang | undefined;
+    }[];
+}>;
+export declare const deleteCartItem: (currentCart: ICart, sku: string[], onlyIfUpsellOf?: string) => {
+    id?: string | undefined;
+    cart_type: import("../Interfaces/Cart").CartTypeEnum;
+    current_store_id?: string | null | undefined;
+    customer_id?: string | undefined;
+    user_email?: string | undefined;
+    customer_info?: {
+        readonly customer_type?: string | undefined;
+        readonly pro_title?: string | undefined;
+        readonly pro_proof_doc?: string | undefined;
+        readonly customer_default_email?: string | undefined;
+        readonly customer_external_code?: string | undefined;
+        readonly customer_external_group?: string | undefined;
+        readonly terms_code?: string | undefined;
+        readonly previous_terms_code?: string | undefined;
+        readonly company_name?: string | undefined;
+    } | undefined;
+    discount_rules: import("../Interfaces/Rules/IDiscountRule").default[];
+    error?: string | undefined;
+    errors?: import("../Interfaces/Cart").CartErrorEnum[] | undefined;
+    message?: string | undefined;
+    items: ICartItem[];
+    subtotalWithoutPromotions?: number | null | undefined;
+    subtotal: number;
+    shipping: number;
+    shipping_selected?: import("../Interfaces/Cart").IShippingQuote | undefined;
+    shipping_message: string;
+    free_shipping?: boolean | undefined;
+    taxes: import("../Interfaces/Tax").default[];
+    promo_after_taxes_amount?: number | null | undefined;
+    total: number;
+    clerk_id?: string | undefined;
+    total_taxes?: number | undefined;
+    cart_promo_applied?: import("../Interfaces/Cart").ICartPromoApplied | null | undefined;
+    cart_promos_applied?: import("../Interfaces/Cart").ICartPromoApplied[] | null | undefined;
+    billing_address?: import("../Interfaces/Customer").IExpeditionInfo | undefined;
+    shipping_address?: import("../Interfaces/Customer").IExpeditionInfo | undefined;
+    is_pickup?: boolean | undefined;
+    is_booking?: string | false | undefined;
+    is_booking_beton?: boolean | undefined;
+    status: import("../Interfaces/Cart").CartStatusEnum;
+    paid_by?: PaymentTypeEnum | null | undefined;
+    custom_payment_type?: {
+        method: import("../Interfaces/Cart").CustomPaymentTypeEnum;
+        amount?: number | undefined;
+    } | null | undefined;
+    payment_details?: import("../Interfaces/Payment").default[] | undefined;
+    paid_at?: Date | undefined;
+    payment_reference?: string | undefined;
+    invoice_access_token?: string | undefined;
+    paypal_secure_token?: string | undefined;
+    boxes: import("../Interfaces/Cart").IBoxItem[];
+    shipping_payload?: any;
+    stripe_payload?: import("../Interfaces/Cart/IStripePayload").default | undefined;
+    pandapay_payload?: import("../Interfaces/Cart/IPandaPayload").default | undefined;
+    paysafe_payload?: import("../Interfaces/Cart/IPaysafePayload").IPaysafePayload | undefined;
+    paypal_payload?: import("../Interfaces/Cart/IPaypalPayload").default | undefined;
+    refund_payload?: any;
+    ref?: string | undefined;
+    invoice_ref?: string | undefined;
+    currency?: string | undefined;
+    locale: string;
+    comfirmation_email_sent?: Date | undefined;
+    receip_sent?: Date | undefined;
+    shipping_comfirmation_sent?: Date | undefined;
+    pickup_ready_sent?: Date | undefined;
+    is_test?: boolean | undefined;
+    no_email_receipt?: boolean | undefined;
+    check_marketing_emails?: boolean | undefined;
+    check_sms_to_send?: boolean | undefined;
+    check_retarget_marketing_emails?: boolean | undefined;
+    other_emails_sent?: {
+        readonly photo_shoot_admin_email?: Date | undefined;
+        readonly photo_shoot_client_email?: Date | undefined;
+        readonly sms_survey_sent?: Date | undefined;
+        readonly retarget_marketing_email?: Date | undefined;
+        readonly billing_invoice_email?: Date | undefined;
+    } | undefined;
+    is?: string[] | undefined;
+    assigned_to?: import("../Interfaces/Cart").ICartAssignedUser[] | undefined;
+    created_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+    processed_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+    from_marketplace?: import("../Interfaces/MarketplacePublication").MarketplaceTypeEnum | undefined;
+    marketplace_data?: import("../Interfaces/MarketplacePublication/MarketplaceOrderData").default | undefined;
+    promise_to_purchase?: import("../Interfaces/Cart").ICartPromiseToPurchase | null | undefined;
+    cart_content_type?: import("../Interfaces/Cart").CartContentTypeEnum | undefined;
+    updated_by?: import("../Interfaces/Cart").ICartAssignedUser[] | undefined;
+    canceled_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+    updates?: any[] | undefined;
+    last_update?: Date | undefined;
+    last_update_by?: string | undefined;
+    created?: Date | undefined;
+    created_by_email?: string | undefined;
+};
+export declare const priceWasOverridden: (itemToCheck: ICartItem) => boolean;
+export declare const getActualPromoPrice: (item: ICartItem, output: '%' | '$') => number;
+export declare const getActualDiscountPrice: (item: ICartItem, output: '%' | '$') => number;
+export declare const addCartItems: (currentCart: ICart, newItems: ICartItem[], fetchInventory: (sku: string) => Promise<IInventoryItem | undefined>, shouldCheckInventory: boolean | undefined, handleInventoryError: ((shouldSave?: boolean) => Promise<void>) | undefined, defaultAdd?: boolean, isServiceUpsellOfSku?: boolean, customPriceList?: ICustomPriceItem[]) => Promise<{
+    cartData: {
+        id?: string | undefined;
+        cart_type: import("../Interfaces/Cart").CartTypeEnum;
+        current_store_id?: string | null | undefined;
+        customer_id?: string | undefined;
+        user_email?: string | undefined;
+        customer_info?: {
+            readonly customer_type?: string | undefined;
+            readonly pro_title?: string | undefined;
+            readonly pro_proof_doc?: string | undefined;
+            readonly customer_default_email?: string | undefined;
+            readonly customer_external_code?: string | undefined;
+            readonly customer_external_group?: string | undefined;
+            readonly terms_code?: string | undefined;
+            readonly previous_terms_code?: string | undefined;
+            readonly company_name?: string | undefined;
+        } | undefined;
+        discount_rules: import("../Interfaces/Rules/IDiscountRule").default[];
+        error?: string | undefined;
+        errors?: import("../Interfaces/Cart").CartErrorEnum[] | undefined;
+        message?: string | undefined;
+        items: ICartItem[];
+        subtotalWithoutPromotions?: number | null | undefined;
+        subtotal: number;
+        shipping: number;
+        shipping_selected?: import("../Interfaces/Cart").IShippingQuote | undefined;
+        shipping_message: string;
+        free_shipping?: boolean | undefined;
+        taxes: import("../Interfaces/Tax").default[];
+        promo_after_taxes_amount?: number | null | undefined;
+        total: number;
+        clerk_id?: string | undefined;
+        total_taxes?: number | undefined;
+        cart_promo_applied?: import("../Interfaces/Cart").ICartPromoApplied | null | undefined;
+        cart_promos_applied?: import("../Interfaces/Cart").ICartPromoApplied[] | null | undefined;
+        billing_address?: import("../Interfaces/Customer").IExpeditionInfo | undefined;
+        shipping_address?: import("../Interfaces/Customer").IExpeditionInfo | undefined;
+        is_pickup?: boolean | undefined;
+        is_booking?: string | false | undefined;
+        is_booking_beton?: boolean | undefined;
+        status: import("../Interfaces/Cart").CartStatusEnum;
+        paid_by?: PaymentTypeEnum | null | undefined;
+        custom_payment_type?: {
+            method: import("../Interfaces/Cart").CustomPaymentTypeEnum;
+            amount?: number | undefined;
+        } | null | undefined;
+        payment_details?: import("../Interfaces/Payment").default[] | undefined;
+        paid_at?: Date | undefined;
+        payment_reference?: string | undefined;
+        invoice_access_token?: string | undefined;
+        paypal_secure_token?: string | undefined;
+        boxes: import("../Interfaces/Cart").IBoxItem[];
+        shipping_payload?: any;
+        stripe_payload?: import("../Interfaces/Cart/IStripePayload").default | undefined;
+        pandapay_payload?: import("../Interfaces/Cart/IPandaPayload").default | undefined;
+        paysafe_payload?: import("../Interfaces/Cart/IPaysafePayload").IPaysafePayload | undefined;
+        paypal_payload?: import("../Interfaces/Cart/IPaypalPayload").default | undefined;
+        refund_payload?: any;
+        ref?: string | undefined;
+        invoice_ref?: string | undefined;
+        currency?: string | undefined;
+        locale: string;
+        comfirmation_email_sent?: Date | undefined;
+        receip_sent?: Date | undefined;
+        shipping_comfirmation_sent?: Date | undefined;
+        pickup_ready_sent?: Date | undefined;
+        is_test?: boolean | undefined;
+        no_email_receipt?: boolean | undefined;
+        check_marketing_emails?: boolean | undefined;
+        check_sms_to_send?: boolean | undefined;
+        check_retarget_marketing_emails?: boolean | undefined;
+        other_emails_sent?: {
+            readonly photo_shoot_admin_email?: Date | undefined;
+            readonly photo_shoot_client_email?: Date | undefined;
+            readonly sms_survey_sent?: Date | undefined;
+            readonly retarget_marketing_email?: Date | undefined;
+            readonly billing_invoice_email?: Date | undefined;
+        } | undefined;
+        is?: string[] | undefined;
+        assigned_to?: import("../Interfaces/Cart").ICartAssignedUser[] | undefined;
+        created_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+        processed_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+        from_marketplace?: import("../Interfaces/MarketplacePublication").MarketplaceTypeEnum | undefined;
+        marketplace_data?: import("../Interfaces/MarketplacePublication/MarketplaceOrderData").default | undefined;
+        promise_to_purchase?: import("../Interfaces/Cart").ICartPromiseToPurchase | null | undefined;
+        cart_content_type?: import("../Interfaces/Cart").CartContentTypeEnum | undefined;
+        updated_by?: import("../Interfaces/Cart").ICartAssignedUser[] | undefined;
+        canceled_by?: import("../Interfaces/Cart").ICartAssignedUser | undefined;
+        updates?: any[] | undefined;
+        last_update?: Date | undefined;
+        last_update_by?: string | undefined;
+        created?: Date | undefined;
+        created_by_email?: string | undefined;
+    };
+    added: boolean;
+    updated: boolean;
+    maxQtyItems: boolean;
+}>;
+export declare const getCurrentProvince: (provinceToCheck: string) => {
+    value: string;
+    label: string;
+    label_en: string;
+} | undefined;
+export declare const getIndexedCartData: (cartData: ICart, space: Space, setPaidAtIfUndefined?: boolean, customer?: ICustomer, createdAt?: Date, updatedAt?: Date) => {
+    project_number: any;
+    assigned_to: null;
+    order_type: string;
+    store: {
+        id: any;
+        name: any;
+    };
+    subtotal: number;
+    total: number;
+    is_pickup: boolean;
+    out_of_zone: boolean;
+    is_booking: boolean;
+    is_promise_to_purchase: boolean;
+    items: {
+        [key: string]: {
+            qty: number;
+            refunded_qty: number;
+            refunded: boolean;
+        };
+    };
+    billing_phone: string | null;
+    shipping_phone: string | null;
+    customer_id: string | boolean;
+    customer_name: string | null;
+    customer_email: string | null;
+    customer_company_name: any;
+    is_detail_customer: boolean;
+    customer_type: CartCustomerEnum;
+    customer_rep: string | null | undefined;
+    keywords: string[];
+    cart_slug_list: string[];
+    from_marketplace: import("../Interfaces/MarketplacePublication").MarketplaceTypeEnum | null;
+    paid_by?: PaymentTypeEnum | null | undefined;
+    multiple_payments?: boolean | null | undefined;
+    paid_at: number | null;
+    objectID: string | undefined;
+    cart_type: import("../Interfaces/Cart").CartTypeEnum;
+    cart_promos_applied: import("../Interfaces/Cart").ICartPromoApplied[] | null;
+    status: import("../Interfaces/Cart").CartStatusEnum;
+    ref: string | undefined;
+    invoice_ref: string | null;
+    created_at: number | null;
+    updated_at: number | null;
+    processed_at: number | null;
+} | {
+    project_number: any;
+    assigned_to: string;
+    order_type: string;
+    store: {
+        id: any;
+        name: any;
+    };
+    subtotal: number;
+    total: number;
+    is_pickup: boolean;
+    out_of_zone: boolean;
+    is_booking: boolean;
+    is_promise_to_purchase: boolean;
+    items: {
+        [key: string]: {
+            qty: number;
+            refunded_qty: number;
+            refunded: boolean;
+        };
+    };
+    billing_phone: string | null;
+    shipping_phone: string | null;
+    customer_id: string | boolean;
+    customer_name: string | null;
+    customer_email: string | null;
+    customer_company_name: any;
+    is_detail_customer: boolean;
+    customer_type: CartCustomerEnum;
+    customer_rep: string | null | undefined;
+    keywords: string[];
+    cart_slug_list: string[];
+    from_marketplace: import("../Interfaces/MarketplacePublication").MarketplaceTypeEnum | null;
+    paid_by?: PaymentTypeEnum | null | undefined;
+    multiple_payments?: boolean | null | undefined;
+    paid_at: number | null;
+    objectID: string | undefined;
+    cart_type: import("../Interfaces/Cart").CartTypeEnum;
+    cart_promos_applied: import("../Interfaces/Cart").ICartPromoApplied[] | null;
+    status: import("../Interfaces/Cart").CartStatusEnum;
+    ref: string | undefined;
+    invoice_ref: string | null;
+    created_at: number | null;
+    updated_at: number | null;
+    processed_at: number | null;
+} | {
+    store: {
+        id: any;
+        name: any;
+    };
+    subtotal: number;
+    total: number;
+    is_pickup: boolean;
+    out_of_zone: boolean;
+    is_booking: boolean;
+    is_promise_to_purchase: boolean;
+    items: {
+        [key: string]: {
+            qty: number;
+            refunded_qty: number;
+            refunded: boolean;
+        };
+    };
+    billing_phone: string | null;
+    shipping_phone: string | null;
+    customer_id: string | boolean;
+    customer_name: string | null;
+    customer_email: string | null;
+    customer_company_name: any;
+    is_detail_customer: boolean;
+    customer_type: CartCustomerEnum;
+    customer_rep: string | null | undefined;
+    keywords: string[];
+    cart_slug_list: string[];
+    from_marketplace: import("../Interfaces/MarketplacePublication").MarketplaceTypeEnum | null;
+    paid_by?: PaymentTypeEnum | null | undefined;
+    multiple_payments?: boolean | null | undefined;
+    paid_at: number | null;
+    objectID: string | undefined;
+    cart_type: import("../Interfaces/Cart").CartTypeEnum;
+    cart_promos_applied: import("../Interfaces/Cart").ICartPromoApplied[] | null;
+    status: import("../Interfaces/Cart").CartStatusEnum;
+    ref: string | undefined;
+    invoice_ref: string | null;
+    created_at: number | null;
+    updated_at: number | null;
+    processed_at: number | null;
+} | {
+    subtotal: number;
+    total: number;
+    is_pickup: boolean;
+    out_of_zone: boolean;
+    is_booking: boolean;
+    is_promise_to_purchase: boolean;
+    items: {
+        [key: string]: {
+            qty: number;
+            refunded_qty: number;
+            refunded: boolean;
+        };
+    };
+    billing_phone: string | null;
+    shipping_phone: string | null;
+    customer_id: string | boolean;
+    customer_name: string | null;
+    customer_email: string | null;
+    customer_company_name: any;
+    is_detail_customer: boolean;
+    customer_type: CartCustomerEnum;
+    customer_rep: string | null | undefined;
+    keywords: string[];
+    cart_slug_list: string[];
+    from_marketplace: import("../Interfaces/MarketplacePublication").MarketplaceTypeEnum | null;
+    paid_by?: PaymentTypeEnum | null | undefined;
+    multiple_payments?: boolean | null | undefined;
+    paid_at: number | null;
+    objectID: string | undefined;
+    cart_type: import("../Interfaces/Cart").CartTypeEnum;
+    cart_promos_applied: import("../Interfaces/Cart").ICartPromoApplied[] | null;
+    status: import("../Interfaces/Cart").CartStatusEnum;
+    ref: string | undefined;
+    invoice_ref: string | null;
+    created_at: number | null;
+    updated_at: number | null;
+    processed_at: number | null;
+};
+export declare const getPaidByForIndexedCart: (order: ICart) => {
+    paid_by?: PaymentTypeEnum | null;
+    multiple_payments?: boolean | null;
+};
+export declare const getAssignedToInfo: (order: ICart) => {
+    assigned_to: null;
+} | {
+    assigned_to: string;
+};
+export declare const getShippingStoreInfo: (order: ICart, space: Space) => {
+    store: {
+        id: any;
+        name: any;
+    };
+};
+export declare const getOrderStoreInfo: (spaceData: ISpace, storeAddress: IAddress) => {
+    id: string | undefined;
+    name: string;
+};
+export declare const getModifiedItems: (newItems: ICartItem[], oldItems: ICartItem[]) => ICartItem[];