@dropins/storefront-quote-management 0.0.1-alpha9 → 1.0.0-beta2

package/data/models/negotiable-quote-model.d.ts

@@ -1,51 +1,286 @@
+/********************************************************************
+ *  Copyright 2025 Adobe
+ *  All Rights Reserved.
+ *
+ * NOTICE:  Adobe permits you to use, modify, and distribute this
+ * file in accordance with the terms of the Adobe license agreement
+ * accompanying it.
+ *******************************************************************/
+export interface ShippingAddress {
+    /**
+     * The unique string identifier of the address
+     */
+    uid?: string;
+    firstname: string;
+    lastname: string;
+    company?: string;
+    street: string[];
+    city: string;
+    region?: {
+        code: string;
+        label: string;
+        regionId: number;
+    };
+    postcode: string;
+    country: {
+        code: string;
+        label: string;
+    };
+    telephone: string;
+}
 export interface NegotiableQuoteModel {
     uid: string;
+    name: string;
     createdAt: string;
-    status: string;
+    salesRepName: string;
+    expirationDate: string;
+    updatedAt: string;
+    status: NegotiableQuoteStatus;
+    isVirtual: boolean;
     buyer: {
         firstname: string;
         lastname: string;
     };
-    comments: {
+    templateName?: string;
+    totalQuantity: number;
+    comments?: {
         uid: string;
         createdAt: string;
         author: {
             firstname: string;
             lastname: string;
         };
+        text: string;
         attachments?: {
             name: string;
             url: string;
         }[];
     }[];
-    items: {
-        product: {
-            uid: string;
-            sku: string;
-            name: string;
-            priceRange: {
-                maximumPrice: {
-                    regularPrice: {
-                        value: number;
-                    };
-                };
-            };
-        };
+    history?: NegotiableQuoteHistoryEntry[];
+    prices: {
+        appliedDiscounts?: Discount[];
+        appliedTaxes?: Tax[];
+        discount?: Currency;
+        grandTotal?: Currency;
+        grandTotalExcludingTax?: Currency;
+        shippingExcludingTax?: Currency;
+        shippingIncludingTax?: Currency;
+        subtotalExcludingTax?: Currency;
+        subtotalIncludingTax?: Currency;
+        subtotalWithDiscountExcludingTax?: Currency;
+        totalTax?: Currency;
+    };
+    items: NegotiableQuoteCartItem[];
+    shippingAddresses?: ShippingAddress[];
+    canCheckout: boolean;
+    canSendForReview: boolean;
+    lockedForEditing?: boolean;
+    canDelete: boolean;
+    canClose: boolean;
+    canUpdateQuote: boolean;
+    readOnly: boolean;
+}
+export interface ConfigurableOption {
+    optionLabel: string;
+    valueLabel: string;
+}
+export interface BundleOption {
+    label: string;
+    values: {
+        label: string;
         quantity: number;
-        prices: {
-            subtotalExcludingTax: {
-                value: number;
-            };
-            subtotalIncludingTax: {
-                value: number;
-            };
-            subtotalWithDiscountExcludingTax: {
-                value: number;
-            };
-            grandTotal: {
-                value: number;
+        originalPrice: Currency;
+        price: Currency;
+    }[];
+}
+export interface CustomizableOption {
+    type: string;
+    label: string;
+    values: {
+        label: string;
+        value: string;
+    }[];
+}
+export interface NegotiableQuoteCartItem {
+    itemType: string;
+    uid: string;
+    product: {
+        uid: string;
+        sku: string;
+        name: string;
+        templateId?: string;
+        templateName?: string;
+        priceRange: {
+            maximumPrice: {
+                regularPrice: Currency;
             };
         };
+    };
+    image: ItemImage;
+    links?: ItemLinks;
+    discounted: boolean;
+    discountedTotal: Currency;
+    catalogDiscount: {
+        amountOff: number;
+        percentOff: number;
+    };
+    discounts: {
+        label: string;
+        value: string;
+        amount: Currency;
     }[];
+    discountPercentage?: number;
+    insufficientQuantity?: boolean;
+    outOfStock?: boolean;
+    stockStatus: string;
+    quantity: number;
+    prices: {
+        regularPrice: Currency;
+        priceIncludingTax: Currency;
+        originalItemPrice: Currency;
+        originalRowTotal: Currency;
+        rowTotal: Currency;
+        rowTotalIncludingTax: Currency;
+    };
+    savingsAmount?: Currency;
+    configurableOptions?: ConfigurableOption[];
+    bundleOptions?: BundleOption[];
+    customizableOptions?: CustomizableOption[];
+    noteFromBuyer?: ItemNote[];
+    noteFromSeller?: ItemNote[];
+}
+interface ItemImage {
+    src: string;
+    alt: string;
+}
+interface ItemLinks {
+    count: number;
+    result: string;
+}
+export interface ItemNote {
+    createdAt: string;
+    creatorId: number;
+    creatorType: number;
+    negotiableQuoteItemUid: string;
+    note: string;
+    noteUid: string;
+}
+export interface Currency {
+    value: number;
+    currency: string;
+}
+export interface Tax {
+    amount: Currency;
+    label: string;
+}
+export interface Discount {
+    amount: Currency;
+    label: string;
+    coupon?: Coupon;
+}
+export interface Coupon {
+    code: string;
+}
+export interface NegotiableQuoteListEntry {
+    uid: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+    status: NegotiableQuoteStatus;
+    buyer: {
+        firstname: string;
+        lastname: string;
+    };
+    templateName: string;
+    prices: {
+        grandTotal: Currency;
+    };
+}
+export interface NegotiableQuotesListModel {
+    items: NegotiableQuoteListEntry[];
+    pageInfo: {
+        currentPage: number;
+        pageSize: number;
+        totalPages: number;
+    };
+    totalCount: number;
+    paginationInfo?: PaginationInfo;
+    sortFields?: {
+        default: string;
+        options: Array<{
+            label: string;
+            value: string;
+        }>;
+    };
+}
+export interface NegotiableQuoteHistoryEntry {
+    author: {
+        firstname: string;
+        lastname: string;
+    };
+    changeType: NegotiableQuoteHistoryEntryChangeType;
+    changes: {
+        commentAdded?: {
+            comment: string;
+        };
+        customChanges?: {
+            new_value: string;
+            old_value: string;
+            title: string;
+        };
+        expiration?: {
+            newExpiration: string;
+            oldExpiration: string;
+        };
+        productsRemoved?: {
+            productsRemovedFromCatalog: string[];
+            productsRemovedFromQuote?: {
+                uid: string;
+                name: string;
+                sku: string;
+                quantity: number;
+            }[];
+        };
+        statuses?: {
+            changes: {
+                newStatus: string;
+                oldStatus: string;
+            }[];
+        };
+        total?: {
+            newPrice: Currency;
+            oldPrice: Currency;
+        };
+    };
+    createdAt: string;
+    uid: string;
+}
+export declare enum NegotiableQuoteHistoryEntryChangeType {
+    CREATED = "CREATED",
+    UPDATED = "UPDATED",
+    CLOSED = "CLOSED",
+    UPDATED_BY_SYSTEM = "UPDATED_BY_SYSTEM"
+}
+export declare enum NegotiableQuoteStatus {
+    NEW = "NEW",
+    SUBMITTED = "SUBMITTED",
+    PENDING = "PENDING",
+    UPDATED = "UPDATED",
+    OPEN = "OPEN",
+    ORDERED = "ORDERED",
+    CLOSED = "CLOSED",
+    DECLINED = "DECLINED",
+    EXPIRED = "EXPIRED",
+    DRAFT = "DRAFT"
+}
+export interface PaginationInfo {
+    currentPage: number;
+    totalCount: number;
+    pageSize: number;
+    startItem: number;
+    endItem: number;
+    totalPages: number;
+    pageSizeOptions?: number[];
 }
+export {};
 //# sourceMappingURL=negotiable-quote-model.d.ts.map

package/data/models/negotiable-quote-template-model.d.ts

@@ -0,0 +1,148 @@
+import { Currency, ItemNote, PaginationInfo, ShippingAddress, ConfigurableOption, BundleOption } from './negotiable-quote-model';
+
+export interface NegotiableQuoteTemplateModel {
+    id: string;
+    uid: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+    expirationDate?: string;
+    status: NegotiableQuoteTemplateStatus;
+    salesRepName: string;
+    buyer: {
+        firstname: string;
+        lastname: string;
+    };
+    comments?: QuoteTemplateComment[];
+    history?: QuoteTemplateHistoryEntry[];
+    prices: {
+        subtotalExcludingTax?: Currency;
+        subtotalIncludingTax?: Currency;
+        subtotalWithDiscountExcludingTax?: Currency;
+        grandTotal?: Currency;
+        appliedTaxes?: {
+            amount: Currency;
+            label: string;
+        }[];
+    };
+    items: QuoteTemplateCartItem[];
+    shippingAddresses?: ShippingAddress[];
+    referenceDocuments?: {
+        uid: string;
+        name: string;
+        identifier?: string;
+        url: string;
+    }[];
+    quantityThresholds?: {
+        min?: number;
+        max?: number;
+    };
+    canAccept: boolean;
+    canDelete: boolean;
+    canReopen: boolean;
+    canCancel: boolean;
+    canSendForReview: boolean;
+    canGenerateQuoteFromTemplate: boolean;
+    canEditTemplateItems: boolean;
+}
+export declare enum NegotiableQuoteTemplateStatus {
+    ACTIVE = "Active",
+    IN_REVIEW = "In Review",
+    INACTIVE = "Inactive",
+    SUBMITTED = "Submitted",
+    PENDING = "Pending",
+    CLOSED = "Closed",
+    OPEN = "Open",
+    UPDATED = "Updated",
+    EDITED = "Edited",
+    NEW = "New",
+    DRAFT = "Draft",
+    DECLINED = "Declined",
+    CANCELED = "Canceled",
+    EXPIRED = "Expired"
+}
+export interface QuoteTemplateCartItem {
+    uid?: string;
+    product: {
+        uid: string;
+        sku: string;
+        name: string;
+    };
+    quantity: number;
+    prices: {
+        originalItemPrice: Currency;
+        rowTotal: Currency;
+    };
+    catalogDiscount?: {
+        amountOff: number;
+        percentOff: number;
+    };
+    discounts?: {
+        label: string;
+        value: string;
+        amount: Currency;
+    }[];
+    noteFromBuyer?: ItemNote[];
+    noteFromSeller?: ItemNote[];
+    configurableOptions?: ConfigurableOption[];
+    bundleOptions?: BundleOption[];
+}
+export interface QuoteTemplateComment {
+    uid: string;
+    createdAt: string;
+    author: {
+        firstname: string;
+        lastname: string;
+    };
+    text: string;
+    attachments?: {
+        name: string;
+        url: string;
+    }[];
+}
+export interface QuoteTemplateHistoryEntry {
+    uid: string;
+    createdAt: string;
+    author: {
+        firstname: string;
+        lastname: string;
+    };
+    changeType: string;
+    changes: any;
+}
+export interface NegotiableQuoteTemplatesListModel {
+    items: NegotiableQuoteTemplateListEntry[];
+    pageInfo: {
+        currentPage: number;
+        pageSize: number;
+        totalPages: number;
+    };
+    totalCount: number;
+    paginationInfo?: PaginationInfo;
+    sortFields?: {
+        default: string;
+        options: Array<{
+            label: string;
+            value: string;
+        }>;
+    };
+}
+export interface NegotiableQuoteTemplateListEntry {
+    id: string;
+    uid: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+    status: NegotiableQuoteTemplateStatus;
+    state: 'active' | 'inactive' | 'in_review';
+    lastSharedAt: string;
+    lastOrderedAt: string;
+    expirationDate: string;
+    ordersPlaced: number;
+    prices: {
+        grandTotal: Currency;
+        minNegotiatedGrandTotal: Currency;
+    };
+    canGenerateQuoteFromTemplate?: boolean;
+}
+//# sourceMappingURL=negotiable-quote-template-model.d.ts.map

package/data/models/store-config-model.d.ts

@@ -0,0 +1,27 @@
+/********************************************************************
+ *  Copyright 2025 Adobe
+ *  All Rights Reserved.
+ *
+ * NOTICE:  Adobe permits you to use, modify, and distribute this
+ * file in accordance with the terms of the Adobe license agreement
+ * accompanying it.
+ *******************************************************************/
+export declare enum QuoteDisplayAmount {
+    TAX_EXCLUDED = 1,
+    TAX_INCLUDED = 2,
+    TAX_INCLUDED_AND_EXCLUDED = 3
+}
+export interface StoreConfigModel {
+    quoteSummaryDisplayTotal: number;
+    quoteSummaryMaxItems: number;
+    quoteDisplaySettings: {
+        zeroTax: boolean;
+        subtotal: QuoteDisplayAmount;
+        price: QuoteDisplayAmount;
+        shipping: QuoteDisplayAmount;
+        fullSummary: boolean;
+        grandTotal: boolean;
+    };
+    useConfigurableParentThumbnail: boolean;
+}
+//# sourceMappingURL=store-config-model.d.ts.map