@vindentech/api-client 1.5.0 → 1.6.0-next.0

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

@@ -170,10 +170,20 @@ export interface OrderProductDto {
     salesOrderProductId: string;
     productId: string;
     /**
-       * Display name — the product's placeholder_name, falling back to name.
+       * Display name: the product's own name when it has one, otherwise its placeholder_name. A client that labels the line in the reader's language builds the label from `productName`, `categoryId` and `placeholderName` instead: `productName`, else the category's name in that language (GET /v1/categories), else `placeholderName`.
        * @nullable
        */
     name: string | null;
+    /**
+       * The product's own name (public.product.name). Null when the customer has not named it: the line is then labelled by its category.
+       * @nullable
+       */
+    productName: string | null;
+    /**
+       * The text the product was checked in with (public.product.placeholder_name): its label when it has neither a name nor a category.
+       * @nullable
+       */
+    placeholderName: string | null;
     /**
        * Storage key of the product's primary image (never base64).
        * @nullable
@@ -2671,6 +2681,21 @@ export interface CartItemDto {
     productId: string | null;
     /** @nullable */
     productReference: string | null;
+    /**
+       * The product's own name (public.product.name), on a line that stands for a product. Null when the customer has not named it, and on an estimate line. A product line is labelled by this name, else its category's name in the reader's language (`categoryId`, GET /v1/categories), else `placeholderName`.
+       * @nullable
+       */
+    productName: string | null;
+    /**
+       * The text the product was checked in with (public.product.placeholder_name). Null on an estimate line.
+       * @nullable
+       */
+    placeholderName: string | null;
+    /**
+       * The product's public.category id. Null when it has none, and on an estimate line.
+       * @nullable
+       */
+    categoryId: number | null;
     quantity: number;
     /** @nullable */
     lengthMm: number | null;
@@ -3800,7 +3825,7 @@ export interface UpdateTransportServiceDto {
     salesOrderType?: UpdateTransportServiceDtoSalesOrderType;
     fulfilmentMode?: UpdateTransportServiceDtoFulfilmentMode;
     /**
-       * Set null to make the service carrier-agnostic; a uuid to pin a carrier.
+       * Set null to make the service carrier-agnostic; a uuid to pin a carrier. Also points the service's slots whose window has not started at it, booked or not; an order already placed keeps its leg's carrier.
        * @nullable
        */
     tenantCarrierId?: string | null;
@@ -4027,7 +4052,7 @@ export declare const SlotConfigDtoSlotKind: {
     readonly PICKUP_WINDOW: "PICKUP_WINDOW";
 };
 /**
- * Per-weekday window schedule, returned as written (each window's base_max_orders, express_surcharge_ex_vat or express_surcharge_per_m3_ex_vat, and order_cutoff_lead_minutes included). A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. It applies to slots generated afterwards; existing slots keep their cutoff unless regenerated. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier.
+ * Per-weekday window schedule, returned as written (each window's base_max_orders, express_surcharge_ex_vat or express_surcharge_per_m3_ex_vat, and order_cutoff_lead_minutes included). A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. A PATCH that changes a window's start or its effective lead also re-derives the cutoff of the config's slots whose window has not started, booked or not; a slot no window matches keeps its cutoff. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier; an order already placed keeps its editable_until at the edit.
  * @nullable
  */
 export type SlotConfigDtoWeeklySchedule = {
@@ -4048,7 +4073,7 @@ export interface SlotConfigDto {
     slotKind: SlotConfigDtoSlotKind;
     timezone: string;
     /**
-       * Per-weekday window schedule, returned as written (each window's base_max_orders, express_surcharge_ex_vat or express_surcharge_per_m3_ex_vat, and order_cutoff_lead_minutes included). A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. It applies to slots generated afterwards; existing slots keep their cutoff unless regenerated. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier.
+       * Per-weekday window schedule, returned as written (each window's base_max_orders, express_surcharge_ex_vat or express_surcharge_per_m3_ex_vat, and order_cutoff_lead_minutes included). A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. A PATCH that changes a window's start or its effective lead also re-derives the cutoff of the config's slots whose window has not started, booked or not; a slot no window matches keeps its cutoff. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier; an order already placed keeps its editable_until at the edit.
        * @nullable
        */
     weeklySchedule: SlotConfigDtoWeeklySchedule;
@@ -4065,7 +4090,7 @@ export interface SlotConfigDto {
        */
     dayMaxWeightG: number | null;
     generateHorizonDays: number;
-    /** Each generated slot's order_cutoff_at = window_start − this many minutes (0077), unless its weekly_schedule window sets its own order_cutoff_lead_minutes. */
+    /** Each generated slot's order_cutoff_at = window_start − this many minutes (0077), unless its weekly_schedule window sets its own order_cutoff_lead_minutes. A PATCH that changes it re-derives the cutoff of the config's slots whose window has not started and that inherit it. */
     orderCutoffLeadMinutes: number;
     status: string;
     createdAt: string;
@@ -4091,7 +4116,7 @@ export declare const CreateSlotConfigDtoSlotKind: {
     readonly PICKUP_WINDOW: "PICKUP_WINDOW";
 };
 /**
- * Per-weekday windows (incl. per-slot base_max_orders / express_surcharge_ex_vat / express_surcharge_per_m3_ex_vat / order_cutoff_lead_minutes). express_surcharge_ex_vat (>= 0) is added once per order on top of the price book's base price; express_surcharge_per_m3_ex_vat (>= 0) instead adds that much per m³ the order's transport bills. A window sets at most one of the two (both is a 400). A window carries no price of its own: price_ex_vat is refused. A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. It applies to slots generated afterwards; existing slots keep their cutoff unless regenerated. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier. NULL = daily-cap-only.
+ * Per-weekday windows (incl. per-slot base_max_orders / express_surcharge_ex_vat / express_surcharge_per_m3_ex_vat / order_cutoff_lead_minutes). express_surcharge_ex_vat (>= 0) is added once per order on top of the price book's base price; express_surcharge_per_m3_ex_vat (>= 0) instead adds that much per m³ the order's transport bills. A window sets at most one of the two (both is a 400). A window carries no price of its own: price_ex_vat is refused. A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. A PATCH that changes a window's start or its effective lead also re-derives the cutoff of the config's slots whose window has not started, booked or not; a slot no window matches keeps its cutoff. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier; an order already placed keeps its editable_until at the edit. NULL = daily-cap-only.
  */
 export type CreateSlotConfigDtoWeeklySchedule = {
     [key: string]: unknown;
@@ -4102,7 +4127,7 @@ export interface CreateSlotConfigDto {
     /** NULL = daily-cap-only (no concrete slots). */
     slotKind?: CreateSlotConfigDtoSlotKind;
     timezone?: string;
-    /** Per-weekday windows (incl. per-slot base_max_orders / express_surcharge_ex_vat / express_surcharge_per_m3_ex_vat / order_cutoff_lead_minutes). express_surcharge_ex_vat (>= 0) is added once per order on top of the price book's base price; express_surcharge_per_m3_ex_vat (>= 0) instead adds that much per m³ the order's transport bills. A window sets at most one of the two (both is a 400). A window carries no price of its own: price_ex_vat is refused. A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. It applies to slots generated afterwards; existing slots keep their cutoff unless regenerated. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier. NULL = daily-cap-only. */
+    /** Per-weekday windows (incl. per-slot base_max_orders / express_surcharge_ex_vat / express_surcharge_per_m3_ex_vat / order_cutoff_lead_minutes). express_surcharge_ex_vat (>= 0) is added once per order on top of the price book's base price; express_surcharge_per_m3_ex_vat (>= 0) instead adds that much per m³ the order's transport bills. A window sets at most one of the two (both is a 400). A window carries no price of its own: price_ex_vat is refused. A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. A PATCH that changes a window's start or its effective lead also re-derives the cutoff of the config's slots whose window has not started, booked or not; a slot no window matches keeps its cutoff. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier; an order already placed keeps its editable_until at the edit. NULL = daily-cap-only. */
     weeklySchedule?: CreateSlotConfigDtoWeeklySchedule;
     dayMaxOrders?: number;
     /** bigint */
@@ -4110,7 +4135,7 @@ export interface CreateSlotConfigDto {
     /** bigint */
     dayMaxWeightG?: string;
     generateHorizonDays?: number;
-    /** Each generated slot's order_cutoff_at = window_start − this many minutes (0077), unless its weekly_schedule window sets its own order_cutoff_lead_minutes. */
+    /** Each generated slot's order_cutoff_at = window_start − this many minutes (0077), unless its weekly_schedule window sets its own order_cutoff_lead_minutes. A PATCH that changes it re-derives the cutoff of the config's slots whose window has not started and that inherit it. */
     orderCutoffLeadMinutes?: number;
     status?: string;
 }
@@ -4121,7 +4146,7 @@ export declare const UpdateSlotConfigDtoSlotKind: {
     readonly PICKUP_WINDOW: "PICKUP_WINDOW";
 };
 /**
- * Per-weekday windows, replacing the stored schedule; the window shape is create's. A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. It applies to slots generated afterwards; existing slots keep their cutoff unless regenerated. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier.
+ * Per-weekday windows, replacing the stored schedule; the window shape is create's. A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. A PATCH that changes a window's start or its effective lead also re-derives the cutoff of the config's slots whose window has not started, booked or not; a slot no window matches keeps its cutoff. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier; an order already placed keeps its editable_until at the edit.
  */
 export type UpdateSlotConfigDtoWeeklySchedule = {
     [key: string]: unknown;
@@ -4131,7 +4156,7 @@ export interface UpdateSlotConfigDto {
     serviceZoneId?: string;
     slotKind?: UpdateSlotConfigDtoSlotKind;
     timezone?: string;
-    /** Per-weekday windows, replacing the stored schedule; the window shape is create's. A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. It applies to slots generated afterwards; existing slots keep their cutoff unless regenerated. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier. */
+    /** Per-weekday windows, replacing the stored schedule; the window shape is create's. A window's order_cutoff_lead_minutes (a JSON integer >= 0; absent or null = the config's orderCutoffLeadMinutes) is its own booking cutoff: its slots' order_cutoff_at = window_start − this many minutes, counted as elapsed time, so across a DST change the wall-clock cutoff moves by an hour. A PATCH that changes a window's start or its effective lead also re-derives the cutoff of the config's slots whose window has not started, booked or not; a slot no window matches keeps its cutoff. An order's editable_until is the earliest cutoff of its held slots, so a stricter window also closes order editing earlier; an order already placed keeps its editable_until at the edit. */
     weeklySchedule?: UpdateSlotConfigDtoWeeklySchedule;
     dayMaxOrders?: number;
     /** bigint */
@@ -4139,7 +4164,7 @@ export interface UpdateSlotConfigDto {
     /** bigint */
     dayMaxWeightG?: string;
     generateHorizonDays?: number;
-    /** Each generated slot's order_cutoff_at = window_start − this many minutes (0077), unless its weekly_schedule window sets its own order_cutoff_lead_minutes. */
+    /** Each generated slot's order_cutoff_at = window_start − this many minutes (0077), unless its weekly_schedule window sets its own order_cutoff_lead_minutes. A PATCH that changes it re-derives the cutoff of the config's slots whose window has not started and that inherit it. */
     orderCutoffLeadMinutes?: number;
     status?: string;
 }
@@ -5360,7 +5385,7 @@ export interface ProductDto {
     productId: string;
     organizationId: string;
     /**
-       * Catalogued product name
+       * The customer's own name for the product. Null when it has none: it is then labelled by its category's name in the reader's language (`categoryId`, GET /v1/categories), else by `placeholderName`.
        * @nullable
        */
     name: string | null;
@@ -5480,7 +5505,7 @@ export interface CreateProductDto {
     /** The owning organization (server validates the caller's scope over it). */
     organizationId: string;
     /**
-       * Catalogued product name
+       * The customer's own name for the product. Stored trimmed; a blank name is stored as null, and the product is then labelled by its category.
        * @maxLength 255
        */
     name: string;
@@ -5511,8 +5536,11 @@ export interface CreateProductDto {
     comment?: string;
 }
 export interface UpdateProductDto {
-    /** Catalogued product name */
-    name?: string;
+    /**
+       * The customer's own name for the product. Stored trimmed; a blank name or an explicit null clears it, and the product is then labelled by its category.
+       * @nullable
+       */
+    name?: string | null;
     categoryId?: number;
     /**
        * Move the item into this folder (same organization). Explicit null moves it back to the storage root; omit to leave the folder unchanged.
@@ -14094,7 +14122,7 @@ export type ProductsControllerListV1Params = {
      */
     rootOnly?: boolean;
     /**
-     * Case-insensitive substring search over product name and external reference (accelerated by the pg_trgm GIN indexes)
+     * Case-insensitive substring search over the product's name, placeholder name and external reference, and its category's name in every language (so an unnamed product is found by the category that labels it)
      * @maxLength 200
      */
     search?: string;
@@ -14121,7 +14149,7 @@ export type ProductsControllerStatsV1Params = {
      */
     rootOnly?: boolean;
     /**
-     * Case-insensitive substring search over product name and external reference (accelerated by the pg_trgm GIN indexes)
+     * Case-insensitive substring search over the product's name, placeholder name and external reference, and its category's name in every language (so an unnamed product is found by the category that labels it)
      * @maxLength 200
      */
     search?: string;