@munchi_oy/core 1.9.112 → 1.9.113
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/api.d.ts +345 -0
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +384 -0
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -12733,6 +12733,309 @@ export interface PairPayTerminalResponseDto {
|
|
|
12733
12733
|
*/
|
|
12734
12734
|
'terminalName'?: string | null;
|
|
12735
12735
|
}
|
|
12736
|
+
/**
|
|
12737
|
+
*
|
|
12738
|
+
* @export
|
|
12739
|
+
* @interface ParkPosOrderDto
|
|
12740
|
+
*/
|
|
12741
|
+
export interface ParkPosOrderDto {
|
|
12742
|
+
/**
|
|
12743
|
+
* Ordering business id the POS order belongs to.
|
|
12744
|
+
* @type {number}
|
|
12745
|
+
* @memberof ParkPosOrderDto
|
|
12746
|
+
*/
|
|
12747
|
+
'businessId': number;
|
|
12748
|
+
/**
|
|
12749
|
+
*
|
|
12750
|
+
* @type {ParkPosOrderDtoOrder}
|
|
12751
|
+
* @memberof ParkPosOrderDto
|
|
12752
|
+
*/
|
|
12753
|
+
'order': ParkPosOrderDtoOrder;
|
|
12754
|
+
}
|
|
12755
|
+
/**
|
|
12756
|
+
* 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.
|
|
12757
|
+
* @export
|
|
12758
|
+
* @interface ParkPosOrderDtoOrder
|
|
12759
|
+
*/
|
|
12760
|
+
export interface ParkPosOrderDtoOrder {
|
|
12761
|
+
/**
|
|
12762
|
+
* 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.
|
|
12763
|
+
* @type {boolean}
|
|
12764
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12765
|
+
*/
|
|
12766
|
+
'hiddenFromOrderManager'?: boolean;
|
|
12767
|
+
/**
|
|
12768
|
+
* 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.
|
|
12769
|
+
* @type {boolean}
|
|
12770
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12771
|
+
*/
|
|
12772
|
+
'readyControlledByKds'?: boolean;
|
|
12773
|
+
/**
|
|
12774
|
+
*
|
|
12775
|
+
* @type {string}
|
|
12776
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12777
|
+
*/
|
|
12778
|
+
'id': string;
|
|
12779
|
+
/**
|
|
12780
|
+
*
|
|
12781
|
+
* @type {string}
|
|
12782
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12783
|
+
*/
|
|
12784
|
+
'businessId': string;
|
|
12785
|
+
/**
|
|
12786
|
+
*
|
|
12787
|
+
* @type {ProviderEnum}
|
|
12788
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12789
|
+
*/
|
|
12790
|
+
'provider': ProviderEnum;
|
|
12791
|
+
/**
|
|
12792
|
+
*
|
|
12793
|
+
* @type {CurrencyCode}
|
|
12794
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12795
|
+
*/
|
|
12796
|
+
'currency': CurrencyCode;
|
|
12797
|
+
/**
|
|
12798
|
+
*
|
|
12799
|
+
* @type {PosBusinessDto}
|
|
12800
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12801
|
+
*/
|
|
12802
|
+
'business': PosBusinessDto;
|
|
12803
|
+
/**
|
|
12804
|
+
*
|
|
12805
|
+
* @type {string}
|
|
12806
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12807
|
+
*/
|
|
12808
|
+
'createdAt': string;
|
|
12809
|
+
/**
|
|
12810
|
+
*
|
|
12811
|
+
* @type {OrderStatusEnum}
|
|
12812
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12813
|
+
*/
|
|
12814
|
+
'status': OrderStatusEnum;
|
|
12815
|
+
/**
|
|
12816
|
+
*
|
|
12817
|
+
* @type {string}
|
|
12818
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12819
|
+
*/
|
|
12820
|
+
'updatedAt': string;
|
|
12821
|
+
/**
|
|
12822
|
+
*
|
|
12823
|
+
* @type {string}
|
|
12824
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12825
|
+
*/
|
|
12826
|
+
'completedAt'?: string;
|
|
12827
|
+
/**
|
|
12828
|
+
*
|
|
12829
|
+
* @type {string}
|
|
12830
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12831
|
+
*/
|
|
12832
|
+
'orderNumber': string;
|
|
12833
|
+
/**
|
|
12834
|
+
*
|
|
12835
|
+
* @type {CheckoutModelEnum}
|
|
12836
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12837
|
+
*/
|
|
12838
|
+
'checkoutModel': CheckoutModelEnum;
|
|
12839
|
+
/**
|
|
12840
|
+
*
|
|
12841
|
+
* @type {OrderTypePOS}
|
|
12842
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12843
|
+
*/
|
|
12844
|
+
'orderType': OrderTypePOS;
|
|
12845
|
+
/**
|
|
12846
|
+
*
|
|
12847
|
+
* @type {string}
|
|
12848
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12849
|
+
*/
|
|
12850
|
+
'spotNumber': string | null;
|
|
12851
|
+
/**
|
|
12852
|
+
* ID of the floor plan dining table linked to this order
|
|
12853
|
+
* @type {string}
|
|
12854
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12855
|
+
*/
|
|
12856
|
+
'tableId'?: string | null;
|
|
12857
|
+
/**
|
|
12858
|
+
*
|
|
12859
|
+
* @type {string}
|
|
12860
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12861
|
+
*/
|
|
12862
|
+
'comments': string | null;
|
|
12863
|
+
/**
|
|
12864
|
+
*
|
|
12865
|
+
* @type {PosOrderDtoTableService}
|
|
12866
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12867
|
+
*/
|
|
12868
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
12869
|
+
/**
|
|
12870
|
+
*
|
|
12871
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
12872
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12873
|
+
*/
|
|
12874
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
12875
|
+
/**
|
|
12876
|
+
* Id of the staff in shift
|
|
12877
|
+
* @type {string}
|
|
12878
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12879
|
+
*/
|
|
12880
|
+
'staffId': string | null;
|
|
12881
|
+
/**
|
|
12882
|
+
* Id of the shift
|
|
12883
|
+
* @type {string}
|
|
12884
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12885
|
+
*/
|
|
12886
|
+
'shiftId': string | null;
|
|
12887
|
+
/**
|
|
12888
|
+
*
|
|
12889
|
+
* @type {OrderRefundStatus}
|
|
12890
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12891
|
+
*/
|
|
12892
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
12893
|
+
/**
|
|
12894
|
+
*
|
|
12895
|
+
* @type {LocatorType}
|
|
12896
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12897
|
+
*/
|
|
12898
|
+
'locatorType': LocatorType;
|
|
12899
|
+
/**
|
|
12900
|
+
*
|
|
12901
|
+
* @type {PosOrderPriceDto}
|
|
12902
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12903
|
+
*/
|
|
12904
|
+
'basketPrice': PosOrderPriceDto;
|
|
12905
|
+
/**
|
|
12906
|
+
*
|
|
12907
|
+
* @type {Array<PosOrderItemDto>}
|
|
12908
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12909
|
+
*/
|
|
12910
|
+
'items': Array<PosOrderItemDto>;
|
|
12911
|
+
/**
|
|
12912
|
+
*
|
|
12913
|
+
* @type {Array<PosDiscountDto>}
|
|
12914
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12915
|
+
*/
|
|
12916
|
+
'discounts': Array<PosDiscountDto>;
|
|
12917
|
+
/**
|
|
12918
|
+
*
|
|
12919
|
+
* @type {PosCustomerDto}
|
|
12920
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12921
|
+
*/
|
|
12922
|
+
'customer': PosCustomerDto | null;
|
|
12923
|
+
/**
|
|
12924
|
+
*
|
|
12925
|
+
* @type {Array<TransactionDto>}
|
|
12926
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12927
|
+
*/
|
|
12928
|
+
'paymentEvents': Array<TransactionDto>;
|
|
12929
|
+
/**
|
|
12930
|
+
*
|
|
12931
|
+
* @type {Array<PaymentRefundDto>}
|
|
12932
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12933
|
+
*/
|
|
12934
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
12935
|
+
/**
|
|
12936
|
+
* Data version code
|
|
12937
|
+
* @type {string}
|
|
12938
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12939
|
+
*/
|
|
12940
|
+
'version': string;
|
|
12941
|
+
/**
|
|
12942
|
+
*
|
|
12943
|
+
* @type {OrderFormat}
|
|
12944
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12945
|
+
*/
|
|
12946
|
+
'orderFormat'?: OrderFormat;
|
|
12947
|
+
/**
|
|
12948
|
+
* The ID of the loyalty program active during this order.
|
|
12949
|
+
* @type {string}
|
|
12950
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12951
|
+
*/
|
|
12952
|
+
'loyaltyProgramId': string | null;
|
|
12953
|
+
/**
|
|
12954
|
+
* An array of loyalty transaction IDs related to this order.
|
|
12955
|
+
* @type {Array<string>}
|
|
12956
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12957
|
+
*/
|
|
12958
|
+
'loyaltyTransactionIds': Array<string>;
|
|
12959
|
+
/**
|
|
12960
|
+
*
|
|
12961
|
+
* @type {PosOrderDtoTaxSummary}
|
|
12962
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12963
|
+
*/
|
|
12964
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
12965
|
+
/**
|
|
12966
|
+
* Name of staff member who created the order
|
|
12967
|
+
* @type {string}
|
|
12968
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12969
|
+
*/
|
|
12970
|
+
'staffName'?: string | null;
|
|
12971
|
+
/**
|
|
12972
|
+
*
|
|
12973
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
12974
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12975
|
+
*/
|
|
12976
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
12977
|
+
/**
|
|
12978
|
+
*
|
|
12979
|
+
* @type {object}
|
|
12980
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12981
|
+
*/
|
|
12982
|
+
'lastPaymentError'?: object;
|
|
12983
|
+
/**
|
|
12984
|
+
*
|
|
12985
|
+
* @type {Array<OrderFeeDto>}
|
|
12986
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12987
|
+
*/
|
|
12988
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
12989
|
+
/**
|
|
12990
|
+
* Loyalty user ID associated with this order
|
|
12991
|
+
* @type {number}
|
|
12992
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12993
|
+
*/
|
|
12994
|
+
'targetUserId'?: number;
|
|
12995
|
+
/**
|
|
12996
|
+
* ID of the table group this order belongs to
|
|
12997
|
+
* @type {string}
|
|
12998
|
+
* @memberof ParkPosOrderDtoOrder
|
|
12999
|
+
*/
|
|
13000
|
+
'tableGroupId'?: string | null;
|
|
13001
|
+
}
|
|
13002
|
+
/**
|
|
13003
|
+
*
|
|
13004
|
+
* @export
|
|
13005
|
+
* @interface ParkPosOrderResponseDto
|
|
13006
|
+
*/
|
|
13007
|
+
export interface ParkPosOrderResponseDto {
|
|
13008
|
+
/**
|
|
13009
|
+
*
|
|
13010
|
+
* @type {string}
|
|
13011
|
+
* @memberof ParkPosOrderResponseDto
|
|
13012
|
+
*/
|
|
13013
|
+
'orderId': string;
|
|
13014
|
+
/**
|
|
13015
|
+
*
|
|
13016
|
+
* @type {object}
|
|
13017
|
+
* @memberof ParkPosOrderResponseDto
|
|
13018
|
+
*/
|
|
13019
|
+
'ticketId': object | null;
|
|
13020
|
+
/**
|
|
13021
|
+
*
|
|
13022
|
+
* @type {object}
|
|
13023
|
+
* @memberof ParkPosOrderResponseDto
|
|
13024
|
+
*/
|
|
13025
|
+
'ticketOrderNumber': object | null;
|
|
13026
|
+
/**
|
|
13027
|
+
* Line items placed on a ticket by this call.
|
|
13028
|
+
* @type {number}
|
|
13029
|
+
* @memberof ParkPosOrderResponseDto
|
|
13030
|
+
*/
|
|
13031
|
+
'dispatchedLineItems': number;
|
|
13032
|
+
/**
|
|
13033
|
+
* Line items left on the order because they are on hold.
|
|
13034
|
+
* @type {number}
|
|
13035
|
+
* @memberof ParkPosOrderResponseDto
|
|
13036
|
+
*/
|
|
13037
|
+
'heldLineItems': number;
|
|
13038
|
+
}
|
|
12736
13039
|
/**
|
|
12737
13040
|
*
|
|
12738
13041
|
* @export
|
|
@@ -34165,6 +34468,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
34165
34468
|
* @throws {RequiredError}
|
|
34166
34469
|
*/
|
|
34167
34470
|
markOrderAsReady: (readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34471
|
+
/**
|
|
34472
|
+
* 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.
|
|
34473
|
+
* @summary Park a POS order on the event-v1 path
|
|
34474
|
+
* @param {ParkPosOrderDto} parkPosOrderDto
|
|
34475
|
+
* @param {*} [options] Override http request option.
|
|
34476
|
+
* @throws {RequiredError}
|
|
34477
|
+
*/
|
|
34478
|
+
parkPosOrderV5: (parkPosOrderDto: ParkPosOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34168
34479
|
/**
|
|
34169
34480
|
*
|
|
34170
34481
|
* @summary Place an POS order
|
|
@@ -34305,6 +34616,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
34305
34616
|
* @throws {RequiredError}
|
|
34306
34617
|
*/
|
|
34307
34618
|
markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderStatusResponseDto>>;
|
|
34619
|
+
/**
|
|
34620
|
+
* 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.
|
|
34621
|
+
* @summary Park a POS order on the event-v1 path
|
|
34622
|
+
* @param {ParkPosOrderDto} parkPosOrderDto
|
|
34623
|
+
* @param {*} [options] Override http request option.
|
|
34624
|
+
* @throws {RequiredError}
|
|
34625
|
+
*/
|
|
34626
|
+
parkPosOrderV5(parkPosOrderDto: ParkPosOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParkPosOrderResponseDto>>;
|
|
34308
34627
|
/**
|
|
34309
34628
|
*
|
|
34310
34629
|
* @summary Place an POS order
|
|
@@ -34445,6 +34764,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
34445
34764
|
* @throws {RequiredError}
|
|
34446
34765
|
*/
|
|
34447
34766
|
markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: any): AxiosPromise<OrderStatusResponseDto>;
|
|
34767
|
+
/**
|
|
34768
|
+
* 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.
|
|
34769
|
+
* @summary Park a POS order on the event-v1 path
|
|
34770
|
+
* @param {ParkPosOrderDto} parkPosOrderDto
|
|
34771
|
+
* @param {*} [options] Override http request option.
|
|
34772
|
+
* @throws {RequiredError}
|
|
34773
|
+
*/
|
|
34774
|
+
parkPosOrderV5(parkPosOrderDto: ParkPosOrderDto, options?: any): AxiosPromise<ParkPosOrderResponseDto>;
|
|
34448
34775
|
/**
|
|
34449
34776
|
*
|
|
34450
34777
|
* @summary Place an POS order
|
|
@@ -34597,6 +34924,15 @@ export interface OrdersApiInterface {
|
|
|
34597
34924
|
* @memberof OrdersApiInterface
|
|
34598
34925
|
*/
|
|
34599
34926
|
markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
|
|
34927
|
+
/**
|
|
34928
|
+
* 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.
|
|
34929
|
+
* @summary Park a POS order on the event-v1 path
|
|
34930
|
+
* @param {ParkPosOrderDto} parkPosOrderDto
|
|
34931
|
+
* @param {*} [options] Override http request option.
|
|
34932
|
+
* @throws {RequiredError}
|
|
34933
|
+
* @memberof OrdersApiInterface
|
|
34934
|
+
*/
|
|
34935
|
+
parkPosOrderV5(parkPosOrderDto: ParkPosOrderDto, options?: AxiosRequestConfig): AxiosPromise<ParkPosOrderResponseDto>;
|
|
34600
34936
|
/**
|
|
34601
34937
|
*
|
|
34602
34938
|
* @summary Place an POS order
|
|
@@ -34755,6 +35091,15 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
34755
35091
|
* @memberof OrdersApi
|
|
34756
35092
|
*/
|
|
34757
35093
|
markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderStatusResponseDto, any, {}>>;
|
|
35094
|
+
/**
|
|
35095
|
+
* 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.
|
|
35096
|
+
* @summary Park a POS order on the event-v1 path
|
|
35097
|
+
* @param {ParkPosOrderDto} parkPosOrderDto
|
|
35098
|
+
* @param {*} [options] Override http request option.
|
|
35099
|
+
* @throws {RequiredError}
|
|
35100
|
+
* @memberof OrdersApi
|
|
35101
|
+
*/
|
|
35102
|
+
parkPosOrderV5(parkPosOrderDto: ParkPosOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ParkPosOrderResponseDto, any, {}>>;
|
|
34758
35103
|
/**
|
|
34759
35104
|
*
|
|
34760
35105
|
* @summary Place an POS order
|