@vindentech/api-client 1.6.0-next.0 → 1.6.0-next.1

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

@@ -13434,6 +13434,416 @@ export interface UpdateTransportOptionDto {
     bookingSoftware?: string;
     active?: boolean;
 }
+export interface AnalyticsStoredVolumeDto {
+    /** Measured m³ in storage: the pods' recorded sizes. Reads low while a provider-run warehouse has not reported its measurements. */
+    measuredM3: number;
+    /**
+       * Estimated m³ in storage: an unsized pod taken at its product's size. Null for a night written before the estimate existed.
+       * @nullable
+       */
+    estimatedM3: number | null;
+    /**
+       * Share of the pods in storage that are measured, 0–1. Null when the night does not record it.
+       * @nullable
+       */
+    measuredPodShare: number | null;
+}
+export interface AnalyticsVolumePerCustomerDto {
+    /**
+       * Null when no customer has goods in storage.
+       * @nullable
+       */
+    measuredM3: number | null;
+    /** @nullable */
+    estimatedM3: number | null;
+}
+export interface AnalyticsNightsBucketDto {
+    /** Stays, or customers, in the bucket. */
+    count: number;
+    /**
+       * Average stored nights, one decimal. Null for an empty bucket.
+       * @nullable
+       */
+    averageNights: number | null;
+}
+export interface AnalyticsNightsByStatusDto {
+    /** Stored on the night. */
+    active: AnalyticsNightsBucketDto;
+    /** Ended: empty for `stayGapNights` consecutive nights. */
+    ended: AnalyticsNightsBucketDto;
+    /** Every one, including those between stays (emptied, for fewer than `stayGapNights` nights), which are in neither bucket above. */
+    all: AnalyticsNightsBucketDto;
+}
+export interface AnalyticsStorageTimeDto {
+    /** Per stay, by the stay's status. */
+    perStay: AnalyticsNightsByStatusDto;
+    /** Per customer, nights totalled across their stays, by the status of their latest stay. */
+    perCustomer: AnalyticsNightsByStatusDto;
+    /** Customers with exactly one stay, so returning customers are left out. */
+    singleStayCustomers: AnalyticsNightsByStatusDto;
+}
+export interface AnalyticsReturningCustomersDto {
+    /** Customers with two or more stays. */
+    count: number;
+    /**
+       * Their share of the customers who have stored, 0–1. Null when none has.
+       * @nullable
+       */
+    shareOfStoringCustomers: number | null;
+}
+export interface AnalyticsLifetimeValueDto {
+    /**
+       * The tenant's default currency, which lifetime revenue is counted in; revenue in any other currency is not in it. Null before the first build or for a tenant with no default currency.
+       * @nullable
+       */
+    currencyCode: string | null;
+    /**
+       * Average invoiced revenue ex VAT, minor units, of the customers whose latest stay has ended.
+       * @nullable
+       */
+    endedCustomersMinor: number | null;
+    /**
+       * The same over every customer who has stored.
+       * @nullable
+       */
+    storingCustomersMinor: number | null;
+}
+export interface AnalyticsPointInTimeDto {
+    /** The night these figures describe. */
+    date: string;
+    /** Customers with goods in storage. */
+    activeCustomers: number;
+    storedVolume: AnalyticsStoredVolumeDto;
+    averageVolumePerActiveCustomer: AnalyticsVolumePerCustomerDto;
+    /** Customers registered on or before the night, cumulative. */
+    registeredCustomers: number;
+    /** Customers who had stored by the night, cumulative. */
+    storingCustomers: number;
+    storageTime: AnalyticsStorageTimeDto;
+    returningCustomers: AnalyticsReturningCustomersDto;
+    averageLifetimeValue: AnalyticsLifetimeValueDto;
+}
+export interface AnalyticsPointInTimeSetDto {
+    asOf: AnalyticsPointInTimeDto;
+    /** The last day of the month before asOf's. */
+    previousMonthEnd: AnalyticsPointInTimeDto;
+    /** asOf a month earlier, clamped to that month's last day (31 Oct → 30 Sep). */
+    sameDayLastMonth: AnalyticsPointInTimeDto;
+}
+export interface AnalyticsRevenueCategoryDto {
+    /**
+       * The article's category; null when it has none.
+       * @nullable
+       */
+    category: string | null;
+    /** Revenue ex VAT, minor units. */
+    amountMinor: number;
+}
+export interface AnalyticsRevenueArticleDto {
+    /**
+       * Null for a row with no article.
+       * @nullable
+       */
+    articleId: string | null;
+    /** @nullable */
+    code: string | null;
+    /** @nullable */
+    name: string | null;
+    /** @nullable */
+    category: string | null;
+    /** Revenue ex VAT, minor units. */
+    amountMinor: number;
+}
+export interface AnalyticsRevenueDto {
+    currencyCode: string;
+    /** Revenue ex VAT, minor units. */
+    totalMinor: number;
+    byCategory: AnalyticsRevenueCategoryDto[];
+    byArticle: AnalyticsRevenueArticleDto[];
+}
+export interface AnalyticsPeriodDto {
+    from: string;
+    /** Included. */
+    to: string;
+    /** Customers registered in the window. */
+    newRegisteredCustomers: number;
+    /** Customers whose first stay started in the window. */
+    newStoringCustomers: number;
+    /** Invoiced revenue by invoice date, one entry per currency, never summed across currencies. Invoices sent, paid, overdue or written off; credit notes net against them. */
+    revenue: AnalyticsRevenueDto[];
+}
+export interface AnalyticsPeriodSetDto {
+    /** From the 1st of asOf's month through asOf. */
+    monthToDate: AnalyticsPeriodDto;
+    /** The same days of the month before, the last one clamped to that month's end. */
+    sameDaysLastMonth: AnalyticsPeriodDto;
+    /** The month before asOf's. */
+    lastFullMonth: AnalyticsPeriodDto;
+    /** The month before that. */
+    monthBefore: AnalyticsPeriodDto;
+}
+export interface AnalyticsRevenueTotalDto {
+    currencyCode: string;
+    /** Revenue ex VAT, minor units. */
+    totalMinor: number;
+    byCategory: AnalyticsRevenueCategoryDto[];
+}
+export interface AnalyticsRevenueYearToDateDto {
+    /** 1 January of asOf's year. */
+    from: string;
+    to: string;
+    /** One entry per currency. */
+    revenue: AnalyticsRevenueTotalDto[];
+}
+export interface AnalyticsPricePerM3MonthDto {
+    /** First day of the service month. */
+    serviceMonth: string;
+    /** Storage-category revenue ex VAT for the service month, minor units. */
+    storageRevenueMinor: number;
+    /** Average m³ stored over the month's nights, measured. */
+    averageMeasuredM3: number;
+    /**
+       * The same, estimated; null when no night of the month carries an estimate.
+       * @nullable
+       */
+    averageEstimatedM3: number | null;
+    /**
+       * Minor units per measured m³; null when nothing measured was stored.
+       * @nullable
+       */
+    pricePerMeasuredM3Minor: number | null;
+    /**
+       * Minor units per estimated m³.
+       * @nullable
+       */
+    pricePerEstimatedM3Minor: number | null;
+}
+export interface AnalyticsPricePerM3Dto {
+    currencyCode: string;
+    /** The latest service month before asOf's that has invoiced storage revenue. A month has no price until it is invoiced, so the current one never appears. */
+    lastInvoicedServiceMonth: AnalyticsPricePerM3MonthDto;
+    /** The service month before it. */
+    monthBefore: AnalyticsPricePerM3MonthDto;
+}
+export interface AnalyticsEstimateCategoryDto {
+    /** @nullable */
+    category: string | null;
+    /** Priced charges of the window, storage projected to month end, minor units. */
+    grossMinor: number;
+    /** Last window's invoiced net ÷ the priced gross it was invoiced from, for this category; 1 when last window had none. Four decimals. */
+    ratio: number;
+    /** grossMinor × ratio, minor units. */
+    estimateMinor: number;
+    /** Last window's invoiced net in this category, minor units. */
+    lastMonthActualMinor: number;
+}
+export interface AnalyticsEstimateCurrencyDto {
+    currencyCode: string;
+    /** rowsMinor + projectedMinor. */
+    grossMinor: number;
+    /** Priced charges of the window so far, minor units. */
+    rowsMinor: number;
+    /** Storage projected for the days after storageCoveredThrough, minor units. */
+    projectedMinor: number;
+    /** The estimate: the sum of the categories' estimates, minor units. */
+    estimateMinor: number;
+    /** The invoices of the previous window, net, minor units. */
+    lastMonthActualMinor: number;
+    byCategory: AnalyticsEstimateCategoryDto[];
+}
+export interface AnalyticsInvoiceEstimateDto {
+    /** Always true: these are projections, not invoices. */
+    isEstimate: boolean;
+    /** The invoice window estimated: asOf's month. */
+    windowFrom: string;
+    windowTo: string;
+    /**
+       * The day storage is counted from priced charges through; later days are projected from it. Null when the window has no priced storage to project from.
+       * @nullable
+       */
+    storageCoveredThrough: string | null;
+    /** Days of storage projected. */
+    projectedDays: number;
+    /** False while charges of the previous window are still to be invoiced, when lastMonthActualMinor is short and the ratios rest on the invoices built so far. */
+    lastMonthComplete: boolean;
+    /** One entry per currency. */
+    currencies: AnalyticsEstimateCurrencyDto[];
+}
+export interface AnalyticsOverviewDto {
+    /** The night the figures describe. */
+    asOf: string;
+    /**
+       * When the nightly analytics build these figures read was computed; null before the first.
+       * @nullable
+       */
+    computedAt: string | null;
+    /** Consecutive empty nights that end a storage stay. */
+    stayGapNights: number;
+    pointInTime: AnalyticsPointInTimeSetDto;
+    periods: AnalyticsPeriodSetDto;
+    revenueYearToDate: AnalyticsRevenueYearToDateDto;
+    /** One entry per currency with invoiced storage. */
+    averagePricePerM3: AnalyticsPricePerM3Dto[];
+    estimatedInvoicesThisMonth: AnalyticsInvoiceEstimateDto;
+}
+export interface AnalyticsDailyRowDto {
+    date: string;
+    /** Customers with goods in storage that night. */
+    activeCustomers: number;
+    measuredM3: number;
+    /**
+       * Null for a night written before the estimate existed.
+       * @nullable
+       */
+    estimatedM3: number | null;
+    /**
+       * Pods in storage with no size. Null when the night does not record it.
+       * @nullable
+       */
+    unmeasuredPods: number | null;
+    newRegisteredCustomers: number;
+    /** Customers whose first stay started that day. */
+    newStoringCustomers: number;
+    /** Registered on or before the day, cumulative. */
+    registeredCustomers: number;
+    /** Had stored by the day, cumulative. */
+    storingCustomers: number;
+}
+export interface AnalyticsDailyPageDto {
+    items: AnalyticsDailyRowDto[];
+    /**
+       * Pass as `cursor` for the next page; null on the last page.
+       * @nullable
+       */
+    nextCursor: string | null;
+}
+export type AnalyticsCustomerRowDtoOrganizationType = typeof AnalyticsCustomerRowDtoOrganizationType[keyof typeof AnalyticsCustomerRowDtoOrganizationType];
+export declare const AnalyticsCustomerRowDtoOrganizationType: {
+    readonly personal: "personal";
+    readonly business: "business";
+};
+export type AnalyticsCustomerRowDtoStatus = typeof AnalyticsCustomerRowDtoStatus[keyof typeof AnalyticsCustomerRowDtoStatus];
+export declare const AnalyticsCustomerRowDtoStatus: {
+    readonly never_stored: "never_stored";
+    readonly active: "active";
+    readonly between: "between";
+    readonly ended: "ended";
+};
+export interface AnalyticsCustomerRowDto {
+    /** The customer's pseudonymous key, stable across builds. */
+    customerKey: string;
+    organizationType: AnalyticsCustomerRowDtoOrganizationType;
+    registeredOn: string;
+    status: AnalyticsCustomerRowDtoStatus;
+    stayCount: number;
+    /** Two or more stays. */
+    isReturning: boolean;
+    /** @nullable */
+    firstStoredOn: string | null;
+    totalStoredNights: number;
+    /** Measured m³ in storage on the latest night built. */
+    currentMeasuredM3: number;
+    /** @nullable */
+    currentEstimatedM3: number | null;
+    /** Invoiced revenue ex VAT in currencyCode, minor units. */
+    lifetimeRevenueMinor: number;
+    /**
+       * The tenant's default currency.
+       * @nullable
+       */
+    currencyCode: string | null;
+}
+export interface AnalyticsCustomerPageDto {
+    items: AnalyticsCustomerRowDto[];
+    /**
+       * Pass as `cursor` for the next page; null on the last page.
+       * @nullable
+       */
+    nextCursor: string | null;
+}
+export type AnalyticsStayRowDtoStatus = typeof AnalyticsStayRowDtoStatus[keyof typeof AnalyticsStayRowDtoStatus];
+export declare const AnalyticsStayRowDtoStatus: {
+    readonly active: "active";
+    readonly between: "between";
+    readonly ended: "ended";
+};
+export interface AnalyticsStayRowDto {
+    customerKey: string;
+    /** 1 for the customer's first stay, then 2, 3, … */
+    stayNumber: number;
+    startedOn: string;
+    lastStoredOn: string;
+    /**
+       * The first of the empty nights that ended the stay; null until it has ended.
+       * @nullable
+       */
+    endedOn: string | null;
+    status: AnalyticsStayRowDtoStatus;
+    /** Nights with goods in storage; empty nights inside the stay are not counted. */
+    storedNights: number;
+    averageMeasuredM3: number;
+    peakMeasuredM3: number;
+    /** @nullable */
+    averageEstimatedM3: number | null;
+    /** @nullable */
+    peakEstimatedM3: number | null;
+}
+export interface AnalyticsStayPageDto {
+    items: AnalyticsStayRowDto[];
+    /**
+       * Pass as `cursor` for the next page; null on the last page.
+       * @nullable
+       */
+    nextCursor: string | null;
+}
+export interface AnalyticsCustomerMonthRowDto {
+    /** First day of the month. */
+    month: string;
+    customerKey: string;
+    /** Nights with goods in storage that month; at least 1. */
+    storedNights: number;
+    /** Over the stored nights. */
+    averageMeasuredM3: number;
+    peakMeasuredM3: number;
+    /** @nullable */
+    averageEstimatedM3: number | null;
+    /** @nullable */
+    peakEstimatedM3: number | null;
+}
+export interface AnalyticsCustomerMonthPageDto {
+    items: AnalyticsCustomerMonthRowDto[];
+    /**
+       * Pass as `cursor` for the next page; null on the last page.
+       * @nullable
+       */
+    nextCursor: string | null;
+}
+export interface AnalyticsRevenueRowDto {
+    /** First day of the invoice's month. */
+    invoiceMonth: string;
+    /** First day of the month the charge was for. */
+    serviceMonth: string;
+    customerKey: string;
+    currencyCode: string;
+    /** @nullable */
+    articleId: string | null;
+    /** @nullable */
+    articleCode: string | null;
+    /** @nullable */
+    articleName: string | null;
+    /** @nullable */
+    articleCategory: string | null;
+    /** Revenue ex VAT, minor units; negative where credit notes outweigh. */
+    amountMinor: number;
+}
+export interface AnalyticsRevenuePageDto {
+    items: AnalyticsRevenueRowDto[];
+    /**
+       * Pass as `cursor` for the next page; null on the last page.
+       * @nullable
+       */
+    nextCursor: string | null;
+}
 export type OrdersControllerListV1Params = {
     /**
      * Max rows to return (1–100).
@@ -15249,4 +15659,103 @@ export type TransportOptionsControllerListV1Params = {
      */
     active?: boolean;
 };
+export type AnalyticsControllerOverviewV1Params = {
+    /**
+     * The night the figures describe (YYYY-MM-DD), in the tenant's billing calendar. Defaults to the latest night the nightly analytics build covers, normally last night. A later night is 400 as_of_not_built.
+     */
+    asOf?: string;
+};
+export type AnalyticsControllerDailyV1Params = {
+    /**
+     * The `nextCursor` of the previous page. Omit for the first page.
+     */
+    cursor?: string;
+    /**
+     * Rows per page (1–5000).
+     * @minimum 1
+     * @maximum 5000
+     */
+    limit?: number;
+    /**
+     * First day (YYYY-MM-DD), in the billing calendar. Defaults to the 1st of the month twelve months before `to`'s. A monthly dataset covers `from`'s month.
+     */
+    from?: string;
+    /**
+     * Last day, included. Defaults to the latest night the nightly build covers. The range may span at most 25 calendar months.
+     */
+    to?: string;
+};
+export type AnalyticsControllerCustomersV1Params = {
+    /**
+     * The `nextCursor` of the previous page. Omit for the first page.
+     */
+    cursor?: string;
+    /**
+     * Rows per page (1–5000).
+     * @minimum 1
+     * @maximum 5000
+     */
+    limit?: number;
+};
+export type AnalyticsControllerStaysV1Params = {
+    /**
+     * The `nextCursor` of the previous page. Omit for the first page.
+     */
+    cursor?: string;
+    /**
+     * Rows per page (1–5000).
+     * @minimum 1
+     * @maximum 5000
+     */
+    limit?: number;
+};
+export type AnalyticsControllerCustomerMonthsV1Params = {
+    /**
+     * The `nextCursor` of the previous page. Omit for the first page.
+     */
+    cursor?: string;
+    /**
+     * Rows per page (1–5000).
+     * @minimum 1
+     * @maximum 5000
+     */
+    limit?: number;
+    /**
+     * First day (YYYY-MM-DD), in the billing calendar. Defaults to the 1st of the month twelve months before `to`'s. A monthly dataset covers `from`'s month.
+     */
+    from?: string;
+    /**
+     * Last day, included. Defaults to the latest night the nightly build covers. The range may span at most 25 calendar months.
+     */
+    to?: string;
+};
+export type AnalyticsControllerRevenueV1Params = {
+    /**
+     * The `nextCursor` of the previous page. Omit for the first page.
+     */
+    cursor?: string;
+    /**
+     * Rows per page (1–5000).
+     * @minimum 1
+     * @maximum 5000
+     */
+    limit?: number;
+    /**
+     * First day (YYYY-MM-DD), in the billing calendar. Defaults to the 1st of the month twelve months before `to`'s. A monthly dataset covers `from`'s month.
+     */
+    from?: string;
+    /**
+     * Last day, included. Defaults to the latest night the nightly build covers. The range may span at most 25 calendar months.
+     */
+    to?: string;
+    /**
+     * Which month `from`/`to` select and the rows are ordered by: the invoice's month, or the month the charge was for.
+     */
+    dateBasis?: AnalyticsControllerRevenueV1DateBasis;
+};
+export type AnalyticsControllerRevenueV1DateBasis = typeof AnalyticsControllerRevenueV1DateBasis[keyof typeof AnalyticsControllerRevenueV1DateBasis];
+export declare const AnalyticsControllerRevenueV1DateBasis: {
+    readonly invoice: "invoice";
+    readonly service: "service";
+};
 //# sourceMappingURL=index.schemas.d.ts.map