@munchi_oy/core 1.9.113 → 1.9.116

package/dist/generated/api.d.ts

@@ -10053,6 +10053,24 @@ export interface MunchiPaySessionDto {
      * @memberof MunchiPaySessionDto
      */
     'metadata'?: object;
+    /**
+     * Total amount refunded against this sale, in cents. Always 0 for non-SALE purpose sessions.
+     * @type {number}
+     * @memberof MunchiPaySessionDto
+     */
+    'refundedAmount': number;
+    /**
+     * True when refundedAmount >= amount (fully refunded).
+     * @type {boolean}
+     * @memberof MunchiPaySessionDto
+     */
+    'isFullyRefunded': boolean;
+    /**
+     * True when 0 < refundedAmount < amount (partially refunded).
+     * @type {boolean}
+     * @memberof MunchiPaySessionDto
+     */
+    'isPartiallyRefunded': boolean;
     /**
      *
      * @type {string}
@@ -12751,6 +12769,12 @@ export interface ParkPosOrderDto {
      * @memberof ParkPosOrderDto
      */
     'order': ParkPosOrderDtoOrder;
+    /**
+     * Line items cancelled by this operation only, never the accumulated history. A line already dispatched is cancelled on the order and revised on every ticket it reached; a line the request does not name is untouched. Absent on an ordinary park.
+     * @type {Array<string>}
+     * @memberof ParkPosOrderDto
+     */
+    'cancelledLineItemIds'?: Array<string>;
 }
 /**
  * POS order snapshot to park. Server-owned fields (payments, refunds, loyalty, completion and routing outcomes) are ignored, and a line the server has already dispatched keeps its server state.
@@ -14439,6 +14463,111 @@ export declare const PaymentReportingBucket: {
     readonly Other: "other";
 };
 export type PaymentReportingBucket = typeof PaymentReportingBucket[keyof typeof PaymentReportingBucket];
+/**
+ *
+ * @export
+ * @interface PaymentSessionAnalyticsMethodBreakdownDto
+ */
+export interface PaymentSessionAnalyticsMethodBreakdownDto {
+    /**
+     * Paymethod code, e.g. Card / Debit / Credit / Edenred.
+     * @type {string}
+     * @memberof PaymentSessionAnalyticsMethodBreakdownDto
+     */
+    'paymethod': string;
+    /**
+     *
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsMethodBreakdownDto
+     */
+    'count': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsMethodBreakdownDto
+     */
+    'amount': number;
+}
+/**
+ *
+ * @export
+ * @interface PaymentSessionAnalyticsResolvedRangeDto
+ */
+export interface PaymentSessionAnalyticsResolvedRangeDto {
+    /**
+     * Schedule-resolved range start. Not calendar midnight for DAY timeSpan.
+     * @type {string}
+     * @memberof PaymentSessionAnalyticsResolvedRangeDto
+     */
+    'start': string;
+    /**
+     * Schedule-resolved range end. Not calendar midnight for DAY timeSpan.
+     * @type {string}
+     * @memberof PaymentSessionAnalyticsResolvedRangeDto
+     */
+    'end': string;
+}
+/**
+ *
+ * @export
+ * @interface PaymentSessionAnalyticsResponseDto
+ */
+export interface PaymentSessionAnalyticsResponseDto {
+    /**
+     *
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'orderCount': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'grossSales': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'tips': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'surcharges': number;
+    /**
+     *
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'refundCount': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'refundAmount': number;
+    /**
+     * grossSales - refundAmount, computed server-side.
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'netSales': number;
+    /**
+     *
+     * @type {Array<PaymentSessionAnalyticsMethodBreakdownDto>}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'byPaymentMethod': Array<PaymentSessionAnalyticsMethodBreakdownDto>;
+    /**
+     *
+     * @type {PaymentSessionAnalyticsResolvedRangeDto}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'resolvedRange': PaymentSessionAnalyticsResolvedRangeDto;
+}
 /**
  *
  * @export
@@ -34469,7 +34598,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      */
     markOrderAsReady: (readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines the server has already dispatched keep their server state, so retrying the same park creates no second ticket.
+     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines already dispatched or already on a ticket keep their server state, so retrying the same park creates no second ticket. An order previously ticketed by the legacy path is accepted: its existing tickets are left untouched and count as settled work. A request may also name the lines this operation cancelled, which the same transaction cancels on the order and revises on every ticket that already carried them.
      * @summary Park a POS order on the event-v1 path
      * @param {ParkPosOrderDto} parkPosOrderDto
      * @param {*} [options] Override http request option.
@@ -34617,7 +34746,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      */
     markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderStatusResponseDto>>;
     /**
-     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines the server has already dispatched keep their server state, so retrying the same park creates no second ticket.
+     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines already dispatched or already on a ticket keep their server state, so retrying the same park creates no second ticket. An order previously ticketed by the legacy path is accepted: its existing tickets are left untouched and count as settled work. A request may also name the lines this operation cancelled, which the same transaction cancels on the order and revises on every ticket that already carried them.
      * @summary Park a POS order on the event-v1 path
      * @param {ParkPosOrderDto} parkPosOrderDto
      * @param {*} [options] Override http request option.
@@ -34765,7 +34894,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      */
     markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: any): AxiosPromise<OrderStatusResponseDto>;
     /**
-     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines the server has already dispatched keep their server state, so retrying the same park creates no second ticket.
+     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines already dispatched or already on a ticket keep their server state, so retrying the same park creates no second ticket. An order previously ticketed by the legacy path is accepted: its existing tickets are left untouched and count as settled work. A request may also name the lines this operation cancelled, which the same transaction cancels on the order and revises on every ticket that already carried them.
      * @summary Park a POS order on the event-v1 path
      * @param {ParkPosOrderDto} parkPosOrderDto
      * @param {*} [options] Override http request option.
@@ -34925,7 +35054,7 @@ export interface OrdersApiInterface {
      */
     markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
     /**
-     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines the server has already dispatched keep their server state, so retrying the same park creates no second ticket.
+     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines already dispatched or already on a ticket keep their server state, so retrying the same park creates no second ticket. An order previously ticketed by the legacy path is accepted: its existing tickets are left untouched and count as settled work. A request may also name the lines this operation cancelled, which the same transaction cancels on the order and revises on every ticket that already carried them.
      * @summary Park a POS order on the event-v1 path
      * @param {ParkPosOrderDto} parkPosOrderDto
      * @param {*} [options] Override http request option.
@@ -35092,7 +35221,7 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
      */
     markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderStatusResponseDto, any, {}>>;
     /**
-     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines the server has already dispatched keep their server state, so retrying the same park creates no second ticket.
+     * Persists the order snapshot, resolves the dispatch policy for every line once, and tickets the lines that have not been fired yet. Held lines stay on the order and are neither ticketed, printed nor sent to the kitchen screen. Lines already dispatched or already on a ticket keep their server state, so retrying the same park creates no second ticket. An order previously ticketed by the legacy path is accepted: its existing tickets are left untouched and count as settled work. A request may also name the lines this operation cancelled, which the same transaction cancels on the order and revises on every ticket that already carried them.
      * @summary Park a POS order on the event-v1 path
      * @param {ParkPosOrderDto} parkPosOrderDto
      * @param {*} [options] Override http request option.
@@ -36458,6 +36587,17 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     getPaymentSession: (clientToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentSessionAnalytics: (businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session
@@ -36621,6 +36761,17 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPaymentSession(clientToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionAnalyticsResponseDto>>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session
@@ -36784,6 +36935,17 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     getPaymentSession(clientToken: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<PaymentSessionAnalyticsResponseDto>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session
@@ -36951,6 +37113,18 @@ export interface PaymentSessionApiInterface {
      * @memberof PaymentSessionApiInterface
      */
     getPaymentSession(clientToken: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentSessionApiInterface
+     */
+    getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionAnalyticsResponseDto>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session
@@ -37135,6 +37309,18 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
      * @memberof PaymentSessionApi
      */
     getPaymentSession(clientToken: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentSessionApi
+     */
+    getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionAnalyticsResponseDto, any, {}>>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session