@vrplatform/api 1.3.1-3874 → 1.3.1-3893

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.
@@ -624,6 +624,23 @@ export interface paths {
624
624
  patch?: never;
625
625
  trace?: never;
626
626
  };
627
+ "/connections/pms-cutover/listing-mappings": {
628
+ parameters: {
629
+ query?: never;
630
+ header?: never;
631
+ path?: never;
632
+ cookie?: never;
633
+ };
634
+ /** @description Retrieve PMS migration cutover target listing refs that need mapping, suggested source listings, and the source listing pool */
635
+ get: operations["getPmsConnectionCutoverListingMappings"];
636
+ put?: never;
637
+ post?: never;
638
+ delete?: never;
639
+ options?: never;
640
+ head?: never;
641
+ patch?: never;
642
+ trace?: never;
643
+ };
627
644
  "/connections/pms-cutover/preview": {
628
645
  parameters: {
629
646
  query?: never;
@@ -2730,6 +2747,23 @@ export interface paths {
2730
2747
  patch?: never;
2731
2748
  trace?: never;
2732
2749
  };
2750
+ "/statements/historic": {
2751
+ parameters: {
2752
+ query?: never;
2753
+ header?: never;
2754
+ path?: never;
2755
+ cookie?: never;
2756
+ };
2757
+ get?: never;
2758
+ put?: never;
2759
+ /** @description Import a historic owner statement with journal entries on the historical ledger; re-posting the same uniqueRef replaces the previous import */
2760
+ post: operations["postStatementsHistoric"];
2761
+ delete?: never;
2762
+ options?: never;
2763
+ head?: never;
2764
+ patch?: never;
2765
+ trace?: never;
2766
+ };
2733
2767
  "/statements/layouts": {
2734
2768
  parameters: {
2735
2769
  query?: never;
@@ -4917,8 +4951,8 @@ export interface operations {
4917
4951
  requestBody?: {
4918
4952
  content: {
4919
4953
  "application/json": {
4920
- startingBalanceDate?: string | null;
4921
- startingBalanceAmount?: number | null;
4954
+ startingBalanceDate: string;
4955
+ startingBalanceAmount: number;
4922
4956
  };
4923
4957
  };
4924
4958
  };
@@ -7542,6 +7576,7 @@ export interface operations {
7542
7576
  status: "active" | "inactive";
7543
7577
  uniqueRef?: string | null;
7544
7578
  appId: string;
7579
+ icon?: string | null;
7545
7580
  } | null;
7546
7581
  source?: {
7547
7582
  /** Format: uuid */
@@ -11547,6 +11582,11 @@ export interface operations {
11547
11582
  /** Format: uuid */
11548
11583
  targetConnectionId: string;
11549
11584
  cutoverAt: string;
11585
+ listingMappings?: {
11586
+ /** Format: uuid */
11587
+ targetListingConnectionId: string;
11588
+ sourceListingId: string | null;
11589
+ }[];
11550
11590
  };
11551
11591
  };
11552
11592
  };
@@ -11685,6 +11725,132 @@ export interface operations {
11685
11725
  };
11686
11726
  };
11687
11727
  };
11728
+ getPmsConnectionCutoverListingMappings: {
11729
+ parameters: {
11730
+ query: {
11731
+ sourceConnectionId: string;
11732
+ targetConnectionId: string;
11733
+ };
11734
+ header?: never;
11735
+ path?: never;
11736
+ cookie?: never;
11737
+ };
11738
+ requestBody?: never;
11739
+ responses: {
11740
+ /** @description Successful response */
11741
+ 200: {
11742
+ headers: {
11743
+ [name: string]: unknown;
11744
+ };
11745
+ content: {
11746
+ "application/json": {
11747
+ sourceListings: {
11748
+ /** Format: uuid */
11749
+ id: string;
11750
+ name: string;
11751
+ address: string | null;
11752
+ }[];
11753
+ targetListings: {
11754
+ /** Format: uuid */
11755
+ targetListingConnectionId: string;
11756
+ uniqueRef: string | null;
11757
+ name: string;
11758
+ address: string | null;
11759
+ listingId: string | null;
11760
+ /** @enum {string} */
11761
+ status: "alreadyShared" | "matched" | "ambiguous" | "unmapped";
11762
+ suggestedListing: {
11763
+ /** Format: uuid */
11764
+ id: string;
11765
+ name: string;
11766
+ address: string | null;
11767
+ } | null;
11768
+ }[];
11769
+ };
11770
+ };
11771
+ };
11772
+ /** @description Bad request */
11773
+ 400: {
11774
+ headers: {
11775
+ [name: string]: unknown;
11776
+ };
11777
+ content: {
11778
+ "application/json": {
11779
+ code: string;
11780
+ message: string;
11781
+ issues?: {
11782
+ message: string;
11783
+ }[];
11784
+ context?: unknown;
11785
+ };
11786
+ };
11787
+ };
11788
+ /** @description Unauthorized */
11789
+ 401: {
11790
+ headers: {
11791
+ [name: string]: unknown;
11792
+ };
11793
+ content: {
11794
+ "application/json": {
11795
+ code: string;
11796
+ message: string;
11797
+ issues?: {
11798
+ message: string;
11799
+ }[];
11800
+ context?: unknown;
11801
+ };
11802
+ };
11803
+ };
11804
+ /** @description Forbidden */
11805
+ 403: {
11806
+ headers: {
11807
+ [name: string]: unknown;
11808
+ };
11809
+ content: {
11810
+ "application/json": {
11811
+ code: string;
11812
+ message: string;
11813
+ issues?: {
11814
+ message: string;
11815
+ }[];
11816
+ context?: unknown;
11817
+ };
11818
+ };
11819
+ };
11820
+ /** @description Not found */
11821
+ 404: {
11822
+ headers: {
11823
+ [name: string]: unknown;
11824
+ };
11825
+ content: {
11826
+ "application/json": {
11827
+ code: string;
11828
+ message: string;
11829
+ issues?: {
11830
+ message: string;
11831
+ }[];
11832
+ context?: unknown;
11833
+ };
11834
+ };
11835
+ };
11836
+ /** @description Internal server error */
11837
+ 500: {
11838
+ headers: {
11839
+ [name: string]: unknown;
11840
+ };
11841
+ content: {
11842
+ "application/json": {
11843
+ code: string;
11844
+ message: string;
11845
+ issues?: {
11846
+ message: string;
11847
+ }[];
11848
+ context?: unknown;
11849
+ };
11850
+ };
11851
+ };
11852
+ };
11853
+ };
11688
11854
  previewPmsConnectionCutover: {
11689
11855
  parameters: {
11690
11856
  query?: never;
@@ -11700,6 +11866,11 @@ export interface operations {
11700
11866
  /** Format: uuid */
11701
11867
  targetConnectionId: string;
11702
11868
  cutoverAt: string;
11869
+ listingMappings?: {
11870
+ /** Format: uuid */
11871
+ targetListingConnectionId: string;
11872
+ sourceListingId: string | null;
11873
+ }[];
11703
11874
  };
11704
11875
  };
11705
11876
  };
@@ -24251,7 +24422,7 @@ export interface operations {
24251
24422
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
24252
24423
  taxRateId?: string | null;
24253
24424
  taxBehavior?: ("excluded" | "included") | null;
24254
- revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
24425
+ revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
24255
24426
  status?: ("active" | "inactive") | null;
24256
24427
  rateType?: ("flat" | "percentage") | null;
24257
24428
  creditAccountId?: string | null;
@@ -24977,7 +25148,7 @@ export interface operations {
24977
25148
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
24978
25149
  taxRateId?: string | null;
24979
25150
  taxBehavior?: ("excluded" | "included") | null;
24980
- revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
25151
+ revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
24981
25152
  status?: ("active" | "inactive") | null;
24982
25153
  rateType?: ("flat" | "percentage") | null;
24983
25154
  creditAccountId?: string | null;
@@ -25424,7 +25595,7 @@ export interface operations {
25424
25595
  type?: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
25425
25596
  taxRateId?: string | null;
25426
25597
  taxBehavior?: ("excluded" | "included") | null;
25427
- revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
25598
+ revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
25428
25599
  status?: ("active" | "inactive") | null;
25429
25600
  rateType?: ("flat" | "percentage") | null;
25430
25601
  creditAccountId?: string | null;
@@ -36747,7 +36918,7 @@ export interface operations {
36747
36918
  type: string;
36748
36919
  description?: string | null;
36749
36920
  accountId?: string | null;
36750
- revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
36921
+ revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
36751
36922
  };
36752
36923
  };
36753
36924
  };
@@ -36991,11 +37162,11 @@ export interface operations {
36991
37162
  "application/json": {
36992
37163
  description?: string | null;
36993
37164
  accountId?: string | null;
36994
- revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
37165
+ revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
36995
37166
  channelMappings?: {
36996
37167
  bookingChannel: string;
36997
37168
  accountId?: string | null;
36998
- revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
37169
+ revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
36999
37170
  }[] | null;
37000
37171
  };
37001
37172
  };
@@ -43275,6 +43446,174 @@ export interface operations {
43275
43446
  };
43276
43447
  };
43277
43448
  };
43449
+ postStatementsHistoric: {
43450
+ parameters: {
43451
+ query?: never;
43452
+ header?: never;
43453
+ path?: never;
43454
+ cookie?: never;
43455
+ };
43456
+ requestBody?: {
43457
+ content: {
43458
+ "application/json": {
43459
+ /** @description Stable statement idempotency key; re-posting replaces */
43460
+ uniqueRef: string;
43461
+ /** Format: uuid */
43462
+ listingId: string;
43463
+ startAt: string;
43464
+ endAt: string;
43465
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
43466
+ currency: string;
43467
+ /**
43468
+ * @default published
43469
+ * @enum {string}
43470
+ */
43471
+ status?: "inReview" | "published";
43472
+ /** @description Value in cents (100 = 1€) */
43473
+ centBalanceStart?: number;
43474
+ /** @description Derived from balanceStart + net income + payouts when omitted */
43475
+ centBalanceEnd?: number;
43476
+ lines: {
43477
+ /** @description Stable per-line idempotency key within the team */
43478
+ uniqueRef: string;
43479
+ /**
43480
+ * @default line
43481
+ * @enum {string}
43482
+ */
43483
+ type?: "line" | "payout";
43484
+ /**
43485
+ * Format: uuid
43486
+ * @description Required for type=line; ignored for payouts
43487
+ */
43488
+ accountId?: string;
43489
+ /** @description Owner-facing amount: revenue positive, expenses negative; payout positive = paid to owner */
43490
+ centTotal: number;
43491
+ description?: string;
43492
+ /** @description Posting date; defaults to the day before endAt */
43493
+ date?: string;
43494
+ /** Format: uuid */
43495
+ reservationId?: string;
43496
+ /** Format: uuid */
43497
+ contactId?: string;
43498
+ }[];
43499
+ };
43500
+ };
43501
+ };
43502
+ responses: {
43503
+ /** @description Successful response */
43504
+ 200: {
43505
+ headers: {
43506
+ [name: string]: unknown;
43507
+ };
43508
+ content: {
43509
+ "application/json": {
43510
+ /** Format: uuid */
43511
+ id: string;
43512
+ uniqueRef: string;
43513
+ /** @enum {string} */
43514
+ status: "inReview" | "published";
43515
+ /** Format: uuid */
43516
+ listingId: string;
43517
+ /** Format: uuid */
43518
+ listingOwnershipPeriodId: string;
43519
+ startAt: string;
43520
+ endAt: string;
43521
+ currency: string;
43522
+ replaced: boolean;
43523
+ journalEntryCount: number;
43524
+ financials: {
43525
+ centBalanceStart: number;
43526
+ centBalanceEnd: number;
43527
+ centTotal: number;
43528
+ centExpenses: number;
43529
+ centNetRevenue: number;
43530
+ centTransfer: number;
43531
+ };
43532
+ };
43533
+ };
43534
+ };
43535
+ /** @description Bad request */
43536
+ 400: {
43537
+ headers: {
43538
+ [name: string]: unknown;
43539
+ };
43540
+ content: {
43541
+ "application/json": {
43542
+ code: string;
43543
+ message: string;
43544
+ issues?: {
43545
+ message: string;
43546
+ }[];
43547
+ context?: unknown;
43548
+ };
43549
+ };
43550
+ };
43551
+ /** @description Unauthorized */
43552
+ 401: {
43553
+ headers: {
43554
+ [name: string]: unknown;
43555
+ };
43556
+ content: {
43557
+ "application/json": {
43558
+ code: string;
43559
+ message: string;
43560
+ issues?: {
43561
+ message: string;
43562
+ }[];
43563
+ context?: unknown;
43564
+ };
43565
+ };
43566
+ };
43567
+ /** @description Forbidden */
43568
+ 403: {
43569
+ headers: {
43570
+ [name: string]: unknown;
43571
+ };
43572
+ content: {
43573
+ "application/json": {
43574
+ code: string;
43575
+ message: string;
43576
+ issues?: {
43577
+ message: string;
43578
+ }[];
43579
+ context?: unknown;
43580
+ };
43581
+ };
43582
+ };
43583
+ /** @description Not found */
43584
+ 404: {
43585
+ headers: {
43586
+ [name: string]: unknown;
43587
+ };
43588
+ content: {
43589
+ "application/json": {
43590
+ code: string;
43591
+ message: string;
43592
+ issues?: {
43593
+ message: string;
43594
+ }[];
43595
+ context?: unknown;
43596
+ };
43597
+ };
43598
+ };
43599
+ /** @description Internal server error */
43600
+ 500: {
43601
+ headers: {
43602
+ [name: string]: unknown;
43603
+ };
43604
+ content: {
43605
+ "application/json": {
43606
+ code: string;
43607
+ message: string;
43608
+ issues?: {
43609
+ message: string;
43610
+ }[];
43611
+ context?: unknown;
43612
+ };
43613
+ };
43614
+ };
43615
+ };
43616
+ };
43278
43617
  getStatementsLayouts: {
43279
43618
  parameters: {
43280
43619
  query?: {
@@ -49118,6 +49457,7 @@ export interface operations {
49118
49457
  } | null;
49119
49458
  phone?: string | null;
49120
49459
  email?: string | null;
49460
+ supportEmail?: string | null;
49121
49461
  taxId?: string | null;
49122
49462
  partner?: {
49123
49463
  /** Format: uuid */
@@ -49326,7 +49666,7 @@ export interface operations {
49326
49666
  "application/json": {
49327
49667
  defaultCurrency?: string | null;
49328
49668
  longTermStayNights?: number | null;
49329
- defaultRevenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
49669
+ defaultRevenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
49330
49670
  name: string;
49331
49671
  slug?: string;
49332
49672
  statementAddress?: {
@@ -49383,6 +49723,7 @@ export interface operations {
49383
49723
  }[] | null;
49384
49724
  /** Format: email */
49385
49725
  email: string;
49726
+ supportEmail?: string | null;
49386
49727
  };
49387
49728
  };
49388
49729
  };
@@ -49427,6 +49768,7 @@ export interface operations {
49427
49768
  } | null;
49428
49769
  phone?: string | null;
49429
49770
  email?: string | null;
49771
+ supportEmail?: string | null;
49430
49772
  taxId?: string | null;
49431
49773
  partner?: {
49432
49774
  /** Format: uuid */
@@ -50064,6 +50406,7 @@ export interface operations {
50064
50406
  } | null;
50065
50407
  phone?: string | null;
50066
50408
  email?: string | null;
50409
+ supportEmail?: string | null;
50067
50410
  taxId?: string | null;
50068
50411
  partner?: {
50069
50412
  /** Format: uuid */
@@ -50320,6 +50663,7 @@ export interface operations {
50320
50663
  } | null;
50321
50664
  phone?: string | null;
50322
50665
  email?: string | null;
50666
+ supportEmail?: string | null;
50323
50667
  taxId?: string | null;
50324
50668
  partner?: {
50325
50669
  /** Format: uuid */
@@ -50569,6 +50913,7 @@ export interface operations {
50569
50913
  } | null;
50570
50914
  phone?: string | null;
50571
50915
  email?: string | null;
50916
+ supportEmail?: string | null;
50572
50917
  taxId?: string | null;
50573
50918
  partner?: {
50574
50919
  /** Format: uuid */
@@ -52312,6 +52657,7 @@ export interface operations {
52312
52657
  } | null;
52313
52658
  phone?: string | null;
52314
52659
  email?: string | null;
52660
+ supportEmail?: string | null;
52315
52661
  taxId?: string | null;
52316
52662
  partner?: {
52317
52663
  /** Format: uuid */
@@ -52549,6 +52895,7 @@ export interface operations {
52549
52895
  } | null;
52550
52896
  phone?: string | null;
52551
52897
  email?: string | null;
52898
+ supportEmail?: string | null;
52552
52899
  taxId?: string | null;
52553
52900
  partner?: {
52554
52901
  /** Format: uuid */
@@ -52749,7 +53096,7 @@ export interface operations {
52749
53096
  "application/json": {
52750
53097
  defaultCurrency?: string | null;
52751
53098
  longTermStayNights?: number | null;
52752
- defaultRevenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
53099
+ defaultRevenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
52753
53100
  name?: string;
52754
53101
  slug?: string;
52755
53102
  statementAddress?: {
@@ -52794,6 +53141,7 @@ export interface operations {
52794
53141
  billingPartnerId?: string | null;
52795
53142
  /** Format: email */
52796
53143
  email?: string;
53144
+ supportEmail?: string | null;
52797
53145
  migratedFromTenantId?: string | null;
52798
53146
  settings?: {
52799
53147
  showReservations?: boolean;
@@ -52864,6 +53212,7 @@ export interface operations {
52864
53212
  } | null;
52865
53213
  phone?: string | null;
52866
53214
  email?: string | null;
53215
+ supportEmail?: string | null;
52867
53216
  taxId?: string | null;
52868
53217
  partner?: {
52869
53218
  /** Format: uuid */
@@ -53554,6 +53903,7 @@ export interface operations {
53554
53903
  } | null;
53555
53904
  phone?: string | null;
53556
53905
  email?: string | null;
53906
+ supportEmail?: string | null;
53557
53907
  taxId?: string | null;
53558
53908
  partner?: {
53559
53909
  /** Format: uuid */