@munchi_oy/core 2.20.0 → 2.22.0
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 +1174 -172
- 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 +1504 -174
- package/package.json +13 -15
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2874,6 +2874,7 @@ export declare const ChannelEnum: {
|
|
|
2874
2874
|
readonly Storefront: "Storefront";
|
|
2875
2875
|
readonly MunchiPay: "MunchiPay";
|
|
2876
2876
|
readonly ResQ: "ResQ";
|
|
2877
|
+
readonly Partner: "Partner";
|
|
2877
2878
|
};
|
|
2878
2879
|
export type ChannelEnum = typeof ChannelEnum[keyof typeof ChannelEnum];
|
|
2879
2880
|
/**
|
|
@@ -15506,6 +15507,339 @@ export interface NexiConfigResponseDto {
|
|
|
15506
15507
|
*/
|
|
15507
15508
|
'hasPassword': boolean;
|
|
15508
15509
|
}
|
|
15510
|
+
/**
|
|
15511
|
+
*
|
|
15512
|
+
* @export
|
|
15513
|
+
* @interface NexiOnDeviceAnswerDto
|
|
15514
|
+
*/
|
|
15515
|
+
export interface NexiOnDeviceAnswerDto {
|
|
15516
|
+
/**
|
|
15517
|
+
*
|
|
15518
|
+
* @type {PoyntPaymentStatus}
|
|
15519
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15520
|
+
*/
|
|
15521
|
+
'status': PoyntPaymentStatus;
|
|
15522
|
+
/**
|
|
15523
|
+
* The reference the payment app was given, read back from the transaction\'s references: the session\'s sessionId. Required on a sale\'s or a refund\'s approval, which is refused when it is not the session\'s. A decline or a cancel may come without it, and then only ends the wait. Not read on a revert: Poynt\'s void carries the sale\'s references.
|
|
15524
|
+
* @type {string}
|
|
15525
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15526
|
+
*/
|
|
15527
|
+
'reference'?: string;
|
|
15528
|
+
/**
|
|
15529
|
+
* Poynt\'s `Transaction.id`. Required on an approval. On a sale or a refund it becomes the session\'s providerTransactionId, and one id settles one session only. On a revert it is the void\'s own transaction or the sale\'s, and it or parentId must be the sale\'s; it is kept in the stored answer only.
|
|
15530
|
+
* @type {string}
|
|
15531
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15532
|
+
*/
|
|
15533
|
+
'transactionId'?: string;
|
|
15534
|
+
/**
|
|
15535
|
+
* Poynt\'s `Transaction.parentId`: on a void, the sale\'s transaction id. Absent on a sale, and on a refund, which Poynt does not link to its sale (a non-referenced refund).
|
|
15536
|
+
* @type {string}
|
|
15537
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15538
|
+
*/
|
|
15539
|
+
'parentId'?: string;
|
|
15540
|
+
/**
|
|
15541
|
+
* Poynt\'s `Transaction.status`. A sale\'s approval must carry CAPTURED, a refund\'s REFUNDED, a revert\'s VOIDED; any other is kept for ops and the session is not settled.
|
|
15542
|
+
* @type {string}
|
|
15543
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15544
|
+
*/
|
|
15545
|
+
'transactionStatus'?: string;
|
|
15546
|
+
/**
|
|
15547
|
+
* Poynt\'s `Transaction.action` (SALE, REFUND). Kept in the stored answer, not checked.
|
|
15548
|
+
* @type {string}
|
|
15549
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15550
|
+
*/
|
|
15551
|
+
'transactionAction'?: string;
|
|
15552
|
+
/**
|
|
15553
|
+
* Poynt\'s `Transaction.partiallyApproved`. An approval for part of the amount is kept for ops and the session is not settled. Absent reads as false.
|
|
15554
|
+
* @type {boolean}
|
|
15555
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15556
|
+
*/
|
|
15557
|
+
'partiallyApproved'?: boolean;
|
|
15558
|
+
/**
|
|
15559
|
+
* How many of the Payment\'s transactions Poynt approved. Absent or 1 is the normal case; 2 or more is kept for ops and the session is not settled.
|
|
15560
|
+
* @type {number}
|
|
15561
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15562
|
+
*/
|
|
15563
|
+
'approvedTransactionCount'?: number;
|
|
15564
|
+
/**
|
|
15565
|
+
* The currency charged, ISO 4217 alpha code (`amounts.currency`). Required on a sale\'s or a refund\'s approval, and must be the session\'s.
|
|
15566
|
+
* @type {string}
|
|
15567
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15568
|
+
*/
|
|
15569
|
+
'currency'?: string;
|
|
15570
|
+
/**
|
|
15571
|
+
* What the card was charged or refunded, in cents (`amounts.transactionAmount`), tip included. Required on a sale\'s or a refund\'s approval: a sale\'s must be the session\'s amount plus its tip, a refund\'s the refund\'s amount. One that does not match is kept for ops and the session is not settled. Not checked on a revert, which gives back the whole sale.
|
|
15572
|
+
* @type {number}
|
|
15573
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15574
|
+
*/
|
|
15575
|
+
'transactionAmount'?: number;
|
|
15576
|
+
/**
|
|
15577
|
+
* The tip in `amounts.tipAmount`, in cents. Kept in the stored answer; the payment event\'s tip is the session\'s, since the payment app takes no tip of its own.
|
|
15578
|
+
* @type {number}
|
|
15579
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15580
|
+
*/
|
|
15581
|
+
'tipAmount'?: number;
|
|
15582
|
+
/**
|
|
15583
|
+
* The card brand, Poynt\'s `card.type`.
|
|
15584
|
+
* @type {string}
|
|
15585
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15586
|
+
*/
|
|
15587
|
+
'cardType'?: string;
|
|
15588
|
+
/**
|
|
15589
|
+
* The card\'s first six digits (`card.numberFirst6`); they tell a benefit card. Six digits exactly.
|
|
15590
|
+
* @type {string}
|
|
15591
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15592
|
+
*/
|
|
15593
|
+
'numberFirst6'?: string;
|
|
15594
|
+
/**
|
|
15595
|
+
* The card\'s last four digits (`card.numberLast4`). A refund whose card differs from the sale\'s is recorded and logged, never refused. Four digits exactly.
|
|
15596
|
+
* @type {string}
|
|
15597
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15598
|
+
*/
|
|
15599
|
+
'numberLast4'?: string;
|
|
15600
|
+
/**
|
|
15601
|
+
* The issuer\'s approval code (`processorResponse.approvalCode`; Poynt\'s top-level `approvalCode` is null on the N950). Optional: shown on the payment event, never required.
|
|
15602
|
+
* @type {string}
|
|
15603
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15604
|
+
*/
|
|
15605
|
+
'approvalCode'?: string;
|
|
15606
|
+
/**
|
|
15607
|
+
* The acquirer\'s retrieval reference number (`processorResponse.retrievalRefNum`).
|
|
15608
|
+
* @type {string}
|
|
15609
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15610
|
+
*/
|
|
15611
|
+
'retrievalRefNum'?: string;
|
|
15612
|
+
/**
|
|
15613
|
+
* `processorResponse.status`: Successful or Failure. Kept, not checked.
|
|
15614
|
+
* @type {string}
|
|
15615
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15616
|
+
*/
|
|
15617
|
+
'processorStatus'?: string;
|
|
15618
|
+
/**
|
|
15619
|
+
* `processorResponse.statusMessage`: why a transaction failed, in Poynt\'s words. Stored, trimmed, as the session\'s errorMessage when the session ends without money; a blank one (the N950 sends a single space when it has none) is replaced by the server\'s own words.
|
|
15620
|
+
* @type {string}
|
|
15621
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15622
|
+
*/
|
|
15623
|
+
'processorStatusMessage'?: string;
|
|
15624
|
+
/**
|
|
15625
|
+
* Nexi\'s own reference of the transaction (the `npay-reference-number` reference), as the Nexi portal shows it. Kept, not checked.
|
|
15626
|
+
* @type {string}
|
|
15627
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15628
|
+
*/
|
|
15629
|
+
'nexiReferenceNumber'?: string;
|
|
15630
|
+
/**
|
|
15631
|
+
* When Poynt created the transaction, ISO 8601, as the device\'s clock says. Kept in the stored answer only; the payment event\'s time is the server\'s.
|
|
15632
|
+
* @type {string}
|
|
15633
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15634
|
+
*/
|
|
15635
|
+
'createdAt'?: string;
|
|
15636
|
+
}
|
|
15637
|
+
/**
|
|
15638
|
+
*
|
|
15639
|
+
* @export
|
|
15640
|
+
* @interface NexiOnDeviceResultViewDto
|
|
15641
|
+
*/
|
|
15642
|
+
export interface NexiOnDeviceResultViewDto {
|
|
15643
|
+
/**
|
|
15644
|
+
* Opaque client token.
|
|
15645
|
+
* @type {string}
|
|
15646
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15647
|
+
*/
|
|
15648
|
+
'clientToken': string;
|
|
15649
|
+
/**
|
|
15650
|
+
* Internal session ID.
|
|
15651
|
+
* @type {string}
|
|
15652
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15653
|
+
*/
|
|
15654
|
+
'sessionId': string;
|
|
15655
|
+
/**
|
|
15656
|
+
* Viva transaction ID set after webhook completes.
|
|
15657
|
+
* @type {string}
|
|
15658
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15659
|
+
*/
|
|
15660
|
+
'providerTransactionId'?: string;
|
|
15661
|
+
/**
|
|
15662
|
+
*
|
|
15663
|
+
* @type {PaymentSessionStatus}
|
|
15664
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15665
|
+
*/
|
|
15666
|
+
'status': PaymentSessionStatus;
|
|
15667
|
+
/**
|
|
15668
|
+
* Amount in cents.
|
|
15669
|
+
* @type {number}
|
|
15670
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15671
|
+
*/
|
|
15672
|
+
'amount': number;
|
|
15673
|
+
/**
|
|
15674
|
+
* Currency.
|
|
15675
|
+
* @type {string}
|
|
15676
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15677
|
+
*/
|
|
15678
|
+
'currency': string;
|
|
15679
|
+
/**
|
|
15680
|
+
* Tip amount (cents).
|
|
15681
|
+
* @type {number}
|
|
15682
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15683
|
+
*/
|
|
15684
|
+
'tipAmount': number;
|
|
15685
|
+
/**
|
|
15686
|
+
* Surcharge amount (cents).
|
|
15687
|
+
* @type {number}
|
|
15688
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15689
|
+
*/
|
|
15690
|
+
'surchargeAmount': number;
|
|
15691
|
+
/**
|
|
15692
|
+
* Error code if failed.
|
|
15693
|
+
* @type {string}
|
|
15694
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15695
|
+
*/
|
|
15696
|
+
'errorCode'?: string;
|
|
15697
|
+
/**
|
|
15698
|
+
* Error message if failed.
|
|
15699
|
+
* @type {string}
|
|
15700
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15701
|
+
*/
|
|
15702
|
+
'errorMessage'?: string;
|
|
15703
|
+
/**
|
|
15704
|
+
* When the session was started (ISO 8601, UTC).
|
|
15705
|
+
* @type {string}
|
|
15706
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15707
|
+
*/
|
|
15708
|
+
'createdAt': string;
|
|
15709
|
+
/**
|
|
15710
|
+
* When the session last changed (ISO 8601, UTC).
|
|
15711
|
+
* @type {string}
|
|
15712
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15713
|
+
*/
|
|
15714
|
+
'updatedAt': string;
|
|
15715
|
+
/**
|
|
15716
|
+
* When the sale was written to the order and closed (ISO 8601, UTC); null while it is not.
|
|
15717
|
+
* @type {string}
|
|
15718
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15719
|
+
*/
|
|
15720
|
+
'closedAt'?: string;
|
|
15721
|
+
/**
|
|
15722
|
+
*
|
|
15723
|
+
* @type {NexiOnDeviceResultViewDtoTransaction}
|
|
15724
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15725
|
+
*/
|
|
15726
|
+
'transaction'?: NexiOnDeviceResultViewDtoTransaction;
|
|
15727
|
+
}
|
|
15728
|
+
/**
|
|
15729
|
+
* The payment event the order receives for this sale, built from the payment app\'s approval: the session\'s amount, the tip as a fee, the card\'s brand and masked number. Present while the session is a paid sale (SUCCESS or CLOSED), a repeated answer included; absent for a failure, a cancel, a refund or a revert.
|
|
15730
|
+
* @export
|
|
15731
|
+
* @interface NexiOnDeviceResultViewDtoTransaction
|
|
15732
|
+
*/
|
|
15733
|
+
export interface NexiOnDeviceResultViewDtoTransaction {
|
|
15734
|
+
/**
|
|
15735
|
+
* Id of this payment: the payment provider\'s transaction id for a card payment, or an id the till made
|
|
15736
|
+
* @type {string}
|
|
15737
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15738
|
+
*/
|
|
15739
|
+
'id': string;
|
|
15740
|
+
/**
|
|
15741
|
+
* The payment\'s reference: the provider\'s session or merchant reference for a card payment, or, on a reversal, the id of the payment it reverses; null when there is none
|
|
15742
|
+
* @type {string}
|
|
15743
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15744
|
+
*/
|
|
15745
|
+
'referenceId': string | null;
|
|
15746
|
+
/**
|
|
15747
|
+
*
|
|
15748
|
+
* @type {PaymentProvider}
|
|
15749
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15750
|
+
*/
|
|
15751
|
+
'provider': PaymentProvider;
|
|
15752
|
+
/**
|
|
15753
|
+
*
|
|
15754
|
+
* @type {PaymentMethod}
|
|
15755
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15756
|
+
*/
|
|
15757
|
+
'type': PaymentMethod;
|
|
15758
|
+
/**
|
|
15759
|
+
*
|
|
15760
|
+
* @type {PaymentOutcomeStatus}
|
|
15761
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15762
|
+
*/
|
|
15763
|
+
'paymentOutcomeStatus'?: PaymentOutcomeStatus;
|
|
15764
|
+
/**
|
|
15765
|
+
* Amount paid in cents
|
|
15766
|
+
* @type {number}
|
|
15767
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15768
|
+
*/
|
|
15769
|
+
'amount': number;
|
|
15770
|
+
/**
|
|
15771
|
+
* Difference from cash rounding in cents
|
|
15772
|
+
* @type {number}
|
|
15773
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15774
|
+
*/
|
|
15775
|
+
'roundingDifference': number;
|
|
15776
|
+
/**
|
|
15777
|
+
* Raw data from payment provider, as it sent it
|
|
15778
|
+
* @type {object}
|
|
15779
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15780
|
+
*/
|
|
15781
|
+
'rawData': object;
|
|
15782
|
+
/**
|
|
15783
|
+
* When the payment was taken
|
|
15784
|
+
* @type {string}
|
|
15785
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15786
|
+
*/
|
|
15787
|
+
'createdAt': string;
|
|
15788
|
+
/**
|
|
15789
|
+
*
|
|
15790
|
+
* @type {TransactionDtoCardDetail}
|
|
15791
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15792
|
+
*/
|
|
15793
|
+
'cardDetail': TransactionDtoCardDetail | null;
|
|
15794
|
+
/**
|
|
15795
|
+
* The monetary amount of the voucher value that was *not* used and *not* refunded to the customer (i.e., the overage). This is applicable only when a voucher is used and its value exceeds the order total.
|
|
15796
|
+
* @type {number}
|
|
15797
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15798
|
+
*/
|
|
15799
|
+
'voucherForfeitedAmount'?: number | null;
|
|
15800
|
+
/**
|
|
15801
|
+
* The specific line items this transaction paid for. If null or empty, it was a pooled payment against the total bill.
|
|
15802
|
+
* @type {Array<string>}
|
|
15803
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15804
|
+
*/
|
|
15805
|
+
'lineItemIds'?: Array<string> | null;
|
|
15806
|
+
/**
|
|
15807
|
+
* The specific split part this transaction paid for. If null, it was not a payment for a split part.
|
|
15808
|
+
* @type {string}
|
|
15809
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15810
|
+
*/
|
|
15811
|
+
'splitPartId'?: string | null;
|
|
15812
|
+
/**
|
|
15813
|
+
* Detailed settlement allocations for this transaction. Use this for accurate refund and reconciliation logic, especially when one line item is split across multiple payments.
|
|
15814
|
+
* @type {Array<TransactionItemAllocationDto>}
|
|
15815
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15816
|
+
*/
|
|
15817
|
+
'itemAllocations'?: Array<TransactionItemAllocationDto> | null;
|
|
15818
|
+
/**
|
|
15819
|
+
*
|
|
15820
|
+
* @type {TransactionDtoDevice}
|
|
15821
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15822
|
+
*/
|
|
15823
|
+
'device'?: TransactionDtoDevice | null;
|
|
15824
|
+
/**
|
|
15825
|
+
*
|
|
15826
|
+
* @type {TransactionDtoCapturedBy}
|
|
15827
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15828
|
+
*/
|
|
15829
|
+
'capturedBy'?: TransactionDtoCapturedBy | null;
|
|
15830
|
+
/**
|
|
15831
|
+
* Indicates whether this transaction was processed as a pre-authorization.
|
|
15832
|
+
* @type {string}
|
|
15833
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15834
|
+
*/
|
|
15835
|
+
'label': string | null;
|
|
15836
|
+
/**
|
|
15837
|
+
*
|
|
15838
|
+
* @type {TransactionDtoFees}
|
|
15839
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15840
|
+
*/
|
|
15841
|
+
'fees'?: TransactionDtoFees | null;
|
|
15842
|
+
}
|
|
15509
15843
|
/**
|
|
15510
15844
|
*
|
|
15511
15845
|
* @export
|
|
@@ -18310,6 +18644,65 @@ export interface ParkPosOrderResponseDto {
|
|
|
18310
18644
|
*/
|
|
18311
18645
|
'heldLineItems': number;
|
|
18312
18646
|
}
|
|
18647
|
+
/**
|
|
18648
|
+
*
|
|
18649
|
+
* @export
|
|
18650
|
+
* @interface PartnerDto
|
|
18651
|
+
*/
|
|
18652
|
+
export interface PartnerDto {
|
|
18653
|
+
/**
|
|
18654
|
+
* The partner\'s id, which never changes: a provider row links to it, and an order keeps it with the partner\'s name and logo as they were when the order was saved
|
|
18655
|
+
* @type {string}
|
|
18656
|
+
* @memberof PartnerDto
|
|
18657
|
+
*/
|
|
18658
|
+
'id': string;
|
|
18659
|
+
/**
|
|
18660
|
+
* The partner\'s key, which never changes once created: orders keep it. A platform Munchi connected before the partner standard has its channel name as key (Wolt, WoltStorefront, UberEats, Foodora, Bolt, ResQ); a partner on the partner standard a slug: words of lowercase letters and digits joined by single -, starting with a letter, 2 to 41 characters, that names no Munchi channel
|
|
18661
|
+
* @type {string}
|
|
18662
|
+
* @memberof PartnerDto
|
|
18663
|
+
*/
|
|
18664
|
+
'key': string;
|
|
18665
|
+
/**
|
|
18666
|
+
* The partner\'s name as the apps show it
|
|
18667
|
+
* @type {string}
|
|
18668
|
+
* @memberof PartnerDto
|
|
18669
|
+
*/
|
|
18670
|
+
'name': string;
|
|
18671
|
+
/**
|
|
18672
|
+
* The partner\'s logo, an https address; null when it has none
|
|
18673
|
+
* @type {string}
|
|
18674
|
+
* @memberof PartnerDto
|
|
18675
|
+
*/
|
|
18676
|
+
'logoUrl': string | null;
|
|
18677
|
+
/**
|
|
18678
|
+
* Whether the partner is active
|
|
18679
|
+
* @type {boolean}
|
|
18680
|
+
* @memberof PartnerDto
|
|
18681
|
+
*/
|
|
18682
|
+
'isActive': boolean;
|
|
18683
|
+
/**
|
|
18684
|
+
* When the partner was added, ISO 8601 in UTC
|
|
18685
|
+
* @type {string}
|
|
18686
|
+
* @memberof PartnerDto
|
|
18687
|
+
*/
|
|
18688
|
+
'createdAt': string;
|
|
18689
|
+
/**
|
|
18690
|
+
* When the partner was last changed, ISO 8601 in UTC
|
|
18691
|
+
* @type {string}
|
|
18692
|
+
* @memberof PartnerDto
|
|
18693
|
+
*/
|
|
18694
|
+
'updatedAt': string;
|
|
18695
|
+
}
|
|
18696
|
+
/**
|
|
18697
|
+
*
|
|
18698
|
+
* @export
|
|
18699
|
+
* @enum {string}
|
|
18700
|
+
*/
|
|
18701
|
+
export declare const PartnerWrite: {
|
|
18702
|
+
readonly Created: "created";
|
|
18703
|
+
readonly Updated: "updated";
|
|
18704
|
+
};
|
|
18705
|
+
export type PartnerWrite = typeof PartnerWrite[keyof typeof PartnerWrite];
|
|
18313
18706
|
/**
|
|
18314
18707
|
*
|
|
18315
18708
|
* @export
|
|
@@ -23475,6 +23868,23 @@ export interface PosVivaMerchantDto {
|
|
|
23475
23868
|
*/
|
|
23476
23869
|
'merchantId': string | null;
|
|
23477
23870
|
}
|
|
23871
|
+
/**
|
|
23872
|
+
*
|
|
23873
|
+
* @export
|
|
23874
|
+
* @enum {string}
|
|
23875
|
+
*/
|
|
23876
|
+
export declare const PoyntPaymentStatus: {
|
|
23877
|
+
readonly Authorized: "AUTHORIZED";
|
|
23878
|
+
readonly Canceled: "CANCELED";
|
|
23879
|
+
readonly Completed: "COMPLETED";
|
|
23880
|
+
readonly Declined: "DECLINED";
|
|
23881
|
+
readonly Failed: "FAILED";
|
|
23882
|
+
readonly Hold: "HOLD";
|
|
23883
|
+
readonly ReadCardOnly: "READ_CARD_ONLY";
|
|
23884
|
+
readonly Refunded: "REFUNDED";
|
|
23885
|
+
readonly Voided: "VOIDED";
|
|
23886
|
+
};
|
|
23887
|
+
export type PoyntPaymentStatus = typeof PoyntPaymentStatus[keyof typeof PoyntPaymentStatus];
|
|
23478
23888
|
/**
|
|
23479
23889
|
*
|
|
23480
23890
|
* @export
|
|
@@ -24928,6 +25338,7 @@ export declare const ProviderEnum: {
|
|
|
24928
25338
|
readonly Storefront: "Storefront";
|
|
24929
25339
|
readonly MunchiPay: "MunchiPay";
|
|
24930
25340
|
readonly ResQ: "ResQ";
|
|
25341
|
+
readonly Partner: "Partner";
|
|
24931
25342
|
};
|
|
24932
25343
|
export type ProviderEnum = typeof ProviderEnum[keyof typeof ProviderEnum];
|
|
24933
25344
|
/**
|
|
@@ -26653,6 +27064,152 @@ export declare const RecordManualStatus: {
|
|
|
26653
27064
|
readonly Failed: "FAILED";
|
|
26654
27065
|
};
|
|
26655
27066
|
export type RecordManualStatus = typeof RecordManualStatus[keyof typeof RecordManualStatus];
|
|
27067
|
+
/**
|
|
27068
|
+
*
|
|
27069
|
+
* @export
|
|
27070
|
+
* @interface RecordNexiOnDeviceResultDto
|
|
27071
|
+
*/
|
|
27072
|
+
export interface RecordNexiOnDeviceResultDto {
|
|
27073
|
+
/**
|
|
27074
|
+
* The sessionId the start, refund or revert route answered. A sale\'s and a refund\'s is the reference the payment app was given; a revert\'s names the reversal the void settles.
|
|
27075
|
+
* @type {string}
|
|
27076
|
+
* @memberof RecordNexiOnDeviceResultDto
|
|
27077
|
+
*/
|
|
27078
|
+
'sessionId': string;
|
|
27079
|
+
/**
|
|
27080
|
+
*
|
|
27081
|
+
* @type {RecordNexiOnDeviceResultDtoAnswer}
|
|
27082
|
+
* @memberof RecordNexiOnDeviceResultDto
|
|
27083
|
+
*/
|
|
27084
|
+
'answer': RecordNexiOnDeviceResultDtoAnswer;
|
|
27085
|
+
}
|
|
27086
|
+
/**
|
|
27087
|
+
* The payment app\'s answer, flattened from Poynt\'s Payment by the app.
|
|
27088
|
+
* @export
|
|
27089
|
+
* @interface RecordNexiOnDeviceResultDtoAnswer
|
|
27090
|
+
*/
|
|
27091
|
+
export interface RecordNexiOnDeviceResultDtoAnswer {
|
|
27092
|
+
/**
|
|
27093
|
+
*
|
|
27094
|
+
* @type {PoyntPaymentStatus}
|
|
27095
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27096
|
+
*/
|
|
27097
|
+
'status': PoyntPaymentStatus;
|
|
27098
|
+
/**
|
|
27099
|
+
* The reference the payment app was given, read back from the transaction\'s references: the session\'s sessionId. Required on a sale\'s or a refund\'s approval, which is refused when it is not the session\'s. A decline or a cancel may come without it, and then only ends the wait. Not read on a revert: Poynt\'s void carries the sale\'s references.
|
|
27100
|
+
* @type {string}
|
|
27101
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27102
|
+
*/
|
|
27103
|
+
'reference'?: string;
|
|
27104
|
+
/**
|
|
27105
|
+
* Poynt\'s `Transaction.id`. Required on an approval. On a sale or a refund it becomes the session\'s providerTransactionId, and one id settles one session only. On a revert it is the void\'s own transaction or the sale\'s, and it or parentId must be the sale\'s; it is kept in the stored answer only.
|
|
27106
|
+
* @type {string}
|
|
27107
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27108
|
+
*/
|
|
27109
|
+
'transactionId'?: string;
|
|
27110
|
+
/**
|
|
27111
|
+
* Poynt\'s `Transaction.parentId`: on a void, the sale\'s transaction id. Absent on a sale, and on a refund, which Poynt does not link to its sale (a non-referenced refund).
|
|
27112
|
+
* @type {string}
|
|
27113
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27114
|
+
*/
|
|
27115
|
+
'parentId'?: string;
|
|
27116
|
+
/**
|
|
27117
|
+
* Poynt\'s `Transaction.status`. A sale\'s approval must carry CAPTURED, a refund\'s REFUNDED, a revert\'s VOIDED; any other is kept for ops and the session is not settled.
|
|
27118
|
+
* @type {string}
|
|
27119
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27120
|
+
*/
|
|
27121
|
+
'transactionStatus'?: string;
|
|
27122
|
+
/**
|
|
27123
|
+
* Poynt\'s `Transaction.action` (SALE, REFUND). Kept in the stored answer, not checked.
|
|
27124
|
+
* @type {string}
|
|
27125
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27126
|
+
*/
|
|
27127
|
+
'transactionAction'?: string;
|
|
27128
|
+
/**
|
|
27129
|
+
* Poynt\'s `Transaction.partiallyApproved`. An approval for part of the amount is kept for ops and the session is not settled. Absent reads as false.
|
|
27130
|
+
* @type {boolean}
|
|
27131
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27132
|
+
*/
|
|
27133
|
+
'partiallyApproved'?: boolean;
|
|
27134
|
+
/**
|
|
27135
|
+
* How many of the Payment\'s transactions Poynt approved. Absent or 1 is the normal case; 2 or more is kept for ops and the session is not settled.
|
|
27136
|
+
* @type {number}
|
|
27137
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27138
|
+
*/
|
|
27139
|
+
'approvedTransactionCount'?: number;
|
|
27140
|
+
/**
|
|
27141
|
+
* The currency charged, ISO 4217 alpha code (`amounts.currency`). Required on a sale\'s or a refund\'s approval, and must be the session\'s.
|
|
27142
|
+
* @type {string}
|
|
27143
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27144
|
+
*/
|
|
27145
|
+
'currency'?: string;
|
|
27146
|
+
/**
|
|
27147
|
+
* What the card was charged or refunded, in cents (`amounts.transactionAmount`), tip included. Required on a sale\'s or a refund\'s approval: a sale\'s must be the session\'s amount plus its tip, a refund\'s the refund\'s amount. One that does not match is kept for ops and the session is not settled. Not checked on a revert, which gives back the whole sale.
|
|
27148
|
+
* @type {number}
|
|
27149
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27150
|
+
*/
|
|
27151
|
+
'transactionAmount'?: number;
|
|
27152
|
+
/**
|
|
27153
|
+
* The tip in `amounts.tipAmount`, in cents. Kept in the stored answer; the payment event\'s tip is the session\'s, since the payment app takes no tip of its own.
|
|
27154
|
+
* @type {number}
|
|
27155
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27156
|
+
*/
|
|
27157
|
+
'tipAmount'?: number;
|
|
27158
|
+
/**
|
|
27159
|
+
* The card brand, Poynt\'s `card.type`.
|
|
27160
|
+
* @type {string}
|
|
27161
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27162
|
+
*/
|
|
27163
|
+
'cardType'?: string;
|
|
27164
|
+
/**
|
|
27165
|
+
* The card\'s first six digits (`card.numberFirst6`); they tell a benefit card. Six digits exactly.
|
|
27166
|
+
* @type {string}
|
|
27167
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27168
|
+
*/
|
|
27169
|
+
'numberFirst6'?: string;
|
|
27170
|
+
/**
|
|
27171
|
+
* The card\'s last four digits (`card.numberLast4`). A refund whose card differs from the sale\'s is recorded and logged, never refused. Four digits exactly.
|
|
27172
|
+
* @type {string}
|
|
27173
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27174
|
+
*/
|
|
27175
|
+
'numberLast4'?: string;
|
|
27176
|
+
/**
|
|
27177
|
+
* The issuer\'s approval code (`processorResponse.approvalCode`; Poynt\'s top-level `approvalCode` is null on the N950). Optional: shown on the payment event, never required.
|
|
27178
|
+
* @type {string}
|
|
27179
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27180
|
+
*/
|
|
27181
|
+
'approvalCode'?: string;
|
|
27182
|
+
/**
|
|
27183
|
+
* The acquirer\'s retrieval reference number (`processorResponse.retrievalRefNum`).
|
|
27184
|
+
* @type {string}
|
|
27185
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27186
|
+
*/
|
|
27187
|
+
'retrievalRefNum'?: string;
|
|
27188
|
+
/**
|
|
27189
|
+
* `processorResponse.status`: Successful or Failure. Kept, not checked.
|
|
27190
|
+
* @type {string}
|
|
27191
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27192
|
+
*/
|
|
27193
|
+
'processorStatus'?: string;
|
|
27194
|
+
/**
|
|
27195
|
+
* `processorResponse.statusMessage`: why a transaction failed, in Poynt\'s words. Stored, trimmed, as the session\'s errorMessage when the session ends without money; a blank one (the N950 sends a single space when it has none) is replaced by the server\'s own words.
|
|
27196
|
+
* @type {string}
|
|
27197
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27198
|
+
*/
|
|
27199
|
+
'processorStatusMessage'?: string;
|
|
27200
|
+
/**
|
|
27201
|
+
* Nexi\'s own reference of the transaction (the `npay-reference-number` reference), as the Nexi portal shows it. Kept, not checked.
|
|
27202
|
+
* @type {string}
|
|
27203
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27204
|
+
*/
|
|
27205
|
+
'nexiReferenceNumber'?: string;
|
|
27206
|
+
/**
|
|
27207
|
+
* When Poynt created the transaction, ISO 8601, as the device\'s clock says. Kept in the stored answer only; the payment event\'s time is the server\'s.
|
|
27208
|
+
* @type {string}
|
|
27209
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27210
|
+
*/
|
|
27211
|
+
'createdAt'?: string;
|
|
27212
|
+
}
|
|
26656
27213
|
/**
|
|
26657
27214
|
*
|
|
26658
27215
|
* @export
|
|
@@ -28642,7 +29199,7 @@ export interface ReverseSessionDto {
|
|
|
28642
29199
|
*/
|
|
28643
29200
|
'sessionId': string;
|
|
28644
29201
|
/**
|
|
28645
|
-
* Amount to refund in cents for a partial / item refund. Must be > 0 and <= the session\'s paid amount. Omit to refund the full session amount.
|
|
29202
|
+
* Amount to refund in cents for a partial / item refund. Must be > 0 and <= the session\'s paid amount. Omit to refund the full session amount; on nexi/refund, omitting it refunds what is left of the sale, and nexi/revert ignores it.
|
|
28646
29203
|
* @type {number}
|
|
28647
29204
|
* @memberof ReverseSessionDto
|
|
28648
29205
|
*/
|
|
@@ -31130,6 +31687,74 @@ export interface SaveEpassiCredentialsDto {
|
|
|
31130
31687
|
*/
|
|
31131
31688
|
'posName': string;
|
|
31132
31689
|
}
|
|
31690
|
+
/**
|
|
31691
|
+
*
|
|
31692
|
+
* @export
|
|
31693
|
+
* @interface SavedPartnerDto
|
|
31694
|
+
*/
|
|
31695
|
+
export interface SavedPartnerDto {
|
|
31696
|
+
/**
|
|
31697
|
+
*
|
|
31698
|
+
* @type {PartnerWrite}
|
|
31699
|
+
* @memberof SavedPartnerDto
|
|
31700
|
+
*/
|
|
31701
|
+
'write': PartnerWrite;
|
|
31702
|
+
/**
|
|
31703
|
+
*
|
|
31704
|
+
* @type {SavedPartnerDtoPartner}
|
|
31705
|
+
* @memberof SavedPartnerDto
|
|
31706
|
+
*/
|
|
31707
|
+
'partner': SavedPartnerDtoPartner;
|
|
31708
|
+
}
|
|
31709
|
+
/**
|
|
31710
|
+
* The partner as it is after the save; its key is the one it was saved under, which a key asked in another case is changed to
|
|
31711
|
+
* @export
|
|
31712
|
+
* @interface SavedPartnerDtoPartner
|
|
31713
|
+
*/
|
|
31714
|
+
export interface SavedPartnerDtoPartner {
|
|
31715
|
+
/**
|
|
31716
|
+
* The partner\'s id, which never changes: a provider row links to it, and an order keeps it with the partner\'s name and logo as they were when the order was saved
|
|
31717
|
+
* @type {string}
|
|
31718
|
+
* @memberof SavedPartnerDtoPartner
|
|
31719
|
+
*/
|
|
31720
|
+
'id': string;
|
|
31721
|
+
/**
|
|
31722
|
+
* The partner\'s key, which never changes once created: orders keep it. A platform Munchi connected before the partner standard has its channel name as key (Wolt, WoltStorefront, UberEats, Foodora, Bolt, ResQ); a partner on the partner standard a slug: words of lowercase letters and digits joined by single -, starting with a letter, 2 to 41 characters, that names no Munchi channel
|
|
31723
|
+
* @type {string}
|
|
31724
|
+
* @memberof SavedPartnerDtoPartner
|
|
31725
|
+
*/
|
|
31726
|
+
'key': string;
|
|
31727
|
+
/**
|
|
31728
|
+
* The partner\'s name as the apps show it
|
|
31729
|
+
* @type {string}
|
|
31730
|
+
* @memberof SavedPartnerDtoPartner
|
|
31731
|
+
*/
|
|
31732
|
+
'name': string;
|
|
31733
|
+
/**
|
|
31734
|
+
* The partner\'s logo, an https address; null when it has none
|
|
31735
|
+
* @type {string}
|
|
31736
|
+
* @memberof SavedPartnerDtoPartner
|
|
31737
|
+
*/
|
|
31738
|
+
'logoUrl': string | null;
|
|
31739
|
+
/**
|
|
31740
|
+
* Whether the partner is active
|
|
31741
|
+
* @type {boolean}
|
|
31742
|
+
* @memberof SavedPartnerDtoPartner
|
|
31743
|
+
*/
|
|
31744
|
+
'isActive': boolean;
|
|
31745
|
+
/**
|
|
31746
|
+
* When the partner was added, ISO 8601 in UTC
|
|
31747
|
+
* @type {string}
|
|
31748
|
+
* @memberof SavedPartnerDtoPartner
|
|
31749
|
+
*/
|
|
31750
|
+
'createdAt': string;
|
|
31751
|
+
/**
|
|
31752
|
+
* When the partner was last changed, ISO 8601 in UTC
|
|
31753
|
+
* @type {string}
|
|
31754
|
+
* @memberof SavedPartnerDtoPartner
|
|
31755
|
+
*/
|
|
31756
|
+
'updatedAt': string;
|
|
31757
|
+
}
|
|
31133
31758
|
/**
|
|
31134
31759
|
*
|
|
31135
31760
|
* @export
|
|
@@ -37754,6 +38379,31 @@ export interface UpsertNexiDto {
|
|
|
37754
38379
|
*/
|
|
37755
38380
|
'password'?: string;
|
|
37756
38381
|
}
|
|
38382
|
+
/**
|
|
38383
|
+
*
|
|
38384
|
+
* @export
|
|
38385
|
+
* @interface UpsertPartnerDto
|
|
38386
|
+
*/
|
|
38387
|
+
export interface UpsertPartnerDto {
|
|
38388
|
+
/**
|
|
38389
|
+
* The partner\'s name as the apps show it, 1 to 60 characters once the spaces around it are removed
|
|
38390
|
+
* @type {string}
|
|
38391
|
+
* @memberof UpsertPartnerDto
|
|
38392
|
+
*/
|
|
38393
|
+
'name': string;
|
|
38394
|
+
/**
|
|
38395
|
+
* The partner\'s logo, an https address of at most 2048 characters (Munchi keeps its logos on Google Cloud Storage). null removes it; absent: a new partner has none, and a partner already there keeps its own
|
|
38396
|
+
* @type {string}
|
|
38397
|
+
* @memberof UpsertPartnerDto
|
|
38398
|
+
*/
|
|
38399
|
+
'logoUrl'?: string | null;
|
|
38400
|
+
/**
|
|
38401
|
+
* Whether the partner is active. Absent: a new partner is active, and a partner already there keeps its own
|
|
38402
|
+
* @type {boolean}
|
|
38403
|
+
* @memberof UpsertPartnerDto
|
|
38404
|
+
*/
|
|
38405
|
+
'isActive'?: boolean;
|
|
38406
|
+
}
|
|
37757
38407
|
/**
|
|
37758
38408
|
*
|
|
37759
38409
|
* @export
|
|
@@ -38413,11 +39063,17 @@ export interface VendureSellerUpsertDto {
|
|
|
38413
39063
|
*/
|
|
38414
39064
|
'enabled': boolean;
|
|
38415
39065
|
/**
|
|
38416
|
-
* The Clerk user ids of the venue\'s owners. Each is trimmed and added to the owners the venue has;
|
|
39066
|
+
* The Clerk user ids of the venue\'s owners. Each is trimmed and added to the owners the venue has; an owner is removed only when owners_removed lists it. An empty list or none keeps them as they are
|
|
38417
39067
|
* @type {Array<string>}
|
|
38418
39068
|
* @memberof VendureSellerUpsertDto
|
|
38419
39069
|
*/
|
|
38420
39070
|
'owners'?: Array<string>;
|
|
39071
|
+
/**
|
|
39072
|
+
* The owner keys Vendure removed from the venue in this change: a Clerk user\'s externalId or a Clerk user id. Each is trimmed and removed from the owners the venue has, unless owners sends it too; an owner not listed here is never removed. Absent or empty means nothing was removed. Vendure builds from before its remove-owner route never send it
|
|
39073
|
+
* @type {Array<string>}
|
|
39074
|
+
* @memberof VendureSellerUpsertDto
|
|
39075
|
+
*/
|
|
39076
|
+
'owners_removed'?: Array<string>;
|
|
38421
39077
|
/**
|
|
38422
39078
|
* The venue\'s opening hours, seven days Sunday first, stored on the venue as sent: each day { enabled, lapses: [{ open: { hour, minute }, close: { hour, minute } }] }. Only checked to be a list. An empty list or none keeps the stored schedule
|
|
38423
39079
|
* @type {Array<object>}
|
|
@@ -43840,11 +44496,11 @@ export declare const CashManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
43840
44496
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
43841
44497
|
* @param {string} sessionId The cash session\'s id
|
|
43842
44498
|
* @param {SendCashReportDto} sendCashReportDto
|
|
43843
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
44499
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
43844
44500
|
* @param {*} [options] Override http request option.
|
|
43845
44501
|
* @throws {RequiredError}
|
|
43846
44502
|
*/
|
|
43847
|
-
sendSessionReport: (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44503
|
+
sendSessionReport: (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43848
44504
|
};
|
|
43849
44505
|
/**
|
|
43850
44506
|
* CashManagementApi - functional programming interface
|
|
@@ -43906,11 +44562,11 @@ export declare const CashManagementApiFp: (configuration?: Configuration) => {
|
|
|
43906
44562
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
43907
44563
|
* @param {string} sessionId The cash session\'s id
|
|
43908
44564
|
* @param {SendCashReportDto} sendCashReportDto
|
|
43909
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
44565
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
43910
44566
|
* @param {*} [options] Override http request option.
|
|
43911
44567
|
* @throws {RequiredError}
|
|
43912
44568
|
*/
|
|
43913
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashReportSentDto>>;
|
|
44569
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashReportSentDto>>;
|
|
43914
44570
|
};
|
|
43915
44571
|
/**
|
|
43916
44572
|
* CashManagementApi - factory interface
|
|
@@ -43972,11 +44628,11 @@ export declare const CashManagementApiFactory: (configuration?: Configuration, b
|
|
|
43972
44628
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
43973
44629
|
* @param {string} sessionId The cash session\'s id
|
|
43974
44630
|
* @param {SendCashReportDto} sendCashReportDto
|
|
43975
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
44631
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
43976
44632
|
* @param {*} [options] Override http request option.
|
|
43977
44633
|
* @throws {RequiredError}
|
|
43978
44634
|
*/
|
|
43979
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<CashReportSentDto>;
|
|
44635
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: any): AxiosPromise<CashReportSentDto>;
|
|
43980
44636
|
};
|
|
43981
44637
|
/**
|
|
43982
44638
|
* CashManagementApi - interface
|
|
@@ -44044,12 +44700,12 @@ export interface CashManagementApiInterface {
|
|
|
44044
44700
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
44045
44701
|
* @param {string} sessionId The cash session\'s id
|
|
44046
44702
|
* @param {SendCashReportDto} sendCashReportDto
|
|
44047
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
44703
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
44048
44704
|
* @param {*} [options] Override http request option.
|
|
44049
44705
|
* @throws {RequiredError}
|
|
44050
44706
|
* @memberof CashManagementApiInterface
|
|
44051
44707
|
*/
|
|
44052
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<CashReportSentDto>;
|
|
44708
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<CashReportSentDto>;
|
|
44053
44709
|
}
|
|
44054
44710
|
/**
|
|
44055
44711
|
* CashManagementApi - object-oriented interface
|
|
@@ -44118,12 +44774,12 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
44118
44774
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
44119
44775
|
* @param {string} sessionId The cash session\'s id
|
|
44120
44776
|
* @param {SendCashReportDto} sendCashReportDto
|
|
44121
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
44777
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
44122
44778
|
* @param {*} [options] Override http request option.
|
|
44123
44779
|
* @throws {RequiredError}
|
|
44124
44780
|
* @memberof CashManagementApi
|
|
44125
44781
|
*/
|
|
44126
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashReportSentDto, any, {}>>;
|
|
44782
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashReportSentDto, any, {}>>;
|
|
44127
44783
|
}
|
|
44128
44784
|
/**
|
|
44129
44785
|
* CashManagementV6Api - axios parameter creator
|
|
@@ -44503,21 +45159,21 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44503
45159
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
44504
45160
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
44505
45161
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44506
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45162
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44507
45163
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
44508
45164
|
* @param {*} [options] Override http request option.
|
|
44509
45165
|
* @throws {RequiredError}
|
|
44510
45166
|
*/
|
|
44511
|
-
configConfigureMunchiGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45167
|
+
configConfigureMunchiGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44512
45168
|
/**
|
|
44513
45169
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
44514
45170
|
* @summary Read a channel\'s card payment providers
|
|
44515
45171
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44516
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45172
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44517
45173
|
* @param {*} [options] Override http request option.
|
|
44518
45174
|
* @throws {RequiredError}
|
|
44519
45175
|
*/
|
|
44520
|
-
configGetProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45176
|
+
configGetProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44521
45177
|
/**
|
|
44522
45178
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
44523
45179
|
* @summary Manual sync trigger
|
|
@@ -44532,22 +45188,22 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44532
45188
|
* @summary Remove payment option
|
|
44533
45189
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44534
45190
|
* @param {string} id The payment option\'s id
|
|
44535
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45191
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44536
45192
|
* @param {*} [options] Override http request option.
|
|
44537
45193
|
* @throws {RequiredError}
|
|
44538
45194
|
*/
|
|
44539
|
-
configRemovePaymentOption: (businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45195
|
+
configRemovePaymentOption: (businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44540
45196
|
/**
|
|
44541
45197
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
44542
45198
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44543
45199
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44544
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45200
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44545
45201
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
44546
45202
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
44547
45203
|
* @param {*} [options] Override http request option.
|
|
44548
45204
|
* @throws {RequiredError}
|
|
44549
45205
|
*/
|
|
44550
|
-
configSaveEpassiCredentials: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45206
|
+
configSaveEpassiCredentials: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44551
45207
|
/**
|
|
44552
45208
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
44553
45209
|
* @summary Create or update a venue
|
|
@@ -44561,22 +45217,22 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44561
45217
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
44562
45218
|
* @summary Create or update a channel\'s config
|
|
44563
45219
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44564
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45220
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44565
45221
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
44566
45222
|
* @param {*} [options] Override http request option.
|
|
44567
45223
|
* @throws {RequiredError}
|
|
44568
45224
|
*/
|
|
44569
|
-
configUpsertChannelConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45225
|
+
configUpsertChannelConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44570
45226
|
/**
|
|
44571
45227
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
44572
45228
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
44573
45229
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44574
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45230
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44575
45231
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
44576
45232
|
* @param {*} [options] Override http request option.
|
|
44577
45233
|
* @throws {RequiredError}
|
|
44578
45234
|
*/
|
|
44579
|
-
configUpsertGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45235
|
+
configUpsertGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44580
45236
|
/**
|
|
44581
45237
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
44582
45238
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -44590,72 +45246,72 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44590
45246
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
44591
45247
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44592
45248
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44593
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45249
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44594
45250
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
44595
45251
|
* @param {*} [options] Override http request option.
|
|
44596
45252
|
* @throws {RequiredError}
|
|
44597
45253
|
*/
|
|
44598
|
-
configUpsertNets: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45254
|
+
configUpsertNets: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44599
45255
|
/**
|
|
44600
45256
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
44601
45257
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44602
45258
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44603
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45259
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44604
45260
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
44605
45261
|
* @param {*} [options] Override http request option.
|
|
44606
45262
|
* @throws {RequiredError}
|
|
44607
45263
|
*/
|
|
44608
|
-
configUpsertNexi: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45264
|
+
configUpsertNexi: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44609
45265
|
/**
|
|
44610
45266
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
44611
45267
|
* @summary Create or update a channel\'s checkout payment options
|
|
44612
45268
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44613
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45269
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44614
45270
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
44615
45271
|
* @param {*} [options] Override http request option.
|
|
44616
45272
|
* @throws {RequiredError}
|
|
44617
45273
|
*/
|
|
44618
|
-
configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45274
|
+
configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44619
45275
|
/**
|
|
44620
45276
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
44621
45277
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44622
45278
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44623
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45279
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44624
45280
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
44625
45281
|
* @param {*} [options] Override http request option.
|
|
44626
45282
|
* @throws {RequiredError}
|
|
44627
45283
|
*/
|
|
44628
|
-
configUpsertProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45284
|
+
configUpsertProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44629
45285
|
/**
|
|
44630
45286
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
44631
45287
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44632
45288
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44633
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45289
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44634
45290
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
44635
45291
|
* @param {*} [options] Override http request option.
|
|
44636
45292
|
* @throws {RequiredError}
|
|
44637
45293
|
*/
|
|
44638
|
-
configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45294
|
+
configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44639
45295
|
/**
|
|
44640
45296
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
44641
45297
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44642
45298
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44643
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45299
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44644
45300
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
44645
45301
|
* @param {*} [options] Override http request option.
|
|
44646
45302
|
* @throws {RequiredError}
|
|
44647
45303
|
*/
|
|
44648
|
-
configUpsertViva: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45304
|
+
configUpsertViva: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44649
45305
|
/**
|
|
44650
45306
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
44651
45307
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44652
45308
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44653
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45309
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44654
45310
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44655
45311
|
* @param {*} [options] Override http request option.
|
|
44656
45312
|
* @throws {RequiredError}
|
|
44657
45313
|
*/
|
|
44658
|
-
configUpsertWorldline: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45314
|
+
configUpsertWorldline: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44659
45315
|
};
|
|
44660
45316
|
/**
|
|
44661
45317
|
* ConfigManagementApi - functional programming interface
|
|
@@ -44666,21 +45322,21 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44666
45322
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
44667
45323
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
44668
45324
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44669
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45325
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44670
45326
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
44671
45327
|
* @param {*} [options] Override http request option.
|
|
44672
45328
|
* @throws {RequiredError}
|
|
44673
45329
|
*/
|
|
44674
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45330
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44675
45331
|
/**
|
|
44676
45332
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
44677
45333
|
* @summary Read a channel\'s card payment providers
|
|
44678
45334
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44679
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45335
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44680
45336
|
* @param {*} [options] Override http request option.
|
|
44681
45337
|
* @throws {RequiredError}
|
|
44682
45338
|
*/
|
|
44683
|
-
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>>;
|
|
45339
|
+
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>>;
|
|
44684
45340
|
/**
|
|
44685
45341
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
44686
45342
|
* @summary Manual sync trigger
|
|
@@ -44695,22 +45351,22 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44695
45351
|
* @summary Remove payment option
|
|
44696
45352
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44697
45353
|
* @param {string} id The payment option\'s id
|
|
44698
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45354
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44699
45355
|
* @param {*} [options] Override http request option.
|
|
44700
45356
|
* @throws {RequiredError}
|
|
44701
45357
|
*/
|
|
44702
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45358
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44703
45359
|
/**
|
|
44704
45360
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
44705
45361
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44706
45362
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44707
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45363
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44708
45364
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
44709
45365
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
44710
45366
|
* @param {*} [options] Override http request option.
|
|
44711
45367
|
* @throws {RequiredError}
|
|
44712
45368
|
*/
|
|
44713
|
-
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>>;
|
|
45369
|
+
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>>;
|
|
44714
45370
|
/**
|
|
44715
45371
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
44716
45372
|
* @summary Create or update a venue
|
|
@@ -44724,22 +45380,22 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44724
45380
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
44725
45381
|
* @summary Create or update a channel\'s config
|
|
44726
45382
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44727
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45383
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44728
45384
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
44729
45385
|
* @param {*} [options] Override http request option.
|
|
44730
45386
|
* @throws {RequiredError}
|
|
44731
45387
|
*/
|
|
44732
|
-
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45388
|
+
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44733
45389
|
/**
|
|
44734
45390
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
44735
45391
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
44736
45392
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44737
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45393
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44738
45394
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
44739
45395
|
* @param {*} [options] Override http request option.
|
|
44740
45396
|
* @throws {RequiredError}
|
|
44741
45397
|
*/
|
|
44742
|
-
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45398
|
+
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44743
45399
|
/**
|
|
44744
45400
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
44745
45401
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -44753,72 +45409,72 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44753
45409
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
44754
45410
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44755
45411
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44756
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45412
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44757
45413
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
44758
45414
|
* @param {*} [options] Override http request option.
|
|
44759
45415
|
* @throws {RequiredError}
|
|
44760
45416
|
*/
|
|
44761
|
-
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45417
|
+
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44762
45418
|
/**
|
|
44763
45419
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
44764
45420
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44765
45421
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44766
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45422
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44767
45423
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
44768
45424
|
* @param {*} [options] Override http request option.
|
|
44769
45425
|
* @throws {RequiredError}
|
|
44770
45426
|
*/
|
|
44771
|
-
configUpsertNexi(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45427
|
+
configUpsertNexi(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44772
45428
|
/**
|
|
44773
45429
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
44774
45430
|
* @summary Create or update a channel\'s checkout payment options
|
|
44775
45431
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44776
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45432
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44777
45433
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
44778
45434
|
* @param {*} [options] Override http request option.
|
|
44779
45435
|
* @throws {RequiredError}
|
|
44780
45436
|
*/
|
|
44781
|
-
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45437
|
+
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44782
45438
|
/**
|
|
44783
45439
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
44784
45440
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44785
45441
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44786
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45442
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44787
45443
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
44788
45444
|
* @param {*} [options] Override http request option.
|
|
44789
45445
|
* @throws {RequiredError}
|
|
44790
45446
|
*/
|
|
44791
|
-
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>>;
|
|
45447
|
+
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>>;
|
|
44792
45448
|
/**
|
|
44793
45449
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
44794
45450
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44795
45451
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44796
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45452
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44797
45453
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
44798
45454
|
* @param {*} [options] Override http request option.
|
|
44799
45455
|
* @throws {RequiredError}
|
|
44800
45456
|
*/
|
|
44801
|
-
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45457
|
+
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44802
45458
|
/**
|
|
44803
45459
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
44804
45460
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44805
45461
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44806
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45462
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44807
45463
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
44808
45464
|
* @param {*} [options] Override http request option.
|
|
44809
45465
|
* @throws {RequiredError}
|
|
44810
45466
|
*/
|
|
44811
|
-
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45467
|
+
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44812
45468
|
/**
|
|
44813
45469
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
44814
45470
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44815
45471
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44816
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45472
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44817
45473
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44818
45474
|
* @param {*} [options] Override http request option.
|
|
44819
45475
|
* @throws {RequiredError}
|
|
44820
45476
|
*/
|
|
44821
|
-
configUpsertWorldline(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
45477
|
+
configUpsertWorldline(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44822
45478
|
};
|
|
44823
45479
|
/**
|
|
44824
45480
|
* ConfigManagementApi - factory interface
|
|
@@ -44829,21 +45485,21 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44829
45485
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
44830
45486
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
44831
45487
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44832
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45488
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44833
45489
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
44834
45490
|
* @param {*} [options] Override http request option.
|
|
44835
45491
|
* @throws {RequiredError}
|
|
44836
45492
|
*/
|
|
44837
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45493
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44838
45494
|
/**
|
|
44839
45495
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
44840
45496
|
* @summary Read a channel\'s card payment providers
|
|
44841
45497
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44842
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45498
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44843
45499
|
* @param {*} [options] Override http request option.
|
|
44844
45500
|
* @throws {RequiredError}
|
|
44845
45501
|
*/
|
|
44846
|
-
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45502
|
+
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
44847
45503
|
/**
|
|
44848
45504
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
44849
45505
|
* @summary Manual sync trigger
|
|
@@ -44858,22 +45514,22 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44858
45514
|
* @summary Remove payment option
|
|
44859
45515
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44860
45516
|
* @param {string} id The payment option\'s id
|
|
44861
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45517
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44862
45518
|
* @param {*} [options] Override http request option.
|
|
44863
45519
|
* @throws {RequiredError}
|
|
44864
45520
|
*/
|
|
44865
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45521
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44866
45522
|
/**
|
|
44867
45523
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
44868
45524
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44869
45525
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44870
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45526
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44871
45527
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
44872
45528
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
44873
45529
|
* @param {*} [options] Override http request option.
|
|
44874
45530
|
* @throws {RequiredError}
|
|
44875
45531
|
*/
|
|
44876
|
-
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
45532
|
+
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
44877
45533
|
/**
|
|
44878
45534
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
44879
45535
|
* @summary Create or update a venue
|
|
@@ -44887,22 +45543,22 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44887
45543
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
44888
45544
|
* @summary Create or update a channel\'s config
|
|
44889
45545
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44890
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45546
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44891
45547
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
44892
45548
|
* @param {*} [options] Override http request option.
|
|
44893
45549
|
* @throws {RequiredError}
|
|
44894
45550
|
*/
|
|
44895
|
-
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45551
|
+
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44896
45552
|
/**
|
|
44897
45553
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
44898
45554
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
44899
45555
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44900
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45556
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44901
45557
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
44902
45558
|
* @param {*} [options] Override http request option.
|
|
44903
45559
|
* @throws {RequiredError}
|
|
44904
45560
|
*/
|
|
44905
|
-
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45561
|
+
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44906
45562
|
/**
|
|
44907
45563
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
44908
45564
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -44916,72 +45572,72 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44916
45572
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
44917
45573
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44918
45574
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44919
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45575
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44920
45576
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
44921
45577
|
* @param {*} [options] Override http request option.
|
|
44922
45578
|
* @throws {RequiredError}
|
|
44923
45579
|
*/
|
|
44924
|
-
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45580
|
+
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44925
45581
|
/**
|
|
44926
45582
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
44927
45583
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44928
45584
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44929
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45585
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44930
45586
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
44931
45587
|
* @param {*} [options] Override http request option.
|
|
44932
45588
|
* @throws {RequiredError}
|
|
44933
45589
|
*/
|
|
44934
|
-
configUpsertNexi(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNexiDto: UpsertNexiDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45590
|
+
configUpsertNexi(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNexiDto: UpsertNexiDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44935
45591
|
/**
|
|
44936
45592
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
44937
45593
|
* @summary Create or update a channel\'s checkout payment options
|
|
44938
45594
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44939
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45595
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44940
45596
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
44941
45597
|
* @param {*} [options] Override http request option.
|
|
44942
45598
|
* @throws {RequiredError}
|
|
44943
45599
|
*/
|
|
44944
|
-
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45600
|
+
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44945
45601
|
/**
|
|
44946
45602
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
44947
45603
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44948
45604
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44949
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45605
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44950
45606
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
44951
45607
|
* @param {*} [options] Override http request option.
|
|
44952
45608
|
* @throws {RequiredError}
|
|
44953
45609
|
*/
|
|
44954
|
-
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45610
|
+
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
44955
45611
|
/**
|
|
44956
45612
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
44957
45613
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44958
45614
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44959
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45615
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44960
45616
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
44961
45617
|
* @param {*} [options] Override http request option.
|
|
44962
45618
|
* @throws {RequiredError}
|
|
44963
45619
|
*/
|
|
44964
|
-
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45620
|
+
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44965
45621
|
/**
|
|
44966
45622
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
44967
45623
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44968
45624
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44969
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45625
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44970
45626
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
44971
45627
|
* @param {*} [options] Override http request option.
|
|
44972
45628
|
* @throws {RequiredError}
|
|
44973
45629
|
*/
|
|
44974
|
-
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45630
|
+
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44975
45631
|
/**
|
|
44976
45632
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
44977
45633
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44978
45634
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44979
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45635
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44980
45636
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44981
45637
|
* @param {*} [options] Override http request option.
|
|
44982
45638
|
* @throws {RequiredError}
|
|
44983
45639
|
*/
|
|
44984
|
-
configUpsertWorldline(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertWorldlineDto: UpsertWorldlineDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
45640
|
+
configUpsertWorldline(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertWorldlineDto: UpsertWorldlineDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44985
45641
|
};
|
|
44986
45642
|
/**
|
|
44987
45643
|
* ConfigManagementApi - interface
|
|
@@ -44993,23 +45649,23 @@ export interface ConfigManagementApiInterface {
|
|
|
44993
45649
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
44994
45650
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
44995
45651
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44996
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45652
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
44997
45653
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
44998
45654
|
* @param {*} [options] Override http request option.
|
|
44999
45655
|
* @throws {RequiredError}
|
|
45000
45656
|
* @memberof ConfigManagementApiInterface
|
|
45001
45657
|
*/
|
|
45002
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45658
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45003
45659
|
/**
|
|
45004
45660
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
45005
45661
|
* @summary Read a channel\'s card payment providers
|
|
45006
45662
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45007
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45663
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45008
45664
|
* @param {*} [options] Override http request option.
|
|
45009
45665
|
* @throws {RequiredError}
|
|
45010
45666
|
* @memberof ConfigManagementApiInterface
|
|
45011
45667
|
*/
|
|
45012
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45668
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45013
45669
|
/**
|
|
45014
45670
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
45015
45671
|
* @summary Manual sync trigger
|
|
@@ -45025,24 +45681,24 @@ export interface ConfigManagementApiInterface {
|
|
|
45025
45681
|
* @summary Remove payment option
|
|
45026
45682
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45027
45683
|
* @param {string} id The payment option\'s id
|
|
45028
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45684
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45029
45685
|
* @param {*} [options] Override http request option.
|
|
45030
45686
|
* @throws {RequiredError}
|
|
45031
45687
|
* @memberof ConfigManagementApiInterface
|
|
45032
45688
|
*/
|
|
45033
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45689
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45034
45690
|
/**
|
|
45035
45691
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
45036
45692
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
45037
45693
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45038
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45694
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45039
45695
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
45040
45696
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
45041
45697
|
* @param {*} [options] Override http request option.
|
|
45042
45698
|
* @throws {RequiredError}
|
|
45043
45699
|
* @memberof ConfigManagementApiInterface
|
|
45044
45700
|
*/
|
|
45045
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
45701
|
+
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
45046
45702
|
/**
|
|
45047
45703
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
45048
45704
|
* @summary Create or update a venue
|
|
@@ -45057,24 +45713,24 @@ export interface ConfigManagementApiInterface {
|
|
|
45057
45713
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
45058
45714
|
* @summary Create or update a channel\'s config
|
|
45059
45715
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45060
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45716
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45061
45717
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
45062
45718
|
* @param {*} [options] Override http request option.
|
|
45063
45719
|
* @throws {RequiredError}
|
|
45064
45720
|
* @memberof ConfigManagementApiInterface
|
|
45065
45721
|
*/
|
|
45066
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45722
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45067
45723
|
/**
|
|
45068
45724
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
45069
45725
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
45070
45726
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45071
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45727
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45072
45728
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
45073
45729
|
* @param {*} [options] Override http request option.
|
|
45074
45730
|
* @throws {RequiredError}
|
|
45075
45731
|
* @memberof ConfigManagementApiInterface
|
|
45076
45732
|
*/
|
|
45077
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45733
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45078
45734
|
/**
|
|
45079
45735
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
45080
45736
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -45089,79 +45745,79 @@ export interface ConfigManagementApiInterface {
|
|
|
45089
45745
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
45090
45746
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
45091
45747
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45092
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45748
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45093
45749
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
45094
45750
|
* @param {*} [options] Override http request option.
|
|
45095
45751
|
* @throws {RequiredError}
|
|
45096
45752
|
* @memberof ConfigManagementApiInterface
|
|
45097
45753
|
*/
|
|
45098
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45754
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45099
45755
|
/**
|
|
45100
45756
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
45101
45757
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
45102
45758
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45103
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45759
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45104
45760
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
45105
45761
|
* @param {*} [options] Override http request option.
|
|
45106
45762
|
* @throws {RequiredError}
|
|
45107
45763
|
* @memberof ConfigManagementApiInterface
|
|
45108
45764
|
*/
|
|
45109
|
-
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45765
|
+
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45110
45766
|
/**
|
|
45111
45767
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
45112
45768
|
* @summary Create or update a channel\'s checkout payment options
|
|
45113
45769
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45114
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45770
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45115
45771
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
45116
45772
|
* @param {*} [options] Override http request option.
|
|
45117
45773
|
* @throws {RequiredError}
|
|
45118
45774
|
* @memberof ConfigManagementApiInterface
|
|
45119
45775
|
*/
|
|
45120
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45776
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45121
45777
|
/**
|
|
45122
45778
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
45123
45779
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
45124
45780
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45125
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45781
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45126
45782
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
45127
45783
|
* @param {*} [options] Override http request option.
|
|
45128
45784
|
* @throws {RequiredError}
|
|
45129
45785
|
* @memberof ConfigManagementApiInterface
|
|
45130
45786
|
*/
|
|
45131
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45787
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45132
45788
|
/**
|
|
45133
45789
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
45134
45790
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
45135
45791
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45136
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45792
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45137
45793
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
45138
45794
|
* @param {*} [options] Override http request option.
|
|
45139
45795
|
* @throws {RequiredError}
|
|
45140
45796
|
* @memberof ConfigManagementApiInterface
|
|
45141
45797
|
*/
|
|
45142
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45798
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45143
45799
|
/**
|
|
45144
45800
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
45145
45801
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
45146
45802
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45147
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45803
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45148
45804
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
45149
45805
|
* @param {*} [options] Override http request option.
|
|
45150
45806
|
* @throws {RequiredError}
|
|
45151
45807
|
* @memberof ConfigManagementApiInterface
|
|
45152
45808
|
*/
|
|
45153
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45809
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45154
45810
|
/**
|
|
45155
45811
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
45156
45812
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
45157
45813
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45158
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45814
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45159
45815
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
45160
45816
|
* @param {*} [options] Override http request option.
|
|
45161
45817
|
* @throws {RequiredError}
|
|
45162
45818
|
* @memberof ConfigManagementApiInterface
|
|
45163
45819
|
*/
|
|
45164
|
-
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45820
|
+
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45165
45821
|
}
|
|
45166
45822
|
/**
|
|
45167
45823
|
* ConfigManagementApi - object-oriented interface
|
|
@@ -45174,23 +45830,23 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
45174
45830
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
45175
45831
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
45176
45832
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45177
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45833
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45178
45834
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
45179
45835
|
* @param {*} [options] Override http request option.
|
|
45180
45836
|
* @throws {RequiredError}
|
|
45181
45837
|
* @memberof ConfigManagementApi
|
|
45182
45838
|
*/
|
|
45183
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45839
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45184
45840
|
/**
|
|
45185
45841
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
45186
45842
|
* @summary Read a channel\'s card payment providers
|
|
45187
45843
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45188
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45844
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45189
45845
|
* @param {*} [options] Override http request option.
|
|
45190
45846
|
* @throws {RequiredError}
|
|
45191
45847
|
* @memberof ConfigManagementApi
|
|
45192
45848
|
*/
|
|
45193
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
45849
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
45194
45850
|
/**
|
|
45195
45851
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
45196
45852
|
* @summary Manual sync trigger
|
|
@@ -45206,24 +45862,24 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
45206
45862
|
* @summary Remove payment option
|
|
45207
45863
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45208
45864
|
* @param {string} id The payment option\'s id
|
|
45209
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45865
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45210
45866
|
* @param {*} [options] Override http request option.
|
|
45211
45867
|
* @throws {RequiredError}
|
|
45212
45868
|
* @memberof ConfigManagementApi
|
|
45213
45869
|
*/
|
|
45214
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45870
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45215
45871
|
/**
|
|
45216
45872
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
45217
45873
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
45218
45874
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45219
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45875
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45220
45876
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
45221
45877
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
45222
45878
|
* @param {*} [options] Override http request option.
|
|
45223
45879
|
* @throws {RequiredError}
|
|
45224
45880
|
* @memberof ConfigManagementApi
|
|
45225
45881
|
*/
|
|
45226
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
|
|
45882
|
+
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
|
|
45227
45883
|
/**
|
|
45228
45884
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
45229
45885
|
* @summary Create or update a venue
|
|
@@ -45238,24 +45894,24 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
45238
45894
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
45239
45895
|
* @summary Create or update a channel\'s config
|
|
45240
45896
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45241
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45897
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45242
45898
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
45243
45899
|
* @param {*} [options] Override http request option.
|
|
45244
45900
|
* @throws {RequiredError}
|
|
45245
45901
|
* @memberof ConfigManagementApi
|
|
45246
45902
|
*/
|
|
45247
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45903
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45248
45904
|
/**
|
|
45249
45905
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
45250
45906
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
45251
45907
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45252
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45908
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45253
45909
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
45254
45910
|
* @param {*} [options] Override http request option.
|
|
45255
45911
|
* @throws {RequiredError}
|
|
45256
45912
|
* @memberof ConfigManagementApi
|
|
45257
45913
|
*/
|
|
45258
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45914
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45259
45915
|
/**
|
|
45260
45916
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
45261
45917
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -45270,79 +45926,79 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
45270
45926
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
45271
45927
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
45272
45928
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45273
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45929
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45274
45930
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
45275
45931
|
* @param {*} [options] Override http request option.
|
|
45276
45932
|
* @throws {RequiredError}
|
|
45277
45933
|
* @memberof ConfigManagementApi
|
|
45278
45934
|
*/
|
|
45279
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45935
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45280
45936
|
/**
|
|
45281
45937
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
45282
45938
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
45283
45939
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45284
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45940
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45285
45941
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
45286
45942
|
* @param {*} [options] Override http request option.
|
|
45287
45943
|
* @throws {RequiredError}
|
|
45288
45944
|
* @memberof ConfigManagementApi
|
|
45289
45945
|
*/
|
|
45290
|
-
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45946
|
+
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45291
45947
|
/**
|
|
45292
45948
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
45293
45949
|
* @summary Create or update a channel\'s checkout payment options
|
|
45294
45950
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45295
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45951
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45296
45952
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
45297
45953
|
* @param {*} [options] Override http request option.
|
|
45298
45954
|
* @throws {RequiredError}
|
|
45299
45955
|
* @memberof ConfigManagementApi
|
|
45300
45956
|
*/
|
|
45301
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45957
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45302
45958
|
/**
|
|
45303
45959
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
45304
45960
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
45305
45961
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45306
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45962
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45307
45963
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
45308
45964
|
* @param {*} [options] Override http request option.
|
|
45309
45965
|
* @throws {RequiredError}
|
|
45310
45966
|
* @memberof ConfigManagementApi
|
|
45311
45967
|
*/
|
|
45312
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
45968
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
45313
45969
|
/**
|
|
45314
45970
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
45315
45971
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
45316
45972
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45317
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45973
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45318
45974
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
45319
45975
|
* @param {*} [options] Override http request option.
|
|
45320
45976
|
* @throws {RequiredError}
|
|
45321
45977
|
* @memberof ConfigManagementApi
|
|
45322
45978
|
*/
|
|
45323
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45979
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45324
45980
|
/**
|
|
45325
45981
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
45326
45982
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
45327
45983
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45328
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45984
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45329
45985
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
45330
45986
|
* @param {*} [options] Override http request option.
|
|
45331
45987
|
* @throws {RequiredError}
|
|
45332
45988
|
* @memberof ConfigManagementApi
|
|
45333
45989
|
*/
|
|
45334
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45990
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45335
45991
|
/**
|
|
45336
45992
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
45337
45993
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
45338
45994
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45339
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45995
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
45340
45996
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
45341
45997
|
* @param {*} [options] Override http request option.
|
|
45342
45998
|
* @throws {RequiredError}
|
|
45343
45999
|
* @memberof ConfigManagementApi
|
|
45344
46000
|
*/
|
|
45345
|
-
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
46001
|
+
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45346
46002
|
}
|
|
45347
46003
|
/**
|
|
45348
46004
|
* CouponsApi - axios parameter creator
|
|
@@ -50991,6 +51647,13 @@ export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
50991
51647
|
* @throws {RequiredError}
|
|
50992
51648
|
*/
|
|
50993
51649
|
disconnectDeliveryPlatform: (venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51650
|
+
/**
|
|
51651
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51652
|
+
* @summary Every delivery partner, by key
|
|
51653
|
+
* @param {*} [options] Override http request option.
|
|
51654
|
+
* @throws {RequiredError}
|
|
51655
|
+
*/
|
|
51656
|
+
listPartners: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50994
51657
|
/**
|
|
50995
51658
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
50996
51659
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51008,6 +51671,15 @@ export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
51008
51671
|
* @throws {RequiredError}
|
|
51009
51672
|
*/
|
|
51010
51673
|
searchVenues: (search: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51674
|
+
/**
|
|
51675
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51676
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51677
|
+
* @param {string} key The partner\'s key
|
|
51678
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51679
|
+
* @param {*} [options] Override http request option.
|
|
51680
|
+
* @throws {RequiredError}
|
|
51681
|
+
*/
|
|
51682
|
+
upsertPartner: (key: string, upsertPartnerDto: UpsertPartnerDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51011
51683
|
};
|
|
51012
51684
|
/**
|
|
51013
51685
|
* OpsApi - functional programming interface
|
|
@@ -51040,6 +51712,13 @@ export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
|
51040
51712
|
* @throws {RequiredError}
|
|
51041
51713
|
*/
|
|
51042
51714
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisconnectedDeliveryPlatformDto>>;
|
|
51715
|
+
/**
|
|
51716
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51717
|
+
* @summary Every delivery partner, by key
|
|
51718
|
+
* @param {*} [options] Override http request option.
|
|
51719
|
+
* @throws {RequiredError}
|
|
51720
|
+
*/
|
|
51721
|
+
listPartners(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDto>>>;
|
|
51043
51722
|
/**
|
|
51044
51723
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
51045
51724
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51057,6 +51736,15 @@ export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
|
51057
51736
|
* @throws {RequiredError}
|
|
51058
51737
|
*/
|
|
51059
51738
|
searchVenues(search: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VenueFoundDto>>>;
|
|
51739
|
+
/**
|
|
51740
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51741
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51742
|
+
* @param {string} key The partner\'s key
|
|
51743
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51744
|
+
* @param {*} [options] Override http request option.
|
|
51745
|
+
* @throws {RequiredError}
|
|
51746
|
+
*/
|
|
51747
|
+
upsertPartner(key: string, upsertPartnerDto: UpsertPartnerDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedPartnerDto>>;
|
|
51060
51748
|
};
|
|
51061
51749
|
/**
|
|
51062
51750
|
* OpsApi - factory interface
|
|
@@ -51089,6 +51777,13 @@ export declare const OpsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
51089
51777
|
* @throws {RequiredError}
|
|
51090
51778
|
*/
|
|
51091
51779
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: any): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
51780
|
+
/**
|
|
51781
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51782
|
+
* @summary Every delivery partner, by key
|
|
51783
|
+
* @param {*} [options] Override http request option.
|
|
51784
|
+
* @throws {RequiredError}
|
|
51785
|
+
*/
|
|
51786
|
+
listPartners(options?: any): AxiosPromise<Array<PartnerDto>>;
|
|
51092
51787
|
/**
|
|
51093
51788
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
51094
51789
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51106,6 +51801,15 @@ export declare const OpsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
51106
51801
|
* @throws {RequiredError}
|
|
51107
51802
|
*/
|
|
51108
51803
|
searchVenues(search: string, limit?: number, options?: any): AxiosPromise<Array<VenueFoundDto>>;
|
|
51804
|
+
/**
|
|
51805
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51806
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51807
|
+
* @param {string} key The partner\'s key
|
|
51808
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51809
|
+
* @param {*} [options] Override http request option.
|
|
51810
|
+
* @throws {RequiredError}
|
|
51811
|
+
*/
|
|
51812
|
+
upsertPartner(key: string, upsertPartnerDto: UpsertPartnerDto, options?: any): AxiosPromise<SavedPartnerDto>;
|
|
51109
51813
|
};
|
|
51110
51814
|
/**
|
|
51111
51815
|
* OpsApi - interface
|
|
@@ -51142,6 +51846,14 @@ export interface OpsApiInterface {
|
|
|
51142
51846
|
* @memberof OpsApiInterface
|
|
51143
51847
|
*/
|
|
51144
51848
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
51849
|
+
/**
|
|
51850
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51851
|
+
* @summary Every delivery partner, by key
|
|
51852
|
+
* @param {*} [options] Override http request option.
|
|
51853
|
+
* @throws {RequiredError}
|
|
51854
|
+
* @memberof OpsApiInterface
|
|
51855
|
+
*/
|
|
51856
|
+
listPartners(options?: AxiosRequestConfig): AxiosPromise<Array<PartnerDto>>;
|
|
51145
51857
|
/**
|
|
51146
51858
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
51147
51859
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51161,6 +51873,16 @@ export interface OpsApiInterface {
|
|
|
51161
51873
|
* @memberof OpsApiInterface
|
|
51162
51874
|
*/
|
|
51163
51875
|
searchVenues(search: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<Array<VenueFoundDto>>;
|
|
51876
|
+
/**
|
|
51877
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51878
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51879
|
+
* @param {string} key The partner\'s key
|
|
51880
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51881
|
+
* @param {*} [options] Override http request option.
|
|
51882
|
+
* @throws {RequiredError}
|
|
51883
|
+
* @memberof OpsApiInterface
|
|
51884
|
+
*/
|
|
51885
|
+
upsertPartner(key: string, upsertPartnerDto: UpsertPartnerDto, options?: AxiosRequestConfig): AxiosPromise<SavedPartnerDto>;
|
|
51164
51886
|
}
|
|
51165
51887
|
/**
|
|
51166
51888
|
* OpsApi - object-oriented interface
|
|
@@ -51198,6 +51920,14 @@ export declare class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
51198
51920
|
* @memberof OpsApi
|
|
51199
51921
|
*/
|
|
51200
51922
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DisconnectedDeliveryPlatformDto, any, {}>>;
|
|
51923
|
+
/**
|
|
51924
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51925
|
+
* @summary Every delivery partner, by key
|
|
51926
|
+
* @param {*} [options] Override http request option.
|
|
51927
|
+
* @throws {RequiredError}
|
|
51928
|
+
* @memberof OpsApi
|
|
51929
|
+
*/
|
|
51930
|
+
listPartners(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerDto[], any, {}>>;
|
|
51201
51931
|
/**
|
|
51202
51932
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
51203
51933
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51217,6 +51947,16 @@ export declare class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
51217
51947
|
* @memberof OpsApi
|
|
51218
51948
|
*/
|
|
51219
51949
|
searchVenues(search: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueFoundDto[], any, {}>>;
|
|
51950
|
+
/**
|
|
51951
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51952
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51953
|
+
* @param {string} key The partner\'s key
|
|
51954
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51955
|
+
* @param {*} [options] Override http request option.
|
|
51956
|
+
* @throws {RequiredError}
|
|
51957
|
+
* @memberof OpsApi
|
|
51958
|
+
*/
|
|
51959
|
+
upsertPartner(key: string, upsertPartnerDto: UpsertPartnerDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedPartnerDto, any, {}>>;
|
|
51220
51960
|
}
|
|
51221
51961
|
/**
|
|
51222
51962
|
* OrderCompletionApi - axios parameter creator
|
|
@@ -53555,7 +54295,7 @@ export declare class PaymentMethodsApi extends BaseAPI implements PaymentMethods
|
|
|
53555
54295
|
*/
|
|
53556
54296
|
export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
53557
54297
|
/**
|
|
53558
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
54298
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
53559
54299
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
53560
54300
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
53561
54301
|
* @param {*} [options] Override http request option.
|
|
@@ -53619,7 +54359,16 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53619
54359
|
*/
|
|
53620
54360
|
initiateNetsSession: (initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53621
54361
|
/**
|
|
53622
|
-
*
|
|
54362
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
54363
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
54364
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
54365
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
54366
|
+
* @param {*} [options] Override http request option.
|
|
54367
|
+
* @throws {RequiredError}
|
|
54368
|
+
*/
|
|
54369
|
+
initiateNexiOnDeviceSession: (initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54370
|
+
/**
|
|
54371
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
53623
54372
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53624
54373
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53625
54374
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -53711,6 +54460,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53711
54460
|
* @throws {RequiredError}
|
|
53712
54461
|
*/
|
|
53713
54462
|
recordManualPayment: (createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54463
|
+
/**
|
|
54464
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54465
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
54466
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
54467
|
+
* @param {*} [options] Override http request option.
|
|
54468
|
+
* @throws {RequiredError}
|
|
54469
|
+
*/
|
|
54470
|
+
recordNexiOnDeviceResult: (recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53714
54471
|
/**
|
|
53715
54472
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
53716
54473
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -53735,6 +54492,23 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53735
54492
|
* @throws {RequiredError}
|
|
53736
54493
|
*/
|
|
53737
54494
|
refundNetsSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54495
|
+
/**
|
|
54496
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54497
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
54498
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54499
|
+
* @param {*} [options] Override http request option.
|
|
54500
|
+
* @throws {RequiredError}
|
|
54501
|
+
*/
|
|
54502
|
+
refundNexiOnDeviceSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54503
|
+
/**
|
|
54504
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54505
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
54506
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54507
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
54508
|
+
* @param {*} [options] Override http request option.
|
|
54509
|
+
* @throws {RequiredError}
|
|
54510
|
+
*/
|
|
54511
|
+
refundNexiSession: (reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53738
54512
|
/**
|
|
53739
54513
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
53740
54514
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -53775,6 +54549,22 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53775
54549
|
* @throws {RequiredError}
|
|
53776
54550
|
*/
|
|
53777
54551
|
revertNetsSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54552
|
+
/**
|
|
54553
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54554
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
54555
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54556
|
+
* @param {*} [options] Override http request option.
|
|
54557
|
+
* @throws {RequiredError}
|
|
54558
|
+
*/
|
|
54559
|
+
revertNexiOnDeviceSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54560
|
+
/**
|
|
54561
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54562
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
54563
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54564
|
+
* @param {*} [options] Override http request option.
|
|
54565
|
+
* @throws {RequiredError}
|
|
54566
|
+
*/
|
|
54567
|
+
revertNexiSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53778
54568
|
/**
|
|
53779
54569
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
53780
54570
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -53822,7 +54612,7 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53822
54612
|
*/
|
|
53823
54613
|
export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
53824
54614
|
/**
|
|
53825
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
54615
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
53826
54616
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
53827
54617
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
53828
54618
|
* @param {*} [options] Override http request option.
|
|
@@ -53886,7 +54676,16 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
53886
54676
|
*/
|
|
53887
54677
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateNetsSessionResponseDto>>;
|
|
53888
54678
|
/**
|
|
53889
|
-
*
|
|
54679
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
54680
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
54681
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
54682
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
54683
|
+
* @param {*} [options] Override http request option.
|
|
54684
|
+
* @throws {RequiredError}
|
|
54685
|
+
*/
|
|
54686
|
+
initiateNexiOnDeviceSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54687
|
+
/**
|
|
54688
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
53890
54689
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53891
54690
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53892
54691
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -53978,6 +54777,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
53978
54777
|
* @throws {RequiredError}
|
|
53979
54778
|
*/
|
|
53980
54779
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
|
|
54780
|
+
/**
|
|
54781
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54782
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
54783
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
54784
|
+
* @param {*} [options] Override http request option.
|
|
54785
|
+
* @throws {RequiredError}
|
|
54786
|
+
*/
|
|
54787
|
+
recordNexiOnDeviceResult(recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NexiOnDeviceResultViewDto>>;
|
|
53981
54788
|
/**
|
|
53982
54789
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
53983
54790
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -54002,6 +54809,23 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
54002
54809
|
* @throws {RequiredError}
|
|
54003
54810
|
*/
|
|
54004
54811
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54812
|
+
/**
|
|
54813
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54814
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
54815
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54816
|
+
* @param {*} [options] Override http request option.
|
|
54817
|
+
* @throws {RequiredError}
|
|
54818
|
+
*/
|
|
54819
|
+
refundNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54820
|
+
/**
|
|
54821
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54822
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
54823
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54824
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
54825
|
+
* @param {*} [options] Override http request option.
|
|
54826
|
+
* @throws {RequiredError}
|
|
54827
|
+
*/
|
|
54828
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54005
54829
|
/**
|
|
54006
54830
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
54007
54831
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -54042,6 +54866,22 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
54042
54866
|
* @throws {RequiredError}
|
|
54043
54867
|
*/
|
|
54044
54868
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetsRevertResponseDto>>;
|
|
54869
|
+
/**
|
|
54870
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54871
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
54872
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54873
|
+
* @param {*} [options] Override http request option.
|
|
54874
|
+
* @throws {RequiredError}
|
|
54875
|
+
*/
|
|
54876
|
+
revertNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54877
|
+
/**
|
|
54878
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54879
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
54880
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54881
|
+
* @param {*} [options] Override http request option.
|
|
54882
|
+
* @throws {RequiredError}
|
|
54883
|
+
*/
|
|
54884
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54045
54885
|
/**
|
|
54046
54886
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
54047
54887
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -54089,7 +54929,7 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
54089
54929
|
*/
|
|
54090
54930
|
export declare const PaymentSessionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
54091
54931
|
/**
|
|
54092
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
54932
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
54093
54933
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
54094
54934
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
54095
54935
|
* @param {*} [options] Override http request option.
|
|
@@ -54153,7 +54993,16 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54153
54993
|
*/
|
|
54154
54994
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
54155
54995
|
/**
|
|
54156
|
-
*
|
|
54996
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
54997
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
54998
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
54999
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
55000
|
+
* @param {*} [options] Override http request option.
|
|
55001
|
+
* @throws {RequiredError}
|
|
55002
|
+
*/
|
|
55003
|
+
initiateNexiOnDeviceSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
55004
|
+
/**
|
|
55005
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
54157
55006
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54158
55007
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54159
55008
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -54245,6 +55094,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54245
55094
|
* @throws {RequiredError}
|
|
54246
55095
|
*/
|
|
54247
55096
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
|
|
55097
|
+
/**
|
|
55098
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
55099
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
55100
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
55101
|
+
* @param {*} [options] Override http request option.
|
|
55102
|
+
* @throws {RequiredError}
|
|
55103
|
+
*/
|
|
55104
|
+
recordNexiOnDeviceResult(recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: any): AxiosPromise<NexiOnDeviceResultViewDto>;
|
|
54248
55105
|
/**
|
|
54249
55106
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54250
55107
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -54269,6 +55126,23 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54269
55126
|
* @throws {RequiredError}
|
|
54270
55127
|
*/
|
|
54271
55128
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
55129
|
+
/**
|
|
55130
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55131
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
55132
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55133
|
+
* @param {*} [options] Override http request option.
|
|
55134
|
+
* @throws {RequiredError}
|
|
55135
|
+
*/
|
|
55136
|
+
refundNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
55137
|
+
/**
|
|
55138
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55139
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
55140
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55141
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
55142
|
+
* @param {*} [options] Override http request option.
|
|
55143
|
+
* @throws {RequiredError}
|
|
55144
|
+
*/
|
|
55145
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
54272
55146
|
/**
|
|
54273
55147
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
54274
55148
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -54309,6 +55183,22 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54309
55183
|
* @throws {RequiredError}
|
|
54310
55184
|
*/
|
|
54311
55185
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<NetsRevertResponseDto>;
|
|
55186
|
+
/**
|
|
55187
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55188
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
55189
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55190
|
+
* @param {*} [options] Override http request option.
|
|
55191
|
+
* @throws {RequiredError}
|
|
55192
|
+
*/
|
|
55193
|
+
revertNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
55194
|
+
/**
|
|
55195
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55196
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
55197
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55198
|
+
* @param {*} [options] Override http request option.
|
|
55199
|
+
* @throws {RequiredError}
|
|
55200
|
+
*/
|
|
55201
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
54312
55202
|
/**
|
|
54313
55203
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
54314
55204
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -54357,7 +55247,7 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54357
55247
|
*/
|
|
54358
55248
|
export interface PaymentSessionApiInterface {
|
|
54359
55249
|
/**
|
|
54360
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
55250
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
54361
55251
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
54362
55252
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
54363
55253
|
* @param {*} [options] Override http request option.
|
|
@@ -54428,7 +55318,17 @@ export interface PaymentSessionApiInterface {
|
|
|
54428
55318
|
*/
|
|
54429
55319
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
54430
55320
|
/**
|
|
54431
|
-
*
|
|
55321
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
55322
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
55323
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
55324
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
55325
|
+
* @param {*} [options] Override http request option.
|
|
55326
|
+
* @throws {RequiredError}
|
|
55327
|
+
* @memberof PaymentSessionApiInterface
|
|
55328
|
+
*/
|
|
55329
|
+
initiateNexiOnDeviceSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
55330
|
+
/**
|
|
55331
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
54432
55332
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54433
55333
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54434
55334
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -54531,6 +55431,15 @@ export interface PaymentSessionApiInterface {
|
|
|
54531
55431
|
* @memberof PaymentSessionApiInterface
|
|
54532
55432
|
*/
|
|
54533
55433
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
55434
|
+
/**
|
|
55435
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
55436
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
55437
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
55438
|
+
* @param {*} [options] Override http request option.
|
|
55439
|
+
* @throws {RequiredError}
|
|
55440
|
+
* @memberof PaymentSessionApiInterface
|
|
55441
|
+
*/
|
|
55442
|
+
recordNexiOnDeviceResult(recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: AxiosRequestConfig): AxiosPromise<NexiOnDeviceResultViewDto>;
|
|
54534
55443
|
/**
|
|
54535
55444
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54536
55445
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -54558,6 +55467,25 @@ export interface PaymentSessionApiInterface {
|
|
|
54558
55467
|
* @memberof PaymentSessionApiInterface
|
|
54559
55468
|
*/
|
|
54560
55469
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
55470
|
+
/**
|
|
55471
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55472
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
55473
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55474
|
+
* @param {*} [options] Override http request option.
|
|
55475
|
+
* @throws {RequiredError}
|
|
55476
|
+
* @memberof PaymentSessionApiInterface
|
|
55477
|
+
*/
|
|
55478
|
+
refundNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
55479
|
+
/**
|
|
55480
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55481
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
55482
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55483
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
55484
|
+
* @param {*} [options] Override http request option.
|
|
55485
|
+
* @throws {RequiredError}
|
|
55486
|
+
* @memberof PaymentSessionApiInterface
|
|
55487
|
+
*/
|
|
55488
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
54561
55489
|
/**
|
|
54562
55490
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
54563
55491
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -54603,6 +55531,24 @@ export interface PaymentSessionApiInterface {
|
|
|
54603
55531
|
* @memberof PaymentSessionApiInterface
|
|
54604
55532
|
*/
|
|
54605
55533
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<NetsRevertResponseDto>;
|
|
55534
|
+
/**
|
|
55535
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55536
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
55537
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55538
|
+
* @param {*} [options] Override http request option.
|
|
55539
|
+
* @throws {RequiredError}
|
|
55540
|
+
* @memberof PaymentSessionApiInterface
|
|
55541
|
+
*/
|
|
55542
|
+
revertNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
55543
|
+
/**
|
|
55544
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55545
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
55546
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55547
|
+
* @param {*} [options] Override http request option.
|
|
55548
|
+
* @throws {RequiredError}
|
|
55549
|
+
* @memberof PaymentSessionApiInterface
|
|
55550
|
+
*/
|
|
55551
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
54606
55552
|
/**
|
|
54607
55553
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
54608
55554
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -54657,7 +55603,7 @@ export interface PaymentSessionApiInterface {
|
|
|
54657
55603
|
*/
|
|
54658
55604
|
export declare class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInterface {
|
|
54659
55605
|
/**
|
|
54660
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
55606
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
54661
55607
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
54662
55608
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
54663
55609
|
* @param {*} [options] Override http request option.
|
|
@@ -54728,7 +55674,17 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54728
55674
|
*/
|
|
54729
55675
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateNetsSessionResponseDto, any, {}>>;
|
|
54730
55676
|
/**
|
|
54731
|
-
*
|
|
55677
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
55678
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
55679
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
55680
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
55681
|
+
* @param {*} [options] Override http request option.
|
|
55682
|
+
* @throws {RequiredError}
|
|
55683
|
+
* @memberof PaymentSessionApi
|
|
55684
|
+
*/
|
|
55685
|
+
initiateNexiOnDeviceSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
55686
|
+
/**
|
|
55687
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
54732
55688
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54733
55689
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54734
55690
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -54831,6 +55787,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54831
55787
|
* @memberof PaymentSessionApi
|
|
54832
55788
|
*/
|
|
54833
55789
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
|
|
55790
|
+
/**
|
|
55791
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
55792
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
55793
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
55794
|
+
* @param {*} [options] Override http request option.
|
|
55795
|
+
* @throws {RequiredError}
|
|
55796
|
+
* @memberof PaymentSessionApi
|
|
55797
|
+
*/
|
|
55798
|
+
recordNexiOnDeviceResult(recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NexiOnDeviceResultViewDto, any, {}>>;
|
|
54834
55799
|
/**
|
|
54835
55800
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54836
55801
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -54858,6 +55823,25 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54858
55823
|
* @memberof PaymentSessionApi
|
|
54859
55824
|
*/
|
|
54860
55825
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
55826
|
+
/**
|
|
55827
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55828
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
55829
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55830
|
+
* @param {*} [options] Override http request option.
|
|
55831
|
+
* @throws {RequiredError}
|
|
55832
|
+
* @memberof PaymentSessionApi
|
|
55833
|
+
*/
|
|
55834
|
+
refundNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
55835
|
+
/**
|
|
55836
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55837
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
55838
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55839
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
55840
|
+
* @param {*} [options] Override http request option.
|
|
55841
|
+
* @throws {RequiredError}
|
|
55842
|
+
* @memberof PaymentSessionApi
|
|
55843
|
+
*/
|
|
55844
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54861
55845
|
/**
|
|
54862
55846
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
54863
55847
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -54903,6 +55887,24 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54903
55887
|
* @memberof PaymentSessionApi
|
|
54904
55888
|
*/
|
|
54905
55889
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetsRevertResponseDto, any, {}>>;
|
|
55890
|
+
/**
|
|
55891
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55892
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
55893
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55894
|
+
* @param {*} [options] Override http request option.
|
|
55895
|
+
* @throws {RequiredError}
|
|
55896
|
+
* @memberof PaymentSessionApi
|
|
55897
|
+
*/
|
|
55898
|
+
revertNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
55899
|
+
/**
|
|
55900
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55901
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
55902
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55903
|
+
* @param {*} [options] Override http request option.
|
|
55904
|
+
* @throws {RequiredError}
|
|
55905
|
+
* @memberof PaymentSessionApi
|
|
55906
|
+
*/
|
|
55907
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54906
55908
|
/**
|
|
54907
55909
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
54908
55910
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -56003,21 +57005,21 @@ export declare const ReceiptFooterApiAxiosParamCreator: (configuration?: Configu
|
|
|
56003
57005
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
56004
57006
|
* @summary Get the receipt footer config for a business + channel
|
|
56005
57007
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56006
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57008
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56007
57009
|
* @param {*} [options] Override http request option.
|
|
56008
57010
|
* @throws {RequiredError}
|
|
56009
57011
|
*/
|
|
56010
|
-
receiptFooterGetConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57012
|
+
receiptFooterGetConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56011
57013
|
/**
|
|
56012
57014
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
56013
57015
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56014
57016
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56015
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57017
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56016
57018
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56017
57019
|
* @param {*} [options] Override http request option.
|
|
56018
57020
|
* @throws {RequiredError}
|
|
56019
57021
|
*/
|
|
56020
|
-
receiptFooterUpsertConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57022
|
+
receiptFooterUpsertConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56021
57023
|
};
|
|
56022
57024
|
/**
|
|
56023
57025
|
* ReceiptFooterApi - functional programming interface
|
|
@@ -56028,21 +57030,21 @@ export declare const ReceiptFooterApiFp: (configuration?: Configuration) => {
|
|
|
56028
57030
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
56029
57031
|
* @summary Get the receipt footer config for a business + channel
|
|
56030
57032
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56031
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57033
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56032
57034
|
* @param {*} [options] Override http request option.
|
|
56033
57035
|
* @throws {RequiredError}
|
|
56034
57036
|
*/
|
|
56035
|
-
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>>;
|
|
57037
|
+
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>>;
|
|
56036
57038
|
/**
|
|
56037
57039
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
56038
57040
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56039
57041
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56040
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57042
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56041
57043
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56042
57044
|
* @param {*} [options] Override http request option.
|
|
56043
57045
|
* @throws {RequiredError}
|
|
56044
57046
|
*/
|
|
56045
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>>;
|
|
57047
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>>;
|
|
56046
57048
|
};
|
|
56047
57049
|
/**
|
|
56048
57050
|
* ReceiptFooterApi - factory interface
|
|
@@ -56053,21 +57055,21 @@ export declare const ReceiptFooterApiFactory: (configuration?: Configuration, ba
|
|
|
56053
57055
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
56054
57056
|
* @summary Get the receipt footer config for a business + channel
|
|
56055
57057
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56056
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57058
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56057
57059
|
* @param {*} [options] Override http request option.
|
|
56058
57060
|
* @throws {RequiredError}
|
|
56059
57061
|
*/
|
|
56060
|
-
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
57062
|
+
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56061
57063
|
/**
|
|
56062
57064
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
56063
57065
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56064
57066
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56065
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57067
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56066
57068
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56067
57069
|
* @param {*} [options] Override http request option.
|
|
56068
57070
|
* @throws {RequiredError}
|
|
56069
57071
|
*/
|
|
56070
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
57072
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56071
57073
|
};
|
|
56072
57074
|
/**
|
|
56073
57075
|
* ReceiptFooterApi - interface
|
|
@@ -56079,23 +57081,23 @@ export interface ReceiptFooterApiInterface {
|
|
|
56079
57081
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
56080
57082
|
* @summary Get the receipt footer config for a business + channel
|
|
56081
57083
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56082
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57084
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56083
57085
|
* @param {*} [options] Override http request option.
|
|
56084
57086
|
* @throws {RequiredError}
|
|
56085
57087
|
* @memberof ReceiptFooterApiInterface
|
|
56086
57088
|
*/
|
|
56087
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
57089
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56088
57090
|
/**
|
|
56089
57091
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
56090
57092
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56091
57093
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56092
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57094
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56093
57095
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56094
57096
|
* @param {*} [options] Override http request option.
|
|
56095
57097
|
* @throws {RequiredError}
|
|
56096
57098
|
* @memberof ReceiptFooterApiInterface
|
|
56097
57099
|
*/
|
|
56098
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
57100
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56099
57101
|
}
|
|
56100
57102
|
/**
|
|
56101
57103
|
* ReceiptFooterApi - object-oriented interface
|
|
@@ -56108,23 +57110,23 @@ export declare class ReceiptFooterApi extends BaseAPI implements ReceiptFooterAp
|
|
|
56108
57110
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
56109
57111
|
* @summary Get the receipt footer config for a business + channel
|
|
56110
57112
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56111
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57113
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56112
57114
|
* @param {*} [options] Override http request option.
|
|
56113
57115
|
* @throws {RequiredError}
|
|
56114
57116
|
* @memberof ReceiptFooterApi
|
|
56115
57117
|
*/
|
|
56116
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
57118
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
56117
57119
|
/**
|
|
56118
57120
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
56119
57121
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56120
57122
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56121
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
57123
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
56122
57124
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56123
57125
|
* @param {*} [options] Override http request option.
|
|
56124
57126
|
* @throws {RequiredError}
|
|
56125
57127
|
* @memberof ReceiptFooterApi
|
|
56126
57128
|
*/
|
|
56127
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
57129
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
56128
57130
|
}
|
|
56129
57131
|
/**
|
|
56130
57132
|
* RefundsApi - axios parameter creator
|