@vindentech/api-client 0.3.0-next.15 → 0.3.0-next.16

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

@@ -165,6 +165,13 @@ export interface OrderLegDto {
     city: string | null;
     /** @nullable */
     countryCode: string | null;
+    /**
+     * Opaque provider-specific service-point (parcel locker) id; DELIVERY legs only.
+     * @nullable
+     */
+    servicePointId: string | null;
+    /** @nullable */
+    servicePointProvider: string | null;
     /** @nullable */
     floorLevel: number | null;
     /** @nullable */
@@ -258,6 +265,11 @@ export interface OrderDetailDto {
     /** @nullable */
     estimate: OrderDetailDtoEstimate;
     legs: OrderLegDto[];
+    /**
+     * The transport_slot id of this order's material:delivery reservation, if any — derived from the originating cart, not a stored column.
+     * @nullable
+     */
+    materialsTimeslotId: string | null;
 }
 export type OrderTimelineEventDtoKind = typeof OrderTimelineEventDtoKind[keyof typeof OrderTimelineEventDtoKind];
 export declare const OrderTimelineEventDtoKind: {
@@ -1656,6 +1668,41 @@ export interface CartLocationDto {
     /** @nullable */
     extraStorageM2: number | null;
 }
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationDtoServicePointProvider = typeof CartDeliveryLocationDtoServicePointProvider[keyof typeof CartDeliveryLocationDtoServicePointProvider] | null;
+export declare const CartDeliveryLocationDtoServicePointProvider: {
+    readonly POSTI: "POSTI";
+};
+export interface CartDeliveryLocationDto {
+    /** @nullable */
+    addressLine1: string | null;
+    /** @nullable */
+    addressLine2: string | null;
+    /** @nullable */
+    zipCode: string | null;
+    /** @nullable */
+    city: string | null;
+    /** @nullable */
+    countryCode: string | null;
+    /** @nullable */
+    squareMeters: number | null;
+    /** @nullable */
+    numberOfRooms: number | null;
+    /** @nullable */
+    floor: number | null;
+    /** @nullable */
+    elevatorType: string | null;
+    /** @nullable */
+    isBackyardHouse: boolean | null;
+    /** @nullable */
+    extraStorageM2: number | null;
+    /** @nullable */
+    servicePointId: string | null;
+    /** @nullable */
+    servicePointProvider: CartDeliveryLocationDtoServicePointProvider;
+}
 /**
  * @nullable
  */
@@ -1707,6 +1754,11 @@ export interface CartHoldDto {
     reservationId: string;
     /** @nullable */
     slotId: string | null;
+    /**
+     * Which cart component this hold is for (move:pickup | move:delivery | material:delivery); null = legacy single-component cart.
+     * @nullable
+     */
+    componentKey: string | null;
     /** HELD | CONFIRMED | EXPIRED | CANCELLED */
     status: string;
     /** @nullable */
@@ -1754,9 +1806,14 @@ export interface CartDto {
     customer: CartContactDto;
     contact: CartContactDto;
     pickup: CartLocationDto;
-    delivery: CartLocationDto;
+    delivery: CartDeliveryLocationDto;
     /** @nullable */
     estimatedHours: string | null;
+    /**
+     * The transport_slot id of this cart's material:delivery hold, if any — derived from holds[], not a stored column.
+     * @nullable
+     */
+    materialsTimeslotId: string | null;
     /**
      * Versioned pricing payload (schema_version tracked server-side)
      * @nullable
@@ -1881,7 +1938,7 @@ export interface QuoteResponseDto {
      */
     rutDeductionMinor: number | null;
     totals: QuoteTotalsDto;
-    /** Components present on the cart that this quote did not price, or reductions it did not apply. Their absence from `totals` is intentional, never a zero charge. Values: GOODS, SERVICE, START_FEE, TRANSPORT (no configured article, price row, or computable rate), INSURANCE (no plan catalogue exists yet), TRANSPORT_RUT (the line is RUT-eligible but its price source carries no post-deduction price to derive the amount from), BINDING_DISCOUNT (the plan carries rates in `discounts` that invoicing does not yet honour, so the totals exclude them). */
+    /** Components present on the cart that this quote did not price, or reductions it did not apply. Their absence from `totals` is intentional, never a zero charge. Values: GOODS, SERVICE, START_FEE, TRANSPORT (no configured article, price row, or computable rate — no line is emitted at all), INSURANCE (no plan catalogue exists yet), TRANSPORT_PARTIAL (a transport line IS priced from the rate card but excludes a component the cart carries no quantity for — a per-hour rate with no `estimatedHours`, or a per-unit rate with no shipment manifest — so the transport amount is a floor, not the final charge), TRANSPORT_RUT (the line is RUT-eligible but its price source carries no post-deduction price to derive the amount from), BINDING_DISCOUNT (the plan carries rates in `discounts` that invoicing does not yet honour, so the totals exclude them), MATERIAL_DELIVERY (the cart holds a material:delivery timeslot; its underlying slot may carry a real price, but materials pricing is not yet designed, so it is excluded from `totals` rather than priced as ordinary transport). */
     deferred: string[];
 }
 /**
@@ -2008,6 +2065,129 @@ export interface CartLocationInputDto {
     /** @nullable */
     extraStorageM2?: CartLocationInputDtoExtraStorageM2;
 }
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoAddressLine1 = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoAddressLine2 = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoZipCode = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoCity = {
+    [key: string]: unknown;
+} | null;
+/**
+ * ISO 3166-1 alpha-2
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoCountryCode = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoSquareMeters = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoNumberOfRooms = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoFloor = {
+    [key: string]: unknown;
+} | null;
+/**
+ * Value from the elevator_type lookup (e.g. NONE, SMALL, BIG)
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoElevatorType = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoIsBackyardHouse = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoExtraStorageM2 = {
+    [key: string]: unknown;
+} | null;
+/**
+ * Opaque provider-specific id; requires servicePointProvider alongside it.
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoServicePointId = {
+    [key: string]: unknown;
+} | null;
+/**
+ * Required alongside servicePointId.
+ * @nullable
+ */
+export type CartDeliveryLocationInputDtoServicePointProvider = typeof CartDeliveryLocationInputDtoServicePointProvider[keyof typeof CartDeliveryLocationInputDtoServicePointProvider] | null;
+export declare const CartDeliveryLocationInputDtoServicePointProvider: {
+    readonly POSTI: "POSTI";
+};
+export interface CartDeliveryLocationInputDto {
+    /** @nullable */
+    addressLine1?: CartDeliveryLocationInputDtoAddressLine1;
+    /** @nullable */
+    addressLine2?: CartDeliveryLocationInputDtoAddressLine2;
+    /** @nullable */
+    zipCode?: CartDeliveryLocationInputDtoZipCode;
+    /** @nullable */
+    city?: CartDeliveryLocationInputDtoCity;
+    /**
+     * ISO 3166-1 alpha-2
+     * @nullable
+     */
+    countryCode?: CartDeliveryLocationInputDtoCountryCode;
+    /** @nullable */
+    squareMeters?: CartDeliveryLocationInputDtoSquareMeters;
+    /** @nullable */
+    numberOfRooms?: CartDeliveryLocationInputDtoNumberOfRooms;
+    /** @nullable */
+    floor?: CartDeliveryLocationInputDtoFloor;
+    /**
+     * Value from the elevator_type lookup (e.g. NONE, SMALL, BIG)
+     * @nullable
+     */
+    elevatorType?: CartDeliveryLocationInputDtoElevatorType;
+    /** @nullable */
+    isBackyardHouse?: CartDeliveryLocationInputDtoIsBackyardHouse;
+    /** @nullable */
+    extraStorageM2?: CartDeliveryLocationInputDtoExtraStorageM2;
+    /**
+     * Opaque provider-specific id; requires servicePointProvider alongside it.
+     * @nullable
+     */
+    servicePointId?: CartDeliveryLocationInputDtoServicePointId;
+    /**
+     * Required alongside servicePointId.
+     * @nullable
+     */
+    servicePointProvider?: CartDeliveryLocationInputDtoServicePointProvider;
+}
 /**
  * @nullable
  */
@@ -2139,7 +2319,7 @@ export type UpdateCartDtoPickup = CartLocationInputDto | null;
 /**
  * @nullable
  */
-export type UpdateCartDtoDelivery = CartLocationInputDto | null;
+export type UpdateCartDtoDelivery = CartDeliveryLocationInputDto | null;
 /**
  * @nullable
  */
@@ -2187,6 +2367,15 @@ export interface ClaimCartDto {
     /** Staff claim-on-behalf target organization. Org users always claim into their own organization. */
     organizationId?: string;
 }
+/**
+ * Which cart component this hold is for. Omit for the legacy single-component behavior (the move itself) — a cart's leg-producing holds must be either all omitted or all explicit, never mixed.
+ */
+export type HoldTimeslotDtoComponentKey = typeof HoldTimeslotDtoComponentKey[keyof typeof HoldTimeslotDtoComponentKey];
+export declare const HoldTimeslotDtoComponentKey: {
+    readonly 'move:pickup': "move:pickup";
+    readonly 'move:delivery': "move:delivery";
+    readonly 'material:delivery': "material:delivery";
+};
 /**
  * @nullable
  */
@@ -2203,6 +2392,8 @@ export interface HoldTimeslotDto {
     expectedRevision: number;
     /** transport_slot id to draw capacity from */
     timeslotId: string;
+    /** Which cart component this hold is for. Omit for the legacy single-component behavior (the move itself) — a cart's leg-producing holds must be either all omitted or all explicit, never mixed. */
+    componentKey?: HoldTimeslotDtoComponentKey;
     /** @minimum 1 */
     quantityOrders?: number;
     /** @nullable */
@@ -7372,6 +7563,95 @@ export interface NotificationRuleDto {
     createdAt: string;
     updatedAt: string;
 }
+export type CreateNotificationRuleDtoChannel = typeof CreateNotificationRuleDtoChannel[keyof typeof CreateNotificationRuleDtoChannel];
+export declare const CreateNotificationRuleDtoChannel: {
+    readonly email: "email";
+    readonly sms: "sms";
+    readonly push: "push";
+    readonly webhook: "webhook";
+};
+/**
+ * Defaults to the event's category. Only operational ↔ transactional relabelling is permitted (02 §3).
+ */
+export type CreateNotificationRuleDtoCategory = typeof CreateNotificationRuleDtoCategory[keyof typeof CreateNotificationRuleDtoCategory];
+export declare const CreateNotificationRuleDtoCategory: {
+    readonly marketing: "marketing";
+    readonly operational: "operational";
+    readonly transactional: "transactional";
+    readonly billing: "billing";
+    readonly security: "security";
+    readonly system: "system";
+};
+/**
+ * NULL falls back to the platform system template for (event, channel, locale).
+ */
+export type CreateNotificationRuleDtoNotificationTemplateId = {
+    [key: string]: unknown;
+};
+export interface CreateNotificationRuleDto {
+    /** Must exist in the event catalog and not be retired. */
+    eventKey: string;
+    /** The contract version to pin to. Defaults to the event's active version — the rule stays on it until an explicit migration. */
+    eventVersion?: number;
+    channel: CreateNotificationRuleDtoChannel;
+    /** 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). */
+    notificationTemplateId?: CreateNotificationRuleDtoNotificationTemplateId;
+    /** Validated against the pinned version's contractPaths at save (02 §5). */
+    recipients: RecipientSpecDto[];
+}
+export type UpdateNotificationRuleDtoCategory = typeof UpdateNotificationRuleDtoCategory[keyof typeof UpdateNotificationRuleDtoCategory];
+export declare const UpdateNotificationRuleDtoCategory: {
+    readonly marketing: "marketing";
+    readonly operational: "operational";
+    readonly transactional: "transactional";
+    readonly billing: "billing";
+    readonly security: "security";
+    readonly system: "system";
+};
+export interface UpdateNotificationRuleDto {
+    /** Migrate the rule to another contract version. Rejected (`event_version_migration_invalid`) when a recipient path or a template variable does not exist there. */
+    eventVersion?: number;
+    category?: UpdateNotificationRuleDtoCategory;
+    /** @nullable */
+    notificationTemplateId?: string | null;
+    recipients?: RecipientSpecDto[];
+}
+export interface EnableRuleDto {
+    /** The estimate shown in the confirmation panel (from `GET …/recipient-estimate`). */
+    confirmedRecipientEstimate: number;
+    /** Required above the typed-confirmation threshold: the tenant slug, typed by the admin. */
+    typedConfirmation?: string;
+}
+export type RecipientSpecEstimateDtoKind = typeof RecipientSpecEstimateDtoKind[keyof typeof RecipientSpecEstimateDtoKind];
+export declare const RecipientSpecEstimateDtoKind: {
+    readonly event_field: "event_field";
+    readonly org_contact_role: "org_contact_role";
+    readonly tenant_role: "tenant_role";
+    readonly static_email: "static_email";
+    readonly static_phone: "static_phone";
+};
+export interface RecipientSpecEstimateDto {
+    /** Index into the rule's recipients array. */
+    specIndex: number;
+    kind: RecipientSpecEstimateDtoKind;
+    /** Addresses this spec resolves to per event. */
+    estimate: number;
+}
+export type RecipientEstimateDtoBasis = typeof RecipientEstimateDtoBasis[keyof typeof RecipientEstimateDtoBasis];
+export declare const RecipientEstimateDtoBasis: {
+    readonly recent_events: "recent_events";
+    readonly preview_data: "preview_data";
+};
+export interface RecipientEstimateDto {
+    /** Addresses one firing of this event would reach. */
+    estimate: number;
+    /** How many sample events the estimate averaged over. */
+    sampleSize: number;
+    basis: RecipientEstimateDtoBasis;
+    perSpec: RecipientSpecEstimateDto[];
+}
 export type NotificationTemplateDtoChannel = typeof NotificationTemplateDtoChannel[keyof typeof NotificationTemplateDtoChannel];
 export declare const NotificationTemplateDtoChannel: {
     readonly email: "email";
@@ -7411,6 +7691,23 @@ export interface PaginatedNotificationTemplatesDto {
     /** Effective rows skipped applied. */
     offset: number;
 }
+export type CreateNotificationTemplateDtoChannel = typeof CreateNotificationTemplateDtoChannel[keyof typeof CreateNotificationTemplateDtoChannel];
+export declare const CreateNotificationTemplateDtoChannel: {
+    readonly email: "email";
+    readonly sms: "sms";
+    readonly push: "push";
+    readonly webhook: "webhook";
+};
+export interface CreateNotificationTemplateDto {
+    eventKey: string;
+    channel: CreateNotificationTemplateDtoChannel;
+    locale?: string;
+    name: string;
+    /** NULL = the tenant default; set = that organization's override. */
+    organizationId?: string;
+    /** Clone this template's published content into the first draft — the Customize action on a system template, and the tenant-default → org-override path. */
+    sourceTemplateId?: string;
+}
 export type TemplateVersionSummaryDtoLifecycleStatus = typeof TemplateVersionSummaryDtoLifecycleStatus[keyof typeof TemplateVersionSummaryDtoLifecycleStatus];
 export declare const TemplateVersionSummaryDtoLifecycleStatus: {
     readonly draft: "draft";
@@ -7459,6 +7756,191 @@ export interface NotificationTemplateDetailDto {
     updatedAt: string;
     versions: TemplateVersionSummaryDto[];
 }
+export interface UpdateNotificationTemplateDto {
+    /** The only mutable field: event, channel, locale and organization are the template's identity. */
+    name: string;
+}
+export interface CreateTemplateVersionDto {
+    /** Start from this version's content. Cloning an ARCHIVED version is the rollback-with-edits path; the archived row itself is never mutated. */
+    cloneFromVersionId?: string;
+    /** The contract version to author against. Defaults to the cloned version's, else the event's active version. */
+    eventVersion?: number;
+}
+export type TemplateVersionDtoLifecycleStatus = typeof TemplateVersionDtoLifecycleStatus[keyof typeof TemplateVersionDtoLifecycleStatus];
+export declare const TemplateVersionDtoLifecycleStatus: {
+    readonly draft: "draft";
+    readonly published: "published";
+    readonly archived: "archived";
+};
+/**
+ * @nullable
+ */
+export type TemplateVersionDtoPreviewData = {
+    [key: string]: unknown;
+} | null;
+export interface TemplateVersionDto {
+    notificationTemplateVersionId: string;
+    notificationTemplateId: string;
+    version: number;
+    lifecycleStatus: TemplateVersionDtoLifecycleStatus;
+    eventVersion: number;
+    createdAt: string;
+    /** @nullable */
+    publishedAt: string | null;
+    /** @nullable */
+    archivedAt: string | null;
+    /** @nullable */
+    subject: string | null;
+    /** @nullable */
+    preheader: string | null;
+    /** @nullable */
+    bodyHtml: string | null;
+    /** @nullable */
+    bodyText: string | null;
+    referencedVariables: string[];
+    /** @nullable */
+    previewData: TemplateVersionDtoPreviewData;
+    /** @nullable */
+    fromAddress: string | null;
+    /** @nullable */
+    replyTo: string | null;
+}
+/**
+ * Sample payload for preview and test-send — contract-validated against eventVersion.
+ */
+export type UpdateTemplateVersionDtoPreviewData = {
+    [key: string]: unknown;
+};
+export interface UpdateTemplateVersionDto {
+    /**
+     * @maxLength 500
+     * @nullable
+     */
+    subject?: string | null;
+    /** @nullable */
+    preheader?: string | null;
+    /**
+     * Raw HTML — requires the `template:author_html` capability (04 §5.1).
+     * @nullable
+     */
+    bodyHtml?: string | null;
+    /**
+     * The plain-text alternative for email; THE message for SMS.
+     * @nullable
+     */
+    bodyText?: string | null;
+    /** @nullable */
+    fromAddress?: string | null;
+    /** @nullable */
+    replyTo?: string | null;
+    /** Sample payload for preview and test-send — contract-validated against eventVersion. */
+    previewData?: UpdateTemplateVersionDtoPreviewData;
+    /** Re-target the draft at another contract version. */
+    eventVersion?: number;
+}
+/**
+ * Defaults to the version's previewData; a supplied payload is contract-validated first.
+ */
+export type PreviewTemplateVersionDtoPayload = {
+    [key: string]: unknown;
+};
+export interface PreviewTemplateVersionDto {
+    /** Defaults to the version's previewData; a supplied payload is contract-validated first. */
+    payload?: PreviewTemplateVersionDtoPayload;
+}
+export type SanitizationWarningDtoKind = typeof SanitizationWarningDtoKind[keyof typeof SanitizationWarningDtoKind];
+export declare const SanitizationWarningDtoKind: {
+    readonly stripped_tag: "stripped_tag";
+    readonly stripped_attribute: "stripped_attribute";
+    readonly stripped_style: "stripped_style";
+};
+export interface SanitizationWarningDto {
+    kind: SanitizationWarningDtoKind;
+    detail: string;
+}
+export interface TemplatePreviewDto {
+    subject: string;
+    html: string;
+    text: string;
+    /** SMS only: the segment count for this render. */
+    smsSegments?: number;
+    sanitizationWarnings: SanitizationWarningDto[];
+    links: string[];
+    /** Engine errors. A non-empty list means the version cannot render this payload. */
+    renderErrors: string[];
+}
+/**
+ * Defaults to the version's previewData.
+ */
+export type TestSendDtoPayload = {
+    [key: string]: unknown;
+};
+export interface TestSendDto {
+    /** Format-validated per channel. */
+    to: string;
+    /** Defaults to the version's previewData. */
+    payload?: TestSendDtoPayload;
+}
+/**
+ * `suppressed` when the address carries an active suppression: the row is written terminal, not sent. A test cannot punch through a hard block.
+ */
+export type TestSendResultDtoGateOutcome = typeof TestSendResultDtoGateOutcome[keyof typeof TestSendResultDtoGateOutcome];
+export declare const TestSendResultDtoGateOutcome: {
+    readonly queued: "queued";
+    readonly suppressed: "suppressed";
+};
+export interface TestSendResultDto {
+    notificationDispatchId: string;
+    /** `suppressed` when the address carries an active suppression: the row is written terminal, not sent. A test cannot punch through a hard block. */
+    gateOutcome: TestSendResultDtoGateOutcome;
+}
+export interface PublishFailureDto {
+    /** The 02 §4.2 check that failed. */
+    gate: string;
+    detail: string;
+    /** The content field the failure is in. */
+    field?: string;
+}
+export type PublishedTemplateVersionDtoLifecycleStatus = typeof PublishedTemplateVersionDtoLifecycleStatus[keyof typeof PublishedTemplateVersionDtoLifecycleStatus];
+export declare const PublishedTemplateVersionDtoLifecycleStatus: {
+    readonly draft: "draft";
+    readonly published: "published";
+    readonly archived: "archived";
+};
+/**
+ * @nullable
+ */
+export type PublishedTemplateVersionDtoPreviewData = {
+    [key: string]: unknown;
+} | null;
+export interface PublishedTemplateVersionDto {
+    notificationTemplateVersionId: string;
+    notificationTemplateId: string;
+    version: number;
+    lifecycleStatus: PublishedTemplateVersionDtoLifecycleStatus;
+    eventVersion: number;
+    createdAt: string;
+    /** @nullable */
+    publishedAt: string | null;
+    /** @nullable */
+    archivedAt: string | null;
+    /** @nullable */
+    subject: string | null;
+    /** @nullable */
+    preheader: string | null;
+    /** @nullable */
+    bodyHtml: string | null;
+    /** @nullable */
+    bodyText: string | null;
+    referencedVariables: string[];
+    /** @nullable */
+    previewData: PublishedTemplateVersionDtoPreviewData;
+    /** @nullable */
+    fromAddress: string | null;
+    /** @nullable */
+    replyTo: string | null;
+    warnings: PublishFailureDto[];
+}
 export type PreferenceDtoCategory = typeof PreferenceDtoCategory[keyof typeof PreferenceDtoCategory];
 export declare const PreferenceDtoCategory: {
     readonly marketing: "marketing";
@@ -8767,6 +9249,25 @@ export declare const LookupsControllerListV1Kind: {
     readonly 'transport-slot-kind': "transport-slot-kind";
     readonly 'organization-type': "organization-type";
 };
+export type ServicePointsControllerListV1Params = {
+    /**
+     * Postal code to search near.
+     */
+    zipCode?: string;
+    /**
+     * ISO 3166-1 alpha-2
+     */
+    countryCode?: string;
+    provider?: ServicePointsControllerListV1Provider;
+    /**
+     * Provider-specific service-point type filter.
+     */
+    type?: string;
+};
+export type ServicePointsControllerListV1Provider = typeof ServicePointsControllerListV1Provider[keyof typeof ServicePointsControllerListV1Provider];
+export declare const ServicePointsControllerListV1Provider: {
+    readonly POSTI: "POSTI";
+};
 export type IntegrationsControllerGetByIdV1200 = StripeAccountDto | FortnoxAccountDto;
 export type BillingAccountsControllerListAccountsV1Params = {
     /**