@sixtyninecommerce/admin 0.10.0 → 0.11.0

package/dist/integrations/exact-online-types.d.ts

@@ -0,0 +1,423 @@
+/**
+ * The shapes of `admin.integrations.exactOnline` (headless W10-55): the store's Exact Online
+ * connection, its settings, the read-only structure probes of the connected division, and the
+ * calls-per-day estimate of a sync schedule.
+ */
+/** When an order auto-pushes to Exact, by lifecycle event (`off`: never). */
+export type ExactAutoPushTrigger = 'off' | 'placed' | 'paid' | 'fulfilled';
+export interface ExactAutoPushRule {
+    customerGroupId: string;
+    trigger: ExactAutoPushTrigger;
+}
+/** The store's automatic order push, per customer group: the first rule naming a group wins. */
+export interface ExactAutoPushConfig {
+    /** Master switch: off, nothing auto-pushes whatever the rules say. */
+    enabled: boolean;
+    /** The trigger of a customer no rule names. */
+    defaultTrigger: ExactAutoPushTrigger;
+    rules: ExactAutoPushRule[];
+}
+/** Inbound account filter: sales accounts only, or every account. */
+export type ExactCustomerAccountFilter = 'sales' | 'all';
+/** Which side wins when a customer differs between Exact and the platform. */
+export type ExactCustomerOverwritePolicy = 'exact-authoritative' | 'last-writer-wins';
+/** The store's customer sync, both ways. */
+export interface ExactCustomerSyncConfig {
+    /** Master switch: off, neither direction runs. */
+    enabled: boolean;
+    /** Inbound: an Accounts webhook from Exact starts a customer sync. */
+    webhookEnabled: boolean;
+    /** Outbound: a customer edited here is pushed to its Exact Account. */
+    pushEnabled: boolean;
+    accountFilter: ExactCustomerAccountFilter;
+    overwritePolicy: ExactCustomerOverwritePolicy;
+    /** The outbound fields. */
+    fields: {
+        name: boolean;
+        email: boolean;
+        address: boolean;
+    };
+}
+/** A payment method of the store, mapped to the Exact condition orders paid with it carry. */
+export interface ExactPaymentMethodCondition {
+    paymentMethodId: string;
+    conditionCode: string;
+}
+/** Exact-owned customer payment terms. */
+export interface ExactPaymentTermsConfig {
+    /** The mirrored Exact condition is authoritative for checkout and pay-on-account orders. */
+    enabled: boolean;
+    /** Mirror Exact's conditions and assignments, without changing checkout or orders. */
+    synchronizationEnabled: boolean;
+    /** The condition a brand-new Account the platform creates in Exact gets; never an existing one. */
+    newAccountPaymentConditionCode: string | null;
+    /** Prepaid payment-method overrides, applied when an order's terms are captured. */
+    paymentMethodConditions: ExactPaymentMethodCondition[];
+}
+/** Exact-owned customer delivery profiles. */
+export interface ExactDeliveryTermsConfig {
+    enabled: boolean;
+    synchronizationEnabled: boolean;
+    /** Send the buyer's requested delivery day to Exact as the sales order's delivery date. */
+    forwardRequestedDeliveryDate: boolean;
+    /**
+     * Send where a pushed order ships as the sales order's delivery address. Optional here because
+     * a save that leaves it out keeps the stored switch; every read carries it.
+     */
+    sendDeliveryAddress?: boolean;
+    /** The defaults below seed only a brand-new Account the platform creates in Exact. */
+    newAccountShippingMethodId: string | null;
+    newAccountIncotermCode: string | null;
+    newAccountIncotermVersion: number | null;
+    newAccountIncotermAddress: string | null;
+    /** Dispatch lead time in days, not a promised arrival. Zero is valid. */
+    newAccountShippingLeadDays: number | null;
+    /** Exact's DeliveryAdvice: 0 partial, 1 complete, 2 partial without backorder. */
+    newAccountDeliveryAdvice: 0 | 1 | 2 | null;
+}
+/** One scheduled sweep: whether it runs, and the minutes between runs. */
+export interface ExactSyncWindow {
+    enabled: boolean;
+    intervalMinutes: number;
+}
+/** The store's scheduled Exact → platform sweeps, and the advisory daily call budget. */
+export interface ExactSyncSchedule {
+    /** Near-real-time price delta. */
+    delta: ExactSyncWindow;
+    /** Items, stock, warehouses, shipping methods and pictures: the full reconciler. */
+    full: ExactSyncWindow;
+    /** Inbound sales orders. */
+    order: ExactSyncWindow;
+    /** Inbound purchase orders, feeding incoming stock (storefront restock dates). */
+    purchaseOrders: ExactSyncWindow;
+    /** Prunes incoming stock of purchase orders deleted in Exact (the sweep above never sees one). */
+    purchaseOrdersReconcile: ExactSyncWindow;
+    /** Accounts and their payment conditions. */
+    customers: ExactSyncWindow;
+    /** B2B price agreements and named price lists: the integration's heaviest reads. */
+    priceLists: ExactSyncWindow;
+    /** Advisory only (0: none set); see {@link ExactSyncEstimate.overBudget}. */
+    dailyCallBudget: number;
+}
+/**
+ * A schedule to save or estimate. `delta`, `full`, `order` and the budget are always sent; a
+ * window left out keeps the stored one, an explicit `null` window its default.
+ */
+export interface ExactSyncScheduleInput {
+    delta: ExactSyncWindow;
+    full: ExactSyncWindow;
+    order: ExactSyncWindow;
+    purchaseOrders?: ExactSyncWindow | null;
+    purchaseOrdersReconcile?: ExactSyncWindow | null;
+    customers?: ExactSyncWindow | null;
+    priceLists?: ExactSyncWindow | null;
+    dailyCallBudget: number;
+}
+/** What the catalogue import does with an Exact item that is not a stock item. */
+export type ExactNonStockItemPolicy = 'public' | 'disabled' | 'skip';
+/** What the catalogue import does with an Exact item with no usable sales price. */
+export type ExactUnpricedItemPolicy = 'import' | 'disabled';
+/** The tax basis Exact's prices arrive in: as the store keeps them, net or gross. */
+export type ExactPriceBasis = 'channel' | 'net' | 'gross';
+/** Whether, and how, Exact item pictures become product images. */
+export type ExactPicturePolicy = 'off' | 'fill_missing' | 'exact_owns_featured';
+/** Which Exact stock figure becomes on-hand: In stock, or Free stock (minus reserved). */
+export type ExactStockBasis = 'in_stock' | 'free_stock';
+/**
+ * Which Exact items may become publicly visible storefront products. Every read carries the
+ * RESOLVED policy: a store that never saved one reads the engine's defaults.
+ */
+export interface ExactCatalogueImportPolicy {
+    /** Import only items whose Exact `IsWebshopItem` flag is set. */
+    requireWebshopFlag: boolean;
+    nonStockItems: ExactNonStockItemPolicy;
+    unpricedItems: ExactUnpricedItemPolicy;
+    priceBasis: ExactPriceBasis;
+    pictures: ExactPicturePolicy;
+    stockBasis: ExactStockBasis;
+}
+/**
+ * A catalogue-policy change, MERGED over the stored policy: a key left out keeps its value, an
+ * explicit `null` resets it to the default. Send only the keys that changed.
+ */
+export interface ExactCatalogueImportPolicyInput {
+    requireWebshopFlag?: boolean | null;
+    nonStockItems?: ExactNonStockItemPolicy | null;
+    unpricedItems?: ExactUnpricedItemPolicy | null;
+    priceBasis?: ExactPriceBasis | null;
+    pictures?: ExactPicturePolicy | null;
+    stockBasis?: ExactStockBasis | null;
+}
+/**
+ * The store's Exact Online connection and settings. The client secret, the webhook secret and
+ * the OAuth tokens are write-only: no read returns them in any form.
+ */
+export interface ExactOnlineConfig {
+    id: string;
+    /** The integration's runtime switch (the scheduled sweeps and automatic pushes follow it). */
+    enabled: boolean;
+    /** An Exact division is connected (OAuth) and its refresh token is held. */
+    connected: boolean;
+    /** Where the Exact administration lives: `nl`, `be`, `de`, `uk`, `fr`, `es` or `com`. */
+    region: string;
+    division: string | null;
+    companyName: string | null;
+    /** The store's own Exact app client id. */
+    clientId: string | null;
+    /** The store has stored its Exact app's client id AND secret: it can connect. */
+    hasCustomCredentials: boolean;
+    hasWebhookSecret: boolean;
+    lastConnectedAt: string | null;
+    lastRefreshedAt: string | null;
+    accessTokenExpiresAt: string | null;
+    /** The Exact item the shipping-cost line of a pushed sales order is booked on. */
+    shippingItemCode: string | null;
+    /** The Exact item a pushed order's promotion discount is booked on; null folds it into prices. */
+    discountItemCode: string | null;
+    /** The Exact item externally priced order lines are booked on. */
+    externalLineItemCode: string | null;
+    /** A pushed sales order carries the order's surcharges, one line each. */
+    pushSurcharges: boolean;
+    surchargeItemCode: string | null;
+    negativeSurchargeItemCode: string | null;
+    /** Advice (never a refusal) when surcharges push while auto-push sends orders early. */
+    pushSurchargesWarning: string | null;
+    autoPush: ExactAutoPushConfig;
+    customerSync: ExactCustomerSyncConfig;
+    paymentTerms: ExactPaymentTermsConfig;
+    deliveryTerms: ExactDeliveryTermsConfig;
+    syncSchedule: ExactSyncSchedule;
+    catalogueImportPolicy: ExactCatalogueImportPolicy;
+    /** When each sweep was last QUEUED (null: never); how it ended is in the sync log. */
+    deltaLastEnqueuedAt: string | null;
+    fullLastEnqueuedAt: string | null;
+    orderLastEnqueuedAt: string | null;
+    purchaseOrderLastEnqueuedAt: string | null;
+    purchaseOrderReconcileLastEnqueuedAt: string | null;
+    customerLastEnqueuedAt: string | null;
+    priceListLastEnqueuedAt: string | null;
+}
+/** A payment-terms section to save; `paymentMethodConditions` left out keeps the stored list. */
+export interface ExactPaymentTermsConfigInput {
+    enabled: boolean;
+    synchronizationEnabled?: boolean | null;
+    newAccountPaymentConditionCode?: string | null;
+    paymentMethodConditions?: ExactPaymentMethodCondition[] | null;
+}
+/** A delivery-terms section to save; `sendDeliveryAddress` left out keeps the stored switch. */
+export interface ExactDeliveryTermsConfigInput {
+    enabled: boolean;
+    synchronizationEnabled?: boolean | null;
+    forwardRequestedDeliveryDate?: boolean | null;
+    sendDeliveryAddress?: boolean | null;
+    newAccountShippingMethodId?: string | null;
+    newAccountIncotermCode?: string | null;
+    newAccountIncotermVersion?: number | null;
+    newAccountIncotermAddress?: string | null;
+    newAccountShippingLeadDays?: number | null;
+    newAccountDeliveryAdvice?: number | null;
+}
+/**
+ * A settings change: every key optional, a key left out keeps the stored value. `autoPush` and
+ * `customerSync` replace their whole setting (`null`: the default); `syncSchedule` and
+ * `catalogueImportPolicy` merge over the stored one. The OAuth connection and the app
+ * credentials have their own methods.
+ *
+ * `region`, `enabled`, `shippingItemCode`, `discountItemCode`, `paymentTerms` and `deliveryTerms`
+ * take no `null` (the engine cannot store one): the SDK refuses it before sending.
+ */
+export interface UpdateExactOnlineConfigInput {
+    region?: string;
+    enabled?: boolean;
+    /** Trimmed; blank clears it. */
+    shippingItemCode?: string;
+    /** Trimmed; blank clears it, folding promotions back into the line prices. */
+    discountItemCode?: string;
+    /** Trimmed; blank or `null` clears it; over 60 characters is refused `USER_INPUT_ERROR`. */
+    externalLineItemCode?: string | null;
+    /** `null` restores the default, off. */
+    pushSurcharges?: boolean | null;
+    /** Trimmed; blank or `null` clears it; over 60 characters is refused `USER_INPUT_ERROR`. */
+    surchargeItemCode?: string | null;
+    /** Trimmed; blank or `null` clears it; over 60 characters is refused `USER_INPUT_ERROR`. */
+    negativeSurchargeItemCode?: string | null;
+    autoPush?: ExactAutoPushConfig | null;
+    customerSync?: ExactCustomerSyncConfig | null;
+    paymentTerms?: ExactPaymentTermsConfigInput;
+    deliveryTerms?: ExactDeliveryTermsConfigInput;
+    syncSchedule?: ExactSyncScheduleInput | null;
+    catalogueImportPolicy?: ExactCatalogueImportPolicyInput | null;
+}
+/** The store's own Exact app, entered before connecting. */
+export interface SetExactOnlineCredentialsInput {
+    clientId: string;
+    /** Write-only. Left out, or blank, the stored secret stays. */
+    clientSecret?: string | null;
+    /** Write-only. Left out, or blank, the stored secret stays. */
+    webhookSecret?: string | null;
+}
+/** One CRM Account of the connected division, read live. */
+export interface ExactOnlineAccountPreview {
+    id: string;
+    code: string | null;
+    name: string | null;
+    city: string | null;
+    country: string | null;
+    email: string | null;
+    status: string | null;
+}
+/** One logistics Item of the connected division, read live. */
+export interface ExactOnlineItemPreview {
+    id: string;
+    code: string | null;
+    description: string | null;
+    isSalesItem: boolean | null;
+    isStockItem: boolean | null;
+}
+export interface ExactItemGroupStat {
+    code: string | null;
+    description: string | null;
+    itemCount: number;
+}
+export interface ExactClassFieldStat {
+    field: string;
+    nonEmptyCount: number;
+    distinctCount: number;
+}
+export interface ExactCatalogueRow {
+    code: string | null;
+    description: string | null;
+    itemGroup: string | null;
+}
+/** How the division's items group, for designing the item → product grouping rule. */
+export interface ExactCatalogueStructure {
+    sampledCount: number;
+    distinctItemGroupCount: number;
+    topItemGroups: ExactItemGroupStat[];
+    classFields: ExactClassFieldStat[];
+    rows: ExactCatalogueRow[];
+}
+export interface ExactClassificationValueStat {
+    id: string;
+    code: string | null;
+    description: string | null;
+    accountCount: number;
+}
+export interface ExactClassificationDimension {
+    sequence: number;
+    name: string;
+    slotField: string;
+    populatedCount: number;
+    distinctCount: number;
+    values: ExactClassificationValueStat[];
+}
+export interface ExactPriceListStat {
+    id: string;
+    code: string | null;
+    description: string | null;
+    accountCount: number;
+}
+export interface ExactAccountRow {
+    code: string | null;
+    name: string | null;
+    email: string | null;
+    city: string | null;
+    country: string | null;
+    isReseller: boolean;
+    classifications: string[];
+    priceList: string | null;
+}
+/** How the division's Accounts group, for designing the Account → customer group mapping. */
+export interface ExactAccountStructure {
+    sampledCount: number;
+    withEmail: number;
+    withoutEmail: number;
+    withAddress: number;
+    resellerCount: number;
+    dimensions: ExactClassificationDimension[];
+    priceLists: ExactPriceListStat[];
+    rows: ExactAccountRow[];
+}
+export interface ExactPriceListInfo {
+    id: string;
+    code: string | null;
+    description: string | null;
+    currency: string | null;
+}
+export interface ExactPriceListItemSample {
+    itemCode: string | null;
+    itemDescription: string | null;
+    quantity: number | null;
+    newPrice: number | null;
+    discount: number | null;
+    entryMethod: number | null;
+    /** `set`: the list defines its own base price for the item; `standard`: the item's own. */
+    basePrice: 'set' | 'standard';
+}
+export interface ExactCustomerPriceSample {
+    itemCode: string | null;
+    accountName: string | null;
+    price: number | null;
+    quantity: number | null;
+    currency: string | null;
+}
+/** Named price lists against per-customer item prices in the division. */
+export interface ExactPricingStructure {
+    priceLists: ExactPriceListInfo[];
+    priceListItemPriceCount: number;
+    priceListItemSamples: ExactPriceListItemSample[];
+    accountsWithDefaultPriceList: number;
+    customerPriceCount: number;
+    customerPriceDistinctAccounts: number;
+    customerPriceDistinctItems: number;
+    customerPriceSamples: ExactCustomerPriceSample[];
+    sampled: boolean;
+}
+/** One Exact webhook subscription live for the store. */
+export interface ExactWebhookSubscription {
+    topic: string;
+    subscriptionId: string | null;
+    callbackUrl: string | null;
+}
+/** The store's Exact webhook subscriptions, read live. */
+export interface ExactWebhookStatus {
+    /** A webhook secret is stored: real-time webhooks are possible. */
+    supported: boolean;
+    /** At least one of the platform's subscriptions is live in Exact. */
+    registered: boolean;
+    subscriptions: ExactWebhookSubscription[];
+    /** When this live read ran. */
+    checkedAt: string;
+    /** Set when the live read itself failed; the rest is then a best-effort answer. */
+    error: string | null;
+}
+/** One sweep's share of {@link ExactSyncEstimate}. */
+export interface ExactSyncSweepEstimate {
+    enabled: boolean;
+    /** The interval the estimate used: the one asked for, rounded and clamped (what a save stores). */
+    intervalMinutes: number;
+    minIntervalMinutes: number;
+    maxIntervalMinutes: number;
+    /** Representative Exact calls one run makes; a lower bound for the sweeps that page. */
+    callsPerRun: number;
+    /** Whole runs a day at `intervalMinutes`. */
+    runsPerDay: number;
+    /** `runsPerDay × callsPerRun`; 0 when the sweep is off. */
+    callsPerDay: number;
+}
+/** The Exact API calls a day a sync schedule makes. Advice: nothing is ever capped by it. */
+export interface ExactSyncEstimate {
+    delta: ExactSyncSweepEstimate;
+    full: ExactSyncSweepEstimate;
+    order: ExactSyncSweepEstimate;
+    purchaseOrders: ExactSyncSweepEstimate;
+    purchaseOrdersReconcile: ExactSyncSweepEstimate;
+    customers: ExactSyncSweepEstimate;
+    priceLists: ExactSyncSweepEstimate;
+    /** Every sweep's `callsPerDay`, summed. */
+    total: number;
+    /** The budget as a save stores it; 0 means none is set. */
+    dailyCallBudget: number;
+    /** A budget is set (above 0) and `total` exceeds it. */
+    overBudget: boolean;
+}

package/dist/integrations/exact-online-types.js

@@ -0,0 +1,6 @@
+/**
+ * The shapes of `admin.integrations.exactOnline` (headless W10-55): the store's Exact Online
+ * connection, its settings, the read-only structure probes of the connected division, and the
+ * calls-per-day estimate of a sync schedule.
+ */
+export {};