@munchi_oy/core 2.5.0 → 2.6.1
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 +725 -16
- 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 +895 -16
- package/package.json +13 -15
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2590,6 +2590,12 @@ export interface ChangeKioskDto {
|
|
|
2590
2590
|
* @memberof ChangeKioskDto
|
|
2591
2591
|
*/
|
|
2592
2592
|
'prefix'?: string;
|
|
2593
|
+
/**
|
|
2594
|
+
*
|
|
2595
|
+
* @type {KioskDeviceType}
|
|
2596
|
+
* @memberof ChangeKioskDto
|
|
2597
|
+
*/
|
|
2598
|
+
'deviceType'?: KioskDeviceType;
|
|
2593
2599
|
/**
|
|
2594
2600
|
*
|
|
2595
2601
|
* @type {Status}
|
|
@@ -3074,6 +3080,12 @@ export interface ClaimKioskDto {
|
|
|
3074
3080
|
* @memberof ClaimKioskDto
|
|
3075
3081
|
*/
|
|
3076
3082
|
'prefix'?: string;
|
|
3083
|
+
/**
|
|
3084
|
+
*
|
|
3085
|
+
* @type {KioskDeviceType}
|
|
3086
|
+
* @memberof ClaimKioskDto
|
|
3087
|
+
*/
|
|
3088
|
+
'deviceType'?: KioskDeviceType;
|
|
3077
3089
|
}
|
|
3078
3090
|
/**
|
|
3079
3091
|
*
|
|
@@ -5002,6 +5014,12 @@ export interface CreateSavedReportDto {
|
|
|
5002
5014
|
* @memberof CreateSavedReportDto
|
|
5003
5015
|
*/
|
|
5004
5016
|
'filters': SavedReportDtoFilters;
|
|
5017
|
+
/**
|
|
5018
|
+
*
|
|
5019
|
+
* @type {ReadyMadeReport}
|
|
5020
|
+
* @memberof CreateSavedReportDto
|
|
5021
|
+
*/
|
|
5022
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
5005
5023
|
/**
|
|
5006
5024
|
*
|
|
5007
5025
|
* @type {SavedReportVisibility}
|
|
@@ -9036,6 +9054,49 @@ export interface InitiateVivaSessionResponseDtoVivaIntent {
|
|
|
9036
9054
|
*/
|
|
9037
9055
|
'skipSurcharge': boolean;
|
|
9038
9056
|
}
|
|
9057
|
+
/**
|
|
9058
|
+
*
|
|
9059
|
+
* @export
|
|
9060
|
+
* @interface InitiateWorldlineA2aSessionDto
|
|
9061
|
+
*/
|
|
9062
|
+
export interface InitiateWorldlineA2aSessionDto {
|
|
9063
|
+
/**
|
|
9064
|
+
*
|
|
9065
|
+
* @type {CreateManualSessionDtoDevice}
|
|
9066
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9067
|
+
*/
|
|
9068
|
+
'device'?: CreateManualSessionDtoDevice | null;
|
|
9069
|
+
/**
|
|
9070
|
+
* The internal business ID.
|
|
9071
|
+
* @type {number}
|
|
9072
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9073
|
+
*/
|
|
9074
|
+
'businessId': number;
|
|
9075
|
+
/**
|
|
9076
|
+
* The POS order ID this payment session is for.
|
|
9077
|
+
* @type {string}
|
|
9078
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9079
|
+
*/
|
|
9080
|
+
'orderId': string;
|
|
9081
|
+
/**
|
|
9082
|
+
* Amount to charge in smallest currency unit (cents).
|
|
9083
|
+
* @type {number}
|
|
9084
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9085
|
+
*/
|
|
9086
|
+
'amount': number;
|
|
9087
|
+
/**
|
|
9088
|
+
* Optional tip amount in the smallest currency unit (cents).
|
|
9089
|
+
* @type {number}
|
|
9090
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9091
|
+
*/
|
|
9092
|
+
'tipAmount'?: number;
|
|
9093
|
+
/**
|
|
9094
|
+
*
|
|
9095
|
+
* @type {CreateManualSessionDtoSplitContext}
|
|
9096
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9097
|
+
*/
|
|
9098
|
+
'splitContext'?: CreateManualSessionDtoSplitContext;
|
|
9099
|
+
}
|
|
9039
9100
|
/**
|
|
9040
9101
|
*
|
|
9041
9102
|
* @export
|
|
@@ -11025,6 +11086,16 @@ export interface KdsStationDto {
|
|
|
11025
11086
|
*/
|
|
11026
11087
|
'categoryIds': Array<string>;
|
|
11027
11088
|
}
|
|
11089
|
+
/**
|
|
11090
|
+
*
|
|
11091
|
+
* @export
|
|
11092
|
+
* @enum {string}
|
|
11093
|
+
*/
|
|
11094
|
+
export declare const KioskDeviceType: {
|
|
11095
|
+
readonly Tablet: "TABLET";
|
|
11096
|
+
readonly KioskStand: "KIOSK_STAND";
|
|
11097
|
+
};
|
|
11098
|
+
export type KioskDeviceType = typeof KioskDeviceType[keyof typeof KioskDeviceType];
|
|
11028
11099
|
/**
|
|
11029
11100
|
*
|
|
11030
11101
|
* @export
|
|
@@ -24203,6 +24274,12 @@ export interface PublicSavedReportDto {
|
|
|
24203
24274
|
* @memberof PublicSavedReportDto
|
|
24204
24275
|
*/
|
|
24205
24276
|
'filters': SavedReportDtoFilters;
|
|
24277
|
+
/**
|
|
24278
|
+
*
|
|
24279
|
+
* @type {ReadyMadeReport}
|
|
24280
|
+
* @memberof PublicSavedReportDto
|
|
24281
|
+
*/
|
|
24282
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
24206
24283
|
/**
|
|
24207
24284
|
* The store whose data the report reads, by orderingBusinessId; null for an organisation\'s
|
|
24208
24285
|
* @type {number}
|
|
@@ -24760,6 +24837,128 @@ export declare const RecordManualStatus: {
|
|
|
24760
24837
|
readonly Failed: "FAILED";
|
|
24761
24838
|
};
|
|
24762
24839
|
export type RecordManualStatus = typeof RecordManualStatus[keyof typeof RecordManualStatus];
|
|
24840
|
+
/**
|
|
24841
|
+
*
|
|
24842
|
+
* @export
|
|
24843
|
+
* @interface RecordWorldlineA2aResultDto
|
|
24844
|
+
*/
|
|
24845
|
+
export interface RecordWorldlineA2aResultDto {
|
|
24846
|
+
/**
|
|
24847
|
+
* The sessionId the start, refund or revert route answered, which the payment app was given as its reference.
|
|
24848
|
+
* @type {string}
|
|
24849
|
+
* @memberof RecordWorldlineA2aResultDto
|
|
24850
|
+
*/
|
|
24851
|
+
'sessionId': string;
|
|
24852
|
+
/**
|
|
24853
|
+
*
|
|
24854
|
+
* @type {RecordWorldlineA2aResultDtoAnswer}
|
|
24855
|
+
* @memberof RecordWorldlineA2aResultDto
|
|
24856
|
+
*/
|
|
24857
|
+
'answer': RecordWorldlineA2aResultDtoAnswer;
|
|
24858
|
+
}
|
|
24859
|
+
/**
|
|
24860
|
+
* The payment app\'s answer (WPI_RESPONSE), parsed from its JSON.
|
|
24861
|
+
* @export
|
|
24862
|
+
* @interface RecordWorldlineA2aResultDtoAnswer
|
|
24863
|
+
*/
|
|
24864
|
+
export interface RecordWorldlineA2aResultDtoAnswer {
|
|
24865
|
+
/**
|
|
24866
|
+
*
|
|
24867
|
+
* @type {WorldlineAppResult}
|
|
24868
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24869
|
+
*/
|
|
24870
|
+
'result': WorldlineAppResult;
|
|
24871
|
+
/**
|
|
24872
|
+
* Why the transaction failed, as the payment app names it (WPI_ERR_COND_…). WPI_ERR_COND_USER_CANCEL ends the session CANCELLED; any other failure ends it FAILED. Absent on an approval.
|
|
24873
|
+
* @type {string}
|
|
24874
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24875
|
+
*/
|
|
24876
|
+
'errorCondition'?: string;
|
|
24877
|
+
/**
|
|
24878
|
+
* The payment app\'s free-text remark on the transaction, if any.
|
|
24879
|
+
* @type {string}
|
|
24880
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24881
|
+
*/
|
|
24882
|
+
'remark'?: string;
|
|
24883
|
+
/**
|
|
24884
|
+
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s answer, which is refused when it is not the session\'s. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
|
|
24885
|
+
* @type {string}
|
|
24886
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24887
|
+
*/
|
|
24888
|
+
'reference'?: string;
|
|
24889
|
+
/**
|
|
24890
|
+
* When the payment app ran 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.
|
|
24891
|
+
* @type {string}
|
|
24892
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24893
|
+
*/
|
|
24894
|
+
'timestamp'?: string;
|
|
24895
|
+
/**
|
|
24896
|
+
* The currency charged, ISO 4217 alpha code. Required on an approval, and must be the session\'s.
|
|
24897
|
+
* @type {string}
|
|
24898
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24899
|
+
*/
|
|
24900
|
+
'currency'?: string;
|
|
24901
|
+
/**
|
|
24902
|
+
* What the card was charged, in the smallest currency unit (cents), every tip included. Required on a sale\'s or a refund\'s approval: a sale\'s must be the session\'s amount plus its tip, or that plus the tipAmount the cardholder added on the payment app; a refund\'s must be the refund\'s amount. A sale\'s or a refund\'s approval that does not match is refused, kept on the session and alerted to ops. Not checked on a revert, which cancels the whole sale.
|
|
24903
|
+
* @type {number}
|
|
24904
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24905
|
+
*/
|
|
24906
|
+
'authorizedAmount'?: number;
|
|
24907
|
+
/**
|
|
24908
|
+
* The tip the cardholder entered on the payment app, or the one the request sent, in the smallest currency unit (cents). A tip added on the payment app is recorded with the session\'s tip, as a fee of the payment event.
|
|
24909
|
+
* @type {number}
|
|
24910
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24911
|
+
*/
|
|
24912
|
+
'tipAmount'?: number;
|
|
24913
|
+
/**
|
|
24914
|
+
* The card brand.
|
|
24915
|
+
* @type {string}
|
|
24916
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24917
|
+
*/
|
|
24918
|
+
'brandName'?: string;
|
|
24919
|
+
/**
|
|
24920
|
+
* The card application\'s label.
|
|
24921
|
+
* @type {string}
|
|
24922
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24923
|
+
*/
|
|
24924
|
+
'applicationLabel'?: string;
|
|
24925
|
+
/**
|
|
24926
|
+
* The card application\'s identifier (AID).
|
|
24927
|
+
* @type {string}
|
|
24928
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24929
|
+
*/
|
|
24930
|
+
'applicationIdentifier'?: string;
|
|
24931
|
+
/**
|
|
24932
|
+
* The payment app\'s own id of the transaction. 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 cancelled sale\'s id and must be the sale\'s; it is kept in the stored answer only.
|
|
24933
|
+
* @type {string}
|
|
24934
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24935
|
+
*/
|
|
24936
|
+
'paymentSolutionReference'?: string;
|
|
24937
|
+
/**
|
|
24938
|
+
* The issuer\'s authorisation code.
|
|
24939
|
+
* @type {string}
|
|
24940
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24941
|
+
*/
|
|
24942
|
+
'authorizationCode'?: string;
|
|
24943
|
+
/**
|
|
24944
|
+
* The merchant id the payment app charged under. Kept, not checked.
|
|
24945
|
+
* @type {string}
|
|
24946
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24947
|
+
*/
|
|
24948
|
+
'merchantIdentifier'?: string;
|
|
24949
|
+
/**
|
|
24950
|
+
* The terminal id the payment app charged on. Kept, not checked.
|
|
24951
|
+
* @type {string}
|
|
24952
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24953
|
+
*/
|
|
24954
|
+
'terminalIdentifier'?: string;
|
|
24955
|
+
/**
|
|
24956
|
+
* The card number, masked by the payment app: at most the first 6 digits, then * or X, then the last 4. A full card number is refused.
|
|
24957
|
+
* @type {string}
|
|
24958
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
24959
|
+
*/
|
|
24960
|
+
'pan'?: string;
|
|
24961
|
+
}
|
|
24763
24962
|
/**
|
|
24764
24963
|
*
|
|
24765
24964
|
* @export
|
|
@@ -26451,7 +26650,7 @@ export interface RestoreLoyaltyRedemptionDto {
|
|
|
26451
26650
|
*/
|
|
26452
26651
|
'businessId': number;
|
|
26453
26652
|
/**
|
|
26454
|
-
* The id of the POS or kiosk order that carries the redemption
|
|
26653
|
+
* The id of the POS or kiosk order, or the code of the website order (its externalId), that carries the redemption
|
|
26455
26654
|
* @type {string}
|
|
26456
26655
|
* @memberof RestoreLoyaltyRedemptionDto
|
|
26457
26656
|
*/
|
|
@@ -29032,6 +29231,12 @@ export interface SavedReportDto {
|
|
|
29032
29231
|
* @memberof SavedReportDto
|
|
29033
29232
|
*/
|
|
29034
29233
|
'filters': SavedReportDtoFilters;
|
|
29234
|
+
/**
|
|
29235
|
+
*
|
|
29236
|
+
* @type {ReadyMadeReport}
|
|
29237
|
+
* @memberof SavedReportDto
|
|
29238
|
+
*/
|
|
29239
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
29035
29240
|
/**
|
|
29036
29241
|
* The report\'s id
|
|
29037
29242
|
* @type {string}
|
|
@@ -34549,6 +34754,12 @@ export interface UpdateSavedReportDto {
|
|
|
34549
34754
|
* @memberof UpdateSavedReportDto
|
|
34550
34755
|
*/
|
|
34551
34756
|
'filters': SavedReportDtoFilters;
|
|
34757
|
+
/**
|
|
34758
|
+
*
|
|
34759
|
+
* @type {ReadyMadeReport}
|
|
34760
|
+
* @memberof UpdateSavedReportDto
|
|
34761
|
+
*/
|
|
34762
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
34552
34763
|
/**
|
|
34553
34764
|
* The version the report was read at; answered 409 when someone saved it since
|
|
34554
34765
|
* @type {number}
|
|
@@ -35777,6 +35988,12 @@ export interface VenueKioskDto {
|
|
|
35777
35988
|
* @memberof VenueKioskDto
|
|
35778
35989
|
*/
|
|
35779
35990
|
'hardwareId': string;
|
|
35991
|
+
/**
|
|
35992
|
+
*
|
|
35993
|
+
* @type {DeviceType}
|
|
35994
|
+
* @memberof VenueKioskDto
|
|
35995
|
+
*/
|
|
35996
|
+
'deviceType': DeviceType;
|
|
35780
35997
|
/**
|
|
35781
35998
|
*
|
|
35782
35999
|
* @type {Status}
|
|
@@ -38027,6 +38244,212 @@ export interface WoltSwitchesTaskDto {
|
|
|
38027
38244
|
*/
|
|
38028
38245
|
'orderingBusinessId': string;
|
|
38029
38246
|
}
|
|
38247
|
+
/**
|
|
38248
|
+
*
|
|
38249
|
+
* @export
|
|
38250
|
+
* @interface WorldlineA2aResultViewDto
|
|
38251
|
+
*/
|
|
38252
|
+
export interface WorldlineA2aResultViewDto {
|
|
38253
|
+
/**
|
|
38254
|
+
* Opaque client token.
|
|
38255
|
+
* @type {string}
|
|
38256
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38257
|
+
*/
|
|
38258
|
+
'clientToken': string;
|
|
38259
|
+
/**
|
|
38260
|
+
* Internal session ID.
|
|
38261
|
+
* @type {string}
|
|
38262
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38263
|
+
*/
|
|
38264
|
+
'sessionId': string;
|
|
38265
|
+
/**
|
|
38266
|
+
* Viva transaction ID set after webhook completes.
|
|
38267
|
+
* @type {string}
|
|
38268
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38269
|
+
*/
|
|
38270
|
+
'providerTransactionId'?: string;
|
|
38271
|
+
/**
|
|
38272
|
+
*
|
|
38273
|
+
* @type {PaymentSessionStatus}
|
|
38274
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38275
|
+
*/
|
|
38276
|
+
'status': PaymentSessionStatus;
|
|
38277
|
+
/**
|
|
38278
|
+
* Amount in cents.
|
|
38279
|
+
* @type {number}
|
|
38280
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38281
|
+
*/
|
|
38282
|
+
'amount': number;
|
|
38283
|
+
/**
|
|
38284
|
+
* Currency.
|
|
38285
|
+
* @type {string}
|
|
38286
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38287
|
+
*/
|
|
38288
|
+
'currency': string;
|
|
38289
|
+
/**
|
|
38290
|
+
* Tip amount (cents).
|
|
38291
|
+
* @type {number}
|
|
38292
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38293
|
+
*/
|
|
38294
|
+
'tipAmount': number;
|
|
38295
|
+
/**
|
|
38296
|
+
* Surcharge amount (cents).
|
|
38297
|
+
* @type {number}
|
|
38298
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38299
|
+
*/
|
|
38300
|
+
'surchargeAmount': number;
|
|
38301
|
+
/**
|
|
38302
|
+
* Error code if failed.
|
|
38303
|
+
* @type {string}
|
|
38304
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38305
|
+
*/
|
|
38306
|
+
'errorCode'?: string;
|
|
38307
|
+
/**
|
|
38308
|
+
* Error message if failed.
|
|
38309
|
+
* @type {string}
|
|
38310
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38311
|
+
*/
|
|
38312
|
+
'errorMessage'?: string;
|
|
38313
|
+
/**
|
|
38314
|
+
* When the session was started (ISO 8601, UTC).
|
|
38315
|
+
* @type {string}
|
|
38316
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38317
|
+
*/
|
|
38318
|
+
'createdAt': string;
|
|
38319
|
+
/**
|
|
38320
|
+
* When the session last changed (ISO 8601, UTC).
|
|
38321
|
+
* @type {string}
|
|
38322
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38323
|
+
*/
|
|
38324
|
+
'updatedAt': string;
|
|
38325
|
+
/**
|
|
38326
|
+
* When the sale was written to the order and closed (ISO 8601, UTC); null while it is not.
|
|
38327
|
+
* @type {string}
|
|
38328
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38329
|
+
*/
|
|
38330
|
+
'closedAt'?: string;
|
|
38331
|
+
/**
|
|
38332
|
+
*
|
|
38333
|
+
* @type {WorldlineA2aResultViewDtoTransaction}
|
|
38334
|
+
* @memberof WorldlineA2aResultViewDto
|
|
38335
|
+
*/
|
|
38336
|
+
'transaction'?: WorldlineA2aResultViewDtoTransaction;
|
|
38337
|
+
}
|
|
38338
|
+
/**
|
|
38339
|
+
* 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 details. 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.
|
|
38340
|
+
* @export
|
|
38341
|
+
* @interface WorldlineA2aResultViewDtoTransaction
|
|
38342
|
+
*/
|
|
38343
|
+
export interface WorldlineA2aResultViewDtoTransaction {
|
|
38344
|
+
/**
|
|
38345
|
+
* Id of this payment: the payment provider\'s transaction id for a card payment, or an id the till made
|
|
38346
|
+
* @type {string}
|
|
38347
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38348
|
+
*/
|
|
38349
|
+
'id': string;
|
|
38350
|
+
/**
|
|
38351
|
+
* 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
|
|
38352
|
+
* @type {string}
|
|
38353
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38354
|
+
*/
|
|
38355
|
+
'referenceId': string | null;
|
|
38356
|
+
/**
|
|
38357
|
+
*
|
|
38358
|
+
* @type {PaymentProvider}
|
|
38359
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38360
|
+
*/
|
|
38361
|
+
'provider': PaymentProvider;
|
|
38362
|
+
/**
|
|
38363
|
+
*
|
|
38364
|
+
* @type {PaymentMethod}
|
|
38365
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38366
|
+
*/
|
|
38367
|
+
'type': PaymentMethod;
|
|
38368
|
+
/**
|
|
38369
|
+
*
|
|
38370
|
+
* @type {PaymentOutcomeStatus}
|
|
38371
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38372
|
+
*/
|
|
38373
|
+
'paymentOutcomeStatus'?: PaymentOutcomeStatus;
|
|
38374
|
+
/**
|
|
38375
|
+
* Amount paid in cents
|
|
38376
|
+
* @type {number}
|
|
38377
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38378
|
+
*/
|
|
38379
|
+
'amount': number;
|
|
38380
|
+
/**
|
|
38381
|
+
* Difference from cash rounding in cents
|
|
38382
|
+
* @type {number}
|
|
38383
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38384
|
+
*/
|
|
38385
|
+
'roundingDifference': number;
|
|
38386
|
+
/**
|
|
38387
|
+
* Raw data from payment provider, as it sent it
|
|
38388
|
+
* @type {object}
|
|
38389
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38390
|
+
*/
|
|
38391
|
+
'rawData': object;
|
|
38392
|
+
/**
|
|
38393
|
+
* When the payment was taken
|
|
38394
|
+
* @type {string}
|
|
38395
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38396
|
+
*/
|
|
38397
|
+
'createdAt': string;
|
|
38398
|
+
/**
|
|
38399
|
+
*
|
|
38400
|
+
* @type {TransactionDtoCardDetail}
|
|
38401
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38402
|
+
*/
|
|
38403
|
+
'cardDetail': TransactionDtoCardDetail | null;
|
|
38404
|
+
/**
|
|
38405
|
+
* 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.
|
|
38406
|
+
* @type {number}
|
|
38407
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38408
|
+
*/
|
|
38409
|
+
'voucherForfeitedAmount'?: number | null;
|
|
38410
|
+
/**
|
|
38411
|
+
* The specific line items this transaction paid for. If null or empty, it was a pooled payment against the total bill.
|
|
38412
|
+
* @type {Array<string>}
|
|
38413
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38414
|
+
*/
|
|
38415
|
+
'lineItemIds'?: Array<string> | null;
|
|
38416
|
+
/**
|
|
38417
|
+
* The specific split part this transaction paid for. If null, it was not a payment for a split part.
|
|
38418
|
+
* @type {string}
|
|
38419
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38420
|
+
*/
|
|
38421
|
+
'splitPartId'?: string | null;
|
|
38422
|
+
/**
|
|
38423
|
+
* Detailed settlement allocations for this transaction. Use this for accurate refund and reconciliation logic, especially when one line item is split across multiple payments.
|
|
38424
|
+
* @type {Array<TransactionItemAllocationDto>}
|
|
38425
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38426
|
+
*/
|
|
38427
|
+
'itemAllocations'?: Array<TransactionItemAllocationDto> | null;
|
|
38428
|
+
/**
|
|
38429
|
+
*
|
|
38430
|
+
* @type {TransactionDtoDevice}
|
|
38431
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38432
|
+
*/
|
|
38433
|
+
'device'?: TransactionDtoDevice | null;
|
|
38434
|
+
/**
|
|
38435
|
+
*
|
|
38436
|
+
* @type {TransactionDtoCapturedBy}
|
|
38437
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38438
|
+
*/
|
|
38439
|
+
'capturedBy'?: TransactionDtoCapturedBy | null;
|
|
38440
|
+
/**
|
|
38441
|
+
* Indicates whether this transaction was processed as a pre-authorization.
|
|
38442
|
+
* @type {string}
|
|
38443
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38444
|
+
*/
|
|
38445
|
+
'label': string | null;
|
|
38446
|
+
/**
|
|
38447
|
+
*
|
|
38448
|
+
* @type {TransactionDtoFees}
|
|
38449
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
38450
|
+
*/
|
|
38451
|
+
'fees'?: TransactionDtoFees | null;
|
|
38452
|
+
}
|
|
38030
38453
|
/**
|
|
38031
38454
|
*
|
|
38032
38455
|
* @export
|
|
@@ -38052,6 +38475,119 @@ export interface WorldlineAmountsRequestDto {
|
|
|
38052
38475
|
*/
|
|
38053
38476
|
'tip'?: number;
|
|
38054
38477
|
}
|
|
38478
|
+
/**
|
|
38479
|
+
*
|
|
38480
|
+
* @export
|
|
38481
|
+
* @interface WorldlineAppAnswerDto
|
|
38482
|
+
*/
|
|
38483
|
+
export interface WorldlineAppAnswerDto {
|
|
38484
|
+
/**
|
|
38485
|
+
*
|
|
38486
|
+
* @type {WorldlineAppResult}
|
|
38487
|
+
* @memberof WorldlineAppAnswerDto
|
|
38488
|
+
*/
|
|
38489
|
+
'result': WorldlineAppResult;
|
|
38490
|
+
/**
|
|
38491
|
+
* Why the transaction failed, as the payment app names it (WPI_ERR_COND_…). WPI_ERR_COND_USER_CANCEL ends the session CANCELLED; any other failure ends it FAILED. Absent on an approval.
|
|
38492
|
+
* @type {string}
|
|
38493
|
+
* @memberof WorldlineAppAnswerDto
|
|
38494
|
+
*/
|
|
38495
|
+
'errorCondition'?: string;
|
|
38496
|
+
/**
|
|
38497
|
+
* The payment app\'s free-text remark on the transaction, if any.
|
|
38498
|
+
* @type {string}
|
|
38499
|
+
* @memberof WorldlineAppAnswerDto
|
|
38500
|
+
*/
|
|
38501
|
+
'remark'?: string;
|
|
38502
|
+
/**
|
|
38503
|
+
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s answer, which is refused when it is not the session\'s. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
|
|
38504
|
+
* @type {string}
|
|
38505
|
+
* @memberof WorldlineAppAnswerDto
|
|
38506
|
+
*/
|
|
38507
|
+
'reference'?: string;
|
|
38508
|
+
/**
|
|
38509
|
+
* When the payment app ran 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.
|
|
38510
|
+
* @type {string}
|
|
38511
|
+
* @memberof WorldlineAppAnswerDto
|
|
38512
|
+
*/
|
|
38513
|
+
'timestamp'?: string;
|
|
38514
|
+
/**
|
|
38515
|
+
* The currency charged, ISO 4217 alpha code. Required on an approval, and must be the session\'s.
|
|
38516
|
+
* @type {string}
|
|
38517
|
+
* @memberof WorldlineAppAnswerDto
|
|
38518
|
+
*/
|
|
38519
|
+
'currency'?: string;
|
|
38520
|
+
/**
|
|
38521
|
+
* What the card was charged, in the smallest currency unit (cents), every tip included. Required on a sale\'s or a refund\'s approval: a sale\'s must be the session\'s amount plus its tip, or that plus the tipAmount the cardholder added on the payment app; a refund\'s must be the refund\'s amount. A sale\'s or a refund\'s approval that does not match is refused, kept on the session and alerted to ops. Not checked on a revert, which cancels the whole sale.
|
|
38522
|
+
* @type {number}
|
|
38523
|
+
* @memberof WorldlineAppAnswerDto
|
|
38524
|
+
*/
|
|
38525
|
+
'authorizedAmount'?: number;
|
|
38526
|
+
/**
|
|
38527
|
+
* The tip the cardholder entered on the payment app, or the one the request sent, in the smallest currency unit (cents). A tip added on the payment app is recorded with the session\'s tip, as a fee of the payment event.
|
|
38528
|
+
* @type {number}
|
|
38529
|
+
* @memberof WorldlineAppAnswerDto
|
|
38530
|
+
*/
|
|
38531
|
+
'tipAmount'?: number;
|
|
38532
|
+
/**
|
|
38533
|
+
* The card brand.
|
|
38534
|
+
* @type {string}
|
|
38535
|
+
* @memberof WorldlineAppAnswerDto
|
|
38536
|
+
*/
|
|
38537
|
+
'brandName'?: string;
|
|
38538
|
+
/**
|
|
38539
|
+
* The card application\'s label.
|
|
38540
|
+
* @type {string}
|
|
38541
|
+
* @memberof WorldlineAppAnswerDto
|
|
38542
|
+
*/
|
|
38543
|
+
'applicationLabel'?: string;
|
|
38544
|
+
/**
|
|
38545
|
+
* The card application\'s identifier (AID).
|
|
38546
|
+
* @type {string}
|
|
38547
|
+
* @memberof WorldlineAppAnswerDto
|
|
38548
|
+
*/
|
|
38549
|
+
'applicationIdentifier'?: string;
|
|
38550
|
+
/**
|
|
38551
|
+
* The payment app\'s own id of the transaction. 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 cancelled sale\'s id and must be the sale\'s; it is kept in the stored answer only.
|
|
38552
|
+
* @type {string}
|
|
38553
|
+
* @memberof WorldlineAppAnswerDto
|
|
38554
|
+
*/
|
|
38555
|
+
'paymentSolutionReference'?: string;
|
|
38556
|
+
/**
|
|
38557
|
+
* The issuer\'s authorisation code.
|
|
38558
|
+
* @type {string}
|
|
38559
|
+
* @memberof WorldlineAppAnswerDto
|
|
38560
|
+
*/
|
|
38561
|
+
'authorizationCode'?: string;
|
|
38562
|
+
/**
|
|
38563
|
+
* The merchant id the payment app charged under. Kept, not checked.
|
|
38564
|
+
* @type {string}
|
|
38565
|
+
* @memberof WorldlineAppAnswerDto
|
|
38566
|
+
*/
|
|
38567
|
+
'merchantIdentifier'?: string;
|
|
38568
|
+
/**
|
|
38569
|
+
* The terminal id the payment app charged on. Kept, not checked.
|
|
38570
|
+
* @type {string}
|
|
38571
|
+
* @memberof WorldlineAppAnswerDto
|
|
38572
|
+
*/
|
|
38573
|
+
'terminalIdentifier'?: string;
|
|
38574
|
+
/**
|
|
38575
|
+
* The card number, masked by the payment app: at most the first 6 digits, then * or X, then the last 4. A full card number is refused.
|
|
38576
|
+
* @type {string}
|
|
38577
|
+
* @memberof WorldlineAppAnswerDto
|
|
38578
|
+
*/
|
|
38579
|
+
'pan'?: string;
|
|
38580
|
+
}
|
|
38581
|
+
/**
|
|
38582
|
+
*
|
|
38583
|
+
* @export
|
|
38584
|
+
* @enum {string}
|
|
38585
|
+
*/
|
|
38586
|
+
export declare const WorldlineAppResult: {
|
|
38587
|
+
readonly Success: "WPI_RESULT_SUCCESS";
|
|
38588
|
+
readonly Failure: "WPI_RESULT_FAILURE";
|
|
38589
|
+
};
|
|
38590
|
+
export type WorldlineAppResult = typeof WorldlineAppResult[keyof typeof WorldlineAppResult];
|
|
38055
38591
|
/**
|
|
38056
38592
|
*
|
|
38057
38593
|
* @export
|
|
@@ -45229,7 +45765,7 @@ export declare class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
|
45229
45765
|
*/
|
|
45230
45766
|
export declare const LoyaltyCommerceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
45231
45767
|
/**
|
|
45232
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45768
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45233
45769
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
45234
45770
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
45235
45771
|
* @param {*} [options] Override http request option.
|
|
@@ -45243,7 +45779,7 @@ export declare const LoyaltyCommerceApiAxiosParamCreator: (configuration?: Confi
|
|
|
45243
45779
|
*/
|
|
45244
45780
|
export declare const LoyaltyCommerceApiFp: (configuration?: Configuration) => {
|
|
45245
45781
|
/**
|
|
45246
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45782
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45247
45783
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
45248
45784
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
45249
45785
|
* @param {*} [options] Override http request option.
|
|
@@ -45257,7 +45793,7 @@ export declare const LoyaltyCommerceApiFp: (configuration?: Configuration) => {
|
|
|
45257
45793
|
*/
|
|
45258
45794
|
export declare const LoyaltyCommerceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
45259
45795
|
/**
|
|
45260
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45796
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45261
45797
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
45262
45798
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
45263
45799
|
* @param {*} [options] Override http request option.
|
|
@@ -45272,7 +45808,7 @@ export declare const LoyaltyCommerceApiFactory: (configuration?: Configuration,
|
|
|
45272
45808
|
*/
|
|
45273
45809
|
export interface LoyaltyCommerceApiInterface {
|
|
45274
45810
|
/**
|
|
45275
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45811
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45276
45812
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
45277
45813
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
45278
45814
|
* @param {*} [options] Override http request option.
|
|
@@ -45289,7 +45825,7 @@ export interface LoyaltyCommerceApiInterface {
|
|
|
45289
45825
|
*/
|
|
45290
45826
|
export declare class LoyaltyCommerceApi extends BaseAPI implements LoyaltyCommerceApiInterface {
|
|
45291
45827
|
/**
|
|
45292
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45828
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
45293
45829
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
45294
45830
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
45295
45831
|
* @param {*} [options] Override http request option.
|
|
@@ -49070,6 +49606,15 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
49070
49606
|
* @throws {RequiredError}
|
|
49071
49607
|
*/
|
|
49072
49608
|
initiateVivaSession: (initiateVivaSessionDto: InitiateVivaSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49609
|
+
/**
|
|
49610
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
49611
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
49612
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
49613
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
49614
|
+
* @param {*} [options] Override http request option.
|
|
49615
|
+
* @throws {RequiredError}
|
|
49616
|
+
*/
|
|
49617
|
+
initiateWorldlineA2aSession: (initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49073
49618
|
/**
|
|
49074
49619
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
49075
49620
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -49128,6 +49673,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
49128
49673
|
* @throws {RequiredError}
|
|
49129
49674
|
*/
|
|
49130
49675
|
recordManualPayment: (createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49676
|
+
/**
|
|
49677
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; 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.
|
|
49678
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
49679
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
49680
|
+
* @param {*} [options] Override http request option.
|
|
49681
|
+
* @throws {RequiredError}
|
|
49682
|
+
*/
|
|
49683
|
+
recordWorldlineA2aResult: (recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49131
49684
|
/**
|
|
49132
49685
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
49133
49686
|
* @summary Refund an Epassi payment in full
|
|
@@ -49152,6 +49705,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
49152
49705
|
* @throws {RequiredError}
|
|
49153
49706
|
*/
|
|
49154
49707
|
refundVivaSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49708
|
+
/**
|
|
49709
|
+
* 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. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
49710
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
49711
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
49712
|
+
* @param {*} [options] Override http request option.
|
|
49713
|
+
* @throws {RequiredError}
|
|
49714
|
+
*/
|
|
49715
|
+
refundWorldlineA2aSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49155
49716
|
/**
|
|
49156
49717
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
49157
49718
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -49184,6 +49745,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
49184
49745
|
* @throws {RequiredError}
|
|
49185
49746
|
*/
|
|
49186
49747
|
revertVivaSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49748
|
+
/**
|
|
49749
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
49750
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
49751
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
49752
|
+
* @param {*} [options] Override http request option.
|
|
49753
|
+
* @throws {RequiredError}
|
|
49754
|
+
*/
|
|
49755
|
+
revertWorldlineA2aSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49187
49756
|
/**
|
|
49188
49757
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
49189
49758
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -49287,6 +49856,15 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
49287
49856
|
* @throws {RequiredError}
|
|
49288
49857
|
*/
|
|
49289
49858
|
initiateVivaSession(initiateVivaSessionDto: InitiateVivaSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateVivaSessionResponseDto>>;
|
|
49859
|
+
/**
|
|
49860
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
49861
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
49862
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
49863
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
49864
|
+
* @param {*} [options] Override http request option.
|
|
49865
|
+
* @throws {RequiredError}
|
|
49866
|
+
*/
|
|
49867
|
+
initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
49290
49868
|
/**
|
|
49291
49869
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
49292
49870
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -49345,6 +49923,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
49345
49923
|
* @throws {RequiredError}
|
|
49346
49924
|
*/
|
|
49347
49925
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
|
|
49926
|
+
/**
|
|
49927
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; 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.
|
|
49928
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
49929
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
49930
|
+
* @param {*} [options] Override http request option.
|
|
49931
|
+
* @throws {RequiredError}
|
|
49932
|
+
*/
|
|
49933
|
+
recordWorldlineA2aResult(recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorldlineA2aResultViewDto>>;
|
|
49348
49934
|
/**
|
|
49349
49935
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
49350
49936
|
* @summary Refund an Epassi payment in full
|
|
@@ -49369,6 +49955,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
49369
49955
|
* @throws {RequiredError}
|
|
49370
49956
|
*/
|
|
49371
49957
|
refundVivaSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
49958
|
+
/**
|
|
49959
|
+
* 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. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
49960
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
49961
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
49962
|
+
* @param {*} [options] Override http request option.
|
|
49963
|
+
* @throws {RequiredError}
|
|
49964
|
+
*/
|
|
49965
|
+
refundWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
49372
49966
|
/**
|
|
49373
49967
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
49374
49968
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -49401,6 +49995,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
49401
49995
|
* @throws {RequiredError}
|
|
49402
49996
|
*/
|
|
49403
49997
|
revertVivaSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
49998
|
+
/**
|
|
49999
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
50000
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
50001
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
50002
|
+
* @param {*} [options] Override http request option.
|
|
50003
|
+
* @throws {RequiredError}
|
|
50004
|
+
*/
|
|
50005
|
+
revertWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
49404
50006
|
/**
|
|
49405
50007
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
49406
50008
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -49504,6 +50106,15 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
49504
50106
|
* @throws {RequiredError}
|
|
49505
50107
|
*/
|
|
49506
50108
|
initiateVivaSession(initiateVivaSessionDto: InitiateVivaSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<InitiateVivaSessionResponseDto>;
|
|
50109
|
+
/**
|
|
50110
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
50111
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
50112
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
50113
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
50114
|
+
* @param {*} [options] Override http request option.
|
|
50115
|
+
* @throws {RequiredError}
|
|
50116
|
+
*/
|
|
50117
|
+
initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
49507
50118
|
/**
|
|
49508
50119
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
49509
50120
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -49562,6 +50173,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
49562
50173
|
* @throws {RequiredError}
|
|
49563
50174
|
*/
|
|
49564
50175
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
|
|
50176
|
+
/**
|
|
50177
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; 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.
|
|
50178
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
50179
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
50180
|
+
* @param {*} [options] Override http request option.
|
|
50181
|
+
* @throws {RequiredError}
|
|
50182
|
+
*/
|
|
50183
|
+
recordWorldlineA2aResult(recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: any): AxiosPromise<WorldlineA2aResultViewDto>;
|
|
49565
50184
|
/**
|
|
49566
50185
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
49567
50186
|
* @summary Refund an Epassi payment in full
|
|
@@ -49586,6 +50205,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
49586
50205
|
* @throws {RequiredError}
|
|
49587
50206
|
*/
|
|
49588
50207
|
refundVivaSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
50208
|
+
/**
|
|
50209
|
+
* 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. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
50210
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
50211
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
50212
|
+
* @param {*} [options] Override http request option.
|
|
50213
|
+
* @throws {RequiredError}
|
|
50214
|
+
*/
|
|
50215
|
+
refundWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
49589
50216
|
/**
|
|
49590
50217
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
49591
50218
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -49618,6 +50245,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
49618
50245
|
* @throws {RequiredError}
|
|
49619
50246
|
*/
|
|
49620
50247
|
revertVivaSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
50248
|
+
/**
|
|
50249
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
50250
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
50251
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
50252
|
+
* @param {*} [options] Override http request option.
|
|
50253
|
+
* @throws {RequiredError}
|
|
50254
|
+
*/
|
|
50255
|
+
revertWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
49621
50256
|
/**
|
|
49622
50257
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
49623
50258
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -49731,6 +50366,16 @@ export interface PaymentSessionApiInterface {
|
|
|
49731
50366
|
* @memberof PaymentSessionApiInterface
|
|
49732
50367
|
*/
|
|
49733
50368
|
initiateVivaSession(initiateVivaSessionDto: InitiateVivaSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateVivaSessionResponseDto>;
|
|
50369
|
+
/**
|
|
50370
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
50371
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
50372
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
50373
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
50374
|
+
* @param {*} [options] Override http request option.
|
|
50375
|
+
* @throws {RequiredError}
|
|
50376
|
+
* @memberof PaymentSessionApiInterface
|
|
50377
|
+
*/
|
|
50378
|
+
initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
49734
50379
|
/**
|
|
49735
50380
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
49736
50381
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -49796,6 +50441,15 @@ export interface PaymentSessionApiInterface {
|
|
|
49796
50441
|
* @memberof PaymentSessionApiInterface
|
|
49797
50442
|
*/
|
|
49798
50443
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
50444
|
+
/**
|
|
50445
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; 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.
|
|
50446
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
50447
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
50448
|
+
* @param {*} [options] Override http request option.
|
|
50449
|
+
* @throws {RequiredError}
|
|
50450
|
+
* @memberof PaymentSessionApiInterface
|
|
50451
|
+
*/
|
|
50452
|
+
recordWorldlineA2aResult(recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: AxiosRequestConfig): AxiosPromise<WorldlineA2aResultViewDto>;
|
|
49799
50453
|
/**
|
|
49800
50454
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
49801
50455
|
* @summary Refund an Epassi payment in full
|
|
@@ -49823,6 +50477,15 @@ export interface PaymentSessionApiInterface {
|
|
|
49823
50477
|
* @memberof PaymentSessionApiInterface
|
|
49824
50478
|
*/
|
|
49825
50479
|
refundVivaSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
50480
|
+
/**
|
|
50481
|
+
* 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. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
50482
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
50483
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
50484
|
+
* @param {*} [options] Override http request option.
|
|
50485
|
+
* @throws {RequiredError}
|
|
50486
|
+
* @memberof PaymentSessionApiInterface
|
|
50487
|
+
*/
|
|
50488
|
+
refundWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
49826
50489
|
/**
|
|
49827
50490
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
49828
50491
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -49859,6 +50522,15 @@ export interface PaymentSessionApiInterface {
|
|
|
49859
50522
|
* @memberof PaymentSessionApiInterface
|
|
49860
50523
|
*/
|
|
49861
50524
|
revertVivaSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
50525
|
+
/**
|
|
50526
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
50527
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
50528
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
50529
|
+
* @param {*} [options] Override http request option.
|
|
50530
|
+
* @throws {RequiredError}
|
|
50531
|
+
* @memberof PaymentSessionApiInterface
|
|
50532
|
+
*/
|
|
50533
|
+
revertWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
49862
50534
|
/**
|
|
49863
50535
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
49864
50536
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -49975,6 +50647,16 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
49975
50647
|
* @memberof PaymentSessionApi
|
|
49976
50648
|
*/
|
|
49977
50649
|
initiateVivaSession(initiateVivaSessionDto: InitiateVivaSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateVivaSessionResponseDto, any, {}>>;
|
|
50650
|
+
/**
|
|
50651
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
50652
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
50653
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
50654
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
50655
|
+
* @param {*} [options] Override http request option.
|
|
50656
|
+
* @throws {RequiredError}
|
|
50657
|
+
* @memberof PaymentSessionApi
|
|
50658
|
+
*/
|
|
50659
|
+
initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
49978
50660
|
/**
|
|
49979
50661
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
49980
50662
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -50040,6 +50722,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
50040
50722
|
* @memberof PaymentSessionApi
|
|
50041
50723
|
*/
|
|
50042
50724
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
|
|
50725
|
+
/**
|
|
50726
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; 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.
|
|
50727
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
50728
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
50729
|
+
* @param {*} [options] Override http request option.
|
|
50730
|
+
* @throws {RequiredError}
|
|
50731
|
+
* @memberof PaymentSessionApi
|
|
50732
|
+
*/
|
|
50733
|
+
recordWorldlineA2aResult(recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WorldlineA2aResultViewDto, any, {}>>;
|
|
50043
50734
|
/**
|
|
50044
50735
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
50045
50736
|
* @summary Refund an Epassi payment in full
|
|
@@ -50067,6 +50758,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
50067
50758
|
* @memberof PaymentSessionApi
|
|
50068
50759
|
*/
|
|
50069
50760
|
refundVivaSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
50761
|
+
/**
|
|
50762
|
+
* 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. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
50763
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
50764
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
50765
|
+
* @param {*} [options] Override http request option.
|
|
50766
|
+
* @throws {RequiredError}
|
|
50767
|
+
* @memberof PaymentSessionApi
|
|
50768
|
+
*/
|
|
50769
|
+
refundWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
50070
50770
|
/**
|
|
50071
50771
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
50072
50772
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -50103,6 +50803,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
50103
50803
|
* @memberof PaymentSessionApi
|
|
50104
50804
|
*/
|
|
50105
50805
|
revertVivaSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
50806
|
+
/**
|
|
50807
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
50808
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
50809
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
50810
|
+
* @param {*} [options] Override http request option.
|
|
50811
|
+
* @throws {RequiredError}
|
|
50812
|
+
* @memberof PaymentSessionApi
|
|
50813
|
+
*/
|
|
50814
|
+
revertWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
50106
50815
|
/**
|
|
50107
50816
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
50108
50817
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -55840,7 +56549,7 @@ export declare class VendureSellerApi extends BaseAPI implements VendureSellerAp
|
|
|
55840
56549
|
export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
55841
56550
|
/**
|
|
55842
56551
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55843
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56552
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
55844
56553
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55845
56554
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55846
56555
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -55849,7 +56558,7 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
55849
56558
|
*/
|
|
55850
56559
|
changeVenueKiosk: (businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55851
56560
|
/**
|
|
55852
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
56561
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55853
56562
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55854
56563
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55855
56564
|
* @param {ClaimKioskDto} claimKioskDto
|
|
@@ -55900,7 +56609,7 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
55900
56609
|
export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
55901
56610
|
/**
|
|
55902
56611
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55903
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56612
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
55904
56613
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55905
56614
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55906
56615
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -55909,7 +56618,7 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
55909
56618
|
*/
|
|
55910
56619
|
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55911
56620
|
/**
|
|
55912
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
56621
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55913
56622
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55914
56623
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55915
56624
|
* @param {ClaimKioskDto} claimKioskDto
|
|
@@ -55960,7 +56669,7 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
55960
56669
|
export declare const VenueKiosksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
55961
56670
|
/**
|
|
55962
56671
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55963
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56672
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
55964
56673
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55965
56674
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55966
56675
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -55969,7 +56678,7 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
55969
56678
|
*/
|
|
55970
56679
|
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
55971
56680
|
/**
|
|
55972
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
56681
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55973
56682
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55974
56683
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55975
56684
|
* @param {ClaimKioskDto} claimKioskDto
|
|
@@ -56021,7 +56730,7 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
56021
56730
|
export interface VenueKiosksApiInterface {
|
|
56022
56731
|
/**
|
|
56023
56732
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
56024
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56733
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
56025
56734
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56026
56735
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56027
56736
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -56031,7 +56740,7 @@ export interface VenueKiosksApiInterface {
|
|
|
56031
56740
|
*/
|
|
56032
56741
|
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56033
56742
|
/**
|
|
56034
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
56743
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
56035
56744
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
56036
56745
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56037
56746
|
* @param {ClaimKioskDto} claimKioskDto
|
|
@@ -56089,7 +56798,7 @@ export interface VenueKiosksApiInterface {
|
|
|
56089
56798
|
export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
|
|
56090
56799
|
/**
|
|
56091
56800
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
56092
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56801
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
56093
56802
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56094
56803
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56095
56804
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -56099,7 +56808,7 @@ export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInt
|
|
|
56099
56808
|
*/
|
|
56100
56809
|
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56101
56810
|
/**
|
|
56102
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
56811
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
56103
56812
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
56104
56813
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56105
56814
|
* @param {ClaimKioskDto} claimKioskDto
|