@zenglobal/api-client 1.1.4 → 3.0.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.
@@ -1,5 +1,5 @@
1
1
  export type ClientOptions = {
2
- baseUrl: 'https://api-dev.zenglobal.au/v1' | 'https://api.zenglobal.au/v1' | (string & {});
2
+ baseUrl: 'https://api-dev.zenglobal.au' | 'https://api.zenglobal.au' | (string & {});
3
3
  };
4
4
  /**
5
5
  * Address structure used for billing and shipping addresses
@@ -422,10 +422,8 @@ export type CoffeeCardResultItem = {
422
422
  purchased: number;
423
423
  };
424
424
  /**
425
- * Site and company information modelsComplete company information structure.
426
- * Fields are sourced from CHAIN, SBU, CHAININFO, CHAINDEFAULT, and CHAINLOCALE tables.
427
- * All T/F varchar fields are converted to booleans.
428
- * All integer/decimal values are converted to strings by JsonTransformer.
425
+ * Site and company information models.Complete company information structure.
426
+ * Boolean fields are native booleans. Numeric values are returned as strings.
429
427
  */
430
428
  export type CompanyInfo = {
431
429
  /**
@@ -433,11 +431,11 @@ export type CompanyInfo = {
433
431
  */
434
432
  company: ApiNumeric;
435
433
  /**
436
- * Company description/name
434
+ * Company name
437
435
  */
438
436
  description: string;
439
437
  /**
440
- * SBU (Strategic Business Unit) number
438
+ * Strategic Business Unit number
441
439
  */
442
440
  sbunumber: string;
443
441
  /**
@@ -457,7 +455,7 @@ export type CompanyInfo = {
457
455
  */
458
456
  phone: string;
459
457
  /**
460
- * Company active status (T/F converted to boolean)
458
+ * Whether the company is active
461
459
  */
462
460
  active: boolean;
463
461
  /**
@@ -521,7 +519,7 @@ export type CompanyInfo = {
521
519
  */
522
520
  acn: string;
523
521
  /**
524
- * Department levels setting
522
+ * Department hierarchy levels
525
523
  */
526
524
  deptlevels: ApiNumeric;
527
525
  /**
@@ -533,11 +531,11 @@ export type CompanyInfo = {
533
531
  */
534
532
  mastersite: ApiNumeric;
535
533
  /**
536
- * Districts enabled flag (T/F converted to boolean)
534
+ * Whether district grouping is enabled
537
535
  */
538
536
  districts: boolean;
539
537
  /**
540
- * Chain URL for loyalty portal
538
+ * Loyalty portal URL
541
539
  */
542
540
  chainurl: string;
543
541
  /**
@@ -553,7 +551,7 @@ export type CompanyInfo = {
553
551
  */
554
552
  discount: ApiNumeric;
555
553
  /**
556
- * Year renewal month
554
+ * Year renewal setting
557
555
  */
558
556
  yearrenew: ApiNumeric;
559
557
  /**
@@ -565,7 +563,7 @@ export type CompanyInfo = {
565
563
  */
566
564
  weekstartday: ApiNumeric;
567
565
  /**
568
- * Year start month
566
+ * Fiscal year start month
569
567
  */
570
568
  yearstartmonth: ApiNumeric;
571
569
  /**
@@ -573,7 +571,7 @@ export type CompanyInfo = {
573
571
  */
574
572
  defaultmenu: ApiNumeric;
575
573
  /**
576
- * Default image (business) path
574
+ * Default business image path
577
575
  */
578
576
  defaultimageb: string;
579
577
  /**
@@ -585,75 +583,67 @@ export type CompanyInfo = {
585
583
  */
586
584
  loyaltyname: string;
587
585
  /**
588
- * Singular site descriptor label
586
+ * Singular site label
589
587
  */
590
588
  sitedesc: string;
591
589
  /**
592
- * Plural site descriptor label
590
+ * Plural site label
593
591
  */
594
592
  sitedescs: string;
595
593
  /**
596
- * Fashion mode setting
597
- */
598
- fashion: string;
599
- /**
600
- * Brand lab setting
594
+ * Brand label
601
595
  */
602
596
  brandlab: string;
603
597
  /**
604
- * Group financial summary enabled (T/F converted to boolean)
598
+ * Whether loyalty is grouped across sites
605
599
  */
606
600
  groupfs: boolean;
607
601
  /**
608
- * Card management enabled (T/F converted to boolean)
602
+ * Whether card management is enabled
609
603
  */
610
604
  enablecard: boolean;
611
605
  /**
612
- * Card expiry enabled (T/F converted to boolean)
613
- */
614
- enableexpiry: boolean;
615
- /**
616
- * Warning grace period (days)
606
+ * Warning grace period in days
617
607
  */
618
608
  warninggrace: ApiNumeric;
619
609
  /**
620
- * Expiry grace period (days)
610
+ * Expiry grace period in days
621
611
  */
622
612
  expirygrace: ApiNumeric;
623
613
  /**
624
- * Password expiry warning period (days)
614
+ * Password expiry warning period in days
625
615
  */
626
616
  warningpwdexpiry: ApiNumeric;
627
617
  /**
628
- * Tax description label
618
+ * Tax description label (e.g. GST)
629
619
  */
630
620
  taxdesc: string;
631
621
  /**
632
- * Default active status for new records (T/F converted to boolean)
622
+ * Whether new records are active by default
633
623
  */
634
624
  defaultactive: boolean;
635
625
  /**
636
- * Follow active status from parent (T/F converted to boolean)
626
+ * Whether child records follow parent active status
637
627
  */
638
628
  followactive: boolean;
639
629
  /**
640
- * Recalculate points enabled (T/F converted to boolean)
630
+ * Whether points are recalculated on changes
641
631
  */
642
632
  recalculatepoints: boolean;
643
633
  /**
644
- * Loyalty period type
634
+ * Loyalty period type (e.g. man, quart, 4-4-5)
645
635
  */
646
636
  periodtype: string;
647
637
  /**
648
- * SMS sub-accounts enabled (T/F converted to boolean)
638
+ * Whether SMS sub-accounts are enabled
649
639
  */
650
640
  smssubaccounts: boolean;
651
641
  /**
652
- * Currency symbol
642
+ * Currency symbol (e.g. $)
653
643
  */
654
644
  currencysym: string;
655
645
  /**
656
- * Decimal places for currency
646
+ * Decimal places for currency display
657
647
  */
658
648
  decimals: ApiNumeric;
659
649
  /**
@@ -669,35 +659,35 @@ export type CompanyInfo = {
669
659
  */
670
660
  maxterminals: ApiNumeric;
671
661
  /**
672
- * Currency code (e.g., AUD)
662
+ * Currency code (e.g. AUD)
673
663
  */
674
664
  currency: string;
675
665
  /**
676
- * Web voucher module enabled (always true)
666
+ * Whether the web voucher module is enabled
677
667
  */
678
668
  webvoucherenabled: boolean;
679
669
  /**
680
- * Web loyalty module enabled (always true)
670
+ * Whether the web loyalty module is enabled
681
671
  */
682
672
  webloyaltyenabled: boolean;
683
673
  /**
684
- * Web debtor module enabled (always false)
674
+ * Whether the web debtor module is enabled
685
675
  */
686
676
  webdebtorenabled: boolean;
687
677
  /**
688
- * Web member module enabled (always true)
678
+ * Whether the web member module is enabled
689
679
  */
690
680
  webmemberenabled: boolean;
691
681
  /**
692
- * Web customer order module enabled (always true)
682
+ * Whether the web customer order module is enabled
693
683
  */
694
684
  webcustomerorderenabled: boolean;
695
685
  /**
696
- * Web voucher URL
686
+ * Web voucher purchase URL
697
687
  */
698
688
  webvoucherurl: string;
699
689
  /**
700
- * Array of sites belonging to this company
690
+ * Sites belonging to this company
701
691
  */
702
692
  sites: Array<SiteInfo>;
703
693
  };
@@ -1193,6 +1183,73 @@ export type JackpotsResponse = {
1193
1183
  */
1194
1184
  jackpots: Array<Jackpot>;
1195
1185
  };
1186
+ /**
1187
+ * Summary of a journal returned from the lookup search endpoint.
1188
+ */
1189
+ export type JournalLookupResult = {
1190
+ /**
1191
+ * Unique journal ID (JOURNALTRACK.ID)
1192
+ */
1193
+ id: number;
1194
+ /**
1195
+ * Site code where transaction occurred
1196
+ */
1197
+ site: number;
1198
+ /**
1199
+ * Site description
1200
+ */
1201
+ site_name: string;
1202
+ /**
1203
+ * Location number within site
1204
+ */
1205
+ location: number;
1206
+ /**
1207
+ * Terminal number
1208
+ */
1209
+ terminal: number;
1210
+ /**
1211
+ * Journal number
1212
+ */
1213
+ journal: string;
1214
+ /**
1215
+ * Transaction date
1216
+ */
1217
+ transaction_date: ApiDate;
1218
+ /**
1219
+ * Transaction timestamp (may be null for older journals)
1220
+ */
1221
+ transaction_time?: string;
1222
+ /**
1223
+ * Whether the transaction was voided
1224
+ */
1225
+ void: boolean;
1226
+ };
1227
+ /**
1228
+ * Response from the journal lookup search endpoint.
1229
+ *
1230
+ * Returned via `prepareJson()` with `result`/`errormessage` wrapper fields.
1231
+ */
1232
+ export type JournalLookupSearchResponse = {
1233
+ /**
1234
+ * Result code (0 = success)
1235
+ */
1236
+ result: number;
1237
+ /**
1238
+ * Result message
1239
+ */
1240
+ errormessage: string;
1241
+ /**
1242
+ * Matching journals (up to 100 results)
1243
+ */
1244
+ results: Array<JournalLookupResult>;
1245
+ };
1246
+ /**
1247
+ * Response containing raw XML for a journal.
1248
+ *
1249
+ * Returned as `application/xml` with the raw transaction XML directly in the response body.
1250
+ * Sensitive nodes (e.g., SerialNumber) are stripped before returning.
1251
+ */
1252
+ export type JournalLookupXmlResponse = string;
1196
1253
  /**
1197
1254
  * Request body for creating a list definition or adding a card to a list.
1198
1255
  * Body is wrapped in a `lists` key: `{"lists": {...}}`.
@@ -1308,7 +1365,7 @@ export type ListUpdateRequest = {
1308
1365
  };
1309
1366
  };
1310
1367
  /**
1311
- * Location information within a site
1368
+ * Location within a site.
1312
1369
  */
1313
1370
  export type LocationInfo = {
1314
1371
  /**
@@ -1316,7 +1373,7 @@ export type LocationInfo = {
1316
1373
  */
1317
1374
  location: ApiNumeric;
1318
1375
  /**
1319
- * Location description
1376
+ * Location name
1320
1377
  */
1321
1378
  description: string;
1322
1379
  /**
@@ -1324,7 +1381,7 @@ export type LocationInfo = {
1324
1381
  */
1325
1382
  locationtype: ApiNumeric;
1326
1383
  /**
1327
- * Location type description
1384
+ * Location type name
1328
1385
  */
1329
1386
  locationtypedescription: string;
1330
1387
  };
@@ -1585,11 +1642,11 @@ export type LoyaltyCard = {
1585
1642
  /**
1586
1643
  * Available offers (when includeoffers requested)
1587
1644
  */
1588
- offers?: Array<LoyaltyOffer>;
1645
+ offers?: Array<Offer>;
1589
1646
  /**
1590
1647
  * Recently redeemed offers (when includeoffers requested)
1591
1648
  */
1592
- redeemed_offers?: Array<RedeemedOffer>;
1649
+ redeemed_offers?: Array<OfferRedemption>;
1593
1650
  /**
1594
1651
  * Transaction history (when requested)
1595
1652
  */
@@ -2027,29 +2084,6 @@ export type LoyaltyGroup = {
2027
2084
  */
2028
2085
  sitelist: Array<string>;
2029
2086
  };
2030
- /**
2031
- * Loyalty offer information (simplified for card context)
2032
- */
2033
- export type LoyaltyOffer = {
2034
- /**
2035
- * Offer identifier
2036
- */
2037
- offer_id: number;
2038
- /**
2039
- * Offer description
2040
- */
2041
- offer_description: string;
2042
- /**
2043
- * Offer is active
2044
- */
2045
- active: boolean;
2046
- /**
2047
- * Offer details
2048
- */
2049
- details?: {
2050
- [key: string]: string;
2051
- };
2052
- };
2053
2087
  /**
2054
2088
  * Simplified loyalty card information returned by search endpoints
2055
2089
  */
@@ -3316,8 +3350,9 @@ export type Offer = {
3316
3350
  * * `P` - Before birthday
3317
3351
  * * `A` - After birthday
3318
3352
  * * `B` - Before or after birthday
3353
+ * Null when not a birthday offer.
3319
3354
  */
3320
- deltadir?: DeltaDir;
3355
+ deltadir?: DeltaDir | null;
3321
3356
  /**
3322
3357
  * Human-readable description of the card type flag setting
3323
3358
  */
@@ -3435,7 +3470,7 @@ export type Offer = {
3435
3470
  /**
3436
3471
  * Link scheduler value
3437
3472
  */
3438
- linksched?: ApiNumeric;
3473
+ linksched?: string;
3439
3474
  /**
3440
3475
  * Determine the range for which to look for purchased items.
3441
3476
  * * `-1` - ALL
@@ -4464,6 +4499,16 @@ export type PhoneNumbers = {
4464
4499
  */
4465
4500
  work: string;
4466
4501
  };
4502
+ export type PingV2PingResult = {
4503
+ /**
4504
+ * The Unique Identifier of the portal you are connected too
4505
+ */
4506
+ portal_uid: string;
4507
+ /**
4508
+ * The chain your api key is authenticated for.
4509
+ */
4510
+ chaincode: number;
4511
+ };
4467
4512
  export type PluGroup = {
4468
4513
  /**
4469
4514
  * PLU Group Id (match with PLUGroupNo)
@@ -4499,59 +4544,6 @@ export type PurchaseGroup = {
4499
4544
  */
4500
4545
  isdefault: string;
4501
4546
  };
4502
- /**
4503
- * Redeemed offer information
4504
- */
4505
- export type RedeemedOffer = {
4506
- /**
4507
- * Offer identifier
4508
- */
4509
- id: number;
4510
- /**
4511
- * Offer description
4512
- */
4513
- description: string;
4514
- /**
4515
- * Offer active date
4516
- */
4517
- dateactive?: ApiDate;
4518
- /**
4519
- * Offer expiry date
4520
- */
4521
- dateexpire?: ApiDate;
4522
- /**
4523
- * Offer points value
4524
- */
4525
- points?: ApiNumeric;
4526
- /**
4527
- * Offer discount value
4528
- */
4529
- discount?: ApiNumeric;
4530
- /**
4531
- * Offer amount
4532
- */
4533
- amount?: ApiNumeric;
4534
- /**
4535
- * Whether offer is enabled
4536
- */
4537
- enabled: boolean;
4538
- /**
4539
- * Date the offer was redeemed
4540
- */
4541
- redeemed_date?: ApiDate;
4542
- /**
4543
- * Points redeemed for this offer
4544
- */
4545
- redeemed_points?: ApiNumeric;
4546
- /**
4547
- * Amount redeemed for this offer
4548
- */
4549
- redeemed_amount?: ApiNumeric;
4550
- /**
4551
- * Tax on redeemed amount
4552
- */
4553
- redeemed_tax?: ApiNumeric;
4554
- };
4555
4547
  export type Result = {
4556
4548
  result: number;
4557
4549
  errormessage: string;
@@ -4770,11 +4762,6 @@ export type ShortCodeUpdateResponse = {
4770
4762
  };
4771
4763
  /**
4772
4764
  * Individual site information.
4773
- * All columns from the SITE table are included except: servernumber, netaddress,
4774
- * tillmastersite, servername, changedate, childid, chaincode, nmi, enableasp.
4775
- * T/F varchar fields are converted to booleans.
4776
- * Integer/decimal values are converted to strings by JsonTransformer.
4777
- * The `times` and `locations` fields are dynamically added.
4778
4765
  */
4779
4766
  export type SiteInfo = {
4780
4767
  /**
@@ -4782,69 +4769,13 @@ export type SiteInfo = {
4782
4769
  */
4783
4770
  sitecode: ApiNumeric;
4784
4771
  /**
4785
- * Site description/name
4772
+ * Site name
4786
4773
  */
4787
4774
  description: string;
4788
- /**
4789
- * Site type (single character code)
4790
- */
4791
- sitetype: string;
4792
- /**
4793
- * Region code
4794
- */
4795
- region: ApiNumeric;
4796
- /**
4797
- * Site locale setting
4798
- */
4799
- sitelocale: string;
4800
- /**
4801
- * Code page for character encoding
4802
- */
4803
- codepage: ApiNumeric;
4804
- /**
4805
- * Maximum terminals allowed at site
4806
- */
4807
- maxterminals: ApiNumeric;
4808
- /**
4809
- * Venue ID for external integrations
4810
- */
4811
- venue_id: ApiNumeric;
4812
- /**
4813
- * District code
4814
- */
4815
- district: ApiNumeric;
4816
- /**
4817
- * External store identifier
4818
- */
4819
- store_id: string;
4820
- /**
4821
- * Shopify store identifier
4822
- */
4823
- shopify_id: string;
4824
- /**
4825
- * Salesforce account identifier
4826
- */
4827
- salesforce_account_id: string;
4828
- /**
4829
- * Customer reference identifier
4830
- */
4831
- customer_reference_id: string;
4832
- /**
4833
- * Salesforce sync status
4834
- */
4835
- salesforce_sync_status: string;
4836
- /**
4837
- * Salesforce sync last updated timestamp
4838
- */
4839
- salesforce_sync_updated_at: string;
4840
4775
  /**
4841
4776
  * Registered business name
4842
4777
  */
4843
4778
  registeredname: string;
4844
- /**
4845
- * Site serial number for authentication
4846
- */
4847
- serialnumber: string;
4848
4779
  /**
4849
4780
  * Site address line 1
4850
4781
  */
@@ -4866,7 +4797,7 @@ export type SiteInfo = {
4866
4797
  */
4867
4798
  country: string;
4868
4799
  /**
4869
- * City/Suburb name
4800
+ * City or suburb
4870
4801
  */
4871
4802
  city: string;
4872
4803
  /**
@@ -4910,11 +4841,11 @@ export type SiteInfo = {
4910
4841
  */
4911
4842
  billcity: string;
4912
4843
  /**
4913
- * Contact person name
4844
+ * Contact person
4914
4845
  */
4915
4846
  contact: string;
4916
4847
  /**
4917
- * Site manager name
4848
+ * Site manager
4918
4849
  */
4919
4850
  manager: string;
4920
4851
  /**
@@ -4922,105 +4853,61 @@ export type SiteInfo = {
4922
4853
  */
4923
4854
  email: string;
4924
4855
  /**
4925
- * Last known IP address
4926
- */
4927
- lastipaddress: string;
4928
- /**
4929
- * Last IP address date
4930
- */
4931
- lastipdate: string;
4932
- /**
4933
- * Last billing date
4934
- */
4935
- lastbilldate: string;
4936
- /**
4937
- * License expiry date
4938
- */
4939
- licdate: string;
4940
- /**
4941
- * Date of first sale
4942
- */
4943
- firstsale: string;
4944
- /**
4945
- * Date of last sale
4946
- */
4947
- lastsale: string;
4948
- /**
4949
- * Store type classification
4950
- */
4951
- storetype: string;
4952
- /**
4953
- * Store number identifier
4954
- */
4955
- storenum: string;
4956
- /**
4957
- * Blind cash-up enabled (T/F converted to boolean)
4958
- */
4959
- blindcashup: boolean;
4960
- /**
4961
- * Location feature enabled (T/F converted to boolean)
4962
- */
4963
- enableloc: boolean;
4964
- /**
4965
- * Kiosk mode enabled (T/F converted to boolean)
4966
- */
4967
- enablekiosk: boolean;
4968
- /**
4969
- * Australian Company Number for site
4856
+ * Australian Company Number
4970
4857
  */
4971
4858
  acn: string;
4972
4859
  /**
4973
- * VNC password (internal)
4974
- */
4975
- _vncpassword: string;
4976
- /**
4977
- * Site active status (T/F converted to boolean)
4860
+ * Whether the site is active
4978
4861
  */
4979
4862
  siteactive: boolean;
4980
- /**
4981
- * Video port number
4982
- */
4983
- videoport: ApiNumeric;
4984
4863
  /**
4985
4864
  * Site currency code
4986
4865
  */
4987
4866
  currency: string;
4988
4867
  /**
4989
- * GPS latitude coordinate
4868
+ * GPS latitude
4990
4869
  */
4991
4870
  latitude: ApiNumeric;
4992
4871
  /**
4993
- * GPS longitude coordinate (note: column name has legacy typo)
4872
+ * GPS longitude (note: legacy spelling preserved)
4994
4873
  */
4995
4874
  longtitude: ApiNumeric;
4996
4875
  /**
4997
- * Base station identifier
4876
+ * Site timezone
4998
4877
  */
4999
- basestation: string;
4878
+ timezone: string;
5000
4879
  /**
5001
- * Use trade date instead of calendar date (T/F converted to boolean)
4880
+ * Region code
5002
4881
  */
5003
- usetradedate: boolean;
4882
+ region: ApiNumeric;
5004
4883
  /**
5005
- * Site passphrase for authentication
4884
+ * Region reference ID
5006
4885
  */
5007
- passphrase: string;
4886
+ region_id: ApiNumeric;
5008
4887
  /**
5009
- * Map cash drawer enabled (T/F converted to boolean)
4888
+ * District code
5010
4889
  */
5011
- mapcashdrawer: boolean;
4890
+ district: ApiNumeric;
5012
4891
  /**
5013
- * Compliance mode setting
4892
+ * District reference ID
5014
4893
  */
5015
- compliancemode: string;
4894
+ district_id: ApiNumeric;
5016
4895
  /**
5017
- * Region reference ID
4896
+ * External store identifier
5018
4897
  */
5019
- region_id: ApiNumeric;
4898
+ store_id: string;
5020
4899
  /**
5021
- * District reference ID
4900
+ * Shopify store identifier
5022
4901
  */
5023
- district_id: ApiNumeric;
4902
+ shopify_id: string;
4903
+ /**
4904
+ * Salesforce account identifier
4905
+ */
4906
+ salesforce_account_id: string;
4907
+ /**
4908
+ * Customer reference identifier
4909
+ */
4910
+ customer_reference_id: string;
5024
4911
  /**
5025
4912
  * POS provider reference ID
5026
4913
  */
@@ -5030,7 +4917,7 @@ export type SiteInfo = {
5030
4917
  */
5031
4918
  point_of_sale_reseller_id: ApiNumeric;
5032
4919
  /**
5033
- * POS support enabled
4920
+ * Whether POS support is enabled
5034
4921
  */
5035
4922
  point_of_sale_support: boolean;
5036
4923
  /**
@@ -5038,23 +4925,39 @@ export type SiteInfo = {
5038
4925
  */
5039
4926
  web_store_id: ApiNumeric;
5040
4927
  /**
5041
- * Site timezone (e.g., Australia/Adelaide)
4928
+ * Salesforce sync status
5042
4929
  */
5043
- timezone: string;
4930
+ salesforce_sync_status: string;
4931
+ /**
4932
+ * Salesforce sync last updated
4933
+ */
4934
+ salesforce_sync_updated_at: string;
5044
4935
  /**
5045
4936
  * Whether loyalty signup is allowed at this site
5046
4937
  */
5047
- allow_loyalty_signup: boolean;
4938
+ allow_loyalty_signup: string;
4939
+ /**
4940
+ * Date of first sale
4941
+ */
4942
+ firstsale: string;
4943
+ /**
4944
+ * Date of last sale
4945
+ */
4946
+ lastsale: string;
4947
+ /**
4948
+ * Store number
4949
+ */
4950
+ storenum: string;
5048
4951
  /**
5049
4952
  * Operating hours for today
5050
4953
  */
5051
4954
  times: {
5052
4955
  /**
5053
- * Opening time
4956
+ * Opening hour (0-23)
5054
4957
  */
5055
4958
  opening: string;
5056
4959
  /**
5057
- * Closing time
4960
+ * Closing hour (0-23)
5058
4961
  */
5059
4962
  closing: string;
5060
4963
  };
@@ -5064,8 +4967,7 @@ export type SiteInfo = {
5064
4967
  locations: Array<LocationInfo>;
5065
4968
  };
5066
4969
  /**
5067
- * Sites response model.
5068
- * This is a GET endpoint that returns raw JSON via prepareJson() without result/errormessage wrapper.
4970
+ * Sites endpoint response.
5069
4971
  */
5070
4972
  export type SitesResponse = {
5071
4973
  /**
@@ -6062,7 +5964,7 @@ export type VersionResponse = {
6062
5964
  [key: string]: ApiFunctionInfo;
6063
5965
  };
6064
5966
  };
6065
- export type Versions = '1.0.0';
5967
+ export type Versions = '1.0.0' | '2.0.0';
6066
5968
  /**
6067
5969
  * Response from voucher balance-affecting operations (redeem, reserve, release).
6068
5970
  * Uses setError()/setErrorLockClear() so includes result/errormessage.
@@ -7061,7 +6963,7 @@ export type SmsSendSmsData = {
7061
6963
  body: SmsSendRequestBody;
7062
6964
  path?: never;
7063
6965
  query?: never;
7064
- url: '/SMS';
6966
+ url: '/v1/SMS';
7065
6967
  };
7066
6968
  export type SmsSendSmsErrors = {
7067
6969
  /**
@@ -7087,7 +6989,7 @@ export type SmsGetSmsBalanceData = {
7087
6989
  site: number;
7088
6990
  };
7089
6991
  query?: never;
7090
- url: '/SMS/balance/{site}';
6992
+ url: '/v1/SMS/balance/{site}';
7091
6993
  };
7092
6994
  export type SmsGetSmsBalanceErrors = {
7093
6995
  /**
@@ -7137,7 +7039,7 @@ export type SmsGetSmsRepliesData = {
7137
7039
  */
7138
7040
  control?: string;
7139
7041
  };
7140
- url: '/SMS/replies/{site}';
7042
+ url: '/v1/SMS/replies/{site}';
7141
7043
  };
7142
7044
  export type SmsGetSmsRepliesErrors = {
7143
7045
  /**
@@ -7182,7 +7084,7 @@ export type SmsGetSmsResponsesData = {
7182
7084
  */
7183
7085
  to: ApiDate;
7184
7086
  };
7185
- url: '/SMS/response/{site}';
7087
+ url: '/v1/SMS/response/{site}';
7186
7088
  };
7187
7089
  export type SmsGetSmsResponsesErrors = {
7188
7090
  /**
@@ -7223,7 +7125,7 @@ export type SmsGetSentSmsListData = {
7223
7125
  */
7224
7126
  to: ApiDate;
7225
7127
  };
7226
- url: '/SMS/sent/{mobile}';
7128
+ url: '/v1/SMS/sent/{mobile}';
7227
7129
  };
7228
7130
  export type SmsGetSentSmsListErrors = {
7229
7131
  /**
@@ -7247,7 +7149,7 @@ export type EventsProcessEventData = {
7247
7149
  body: EventRequest;
7248
7150
  path?: never;
7249
7151
  query?: never;
7250
- url: '/events';
7152
+ url: '/v1/events';
7251
7153
  };
7252
7154
  export type EventsProcessEventErrors = {
7253
7155
  /**
@@ -7275,7 +7177,7 @@ export type GatewayGetGatewayConfigData = {
7275
7177
  body?: never;
7276
7178
  path?: never;
7277
7179
  query?: never;
7278
- url: '/gateway';
7180
+ url: '/v1/gateway';
7279
7181
  };
7280
7182
  export type GatewayGetGatewayConfigErrors = {
7281
7183
  /**
@@ -7302,7 +7204,7 @@ export type InventoryGetDepartmentItemsData = {
7302
7204
  departmentId: number;
7303
7205
  };
7304
7206
  query?: never;
7305
- url: '/inventory/{siteCode}/department/{departmentId}';
7207
+ url: '/v1/inventory/{siteCode}/department/{departmentId}';
7306
7208
  };
7307
7209
  export type InventoryGetDepartmentItemsErrors = {
7308
7210
  /**
@@ -7335,7 +7237,7 @@ export type InventoryGetItemData = {
7335
7237
  itemNumber: string;
7336
7238
  };
7337
7239
  query?: never;
7338
- url: '/inventory/{siteCode}/item/{itemNumber}';
7240
+ url: '/v1/inventory/{siteCode}/item/{itemNumber}';
7339
7241
  };
7340
7242
  export type InventoryGetItemErrors = {
7341
7243
  /**
@@ -7368,7 +7270,7 @@ export type InventorySearchInventoryData = {
7368
7270
  command: 'number' | 'description' | 'supplier' | 'colour' | 'style' | 'size' | 'barcode';
7369
7271
  };
7370
7272
  query?: never;
7371
- url: '/inventory/{siteCode}/search/{command}';
7273
+ url: '/v1/inventory/{siteCode}/search/{command}';
7372
7274
  };
7373
7275
  export type InventorySearchInventoryErrors = {
7374
7276
  /**
@@ -7400,7 +7302,7 @@ export type InventoryBulkInventoryData = {
7400
7302
  siteId: number;
7401
7303
  };
7402
7304
  query?: never;
7403
- url: '/inventory/{siteId}/bulk_inventory';
7305
+ url: '/v1/inventory/{siteId}/bulk_inventory';
7404
7306
  };
7405
7307
  export type InventoryBulkInventoryErrors = {
7406
7308
  /**
@@ -7441,7 +7343,7 @@ export type JackpotsListData = {
7441
7343
  */
7442
7344
  offset?: number;
7443
7345
  };
7444
- url: '/jackpots';
7346
+ url: '/v1/jackpots';
7445
7347
  };
7446
7348
  export type JackpotsListErrors = {
7447
7349
  /**
@@ -7490,7 +7392,7 @@ export type JackpotsListWinnersData = {
7490
7392
  */
7491
7393
  offset?: number;
7492
7394
  };
7493
- url: '/jackpots/winners';
7395
+ url: '/v1/jackpots/winners';
7494
7396
  };
7495
7397
  export type JackpotsListWinnersErrors = {
7496
7398
  /**
@@ -7518,7 +7420,7 @@ export type ListsDeleteListData = {
7518
7420
  body: ListDeleteRequest;
7519
7421
  path?: never;
7520
7422
  query?: never;
7521
- url: '/lists';
7423
+ url: '/v1/lists';
7522
7424
  };
7523
7425
  export type ListsDeleteListErrors = {
7524
7426
  /**
@@ -7542,7 +7444,7 @@ export type ListsGetAllListsData = {
7542
7444
  body?: never;
7543
7445
  path?: never;
7544
7446
  query?: never;
7545
- url: '/lists';
7447
+ url: '/v1/lists';
7546
7448
  };
7547
7449
  export type ListsGetAllListsErrors = {
7548
7450
  /**
@@ -7562,7 +7464,7 @@ export type ListsCreateListData = {
7562
7464
  body: ListCreateRequest;
7563
7465
  path?: never;
7564
7466
  query?: never;
7565
- url: '/lists';
7467
+ url: '/v1/lists';
7566
7468
  };
7567
7469
  export type ListsCreateListErrors = {
7568
7470
  /**
@@ -7586,7 +7488,7 @@ export type ListsUpdateListData = {
7586
7488
  body: ListUpdateRequest;
7587
7489
  path?: never;
7588
7490
  query?: never;
7589
- url: '/lists';
7491
+ url: '/v1/lists';
7590
7492
  };
7591
7493
  export type ListsUpdateListErrors = {
7592
7494
  /**
@@ -7612,7 +7514,7 @@ export type ListsRemoveCardFromListData = {
7612
7514
  cardNumber: string;
7613
7515
  };
7614
7516
  query?: never;
7615
- url: '/lists/{cardNumber}';
7517
+ url: '/v1/lists/{cardNumber}';
7616
7518
  };
7617
7519
  export type ListsRemoveCardFromListErrors = {
7618
7520
  /**
@@ -7642,7 +7544,7 @@ export type ListsGetCardListsData = {
7642
7544
  cardNumber: string;
7643
7545
  };
7644
7546
  query?: never;
7645
- url: '/lists/{cardNumber}';
7547
+ url: '/v1/lists/{cardNumber}';
7646
7548
  };
7647
7549
  export type ListsGetCardListsErrors = {
7648
7550
  /**
@@ -7668,7 +7570,7 @@ export type ListsCreateListWithCardData = {
7668
7570
  cardNumber: string;
7669
7571
  };
7670
7572
  query?: never;
7671
- url: '/lists/{cardNumber}';
7573
+ url: '/v1/lists/{cardNumber}';
7672
7574
  };
7673
7575
  export type ListsCreateListWithCardErrors = {
7674
7576
  /**
@@ -7698,7 +7600,7 @@ export type ListsUpdateListWithCardData = {
7698
7600
  cardNumber: string;
7699
7601
  };
7700
7602
  query?: never;
7701
- url: '/lists/{cardNumber}';
7603
+ url: '/v1/lists/{cardNumber}';
7702
7604
  };
7703
7605
  export type ListsUpdateListWithCardErrors = {
7704
7606
  /**
@@ -7726,7 +7628,7 @@ export type LoyaltyGetAllowedFunctionsData = {
7726
7628
  body?: never;
7727
7629
  path?: never;
7728
7630
  query?: never;
7729
- url: '/loyalty/allowedFunctions';
7631
+ url: '/v1/loyalty/allowedFunctions';
7730
7632
  };
7731
7633
  export type LoyaltyGetAllowedFunctionsErrors = {
7732
7634
  /**
@@ -7746,7 +7648,7 @@ export type LoyaltyCreateCardData = {
7746
7648
  body: LoyaltyCardCreateRequest;
7747
7649
  path?: never;
7748
7650
  query?: never;
7749
- url: '/loyalty/card';
7651
+ url: '/v1/loyalty/card';
7750
7652
  };
7751
7653
  export type LoyaltyCreateCardErrors = {
7752
7654
  /**
@@ -7774,7 +7676,7 @@ export type LoyaltyGetCardData = {
7774
7676
  query?: {
7775
7677
  format?: 'compact';
7776
7678
  };
7777
- url: '/loyalty/card/{cardNumber}';
7679
+ url: '/v1/loyalty/card/{cardNumber}';
7778
7680
  };
7779
7681
  export type LoyaltyGetCardErrors = {
7780
7682
  /**
@@ -7800,7 +7702,7 @@ export type LoyaltyUpdateCardData = {
7800
7702
  cardNumber: string;
7801
7703
  };
7802
7704
  query?: never;
7803
- url: '/loyalty/card/{cardNumber}';
7705
+ url: '/v1/loyalty/card/{cardNumber}';
7804
7706
  };
7805
7707
  export type LoyaltyUpdateCardErrors = {
7806
7708
  /**
@@ -7829,7 +7731,7 @@ export type LoyaltyActivateCardData = {
7829
7731
  cardNumber: string;
7830
7732
  };
7831
7733
  query?: never;
7832
- url: '/loyalty/card/{cardNumber}/activate';
7734
+ url: '/v1/loyalty/card/{cardNumber}/activate';
7833
7735
  };
7834
7736
  export type LoyaltyActivateCardErrors = {
7835
7737
  /**
@@ -7870,7 +7772,7 @@ export type LoyaltyUpdateAddressData = {
7870
7772
  cardNumber: string;
7871
7773
  };
7872
7774
  query?: never;
7873
- url: '/loyalty/card/{cardNumber}/address';
7775
+ url: '/v1/loyalty/card/{cardNumber}/address';
7874
7776
  };
7875
7777
  export type LoyaltyUpdateAddressErrors = {
7876
7778
  /**
@@ -7903,7 +7805,7 @@ export type LoyaltyUpdateBillingAddressData = {
7903
7805
  cardNumber: string;
7904
7806
  };
7905
7807
  query?: never;
7906
- url: '/loyalty/card/{cardNumber}/billingaddress';
7808
+ url: '/v1/loyalty/card/{cardNumber}/billingaddress';
7907
7809
  };
7908
7810
  export type LoyaltyUpdateBillingAddressErrors = {
7909
7811
  /**
@@ -7932,7 +7834,7 @@ export type LoyaltyDeactivateCardData = {
7932
7834
  cardNumber: string;
7933
7835
  };
7934
7836
  query?: never;
7935
- url: '/loyalty/card/{cardNumber}/deactivate';
7837
+ url: '/v1/loyalty/card/{cardNumber}/deactivate';
7936
7838
  };
7937
7839
  export type LoyaltyDeactivateCardErrors = {
7938
7840
  /**
@@ -7974,7 +7876,7 @@ export type LoyaltyUpdateGroupsData = {
7974
7876
  cardNumber: string;
7975
7877
  };
7976
7878
  query?: never;
7977
- url: '/loyalty/card/{cardNumber}/groups';
7879
+ url: '/v1/loyalty/card/{cardNumber}/groups';
7978
7880
  };
7979
7881
  export type LoyaltyUpdateGroupsErrors = {
7980
7882
  /**
@@ -8014,7 +7916,7 @@ export type LoyaltyUpdateExternalUserIdData = {
8014
7916
  cardNumber: string;
8015
7917
  };
8016
7918
  query?: never;
8017
- url: '/loyalty/card/{cardNumber}/idchange';
7919
+ url: '/v1/loyalty/card/{cardNumber}/idchange';
8018
7920
  };
8019
7921
  export type LoyaltyUpdateExternalUserIdErrors = {
8020
7922
  /**
@@ -8042,9 +7944,9 @@ export type LoyaltyGetCardWithOffersData = {
8042
7944
  path: {
8043
7945
  cardNumber: string;
8044
7946
  /**
8045
- * Site code to determine available offers
7947
+ * Site code to determine available offers. Use `homesite` to automatically resolve the card's home site.
8046
7948
  */
8047
- siteCode: number;
7949
+ siteCode: number | 'homesite';
8048
7950
  };
8049
7951
  query?: {
8050
7952
  /**
@@ -8056,7 +7958,7 @@ export type LoyaltyGetCardWithOffersData = {
8056
7958
  */
8057
7959
  total?: number;
8058
7960
  };
8059
- url: '/loyalty/card/{cardNumber}/includeoffers/{siteCode}';
7961
+ url: '/v1/loyalty/card/{cardNumber}/includeoffers/{siteCode}';
8060
7962
  };
8061
7963
  export type LoyaltyGetCardWithOffersErrors = {
8062
7964
  /**
@@ -8098,7 +8000,7 @@ export type LoyaltyUpdateMemberGroupsData = {
8098
8000
  cardNumber: string;
8099
8001
  };
8100
8002
  query?: never;
8101
- url: '/loyalty/card/{cardNumber}/membergroups';
8003
+ url: '/v1/loyalty/card/{cardNumber}/membergroups';
8102
8004
  };
8103
8005
  export type LoyaltyUpdateMemberGroupsErrors = {
8104
8006
  /**
@@ -8134,7 +8036,7 @@ export type LoyaltyUpdateCardPinData = {
8134
8036
  cardNumber: string;
8135
8037
  };
8136
8038
  query?: never;
8137
- url: '/loyalty/card/{cardNumber}/pin';
8039
+ url: '/v1/loyalty/card/{cardNumber}/pin';
8138
8040
  };
8139
8041
  export type LoyaltyUpdateCardPinErrors = {
8140
8042
  /**
@@ -8198,7 +8100,7 @@ export type LoyaltyUpdatePointsData = {
8198
8100
  cardNumber: string;
8199
8101
  };
8200
8102
  query?: never;
8201
- url: '/loyalty/card/{cardNumber}/points';
8103
+ url: '/v1/loyalty/card/{cardNumber}/points';
8202
8104
  };
8203
8105
  export type LoyaltyUpdatePointsErrors = {
8204
8106
  /**
@@ -8262,7 +8164,7 @@ export type LoyaltyRenewCardData = {
8262
8164
  cardNumber: string;
8263
8165
  };
8264
8166
  query?: never;
8265
- url: '/loyalty/card/{cardNumber}/renewal';
8167
+ url: '/v1/loyalty/card/{cardNumber}/renewal';
8266
8168
  };
8267
8169
  export type LoyaltyRenewCardErrors = {
8268
8170
  /**
@@ -8298,7 +8200,7 @@ export type LoyaltyUpdateShippingAddressData = {
8298
8200
  cardNumber: string;
8299
8201
  };
8300
8202
  query?: never;
8301
- url: '/loyalty/card/{cardNumber}/shippingaddress';
8203
+ url: '/v1/loyalty/card/{cardNumber}/shippingaddress';
8302
8204
  };
8303
8205
  export type LoyaltyUpdateShippingAddressErrors = {
8304
8206
  /**
@@ -8327,7 +8229,7 @@ export type LoyaltyGenerateShortCodeData = {
8327
8229
  cardNumber: string;
8328
8230
  };
8329
8231
  query?: never;
8330
- url: '/loyalty/card/{cardNumber}/shortcode';
8232
+ url: '/v1/loyalty/card/{cardNumber}/shortcode';
8331
8233
  };
8332
8234
  export type LoyaltyGenerateShortCodeErrors = {
8333
8235
  /**
@@ -8372,7 +8274,7 @@ export type LoyaltyUpdateCardTokenData = {
8372
8274
  cardNumber: string;
8373
8275
  };
8374
8276
  query?: never;
8375
- url: '/loyalty/card/{cardNumber}/token';
8277
+ url: '/v1/loyalty/card/{cardNumber}/token';
8376
8278
  };
8377
8279
  export type LoyaltyUpdateCardTokenErrors = {
8378
8280
  /**
@@ -8399,7 +8301,7 @@ export type LoyaltyGetCardTypesData = {
8399
8301
  body?: never;
8400
8302
  path?: never;
8401
8303
  query?: never;
8402
- url: '/loyalty/cardtypes';
8304
+ url: '/v1/loyalty/cardtypes';
8403
8305
  };
8404
8306
  export type LoyaltyGetCardTypesErrors = {
8405
8307
  /**
@@ -8429,7 +8331,7 @@ export type LoyaltyGetCoffeeCardStatsData = {
8429
8331
  site?: number;
8430
8332
  customer_reference_id?: string;
8431
8333
  };
8432
- url: '/loyalty/coffeecard/{cardNumber}';
8334
+ url: '/v1/loyalty/coffeecard/{cardNumber}';
8433
8335
  };
8434
8336
  export type LoyaltyGetCoffeeCardStatsErrors = {
8435
8337
  /**
@@ -8453,7 +8355,7 @@ export type LoyaltyGetCompulsoryFieldsData = {
8453
8355
  body?: never;
8454
8356
  path?: never;
8455
8357
  query?: never;
8456
- url: '/loyalty/compulsory';
8358
+ url: '/v1/loyalty/compulsory';
8457
8359
  };
8458
8360
  export type LoyaltyGetCompulsoryFieldsErrors = {
8459
8361
  /**
@@ -8475,7 +8377,7 @@ export type LoyaltyGetGroupsData = {
8475
8377
  body?: never;
8476
8378
  path?: never;
8477
8379
  query?: never;
8478
- url: '/loyalty/groups';
8380
+ url: '/v1/loyalty/groups';
8479
8381
  };
8480
8382
  export type LoyaltyGetGroupsErrors = {
8481
8383
  /**
@@ -8506,7 +8408,7 @@ export type LoyaltyGetCardImageData = {
8506
8408
  cardNumber: string;
8507
8409
  };
8508
8410
  query?: never;
8509
- url: '/loyalty/image/{cardNumber}';
8411
+ url: '/v1/loyalty/image/{cardNumber}';
8510
8412
  };
8511
8413
  export type LoyaltyGetCardImageErrors = {
8512
8414
  /**
@@ -8541,7 +8443,7 @@ export type LoyaltyGetMemberGroupsData = {
8541
8443
  body?: never;
8542
8444
  path?: never;
8543
8445
  query?: never;
8544
- url: '/loyalty/membergroups';
8446
+ url: '/v1/loyalty/membergroups';
8545
8447
  };
8546
8448
  export type LoyaltyGetMemberGroupsErrors = {
8547
8449
  /**
@@ -8591,7 +8493,7 @@ export type LoyaltyCreatePointsTransactionData = {
8591
8493
  };
8592
8494
  path?: never;
8593
8495
  query?: never;
8594
- url: '/loyalty/points';
8496
+ url: '/v1/loyalty/points';
8595
8497
  };
8596
8498
  export type LoyaltyCreatePointsTransactionErrors = {
8597
8499
  /**
@@ -8624,7 +8526,7 @@ export type LoyaltyGetCardRecoveryData = {
8624
8526
  cardNumber: string;
8625
8527
  };
8626
8528
  query?: never;
8627
- url: '/loyalty/recover/{cardNumber}';
8529
+ url: '/v1/loyalty/recover/{cardNumber}';
8628
8530
  };
8629
8531
  export type LoyaltyGetCardRecoveryErrors = {
8630
8532
  /**
@@ -8662,7 +8564,7 @@ export type LoyaltySearchCardsData = {
8662
8564
  */
8663
8565
  limit?: number;
8664
8566
  };
8665
- url: '/loyalty/search/{command}';
8567
+ url: '/v1/loyalty/search/{command}';
8666
8568
  };
8667
8569
  export type LoyaltySearchCardsErrors = {
8668
8570
  /**
@@ -8686,7 +8588,7 @@ export type LoyaltyGetSettingsData = {
8686
8588
  body?: never;
8687
8589
  path?: never;
8688
8590
  query?: never;
8689
- url: '/loyalty/settings';
8591
+ url: '/v1/loyalty/settings';
8690
8592
  };
8691
8593
  export type LoyaltyGetSettingsErrors = {
8692
8594
  /**
@@ -8706,7 +8608,7 @@ export type LoyaltyGetSyncListData = {
8706
8608
  body?: never;
8707
8609
  path?: never;
8708
8610
  query?: never;
8709
- url: '/loyalty/syncList';
8611
+ url: '/v1/loyalty/syncList';
8710
8612
  };
8711
8613
  export type LoyaltyGetSyncListErrors = {
8712
8614
  /**
@@ -8743,7 +8645,7 @@ export type LoyaltyUpdateSyncListData = {
8743
8645
  };
8744
8646
  path?: never;
8745
8647
  query?: never;
8746
- url: '/loyalty/syncList';
8648
+ url: '/v1/loyalty/syncList';
8747
8649
  };
8748
8650
  export type LoyaltyUpdateSyncListErrors = {
8749
8651
  /**
@@ -8775,7 +8677,7 @@ export type LoyaltyGetSyncListByCommandData = {
8775
8677
  command: string;
8776
8678
  };
8777
8679
  query?: never;
8778
- url: '/loyalty/syncList/{command}';
8680
+ url: '/v1/loyalty/syncList/{command}';
8779
8681
  };
8780
8682
  export type LoyaltyGetSyncListByCommandErrors = {
8781
8683
  /**
@@ -8807,7 +8709,7 @@ export type LoyaltyVerifyCardData = {
8807
8709
  body: VerifyCardRequest;
8808
8710
  path?: never;
8809
8711
  query?: never;
8810
- url: '/loyalty/verify';
8712
+ url: '/v1/loyalty/verify';
8811
8713
  };
8812
8714
  export type LoyaltyVerifyCardErrors = {
8813
8715
  /**
@@ -8833,7 +8735,7 @@ export type LoyaltyGetWalletLinkData = {
8833
8735
  cardNumber: string;
8834
8736
  };
8835
8737
  query?: never;
8836
- url: '/loyalty/wallet/{cardNumber}';
8738
+ url: '/v1/loyalty/wallet/{cardNumber}';
8837
8739
  };
8838
8740
  export type LoyaltyGetWalletLinkErrors = {
8839
8741
  /**
@@ -8864,7 +8766,7 @@ export type MembershipCreateMemberData = {
8864
8766
  body: MemberCreateRequest;
8865
8767
  path?: never;
8866
8768
  query?: never;
8867
- url: '/membership';
8769
+ url: '/v1/membership';
8868
8770
  };
8869
8771
  export type MembershipCreateMemberErrors = {
8870
8772
  /**
@@ -8888,7 +8790,7 @@ export type MembershipGetAllowedFunctionsData = {
8888
8790
  body?: never;
8889
8791
  path?: never;
8890
8792
  query?: never;
8891
- url: '/membership/allowedFunctions';
8793
+ url: '/v1/membership/allowedFunctions';
8892
8794
  };
8893
8795
  export type MembershipGetAllowedFunctionsErrors = {
8894
8796
  /**
@@ -8910,7 +8812,7 @@ export type MembershipGetMemberByCardData = {
8910
8812
  cardNumber: string;
8911
8813
  };
8912
8814
  query?: never;
8913
- url: '/membership/card/{cardNumber}';
8815
+ url: '/v1/membership/card/{cardNumber}';
8914
8816
  };
8915
8817
  export type MembershipGetMemberByCardErrors = {
8916
8818
  /**
@@ -8936,7 +8838,7 @@ export type MembershipUpdateMemberByCardData = {
8936
8838
  cardNumber: string;
8937
8839
  };
8938
8840
  query?: never;
8939
- url: '/membership/card/{cardNumber}';
8841
+ url: '/v1/membership/card/{cardNumber}';
8940
8842
  };
8941
8843
  export type MembershipUpdateMemberByCardErrors = {
8942
8844
  /**
@@ -8964,7 +8866,7 @@ export type MembershipGetMemberGroupsData = {
8964
8866
  body?: never;
8965
8867
  path?: never;
8966
8868
  query?: never;
8967
- url: '/membership/groups';
8869
+ url: '/v1/membership/groups';
8968
8870
  };
8969
8871
  export type MembershipGetMemberGroupsErrors = {
8970
8872
  /**
@@ -8990,7 +8892,7 @@ export type MembershipGetMemberData = {
8990
8892
  memberNumber: string;
8991
8893
  };
8992
8894
  query?: never;
8993
- url: '/membership/member/{memberNumber}';
8895
+ url: '/v1/membership/member/{memberNumber}';
8994
8896
  };
8995
8897
  export type MembershipGetMemberErrors = {
8996
8898
  /**
@@ -9016,7 +8918,7 @@ export type MembershipUpdateMemberData = {
9016
8918
  memberNumber: string;
9017
8919
  };
9018
8920
  query?: never;
9019
- url: '/membership/member/{memberNumber}';
8921
+ url: '/v1/membership/member/{memberNumber}';
9020
8922
  };
9021
8923
  export type MembershipUpdateMemberErrors = {
9022
8924
  /**
@@ -9046,7 +8948,7 @@ export type MembershipActivateMemberData = {
9046
8948
  memberNumber: string;
9047
8949
  };
9048
8950
  query?: never;
9049
- url: '/membership/member/{memberNumber}/activate';
8951
+ url: '/v1/membership/member/{memberNumber}/activate';
9050
8952
  };
9051
8953
  export type MembershipActivateMemberErrors = {
9052
8954
  /**
@@ -9076,7 +8978,7 @@ export type MembershipUpdateMemberAddressData = {
9076
8978
  memberNumber: string;
9077
8979
  };
9078
8980
  query?: never;
9079
- url: '/membership/member/{memberNumber}/address';
8981
+ url: '/v1/membership/member/{memberNumber}/address';
9080
8982
  };
9081
8983
  export type MembershipUpdateMemberAddressErrors = {
9082
8984
  /**
@@ -9106,7 +9008,7 @@ export type MembershipUpdateBillingAddressData = {
9106
9008
  memberNumber: string;
9107
9009
  };
9108
9010
  query?: never;
9109
- url: '/membership/member/{memberNumber}/billingaddress';
9011
+ url: '/v1/membership/member/{memberNumber}/billingaddress';
9110
9012
  };
9111
9013
  export type MembershipUpdateBillingAddressErrors = {
9112
9014
  /**
@@ -9136,7 +9038,7 @@ export type MembershipCancelMemberData = {
9136
9038
  memberNumber: string;
9137
9039
  };
9138
9040
  query?: never;
9139
- url: '/membership/member/{memberNumber}/cancel';
9041
+ url: '/v1/membership/member/{memberNumber}/cancel';
9140
9042
  };
9141
9043
  export type MembershipCancelMemberErrors = {
9142
9044
  /**
@@ -9166,7 +9068,7 @@ export type MembershipReplaceCreditCardData = {
9166
9068
  memberNumber: string;
9167
9069
  };
9168
9070
  query?: never;
9169
- url: '/membership/member/{memberNumber}/replacecreditcard';
9071
+ url: '/v1/membership/member/{memberNumber}/replacecreditcard';
9170
9072
  };
9171
9073
  export type MembershipReplaceCreditCardErrors = {
9172
9074
  /**
@@ -9196,7 +9098,7 @@ export type MembershipUpdateShippingAddressData = {
9196
9098
  memberNumber: string;
9197
9099
  };
9198
9100
  query?: never;
9199
- url: '/membership/member/{memberNumber}/shippingaddress';
9101
+ url: '/v1/membership/member/{memberNumber}/shippingaddress';
9200
9102
  };
9201
9103
  export type MembershipUpdateShippingAddressErrors = {
9202
9104
  /**
@@ -9226,7 +9128,7 @@ export type MembershipSuspendMemberData = {
9226
9128
  memberNumber: string;
9227
9129
  };
9228
9130
  query?: never;
9229
- url: '/membership/member/{memberNumber}/suspend';
9131
+ url: '/v1/membership/member/{memberNumber}/suspend';
9230
9132
  };
9231
9133
  export type MembershipSuspendMemberErrors = {
9232
9134
  /**
@@ -9256,7 +9158,7 @@ export type MembershipUpdateMemberTokenData = {
9256
9158
  memberNumber: string;
9257
9159
  };
9258
9160
  query?: never;
9259
- url: '/membership/member/{memberNumber}/token';
9161
+ url: '/v1/membership/member/{memberNumber}/token';
9260
9162
  };
9261
9163
  export type MembershipUpdateMemberTokenErrors = {
9262
9164
  /**
@@ -9284,7 +9186,7 @@ export type MembershipGetMemberGroupsAltData = {
9284
9186
  body?: never;
9285
9187
  path?: never;
9286
9188
  query?: never;
9287
- url: '/membership/membergroups';
9189
+ url: '/v1/membership/membergroups';
9288
9190
  };
9289
9191
  export type MembershipGetMemberGroupsAltErrors = {
9290
9192
  /**
@@ -9312,7 +9214,7 @@ export type MembershipSearchMembersData = {
9312
9214
  query: {
9313
9215
  q: string;
9314
9216
  };
9315
- url: '/membership/search/{command}';
9217
+ url: '/v1/membership/search/{command}';
9316
9218
  };
9317
9219
  export type MembershipSearchMembersErrors = {
9318
9220
  /**
@@ -9336,7 +9238,7 @@ export type OfferCreateData = {
9336
9238
  body: OfferCreateRequest;
9337
9239
  path?: never;
9338
9240
  query?: never;
9339
- url: '/offer';
9241
+ url: '/v1/offer';
9340
9242
  };
9341
9243
  export type OfferCreateErrors = {
9342
9244
  /**
@@ -9373,7 +9275,7 @@ export type OfferRedemptionsListData = {
9373
9275
  */
9374
9276
  to_date?: ApiDate;
9375
9277
  };
9376
- url: '/offer-redemptions';
9278
+ url: '/v1/offer-redemptions';
9377
9279
  };
9378
9280
  export type OfferRedemptionsListErrors = {
9379
9281
  /**
@@ -9411,7 +9313,7 @@ export type OfferGetCoffeeCardStatsData = {
9411
9313
  */
9412
9314
  site?: number;
9413
9315
  };
9414
- url: '/offer/coffeecard/{cardNumber}';
9316
+ url: '/v1/offer/coffeecard/{cardNumber}';
9415
9317
  };
9416
9318
  export type OfferGetCoffeeCardStatsErrors = {
9417
9319
  /**
@@ -9455,7 +9357,7 @@ export type OfferListData = {
9455
9357
  */
9456
9358
  total?: number;
9457
9359
  };
9458
- url: '/offer/list/{cardNumber}';
9360
+ url: '/v1/offer/list/{cardNumber}';
9459
9361
  };
9460
9362
  export type OfferListErrors = {
9461
9363
  /**
@@ -9484,7 +9386,7 @@ export type OfferDeleteData = {
9484
9386
  offerId: number;
9485
9387
  };
9486
9388
  query?: never;
9487
- url: '/offer/{offerId}';
9389
+ url: '/v1/offer/{offerId}';
9488
9390
  };
9489
9391
  export type OfferDeleteErrors = {
9490
9392
  /**
@@ -9513,7 +9415,7 @@ export type OfferUpdateData = {
9513
9415
  offerId: number;
9514
9416
  };
9515
9417
  query?: never;
9516
- url: '/offer/{offerId}';
9418
+ url: '/v1/offer/{offerId}';
9517
9419
  };
9518
9420
  export type OfferUpdateErrors = {
9519
9421
  /**
@@ -9537,7 +9439,7 @@ export type OrderDeleteOrderData = {
9537
9439
  body: OrderDeleteRequest;
9538
9440
  path?: never;
9539
9441
  query?: never;
9540
- url: '/order';
9442
+ url: '/v1/order';
9541
9443
  };
9542
9444
  export type OrderDeleteOrderErrors = {
9543
9445
  /**
@@ -9561,7 +9463,7 @@ export type OrderCreateOrderData = {
9561
9463
  body: OrderCreateRequest;
9562
9464
  path?: never;
9563
9465
  query?: never;
9564
- url: '/order';
9466
+ url: '/v1/order';
9565
9467
  };
9566
9468
  export type OrderCreateOrderErrors = {
9567
9469
  /**
@@ -9585,7 +9487,7 @@ export type OrderGetAllowedFunctionsData = {
9585
9487
  body?: never;
9586
9488
  path?: never;
9587
9489
  query?: never;
9588
- url: '/order/allowedFunctions';
9490
+ url: '/v1/order/allowedFunctions';
9589
9491
  };
9590
9492
  export type OrderGetAllowedFunctionsErrors = {
9591
9493
  /**
@@ -9612,7 +9514,7 @@ export type OrderSearchOrdersData = {
9612
9514
  site: number;
9613
9515
  };
9614
9516
  query?: never;
9615
- url: '/order/search/{command}/{query}/{site}';
9517
+ url: '/v1/order/search/{command}/{query}/{site}';
9616
9518
  };
9617
9519
  export type OrderSearchOrdersErrors = {
9618
9520
  /**
@@ -9639,7 +9541,7 @@ export type OrderGetOrderData = {
9639
9541
  site: number;
9640
9542
  };
9641
9543
  query?: never;
9642
- url: '/order/{orderNumber}/{site}';
9544
+ url: '/v1/order/{orderNumber}/{site}';
9643
9545
  };
9644
9546
  export type OrderGetOrderErrors = {
9645
9547
  /**
@@ -9663,7 +9565,7 @@ export type PingPingData = {
9663
9565
  body?: never;
9664
9566
  path?: never;
9665
9567
  query?: never;
9666
- url: '/ping';
9568
+ url: '/v1/ping';
9667
9569
  };
9668
9570
  export type PingPingErrors = {
9669
9571
  /**
@@ -9687,7 +9589,7 @@ export type SitesGetSitesData = {
9687
9589
  body?: never;
9688
9590
  path?: never;
9689
9591
  query?: never;
9690
- url: '/sites';
9592
+ url: '/v1/sites';
9691
9593
  };
9692
9594
  export type SitesGetSitesErrors = {
9693
9595
  /**
@@ -9711,7 +9613,7 @@ export type StripeGetStripeConfigData = {
9711
9613
  body?: never;
9712
9614
  path?: never;
9713
9615
  query?: never;
9714
- url: '/stripe';
9616
+ url: '/v1/stripe';
9715
9617
  };
9716
9618
  export type StripeGetStripeConfigErrors = {
9717
9619
  /**
@@ -9760,7 +9662,7 @@ export type TransactionGetTransactionData = {
9760
9662
  */
9761
9663
  format?: 'event';
9762
9664
  };
9763
- url: '/transaction';
9665
+ url: '/v1/transaction';
9764
9666
  };
9765
9667
  export type TransactionGetTransactionErrors = {
9766
9668
  /**
@@ -9788,7 +9690,7 @@ export type TransactionCreateTransactionData = {
9788
9690
  body: TransactionCreateRequest;
9789
9691
  path?: never;
9790
9692
  query?: never;
9791
- url: '/transaction';
9693
+ url: '/v1/transaction';
9792
9694
  };
9793
9695
  export type TransactionCreateTransactionErrors = {
9794
9696
  /**
@@ -9808,11 +9710,86 @@ export type TransactionCreateTransactionResponses = {
9808
9710
  200: TransactionCreateSuccessResponse | TransactionCreateErrorResponse;
9809
9711
  };
9810
9712
  export type TransactionCreateTransactionResponse = TransactionCreateTransactionResponses[keyof TransactionCreateTransactionResponses];
9713
+ export type TransactionLookupSearchJournalsData = {
9714
+ body?: never;
9715
+ path?: never;
9716
+ query: {
9717
+ /**
9718
+ * Journal number to search for
9719
+ */
9720
+ journal: string;
9721
+ /**
9722
+ * Optional site code to narrow results
9723
+ */
9724
+ site?: number;
9725
+ /**
9726
+ * Optional start date filter (Y-m-d)
9727
+ */
9728
+ date_from?: ApiDate;
9729
+ /**
9730
+ * Optional end date filter (Y-m-d)
9731
+ */
9732
+ date_to?: ApiDate;
9733
+ };
9734
+ url: '/v1/transaction-lookup';
9735
+ };
9736
+ export type TransactionLookupSearchJournalsErrors = {
9737
+ /**
9738
+ * The server could not understand the request due to invalid syntax.
9739
+ */
9740
+ 400: ValidationError;
9741
+ /**
9742
+ * Access is unauthorized.
9743
+ */
9744
+ 401: InvalidAccessKeyError;
9745
+ };
9746
+ export type TransactionLookupSearchJournalsError = TransactionLookupSearchJournalsErrors[keyof TransactionLookupSearchJournalsErrors];
9747
+ export type TransactionLookupSearchJournalsResponses = {
9748
+ /**
9749
+ * The request has succeeded.
9750
+ */
9751
+ 200: JournalLookupSearchResponse;
9752
+ };
9753
+ export type TransactionLookupSearchJournalsResponse = TransactionLookupSearchJournalsResponses[keyof TransactionLookupSearchJournalsResponses];
9754
+ export type TransactionLookupDetailGetJournalByIdData = {
9755
+ body?: never;
9756
+ path: {
9757
+ /**
9758
+ * Journal ID (JOURNALTRACK.ID from search results)
9759
+ */
9760
+ id: number;
9761
+ };
9762
+ query?: {
9763
+ /**
9764
+ * Response format
9765
+ */
9766
+ format?: 'json' | 'event' | 'xml';
9767
+ };
9768
+ url: '/v1/transaction-lookup/{id}';
9769
+ };
9770
+ export type TransactionLookupDetailGetJournalByIdErrors = {
9771
+ /**
9772
+ * Access is unauthorized.
9773
+ */
9774
+ 401: InvalidAccessKeyError;
9775
+ /**
9776
+ * The server cannot find the requested resource.
9777
+ */
9778
+ 404: ZenNotFoundError;
9779
+ };
9780
+ export type TransactionLookupDetailGetJournalByIdError = TransactionLookupDetailGetJournalByIdErrors[keyof TransactionLookupDetailGetJournalByIdErrors];
9781
+ export type TransactionLookupDetailGetJournalByIdResponses = {
9782
+ /**
9783
+ * The request has succeeded.
9784
+ */
9785
+ 200: TransactionResponse | TransactionEventResponse;
9786
+ };
9787
+ export type TransactionLookupDetailGetJournalByIdResponse = TransactionLookupDetailGetJournalByIdResponses[keyof TransactionLookupDetailGetJournalByIdResponses];
9811
9788
  export type EmailValidationValidateEmailData = {
9812
9789
  body: EmailValidationRequest;
9813
9790
  path?: never;
9814
9791
  query?: never;
9815
- url: '/validate-email';
9792
+ url: '/v1/validate-email';
9816
9793
  };
9817
9794
  export type EmailValidationValidateEmailErrors = {
9818
9795
  /**
@@ -9840,7 +9817,7 @@ export type VersionGetVersionData = {
9840
9817
  body?: never;
9841
9818
  path?: never;
9842
9819
  query?: never;
9843
- url: '/version';
9820
+ url: '/v1/version';
9844
9821
  };
9845
9822
  export type VersionGetVersionErrors = {
9846
9823
  /**
@@ -9870,7 +9847,7 @@ export type VoucherDeleteVoucherData = {
9870
9847
  voucherType: string;
9871
9848
  };
9872
9849
  query?: never;
9873
- url: '/voucher/{voucherType}';
9850
+ url: '/v1/voucher/{voucherType}';
9874
9851
  };
9875
9852
  export type VoucherDeleteVoucherErrors = {
9876
9853
  /**
@@ -9896,7 +9873,7 @@ export type VoucherGetVoucherTypeData = {
9896
9873
  voucherType: string;
9897
9874
  };
9898
9875
  query?: never;
9899
- url: '/voucher/{voucherType}';
9876
+ url: '/v1/voucher/{voucherType}';
9900
9877
  };
9901
9878
  export type VoucherGetVoucherTypeErrors = {
9902
9879
  /**
@@ -9922,7 +9899,7 @@ export type VoucherCreateVoucherData = {
9922
9899
  voucherType: string;
9923
9900
  };
9924
9901
  query?: never;
9925
- url: '/voucher/{voucherType}/create';
9902
+ url: '/v1/voucher/{voucherType}/create';
9926
9903
  };
9927
9904
  export type VoucherCreateVoucherErrors = {
9928
9905
  /**
@@ -9948,7 +9925,7 @@ export type VoucherEnquireVoucherData = {
9948
9925
  voucherType: string;
9949
9926
  };
9950
9927
  query?: never;
9951
- url: '/voucher/{voucherType}/enquire';
9928
+ url: '/v1/voucher/{voucherType}/enquire';
9952
9929
  };
9953
9930
  export type VoucherEnquireVoucherErrors = {
9954
9931
  /**
@@ -9979,7 +9956,7 @@ export type VoucherGetVoucherImageData = {
9979
9956
  serialNumber: string;
9980
9957
  };
9981
9958
  query?: never;
9982
- url: '/voucher/{voucherType}/image/{serialNumber}';
9959
+ url: '/v1/voucher/{voucherType}/image/{serialNumber}';
9983
9960
  };
9984
9961
  export type VoucherGetVoucherImageErrors = {
9985
9962
  /**
@@ -10005,7 +9982,7 @@ export type VoucherRechargeVoucherData = {
10005
9982
  voucherType: string;
10006
9983
  };
10007
9984
  query?: never;
10008
- url: '/voucher/{voucherType}/recharge';
9985
+ url: '/v1/voucher/{voucherType}/recharge';
10009
9986
  };
10010
9987
  export type VoucherRechargeVoucherErrors = {
10011
9988
  /**
@@ -10035,7 +10012,7 @@ export type VoucherRedeemVoucherData = {
10035
10012
  voucherType: string;
10036
10013
  };
10037
10014
  query?: never;
10038
- url: '/voucher/{voucherType}/redeem';
10015
+ url: '/v1/voucher/{voucherType}/redeem';
10039
10016
  };
10040
10017
  export type VoucherRedeemVoucherErrors = {
10041
10018
  /**
@@ -10065,7 +10042,7 @@ export type VoucherReleaseVoucherData = {
10065
10042
  voucherType: string;
10066
10043
  };
10067
10044
  query?: never;
10068
- url: '/voucher/{voucherType}/release';
10045
+ url: '/v1/voucher/{voucherType}/release';
10069
10046
  };
10070
10047
  export type VoucherReleaseVoucherErrors = {
10071
10048
  /**
@@ -10095,7 +10072,7 @@ export type VoucherReserveVoucherData = {
10095
10072
  voucherType: string;
10096
10073
  };
10097
10074
  query?: never;
10098
- url: '/voucher/{voucherType}/reserve';
10075
+ url: '/v1/voucher/{voucherType}/reserve';
10099
10076
  };
10100
10077
  export type VoucherReserveVoucherErrors = {
10101
10078
  /**
@@ -10128,7 +10105,7 @@ export type VoucherSearchVouchersData = {
10128
10105
  query: {
10129
10106
  q: string;
10130
10107
  };
10131
- url: '/voucher/{voucherType}/search/{searchBy}';
10108
+ url: '/v1/voucher/{voucherType}/search/{searchBy}';
10132
10109
  };
10133
10110
  export type VoucherSearchVouchersErrors = {
10134
10111
  /**
@@ -10157,7 +10134,7 @@ export type VoucherSearchVouchersFlatData = {
10157
10134
  query: {
10158
10135
  q: string;
10159
10136
  };
10160
- url: '/voucher/{voucherType}/search2/{searchBy}';
10137
+ url: '/v1/voucher/{voucherType}/search2/{searchBy}';
10161
10138
  };
10162
10139
  export type VoucherSearchVouchersFlatErrors = {
10163
10140
  /**
@@ -10177,4 +10154,35 @@ export type VoucherSearchVouchersFlatResponses = {
10177
10154
  200: VoucherFlatSearchResponse;
10178
10155
  };
10179
10156
  export type VoucherSearchVouchersFlatResponse = VoucherSearchVouchersFlatResponses[keyof VoucherSearchVouchersFlatResponses];
10157
+ export type CustomerDeleteData = {
10158
+ body?: never;
10159
+ path: {
10160
+ /**
10161
+ * Unique customer identifier.
10162
+ */
10163
+ customer_id: number;
10164
+ };
10165
+ query?: never;
10166
+ url: '/v2/customer/{customer_id}';
10167
+ };
10168
+ export type CustomerDeleteResponses = {
10169
+ /**
10170
+ * There is no content to send for this request, but the headers may be useful.
10171
+ */
10172
+ 204: void;
10173
+ };
10174
+ export type CustomerDeleteResponse = CustomerDeleteResponses[keyof CustomerDeleteResponses];
10175
+ export type PingV2ShowData = {
10176
+ body?: never;
10177
+ path?: never;
10178
+ query?: never;
10179
+ url: '/v2/ping';
10180
+ };
10181
+ export type PingV2ShowResponses = {
10182
+ /**
10183
+ * The request has succeeded.
10184
+ */
10185
+ 200: PingV2PingResult;
10186
+ };
10187
+ export type PingV2ShowResponse = PingV2ShowResponses[keyof PingV2ShowResponses];
10180
10188
  //# sourceMappingURL=types.gen.d.ts.map