@vindentech/api-client 0.3.0-next.35 → 0.3.0-next.37

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

@@ -42,6 +42,8 @@ export interface OrderSummaryDto {
     recipientName: string | null;
     /** Live product lines on the job (voided and deleted lines excluded). Scoped by the caller's own row visibility, so it matches what `GET /v1/orders/{id}` would show them. */
     productCount: number;
+    /** Merchandise lines on the job (public.sales_order_merchandise) — always 0 except on a MERCHANDISE_SALE job, which carries merchandise instead of product lines. Distinct from `productCount`, which never counts these. Scoped by the caller's own row visibility like `productCount`: 0 can mean 'no merchandise' or 'withheld by scope' (no warehouse/carrier read branch exists yet on this table). */
+    merchandiseCount: number;
     /**
      * Dispatch warehouse (NULL for service-only / field jobs).
      * @nullable
@@ -152,6 +154,26 @@ export interface OrderProductDto {
     quantity: number;
     status: string;
 }
+export interface OrderMerchandiseDto {
+    salesOrderMerchandiseId: string;
+    /** The tenant SKU (public.tenant_goods) this line was placed against. */
+    tenantGoodsId: string;
+    /** Denormalized snapshot of the SKU's code at placement. */
+    goodsCode: string;
+    /** Denormalized snapshot of the SKU's name at placement. */
+    goodsName: string;
+    /** Units placed. */
+    quantity: number;
+    /**
+     * Per-unit price ex VAT, frozen at placement, in minor units (e.g. öre/cent).
+     * @minimum 0
+     */
+    unitPriceExVatMinor: number;
+    /** VAT rate frozen at placement (numeric column → string, e.g. "25.0000"). */
+    vatRate: string;
+    /** Frozen at placement (ISO 4217). */
+    currencyCode: string;
+}
 export interface OrderEstimateItemDto {
     /**
      * What the customer called it.
@@ -303,6 +325,8 @@ export interface OrderDetailDto {
     recipientName: string | null;
     /** Live product lines on the job (voided and deleted lines excluded). Scoped by the caller's own row visibility, so it matches what `GET /v1/orders/{id}` would show them. */
     productCount: number;
+    /** Merchandise lines on the job (public.sales_order_merchandise) — always 0 except on a MERCHANDISE_SALE job, which carries merchandise instead of product lines. Distinct from `productCount`, which never counts these. Scoped by the caller's own row visibility like `productCount`: 0 can mean 'no merchandise' or 'withheld by scope' (no warehouse/carrier read branch exists yet on this table). */
+    merchandiseCount: number;
     /**
      * Dispatch warehouse (NULL for service-only / field jobs).
      * @nullable
@@ -363,6 +387,8 @@ export interface OrderDetailDto {
     /** @nullable */
     organization: OrderDetailDtoOrganization;
     products: OrderProductDto[];
+    /** Merchandise lines (public.sales_order_merchandise) — populated on a MERCHANDISE_SALE job, empty on every other order type. Scoped by the caller's own row visibility like `merchandiseCount`: empty can mean 'no merchandise' or 'withheld by scope'. */
+    merchandise: OrderMerchandiseDto[];
     /** @nullable */
     estimate: OrderDetailDtoEstimate;
     legs: OrderLegDto[];
@@ -4084,9 +4110,26 @@ export interface CompleteStopResultDto {
     /** True when this was an idempotent replay. */
     idempotent: boolean;
 }
+/**
+ * Structured failure-reason code. Drives customer-fault billing attribution — omit or use an operational code to never bill.
+ */
+export type FailStopDtoFailureReasonCode = typeof FailStopDtoFailureReasonCode[keyof typeof FailStopDtoFailureReasonCode];
+export declare const FailStopDtoFailureReasonCode: {
+    readonly RECIPIENT_NOT_HOME: "RECIPIENT_NOT_HOME";
+    readonly ACCESS_BLOCKED: "ACCESS_BLOCKED";
+    readonly ADDRESS_INVALID: "ADDRESS_INVALID";
+    readonly DELIVERY_REFUSED: "DELIVERY_REFUSED";
+    readonly CARRIER_VEHICLE_ISSUE: "CARRIER_VEHICLE_ISSUE";
+    readonly CARRIER_CAPACITY: "CARRIER_CAPACITY";
+    readonly WAREHOUSE_ERROR: "WAREHOUSE_ERROR";
+    readonly WEATHER_OR_ROAD_CONDITIONS: "WEATHER_OR_ROAD_CONDITIONS";
+    readonly OTHER_OPERATIONAL: "OTHER_OPERATIONAL";
+};
 export interface FailStopDto {
     /** Why the delivery failed (required). */
     failureReason: string;
+    /** Structured failure-reason code. Drives customer-fault billing attribution — omit or use an operational code to never bill. */
+    failureReasonCode?: FailStopDtoFailureReasonCode;
     /** @maxLength 1000 */
     notes?: string;
     photoFileIds?: string[];
@@ -4177,6 +4220,22 @@ export declare const TransportLegDtoStatus: {
     readonly CANCELLED: "CANCELLED";
     readonly FAILED: "FAILED";
 };
+/**
+ * Structured failure-reason taxonomy code, set on fail(). NULL = not classified (BE-1832).
+ * @nullable
+ */
+export type TransportLegDtoFailureReasonCode = typeof TransportLegDtoFailureReasonCode[keyof typeof TransportLegDtoFailureReasonCode] | null;
+export declare const TransportLegDtoFailureReasonCode: {
+    readonly RECIPIENT_NOT_HOME: "RECIPIENT_NOT_HOME";
+    readonly ACCESS_BLOCKED: "ACCESS_BLOCKED";
+    readonly ADDRESS_INVALID: "ADDRESS_INVALID";
+    readonly DELIVERY_REFUSED: "DELIVERY_REFUSED";
+    readonly CARRIER_VEHICLE_ISSUE: "CARRIER_VEHICLE_ISSUE";
+    readonly CARRIER_CAPACITY: "CARRIER_CAPACITY";
+    readonly WAREHOUSE_ERROR: "WAREHOUSE_ERROR";
+    readonly WEATHER_OR_ROAD_CONDITIONS: "WEATHER_OR_ROAD_CONDITIONS";
+    readonly OTHER_OPERATIONAL: "OTHER_OPERATIONAL";
+};
 /**
  * @nullable
  */
@@ -4189,6 +4248,11 @@ export interface TransportLegDto {
     legType: string;
     legSequence: number;
     status: TransportLegDtoStatus;
+    /**
+     * Structured failure-reason taxonomy code, set on fail(). NULL = not classified (BE-1832).
+     * @nullable
+     */
+    failureReasonCode: TransportLegDtoFailureReasonCode;
     /** @nullable */
     transportServiceId: string | null;
     /** @nullable */
@@ -4313,6 +4377,32 @@ export interface CompleteLegDto {
     /** A file_asset id linked via entity_file. */
     proofOfDeliveryFileId?: string;
 }
+/**
+ * Structured failure-reason code. Drives customer-fault billing attribution — omit or use an operational code to never bill.
+ */
+export type FailTransportLegDtoFailureReasonCode = typeof FailTransportLegDtoFailureReasonCode[keyof typeof FailTransportLegDtoFailureReasonCode];
+export declare const FailTransportLegDtoFailureReasonCode: {
+    readonly RECIPIENT_NOT_HOME: "RECIPIENT_NOT_HOME";
+    readonly ACCESS_BLOCKED: "ACCESS_BLOCKED";
+    readonly ADDRESS_INVALID: "ADDRESS_INVALID";
+    readonly DELIVERY_REFUSED: "DELIVERY_REFUSED";
+    readonly CARRIER_VEHICLE_ISSUE: "CARRIER_VEHICLE_ISSUE";
+    readonly CARRIER_CAPACITY: "CARRIER_CAPACITY";
+    readonly WAREHOUSE_ERROR: "WAREHOUSE_ERROR";
+    readonly WEATHER_OR_ROAD_CONDITIONS: "WEATHER_OR_ROAD_CONDITIONS";
+    readonly OTHER_OPERATIONAL: "OTHER_OPERATIONAL";
+};
+export interface FailTransportLegDto {
+    /**
+     * Required — the failure/cancellation reason.
+     * @maxLength 500
+     */
+    reason?: string;
+    /** When the event occurred (client clock). */
+    occurredAt?: string;
+    /** Structured failure-reason code. Drives customer-fault billing attribution — omit or use an operational code to never bill. */
+    failureReasonCode?: FailTransportLegDtoFailureReasonCode;
+}
 export interface FailLegDto {
     /**
      * Required — the failure/cancellation reason.
@@ -7052,6 +7142,17 @@ export interface VoidInvoiceDto {
     /** Why the invoice is being voided (required, recorded on the row). */
     voidReason: string;
 }
+export interface ReprocessInvoiceFromBasisResponseDto {
+    invoiceId: string;
+    /** Always CANCELLED on success. */
+    invoiceStatus: string;
+    /** New invoice_basis_row(s) inserted across all events behind this invoice. */
+    insertedCount: number;
+    /** invoice_basis_row_supersession row(s) inserted. */
+    supersededCount: number;
+    /** Explains that the replacement invoice is produced asynchronously by the next scheduled aggregation run, not by this call. */
+    note: 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. */
@@ -7184,7 +7285,7 @@ export interface PriceListDto {
     /** @nullable */
     effectiveUntil: string | null;
     isActive: boolean;
-    /** Lifecycle status (draft / approved / ...). */
+    /** Lifecycle status (draft / pending_approval / active / archived). */
     lifecycleStatus: string;
     createdAt: string;
     updatedAt: string;
@@ -7213,7 +7314,7 @@ export interface PriceListItemDto {
     /** @nullable */
     effectiveUntil: string | null;
     isActive: boolean;
-    /** Lifecycle status (draft / approved / ...). */
+    /** Lifecycle status (draft / pending_approval / active / archived). */
     lifecycleStatus: string;
     createdAt: string;
     updatedAt: string;
@@ -7229,6 +7330,14 @@ export interface CreatePriceListDto {
     effectiveUntil?: string;
     changeReason?: string;
 }
+/**
+ * Move between draft and pending_approval only. Activation/archival are dedicated endpoints.
+ */
+export type UpdatePriceListDtoLifecycleStatus = typeof UpdatePriceListDtoLifecycleStatus[keyof typeof UpdatePriceListDtoLifecycleStatus];
+export declare const UpdatePriceListDtoLifecycleStatus: {
+    readonly draft: "draft";
+    readonly pending_approval: "pending_approval";
+};
 export interface UpdatePriceListDto {
     name?: string;
     code?: string;
@@ -7237,6 +7346,12 @@ export interface UpdatePriceListDto {
     effectiveFrom?: string;
     effectiveUntil?: string;
     changeReason?: string;
+    /** Move between draft and pending_approval only. Activation/archival are dedicated endpoints. */
+    lifecycleStatus?: UpdatePriceListDtoLifecycleStatus;
+}
+export interface PriceListLifecycleActionDto {
+    /** Optional justification for this decision. */
+    changeReason?: string;
 }
 export interface CreatePriceListItemDto {
     articleId: string;
@@ -8042,6 +8157,8 @@ export interface BillingModelTemplateDto {
     description: string;
     /** The billable event type the produced rules price. */
     billableEventType: string;
+    /** Whether a live backend emitter produces this template's billable event type today. `false` means a rule created from this template is valid but currently dormant — no in-platform producer fires the event yet. */
+    emitterReady: boolean;
     /** Calculation methods this template emits. */
     generatesCalculationMethods: string[];
     /** JSON Schema for the authoring form. */
@@ -8108,6 +8225,7 @@ export interface ApplyTemplateDto {
     currencyCode: string;
     /** Omit for the tenant-wide default; set for a per-customer override. */
     billingAccountId?: string;
+    /** Reserved for price-list-scoped rules (#70) — not implemented yet, so a non-null value is rejected with 400 (BE-1822). Omit this field. */
     priceListId?: string;
     /** Template form values, per the template's uiFormSchema (e.g. { amount_minor: 49900 }). */
     input: ApplyTemplateDtoInput;
@@ -8211,6 +8329,20 @@ export interface SimulatePricingResponseDto {
     basisRows: SimulatedBasisRowDto[];
     projectedInvoiceRowsBeforeDiscounts: ProjectedInvoiceRowDto[];
 }
+/**
+ * Method-specific parameters (JSON), re-validated on write.
+ */
+export type UpdatePricingRuleDtoParameters = {
+    [key: string]: unknown;
+};
+export interface UpdatePricingRuleDto {
+    /** Close (or narrow) the rule's active window. */
+    effectiveUntil?: string;
+    isActive?: boolean;
+    /** Method-specific parameters (JSON), re-validated on write. */
+    parameters?: UpdatePricingRuleDtoParameters;
+    changeReason?: string;
+}
 export interface BillableEventTypeDto {
     /** Canonical event_type key (e.g. picking_order_processed). */
     eventType: string;
@@ -8220,6 +8352,8 @@ export interface BillableEventTypeDto {
     category: string;
     /** Whether a pricing_rule may target this type. Filter to `true` for the rule-authoring dropdown; `false` are state/audit or system events. */
     pricingTarget: boolean;
+    /** Whether a live backend emitter produces this event type today. `false` means a pricing_rule targeting it is valid but currently dormant — no in-platform producer fires it yet. */
+    emitterReady: boolean;
     description: string;
 }
 export interface PaymentInstrumentDto {
@@ -8309,6 +8443,119 @@ export interface InvoiceDetailsDto {
      */
     paymentMethodName: string | null;
 }
+export interface BillableEventDto {
+    billableEventId: string;
+    tenantId: string;
+    organizationId: string;
+    /**
+     * Null until the operational source resolves the billing account.
+     * @nullable
+     */
+    billingAccountId: string | null;
+    /** e.g. picking_order_processed, storage_snapshot. */
+    eventType: string;
+    /** Operational source table this event was raised from. */
+    sourceTable: string;
+    /** Id of the row in sourceTable. */
+    sourceId: string;
+    /**
+     * Disambiguates multiple events for the same source in one period (e.g. a credit note's invoice id).
+     * @nullable
+     */
+    sourceDiscriminator: string | null;
+    basisPeriodStart: string;
+    /** @nullable */
+    basisPeriodEnd: string | null;
+    /**
+     * Informational snapshot only — NOT authoritative pricing.
+     * @nullable
+     */
+    amountMinor: number | null;
+    /**
+     * ISO 4217 currency code.
+     * @nullable
+     */
+    currencyCode: string | null;
+    createdAt: string;
+    /**
+     * Set once the pricing materializer has consumed this event (0 basis rows is still processed).
+     * @nullable
+     */
+    processedAt: string | null;
+}
+export interface PaginatedBillableEventsDto {
+    /** The page of rows. */
+    items: BillableEventDto[];
+    /** 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;
+}
+/**
+ * Raw operational payload.
+ * @nullable
+ */
+export type BillableEventDetailDtoPayload = {
+    [key: string]: unknown;
+} | null;
+export interface BillableEventDetailDto {
+    billableEventId: string;
+    tenantId: string;
+    organizationId: string;
+    /**
+     * Null until the operational source resolves the billing account.
+     * @nullable
+     */
+    billingAccountId: string | null;
+    /** e.g. picking_order_processed, storage_snapshot. */
+    eventType: string;
+    /** Operational source table this event was raised from. */
+    sourceTable: string;
+    /** Id of the row in sourceTable. */
+    sourceId: string;
+    /**
+     * Disambiguates multiple events for the same source in one period (e.g. a credit note's invoice id).
+     * @nullable
+     */
+    sourceDiscriminator: string | null;
+    basisPeriodStart: string;
+    /** @nullable */
+    basisPeriodEnd: string | null;
+    /**
+     * Informational snapshot only — NOT authoritative pricing.
+     * @nullable
+     */
+    amountMinor: number | null;
+    /**
+     * ISO 4217 currency code.
+     * @nullable
+     */
+    currencyCode: string | null;
+    createdAt: string;
+    /**
+     * Set once the pricing materializer has consumed this event (0 basis rows is still processed).
+     * @nullable
+     */
+    processedAt: string | null;
+    /**
+     * Raw operational payload.
+     * @nullable
+     */
+    payload: BillableEventDetailDtoPayload;
+}
+export interface ReprocessPricingDto {
+    /** Why this event is being reprocessed (recorded on the supersession row). */
+    reason?: string;
+}
+export interface ReprocessPricingResponseDto {
+    billableEventId: string;
+    /** New invoice_basis_row(s) inserted by this call. */
+    insertedCount: number;
+    /** invoice_basis_row_supersession row(s) inserted by this call. */
+    supersededCount: number;
+}
 export interface StripeWebhookAckDto {
     /** Always true once the event was accepted. */
     received: boolean;
@@ -11599,6 +11846,27 @@ export type PricingRulesControllerListPricingRulesV1Params = {
      */
     offset?: number;
 };
+export type BillableEventsControllerListBillableEventsV1Params = {
+    /**
+     * Max rows to return (1–100).
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Rows to skip.
+     * @minimum 0
+     */
+    offset?: number;
+    /**
+     * Filter by the operational source table.
+     */
+    sourceTable?: string;
+    /**
+     * Filter by the operational source row id.
+     */
+    sourceId?: string;
+};
 export type UsersControllerListV1Params = {
     /**
      * Case-insensitive substring match over display name OR email. Omit to list the first page of the directory.