@vindentech/api-client 0.3.0-next.76 → 0.3.0-next.77

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

@@ -2680,9 +2680,9 @@ export interface QuoteLineDto {
     reference: string | null;
     description: string;
     quantity: number;
-    /** Unit price ex-VAT, integer minor units of the quote currency. This is the catalogue price BEFORE any binding discount — with one applied it no longer multiplies out to `lineTotalExVatMinor` (a 100% start-fee waiver leaves a priced unit against a zero line). Sum `lineTotalExVatMinor`, never unit × quantity, or the result contradicts `totals`. */
+    /** Unit price ex-VAT, integer minor units of the quote currency. This is the catalogue price BEFORE any campaign or binding discount — with one applied it no longer multiplies out to `lineTotalExVatMinor` (a 100% start-fee waiver leaves a priced unit against a zero line). Sum `lineTotalExVatMinor`, never unit × quantity, or the result contradicts `totals`. */
     unitPriceExVatMinor: number;
-    /** Line total ex-VAT, integer minor units, AFTER any binding discount — the amount that reaches `totals` */
+    /** Line total ex-VAT, integer minor units, AFTER any campaign and binding discount — the amount that reaches `totals` */
     lineTotalExVatMinor: number;
     /**
        * How much the binding plan took off this line, integer minor units. Null when no discount applied.
@@ -2694,6 +2694,11 @@ export interface QuoteLineDto {
        * @nullable
        */
     couponDiscountIncVatMinor: number | null;
+    /**
+       * How much the automatic campaigns took off this line, ex-VAT, integer minor units. Taken first — before the binding discount, which applies to what is left, and before the coupon — as the invoice takes them. Like `discountExVatMinor` it is already subtracted from `lineTotalExVatMinor`. Null when no campaign reduces this line.
+       * @nullable
+       */
+    campaignDiscountExVatMinor: number | null;
     /** VAT rate as a percentage, per the platform-wide NUMERIC(6,4) convention (25 = 25%) */
     vatRate: number;
     /** Whether this line qualifies for the RUT labour deduction */
@@ -2726,6 +2731,47 @@ export interface QuoteCouponDto {
     code: string;
     /** Discount applied to the payable total, integer minor units — the sum of `lines[].couponDiscountIncVatMinor`, which is only the lines the coupon's benefits are scoped to. Read that field for which lines they were. */
     discountMinor: number;
+    /** Always false: this is the code the customer entered. An automatic campaign is reported in `campaigns`, where it is true. */
+    automatic: boolean;
+}
+/**
+ * Present when `valid` is false. `not_combinable`: an automatic campaign this cart runs under refuses a code alongside it.
+ */
+export type QuoteCouponValidationDtoReason = typeof QuoteCouponValidationDtoReason[keyof typeof QuoteCouponValidationDtoReason];
+export declare const QuoteCouponValidationDtoReason: {
+    readonly not_found: "not_found";
+    readonly inactive: "inactive";
+    readonly not_yet_valid: "not_yet_valid";
+    readonly expired: "expired";
+    readonly not_combinable: "not_combinable";
+};
+export interface QuoteCouponValidationDto {
+    valid: boolean;
+    /** Present when `valid` is false. `not_combinable`: an automatic campaign this cart runs under refuses a code alongside it. */
+    reason?: QuoteCouponValidationDtoReason;
+}
+/**
+ * `qualifies`: placing this cart enrols the account. `provisional`: a guest cart qualifies if this is the customer's first order — confirmed when the cart is claimed, or at placement. `enrolled`: the account already takes part.
+ */
+export type QuoteCampaignDtoStatus = typeof QuoteCampaignDtoStatus[keyof typeof QuoteCampaignDtoStatus];
+export declare const QuoteCampaignDtoStatus: {
+    readonly qualifies: "qualifies";
+    readonly provisional: "provisional";
+    readonly enrolled: "enrolled";
+};
+export interface QuoteCampaignDto {
+    /** The campaign's `billing.coupon` */
+    couponId: string;
+    /** Always true: granted automatically, never entered as a code */
+    automatic: boolean;
+    /** Whether a code may be used alongside it. When false the cart's code is refused — see `couponValidation`. */
+    combinable: boolean;
+    /** `qualifies`: placing this cart enrols the account. `provisional`: a guest cart qualifies if this is the customer's first order — confirmed when the cart is claimed, or at placement. `enrolled`: the account already takes part. */
+    status: QuoteCampaignDtoStatus;
+    /** What this campaign took off, ex-VAT, integer minor units — its share of `lines[].campaignDiscountExVatMinor`, already out of `totals`. */
+    discountExVatMinor: number;
+    /** The same reduction inc-VAT, minor units — the saving to show a consumer. Summed per line at that line's own rate. */
+    discountIncVatMinor: number;
 }
 export interface QuoteBindingDto {
     bindingPlanId: string;
@@ -2758,17 +2804,17 @@ export interface QuoteDiscountDto {
     discountExVatMinor: number;
 }
 export interface QuoteTotalsDto {
-    /** Sum of line totals ex-VAT after binding discounts, minor units */
+    /** Sum of line totals ex-VAT after campaign and binding discounts, minor units */
     exVatMinor: number;
     /** Total VAT, minor units */
     vatMinor: number;
     /** exVat + vat, minor units */
     incVatMinor: number;
-    /** What the customer pays: incVat − coupon discount − RUT deduction, minor units */
+    /** What the customer pays: incVat − coupon discount − RUT deduction, minor units. Campaigns are already out of incVat. */
     payableMinor: number;
     /** What the binding plan took off, ex-VAT, minor units. The number to compare options by: `payableMinor` also carries the coupon and the RUT deduction, both of which floor at zero and can make two options look identical. */
     discountExVatMinor: number;
-    /** The same reduction inc-VAT, minor units — the figure to show a consumer as their saving. Summed per line at that line's own rate, so `incVatMinor + discountIncVatMinor` is exactly what this cart would have come to undiscounted. Grossing `discountExVatMinor` up by the bundle's inc/ex ratio instead is only right when every discounted line carries the same VAT rate. */
+    /** The same reduction inc-VAT, minor units — the figure to show a consumer as their saving. Summed per line at that line's own rate, so `incVatMinor + discountIncVatMinor` is exactly what this cart would have come to with no binding plan; add `campaigns[].discountIncVatMinor` for the price with no campaign either. Grossing `discountExVatMinor` up by the bundle's inc/ex ratio instead is only right when every discounted line carries the same VAT rate. */
     discountIncVatMinor: number;
 }
 export interface QuoteBindingOptionDto {
@@ -2797,6 +2843,13 @@ export interface QuoteResponseDto {
     volume: QuoteVolumeDto;
     /** @nullable */
     coupon: QuoteCouponDto | null;
+    /**
+       * The cart's code, validated. Null when the cart carries no code.
+       * @nullable
+       */
+    couponValidation: QuoteCouponValidationDto | null;
+    /** Automatic campaigns this cart qualifies for or already runs under. Empty when none. */
+    campaigns: QuoteCampaignDto[];
     /**
        * The binding plan in force for this quote, or null when there is none
        * @nullable
@@ -3136,6 +3189,11 @@ export interface SlotPriceDto {
     perHourExVat?: string | null;
     /** @nullable */
     baseFeeExVat?: string | null;
+    /**
+       * Money, ex VAT: what this window adds ON TOP of the base transport price — show it as "+X". Null when the window carries no surcharge, or when `baseFeeExVat` is set: a slot's own price is its whole price, and no surcharge is added to it.
+       * @nullable
+       */
+    windowSurchargeExVat: string | null;
     /** @nullable */
     vatRate: string | null;
     /** @nullable */
@@ -3832,7 +3890,7 @@ export declare const CreateSlotConfigDtoSlotKind: {
     readonly PICKUP_WINDOW: "PICKUP_WINDOW";
 };
 /**
- * Per-weekday windows (incl. per-slot base_max_orders / price_ex_vat). NULL = daily-cap-only.
+ * Per-weekday windows (incl. per-slot base_max_orders / price_ex_vat / express_surcharge_ex_vat). price_ex_vat is a full override of the window's price; express_surcharge_ex_vat (>= 0) is added on top of the base price instead. NULL = daily-cap-only.
  */
 export type CreateSlotConfigDtoWeeklySchedule = {
     [key: string]: unknown;
@@ -3843,7 +3901,7 @@ export interface CreateSlotConfigDto {
     /** NULL = daily-cap-only (no concrete slots). */
     slotKind?: CreateSlotConfigDtoSlotKind;
     timezone?: string;
-    /** Per-weekday windows (incl. per-slot base_max_orders / price_ex_vat). NULL = daily-cap-only. */
+    /** Per-weekday windows (incl. per-slot base_max_orders / price_ex_vat / express_surcharge_ex_vat). price_ex_vat is a full override of the window's price; express_surcharge_ex_vat (>= 0) is added on top of the base price instead. NULL = daily-cap-only. */
     weeklySchedule?: CreateSlotConfigDtoWeeklySchedule;
     dayMaxOrders?: number;
     /** bigint */
@@ -4017,14 +4075,14 @@ export interface SlotDto {
        */
     baseMaxWeightG: number | null;
     /**
-       * money
+       * money — a full override of the slot's transport price; no window surcharge is added to it
        * @nullable
        */
     priceExVat: string | null;
     /** @nullable */
     vatRate: string | null;
     /**
-       * money
+       * money — the window surcharge: what this window adds on top of the base price (>= 0). Ignored while priceExVat is set.
        * @nullable
        */
     expressSurchargeExVat: string | null;
@@ -4091,7 +4149,7 @@ export interface PatchSlotDto {
     manuallyClosed?: boolean;
     /** money */
     priceExVat?: string;
-    /** money */
+    /** money — the window surcharge, added on top of the base price; never negative. Ignored while priceExVat is set. */
     expressSurchargeExVat?: string;
     windowStart?: string;
     windowEnd?: string;
@@ -4164,14 +4222,14 @@ export interface SlotWithAvailabilityDto {
        */
     baseMaxWeightG: number | null;
     /**
-       * money
+       * money — a full override of the slot's transport price; no window surcharge is added to it
        * @nullable
        */
     priceExVat: string | null;
     /** @nullable */
     vatRate: string | null;
     /**
-       * money
+       * money — the window surcharge: what this window adds on top of the base price (>= 0). Ignored while priceExVat is set.
        * @nullable
        */
     expressSurchargeExVat: string | null;
@@ -8057,6 +8115,14 @@ export interface PaginatedInvoicesDto {
     /** Effective rows skipped applied. */
     offset: number;
 }
+export interface AppliedCouponSummaryDto {
+    couponId: string;
+    couponBenefitId: string;
+    /** percentage / fixed_amount / replacement_price. */
+    benefitType: string;
+    /** 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;
+}
 export interface InvoiceRowDto {
     invoiceRowId: string;
     /** @nullable */
@@ -8073,8 +8139,13 @@ export interface InvoiceRowDto {
     vatRate: string;
     /** ISO 4217 currency code. */
     currencyCode: string;
-    /** @nullable */
+    /**
+       * Explanation printed on the invoice line: why a floor or minimum period applied, and the title of a campaign or discount code that reduced the row, in the customer's language.
+       * @nullable
+       */
     freeText: string | null;
+    /** Coupon benefits that reduced this row. Empty when none did. */
+    appliedCoupons: AppliedCouponSummaryDto[];
     /**
        * 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
@@ -8396,6 +8467,14 @@ export declare const TenantBillingConfigDtoPriceBookMode: {
     readonly shadow: "shadow";
     readonly live: "live";
 };
+/**
+ * When one-off charges (a transport, its start fee, a failed-transport or packaging fee) are invoiced: `per_charge` (on an invoice of their own, the day after they are incurred) or `monthly` (on the calendar month's invoice beside storage, once the month has closed). Storage, subscription and recurring charges are invoiced monthly either way. Defaults to `per_charge`. Written by platform admins only.
+ */
+export type TenantBillingConfigDtoOneOffInvoicing = typeof TenantBillingConfigDtoOneOffInvoicing[keyof typeof TenantBillingConfigDtoOneOffInvoicing];
+export declare const TenantBillingConfigDtoOneOffInvoicing: {
+    readonly per_charge: "per_charge";
+    readonly monthly: "monthly";
+};
 export interface TenantBillingConfigDto {
     tenantBillingConfigId: string;
     tenantId: string;
@@ -8418,6 +8497,10 @@ export interface TenantBillingConfigDto {
     corporateIdentityNumber: string | null;
     /** Which pricing source the checkout quote serves: `legacy` (price list + transport rate card), `shadow` (legacy served, the pricing-engine quote computed beside it and every difference logged), or `live` (the pricing-engine quote, from the pricing rules the invoice uses). Written by platform admins only. */
     priceBookMode: TenantBillingConfigDtoPriceBookMode;
+    /** The tenant's billing calendar: the IANA timezone its storage nights, invoice windows and billable-event dates are counted in. Defaults to `Europe/Stockholm`. Written by platform admins only, and fixed once the tenant has an invoice. */
+    timezone: string;
+    /** When one-off charges (a transport, its start fee, a failed-transport or packaging fee) are invoiced: `per_charge` (on an invoice of their own, the day after they are incurred) or `monthly` (on the calendar month's invoice beside storage, once the month has closed). Storage, subscription and recurring charges are invoiced monthly either way. Defaults to `per_charge`. Written by platform admins only. */
+    oneOffInvoicing: TenantBillingConfigDtoOneOffInvoicing;
     createdAt: string;
     updatedAt: string;
     enabledCurrencies: EnabledCurrencyDto[];
@@ -8431,6 +8514,14 @@ export declare const UpdateTenantBillingConfigDtoPriceBookMode: {
     readonly shadow: "shadow";
     readonly live: "live";
 };
+/**
+ * When one-off charges are invoiced (see the read model). **Changed by platform admins only**: anyone else sending a value that differs from the current one gets 403 and nothing is written. Sending the current value back — a form that round-trips the object — is accepted. A change applies to the charges not yet invoiced; nothing already invoiced moves.
+ */
+export type UpdateTenantBillingConfigDtoOneOffInvoicing = typeof UpdateTenantBillingConfigDtoOneOffInvoicing[keyof typeof UpdateTenantBillingConfigDtoOneOffInvoicing];
+export declare const UpdateTenantBillingConfigDtoOneOffInvoicing: {
+    readonly per_charge: "per_charge";
+    readonly monthly: "monthly";
+};
 export interface UpdateTenantBillingConfigDto {
     defaultPaymentMethodId?: string;
     defaultPaymentTermId?: string;
@@ -8441,6 +8532,10 @@ export interface UpdateTenantBillingConfigDto {
     corporateIdentityNumber?: string;
     /** Which pricing source the checkout quote serves (see the read model). **Changed by platform admins only**: anyone else sending a value that differs from the current one gets 403 and nothing is written. Sending the current value back — a form that round-trips the object — is accepted. */
     priceBookMode?: UpdateTenantBillingConfigDtoPriceBookMode;
+    /** The tenant's billing calendar (see the read model): a canonical IANA timezone name. **Changed by platform admins only**, and only before the tenant's first invoice: anyone else sending a value that differs from the current one gets 403, and a change once the tenant has an invoice gets 409. Sending the current value back — a form that round-trips the object — is accepted. */
+    timezone?: string;
+    /** When one-off charges are invoiced (see the read model). **Changed by platform admins only**: anyone else sending a value that differs from the current one gets 403 and nothing is written. Sending the current value back — a form that round-trips the object — is accepted. A change applies to the charges not yet invoiced; nothing already invoiced moves. */
+    oneOffInvoicing?: UpdateTenantBillingConfigDtoOneOffInvoicing;
     changeReason?: string;
 }
 export interface EnabledCurrencyInputDto {
@@ -8934,6 +9029,25 @@ export interface CouponDto {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * @nullable
+ */
+export type CouponBenefitDtoMaxQuantityUnit = typeof CouponBenefitDtoMaxQuantityUnit[keyof typeof CouponBenefitDtoMaxQuantityUnit] | null;
+export declare const CouponBenefitDtoMaxQuantityUnit: {
+    readonly m3: "m3";
+    readonly hours: "hours";
+};
+/**
+ * Which of an invoice line's events share one cap. Null on a money cap written before caps had a scope, which means per_billing_period.
+ * @nullable
+ */
+export type CouponBenefitDtoCapScope = typeof CouponBenefitDtoCapScope[keyof typeof CouponBenefitDtoCapScope] | null;
+export declare const CouponBenefitDtoCapScope: {
+    readonly per_event: "per_event";
+    readonly per_order: "per_order";
+    readonly per_billing_period: "per_billing_period";
+    readonly lifetime: "lifetime";
+};
 export interface CouponBenefitDto {
     couponBenefitId: string;
     couponId: string;
@@ -8954,12 +9068,44 @@ export interface CouponBenefitDto {
     grantCreditAmountMinor: number | null;
     /** @nullable */
     maxDiscountMinor: number | null;
+    /**
+       * Quantity cap, in maxQuantityUnit.
+       * @nullable
+       */
+    maxQuantity: number | null;
+    /** @nullable */
+    maxQuantityUnit: CouponBenefitDtoMaxQuantityUnit;
+    /**
+       * Which of an invoice line's events share one cap. Null on a money cap written before caps had a scope, which means per_billing_period.
+       * @nullable
+       */
+    capScope: CouponBenefitDtoCapScope;
     /** @nullable */
     currencyCode: string | null;
     /** Application priority (lower applies first). */
     priority: number;
     createdAt: string;
 }
+export interface CouponTextDto {
+    couponTextId: string;
+    couponId: string;
+    /** BCP-47 locale. */
+    locale: string;
+    /** Name of the offer as the customer reads it. Also labels the invoice rows the coupon reduces. */
+    title: string;
+    /**
+       * One or two sentences for a banner or the cart.
+       * @nullable
+       */
+    summary: string | null;
+    /**
+       * The offer's terms, e.g. its clawback rule.
+       * @nullable
+       */
+    terms: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
 export interface CouponDetailDto {
     couponId: string;
     tenantId: string;
@@ -9002,6 +9148,8 @@ export interface CouponDetailDto {
     updatedAt: string;
     /** The coupon's benefits. */
     benefits: CouponBenefitDto[];
+    /** The coupon's customer-facing texts, one per locale, ordered by locale. A locale with no text falls back to another (same language, then the tenant's default, then en-GB). */
+    texts: CouponTextDto[];
 }
 export type CouponValidationDtoReason = typeof CouponValidationDtoReason[keyof typeof CouponValidationDtoReason];
 export declare const CouponValidationDtoReason: {
@@ -9106,6 +9254,23 @@ export declare const CreateCouponBenefitDtoBenefitType: {
     readonly replacement_price: "replacement_price";
     readonly grant_account_credit: "grant_account_credit";
 };
+/**
+ * Unit of maxQuantity: m3 (stored or moved volume) or hours. Required iff maxQuantity is set.
+ */
+export type CreateCouponBenefitDtoMaxQuantityUnit = typeof CreateCouponBenefitDtoMaxQuantityUnit[keyof typeof CreateCouponBenefitDtoMaxQuantityUnit];
+export declare const CreateCouponBenefitDtoMaxQuantityUnit: {
+    readonly m3: "m3";
+    readonly hours: "hours";
+};
+/**
+ * Which of an invoice line's priced events share one cap, money and quantity alike. per_event: each event alone. per_order: the events of one sales order — a storage night bills no order and is its own event, so a per_order m³ cap on storage bounds the account's volume held per night. per_billing_period: the whole invoice line. Required with maxQuantity; a maxDiscountMinor given without it is stored as per_billing_period. lifetime is not accepted yet.
+ */
+export type CreateCouponBenefitDtoCapScope = typeof CreateCouponBenefitDtoCapScope[keyof typeof CreateCouponBenefitDtoCapScope];
+export declare const CreateCouponBenefitDtoCapScope: {
+    readonly per_event: "per_event";
+    readonly per_order: "per_order";
+    readonly per_billing_period: "per_billing_period";
+};
 export interface CreateCouponBenefitDto {
     benefitType: CreateCouponBenefitDtoBenefitType;
     /** Target article. Required (with or instead of articleCategory) for discount-style benefits. */
@@ -9122,11 +9287,31 @@ export interface CreateCouponBenefitDto {
     grantCreditAmountMinor?: number;
     /** Money cap on a percentage discount (minor units). Forces currencyCode to be set. */
     maxDiscountMinor?: number;
+    /** Quantity cap: the most of what a row measured that the benefit reaches, in maxQuantityUnit (at most 4 decimals). Above it the benefit reaches cap / quantity of the row's amount and the rest is billed in full. A row measured in no quantity (a start fee, a fixed surcharge) takes the benefit in full. Requires maxQuantityUnit and capScope; not allowed on grant_account_credit. */
+    maxQuantity?: number;
+    /** Unit of maxQuantity: m3 (stored or moved volume) or hours. Required iff maxQuantity is set. */
+    maxQuantityUnit?: CreateCouponBenefitDtoMaxQuantityUnit;
+    /** Which of an invoice line's priced events share one cap, money and quantity alike. per_event: each event alone. per_order: the events of one sales order — a storage night bills no order and is its own event, so a per_order m³ cap on storage bounds the account's volume held per night. per_billing_period: the whole invoice line. Required with maxQuantity; a maxDiscountMinor given without it is stored as per_billing_period. lifetime is not accepted yet. */
+    capScope?: CreateCouponBenefitDtoCapScope;
     /** ISO 4217 currency code. Required for fixed_amount/replacement_price/grant_account_credit and for a capped percentage; omitted for an uncapped percentage. */
     currencyCode?: string;
     /** Application priority (lower applies first); default 100. */
     priority?: number;
 }
+export interface UpsertCouponTextDto {
+    /** @maxLength 80 */
+    title: string;
+    /**
+       * @maxLength 500
+       * @nullable
+       */
+    summary?: string | null;
+    /**
+       * @maxLength 2000
+       * @nullable
+       */
+    terms?: string | null;
+}
 /**
  * Redemption source (default manual).
  */
@@ -9966,6 +10151,130 @@ export interface DiscardPriceBookChangeSetDto {
     /** The change set version being discarded; a stale version is a 409. */
     version: number;
 }
+/**
+ * @nullable
+ */
+export type MeCampaignBenefitDtoMaxQuantityUnit = typeof MeCampaignBenefitDtoMaxQuantityUnit[keyof typeof MeCampaignBenefitDtoMaxQuantityUnit] | null;
+export declare const MeCampaignBenefitDtoMaxQuantityUnit: {
+    readonly m3: "m3";
+    readonly hours: "hours";
+};
+/**
+ * What one cap covers: per_order is each order (for storage, the volume held on any one night); per_event each charge; per_billing_period each invoice line.
+ * @nullable
+ */
+export type MeCampaignBenefitDtoCapScope = typeof MeCampaignBenefitDtoCapScope[keyof typeof MeCampaignBenefitDtoCapScope] | null;
+export declare const MeCampaignBenefitDtoCapScope: {
+    readonly per_event: "per_event";
+    readonly per_order: "per_order";
+    readonly per_billing_period: "per_billing_period";
+    readonly lifetime: "lifetime";
+};
+export interface MeCampaignBenefitDto {
+    couponBenefitId: string;
+    /** @nullable */
+    articleId: string | null;
+    /**
+       * Article category the benefit applies to, e.g. storage.
+       * @nullable
+       */
+    articleCategory: string | null;
+    /** percentage / fixed_amount / replacement_price / grant_account_credit. */
+    benefitType: string;
+    /**
+       * Percentage off in basis points (5000 = 50 %).
+       * @nullable
+       */
+    discountPercentBps: number | null;
+    /**
+       * Amount off in minor currency units.
+       * @nullable
+       */
+    discountAmountMinor: number | null;
+    /**
+       * Price charged instead, in minor currency units.
+       * @nullable
+       */
+    replacementPriceMinor: number | null;
+    /**
+       * Account credit granted, in minor currency units.
+       * @nullable
+       */
+    grantCreditAmountMinor: number | null;
+    /**
+       * Cap on the reduction, in minor currency units.
+       * @nullable
+       */
+    maxDiscountMinor: number | null;
+    /**
+       * The most the benefit reaches, in maxQuantityUnit: 10 with m3 is "up to 10 m³". Above it, full price.
+       * @nullable
+       */
+    maxQuantity: number | null;
+    /** @nullable */
+    maxQuantityUnit: MeCampaignBenefitDtoMaxQuantityUnit;
+    /**
+       * What one cap covers: per_order is each order (for storage, the volume held on any one night); per_event each charge; per_billing_period each invoice line.
+       * @nullable
+       */
+    capScope: MeCampaignBenefitDtoCapScope;
+    /** @nullable */
+    currencyCode: string | null;
+    /** Application order (lower applies first). */
+    priority: number;
+}
+export interface MeCampaignDto {
+    campaignEnrollmentId: string;
+    couponId: string;
+    /** The campaign version the customer enrolled under. */
+    couponVersion: number;
+    /** Enrolment status. Only `active` enrolments are listed. */
+    status: string;
+    /**
+       * Locale of `title` / `summary` / `terms`. Differs from the one asked for when the campaign has no text in it: the fallback is the same language, then the tenant's default, then en-GB, then any text. Null only when the campaign has no text at all.
+       * @nullable
+       */
+    locale: string | null;
+    /** @nullable */
+    title: string | null;
+    /** @nullable */
+    summary: string | null;
+    /** @nullable */
+    terms: string | null;
+    /** one_time / repeating_months / forever. */
+    durationType: string;
+    /**
+       * Benefit length in months, for repeating_months.
+       * @nullable
+       */
+    durationInMonths: number | null;
+    /** Ordered as they apply. */
+    benefits: MeCampaignBenefitDto[];
+    /**
+       * Planned date of the first pickup, which the benefit window starts from. Null until one is placed.
+       * @nullable
+       */
+    anchorDate: string | null;
+    /**
+       * First day the benefit applies.
+       * @nullable
+       */
+    appliesFrom: string | null;
+    /**
+       * EXCLUSIVE end of the benefit window: the benefit applies up to the day before. Null for a benefit with no end, or before the first pickup anchors the window.
+       * @nullable
+       */
+    appliesUntil: string | null;
+    /**
+       * If the customer's storage ends before this date, the granted benefit is charged back on the next invoice. Null when the campaign has no clawback.
+       * @nullable
+       */
+    clawbackUntil: string | null;
+}
+export interface MeCampaignsDto {
+    /** The caller's organization's active campaigns whose benefit or clawback window is still open (or not yet anchored). Empty when there are none, and for a caller who is not an organization user. */
+    campaigns: MeCampaignDto[];
+}
 export interface StripeWebhookAckDto {
     /** Always true once the event was accepted. */
     received: boolean;
@@ -13866,6 +14175,18 @@ export type InvoiceBasisRowsControllerListInvoiceBasisRowsV1Params = {
      */
     invoiced?: boolean;
 };
+export type MeCampaignControllerListV1Params = {
+    /**
+     * Language to show the texts in. Omit it to get the customer's own: the organization's preferred locale, else its billing account's country.
+     */
+    locale?: MeCampaignControllerListV1Locale;
+};
+export type MeCampaignControllerListV1Locale = typeof MeCampaignControllerListV1Locale[keyof typeof MeCampaignControllerListV1Locale];
+export declare const MeCampaignControllerListV1Locale: {
+    readonly 'sv-SE': "sv-SE";
+    readonly 'en-GB': "en-GB";
+    readonly 'fi-FI': "fi-FI";
+};
 export type UsersControllerListV1Params = {
     /**
      * Case-insensitive substring match over display name OR email. Omit to list the first page of the directory.