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

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

@@ -512,6 +512,11 @@ export interface OrderTimelineEventDto {
     /** @nullable */
     oldStatus?: string | null;
     newStatus?: string;
+    /**
+       * Keycloak `sub` of the user who made the status change, for tenant-wide staff and platform admins; absent for every other caller. Null when no user was in context, e.g. a Worker transition.
+       * @nullable
+       */
+    changedBySub?: string | null;
     orderTransportLegId?: string;
     legType?: string;
     sequence?: number;
@@ -1220,6 +1225,76 @@ export interface PickingRouteDto {
     /** Stops in walk order */
     stops: PickingStopDto[];
 }
+/**
+ * The value before the write. Absent on INSERT and when redacted.
+ */
+export type OrderAuditChangeDtoBefore = string | null | number | boolean | {
+    [key: string]: unknown;
+} | unknown[];
+/**
+ * The value after the write. Absent on DELETE and when redacted.
+ */
+export type OrderAuditChangeDtoAfter = string | null | number | boolean | {
+    [key: string]: unknown;
+} | unknown[];
+export interface OrderAuditChangeDto {
+    /** The database column name, e.g. `status`, `planned_window_start`. */
+    column: string;
+    /** The column is outside its table's audit allowlist, so the values were never stored. `before` and `after` are then absent: the entry says only that the column changed. */
+    redacted: boolean;
+    /** The value before the write. Absent on INSERT and when redacted. */
+    before?: OrderAuditChangeDtoBefore;
+    /** The value after the write. Absent on DELETE and when redacted. */
+    after?: OrderAuditChangeDtoAfter;
+}
+/**
+ * Which record was written.
+ */
+export type OrderAuditEntryDtoEntityType = typeof OrderAuditEntryDtoEntityType[keyof typeof OrderAuditEntryDtoEntityType];
+export declare const OrderAuditEntryDtoEntityType: {
+    readonly ORDER: "ORDER";
+    readonly TRANSPORT_LEG: "TRANSPORT_LEG";
+    readonly MERCHANDISE_LINE: "MERCHANDISE_LINE";
+    readonly POD: "POD";
+};
+export type OrderAuditEntryDtoEventType = typeof OrderAuditEntryDtoEventType[keyof typeof OrderAuditEntryDtoEventType];
+export declare const OrderAuditEntryDtoEventType: {
+    readonly INSERT: "INSERT";
+    readonly UPDATE: "UPDATE";
+    readonly DELETE: "DELETE";
+};
+export interface OrderAuditEntryDto {
+    rowChangeId: string;
+    /** When the write's transaction started. Every write of one transaction shares it, so entries are ordered by this and then by `rowChangeId`. */
+    changedAt: string;
+    /** Which record was written. */
+    entityType: OrderAuditEntryDtoEntityType;
+    /** The written record's id. */
+    entityId: string;
+    eventType: OrderAuditEntryDtoEventType;
+    /**
+       * Keycloak `sub` of the user whose request made the write. Null when no user was in context, which includes every Worker write.
+       * @nullable
+       */
+    changedBySub: string | null;
+    /**
+       * The writer's application role, where one was recorded. Null when none was.
+       * @nullable
+       */
+    changedByRole: string | null;
+    /** On UPDATE, every column whose value changed, sorted by name. On INSERT and DELETE, the allowlisted columns holding a value; redacted columns are left out there, because the stored row cannot say whether they held one. */
+    changes: OrderAuditChangeDto[];
+}
+export interface PaginatedOrderAuditEntriesDto {
+    /** The page of rows. */
+    items: OrderAuditEntryDto[];
+    /** Exact count of all rows matching the filter, pre-pagination (RLS-scoped). */
+    total: number;
+    /** Effective max rows applied (after defaults/clamp). */
+    limit: number;
+    /** Effective rows skipped applied. */
+    offset: number;
+}
 export interface AddressDto {
     addressId: string;
     organizationId: string;
@@ -2300,6 +2375,23 @@ export interface UpdateMeOrganizationDto {
        */
     preferredLocale?: UpdateMeOrganizationDtoPreferredLocale;
 }
+/**
+ * Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant.
+ */
+export type CloseAccountResultDtoKeycloakSyncStatus = typeof CloseAccountResultDtoKeycloakSyncStatus[keyof typeof CloseAccountResultDtoKeycloakSyncStatus];
+export declare const CloseAccountResultDtoKeycloakSyncStatus: {
+    readonly synced: "synced";
+    readonly failed: "failed";
+    readonly not_configured: "not_configured";
+};
+export interface CloseAccountResultDto {
+    /** The caller's personal organization. It is kept, not deleted, so storage still owed is billed. */
+    organizationId: string;
+    /** When the account was closed. */
+    closedAt: string;
+    /** Outcome of the best-effort Keycloak push made after the database commit. `synced` — the Keycloak side was updated by this call. `failed` — the push was attempted and failed; the database change stands, and re-running the command re-attempts the push. `not_configured` — no push was attempted because no Keycloak sync client is provisioned for the tenant. */
+    keycloakSyncStatus: CloseAccountResultDtoKeycloakSyncStatus;
+}
 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;
@@ -2480,6 +2572,8 @@ export interface CartLocationDto {
     stairwell: string | null;
     /** @nullable */
     apartmentNumber: string | null;
+    /** @nullable */
+    transportInstructions: string | null;
 }
 /**
  * @nullable
@@ -2522,6 +2616,8 @@ export interface CartDeliveryLocationDto {
     /** @nullable */
     apartmentNumber: string | null;
     /** @nullable */
+    transportInstructions: string | null;
+    /** @nullable */
     servicePointId: string | null;
     /** @nullable */
     servicePointProvider: CartDeliveryLocationDtoServicePointProvider;
@@ -2965,6 +3061,12 @@ export interface CartLocationInputDto {
        * @nullable
        */
     apartmentNumber?: string | null;
+    /**
+       * The customer's message to the driver (e.g. call when outside). Copied onto this side's transport legs at placement.
+       * @maxLength 500
+       * @nullable
+       */
+    transportInstructions?: string | null;
 }
 /**
  * Required alongside servicePointId.
@@ -3035,6 +3137,12 @@ export interface CartDeliveryLocationInputDto {
        * @nullable
        */
     apartmentNumber?: string | null;
+    /**
+       * The customer's message to the driver (e.g. call when outside). Copied onto this side's transport legs at placement.
+       * @maxLength 500
+       * @nullable
+       */
+    transportInstructions?: 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
@@ -7682,6 +7790,14 @@ export declare const PostiOmaPostiProFailureDtoState: {
     readonly PARKED: "PARKED";
     readonly RETRYING: "RETRYING";
 };
+/**
+ * What the provider said when the unanswered send was reconciled with them. NOT_CREATED — they hold no order for it. Null unless `reconciledAt` is set.
+ * @nullable
+ */
+export type PostiOmaPostiProFailureDtoReconciledOutcome = typeof PostiOmaPostiProFailureDtoReconciledOutcome[keyof typeof PostiOmaPostiProFailureDtoReconciledOutcome] | null;
+export declare const PostiOmaPostiProFailureDtoReconciledOutcome: {
+    readonly NOT_CREATED: "NOT_CREATED";
+};
 export interface PostiOmaPostiProFailureDto {
     outboxId: string;
     /** When the sweep emitted the row. Also the partition key. */
@@ -7729,8 +7845,18 @@ export interface PostiOmaPostiProFailureDto {
        * @nullable
        */
     inFlightSince: string | null;
-    /** Whether the booking was also cancelled locally after being sent. Cancelling our record does not cancel the provider's order, so this changes nothing about the phone call — it only explains why the leg looks free. */
+    /** Whether the booking was also cancelled locally after being sent. Cancelling our record does not cancel the provider's order, so this changes nothing about the phone call — it only explains why the leg looks free. Also true once the reconcile command has run (`reconciledAt` set), which cancels the booking because the provider confirmed it holds nothing. */
     cancelledLocally: boolean;
+    /**
+       * When a person reconciled this row's unanswered send with the provider and recorded the outcome. Set only on a PARKED row the reconcile command took out of IN_FLIGHT_UNKNOWN, and the one field that tells it apart from a row whose document the provider refused: both carry a booking with no stamp and a PENDING status, and `lastError` still describes the unanswered send.
+       * @nullable
+       */
+    reconciledAt: string | null;
+    /**
+       * What the provider said when the unanswered send was reconciled with them. NOT_CREATED — they hold no order for it. Null unless `reconciledAt` is set.
+       * @nullable
+       */
+    reconciledOutcome: PostiOmaPostiProFailureDtoReconciledOutcome;
 }
 export interface PostiOmaPostiProFailuresDto {
     failures: PostiOmaPostiProFailureDto[];
@@ -7789,6 +7915,45 @@ export interface PostiOmaPostiProSettleResultDto {
        */
     externalBookingId: string | null;
 }
+/**
+ * NOT_CREATED — the provider confirmed they hold no freight order for this row. The only outcome this command records.
+ */
+export type ReconcilePostiOmaPostiProFailureDtoOutcome = typeof ReconcilePostiOmaPostiProFailureDtoOutcome[keyof typeof ReconcilePostiOmaPostiProFailureDtoOutcome];
+export declare const ReconcilePostiOmaPostiProFailureDtoOutcome: {
+    readonly NOT_CREATED: "NOT_CREATED";
+};
+export interface ReconcilePostiOmaPostiProFailureDto {
+    /** NOT_CREATED — the provider confirmed they hold no freight order for this row. The only outcome this command records. */
+    outcome: ReconcilePostiOmaPostiProFailureDtoOutcome;
+    /** Who at the provider confirmed it, when, and any reference they gave. Recorded in audit_logs.admin_action — this decides that a freight order the platform cannot cancel does not exist, so it is not anonymous. */
+    reason: string;
+}
+export type PostiOmaPostiProReconcileResultDtoDirection = typeof PostiOmaPostiProReconcileResultDtoDirection[keyof typeof PostiOmaPostiProReconcileResultDtoDirection];
+export declare const PostiOmaPostiProReconcileResultDtoDirection: {
+    readonly PICKUP: "PICKUP";
+    readonly MERCHANDISE_DELIVERY: "MERCHANDISE_DELIVERY";
+    readonly DELIVERY: "DELIVERY";
+    readonly UNKNOWN: "UNKNOWN";
+};
+export type PostiOmaPostiProReconcileResultDtoOutcome = typeof PostiOmaPostiProReconcileResultDtoOutcome[keyof typeof PostiOmaPostiProReconcileResultDtoOutcome];
+export declare const PostiOmaPostiProReconcileResultDtoOutcome: {
+    readonly NOT_CREATED: "NOT_CREATED";
+};
+export interface PostiOmaPostiProReconcileResultDto {
+    outboxId: string;
+    /** The sweep's idempotency key, unchanged by the reconcile. */
+    eventKey: string;
+    direction: PostiOmaPostiProReconcileResultDtoDirection;
+    /** The order the freight order was sent for. */
+    aggregateId: string;
+    outcome: PostiOmaPostiProReconcileResultDtoOutcome;
+    /** When the outcome was recorded. */
+    reconciledAt: string;
+    /** The booking the unanswered send was recorded on. It is now cancelled, so the leg is free: a replay books it again on a fresh booking. */
+    carrierBookingId: string;
+    /** When the send that was never answered left the platform — the in-flight stamp this command took off the booking. */
+    inFlightSince: string;
+}
 /**
  * The mode in force. `shadow` when nothing has been configured — the gate's fail-closed default, not a stored value.
  */
@@ -8133,6 +8298,16 @@ export interface AppliedCouponSummaryDto {
     /** What the benefit took off, in minor currency units, measured on the whole part of the invoice line it applied to — not on this row alone. A line billed as several rows (one per constant-volume span) repeats the entry on each row of that part, so do not sum it across rows; the rows' own amounts are already net of it. */
     discountAmountMinor: number;
 }
+/**
+ * What kind of row this is: charge = an ordinary charge; carried = a correction of an earlier month; clawback = a campaign benefit charged back; manual = a row staff added by hand, billed as entered. A credit note row has the kind of the row it credits.
+ */
+export type InvoiceRowDtoRowKind = typeof InvoiceRowDtoRowKind[keyof typeof InvoiceRowDtoRowKind];
+export declare const InvoiceRowDtoRowKind: {
+    readonly charge: "charge";
+    readonly carried: "carried";
+    readonly clawback: "clawback";
+    readonly manual: "manual";
+};
 export interface InvoiceRowDto {
     invoiceRowId: string;
     /** @nullable */
@@ -8156,6 +8331,8 @@ export interface InvoiceRowDto {
     freeText: string | null;
     /** Coupon benefits that reduced this row. Empty when none did. */
     appliedCoupons: AppliedCouponSummaryDto[];
+    /** What kind of row this is: charge = an ordinary charge; carried = a correction of an earlier month; clawback = a campaign benefit charged back; manual = a row staff added by hand, billed as entered. A credit note row has the kind of the row it credits. */
+    rowKind: InvoiceRowDtoRowKind;
     /**
        * 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
@@ -8244,6 +8421,49 @@ export interface ReprocessInvoiceFromBasisResponseDto {
     /** Explains that the replacement invoice is produced asynchronously by the next scheduled aggregation run, not by this call. */
     note: string;
 }
+export interface AddInvoiceRowDto {
+    /** The article the row is posted on. */
+    articleId: string;
+    /** Quantity, greater than 0, at most 4 decimals (e.g. "1", "2.5"). */
+    quantity: string;
+    /** The unit the quantity is in. Defaults to `each`. */
+    unitOfMeasureId?: string;
+    /** Price per unit excl. VAT in minor units, greater than 0. The row bills it times the quantity, rounded to the minor unit. Give this or amountExVatMinor, not both. */
+    unitPriceExVatMinor?: number;
+    /** The row's amount excl. VAT in minor units, greater than 0. Give this or unitPriceExVatMinor, not both. */
+    amountExVatMinor?: number;
+    /** VAT rate as a percentage 0–99.9999. Defaults to the article's VAT rate. */
+    vatRate?: string;
+    /**
+       * Text printed on the invoice line after the article name, as entered.
+       * @maxLength 150
+       */
+    freeText?: string;
+    /** First day the row bills for (YYYY-MM-DD). With periodEnd, or neither: both default to the draft's own invoice period, and a period that would put the row on another invoice is refused. */
+    periodStart?: string;
+    /** Last day the row bills for (YYYY-MM-DD). */
+    periodEnd?: string;
+    /**
+       * Why the row is added (recorded with the edit; never shown to the customer).
+       * @minLength 1
+       * @maxLength 500
+       */
+    reason: string;
+}
+export interface InvoiceEditResponseDto {
+    /** The draft that replaces the edited one (status CREATED), with its rows. Discounts, the minimum monthly fee and RUT hours are computed again over its rows. */
+    invoice: InvoiceDetailDto;
+    /** The edited draft, now CANCELLED. Any further edit of it is refused. */
+    replacedInvoiceId: string;
+}
+export interface RemoveInvoiceRowDto {
+    /**
+       * Why the row is removed (recorded with the edit; never shown to the customer).
+       * @minLength 1
+       * @maxLength 500
+       */
+    reason: string;
+}
 export interface CreditNoteRowDto {
     invoiceRowId: string;
     /** Amount (excl. VAT, minor units, POSITIVE magnitude) to refund off this row. The service writes it as a negative credit-note row. */
@@ -12234,6 +12454,19 @@ 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;
 }
+export interface TenantGoodsTranslationDto {
+    name: string;
+    /**
+       * Null when this locale has no description of its own: show the SKU's `description`.
+       * @nullable
+       */
+    description: string | null;
+}
+export interface TenantGoodsTranslationsDto {
+    'sv-SE'?: TenantGoodsTranslationDto;
+    'en-GB'?: TenantGoodsTranslationDto;
+    'fi-FI'?: TenantGoodsTranslationDto;
+}
 /**
  * @nullable
  */
@@ -12248,6 +12481,8 @@ export interface TenantGoodsDto {
     name: string;
     /** @nullable */
     description?: string | null;
+    /** The SKU's text per locale, keyed by BCP-47 tag (sv-SE, en-GB, fi-FI). `name` and `description` are the default: show `translations[locale]?.name ?? name` and `translations[locale]?.description ?? description`, each field on its own. `{}` when the SKU has no translations. */
+    translations: TenantGoodsTranslationsDto;
     /**
        * The SKU's price ex VAT as a decimal string, read from its pricing rule: the open-ended rule, which is the latest price set even when it starts in the future. Null when the SKU has no open-ended price.
        * @nullable
@@ -12286,6 +12521,23 @@ export interface TenantGoodsDto {
     createdAt: string;
     updatedAt: string;
 }
+export interface TenantGoodsTranslationInputDto {
+    /** The SKU's name in this locale. */
+    name: string;
+    /**
+       * The SKU's description in this locale. Omitted, null or blank stores none, so the SKU's own `description` is shown.
+       * @nullable
+       */
+    description?: string | null;
+}
+export interface TenantGoodsTranslationsInputDto {
+    /** @nullable */
+    'sv-SE'?: TenantGoodsTranslationInputDto | null;
+    /** @nullable */
+    'en-GB'?: TenantGoodsTranslationInputDto | null;
+    /** @nullable */
+    'fi-FI'?: TenantGoodsTranslationInputDto | null;
+}
 /**
  * Operational hints only.
  */
@@ -12297,6 +12549,8 @@ export interface CreateTenantGoodsDto {
     code: string;
     name: string;
     description?: string;
+    /** The name and description per locale (sv-SE, en-GB, fi-FI); `name` and `description` above stay the default for a locale with none. Defaults to none. */
+    translations?: TenantGoodsTranslationsInputDto;
     /**
        * 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
@@ -12340,6 +12594,8 @@ export type UpdateTenantGoodsDtoMetadata = {
 export interface UpdateTenantGoodsDto {
     name?: string;
     description?: string;
+    /** Replaces the SKU's per-locale texts WHOLE: a locale left out loses its entry, and `{}` removes them all. Omitted leaves them alone. */
+    translations?: TenantGoodsTranslationsInputDto;
     /**
        * 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
@@ -12493,6 +12749,8 @@ export interface CheckoutMerchandiseDto {
     name: string;
     /** @nullable */
     description?: string | null;
+    /** The SKU's text per locale, keyed by BCP-47 tag (sv-SE, en-GB, fi-FI). `name` and `description` are the default: show `translations[locale]?.name ?? name` and `translations[locale]?.description ?? description`, each field on its own. `{}` when the SKU has no translations. */
+    translations: TenantGoodsTranslationsDto;
     /**
        * Price ex VAT as a decimal string: what the SKU's pricing rule charges today, in currencyCode. Null when no price is in force today.
        * @nullable
@@ -12529,6 +12787,8 @@ export interface MerchandiseEstimateLineDto {
     name: string;
     /** @nullable */
     description?: string | null;
+    /** The SKU's text per locale, keyed by BCP-47 tag (sv-SE, en-GB, fi-FI). `name` and `description` are the default: show `translations[locale]?.name ?? name` and `translations[locale]?.description ?? description`, each field on its own. `{}` when the SKU has no translations. */
+    translations: TenantGoodsTranslationsDto;
     /**
        * Price ex VAT as a decimal string: what the SKU's pricing rule charges today, in currencyCode. Null when no price is in force today.
        * @nullable
@@ -12915,6 +13175,19 @@ export type SalesOrdersControllerGetPickingRouteV1Params = {
      */
     includeHandled?: string;
 };
+export type OrderAuditControllerListV1Params = {
+    /**
+     * Max rows to return (1–100).
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Rows to skip.
+     * @minimum 0
+     */
+    offset?: number;
+};
 export type AddressesControllerListV1Params = {
     /**
      * Max rows to return (1–100).
@@ -13987,6 +14260,21 @@ export type CouponsControllerListRedemptionsV1Params = {
      * Restrict the list to one billing account's redemptions.
      */
     billingAccountId?: string;
+    /**
+     * Restrict the list to one coupon's redemptions.
+     */
+    couponId?: string;
+    /**
+     * Restrict the list to redemptions in this status. A coupon's redemption caps count every status except `cancelled`, so for one `couponId` the usage a cap enforces is `total` without `status` minus `total` with `status=cancelled`.
+     */
+    status?: CouponsControllerListRedemptionsV1Status;
+};
+export type CouponsControllerListRedemptionsV1Status = typeof CouponsControllerListRedemptionsV1Status[keyof typeof CouponsControllerListRedemptionsV1Status];
+export declare const CouponsControllerListRedemptionsV1Status: {
+    readonly active: "active";
+    readonly consumed: "consumed";
+    readonly expired: "expired";
+    readonly cancelled: "cancelled";
 };
 export type UnitsOfMeasureControllerListUnitsOfMeasureV1Params = {
     /**