@sixtyninecommerce/client 0.3.0 → 0.4.1

package/dist/types.d.ts

@@ -17,13 +17,119 @@ export interface StorefrontClientConfig {
     onAuthExpired?: () => void;
     retry?: RetryConfig;
 }
+export interface ChannelCustomFields {
+    maintenanceMode?: boolean;
+    cdnDomain?: string | null;
+    storefrontUrl?: string;
+    urlLocaleStrategy?: 'path-prefix' | 'subdomain' | 'none';
+    urlLocalePrefixDefault?: boolean;
+    businessName?: string | null;
+    businessDescription?: string | null;
+    logoAssetId?: string | null;
+    darkLogoAssetId?: string | null;
+    coverAssetId?: string | null;
+    faviconAssetId?: string | null;
+    websiteUrl?: string | null;
+    primaryColor?: string | null;
+    contactEmail?: string | null;
+    contactPhone?: string | null;
+    legalName?: string | null;
+    vatNumber?: string | null;
+    registrationNumber?: string | null;
+    addressLine1?: string | null;
+    addressLine2?: string | null;
+    city?: string | null;
+    postalCode?: string | null;
+    province?: string | null;
+    country?: string | null;
+    socialLinks?: string | null;
+    commercePathPrefix?: string | null;
+    commercePathPrefixTranslations?: string | null;
+    twitterHandle?: string | null;
+    defaultOgImageId?: string | null;
+    llmsTxtEnabled?: boolean;
+    [key: string]: unknown;
+}
+export interface BrandingAssetRef {
+    id: string;
+    url: string;
+    preview?: string | null;
+    mimeType?: string | null;
+}
+export interface BrandingFontResource {
+    id: string;
+    identifier: string;
+    kind: 'google' | 'self_hosted';
+    family: string;
+    weights: number[];
+    files: BrandingAssetRef[];
+}
+export interface BrandingSocialLinks {
+    facebook?: string | null;
+    instagram?: string | null;
+    twitter?: string | null;
+    linkedin?: string | null;
+    youtube?: string | null;
+    tiktok?: string | null;
+}
+export interface BrandingIdentity {
+    storeCode: string;
+    businessName: string | null;
+    businessDescription: string | null;
+    websiteUrl: string | null;
+    logoLight: BrandingAssetRef | null;
+    logoDark: BrandingAssetRef | null;
+    cover: BrandingAssetRef | null;
+    favicon: BrandingAssetRef | null;
+}
+export interface BrandingTheme {
+    primaryColor: string | null;
+}
+export interface BrandingContact {
+    email: string | null;
+    phone: string | null;
+}
+export interface BrandingLegalAddress {
+    line1: string | null;
+    line2: string | null;
+    city: string | null;
+    postalCode: string | null;
+    province: string | null;
+    country: string | null;
+}
+export interface BrandingLegal {
+    name: string | null;
+    vatNumber: string | null;
+    registrationNumber: string | null;
+    address: BrandingLegalAddress;
+}
+export interface BrandingStorefrontConfig {
+    url: string | null;
+    cdnUrl: string;
+    urlLocaleStrategy: 'path-prefix' | 'subdomain' | 'none';
+    urlLocalePrefixDefault: boolean;
+    commercePathPrefix: string | null;
+    commercePathPrefixTranslations: Record<string, string> | null;
+    maintenanceMode: boolean;
+    defaultLanguage: string;
+    defaultCurrency: string;
+}
+export interface BrandingInfo {
+    identity: BrandingIdentity;
+    theme: BrandingTheme;
+    fonts: BrandingFontResource[];
+    contact: BrandingContact;
+    legal: BrandingLegal;
+    social: BrandingSocialLinks;
+    storefront: BrandingStorefrontConfig;
+}
 export interface ChannelInfo {
     id: string;
     code: string;
     token: string;
     defaultLanguageCode: string;
     defaultCurrencyCode: string;
-    customFields: Record<string, unknown>;
+    customFields: ChannelCustomFields;
 }
 export interface StoreContext {
     channel: ChannelInfo;
@@ -109,6 +215,11 @@ export interface PriceTier {
     priceWithTax: number;
     discountLabel: string | null;
 }
+export interface VariantLocationAvailability {
+    locationId: string;
+    locationName: string;
+    inStock: boolean;
+}
 export interface ProductOption {
     id: string;
     code: string;
@@ -131,12 +242,14 @@ export interface ProductVariant {
     retailPrice: number | null;
     retailPriceWithTax: number | null;
     priceTiers: PriceTier[] | null;
+    availabilityByLocation: VariantLocationAvailability[];
     options: ProductOption[];
     featuredAsset: Asset | null;
     assets: Asset[];
     customFields: {
         minOrderQuantity: number | null;
         salesUnit: number | null;
+        position: number | null;
     };
 }
 export interface FacetValue {
@@ -153,6 +266,25 @@ export interface CollectionRef {
     id: string;
     name: string;
     slug: string;
+    position?: number;
+    parent?: {
+        id: string;
+    } | null;
+    translations?: Array<{
+        languageCode: string;
+        name: string;
+        slug: string;
+    }>;
+    customFields?: {
+        isRoutable?: boolean | null;
+        isCanonical?: boolean | null;
+    } | null;
+}
+export interface ProductTranslation {
+    languageCode: string;
+    name: string;
+    slug: string;
+    description?: string;
 }
 export interface OptionGroup {
     id: string;
@@ -164,6 +296,17 @@ export interface OptionGroup {
         code: string;
     }>;
 }
+export interface PublicProductDocument {
+    id: string;
+    position: number;
+    title: string;
+    description: string | null;
+    fileUrl: string;
+    fileMimeType: string;
+    fileSize: number;
+    fileName: string;
+    requiresAuth: boolean;
+}
 export interface Product {
     id: string;
     name: string;
@@ -175,6 +318,9 @@ export interface Product {
     optionGroups: OptionGroup[];
     facetValues: FacetValue[];
     collections: CollectionRef[];
+    translations?: ProductTranslation[];
+    documents?: PublicProductDocument[];
+    metadata?: import('./seo/metadata-types.js').ProductMetadata | null;
 }
 export interface RecommendedProductGroup {
     groupName: string;
@@ -195,9 +341,7 @@ export interface ProductSummary {
         priceWithTax: number;
         currencyCode: string;
         stockLevel: string;
-        b2bGroupName: string | null;
-        b2bRetailPrice: number | null;
-        b2bRetailPriceWithTax: number | null;
+        availabilityByLocation?: VariantLocationAvailability[];
     }>;
     facetValues?: FacetValue[];
     collections?: CollectionRef[];
@@ -239,14 +383,37 @@ export interface CollectionDetail extends Collection {
             priceListName: string | null;
             retailPrice: number | null;
             retailPriceWithTax: number | null;
+            priceTiers: PriceTier[] | null;
+            availabilityByLocation: VariantLocationAvailability[];
             customFields: {
                 minOrderQuantity: number | null;
                 salesUnit: number | null;
+                position: number | null;
             };
         }>;
         totalItems: number;
     };
 }
+export type AdjustmentType = 'PROMOTION' | 'DISTRIBUTED_ORDER_PROMOTION' | 'OTHER';
+export interface Discount {
+    adjustmentSource: string;
+    type: AdjustmentType | string;
+    description: string;
+    amount: number;
+    amountWithTax: number;
+}
+export interface OrderTaxSummary {
+    description: string;
+    taxRate: number;
+    taxBase: number;
+    taxTotal: number;
+}
+export interface OrderPromotion {
+    id: string;
+    name: string;
+    description: string;
+    couponCode: string | null;
+}
 export interface OrderLine {
     id: string;
     quantity: number;
@@ -254,6 +421,9 @@ export interface OrderLine {
     unitPriceWithTax: number;
     linePrice: number;
     linePriceWithTax: number;
+    discountedLinePrice: number;
+    discountedLinePriceWithTax: number;
+    discounts: Discount[];
     productVariant: {
         id: string;
         name: string;
@@ -296,6 +466,9 @@ export interface Order {
     totalWithTax: number;
     currencyCode: string;
     lines: OrderLine[];
+    discounts: Discount[];
+    taxSummary: OrderTaxSummary[];
+    promotions: OrderPromotion[];
     shippingAddress?: OrderAddress;
     customer?: {
         id: string;
@@ -362,6 +535,17 @@ export interface OrderSummary {
         };
     }>;
 }
+export interface ReorderSkipped {
+    variantId: string;
+    quantity: number;
+    errorCode: string;
+    message: string;
+}
+export interface ReorderResult {
+    order: Order;
+    addedLines: number;
+    skipped: ReorderSkipped[];
+}
 export interface CustomerInput {
     firstName: string;
     lastName: string;
@@ -383,6 +567,38 @@ export interface PaymentInput {
     method: string;
     metadata?: Record<string, unknown>;
 }
+export interface StripePaymentIntentResult {
+    clientSecret: string;
+}
+export interface MolliePaymentMethodsInput {
+    paymentMethodCode: string;
+}
+export interface MolliePaymentMethodAmount {
+    value: number;
+    currency: string;
+}
+export interface MolliePaymentMethod {
+    id: string;
+    code: string;
+    description: string;
+    minimumAmount: MolliePaymentMethodAmount;
+    maximumAmount: MolliePaymentMethodAmount | null;
+    image: {
+        size1x: string;
+        size2x: string;
+        svg: string;
+    };
+}
+export interface CreateMolliePaymentIntentInput {
+    paymentMethodCode: string;
+    redirectUrl?: string;
+    molliePaymentMethodCode?: string;
+    locale?: string;
+    immediateCapture?: boolean;
+}
+export interface MolliePaymentIntentResult {
+    url: string;
+}
 export interface RegisterInput {
     firstName: string;
     lastName: string;
@@ -422,7 +638,7 @@ export interface ActiveChannel {
     availableLanguageCodes: string[];
     defaultCurrencyCode: string;
     availableCurrencyCodes: string[];
-    customFields: Record<string, unknown>;
+    customFields: ChannelCustomFields;
 }
 export interface FacetValueFilterInput {
     and?: string;
@@ -465,6 +681,7 @@ export interface SearchResultItem {
         };
     } | null;
     collectionIds: string[];
+    inStock: boolean;
 }
 export interface SearchFacetValue {
     facetValue: {
@@ -514,6 +731,7 @@ export interface FavoriteVariant {
     retailPrice: number | null;
     retailPriceWithTax: number | null;
     priceTiers: PriceTier[] | null;
+    availabilityByLocation: VariantLocationAvailability[];
     product: {
         id: string;
         name: string;
@@ -530,6 +748,7 @@ export interface FavoriteVariant {
     customFields: {
         minOrderQuantity: number | null;
         salesUnit: number | null;
+        position: number | null;
     };
 }
 export interface FavoriteItem {
@@ -538,6 +757,12 @@ export interface FavoriteItem {
     createdAt: string;
     productVariant: FavoriteVariant | null;
 }
+export interface StockNotificationSubscriptionResult {
+    id: string;
+    productVariantId: string;
+    emailAddress: string;
+    createdAt: string;
+}
 export interface PaginatedList<T> {
     items: T[];
     totalItems: number;
@@ -568,6 +793,38 @@ export interface ContentItemSummary {
     collection_title_field_slug: string | null;
     title: string | null;
 }
+export interface ContentSearchQuery {
+    q?: string;
+    collectionId?: string;
+    collectionSlug?: string;
+    parentId?: string;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    languageCode?: string;
+}
+export interface ContentSearchHit {
+    id: string;
+    channel_id: string;
+    collection_id: string;
+    collection_slug: string;
+    slug: string | null;
+    path: string | null;
+    parent_id: string | null;
+    position: number;
+    status: string;
+    created_at: number;
+    updated_at: number;
+    published_at: number | null;
+    [fieldSlug: string]: unknown;
+}
+export interface ContentSearchResult {
+    hits: ContentSearchHit[];
+    total: number;
+    limit: number;
+    offset: number;
+    processing_time_ms: number;
+}
 export interface ContentItemWithFields {
     id: string;
     title: string | null;
@@ -652,11 +909,17 @@ export interface RouteEntry {
     id: string;
     title: string;
     slug?: string;
-    updatedAt?: string;
+    updated_at?: string;
     source?: string;
 }
+export interface RoutesMetadata {
+    default_language: string;
+    available_languages: string[];
+    generated_at: string;
+}
 export interface RoutesResponse {
-    routes: Record<string, RouteEntry[]>;
+    data: Record<string, RouteEntry[]>;
+    metadata: RoutesMetadata;
 }
 export interface ExchangeRate {
     baseCurrency: string;
@@ -735,6 +998,13 @@ export interface PropertyConfig {
     maxLength?: number;
     allowedCollectionIds?: string[];
     filterableFieldSlugs?: string[];
+    productFilter?: {
+        filters?: Array<{
+            property_slug: string;
+            facet_value_ids: string[];
+        }>;
+        collection_id?: string | null;
+    };
 }
 export interface Property {
     id: string;
@@ -857,6 +1127,11 @@ export interface ReviewListOptions {
     sort?: 'NEWEST' | 'OLDEST' | 'HIGHEST_RATING' | 'LOWEST_RATING' | 'MOST_HELPFUL';
     rating?: number;
 }
+export interface RecentReviewsOptions {
+    limit?: number;
+    minRating?: number;
+    languageCode?: string;
+}
 export interface CreateReviewResult {
     review: ProductReview;
     requiresModeration: boolean;
@@ -880,6 +1155,60 @@ export interface CustomerSubscription {
     cancelAtPeriodEnd: boolean;
     createdAt: string;
 }
+export type QuoteStatus = 'draft' | 'requested' | 'in_review' | 'approved' | 'declined' | 'expired' | 'converted_to_order' | 'cancelled';
+export interface QuoteLine {
+    id: string;
+    productVariantId: string;
+    quantity: number;
+    unitPrice: number | null;
+    discountLabel: string | null;
+    position: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface Quote {
+    id: string;
+    code: string;
+    channelId: string;
+    customerId: string;
+    currencyCode: string;
+    status: QuoteStatus;
+    expiresAt: string | null;
+    salesRepUserId: string | null;
+    customerNotes: string | null;
+    convertedOrderId: string | null;
+    lines: QuoteLine[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface QuoteList {
+    items: Quote[];
+    totalItems: number;
+}
+export interface QuoteListOptions {
+    take?: number;
+    skip?: number;
+    status?: QuoteStatus;
+}
+export interface CreateQuoteRequestInput {
+    items: Array<{
+        productVariantId: string;
+        quantity: number;
+    }>;
+    customerNotes?: string;
+}
+export interface B2bCreditStatus {
+    customerId: string;
+    currencyCode: string;
+    balance: number;
+    uninvoicedOrdersTotal: number;
+    exposure: number;
+    creditLimit: number | null;
+    available: number | null;
+    overdueInvoiceCount: number;
+    overLimit: boolean;
+    hasOverdue: boolean;
+}
 export interface VatValidationResult {
     status: string;
     vatNumber: string;
@@ -931,6 +1260,39 @@ export interface DeliveryOption {
     date: string;
     time: DeliveryTimeFrame[];
 }
+export interface PickupLocationAddress {
+    streetLine1: string;
+    number: string;
+    postalCode: string;
+    city: string;
+    countryCode: string;
+    region?: string;
+}
+export interface PickupLocationOpeningHours {
+    weekday: number;
+    open: string;
+    close: string;
+}
+export interface PickupLocation {
+    provider: string;
+    carrier: number;
+    locationCode: string;
+    name: string;
+    address: PickupLocationAddress;
+    openingHours?: PickupLocationOpeningHours[];
+    details?: Record<string, unknown>;
+}
+export interface PickupLocationSearchInput {
+    countryCode: string;
+    postalCode: string;
+    carrierId: number;
+    city?: string;
+    street?: string;
+    number?: string;
+    latitude?: number;
+    longitude?: number;
+    distance?: number;
+}
 export interface ShipmentTrackingHistoryEntry {
     status: number;
     time: string;
@@ -965,6 +1327,9 @@ export interface CommerceModule {
     getEligiblePaymentMethods(): Promise<PaymentMethod[]>;
     transitionToArrangingPayment(): Promise<Order>;
     addPayment(input: PaymentInput): Promise<Order>;
+    createStripePaymentIntent(options?: RequestOptions): Promise<StripePaymentIntentResult>;
+    getMolliePaymentMethods(input: MolliePaymentMethodsInput, options?: RequestOptions): Promise<MolliePaymentMethod[]>;
+    createMolliePaymentIntent(input: CreateMolliePaymentIntentInput, options?: RequestOptions): Promise<MolliePaymentIntentResult>;
     login(email: string, password: string): Promise<{
         id: string;
         identifier: string;
@@ -975,6 +1340,7 @@ export interface CommerceModule {
     logout(): Promise<void>;
     getCurrentCustomer(): Promise<Customer | null>;
     getCustomerOrders(options?: OrderListOptions): Promise<PaginatedList<OrderSummary>>;
+    reorder(orderCode: string): Promise<ReorderResult>;
     getCollections(listOptions?: CollectionListOptions, options?: RequestOptions): Promise<Collection[]>;
     getCollection(slug: string, options?: RequestOptions): Promise<CollectionDetail>;
     updateCustomer(input: UpdateCustomerInput): Promise<Customer>;
@@ -1006,6 +1372,8 @@ export interface CommerceModule {
     }): Promise<PaginatedList<FavoriteItem>>;
     toggleFavorite(productVariantId: string): Promise<boolean>;
     removeFavorite(productVariantId: string): Promise<boolean>;
+    subscribeToStockNotification(productVariantId: string, emailAddress?: string): Promise<StockNotificationSubscriptionResult>;
+    unsubscribeFromStockNotification(token: string): Promise<boolean>;
     getProductRecommendations(productId: string, groupSlug?: string): Promise<RecommendedProductGroup[]>;
     getAgeVerificationStatus(): Promise<AgeVerificationStatus>;
     submitDateOfBirth(dateOfBirth: string): Promise<AgeVerificationStatus>;
@@ -1015,6 +1383,7 @@ export interface CommerceModule {
         totalItems: number;
         nextCursor: string | null;
     }>;
+    getRecentProductReviews(options?: RecentReviewsOptions): Promise<ProductReview[]>;
     getReviewRatingSummary(productId: string): Promise<ReviewRatingSummary>;
     getReviewAttributeAggregations(productId: string): Promise<ReviewAttributeAggregation[]>;
     getReviewAttributes(productId?: string): Promise<ReviewAttribute[]>;
@@ -1027,16 +1396,32 @@ export interface CommerceModule {
     reportReview(reviewId: string, reason: string): Promise<boolean>;
     uploadReviewMedia(files: File[]): Promise<ReviewMediaUploadResult[]>;
     getMySubscriptions(): Promise<CustomerSubscription[]>;
+    pauseMySubscription(id: string, reason?: string): Promise<CustomerSubscription>;
+    resumeMySubscription(id: string): Promise<CustomerSubscription>;
+    cancelMySubscription(id: string, options?: {
+        reason?: string;
+        immediate?: boolean;
+    }): Promise<CustomerSubscription>;
+    getMyQuotes(options?: QuoteListOptions): Promise<QuoteList>;
+    getMyQuote(id: string): Promise<Quote | null>;
+    createQuoteRequest(input: CreateQuoteRequestInput): Promise<Quote>;
+    acceptQuote(id: string): Promise<Order>;
+    cancelMyQuote(id: string, reason?: string): Promise<Quote>;
     getMyVatValidationStatus(): Promise<VatValidationResult | null>;
     setMyVatNumber(vatNumber: string): Promise<VatValidationResult>;
     clearMyVatNumber(): Promise<boolean>;
     getDropOffPoints(input: DropOffPointInput): Promise<DropOffPoint[]>;
     getDeliveryOptions(input: DeliveryOptionsInput): Promise<DeliveryOption[]>;
     trackShipment(barcode: string, postalCode: string): Promise<ShipmentTrackingInfo | null>;
+    findPickupLocations(input: PickupLocationSearchInput): Promise<PickupLocation[]>;
+    selectPickupLocation(location: PickupLocation): Promise<Order>;
+    getActivePickupLocation(): Promise<PickupLocation | null>;
+    getBranding(options?: RequestOptions): Promise<BrandingInfo>;
 }
 export interface ContentModule {
     resolvePath(path: string, locale?: string, options?: RequestOptions): Promise<ResolvedContent>;
     getContent(queryOptions: ContentQueryOptions, options?: RequestOptions): Promise<Record<string, unknown>>;
+    searchContent(query: ContentSearchQuery, options?: RequestOptions): Promise<ContentSearchResult>;
     getAsset(id: string, options?: RequestOptions): Promise<CmsAsset>;
     lookupAssets(ids: string[], options?: RequestOptions): Promise<CmsAsset[]>;
     lookupVendureAssetDescriptions(vendureAssetIds: string[], options?: RequestOptions): Promise<Record<string, VendureAssetDescriptionTranslation[]>>;
@@ -1077,6 +1462,9 @@ export interface CurrencyModule {
     getExchangeRates(): Promise<ExchangeRate[]>;
     convertCurrency(amount: string, fromCurrency: string, toCurrency: string): Promise<ConvertedAmount>;
 }
+export interface CreditModule {
+    getCreditStatus(options?: RequestOptions): Promise<B2bCreditStatus | null>;
+}
 export interface StorefrontClient {
     readonly context: StoreContext;
     readonly commerce: CommerceModule;
@@ -1085,6 +1473,8 @@ export interface StorefrontClient {
     readonly pricing: PricingModule;
     readonly media: MediaModule;
     readonly currency: CurrencyModule;
+    readonly credit: CreditModule;
+    readonly seo: import('./seo/types.js').SeoModule;
     readonly maintenanceMode: boolean;
     setLanguage(code: string): void;
     getLanguage(): string;