@fas-core/shared-types 1.0.90 → 1.0.92
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +124 -10
- package/dist/index.d.ts +124 -10
- package/dist/index.js +177 -12
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +177 -12
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -134,6 +134,8 @@ interface IContent {
|
|
|
134
134
|
applications: string;
|
|
135
135
|
}
|
|
136
136
|
|
|
137
|
+
declare const toIdString: (value: unknown) => string;
|
|
138
|
+
|
|
137
139
|
interface ICurrency extends BaseEntity {
|
|
138
140
|
name: string;
|
|
139
141
|
symbol: string;
|
|
@@ -240,7 +242,13 @@ interface ICategory extends BaseEntity {
|
|
|
240
242
|
subCategories?: ICategory[];
|
|
241
243
|
}
|
|
242
244
|
|
|
243
|
-
|
|
245
|
+
declare const StockStatusEnum: {
|
|
246
|
+
readonly IN_STOCK: "IN_STOCK";
|
|
247
|
+
readonly LOW_STOCK: "LOW_STOCK";
|
|
248
|
+
readonly OUT_OF_STOCK: "OUT_OF_STOCK";
|
|
249
|
+
};
|
|
250
|
+
type StockStatus = (typeof StockStatusEnum)[keyof typeof StockStatusEnum];
|
|
251
|
+
declare const STOCK_STATUS_VALUES: ("IN_STOCK" | "LOW_STOCK" | "OUT_OF_STOCK")[];
|
|
244
252
|
interface IStock extends BaseEntity {
|
|
245
253
|
sku: string;
|
|
246
254
|
product: IProduct;
|
|
@@ -260,10 +268,28 @@ declare const InventoryPolicyEnum: {
|
|
|
260
268
|
type InventoryPolicy = (typeof InventoryPolicyEnum)[keyof typeof InventoryPolicyEnum];
|
|
261
269
|
declare const INVENTORY_POLICY_VALUES: InventoryPolicy[];
|
|
262
270
|
|
|
271
|
+
declare const SaleTypeEnum: {
|
|
272
|
+
readonly DIRECT: "DIRECT";
|
|
273
|
+
readonly QUOTE: "QUOTE";
|
|
274
|
+
};
|
|
275
|
+
type SaleType = (typeof SaleTypeEnum)[keyof typeof SaleTypeEnum];
|
|
276
|
+
declare const SALE_TYPE_VALUES: SaleType[];
|
|
277
|
+
|
|
278
|
+
interface SaleTypedLike {
|
|
279
|
+
saleType?: SaleType;
|
|
280
|
+
metaData?: unknown;
|
|
281
|
+
price?: {
|
|
282
|
+
price?: number;
|
|
283
|
+
} | null;
|
|
284
|
+
}
|
|
285
|
+
declare const saleTypeOf: (item: SaleTypedLike | null | undefined) => SaleType;
|
|
286
|
+
declare const isQuoteOnlyItem: (item: SaleTypedLike | null | undefined) => boolean;
|
|
287
|
+
|
|
263
288
|
interface IProductVariantFields {
|
|
264
289
|
description: string;
|
|
265
290
|
overview: string;
|
|
266
291
|
price: IPrice;
|
|
292
|
+
saleType?: SaleType;
|
|
267
293
|
quantity: number;
|
|
268
294
|
inventoryPolicy: InventoryPolicy;
|
|
269
295
|
brand: IBrand;
|
|
@@ -436,9 +462,10 @@ declare const PaymentStatusEnum: {
|
|
|
436
462
|
readonly UNKNOWN: "UNKNOWN";
|
|
437
463
|
readonly REFUNDED: "REFUNDED";
|
|
438
464
|
readonly PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED";
|
|
465
|
+
readonly NOT_REQUIRED: "NOT_REQUIRED";
|
|
439
466
|
};
|
|
440
467
|
type PaymentStatusEnum = (typeof PaymentStatusEnum)[keyof typeof PaymentStatusEnum];
|
|
441
|
-
declare const PAYMENT_STATUS_VALUES: ("INITIATED" | "PENDING" | "PROCESSING" | "FAILED" | "CANCELLED" | "PENDING_CAPTURE" | "COMPLETED" | "VOIDED" | "REDIRECTED_TO_GATEWAY" | "UNKNOWN" | "REFUNDED" | "PARTIALLY_REFUNDED")[];
|
|
468
|
+
declare const PAYMENT_STATUS_VALUES: ("INITIATED" | "PENDING" | "PROCESSING" | "FAILED" | "CANCELLED" | "PENDING_CAPTURE" | "COMPLETED" | "VOIDED" | "REDIRECTED_TO_GATEWAY" | "UNKNOWN" | "REFUNDED" | "PARTIALLY_REFUNDED" | "NOT_REQUIRED")[];
|
|
442
469
|
declare const paymentStatusColorMap: Record<PaymentStatusEnum, string>;
|
|
443
470
|
declare const PaymentMethodEnum: {
|
|
444
471
|
readonly CREDIT_CARD: "CREDIT_CARD";
|
|
@@ -504,10 +531,17 @@ declare const OrderStatusEnum: {
|
|
|
504
531
|
readonly PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED";
|
|
505
532
|
readonly ARCHIVED: "ARCHIVED";
|
|
506
533
|
readonly RETURNED: "RETURNED";
|
|
534
|
+
readonly QUOTE_REQUESTED: "QUOTE_REQUESTED";
|
|
535
|
+
readonly QUOTED: "QUOTED";
|
|
536
|
+
readonly QUOTE_ACCEPTED: "QUOTE_ACCEPTED";
|
|
537
|
+
readonly QUOTE_DECLINED: "QUOTE_DECLINED";
|
|
538
|
+
readonly QUOTE_EXPIRED: "QUOTE_EXPIRED";
|
|
507
539
|
};
|
|
508
540
|
type OrderStatusEnum = (typeof OrderStatusEnum)[keyof typeof OrderStatusEnum];
|
|
509
|
-
declare const ORDER_STATUS_VALUES: ("PENDING" | "PROCESSING" | "FAILED" | "REFUNDED" | "PARTIALLY_REFUNDED" | "CREATED" | "RECEIVED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "CANCELED" | "ARCHIVED" | "RETURNED")[];
|
|
541
|
+
declare const ORDER_STATUS_VALUES: ("PENDING" | "PROCESSING" | "FAILED" | "REFUNDED" | "PARTIALLY_REFUNDED" | "CREATED" | "RECEIVED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "CANCELED" | "ARCHIVED" | "RETURNED" | "QUOTE_REQUESTED" | "QUOTED" | "QUOTE_ACCEPTED" | "QUOTE_DECLINED" | "QUOTE_EXPIRED")[];
|
|
510
542
|
declare const statusColors: Record<OrderStatusEnum, string>;
|
|
543
|
+
declare const PURCHASE_ORDER_STATUSES: OrderStatusEnum[];
|
|
544
|
+
declare const QUOTE_ORDER_STATUSES: OrderStatusEnum[];
|
|
511
545
|
interface IOrderTracking {
|
|
512
546
|
number: string;
|
|
513
547
|
url: string;
|
|
@@ -520,6 +554,10 @@ interface IOrder extends BaseEntity {
|
|
|
520
554
|
coupon: ICoupon;
|
|
521
555
|
store: IStore;
|
|
522
556
|
status: OrderStatusEnum;
|
|
557
|
+
type?: SaleType;
|
|
558
|
+
sourceQuote?: IOrder | string;
|
|
559
|
+
convertedOrder?: IOrder | string;
|
|
560
|
+
quoteValidUntil?: Date;
|
|
523
561
|
paymentStatus: PaymentStatusEnum;
|
|
524
562
|
paymentMethod: PaymentMethodEnum;
|
|
525
563
|
paymentGateway: PaymentGatewayEnum;
|
|
@@ -577,6 +615,7 @@ interface IAddress extends BaseEntity {
|
|
|
577
615
|
email: string;
|
|
578
616
|
phoneNumber: string;
|
|
579
617
|
defaultAddress: boolean;
|
|
618
|
+
isResidential?: boolean;
|
|
580
619
|
state: IState;
|
|
581
620
|
country: ICountry;
|
|
582
621
|
customer: ICustomer;
|
|
@@ -699,13 +738,15 @@ declare const EmailTemplateEventEnum: {
|
|
|
699
738
|
readonly WELCOME: "WELCOME";
|
|
700
739
|
readonly PASSWORD_RESET: "PASSWORD_RESET";
|
|
701
740
|
readonly QUOTE: "QUOTE";
|
|
741
|
+
readonly QUOTE_REQUESTED: "QUOTE_REQUESTED";
|
|
742
|
+
readonly QUOTE_SENT: "QUOTE_SENT";
|
|
702
743
|
readonly INVOICE: "INVOICE";
|
|
703
744
|
readonly PROMOTIONAL: "PROMOTIONAL";
|
|
704
745
|
readonly CONTACT_US: "CONTACT_US";
|
|
705
746
|
readonly NOTIFICATION: "NOTIFICATION";
|
|
706
747
|
};
|
|
707
748
|
type EmailTemplateEventEnum = (typeof EmailTemplateEventEnum)[keyof typeof EmailTemplateEventEnum];
|
|
708
|
-
declare const EMAIL_TEMPLATE_EVENT_VALUES: ("ORDER_RECEIVED" | "ORDER_CANCELLED" | "WELCOME" | "PASSWORD_RESET" | "
|
|
749
|
+
declare const EMAIL_TEMPLATE_EVENT_VALUES: ("QUOTE" | "QUOTE_REQUESTED" | "ORDER_RECEIVED" | "ORDER_CANCELLED" | "WELCOME" | "PASSWORD_RESET" | "QUOTE_SENT" | "INVOICE" | "PROMOTIONAL" | "CONTACT_US" | "NOTIFICATION")[];
|
|
709
750
|
declare const WIRED_EMAIL_TEMPLATE_EVENTS: EmailTemplateEventEnum[];
|
|
710
751
|
declare const EMAIL_TEMPLATE_VARIABLES_BY_EVENT: Partial<Record<EmailTemplateEventEnum, string[]>>;
|
|
711
752
|
interface IEmailTemplate extends BaseEntity {
|
|
@@ -929,6 +970,16 @@ interface AddonAmountInput {
|
|
|
929
970
|
}
|
|
930
971
|
declare const addonUnitAmount: (addon: AddonAmountInput, baseUnitPrice: number) => number;
|
|
931
972
|
declare const addonsUnitAmount: (addons: AddonAmountInput[], baseUnitPrice: number) => number;
|
|
973
|
+
interface PricedLineLike {
|
|
974
|
+
pricing?: {
|
|
975
|
+
baseUnitPrice?: number;
|
|
976
|
+
unitPrice?: number;
|
|
977
|
+
};
|
|
978
|
+
metaData?: unknown;
|
|
979
|
+
}
|
|
980
|
+
declare const addonsOfLine: (line: PricedLineLike) => AddonAmountInput[];
|
|
981
|
+
declare const baseUnitPriceOfLine: (line: PricedLineLike) => number | null;
|
|
982
|
+
declare const feeHint: (fee: IAppliedFee) => string;
|
|
932
983
|
|
|
933
984
|
declare const OrderLogTypeEnum: {
|
|
934
985
|
readonly ORDER_PLACED: "ORDER_PLACED";
|
|
@@ -1038,14 +1089,21 @@ interface StockDemandLine {
|
|
|
1038
1089
|
quantity: number;
|
|
1039
1090
|
}
|
|
1040
1091
|
declare const demandByKey: (lines: StockDemandLine[]) => Map<string, number>;
|
|
1092
|
+
declare const StockVerdictEnum: {
|
|
1093
|
+
readonly OK: "OK";
|
|
1094
|
+
readonly OUT_OF_STOCK: "OUT_OF_STOCK";
|
|
1095
|
+
readonly INSUFFICIENT_STOCK: "INSUFFICIENT_STOCK";
|
|
1096
|
+
};
|
|
1097
|
+
type StockVerdictType = (typeof StockVerdictEnum)[keyof typeof StockVerdictEnum];
|
|
1098
|
+
declare const STOCK_VERDICT_VALUES: ("OUT_OF_STOCK" | "OK" | "INSUFFICIENT_STOCK")[];
|
|
1041
1099
|
type StockVerdict = {
|
|
1042
|
-
type:
|
|
1100
|
+
type: typeof StockVerdictEnum.OK;
|
|
1043
1101
|
} | {
|
|
1044
|
-
type:
|
|
1102
|
+
type: typeof StockVerdictEnum.OUT_OF_STOCK;
|
|
1045
1103
|
available: 0;
|
|
1046
1104
|
requested: number;
|
|
1047
1105
|
} | {
|
|
1048
|
-
type:
|
|
1106
|
+
type: typeof StockVerdictEnum.INSUFFICIENT_STOCK;
|
|
1049
1107
|
available: number;
|
|
1050
1108
|
requested: number;
|
|
1051
1109
|
};
|
|
@@ -1058,7 +1116,7 @@ declare const CartStatusEnum: {
|
|
|
1058
1116
|
readonly ABANDONED: "ABANDONED";
|
|
1059
1117
|
};
|
|
1060
1118
|
type CartStatusEnum = (typeof CartStatusEnum)[keyof typeof CartStatusEnum];
|
|
1061
|
-
declare const CART_STATUS_VALUES: ("
|
|
1119
|
+
declare const CART_STATUS_VALUES: ("QUOTED" | "ACTIVE" | "CONVERTED" | "ABANDONED")[];
|
|
1062
1120
|
declare const RETIRED_CART_STATUSES: CartStatusEnum[];
|
|
1063
1121
|
interface ICart extends BaseEntity {
|
|
1064
1122
|
cartId: string;
|
|
@@ -1071,6 +1129,7 @@ interface ICart extends BaseEntity {
|
|
|
1071
1129
|
pricing: ISummaryPricing;
|
|
1072
1130
|
selectedShippingRate?: IShippingRate;
|
|
1073
1131
|
status: CartStatusEnum;
|
|
1132
|
+
type: SaleType;
|
|
1074
1133
|
order?: IOrder | string;
|
|
1075
1134
|
convertedAt?: Date;
|
|
1076
1135
|
quoteToken?: string;
|
|
@@ -1078,6 +1137,26 @@ interface ICart extends BaseEntity {
|
|
|
1078
1137
|
quoteEmail?: string;
|
|
1079
1138
|
sourceCart?: ICart | string;
|
|
1080
1139
|
}
|
|
1140
|
+
declare const CartIssueTypes: {
|
|
1141
|
+
readonly ITEM_UNAVAILABLE: "ITEM_UNAVAILABLE";
|
|
1142
|
+
readonly OUT_OF_STOCK: "OUT_OF_STOCK";
|
|
1143
|
+
readonly INSUFFICIENT_STOCK: "INSUFFICIENT_STOCK";
|
|
1144
|
+
readonly COUPON_INVALID: "COUPON_INVALID";
|
|
1145
|
+
};
|
|
1146
|
+
type CartIssueType = (typeof CartIssueTypes)[keyof typeof CartIssueTypes];
|
|
1147
|
+
declare const CART_ISSUE_TYPE_VALUES: ("OUT_OF_STOCK" | "INSUFFICIENT_STOCK" | "ITEM_UNAVAILABLE" | "COUPON_INVALID")[];
|
|
1148
|
+
interface CartIssue {
|
|
1149
|
+
type: CartIssueType;
|
|
1150
|
+
itemId?: string;
|
|
1151
|
+
name?: string;
|
|
1152
|
+
available?: number;
|
|
1153
|
+
requested?: number;
|
|
1154
|
+
message: string;
|
|
1155
|
+
}
|
|
1156
|
+
interface CartValidation {
|
|
1157
|
+
ok: boolean;
|
|
1158
|
+
issues: CartIssue[];
|
|
1159
|
+
}
|
|
1081
1160
|
|
|
1082
1161
|
declare const SubscriptionChannelEnum: {
|
|
1083
1162
|
readonly EMAIL: "EMAIL";
|
|
@@ -1225,6 +1304,39 @@ interface IBlogPost extends BaseEntity {
|
|
|
1225
1304
|
seoMetaData: ISEOMetaData;
|
|
1226
1305
|
}
|
|
1227
1306
|
|
|
1307
|
+
interface IFaqCategory extends BaseEntity {
|
|
1308
|
+
name: string;
|
|
1309
|
+
slug: string;
|
|
1310
|
+
description: string;
|
|
1311
|
+
image: string;
|
|
1312
|
+
sortOrder: number;
|
|
1313
|
+
status: boolean;
|
|
1314
|
+
isOnline: boolean;
|
|
1315
|
+
metaData: Metadata;
|
|
1316
|
+
seoMetaData: ISEOMetaData;
|
|
1317
|
+
faqCount?: number;
|
|
1318
|
+
}
|
|
1319
|
+
interface IFaq extends BaseEntity {
|
|
1320
|
+
question: string;
|
|
1321
|
+
slug: string;
|
|
1322
|
+
answer: string;
|
|
1323
|
+
excerpt: string;
|
|
1324
|
+
category: IFaqCategory | string | null;
|
|
1325
|
+
tags: string[];
|
|
1326
|
+
relatedFaqs: (IFaq | string)[];
|
|
1327
|
+
relatedProducts: unknown[];
|
|
1328
|
+
helpfulYes: number;
|
|
1329
|
+
helpfulNo: number;
|
|
1330
|
+
viewCount: number;
|
|
1331
|
+
sortOrder: number;
|
|
1332
|
+
publishedAt: Date | string | null;
|
|
1333
|
+
stores: IStore[];
|
|
1334
|
+
status: boolean;
|
|
1335
|
+
isOnline: boolean;
|
|
1336
|
+
metaData: Metadata;
|
|
1337
|
+
seoMetaData: ISEOMetaData;
|
|
1338
|
+
}
|
|
1339
|
+
|
|
1228
1340
|
interface IPodcastEpisode extends BaseEntity {
|
|
1229
1341
|
title: string;
|
|
1230
1342
|
slug: string;
|
|
@@ -1258,6 +1370,7 @@ interface CheckoutAddressInput {
|
|
|
1258
1370
|
phoneNumber: string;
|
|
1259
1371
|
state?: string;
|
|
1260
1372
|
country?: string;
|
|
1373
|
+
isResidential?: boolean;
|
|
1261
1374
|
}
|
|
1262
1375
|
interface CheckoutPayload {
|
|
1263
1376
|
store: string;
|
|
@@ -1301,9 +1414,10 @@ declare const NotificationTypeEnum: {
|
|
|
1301
1414
|
readonly REFUND: "REFUND";
|
|
1302
1415
|
readonly ORDER_CANCELLED: "ORDER_CANCELLED";
|
|
1303
1416
|
readonly ORDER_STATUS: "ORDER_STATUS";
|
|
1417
|
+
readonly QUOTE_REQUESTED: "QUOTE_REQUESTED";
|
|
1304
1418
|
};
|
|
1305
1419
|
type NotificationTypeEnum = (typeof NotificationTypeEnum)[keyof typeof NotificationTypeEnum];
|
|
1306
|
-
declare const NOTIFICATION_TYPE_VALUES: ("REFUND" | "ORDER_RECEIVED" | "ORDER_CANCELLED" | "PAYMENT_SUCCEEDED" | "PAYMENT_FAILED" | "ORDER_STATUS")[];
|
|
1420
|
+
declare const NOTIFICATION_TYPE_VALUES: ("REFUND" | "QUOTE_REQUESTED" | "ORDER_RECEIVED" | "ORDER_CANCELLED" | "PAYMENT_SUCCEEDED" | "PAYMENT_FAILED" | "ORDER_STATUS")[];
|
|
1307
1421
|
declare const notificationTypeColorMap: Record<NotificationTypeEnum, string>;
|
|
1308
1422
|
interface INotification extends BaseEntity {
|
|
1309
1423
|
type: NotificationTypeEnum;
|
|
@@ -1327,4 +1441,4 @@ interface IWishlist extends BaseEntity {
|
|
|
1327
1441
|
items: IWishlistItem[];
|
|
1328
1442
|
}
|
|
1329
1443
|
|
|
1330
|
-
export { ACTIVE_SUBSCRIPTION_CHANNELS, ADMIN_ROLES, type AddonAmountInput, type AddonSelectionRef, type ApiResponse, type BaseEntity, type BundleGroup, type BundleLine, CAMPAIGN_RECIPIENT_STATUS_VALUES, CAMPAIGN_STATUS_VALUES, CART_STATUS_VALUES, CONFIGURATOR_CONDITION_TYPE_VALUES, CONFIGURATOR_EFFECT_TYPE_VALUES, CONFIGURATOR_ERROR_CODE_VALUES, CONFIGURATOR_SELECT_MODE_VALUES, CONFIGURATOR_SOURCE_VALUES, CampaignRecipientStatusEnum, CampaignStatusEnum, CartStatusEnum, type CheckoutAddressInput, type CheckoutPayload, type CheckoutResult, ConfiguratorConditionTypeEnum, ConfiguratorEffectTypeEnum, ConfiguratorErrorCodeEnum, type ConfiguratorEvalContext, type ConfiguratorEvalError, type ConfiguratorEvalResult, ConfiguratorSelectModeEnum, type ConfiguratorSelections, ConfiguratorSourceEnum, DEFAULT_SUBSCRIPTION_TOPICS, DiscountTypeEnum, EMAIL_TEMPLATE_EVENT_VALUES, EMAIL_TEMPLATE_VARIABLES_BY_EVENT, EmailTemplateEventEnum, FEE_APPLIES_TO_VALUES, FeeAppliesToEnum, type IAddonConfig, type IAddonGroup, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IAppliedFee, type IBannerSlide, type IBlogAuthor, type IBlogCategory, type IBlogCitation, type IBlogPost, type IBrand, type ICampaign, type ICampaignRecipient, type ICampaignStats, type ICart, type ICartItem, type ICategory, type ICompliance, type IConfigurator, type IConfiguratorCondition, type IConfiguratorEffect, type IConfiguratorFacet, type IConfiguratorFacetValue, type IConfiguratorOption, type IConfiguratorPriceAdjustment, type IConfiguratorQuery, type IConfiguratorRule, type IConfiguratorSection, type IConfiguratorStep, type IConfiguratorTarget, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IEmailTemplate, type IKeyValue, type ILinePricing, type IMediaAsset, INVENTORY_POLICY_VALUES, type INotification, type IOrder, type IOrderItem, type IOrderLog, type IOrderTracking, type IOrderTransaction, type IPaymentLink, type IPodcastEpisode, type IPrice, type IProduct, type IProductDailyStat, type IProductOptionGroup, type IProductOptionValue, type IProductRelationGroup, type IProductTechnicalSpec, type IProductTechnicalSpecTable, type IProductVariantFields, type IProductVariantOptionGroup, type IProductVariantOptionMatrix, type IProductVariantOptionValue, type IRedirect, type IRedirectSuggestion, type IRefundTransaction, type IRelationGroup, type ISEOMetaData, type ISelectableFee, type IShipFromAddress, type IShipping, type IShippingRate, type IState, type IStock, type IStore, type IStoreFee, type IStoreSettings, type ISubscriber, type ISubscriberConsent, type ISubscription, type ISummaryPricing, type ITechSpec, type ITechnicalSpecColumn, type ITechnicalSpecGroup, type ITransactionBase, type IUnmatched404, type IVariant, type IVariantOptionSelection, type IWishlist, type IWishlistItem, type Id, type InventoryPolicy, InventoryPolicyEnum, MAX_BUNDLE_QUANTITY, type Metadata, NOTIFICATION_TYPE_VALUES, NotificationTypeEnum, ORDER_LOG_TYPE_VALUES, ORDER_STATUS_VALUES, OrderLogTypeEnum, OrderStatusEnum, PAYMENT_GATEWAY_VALUES, PAYMENT_LINK_STATUS_VALUES, PAYMENT_METHOD_VALUES, PAYMENT_STATUS_VALUES, PRICING_TYPE_VALUES, PRODUCT_EVENT_TYPE_VALUES, type Paginated, PaymentGatewayEnum, PaymentLinkStatusEnum, PaymentMethodEnum, PaymentStatusEnum, type PricingType, PricingTypeEnum, type ProductAddonScope, ProductEventTypeEnum, type ProductVariantType, RETIRED_CART_STATUSES, type RedirectTargetType, type ResolvedAddonSelection, SUBSCRIPTION_CHANNEL_VALUES, SUBSCRIPTION_TOPIC_LABELS, SUBSCRIPTION_TOPIC_VALUES, type SoftDeleteFilter, type StockDemandLine, type StockStatus, type StockVerdict, SubscriptionChannelEnum, SubscriptionTopicEnum, TRANSACTION_TYPE_VALUES, TransactionTypeEnum, type VariantOptionMode, WIRED_EMAIL_TEMPLATE_EVENTS, addonUnitAmount, addonsUnitAmount, adjustmentsFor, applyPriceAdjustments, bundleGroupsOf, bundleLineQuantity, bundleUnitFrom, canonicalizePath, canonicalizeSlug, conditionHolds, demandByKey, evaluateConfigurator, formatMoney, groupHasDefaultAddon, isConfigurationValid, normalizeBundleQuantity, normalizeLineQuantity, normalizePath, notificationTypeColorMap, orderByBundle, orderLogTypeColorMap, paymentGatewayColorMap, paymentLinkStatusColorMap, paymentMethodColorMap, paymentStatusColorMap, resolveAddonSelections, resolveProductAddonGroups, roundMoney, statusColors, stockVerdict, typeColorMap };
|
|
1444
|
+
export { ACTIVE_SUBSCRIPTION_CHANNELS, ADMIN_ROLES, type AddonAmountInput, type AddonSelectionRef, type ApiResponse, type BaseEntity, type BundleGroup, type BundleLine, CAMPAIGN_RECIPIENT_STATUS_VALUES, CAMPAIGN_STATUS_VALUES, CART_ISSUE_TYPE_VALUES, CART_STATUS_VALUES, CONFIGURATOR_CONDITION_TYPE_VALUES, CONFIGURATOR_EFFECT_TYPE_VALUES, CONFIGURATOR_ERROR_CODE_VALUES, CONFIGURATOR_SELECT_MODE_VALUES, CONFIGURATOR_SOURCE_VALUES, CampaignRecipientStatusEnum, CampaignStatusEnum, type CartIssue, type CartIssueType, CartIssueTypes, CartStatusEnum, type CartValidation, type CheckoutAddressInput, type CheckoutPayload, type CheckoutResult, ConfiguratorConditionTypeEnum, ConfiguratorEffectTypeEnum, ConfiguratorErrorCodeEnum, type ConfiguratorEvalContext, type ConfiguratorEvalError, type ConfiguratorEvalResult, ConfiguratorSelectModeEnum, type ConfiguratorSelections, ConfiguratorSourceEnum, DEFAULT_SUBSCRIPTION_TOPICS, DiscountTypeEnum, EMAIL_TEMPLATE_EVENT_VALUES, EMAIL_TEMPLATE_VARIABLES_BY_EVENT, EmailTemplateEventEnum, FEE_APPLIES_TO_VALUES, FeeAppliesToEnum, type IAddonConfig, type IAddonGroup, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IAppliedFee, type IBannerSlide, type IBlogAuthor, type IBlogCategory, type IBlogCitation, type IBlogPost, type IBrand, type ICampaign, type ICampaignRecipient, type ICampaignStats, type ICart, type ICartItem, type ICategory, type ICompliance, type IConfigurator, type IConfiguratorCondition, type IConfiguratorEffect, type IConfiguratorFacet, type IConfiguratorFacetValue, type IConfiguratorOption, type IConfiguratorPriceAdjustment, type IConfiguratorQuery, type IConfiguratorRule, type IConfiguratorSection, type IConfiguratorStep, type IConfiguratorTarget, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IEmailTemplate, type IFaq, type IFaqCategory, type IKeyValue, type ILinePricing, type IMediaAsset, INVENTORY_POLICY_VALUES, type INotification, type IOrder, type IOrderItem, type IOrderLog, type IOrderTracking, type IOrderTransaction, type IPaymentLink, type IPodcastEpisode, type IPrice, type IProduct, type IProductDailyStat, type IProductOptionGroup, type IProductOptionValue, type IProductRelationGroup, type IProductTechnicalSpec, type IProductTechnicalSpecTable, type IProductVariantFields, type IProductVariantOptionGroup, type IProductVariantOptionMatrix, type IProductVariantOptionValue, type IRedirect, type IRedirectSuggestion, type IRefundTransaction, type IRelationGroup, type ISEOMetaData, type ISelectableFee, type IShipFromAddress, type IShipping, type IShippingRate, type IState, type IStock, type IStore, type IStoreFee, type IStoreSettings, type ISubscriber, type ISubscriberConsent, type ISubscription, type ISummaryPricing, type ITechSpec, type ITechnicalSpecColumn, type ITechnicalSpecGroup, type ITransactionBase, type IUnmatched404, type IVariant, type IVariantOptionSelection, type IWishlist, type IWishlistItem, type Id, type InventoryPolicy, InventoryPolicyEnum, MAX_BUNDLE_QUANTITY, type Metadata, NOTIFICATION_TYPE_VALUES, NotificationTypeEnum, ORDER_LOG_TYPE_VALUES, ORDER_STATUS_VALUES, OrderLogTypeEnum, OrderStatusEnum, PAYMENT_GATEWAY_VALUES, PAYMENT_LINK_STATUS_VALUES, PAYMENT_METHOD_VALUES, PAYMENT_STATUS_VALUES, PRICING_TYPE_VALUES, PRODUCT_EVENT_TYPE_VALUES, PURCHASE_ORDER_STATUSES, type Paginated, PaymentGatewayEnum, PaymentLinkStatusEnum, PaymentMethodEnum, PaymentStatusEnum, type PricedLineLike, type PricingType, PricingTypeEnum, type ProductAddonScope, ProductEventTypeEnum, type ProductVariantType, QUOTE_ORDER_STATUSES, RETIRED_CART_STATUSES, type RedirectTargetType, type ResolvedAddonSelection, SALE_TYPE_VALUES, STOCK_STATUS_VALUES, STOCK_VERDICT_VALUES, SUBSCRIPTION_CHANNEL_VALUES, SUBSCRIPTION_TOPIC_LABELS, SUBSCRIPTION_TOPIC_VALUES, type SaleType, SaleTypeEnum, type SaleTypedLike, type SoftDeleteFilter, type StockDemandLine, type StockStatus, StockStatusEnum, type StockVerdict, StockVerdictEnum, type StockVerdictType, SubscriptionChannelEnum, SubscriptionTopicEnum, TRANSACTION_TYPE_VALUES, TransactionTypeEnum, type VariantOptionMode, WIRED_EMAIL_TEMPLATE_EVENTS, addonUnitAmount, addonsOfLine, addonsUnitAmount, adjustmentsFor, applyPriceAdjustments, baseUnitPriceOfLine, bundleGroupsOf, bundleLineQuantity, bundleUnitFrom, canonicalizePath, canonicalizeSlug, conditionHolds, demandByKey, evaluateConfigurator, feeHint, formatMoney, groupHasDefaultAddon, isConfigurationValid, isQuoteOnlyItem, normalizeBundleQuantity, normalizeLineQuantity, normalizePath, notificationTypeColorMap, orderByBundle, orderLogTypeColorMap, paymentGatewayColorMap, paymentLinkStatusColorMap, paymentMethodColorMap, paymentStatusColorMap, resolveAddonSelections, resolveProductAddonGroups, roundMoney, saleTypeOf, statusColors, stockVerdict, toIdString, typeColorMap };
|
package/dist/index.d.ts
CHANGED
|
@@ -134,6 +134,8 @@ interface IContent {
|
|
|
134
134
|
applications: string;
|
|
135
135
|
}
|
|
136
136
|
|
|
137
|
+
declare const toIdString: (value: unknown) => string;
|
|
138
|
+
|
|
137
139
|
interface ICurrency extends BaseEntity {
|
|
138
140
|
name: string;
|
|
139
141
|
symbol: string;
|
|
@@ -240,7 +242,13 @@ interface ICategory extends BaseEntity {
|
|
|
240
242
|
subCategories?: ICategory[];
|
|
241
243
|
}
|
|
242
244
|
|
|
243
|
-
|
|
245
|
+
declare const StockStatusEnum: {
|
|
246
|
+
readonly IN_STOCK: "IN_STOCK";
|
|
247
|
+
readonly LOW_STOCK: "LOW_STOCK";
|
|
248
|
+
readonly OUT_OF_STOCK: "OUT_OF_STOCK";
|
|
249
|
+
};
|
|
250
|
+
type StockStatus = (typeof StockStatusEnum)[keyof typeof StockStatusEnum];
|
|
251
|
+
declare const STOCK_STATUS_VALUES: ("IN_STOCK" | "LOW_STOCK" | "OUT_OF_STOCK")[];
|
|
244
252
|
interface IStock extends BaseEntity {
|
|
245
253
|
sku: string;
|
|
246
254
|
product: IProduct;
|
|
@@ -260,10 +268,28 @@ declare const InventoryPolicyEnum: {
|
|
|
260
268
|
type InventoryPolicy = (typeof InventoryPolicyEnum)[keyof typeof InventoryPolicyEnum];
|
|
261
269
|
declare const INVENTORY_POLICY_VALUES: InventoryPolicy[];
|
|
262
270
|
|
|
271
|
+
declare const SaleTypeEnum: {
|
|
272
|
+
readonly DIRECT: "DIRECT";
|
|
273
|
+
readonly QUOTE: "QUOTE";
|
|
274
|
+
};
|
|
275
|
+
type SaleType = (typeof SaleTypeEnum)[keyof typeof SaleTypeEnum];
|
|
276
|
+
declare const SALE_TYPE_VALUES: SaleType[];
|
|
277
|
+
|
|
278
|
+
interface SaleTypedLike {
|
|
279
|
+
saleType?: SaleType;
|
|
280
|
+
metaData?: unknown;
|
|
281
|
+
price?: {
|
|
282
|
+
price?: number;
|
|
283
|
+
} | null;
|
|
284
|
+
}
|
|
285
|
+
declare const saleTypeOf: (item: SaleTypedLike | null | undefined) => SaleType;
|
|
286
|
+
declare const isQuoteOnlyItem: (item: SaleTypedLike | null | undefined) => boolean;
|
|
287
|
+
|
|
263
288
|
interface IProductVariantFields {
|
|
264
289
|
description: string;
|
|
265
290
|
overview: string;
|
|
266
291
|
price: IPrice;
|
|
292
|
+
saleType?: SaleType;
|
|
267
293
|
quantity: number;
|
|
268
294
|
inventoryPolicy: InventoryPolicy;
|
|
269
295
|
brand: IBrand;
|
|
@@ -436,9 +462,10 @@ declare const PaymentStatusEnum: {
|
|
|
436
462
|
readonly UNKNOWN: "UNKNOWN";
|
|
437
463
|
readonly REFUNDED: "REFUNDED";
|
|
438
464
|
readonly PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED";
|
|
465
|
+
readonly NOT_REQUIRED: "NOT_REQUIRED";
|
|
439
466
|
};
|
|
440
467
|
type PaymentStatusEnum = (typeof PaymentStatusEnum)[keyof typeof PaymentStatusEnum];
|
|
441
|
-
declare const PAYMENT_STATUS_VALUES: ("INITIATED" | "PENDING" | "PROCESSING" | "FAILED" | "CANCELLED" | "PENDING_CAPTURE" | "COMPLETED" | "VOIDED" | "REDIRECTED_TO_GATEWAY" | "UNKNOWN" | "REFUNDED" | "PARTIALLY_REFUNDED")[];
|
|
468
|
+
declare const PAYMENT_STATUS_VALUES: ("INITIATED" | "PENDING" | "PROCESSING" | "FAILED" | "CANCELLED" | "PENDING_CAPTURE" | "COMPLETED" | "VOIDED" | "REDIRECTED_TO_GATEWAY" | "UNKNOWN" | "REFUNDED" | "PARTIALLY_REFUNDED" | "NOT_REQUIRED")[];
|
|
442
469
|
declare const paymentStatusColorMap: Record<PaymentStatusEnum, string>;
|
|
443
470
|
declare const PaymentMethodEnum: {
|
|
444
471
|
readonly CREDIT_CARD: "CREDIT_CARD";
|
|
@@ -504,10 +531,17 @@ declare const OrderStatusEnum: {
|
|
|
504
531
|
readonly PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED";
|
|
505
532
|
readonly ARCHIVED: "ARCHIVED";
|
|
506
533
|
readonly RETURNED: "RETURNED";
|
|
534
|
+
readonly QUOTE_REQUESTED: "QUOTE_REQUESTED";
|
|
535
|
+
readonly QUOTED: "QUOTED";
|
|
536
|
+
readonly QUOTE_ACCEPTED: "QUOTE_ACCEPTED";
|
|
537
|
+
readonly QUOTE_DECLINED: "QUOTE_DECLINED";
|
|
538
|
+
readonly QUOTE_EXPIRED: "QUOTE_EXPIRED";
|
|
507
539
|
};
|
|
508
540
|
type OrderStatusEnum = (typeof OrderStatusEnum)[keyof typeof OrderStatusEnum];
|
|
509
|
-
declare const ORDER_STATUS_VALUES: ("PENDING" | "PROCESSING" | "FAILED" | "REFUNDED" | "PARTIALLY_REFUNDED" | "CREATED" | "RECEIVED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "CANCELED" | "ARCHIVED" | "RETURNED")[];
|
|
541
|
+
declare const ORDER_STATUS_VALUES: ("PENDING" | "PROCESSING" | "FAILED" | "REFUNDED" | "PARTIALLY_REFUNDED" | "CREATED" | "RECEIVED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "CANCELED" | "ARCHIVED" | "RETURNED" | "QUOTE_REQUESTED" | "QUOTED" | "QUOTE_ACCEPTED" | "QUOTE_DECLINED" | "QUOTE_EXPIRED")[];
|
|
510
542
|
declare const statusColors: Record<OrderStatusEnum, string>;
|
|
543
|
+
declare const PURCHASE_ORDER_STATUSES: OrderStatusEnum[];
|
|
544
|
+
declare const QUOTE_ORDER_STATUSES: OrderStatusEnum[];
|
|
511
545
|
interface IOrderTracking {
|
|
512
546
|
number: string;
|
|
513
547
|
url: string;
|
|
@@ -520,6 +554,10 @@ interface IOrder extends BaseEntity {
|
|
|
520
554
|
coupon: ICoupon;
|
|
521
555
|
store: IStore;
|
|
522
556
|
status: OrderStatusEnum;
|
|
557
|
+
type?: SaleType;
|
|
558
|
+
sourceQuote?: IOrder | string;
|
|
559
|
+
convertedOrder?: IOrder | string;
|
|
560
|
+
quoteValidUntil?: Date;
|
|
523
561
|
paymentStatus: PaymentStatusEnum;
|
|
524
562
|
paymentMethod: PaymentMethodEnum;
|
|
525
563
|
paymentGateway: PaymentGatewayEnum;
|
|
@@ -577,6 +615,7 @@ interface IAddress extends BaseEntity {
|
|
|
577
615
|
email: string;
|
|
578
616
|
phoneNumber: string;
|
|
579
617
|
defaultAddress: boolean;
|
|
618
|
+
isResidential?: boolean;
|
|
580
619
|
state: IState;
|
|
581
620
|
country: ICountry;
|
|
582
621
|
customer: ICustomer;
|
|
@@ -699,13 +738,15 @@ declare const EmailTemplateEventEnum: {
|
|
|
699
738
|
readonly WELCOME: "WELCOME";
|
|
700
739
|
readonly PASSWORD_RESET: "PASSWORD_RESET";
|
|
701
740
|
readonly QUOTE: "QUOTE";
|
|
741
|
+
readonly QUOTE_REQUESTED: "QUOTE_REQUESTED";
|
|
742
|
+
readonly QUOTE_SENT: "QUOTE_SENT";
|
|
702
743
|
readonly INVOICE: "INVOICE";
|
|
703
744
|
readonly PROMOTIONAL: "PROMOTIONAL";
|
|
704
745
|
readonly CONTACT_US: "CONTACT_US";
|
|
705
746
|
readonly NOTIFICATION: "NOTIFICATION";
|
|
706
747
|
};
|
|
707
748
|
type EmailTemplateEventEnum = (typeof EmailTemplateEventEnum)[keyof typeof EmailTemplateEventEnum];
|
|
708
|
-
declare const EMAIL_TEMPLATE_EVENT_VALUES: ("ORDER_RECEIVED" | "ORDER_CANCELLED" | "WELCOME" | "PASSWORD_RESET" | "
|
|
749
|
+
declare const EMAIL_TEMPLATE_EVENT_VALUES: ("QUOTE" | "QUOTE_REQUESTED" | "ORDER_RECEIVED" | "ORDER_CANCELLED" | "WELCOME" | "PASSWORD_RESET" | "QUOTE_SENT" | "INVOICE" | "PROMOTIONAL" | "CONTACT_US" | "NOTIFICATION")[];
|
|
709
750
|
declare const WIRED_EMAIL_TEMPLATE_EVENTS: EmailTemplateEventEnum[];
|
|
710
751
|
declare const EMAIL_TEMPLATE_VARIABLES_BY_EVENT: Partial<Record<EmailTemplateEventEnum, string[]>>;
|
|
711
752
|
interface IEmailTemplate extends BaseEntity {
|
|
@@ -929,6 +970,16 @@ interface AddonAmountInput {
|
|
|
929
970
|
}
|
|
930
971
|
declare const addonUnitAmount: (addon: AddonAmountInput, baseUnitPrice: number) => number;
|
|
931
972
|
declare const addonsUnitAmount: (addons: AddonAmountInput[], baseUnitPrice: number) => number;
|
|
973
|
+
interface PricedLineLike {
|
|
974
|
+
pricing?: {
|
|
975
|
+
baseUnitPrice?: number;
|
|
976
|
+
unitPrice?: number;
|
|
977
|
+
};
|
|
978
|
+
metaData?: unknown;
|
|
979
|
+
}
|
|
980
|
+
declare const addonsOfLine: (line: PricedLineLike) => AddonAmountInput[];
|
|
981
|
+
declare const baseUnitPriceOfLine: (line: PricedLineLike) => number | null;
|
|
982
|
+
declare const feeHint: (fee: IAppliedFee) => string;
|
|
932
983
|
|
|
933
984
|
declare const OrderLogTypeEnum: {
|
|
934
985
|
readonly ORDER_PLACED: "ORDER_PLACED";
|
|
@@ -1038,14 +1089,21 @@ interface StockDemandLine {
|
|
|
1038
1089
|
quantity: number;
|
|
1039
1090
|
}
|
|
1040
1091
|
declare const demandByKey: (lines: StockDemandLine[]) => Map<string, number>;
|
|
1092
|
+
declare const StockVerdictEnum: {
|
|
1093
|
+
readonly OK: "OK";
|
|
1094
|
+
readonly OUT_OF_STOCK: "OUT_OF_STOCK";
|
|
1095
|
+
readonly INSUFFICIENT_STOCK: "INSUFFICIENT_STOCK";
|
|
1096
|
+
};
|
|
1097
|
+
type StockVerdictType = (typeof StockVerdictEnum)[keyof typeof StockVerdictEnum];
|
|
1098
|
+
declare const STOCK_VERDICT_VALUES: ("OUT_OF_STOCK" | "OK" | "INSUFFICIENT_STOCK")[];
|
|
1041
1099
|
type StockVerdict = {
|
|
1042
|
-
type:
|
|
1100
|
+
type: typeof StockVerdictEnum.OK;
|
|
1043
1101
|
} | {
|
|
1044
|
-
type:
|
|
1102
|
+
type: typeof StockVerdictEnum.OUT_OF_STOCK;
|
|
1045
1103
|
available: 0;
|
|
1046
1104
|
requested: number;
|
|
1047
1105
|
} | {
|
|
1048
|
-
type:
|
|
1106
|
+
type: typeof StockVerdictEnum.INSUFFICIENT_STOCK;
|
|
1049
1107
|
available: number;
|
|
1050
1108
|
requested: number;
|
|
1051
1109
|
};
|
|
@@ -1058,7 +1116,7 @@ declare const CartStatusEnum: {
|
|
|
1058
1116
|
readonly ABANDONED: "ABANDONED";
|
|
1059
1117
|
};
|
|
1060
1118
|
type CartStatusEnum = (typeof CartStatusEnum)[keyof typeof CartStatusEnum];
|
|
1061
|
-
declare const CART_STATUS_VALUES: ("
|
|
1119
|
+
declare const CART_STATUS_VALUES: ("QUOTED" | "ACTIVE" | "CONVERTED" | "ABANDONED")[];
|
|
1062
1120
|
declare const RETIRED_CART_STATUSES: CartStatusEnum[];
|
|
1063
1121
|
interface ICart extends BaseEntity {
|
|
1064
1122
|
cartId: string;
|
|
@@ -1071,6 +1129,7 @@ interface ICart extends BaseEntity {
|
|
|
1071
1129
|
pricing: ISummaryPricing;
|
|
1072
1130
|
selectedShippingRate?: IShippingRate;
|
|
1073
1131
|
status: CartStatusEnum;
|
|
1132
|
+
type: SaleType;
|
|
1074
1133
|
order?: IOrder | string;
|
|
1075
1134
|
convertedAt?: Date;
|
|
1076
1135
|
quoteToken?: string;
|
|
@@ -1078,6 +1137,26 @@ interface ICart extends BaseEntity {
|
|
|
1078
1137
|
quoteEmail?: string;
|
|
1079
1138
|
sourceCart?: ICart | string;
|
|
1080
1139
|
}
|
|
1140
|
+
declare const CartIssueTypes: {
|
|
1141
|
+
readonly ITEM_UNAVAILABLE: "ITEM_UNAVAILABLE";
|
|
1142
|
+
readonly OUT_OF_STOCK: "OUT_OF_STOCK";
|
|
1143
|
+
readonly INSUFFICIENT_STOCK: "INSUFFICIENT_STOCK";
|
|
1144
|
+
readonly COUPON_INVALID: "COUPON_INVALID";
|
|
1145
|
+
};
|
|
1146
|
+
type CartIssueType = (typeof CartIssueTypes)[keyof typeof CartIssueTypes];
|
|
1147
|
+
declare const CART_ISSUE_TYPE_VALUES: ("OUT_OF_STOCK" | "INSUFFICIENT_STOCK" | "ITEM_UNAVAILABLE" | "COUPON_INVALID")[];
|
|
1148
|
+
interface CartIssue {
|
|
1149
|
+
type: CartIssueType;
|
|
1150
|
+
itemId?: string;
|
|
1151
|
+
name?: string;
|
|
1152
|
+
available?: number;
|
|
1153
|
+
requested?: number;
|
|
1154
|
+
message: string;
|
|
1155
|
+
}
|
|
1156
|
+
interface CartValidation {
|
|
1157
|
+
ok: boolean;
|
|
1158
|
+
issues: CartIssue[];
|
|
1159
|
+
}
|
|
1081
1160
|
|
|
1082
1161
|
declare const SubscriptionChannelEnum: {
|
|
1083
1162
|
readonly EMAIL: "EMAIL";
|
|
@@ -1225,6 +1304,39 @@ interface IBlogPost extends BaseEntity {
|
|
|
1225
1304
|
seoMetaData: ISEOMetaData;
|
|
1226
1305
|
}
|
|
1227
1306
|
|
|
1307
|
+
interface IFaqCategory extends BaseEntity {
|
|
1308
|
+
name: string;
|
|
1309
|
+
slug: string;
|
|
1310
|
+
description: string;
|
|
1311
|
+
image: string;
|
|
1312
|
+
sortOrder: number;
|
|
1313
|
+
status: boolean;
|
|
1314
|
+
isOnline: boolean;
|
|
1315
|
+
metaData: Metadata;
|
|
1316
|
+
seoMetaData: ISEOMetaData;
|
|
1317
|
+
faqCount?: number;
|
|
1318
|
+
}
|
|
1319
|
+
interface IFaq extends BaseEntity {
|
|
1320
|
+
question: string;
|
|
1321
|
+
slug: string;
|
|
1322
|
+
answer: string;
|
|
1323
|
+
excerpt: string;
|
|
1324
|
+
category: IFaqCategory | string | null;
|
|
1325
|
+
tags: string[];
|
|
1326
|
+
relatedFaqs: (IFaq | string)[];
|
|
1327
|
+
relatedProducts: unknown[];
|
|
1328
|
+
helpfulYes: number;
|
|
1329
|
+
helpfulNo: number;
|
|
1330
|
+
viewCount: number;
|
|
1331
|
+
sortOrder: number;
|
|
1332
|
+
publishedAt: Date | string | null;
|
|
1333
|
+
stores: IStore[];
|
|
1334
|
+
status: boolean;
|
|
1335
|
+
isOnline: boolean;
|
|
1336
|
+
metaData: Metadata;
|
|
1337
|
+
seoMetaData: ISEOMetaData;
|
|
1338
|
+
}
|
|
1339
|
+
|
|
1228
1340
|
interface IPodcastEpisode extends BaseEntity {
|
|
1229
1341
|
title: string;
|
|
1230
1342
|
slug: string;
|
|
@@ -1258,6 +1370,7 @@ interface CheckoutAddressInput {
|
|
|
1258
1370
|
phoneNumber: string;
|
|
1259
1371
|
state?: string;
|
|
1260
1372
|
country?: string;
|
|
1373
|
+
isResidential?: boolean;
|
|
1261
1374
|
}
|
|
1262
1375
|
interface CheckoutPayload {
|
|
1263
1376
|
store: string;
|
|
@@ -1301,9 +1414,10 @@ declare const NotificationTypeEnum: {
|
|
|
1301
1414
|
readonly REFUND: "REFUND";
|
|
1302
1415
|
readonly ORDER_CANCELLED: "ORDER_CANCELLED";
|
|
1303
1416
|
readonly ORDER_STATUS: "ORDER_STATUS";
|
|
1417
|
+
readonly QUOTE_REQUESTED: "QUOTE_REQUESTED";
|
|
1304
1418
|
};
|
|
1305
1419
|
type NotificationTypeEnum = (typeof NotificationTypeEnum)[keyof typeof NotificationTypeEnum];
|
|
1306
|
-
declare const NOTIFICATION_TYPE_VALUES: ("REFUND" | "ORDER_RECEIVED" | "ORDER_CANCELLED" | "PAYMENT_SUCCEEDED" | "PAYMENT_FAILED" | "ORDER_STATUS")[];
|
|
1420
|
+
declare const NOTIFICATION_TYPE_VALUES: ("REFUND" | "QUOTE_REQUESTED" | "ORDER_RECEIVED" | "ORDER_CANCELLED" | "PAYMENT_SUCCEEDED" | "PAYMENT_FAILED" | "ORDER_STATUS")[];
|
|
1307
1421
|
declare const notificationTypeColorMap: Record<NotificationTypeEnum, string>;
|
|
1308
1422
|
interface INotification extends BaseEntity {
|
|
1309
1423
|
type: NotificationTypeEnum;
|
|
@@ -1327,4 +1441,4 @@ interface IWishlist extends BaseEntity {
|
|
|
1327
1441
|
items: IWishlistItem[];
|
|
1328
1442
|
}
|
|
1329
1443
|
|
|
1330
|
-
export { ACTIVE_SUBSCRIPTION_CHANNELS, ADMIN_ROLES, type AddonAmountInput, type AddonSelectionRef, type ApiResponse, type BaseEntity, type BundleGroup, type BundleLine, CAMPAIGN_RECIPIENT_STATUS_VALUES, CAMPAIGN_STATUS_VALUES, CART_STATUS_VALUES, CONFIGURATOR_CONDITION_TYPE_VALUES, CONFIGURATOR_EFFECT_TYPE_VALUES, CONFIGURATOR_ERROR_CODE_VALUES, CONFIGURATOR_SELECT_MODE_VALUES, CONFIGURATOR_SOURCE_VALUES, CampaignRecipientStatusEnum, CampaignStatusEnum, CartStatusEnum, type CheckoutAddressInput, type CheckoutPayload, type CheckoutResult, ConfiguratorConditionTypeEnum, ConfiguratorEffectTypeEnum, ConfiguratorErrorCodeEnum, type ConfiguratorEvalContext, type ConfiguratorEvalError, type ConfiguratorEvalResult, ConfiguratorSelectModeEnum, type ConfiguratorSelections, ConfiguratorSourceEnum, DEFAULT_SUBSCRIPTION_TOPICS, DiscountTypeEnum, EMAIL_TEMPLATE_EVENT_VALUES, EMAIL_TEMPLATE_VARIABLES_BY_EVENT, EmailTemplateEventEnum, FEE_APPLIES_TO_VALUES, FeeAppliesToEnum, type IAddonConfig, type IAddonGroup, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IAppliedFee, type IBannerSlide, type IBlogAuthor, type IBlogCategory, type IBlogCitation, type IBlogPost, type IBrand, type ICampaign, type ICampaignRecipient, type ICampaignStats, type ICart, type ICartItem, type ICategory, type ICompliance, type IConfigurator, type IConfiguratorCondition, type IConfiguratorEffect, type IConfiguratorFacet, type IConfiguratorFacetValue, type IConfiguratorOption, type IConfiguratorPriceAdjustment, type IConfiguratorQuery, type IConfiguratorRule, type IConfiguratorSection, type IConfiguratorStep, type IConfiguratorTarget, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IEmailTemplate, type IKeyValue, type ILinePricing, type IMediaAsset, INVENTORY_POLICY_VALUES, type INotification, type IOrder, type IOrderItem, type IOrderLog, type IOrderTracking, type IOrderTransaction, type IPaymentLink, type IPodcastEpisode, type IPrice, type IProduct, type IProductDailyStat, type IProductOptionGroup, type IProductOptionValue, type IProductRelationGroup, type IProductTechnicalSpec, type IProductTechnicalSpecTable, type IProductVariantFields, type IProductVariantOptionGroup, type IProductVariantOptionMatrix, type IProductVariantOptionValue, type IRedirect, type IRedirectSuggestion, type IRefundTransaction, type IRelationGroup, type ISEOMetaData, type ISelectableFee, type IShipFromAddress, type IShipping, type IShippingRate, type IState, type IStock, type IStore, type IStoreFee, type IStoreSettings, type ISubscriber, type ISubscriberConsent, type ISubscription, type ISummaryPricing, type ITechSpec, type ITechnicalSpecColumn, type ITechnicalSpecGroup, type ITransactionBase, type IUnmatched404, type IVariant, type IVariantOptionSelection, type IWishlist, type IWishlistItem, type Id, type InventoryPolicy, InventoryPolicyEnum, MAX_BUNDLE_QUANTITY, type Metadata, NOTIFICATION_TYPE_VALUES, NotificationTypeEnum, ORDER_LOG_TYPE_VALUES, ORDER_STATUS_VALUES, OrderLogTypeEnum, OrderStatusEnum, PAYMENT_GATEWAY_VALUES, PAYMENT_LINK_STATUS_VALUES, PAYMENT_METHOD_VALUES, PAYMENT_STATUS_VALUES, PRICING_TYPE_VALUES, PRODUCT_EVENT_TYPE_VALUES, type Paginated, PaymentGatewayEnum, PaymentLinkStatusEnum, PaymentMethodEnum, PaymentStatusEnum, type PricingType, PricingTypeEnum, type ProductAddonScope, ProductEventTypeEnum, type ProductVariantType, RETIRED_CART_STATUSES, type RedirectTargetType, type ResolvedAddonSelection, SUBSCRIPTION_CHANNEL_VALUES, SUBSCRIPTION_TOPIC_LABELS, SUBSCRIPTION_TOPIC_VALUES, type SoftDeleteFilter, type StockDemandLine, type StockStatus, type StockVerdict, SubscriptionChannelEnum, SubscriptionTopicEnum, TRANSACTION_TYPE_VALUES, TransactionTypeEnum, type VariantOptionMode, WIRED_EMAIL_TEMPLATE_EVENTS, addonUnitAmount, addonsUnitAmount, adjustmentsFor, applyPriceAdjustments, bundleGroupsOf, bundleLineQuantity, bundleUnitFrom, canonicalizePath, canonicalizeSlug, conditionHolds, demandByKey, evaluateConfigurator, formatMoney, groupHasDefaultAddon, isConfigurationValid, normalizeBundleQuantity, normalizeLineQuantity, normalizePath, notificationTypeColorMap, orderByBundle, orderLogTypeColorMap, paymentGatewayColorMap, paymentLinkStatusColorMap, paymentMethodColorMap, paymentStatusColorMap, resolveAddonSelections, resolveProductAddonGroups, roundMoney, statusColors, stockVerdict, typeColorMap };
|
|
1444
|
+
export { ACTIVE_SUBSCRIPTION_CHANNELS, ADMIN_ROLES, type AddonAmountInput, type AddonSelectionRef, type ApiResponse, type BaseEntity, type BundleGroup, type BundleLine, CAMPAIGN_RECIPIENT_STATUS_VALUES, CAMPAIGN_STATUS_VALUES, CART_ISSUE_TYPE_VALUES, CART_STATUS_VALUES, CONFIGURATOR_CONDITION_TYPE_VALUES, CONFIGURATOR_EFFECT_TYPE_VALUES, CONFIGURATOR_ERROR_CODE_VALUES, CONFIGURATOR_SELECT_MODE_VALUES, CONFIGURATOR_SOURCE_VALUES, CampaignRecipientStatusEnum, CampaignStatusEnum, type CartIssue, type CartIssueType, CartIssueTypes, CartStatusEnum, type CartValidation, type CheckoutAddressInput, type CheckoutPayload, type CheckoutResult, ConfiguratorConditionTypeEnum, ConfiguratorEffectTypeEnum, ConfiguratorErrorCodeEnum, type ConfiguratorEvalContext, type ConfiguratorEvalError, type ConfiguratorEvalResult, ConfiguratorSelectModeEnum, type ConfiguratorSelections, ConfiguratorSourceEnum, DEFAULT_SUBSCRIPTION_TOPICS, DiscountTypeEnum, EMAIL_TEMPLATE_EVENT_VALUES, EMAIL_TEMPLATE_VARIABLES_BY_EVENT, EmailTemplateEventEnum, FEE_APPLIES_TO_VALUES, FeeAppliesToEnum, type IAddonConfig, type IAddonGroup, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IAppliedFee, type IBannerSlide, type IBlogAuthor, type IBlogCategory, type IBlogCitation, type IBlogPost, type IBrand, type ICampaign, type ICampaignRecipient, type ICampaignStats, type ICart, type ICartItem, type ICategory, type ICompliance, type IConfigurator, type IConfiguratorCondition, type IConfiguratorEffect, type IConfiguratorFacet, type IConfiguratorFacetValue, type IConfiguratorOption, type IConfiguratorPriceAdjustment, type IConfiguratorQuery, type IConfiguratorRule, type IConfiguratorSection, type IConfiguratorStep, type IConfiguratorTarget, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IEmailTemplate, type IFaq, type IFaqCategory, type IKeyValue, type ILinePricing, type IMediaAsset, INVENTORY_POLICY_VALUES, type INotification, type IOrder, type IOrderItem, type IOrderLog, type IOrderTracking, type IOrderTransaction, type IPaymentLink, type IPodcastEpisode, type IPrice, type IProduct, type IProductDailyStat, type IProductOptionGroup, type IProductOptionValue, type IProductRelationGroup, type IProductTechnicalSpec, type IProductTechnicalSpecTable, type IProductVariantFields, type IProductVariantOptionGroup, type IProductVariantOptionMatrix, type IProductVariantOptionValue, type IRedirect, type IRedirectSuggestion, type IRefundTransaction, type IRelationGroup, type ISEOMetaData, type ISelectableFee, type IShipFromAddress, type IShipping, type IShippingRate, type IState, type IStock, type IStore, type IStoreFee, type IStoreSettings, type ISubscriber, type ISubscriberConsent, type ISubscription, type ISummaryPricing, type ITechSpec, type ITechnicalSpecColumn, type ITechnicalSpecGroup, type ITransactionBase, type IUnmatched404, type IVariant, type IVariantOptionSelection, type IWishlist, type IWishlistItem, type Id, type InventoryPolicy, InventoryPolicyEnum, MAX_BUNDLE_QUANTITY, type Metadata, NOTIFICATION_TYPE_VALUES, NotificationTypeEnum, ORDER_LOG_TYPE_VALUES, ORDER_STATUS_VALUES, OrderLogTypeEnum, OrderStatusEnum, PAYMENT_GATEWAY_VALUES, PAYMENT_LINK_STATUS_VALUES, PAYMENT_METHOD_VALUES, PAYMENT_STATUS_VALUES, PRICING_TYPE_VALUES, PRODUCT_EVENT_TYPE_VALUES, PURCHASE_ORDER_STATUSES, type Paginated, PaymentGatewayEnum, PaymentLinkStatusEnum, PaymentMethodEnum, PaymentStatusEnum, type PricedLineLike, type PricingType, PricingTypeEnum, type ProductAddonScope, ProductEventTypeEnum, type ProductVariantType, QUOTE_ORDER_STATUSES, RETIRED_CART_STATUSES, type RedirectTargetType, type ResolvedAddonSelection, SALE_TYPE_VALUES, STOCK_STATUS_VALUES, STOCK_VERDICT_VALUES, SUBSCRIPTION_CHANNEL_VALUES, SUBSCRIPTION_TOPIC_LABELS, SUBSCRIPTION_TOPIC_VALUES, type SaleType, SaleTypeEnum, type SaleTypedLike, type SoftDeleteFilter, type StockDemandLine, type StockStatus, StockStatusEnum, type StockVerdict, StockVerdictEnum, type StockVerdictType, SubscriptionChannelEnum, SubscriptionTopicEnum, TRANSACTION_TYPE_VALUES, TransactionTypeEnum, type VariantOptionMode, WIRED_EMAIL_TEMPLATE_EVENTS, addonUnitAmount, addonsOfLine, addonsUnitAmount, adjustmentsFor, applyPriceAdjustments, baseUnitPriceOfLine, bundleGroupsOf, bundleLineQuantity, bundleUnitFrom, canonicalizePath, canonicalizeSlug, conditionHolds, demandByKey, evaluateConfigurator, feeHint, formatMoney, groupHasDefaultAddon, isConfigurationValid, isQuoteOnlyItem, normalizeBundleQuantity, normalizeLineQuantity, normalizePath, notificationTypeColorMap, orderByBundle, orderLogTypeColorMap, paymentGatewayColorMap, paymentLinkStatusColorMap, paymentMethodColorMap, paymentStatusColorMap, resolveAddonSelections, resolveProductAddonGroups, roundMoney, saleTypeOf, statusColors, stockVerdict, toIdString, typeColorMap };
|