@infigo-official/types-for-megascript/v1/RunObject/Cart.d.ts

Type definitions for Megascript Scripting

/**
 * Represents operations for managing shopping carts.
 */
interface CartManagement {
    /**
     * Adds an item to the shopping basket.
     * @param sci The object instance representing the item to add.
     * @returns The base model containing the added shopping cart item object.
     */
    AddItemToBasket: (sci: AddToBasketObjectInstance) => MsBaseModel<ShoppingCartItemObject>;

    /**
     * Updates a shopping cart item.
     * @param sci The shopping cart item object to update.
     * @returns The model representing the result of the update operation.
     */
    UpdateShoppingCartItem: (sci: ShoppingCartItemObject) => MsModel;

    /**
     * Clears the shopping cart.
     * @param customer The ID of the customer or the customer object.
     * @param shoppingCartType Optional. The type of shopping cart to clear.
     * @returns A boolean indicating whether the cart was successfully cleared.
     */
    ClearCart: (customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => boolean;

    /**
     * Deletes an item from the shopping basket.
     * @param sci The ID of the item or the object instance representing the item.
     * @returns A boolean indicating whether the item was successfully deleted.
     */
    DeleteItemFromBasket: (sci: number | AddToBasketObjectInstance) => boolean;

    /**
     * Retrieves the count of items in the shopping cart.
     * @param customer The ID of the customer or the customer object.
     * @param shoppingCartType Optional. The type of shopping cart to retrieve item count for.
     * @returns An object containing the count of items in the shopping cart.
     */
    GetCartItemCount: (customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => ShoppingCartItemCount;

    /**
     * Retrieves items from the shopping basket.
     * @param customer The ID of the customer or the customer object.
     * @param shoppingCartType Optional. The type of shopping cart to retrieve items from.
     * @returns An array of shopping cart item objects.
     */
    GetItemsFromBasket: (customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => ShoppingCartItemObject[];
}

/**
 * The cart management object provides operations for managing shopping carts.
 */

declare const CartManagement: CartManagement;

/**
 * Represents an item in the shopping cart.
 */
interface ShoppingCartItemObject {
    /** The ID of the shopping cart item. */
    readonly Id: number;

    /** The ID of the customer who owns the shopping cart item. */
    readonly CustomerId: number;

    /** The ID of the product associated with the shopping cart item. */
    readonly ProductId: number;

    /** The quantity of the product in the shopping cart item. */
    Quantity: number;

    /** An array of delivery types associated with the shopping cart item. */
    DeliveryType: string[];

    /** The group object associated with the shopping cart item. */
    Group: GroupObject;

    /** Additional attributes associated with the shopping cart item. */
    Attributes: { [key: string]: string };

    /** Extra data associated with the shopping cart item. */
    ExtraData: { [key: string]: string };

    /** The type of shopping cart item. */
    Type: MsShoppingCartItemType;

    /** The linked job object associated with the shopping cart item. */
    LinkedJob: LinkedJobObject;

    /** The quote ID associated with the shopping cart item. */
    QuoteId: number;

    /**
     * Sets additional data for the shopping cart item.
     * @param key The key of the data to set.
     * @param value The value of the data to set.
     */
    SetExtraData: (key: string, value: string) => void;
}

/**
 * Represents a shopping cart item object.
 */

declare const ShoppingCartItemObject: ShoppingCartItemObject;

/**
 * Represents the count of items in a shopping cart.
 */
interface ShoppingCartItemCount {
    /** The total count of items in the shopping cart. */
    ItemsCount: number;

    /** An alternative count of items in the shopping cart. */
    Count: number;
}

/**
 * Represents a linked job object associated with a shopping cart item.
 */
interface LinkedJobObject {
    /** The unique identifier of the linked job. */
    Id: number;

    /** The type of product associated with the linked job. */
    Type: ProductType;
}


/**
 * Represents a group object with its properties.
 */
interface GroupObject {
    /** The unique identifier of the group. */
    Id: number;

    /** The name of the group. */
    Name: string;
}

/**
 * Interface representing an item to be added to the basket.
 */
interface AddToBasketObjectInstance {
    /**
     * The customer associated with the basket item.
     * Can be a customer ID or a Customer object.
     */
    Customer: number | Customer;

    /**
     * The product to add to the basket.
     * Can be a product ID or a Product object.
     */
    Product: number | Product;

    /**
     * The quantity of the product to add to the basket.
     */
    Quantity: number;

    /**
     * An array of delivery types for the basket item.
     */
    DeliveryType: string[];

    /**
     * Additional attributes associated with the basket item.
     * A key-value pair where the key is the attribute name and the value is the attribute value.
     */
    Attributes: { [key: string]: string };

    /**
     * The type of basket item.
     * e.g., shopping cart, wishlist.
     */
    Type: MsShoppingCartItemType;
    
    /**
     * The ID of the saved quote associated with the basket item.
     * This is used to associate a basket item with a saved quote.
     */
    SavedQuoteId?: number;
}

/**
 * Constructor interface for creating instances of AddToBasketObjectInstance.
 */
interface AddToBasketObjectInstanceConstructor {
    /**
     * Creates a new instance of AddToBasketObjectInstance.
     * @returns A new instance of AddToBasketObjectInstance.
     */
    new (): AddToBasketObjectInstance;

    /**
     * The prototype of AddToBasketObjectInstance.
     */
    readonly prototype: AddToBasketObjectInstance;
}

/**
 * Constructor for creating instances of AddToBasketObjectInstance.
 */
declare const AddToBasketObject: AddToBasketObjectInstanceConstructor;


/**
 * Enum defining the type of basket items.
 */
declare enum MsShoppingCartItemType {
    /** Shopping cart item type. */
    ShoppingCart = 1,

    /** Wishlist item type. */
    Wishlist = 2,

    /** Saved basket item type. */
    SavedBasket = 3,

    /** API item type. */
    Api = 4
}