@vindentech/api-client 0.3.0-next.26 → 0.3.0-next.28

package/dist/generated/index.schemas.d.ts

@@ -185,6 +185,11 @@ export interface OrderLegDto {
     legType: string;
     legSequence: number;
     status: string;
+    /**
+     * The cart_component_key this leg was placed under (e.g. move:pickup, move:delivery, material:delivery). Send this back as reschedule.componentKey to re-plan this leg. Null for a leg placed before component keys existed, or from a legacy single-component cart.
+     * @nullable
+     */
+    componentKey: string | null;
     /**
      * Assigned carrier (tenant_carrier_id).
      * @nullable
@@ -1864,9 +1869,9 @@ export interface CreateCartDto {
     cartType: CreateCartDtoCartType;
     /** Defaults to the caller's organization type; required for guests. */
     customerType?: CreateCartDtoCustomerType;
-    /** ISO 3166-1 alpha-2 */
+    /** ISO 3166-1 alpha-2. Fallback only: overridden by the target organization's active billing account, if it has one. */
     countryCode: string;
-    /** ISO 4217 */
+    /** ISO 4217. Fallback only: overridden by the target organization's active billing account, if it has one. */
     currencyCode: string;
     /** Staff create-on-behalf target organization. Ignored for org users (own org). */
     organizationId?: string;
@@ -1985,6 +1990,35 @@ export interface CartServiceDto {
     /** @nullable */
     metadata: CartServiceDtoMetadata;
 }
+export interface CartMerchandiseDto {
+    cartMerchandiseId: string;
+    tenantGoodsId: string;
+    quantity: number;
+    /** Provenance: CUSTOMER picked it, ESTIMATOR suggested it. */
+    source: string;
+    /**
+     * From the SKU.
+     * @nullable
+     */
+    code: string | null;
+    /**
+     * From the SKU.
+     * @nullable
+     */
+    name: string | null;
+    /**
+     * The SKU's display price ex VAT. Not what the quote charges — see `deferred`.
+     * @nullable
+     */
+    retailPriceExVat: string | null;
+    /** @nullable */
+    currencyCode: string | null;
+    /**
+     * Whether the SKU is still offered. False means it was deactivated after being basketed: the line is kept so nothing silently disappears, and it should be shown as unavailable.
+     * @nullable
+     */
+    isActive: boolean | null;
+}
 export interface CartHoldDto {
     reservationId: string;
     /** @nullable */
@@ -2062,6 +2096,8 @@ export interface CartDto {
     confirmedAt: string | null;
     items: CartItemDto[];
     services: CartServiceDto[];
+    /** The merchandise basket. Its prices are NOT in `rates.totals` yet — MERCHANDISE appears in `rates.deferred` until the quote prices it. */
+    merchandise: CartMerchandiseDto[];
     holds: CartHoldDto[];
     createdAt: string;
     updatedAt: string;
@@ -2205,7 +2241,7 @@ export interface QuoteResponseDto {
      */
     rutDeductionMinor: number | null;
     totals: QuoteTotalsDto;
-    /** Components present on the cart that this quote did not price, or reductions it did not apply. Their absence from `totals` is intentional, never a zero charge. Values: GOODS, SERVICE, START_FEE, TRANSPORT (no configured article, price row, or computable rate — no line is emitted at all), INSURANCE (no plan catalogue exists yet), TRANSPORT_PARTIAL (a transport line IS priced from the rate card but excludes a component the cart carries no quantity for — a per-hour rate with no `estimatedHours`, or a per-unit rate with no shipment manifest — so the transport amount is a floor, not the final charge), TRANSPORT_RUT (the line is RUT-eligible but its price source carries no post-deduction price to derive the amount from), MATERIAL_DELIVERY (the cart holds a material:delivery timeslot; its underlying slot may carry a real price, but materials pricing is not yet designed, so it is excluded from `totals` rather than priced as ordinary transport). */
+    /** Components present on the cart that this quote did not price, or reductions it did not apply. Their absence from `totals` is intentional, never a zero charge. Values: GOODS, SERVICE, START_FEE, TRANSPORT (no configured article, price row, or computable rate — no line is emitted at all), INSURANCE (no plan catalogue exists yet), TRANSPORT_PARTIAL (a transport line IS priced from the rate card but excludes a component the cart carries no quantity for — a per-hour rate with no `estimatedHours`, or a per-unit rate with no shipment manifest — so the transport amount is a floor, not the final charge), TRANSPORT_RUT (the line is RUT-eligible but its price source carries no post-deduction price to derive the amount from), MATERIAL_DELIVERY (the cart holds a material:delivery timeslot; its underlying slot may carry a real price, but materials pricing is not yet designed, so it is excluded from `totals` rather than priced as ordinary transport), MERCHANDISE (at least one basketed SKU could not be priced and is excluded from `totals` — it was deactivated after being basketed, it has no active price for today in the cart's currency, or its price rule is malformed. Priceable SKUs in the same basket still appear as MERCHANDISE lines, so this value means 'some of the basket is missing from the total', not 'none of it is priced'). */
     deferred: string[];
 }
 /**
@@ -2539,6 +2575,16 @@ export interface CartServiceInputDto {
     /** @nullable */
     metadata?: CartServiceInputDtoMetadata;
 }
+export interface CartMerchandiseInputDto {
+    /** A SKU from GET /v1/checkout/available-merchandise. */
+    tenantGoodsId: string;
+    /**
+     * Units of this SKU. Bounded above because the column is a 32-bit integer: an unbounded value validates in TypeScript and then overflows in Postgres.
+     * @minimum 1
+     * @maximum 1000
+     */
+    quantity: number;
+}
 export type UpdateCartDtoCustomerType = typeof UpdateCartDtoCustomerType[keyof typeof UpdateCartDtoCustomerType];
 export declare const UpdateCartDtoCustomerType: {
     readonly business: "business";
@@ -2629,6 +2675,8 @@ export interface UpdateCartDto {
     items?: CartItemInputDto[];
     /** Full reconcile of extra-service lines; same semantics as items. */
     services?: CartServiceInputDto[];
+    /** Full reconcile of the merchandise basket, keyed by tenantGoodsId: update the quantity of a SKU already present, insert one that is not, remove any SKU absent from the array. Omit the field to leave the basket untouched; send an empty array to clear it. The same SKU twice in one array is a 400 — a full desired set cannot contain a key twice, and collapsing silently would pick a quantity no rule documents. */
+    merchandise?: CartMerchandiseInputDto[];
 }
 export interface ClaimCartDto {
     /** Staff claim-on-behalf target organization. Org users always claim into their own organization. */
@@ -4447,10 +4495,15 @@ export interface ProductDto {
     /** @nullable */
     deliveryFrequency: string | null;
     /**
-     * Customer-facing note on the item, written by staff. The staff-only counterpart (internal_comment) is never projected here.
+     * Customer-facing note on the item, written by staff. See internalComment for its staff-only counterpart.
      * @nullable
      */
     comment: string | null;
+    /**
+     * Staff-only note on the item, written by staff. Scoped to the caller: platform/tenant-wide/warehouse staff see the real value; an organization user reads NULL here regardless of whether a note is set (mirrors how pendingDeliveryDate reads NULL for an order the caller cannot see).
+     * @nullable
+     */
+    internalComment: string | null;
     /** Permanently skips the pick-time GTIN prompt for this product. Set via POST /v1/products/:id/ignore-gtin (the pick-time "Skip GTIN" gesture) or the check-in edit command's ignoreGtin field; reset to false when check-in instead records a scanned boxGtin. */
     ignoreGtin: boolean;
     /**
@@ -4552,6 +4605,11 @@ export interface UpdateProductDto {
      * @nullable
      */
     comment?: string | null;
+    /**
+     * Staff-only note on the item. Null clears it. Rejected (403) if the caller is not platform/tenant-wide/warehouse staff, even though product:write is held by organization roles too.
+     * @nullable
+     */
+    internalComment?: string | null;
 }
 export interface ReplaceImageDto {
     /** Storage key of the new primary image (never base64). */
@@ -6781,6 +6839,21 @@ export interface InvoiceRowDto {
     currencyCode: string;
     /** @nullable */
     freeText: string | null;
+    /**
+     * Billing period start, for a row priced from a real period (e.g. a subscription month). Null for a point-in-time row (see servicedAt) or a correction row (credit_note/adjustment), which carries no period.
+     * @nullable
+     */
+    periodStart: string | null;
+    /**
+     * Billing period end; null under the same conditions as periodStart.
+     * @nullable
+     */
+    periodEnd: string | null;
+    /**
+     * The single day a point-in-time (event-sourced) row was serviced. Null for a real-period row (see periodStart/periodEnd) or a correction row.
+     * @nullable
+     */
+    servicedAt: string | null;
 }
 export interface InvoiceDetailDto {
     invoiceId: string;
@@ -7044,6 +7117,15 @@ export interface CreatePriceListItemDto {
     effectiveUntil?: string;
     changeReason?: string;
 }
+export interface EnabledCurrencyDto {
+    /** ISO 4217 currency code. */
+    currencyCode: string;
+    /** Used at billing_account creation when no currency is specified. */
+    isDefault: boolean;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
 export interface TenantBillingConfigDto {
     tenantBillingConfigId: string;
     tenantId: string;
@@ -7059,8 +7141,14 @@ export interface TenantBillingConfigDto {
     defaultBillingFrequencyId: string | null;
     autoChargeEnabled: boolean;
     requiresPricingApproval: boolean;
+    /**
+     * The tenant's own legal-entity registration number (e.g. Swedish orgnummer).
+     * @nullable
+     */
+    corporateIdentityNumber: string | null;
     createdAt: string;
     updatedAt: string;
+    enabledCurrencies: EnabledCurrencyDto[];
 }
 export interface UpdateTenantBillingConfigDto {
     defaultPaymentMethodId?: string;
@@ -7068,8 +7156,20 @@ export interface UpdateTenantBillingConfigDto {
     defaultBillingFrequencyId?: string;
     autoChargeEnabled?: boolean;
     requiresPricingApproval?: boolean;
+    /** The tenant's own legal-entity registration number (e.g. Swedish orgnummer). */
+    corporateIdentityNumber?: string;
     changeReason?: string;
 }
+export interface EnabledCurrencyInputDto {
+    /** ISO 4217 currency code. */
+    currencyCode: string;
+    /** Used at billing_account creation when no currency is specified. */
+    isDefault: boolean;
+    isActive: boolean;
+}
+export interface ReplaceEnabledCurrenciesDto {
+    currencies: EnabledCurrencyInputDto[];
+}
 export interface CustomerSubscriptionConfigDto {
     customerSubscriptionConfigId: string;
     tenantId: string;
@@ -7841,6 +7941,102 @@ export interface ApplyTemplateDto {
     effectiveUntil?: string;
     changeReason?: string;
 }
+/**
+ * Engine-shaped payload for this event (method-specific inputs — quantities, hours, per-line arrays already in the engine's expected keys).
+ */
+export type SimulatePricingEventDtoPayload = {
+    [key: string]: unknown;
+};
+export interface SimulatePricingEventDto {
+    basisPeriodStart: string;
+    basisPeriodEnd?: string;
+    /** Engine-shaped payload for this event (method-specific inputs — quantities, hours, per-line arrays already in the engine's expected keys). */
+    payload: SimulatePricingEventDtoPayload;
+}
+/**
+ * Template form values, per the template's uiFormSchema (e.g. { amount_minor: 49900 }).
+ */
+export type SimulatePricingDtoInput = {
+    [key: string]: unknown;
+};
+export interface SimulatePricingDto {
+    /** Built-in template code (see GET /billing/billing-model-templates). */
+    templateCode: string;
+    /** Article the priced amount would post to. */
+    articleId: string;
+    /** ISO 4217 currency code (must be enabled for the tenant). */
+    currencyCode: string;
+    /** Omit to preview the tenant-wide default; set to preview a per-customer override. */
+    billingAccountId?: string;
+    /** Template form values, per the template's uiFormSchema (e.g. { amount_minor: 49900 }). */
+    input: SimulatePricingDtoInput;
+    /** Synthetic events to price the expanded rule(s) against (1–50). */
+    events: SimulatePricingEventDto[];
+}
+export interface MatchedPricingRuleDto {
+    pricingRuleId: string;
+    calculationMethod: string;
+    ruleScope: string;
+    componentCode: string;
+    stage: number;
+    /** Whether this rule produced at least one basis row for any supplied event. */
+    matched: boolean;
+    /** @nullable */
+    resolutionError: string | null;
+}
+/**
+ * Calculation audit detail (method, inputs, cap/floor flags).
+ */
+export type SimulatedBasisRowDtoCalculationSnapshot = {
+    [key: string]: unknown;
+};
+export interface SimulatedBasisRowDto {
+    /** Index into the request's events[] that produced this row. */
+    eventIndex: number;
+    pricingRuleId: string;
+    articleId: string;
+    /** Quantity (numeric). */
+    quantity: number;
+    unitOfMeasureId: string;
+    unitCode: string;
+    /** @nullable */
+    unitPriceMinor: number | null;
+    /** Amount excl. VAT in minor currency units. */
+    amountExVatMinor: number;
+    /** Frozen article VAT percentage (e.g. 25). */
+    vatRate: number;
+    /** Pre-discount VAT in minor currency units. */
+    vatAmountMinor: number;
+    currencyCode: string;
+    ruleScope: string;
+    componentCode: string;
+    /** Calculation audit detail (method, inputs, cap/floor flags). */
+    calculationSnapshot: SimulatedBasisRowDtoCalculationSnapshot;
+}
+export interface ProjectedInvoiceRowDto {
+    articleId: string;
+    unitOfMeasureId: string;
+    vatRate: string;
+    currencyCode: string;
+    /** Quantity (numeric). */
+    quantity: number;
+    /** Amount excl. VAT in minor currency units. */
+    amountExVatMinor: number;
+    /** VAT amount in minor currency units, BEFORE discounts. */
+    vatAmountMinor: number;
+    rutEligible: boolean;
+    /** @nullable */
+    periodStart: string | null;
+    /** @nullable */
+    periodEnd: string | null;
+    /** @nullable */
+    servicedAt: string | null;
+}
+export interface SimulatePricingResponseDto {
+    matchedRules: MatchedPricingRuleDto[];
+    basisRows: SimulatedBasisRowDto[];
+    projectedInvoiceRowsBeforeDiscounts: ProjectedInvoiceRowDto[];
+}
 export interface BillableEventTypeDto {
     /** Canonical event_type key (e.g. picking_order_processed). */
     eventType: string;
@@ -9774,6 +9970,104 @@ export interface SimulationResultDto {
     /** This event's cutover mode for this tenant (05 §12 steps 4-5). `live` — the pipeline sends. `shadow` — it fans out and renders, then settles `skipped_shadow` without sending; the legacy message-service is still the system of record. `off` — Phase A discards the event and none of the verdicts above are written at all. Defaults to `shadow` when nobody has ruled on the event. */
     eventMode: SimulationResultDtoEventMode;
 }
+/**
+ * @nullable
+ */
+export type TenantGoodsDtoMetadata = {
+    [key: string]: unknown;
+} | null;
+export interface TenantGoodsDto {
+    tenantGoodsId: string;
+    tenantId: string;
+    /** Tenant-unique SKU code. */
+    code: string;
+    name: string;
+    /** @nullable */
+    description?: string | null;
+    /**
+     * Display price ex VAT (numeric column → string). Derived from the authoritative minor-unit price on the SKU's pricing rule, written in the same transaction, so the two cannot disagree.
+     * @nullable
+     */
+    retailPriceExVat?: string | null;
+    /** @nullable */
+    currencyCode?: string | null;
+    /** The billing.article this SKU prices through. Created by the SKU command; not caller-supplied. */
+    billingArticleId: string;
+    /** @nullable */
+    category?: string | null;
+    /** Whether the SKU is offered at checkout. Deactivating hides it from the catalogue and deliberately leaves its pricing rule active, so an order already placed still bills when it is delivered. */
+    isActive: boolean;
+    /** @nullable */
+    metadata?: TenantGoodsDtoMetadata;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Operational hints only.
+ */
+export type CreateTenantGoodsDtoMetadata = {
+    [key: string]: unknown;
+};
+export interface CreateTenantGoodsDto {
+    /** Tenant-unique SKU code, e.g. BOX-L. */
+    code: string;
+    name: string;
+    description?: string;
+    /**
+     * Price per unit ex VAT, in minor units (öre/cent). 0 is allowed — a free item still needs a rule so the sale produces an invoice line.
+     * @minimum 0
+     */
+    unitPriceExVatMinor: number;
+    /** ISO 4217. Required even though the SKU column is nullable: the pricing rule's currency is NOT NULL and must be enabled for the tenant (billing.tenant_enabled_currency), so a SKU without one could not be priced. */
+    currencyCode: string;
+    /** VAT rate for the SKU's article (numeric → string, e.g. 25.0000). Defaults to the article default of 25.0000 when omitted. */
+    vatRate?: string;
+    /** Date the price takes effect (YYYY-MM-DD). Defaults to today. The rule is open-ended until a later price change closes its window. */
+    effectiveFrom?: string;
+    category?: string;
+    /** Offered at checkout. Defaults to true. */
+    isActive?: boolean;
+    /** Operational hints only. */
+    metadata?: CreateTenantGoodsDtoMetadata;
+}
+export type UpdateTenantGoodsDtoMetadata = {
+    [key: string]: unknown;
+};
+export interface UpdateTenantGoodsDto {
+    name?: string;
+    description?: string;
+    /**
+     * New price per unit ex VAT in minor units. Equal to the current price is a no-op; different closes the live rule's window and opens a new one.
+     * @minimum 0
+     */
+    unitPriceExVatMinor?: number;
+    /** Date the new price takes effect (YYYY-MM-DD). Defaults to today. Must be strictly AFTER the live rule's effective_from: an earlier date would build an inverted date range and a same-day one an empty range, which the EXCLUDE constraint silently accepts and nothing can ever price. */
+    effectiveFrom?: string;
+    category?: string;
+    /** Offered at checkout. Setting false hides the SKU and leaves its pricing rule active on purpose, so an order already placed still bills on delivery. */
+    isActive?: boolean;
+    metadata?: UpdateTenantGoodsDtoMetadata;
+    /** Recorded on the pricing rule when the price changes. */
+    changeReason?: string;
+}
+export interface CheckoutMerchandiseDto {
+    /** Pass this as `tenantGoodsId` when basketing. */
+    tenantGoodsId: string;
+    /** Tenant-unique SKU code, e.g. BOX-L. */
+    code: string;
+    name: string;
+    /** @nullable */
+    description?: string | null;
+    /**
+     * Display price ex VAT (numeric column → string).
+     * @nullable
+     */
+    retailPriceExVat?: string | null;
+    /** @nullable */
+    currencyCode?: string | null;
+    /** @nullable */
+    category?: string | null;
+}
 export type OrdersControllerListV1Params = {
     /**
      * Max rows to return (1–100).
@@ -11168,4 +11462,30 @@ export declare const SenderIdentitiesControllerListV1Channel: {
     readonly push: "push";
     readonly webhook: "webhook";
 };
+export type MerchandiseControllerListTenantGoodsV1Params = {
+    /**
+     * Max rows to return (1–100).
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Rows to skip.
+     * @minimum 0
+     */
+    offset?: number;
+};
+export type MerchandiseCheckoutControllerAvailableMerchandiseV1Params = {
+    /**
+     * Max rows to return (1–100).
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Rows to skip.
+     * @minimum 0
+     */
+    offset?: number;
+};
 //# sourceMappingURL=index.schemas.d.ts.map