@vindentech/api-client 0.3.0-next.82 → 0.3.0-next.84

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,40 @@ 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;
+}
+/**
+ * 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;
@@ -2442,6 +2497,8 @@ export interface CartLocationDto {
     stairwell: string | null;
     /** @nullable */
     apartmentNumber: string | null;
+    /** @nullable */
+    transportInstructions: string | null;
 }
 /**
  * @nullable
@@ -2484,6 +2541,8 @@ export interface CartDeliveryLocationDto {
     /** @nullable */
     apartmentNumber: string | null;
     /** @nullable */
+    transportInstructions: string | null;
+    /** @nullable */
     servicePointId: string | null;
     /** @nullable */
     servicePointProvider: CartDeliveryLocationDtoServicePointProvider;
@@ -2927,6 +2986,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.
@@ -2998,7 +3063,13 @@ export interface CartDeliveryLocationInputDto {
        */
     apartmentNumber?: string | null;
     /**
-       * Opaque provider-specific id; requires servicePointProvider alongside it.
+       * 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
        */
     servicePointId?: string | null;
@@ -7644,6 +7715,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. */
@@ -7691,8 +7770,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[];
@@ -7751,6 +7840,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.
  */
@@ -8003,6 +8131,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;
@@ -8059,6 +8197,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[];
@@ -8077,6 +8223,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 */
@@ -8100,6 +8256,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
@@ -8188,6 +8346,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. */
@@ -10844,7 +11045,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;
@@ -13931,6 +14132,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 = {
     /**