@vindentech/api-client 0.3.0-next.81 → 0.3.0-next.83

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

@@ -2097,6 +2097,11 @@ export interface MeOrganizationDto {
        * @nullable
        */
     countryCode: string | null;
+    /**
+       * The language this account's order emails and invoices are written in. null = not stated: the language follows the billing account's country (SE → sv-SE, FI → fi-FI, otherwise en-GB).
+       * @nullable
+       */
+    preferredLocale: string | null;
     /** Service tier of the account. PRO is the 3PL / Receive & Distribute tier; CORE is the default. A display hint for client-side feature gating only — no endpoint enforces it server-side, so a CORE account can still reach PRO-tier routes it otherwise has permission for. */
     serviceTier: MeOrganizationDtoServiceTier;
     /**
@@ -2214,6 +2219,15 @@ export interface OnboardingStatusDto {
     /** When status is token_refresh_required, the client must perform an OIDC refresh, replace both tokens, and call status again. A page reload is not a refresh. */
     tokenRefreshRequired: boolean;
 }
+/**
+ * The language the customer chose: stored as the new organization's preferredLocale, the language of its order emails and invoices. Omitted means not stated, and the language follows the billing country. Applied only when the organization is created; change it later with PATCH /v1/me/organization.
+ */
+export type OnboardMeDtoPreferredLocale = typeof OnboardMeDtoPreferredLocale[keyof typeof OnboardMeDtoPreferredLocale];
+export declare const OnboardMeDtoPreferredLocale: {
+    readonly 'sv-SE': "sv-SE";
+    readonly 'en-GB': "en-GB";
+    readonly 'fi-FI': "fi-FI";
+};
 export interface OnboardMeDto {
     /** Terms-of-service version the caller accepted. */
     termsVersion: string;
@@ -2224,6 +2238,13 @@ export interface OnboardMeDto {
        * @maxLength 200
        */
     displayName?: string;
+    /** The language the customer chose: stored as the new organization's preferredLocale, the language of its order emails and invoices. Omitted means not stated, and the language follows the billing country. Applied only when the organization is created; change it later with PATCH /v1/me/organization. */
+    preferredLocale?: OnboardMeDtoPreferredLocale;
+    /**
+       * The customer's billing country, ISO-3166-1 alpha-2 in uppercase: stored as the new organization's invoice country and its billing account's country. Omitted means the tenant's own country. Applied only when the organization is created; change it later with PATCH /v1/billing/invoice-details.
+       * @pattern ^[A-Z]{2}$
+       */
+    countryCode?: string;
 }
 /**
  * Opaque per-user preferences object (JSON object, ≤ 16 KB serialized); null clears it.
@@ -2262,6 +2283,23 @@ export interface UpdateMeDto {
        */
     preferences?: UpdateMeDtoPreferences;
 }
+/**
+ * The language this account's order emails and invoices are written in. null = not stated: the language follows the billing account's country (SE → sv-SE, FI → fi-FI, otherwise en-GB).
+ * @nullable
+ */
+export type UpdateMeOrganizationDtoPreferredLocale = typeof UpdateMeOrganizationDtoPreferredLocale[keyof typeof UpdateMeOrganizationDtoPreferredLocale] | null;
+export declare const UpdateMeOrganizationDtoPreferredLocale: {
+    readonly 'sv-SE': "sv-SE";
+    readonly 'en-GB': "en-GB";
+    readonly 'fi-FI': "fi-FI";
+};
+export interface UpdateMeOrganizationDto {
+    /**
+       * The language this account's order emails and invoices are written in. null = not stated: the language follows the billing account's country (SE → sv-SE, FI → fi-FI, otherwise en-GB).
+       * @nullable
+       */
+    preferredLocale?: UpdateMeOrganizationDtoPreferredLocale;
+}
 export interface UpdateIdentityNumberDto {
     /** Swedish personal identity number — YYMMDDNNNN, YYMMDD-NNNN, YYMMDD+NNNN, YYYYMMDDNNNN or YYYYMMDD-NNNN, with a valid Luhn check digit. Stored digits-only. Never returned by any endpoint. */
     personalIdentityNumber: string;
@@ -2436,6 +2474,12 @@ export interface CartLocationDto {
     latitude: string | null;
     /** @nullable */
     longitude: string | null;
+    /** @nullable */
+    doorCode: string | null;
+    /** @nullable */
+    stairwell: string | null;
+    /** @nullable */
+    apartmentNumber: string | null;
 }
 /**
  * @nullable
@@ -2472,6 +2516,12 @@ export interface CartDeliveryLocationDto {
     /** @nullable */
     longitude: string | null;
     /** @nullable */
+    doorCode: string | null;
+    /** @nullable */
+    stairwell: string | null;
+    /** @nullable */
+    apartmentNumber: string | null;
+    /** @nullable */
     servicePointId: string | null;
     /** @nullable */
     servicePointProvider: CartDeliveryLocationDtoServicePointProvider;
@@ -2897,6 +2947,24 @@ export interface CartLocationInputDto {
        * @nullable
        */
     longitude?: number | null;
+    /**
+       * Door or entry code at the address. Copied onto this side's transport legs at placement.
+       * @maxLength 64
+       * @nullable
+       */
+    doorCode?: string | null;
+    /**
+       * Staircase within the building (e.g. A, B). Copied onto this side's transport legs at placement.
+       * @maxLength 64
+       * @nullable
+       */
+    stairwell?: string | null;
+    /**
+       * Apartment or unit within the building (e.g. 12, 1102). Copied onto this side's transport legs at placement.
+       * @maxLength 64
+       * @nullable
+       */
+    apartmentNumber?: string | null;
 }
 /**
  * Required alongside servicePointId.
@@ -2950,7 +3018,25 @@ export interface CartDeliveryLocationInputDto {
        */
     longitude?: number | null;
     /**
-       * Opaque provider-specific id; requires servicePointProvider alongside it.
+       * Door or entry code at the address. Copied onto this side's transport legs at placement.
+       * @maxLength 64
+       * @nullable
+       */
+    doorCode?: string | null;
+    /**
+       * Staircase within the building (e.g. A, B). Copied onto this side's transport legs at placement.
+       * @maxLength 64
+       * @nullable
+       */
+    stairwell?: string | null;
+    /**
+       * Apartment or unit within the building (e.g. 12, 1102). Copied onto this side's transport legs at placement.
+       * @maxLength 64
+       * @nullable
+       */
+    apartmentNumber?: string | null;
+    /**
+       * Opaque provider-specific id; requires servicePointProvider alongside it. Placement still requires the delivery address (addressLine1, zipCode, city) and a contact phone: the provider puts the receiver's own address and mobile on the parcel and sends the arrival notice to that phone.
        * @nullable
        */
     servicePointId?: string | null;
@@ -3141,15 +3227,25 @@ export interface SlotPriceDto {
     /** @nullable */
     baseFeeExVat?: string | null;
     /**
-       * Money, ex VAT: what the slot's service zone adds ON TOP of the base transport price — show it as "+X". Null when the cart would add none: the slot has no zone of its own (a pooled slot), or no zone surcharge rule lists the slot's zone above 0.
+       * Money, ex VAT: what the slot's service zone adds ON TOP of the base transport price — show it as "+X". Null when the cart would add none: the slot has no zone of its own (a pooled slot), no zone surcharge rule lists the slot's zone above 0, or the zone is priced per m³ (zoneSurchargePerM3ExVat).
        * @nullable
        */
     zoneSurchargeExVat: string | null;
     /**
-       * Money, ex VAT: what this window adds ON TOP of the base transport price — show it as "+X". Null when the cart would add none: the window carries no surcharge, or no pricing rule bills it.
+       * Money per m³, ex VAT: what the slot's service zone adds ON TOP of the base transport price for each m³ the order's transport bills, after its minimum billable volumes — show it as "+X/m³". Null when the zone adds nothing per m³; never set beside zoneSurchargeExVat.
+       * @nullable
+       */
+    zoneSurchargePerM3ExVat: string | null;
+    /**
+       * Money, ex VAT: what this window adds ON TOP of the base transport price — show it as "+X". Null when the cart would add none: the window carries no surcharge, no pricing rule bills it, or the window is priced per m³ (windowSurchargePerM3ExVat).
        * @nullable
        */
     windowSurchargeExVat: string | null;
+    /**
+       * Money per m³, ex VAT: what this window adds ON TOP of the base transport price for each m³ the order's transport bills, after its minimum billable volumes — show it as "+X/m³". Null when the window adds nothing per m³ or no pricing rule bills it; never set beside windowSurchargeExVat.
+       * @nullable
+       */
+    windowSurchargePerM3ExVat: string | null;
     /** @nullable */
     vatRate: string | null;
     /** @nullable */
@@ -3685,7 +3781,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 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. 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.
  * @nullable
  */
 export type SlotConfigDtoWeeklySchedule = {
@@ -3706,7 +3802,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 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. 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.
        * @nullable
        */
     weeklySchedule: SlotConfigDtoWeeklySchedule;
@@ -3749,7 +3845,7 @@ export declare const CreateSlotConfigDtoSlotKind: {
     readonly PICKUP_WINDOW: "PICKUP_WINDOW";
 };
 /**
- * Per-weekday windows (incl. per-slot base_max_orders / express_surcharge_ex_vat / order_cutoff_lead_minutes). express_surcharge_ex_vat (>= 0) is added on top of the price book's base price. 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. 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.
  */
 export type CreateSlotConfigDtoWeeklySchedule = {
     [key: string]: unknown;
@@ -3760,7 +3856,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 / order_cutoff_lead_minutes). express_surcharge_ex_vat (>= 0) is added on top of the price book's base price. 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. 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. */
     weeklySchedule?: CreateSlotConfigDtoWeeklySchedule;
     dayMaxOrders?: number;
     /** bigint */
@@ -3942,6 +4038,11 @@ export interface SlotDto {
        * @nullable
        */
     expressSurchargeExVat: string | null;
+    /**
+       * money per m³ — the window surcharge priced per m³: what this window adds on top of the price book's base price for each m³ the order's transport bills, after its minimum billable volumes (>= 0), in the order's currency. Never set beside expressSurchargeExVat.
+       * @nullable
+       */
+    expressSurchargePerM3ExVat: string | null;
     status: string;
     manuallyClosed: boolean;
     /** @nullable */
@@ -4001,8 +4102,10 @@ export declare const PatchSlotDtoStatus: {
 export interface PatchSlotDto {
     status?: PatchSlotDtoStatus;
     manuallyClosed?: boolean;
-    /** money — the window surcharge, added on top of the price book's base price; never negative. */
+    /** money — the window surcharge, added once per order on top of the price book's base price; never negative. Setting it clears expressSurchargePerM3ExVat: a window has one surcharge. */
     expressSurchargeExVat?: string;
+    /** money per m³ — the window surcharge priced per m³ of the order's billed transport volume, in place of expressSurchargeExVat; never negative. Setting it clears expressSurchargeExVat, and setting both in one request is a 400. */
+    expressSurchargePerM3ExVat?: string;
     windowStart?: string;
     windowEnd?: string;
     orderCutoffAt?: string;
@@ -4078,6 +4181,11 @@ export interface SlotWithAvailabilityDto {
        * @nullable
        */
     expressSurchargeExVat: string | null;
+    /**
+       * money per m³ — the window surcharge priced per m³: what this window adds on top of the price book's base price for each m³ the order's transport bills, after its minimum billable volumes (>= 0), in the order's currency. Never set beside expressSurchargeExVat.
+       * @nullable
+       */
+    expressSurchargePerM3ExVat: string | null;
     status: string;
     manuallyClosed: boolean;
     /** @nullable */
@@ -6035,6 +6143,68 @@ export interface DisposalRequestResultDto {
     /** True when this response replays a previous run of the key. */
     idempotent: boolean;
 }
+export type QuoteDisposalRequestDtoType = typeof QuoteDisposalRequestDtoType[keyof typeof QuoteDisposalRequestDtoType];
+export declare const QuoteDisposalRequestDtoType: {
+    readonly RECYCLE: "RECYCLE";
+    readonly DONATE: "DONATE";
+};
+export interface QuoteDisposalRequestDto {
+    /** The owning org (server validates scope). */
+    organizationId: string;
+    type: QuoteDisposalRequestDtoType;
+    /** The warehouse holding the goods, as on the request itself. */
+    warehouseId: string;
+    /** At least one line. */
+    products: WarehouseOrderProductLineDto[];
+}
+export interface DisposalRequestQuoteLineDto {
+    /** The pricing component, e.g. recycling_fee. */
+    componentCode: string;
+    /** Items or m³, per unitCode. */
+    quantity: number;
+    /** unit_of_measure code of the rule, e.g. each or m3_month. */
+    unitCode: string;
+    /**
+       * Minor units, ex VAT.
+       * @nullable
+       */
+    unitPriceExVatMinor: number | null;
+    /** Minor units, ex VAT. */
+    totalExVatMinor: number;
+    /** VAT percentage, e.g. 25.5. */
+    vatRate: number;
+    /** Minor units. */
+    vatAmountMinor: number;
+}
+export type DisposalRequestQuoteResultDtoType = typeof DisposalRequestQuoteResultDtoType[keyof typeof DisposalRequestQuoteResultDtoType];
+export declare const DisposalRequestQuoteResultDtoType: {
+    readonly RECYCLE: "RECYCLE";
+    readonly DONATE: "DONATE";
+};
+export interface DisposalRequestQuoteResultDto {
+    type: DisposalRequestQuoteResultDtoType;
+    /**
+       * The billing account's currency, which the fee is charged in. Null only on a DONATE quote for an organization with no billing account.
+       * @nullable
+       */
+    currencyCode: string | null;
+    lines: DisposalRequestQuoteLineDto[];
+    /** Minor units, ex VAT. */
+    totalExVatMinor: number;
+    /** Minor units. */
+    totalVatMinor: number;
+    /** Minor units, VAT included. The fee as the price book prices it: a discount rule, code or account credit the customer's invoice applies is not taken off here. */
+    totalIncVatMinor: number;
+    /** RECYCLING_FEE when the price book has no rule that prices this request, or its rule cannot (a per-m³ rule on goods with no recorded size). The totals are then 0 and the invoice bills no fee either. Empty for a DONATE request, which is free. */
+    deferred: string[];
+    /** Items in storage the request covers: what a per-item fee bills. */
+    itemCount: number;
+    /**
+       * Their volume in cm³; null when one of them has no recorded size.
+       * @nullable
+       */
+    billableVolumeCm3: number | null;
+}
 export interface CancelDisposalRequestDto {
     /**
        * Why the request is being withdrawn.
@@ -7871,6 +8041,16 @@ export interface UpdateBillingAccountDto {
     currencyCode?: string;
     languageCode?: string;
 }
+export interface InvoiceNowDto {
+    /** The last day whose charges are invoiced (YYYY-MM-DD), in the tenant's billing calendar. Must be before today there; defaults to yesterday. */
+    throughDate?: string;
+    /**
+       * Why the account is invoiced now (recorded in the audit log).
+       * @minLength 1
+       * @maxLength 500
+       */
+    reason: string;
+}
 export interface InvoiceDto {
     invoiceId: string;
     tenantId: string;
@@ -7927,6 +8107,14 @@ export interface InvoiceDto {
     /** @nullable */
     snapshotCorporateIdentityNumber: string | null;
 }
+export interface InvoiceNowResponseDto {
+    /** The draft invoices created (status CREATED), earliest invoice window first: one per window, as the monthly run would cut them. Usually one; more when a month before this one still had charges no invoice held. */
+    invoices: InvoiceDto[];
+    /** The day the account was invoiced through. */
+    throughDate: string;
+    /** The last day through which every charge of the account is priced, and so on these invoices or an earlier one: throughDate, or the day before the earliest charge still being priced. A storage night priced after this call is billed by a later invoice. */
+    coveredThrough: string;
+}
 export interface PaginatedInvoicesDto {
     /** The page of rows. */
     items: InvoiceDto[];
@@ -10712,7 +10900,7 @@ export interface CreateNotificationRuleDto {
     /** Defaults to the event's category. Only operational ↔ transactional relabelling is permitted (02 §3). */
     category?: CreateNotificationRuleDtoCategory;
     /**
-       * NULL falls back to the platform system template for (event, channel, locale).
+       * NULL resolves the template per event: the event organization's override, then the tenant default, then the system template, each in the recipient's locale. Enabling an unbound rule needs a published tenant default or system template for the event and channel; an organization override alone does not satisfy it.
        * @nullable
        */
     notificationTemplateId?: string | null;