@munchi_oy/core 1.9.112 → 1.9.114

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}
@@ -12733,6 +12751,315 @@ export interface PairPayTerminalResponseDto {
      */
     'terminalName'?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface ParkPosOrderDto
+ */
+export interface ParkPosOrderDto {
+    /**
+     * Ordering business id the POS order belongs to.
+     * @type {number}
+     * @memberof ParkPosOrderDto
+     */
+    'businessId': number;
+    /**
+     *
+     * @type {ParkPosOrderDtoOrder}
+     * @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.
+ * @export
+ * @interface ParkPosOrderDtoOrder
+ */
+export interface ParkPosOrderDtoOrder {
+    /**
+     * Set on tickets whose lines all resolve to sendToOm=false. The ticket stays in_progress so the kitchen screen still receives it; only Order Manager skips it. Absent on documents written before this field existed, which is treated as not hidden.
+     * @type {boolean}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'hiddenFromOrderManager'?: boolean;
+    /**
+     * True when this fire produced a kitchen ticket, so the kitchen screen owns marking it ready. False when no kitchen ticket exists and a manager must mark it ready. Absent on documents written before this field existed, where clients fall back to the business-level KDS integration check.
+     * @type {boolean}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'readyControlledByKds'?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'businessId': string;
+    /**
+     *
+     * @type {ProviderEnum}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'provider': ProviderEnum;
+    /**
+     *
+     * @type {CurrencyCode}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'currency': CurrencyCode;
+    /**
+     *
+     * @type {PosBusinessDto}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'business': PosBusinessDto;
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'createdAt': string;
+    /**
+     *
+     * @type {OrderStatusEnum}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'status': OrderStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'updatedAt': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'completedAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'orderNumber': string;
+    /**
+     *
+     * @type {CheckoutModelEnum}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'checkoutModel': CheckoutModelEnum;
+    /**
+     *
+     * @type {OrderTypePOS}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'orderType': OrderTypePOS;
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'spotNumber': string | null;
+    /**
+     * ID of the floor plan dining table linked to this order
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'tableId'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'comments': string | null;
+    /**
+     *
+     * @type {PosOrderDtoTableService}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'tableService'?: PosOrderDtoTableService | null;
+    /**
+     *
+     * @type {PosOrderDtoEqualSplitState}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'equalSplitState'?: PosOrderDtoEqualSplitState | null;
+    /**
+     * Id of the staff in shift
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'staffId': string | null;
+    /**
+     * Id of the shift
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'shiftId': string | null;
+    /**
+     *
+     * @type {OrderRefundStatus}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'orderRefundStatus': OrderRefundStatus;
+    /**
+     *
+     * @type {LocatorType}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'locatorType': LocatorType;
+    /**
+     *
+     * @type {PosOrderPriceDto}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'basketPrice': PosOrderPriceDto;
+    /**
+     *
+     * @type {Array<PosOrderItemDto>}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'items': Array<PosOrderItemDto>;
+    /**
+     *
+     * @type {Array<PosDiscountDto>}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'discounts': Array<PosDiscountDto>;
+    /**
+     *
+     * @type {PosCustomerDto}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'customer': PosCustomerDto | null;
+    /**
+     *
+     * @type {Array<TransactionDto>}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'paymentEvents': Array<TransactionDto>;
+    /**
+     *
+     * @type {Array<PaymentRefundDto>}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'refunds'?: Array<PaymentRefundDto>;
+    /**
+     * Data version code
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'version': string;
+    /**
+     *
+     * @type {OrderFormat}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'orderFormat'?: OrderFormat;
+    /**
+     * The ID of the loyalty program active during this order.
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'loyaltyProgramId': string | null;
+    /**
+     * An array of loyalty transaction IDs related to this order.
+     * @type {Array<string>}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'loyaltyTransactionIds': Array<string>;
+    /**
+     *
+     * @type {PosOrderDtoTaxSummary}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'taxSummary'?: PosOrderDtoTaxSummary;
+    /**
+     * Name of staff member who created the order
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'staffName'?: string | null;
+    /**
+     *
+     * @type {PosOrderDtoInvoiceCompany}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
+    /**
+     *
+     * @type {object}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'lastPaymentError'?: object;
+    /**
+     *
+     * @type {Array<OrderFeeDto>}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'fees'?: Array<OrderFeeDto> | null;
+    /**
+     * Loyalty user ID associated with this order
+     * @type {number}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'targetUserId'?: number;
+    /**
+     * ID of the table group this order belongs to
+     * @type {string}
+     * @memberof ParkPosOrderDtoOrder
+     */
+    'tableGroupId'?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface ParkPosOrderResponseDto
+ */
+export interface ParkPosOrderResponseDto {
+    /**
+     *
+     * @type {string}
+     * @memberof ParkPosOrderResponseDto
+     */
+    'orderId': string;
+    /**
+     *
+     * @type {object}
+     * @memberof ParkPosOrderResponseDto
+     */
+    'ticketId': object | null;
+    /**
+     *
+     * @type {object}
+     * @memberof ParkPosOrderResponseDto
+     */
+    'ticketOrderNumber': object | null;
+    /**
+     * Line items placed on a ticket by this call.
+     * @type {number}
+     * @memberof ParkPosOrderResponseDto
+     */
+    'dispatchedLineItems': number;
+    /**
+     * Line items left on the order because they are on hold.
+     * @type {number}
+     * @memberof ParkPosOrderResponseDto
+     */
+    'heldLineItems': number;
+}
 /**
  *
  * @export
@@ -34165,6 +34492,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     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 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.
+     * @throws {RequiredError}
+     */
+    parkPosOrderV5: (parkPosOrderDto: ParkPosOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Place an POS order
@@ -34305,6 +34640,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     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 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.
+     * @throws {RequiredError}
+     */
+    parkPosOrderV5(parkPosOrderDto: ParkPosOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParkPosOrderResponseDto>>;
     /**
      *
      * @summary Place an POS order
@@ -34445,6 +34788,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     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 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.
+     * @throws {RequiredError}
+     */
+    parkPosOrderV5(parkPosOrderDto: ParkPosOrderDto, options?: any): AxiosPromise<ParkPosOrderResponseDto>;
     /**
      *
      * @summary Place an POS order
@@ -34597,6 +34948,15 @@ export interface OrdersApiInterface {
      * @memberof 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 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.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    parkPosOrderV5(parkPosOrderDto: ParkPosOrderDto, options?: AxiosRequestConfig): AxiosPromise<ParkPosOrderResponseDto>;
     /**
      *
      * @summary Place an POS order
@@ -34755,6 +35115,15 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
      * @memberof OrdersApi
      */
     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 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.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    parkPosOrderV5(parkPosOrderDto: ParkPosOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ParkPosOrderResponseDto, any, {}>>;
     /**
      *
      * @summary Place an POS order