@vindentech/api-client 0.3.0-next.31 → 0.3.0-next.34

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

@@ -330,6 +330,16 @@ export interface OrderDetailDto {
     cancelledAt: string | null;
     /** @nullable */
     cancellationReason: string | null;
+    /**
+     * Whether the order is excluded from automatic billing (staff-only — null when the caller cannot see it, e.g. an org/warehouse/carrier caller).
+     * @nullable
+     */
+    manualBilling?: boolean | null;
+    /**
+     * Why the order is excluded from automatic billing (staff-only — null when the caller cannot see it, or when the order isn't flagged).
+     * @nullable
+     */
+    manualBillingComment?: string | null;
     /** @nullable */
     warehouse: OrderDetailDtoWarehouse;
     /** @nullable */
@@ -444,7 +454,7 @@ export interface EditOrderAddressDto {
 export interface RescheduleOrderDto {
     /** The cart_component_key of the leg to re-plan (e.g. move:pickup, move:delivery). */
     componentKey: string;
-    /** The new transport_slot to book. */
+    /** The new transport_slot to book. Releasing the old slot's capacity and consuming the new slot's happens atomically, in the same transaction as the rest of this edit — nothing changes if the new slot can't be booked. A destination slot with no room left fails the whole edit with 422 capacity_unavailable (not a 409); overbooking past a slot's cap is not possible. */
     timeslotId: string;
     /** Overrides the derived transport date; defaults to the new slot's date. */
     preferredDate?: string;
@@ -462,6 +472,7 @@ export interface EditOrderDto {
     couponCode?: string | null;
     /** Whether the order claims a RUT deduction. The identity number the claim is filed against is frozen at placement and has no edit path, so enabling RUT on an order placed without one leaves the claim without an identity number; disabling it leaves any stored number in place (removal belongs to the personal-data erasure path, not to this toggle). */
     rutDeduction?: boolean;
+    /** Re-plan the named leg onto a new slot. See RescheduleOrderDto.timeslotId for the release/consume atomicity and full-slot error contract. */
     reschedule?: RescheduleOrderDto;
 }
 export interface AssignOrderWarehouseDto {
@@ -494,6 +505,15 @@ export interface EditOrderItemsDto {
     /** Full desired set of product lines. Omit a stored line to remove it; an empty array removes all removable lines. */
     items: OrderItemInput[];
 }
+export interface SetManualBillingDto {
+    /** Whether the order is excluded from automatic billing. */
+    manualBilling: boolean;
+    /**
+     * Why the order is excluded from automatic billing. Required when manualBilling is true.
+     * @maxLength 2000
+     */
+    comment?: string;
+}
 export interface EstimateItemInputDto {
     /** What the customer calls the goods (free text). */
     reference: string;
@@ -757,6 +777,10 @@ export interface CancelOrderResultDto {
     cancellationReason?: string;
     /** Capacity reservations released by this cancel (may be empty). */
     releasedReservationIds: string[];
+    /** Other orders this cancel also cancelled, by cascade — a dependent job whose relationship type declares cancel_with_parent (today: the MERCHANDISE_SALE job of a checkout that carried a basket). Empty for an order with no such dependents. Present for the same reason as releasedReservationIds: the caller asked to cancel one order and has no other way to learn that a second one went with it. */
+    cascadeCancelledSalesOrderIds: string[];
+    /** This order's own transport legs cancelled by this call, plus any from a cancel_with_parent child (e.g. a separately-ordered material:delivery leg). Excludes a leg already COMPLETED/CANCELLED/FAILED. Empty for an order with no live legs. */
+    cancelledLegIds: string[];
 }
 export interface OrderGroupDto {
     orderGroupId: string;
@@ -2589,6 +2613,14 @@ export interface CartServiceInputDto {
     /** @nullable */
     metadata?: CartServiceInputDtoMetadata;
 }
+/**
+ * Where the line came from: CUSTOMER picked it out of the catalogue, ESTIMATOR means it came from a suggested basket the customer accepted or edited. PROVENANCE ONLY — analytics, not a fact. A client can claim either value, so it must never feed price or permission. Omitted on a resubmission leaves the stored value alone.
+ */
+export type CartMerchandiseInputDtoSource = typeof CartMerchandiseInputDtoSource[keyof typeof CartMerchandiseInputDtoSource];
+export declare const CartMerchandiseInputDtoSource: {
+    readonly CUSTOMER: "CUSTOMER";
+    readonly ESTIMATOR: "ESTIMATOR";
+};
 export interface CartMerchandiseInputDto {
     /** A SKU from GET /v1/checkout/available-merchandise. */
     tenantGoodsId: string;
@@ -2598,6 +2630,8 @@ export interface CartMerchandiseInputDto {
      * @maximum 1000
      */
     quantity: number;
+    /** Where the line came from: CUSTOMER picked it out of the catalogue, ESTIMATOR means it came from a suggested basket the customer accepted or edited. PROVENANCE ONLY — analytics, not a fact. A client can claim either value, so it must never feed price or permission. Omitted on a resubmission leaves the stored value alone. */
+    source?: CartMerchandiseInputDtoSource;
 }
 export type UpdateCartDtoCustomerType = typeof UpdateCartDtoCustomerType[keyof typeof UpdateCartDtoCustomerType];
 export declare const UpdateCartDtoCustomerType: {
@@ -2779,7 +2813,7 @@ export interface TransportSlotDto {
     /** @nullable */
     expressSurchargeExVat: string | null;
     /**
-     * Orders still bookable in this slot; null = unlimited
+     * Orders still bookable in this slot; null = unlimited. Computed live from confirmed and unexpired held reservations, so it's a point-in-time figure, not a hold — a booking or reschedule re-checks capacity when it runs, not against a previously-read value.
      * @nullable
      */
     remainingOrders: number | null;
@@ -4212,6 +4246,11 @@ export interface TransportLegDto {
     /** @nullable */
     carrierBooking?: TransportLegDtoCarrierBooking;
     shipmentUnits?: TransportLegShipmentUnitDto[];
+    /**
+     * The route this leg is currently a live stop on, or null if unrouted (within the caller's own route-scope visibility — a warehouse/carrier-scoped caller may see null for a leg routed outside their scope). Populated on list/detail reads.
+     * @nullable
+     */
+    routeId?: string | null;
 }
 export interface PaginatedTransportLegsDto {
     /** The page of rows. */
@@ -5426,6 +5465,23 @@ export interface DisposalRequestResultDto {
     /** True when this response replays a previous run of the key. */
     idempotent: boolean;
 }
+export interface DisposalHandlingFeeDto {
+    /**
+     * Fee amount ex-VAT, integer minor units (e.g. öre/cents). Null when not yet priced for this tenant.
+     * @nullable
+     */
+    amountExVatMinor: number | null;
+    /**
+     * VAT rate as a percentage (25 = 25%). Null when not yet priced for this tenant.
+     * @nullable
+     */
+    vatRate: number | null;
+    /**
+     * ISO 4217. Null when not yet priced for this tenant.
+     * @nullable
+     */
+    currencyCode: string | null;
+}
 export interface CancelDisposalRequestDto {
     /**
      * Why the request is being withdrawn.
@@ -10150,6 +10206,62 @@ export interface UpdateTenantGoodsDto {
     /** Recorded on the pricing rule when the price changes. */
     changeReason?: string;
 }
+/**
+ * Free-text note (e.g. a delivery note id).
+ * @nullable
+ */
+export type ReceiveStockDtoReason = {
+    [key: string]: unknown;
+} | null;
+export interface ReceiveStockDto {
+    /** Warehouse the stock arrived at. Must be one the caller is assigned to. */
+    warehouseId: string;
+    /**
+     * Units received. Unsigned — a receive can only add.
+     * @minimum 1
+     * @maximum 1000000
+     */
+    quantity: number;
+    /**
+     * Free-text note (e.g. a delivery note id).
+     * @nullable
+     */
+    reason?: ReceiveStockDtoReason;
+}
+export type StockMovementResultDtoMovementType = typeof StockMovementResultDtoMovementType[keyof typeof StockMovementResultDtoMovementType];
+export declare const StockMovementResultDtoMovementType: {
+    readonly RECEIVE: "RECEIVE";
+    readonly SELL: "SELL";
+    readonly ADJUST: "ADJUST";
+};
+export interface StockMovementResultDto {
+    tenantGoodsStockMovementId: string;
+    warehouseId: string;
+    movementType: StockMovementResultDtoMovementType;
+    /** Signed delta as recorded on the ledger. */
+    quantityDelta: number;
+    /** The warehouse's level after this movement. May be negative — see the adjust delta description. */
+    quantityAfter: number;
+    /** True when this call replayed a prior result for the same Idempotency-Key. */
+    idempotent: boolean;
+}
+export interface AdjustStockDto {
+    warehouseId: string;
+    /**
+     * Signed correction. Negative is allowed and may take the level below zero — merchandise stock is bookkeeping that never gates checkout, so a negative level is a real state ops resolve with a further adjustment, not an error.
+     * @minimum -1000000
+     * @maximum 1000000
+     */
+    delta: number;
+    /** Why the level changed. Required — a correction must explain itself. */
+    reason: string;
+}
+export interface StockLevelDto {
+    warehouseId: string;
+    /** Σ of the ledger's movements for this SKU/warehouse. */
+    quantity: number;
+    updatedAt: string;
+}
 export interface CheckoutMerchandiseDto {
     /** Pass this as `tenantGoodsId` when basketing. */
     tenantGoodsId: string;
@@ -10168,6 +10280,130 @@ export interface CheckoutMerchandiseDto {
     /** @nullable */
     category?: string | null;
 }
+export interface MerchandiseEstimateItemDto {
+    /**
+     * A `public.category` id from GET /v1/categories — the taxonomy of the customer's BELONGINGS (what is being moved), not the tenant's merchandise grouping. A category no rule mentions simply contributes nothing.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    categoryId: number;
+    /**
+     * How many items of this kind the customer is moving.
+     * @minimum 1
+     * @maximum 999
+     */
+    quantity: number;
+}
+export interface MerchandiseEstimateRequestDto {
+    /** One entry per kind of belongings, at most 100. The same category twice is folded into one entry with the summed quantity. */
+    items: MerchandiseEstimateItemDto[];
+}
+export interface MerchandiseEstimateLineDto {
+    /** 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;
+    /**
+     * Suggested units of this SKU, always at least 1. Editable — the customer may change or remove it before the basket is saved.
+     * @minimum 1
+     */
+    suggestedQuantity: number;
+}
+export interface MerchandiseEstimateRuleDto {
+    tenantGoodsEstimateRuleId: string;
+    /** `public.category` id — the customer's belongings. */
+    sourceCategoryId: number;
+    /** The merchandise SKU the rule suggests. */
+    tenantGoodsId: string;
+    /** Units of the SKU per item of the source category (numeric → string). */
+    quantityPerUnit: string;
+    /** Once-per-category baseline, added on top of the per-unit term. */
+    flatQuantity: number;
+    /** @nullable */
+    minQuantity?: number | null;
+    /** @nullable */
+    maxQuantity?: number | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateMerchandiseEstimateRuleDto {
+    /**
+     * A `public.category` id — the kind of belongings that triggers the suggestion. Keyed on the shared taxonomy the apps already send as `categoryId`, not on the tenant's free-text merchandise grouping.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    sourceCategoryId: number;
+    /** The merchandise SKU to suggest. */
+    tenantGoodsId: string;
+    /**
+     * Units of the SKU per item of the source category, up to 4 decimals. Fractions are the ordinary case (half a roll of tape per sofa) — the rounding happens once, over the whole suggestion for the SKU.
+     * @minimum 0
+     * @maximum 999999.9999
+     */
+    quantityPerUnit: number;
+    /**
+     * Once-per-category baseline. Together with quantityPerUnit this expresses both shapes the tenant needs: `x boxes → x + y boxes` is perUnit 1 with flat y, and `a sofa → n rolls` is perUnit n with flat 0. Defaults to 0.
+     * @minimum 0
+     * @maximum 10000
+     */
+    flatQuantity?: number;
+    /**
+     * Never suggest fewer than this when the category is present at all. Applied AFTER the arithmetic, so it also lifts a suggestion that resolved to zero. Omit for no floor.
+     * @minimum 0
+     * @maximum 10000
+     */
+    minQuantity?: number;
+    /**
+     * Never suggest more than this. Omit for no cap. When several matched rules disagree the strictest wins — the highest floor and the lowest cap.
+     * @minimum 0
+     * @maximum 10000
+     */
+    maxQuantity?: number;
+}
+export interface UpdateMerchandiseEstimateRuleDto {
+    /**
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    sourceCategoryId?: number;
+    tenantGoodsId?: string;
+    /**
+     * @minimum 0
+     * @maximum 999999.9999
+     */
+    quantityPerUnit?: number;
+    /**
+     * @minimum 0
+     * @maximum 10000
+     */
+    flatQuantity?: number;
+    /**
+     * Send null to remove the floor.
+     * @minimum 0
+     * @maximum 10000
+     * @nullable
+     */
+    minQuantity?: number | null;
+    /**
+     * Send null to remove the cap.
+     * @minimum 0
+     * @maximum 10000
+     * @nullable
+     */
+    maxQuantity?: number | null;
+}
 export interface ClientConfigKeycloakDto {
     /** Base URL of the Keycloak deployment serving this tenant. */
     url: string;
@@ -10195,6 +10431,15 @@ export interface ClientVersionDto {
     /** When true the app must block until the user upgrades. */
     forceUpgrade: boolean;
 }
+export interface ClientConfigMaintenanceDto {
+    /** Whether this client is currently in maintenance mode. */
+    enabled: boolean;
+    /**
+     * Operator message shown while in maintenance. Null when unset. This route is @Public() — world-readable, never an internal note.
+     * @nullable
+     */
+    message: string | null;
+}
 /**
  * The client this document was resolved for.
  */
@@ -10220,6 +10465,40 @@ export interface ClientConfigDto {
      * @nullable
      */
     clientVersion: ClientConfigDtoClientVersion;
+    /**
+     * Stripe publishable key for this tenant's account. Null when not configured.
+     * @nullable
+     */
+    stripePublishableKey: string | null;
+    /** This client's maintenance state. */
+    maintenance: ClientConfigMaintenanceDto;
+}
+export type TenantMaintenanceDtoClient = typeof TenantMaintenanceDtoClient[keyof typeof TenantMaintenanceDtoClient];
+export declare const TenantMaintenanceDtoClient: {
+    readonly customer_web: "customer_web";
+    readonly customer_app: "customer_app";
+    readonly admin_web: "admin_web";
+};
+export interface TenantMaintenanceDto {
+    client: TenantMaintenanceDtoClient;
+    /** Whether this client is currently in maintenance mode. */
+    enabled: boolean;
+    /**
+     * Operator message shown to the client while in maintenance. Null when unset. Rendered on the public GET /v1/config bootstrap — world-readable, not an internal note.
+     * @nullable
+     */
+    message: string | null;
+}
+export interface SetTenantMaintenanceModeDto {
+    /** Put this client into (true) or out of (false) maintenance mode. */
+    enabled: boolean;
+    /**
+     * Operator message shown to the client while in maintenance. Served on the public, unauthenticated GET /v1/config — do not put anything here a customer should not read.
+     * @nullable
+     */
+    message?: string | null;
+    /** Why this client is moving into or out of maintenance. Recorded in the admin action. */
+    reason: string;
 }
 export type OrdersControllerListV1Params = {
     /**
@@ -11649,6 +11928,19 @@ export type MerchandiseCheckoutControllerAvailableMerchandiseV1Params = {
      */
     offset?: number;
 };
+export type MerchandiseEstimateRulesControllerListV1Params = {
+    /**
+     * Max rows to return (1–100).
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Rows to skip.
+     * @minimum 0
+     */
+    offset?: number;
+};
 export type ClientConfigControllerGetV1Params = {
     /**
      * Which client is bootstrapping. Selects the Keycloak client id and version policy.