@vrplatform/api 1.3.1-stage.1895 → 1.3.1-stage.1897

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.
@@ -856,6 +856,125 @@ export interface paths {
856
856
  patch?: never;
857
857
  trace?: never;
858
858
  };
859
+ "/metrics/active-listings": {
860
+ parameters: {
861
+ query?: never;
862
+ header?: never;
863
+ path?: never;
864
+ cookie?: never;
865
+ };
866
+ /** @description Active listings comparison metric */
867
+ get: operations["getMetricActiveListings"];
868
+ put?: never;
869
+ post?: never;
870
+ delete?: never;
871
+ options?: never;
872
+ head?: never;
873
+ patch?: never;
874
+ trace?: never;
875
+ };
876
+ "/metrics/average-daily-rate": {
877
+ parameters: {
878
+ query?: never;
879
+ header?: never;
880
+ path?: never;
881
+ cookie?: never;
882
+ };
883
+ /** @description Average daily rate comparison metric */
884
+ get: operations["getMetricAverageDailyRate"];
885
+ put?: never;
886
+ post?: never;
887
+ delete?: never;
888
+ options?: never;
889
+ head?: never;
890
+ patch?: never;
891
+ trace?: never;
892
+ };
893
+ "/metrics/cash-flow": {
894
+ parameters: {
895
+ query?: never;
896
+ header?: never;
897
+ path?: never;
898
+ cookie?: never;
899
+ };
900
+ /** @description Cash flow metric */
901
+ get: operations["getMetricCashFlow"];
902
+ put?: never;
903
+ post?: never;
904
+ delete?: never;
905
+ options?: never;
906
+ head?: never;
907
+ patch?: never;
908
+ trace?: never;
909
+ };
910
+ "/metrics/checkin-counts": {
911
+ parameters: {
912
+ query?: never;
913
+ header?: never;
914
+ path?: never;
915
+ cookie?: never;
916
+ };
917
+ /** @description Check-in count comparison metric */
918
+ get: operations["getMetricCheckinCounts"];
919
+ put?: never;
920
+ post?: never;
921
+ delete?: never;
922
+ options?: never;
923
+ head?: never;
924
+ patch?: never;
925
+ trace?: never;
926
+ };
927
+ "/metrics/future-booked-revenue": {
928
+ parameters: {
929
+ query?: never;
930
+ header?: never;
931
+ path?: never;
932
+ cookie?: never;
933
+ };
934
+ /** @description Future / booked revenue metric */
935
+ get: operations["getMetricFutureBookedRevenue"];
936
+ put?: never;
937
+ post?: never;
938
+ delete?: never;
939
+ options?: never;
940
+ head?: never;
941
+ patch?: never;
942
+ trace?: never;
943
+ };
944
+ "/metrics/occupancy-rate-over-time": {
945
+ parameters: {
946
+ query?: never;
947
+ header?: never;
948
+ path?: never;
949
+ cookie?: never;
950
+ };
951
+ /** @description Occupancy rate over time metric */
952
+ get: operations["getMetricOccupancyRateOverTime"];
953
+ put?: never;
954
+ post?: never;
955
+ delete?: never;
956
+ options?: never;
957
+ head?: never;
958
+ patch?: never;
959
+ trace?: never;
960
+ };
961
+ "/metrics/reservation-count": {
962
+ parameters: {
963
+ query?: never;
964
+ header?: never;
965
+ path?: never;
966
+ cookie?: never;
967
+ };
968
+ /** @description Reservation count comparison metric */
969
+ get: operations["getMetricReservationCount"];
970
+ put?: never;
971
+ post?: never;
972
+ delete?: never;
973
+ options?: never;
974
+ head?: never;
975
+ patch?: never;
976
+ trace?: never;
977
+ };
859
978
  "/metrics/reservation-volume": {
860
979
  parameters: {
861
980
  query?: never;
@@ -873,6 +992,23 @@ export interface paths {
873
992
  patch?: never;
874
993
  trace?: never;
875
994
  };
995
+ "/metrics/revenue": {
996
+ parameters: {
997
+ query?: never;
998
+ header?: never;
999
+ path?: never;
1000
+ cookie?: never;
1001
+ };
1002
+ /** @description Revenue metric (PM Revenue vs Gross Guest Revenue) */
1003
+ get: operations["getMetricRevenue"];
1004
+ put?: never;
1005
+ post?: never;
1006
+ delete?: never;
1007
+ options?: never;
1008
+ head?: never;
1009
+ patch?: never;
1010
+ trace?: never;
1011
+ };
876
1012
  "/metrics/sync-by-status": {
877
1013
  parameters: {
878
1014
  query?: never;
@@ -890,6 +1026,23 @@ export interface paths {
890
1026
  patch?: never;
891
1027
  trace?: never;
892
1028
  };
1029
+ "/metrics/take-rate": {
1030
+ parameters: {
1031
+ query?: never;
1032
+ header?: never;
1033
+ path?: never;
1034
+ cookie?: never;
1035
+ };
1036
+ /** @description Take rate metric */
1037
+ get: operations["getMetricTakeRate"];
1038
+ put?: never;
1039
+ post?: never;
1040
+ delete?: never;
1041
+ options?: never;
1042
+ head?: never;
1043
+ patch?: never;
1044
+ trace?: never;
1045
+ };
893
1046
  "/payments/batch": {
894
1047
  parameters: {
895
1048
  query?: never;
@@ -12821,14 +12974,11 @@ export interface operations {
12821
12974
  };
12822
12975
  };
12823
12976
  };
12824
- getMetricReservationVolume: {
12977
+ getMetricActiveListings: {
12825
12978
  parameters: {
12826
- query?: {
12827
- dimension?: "month" | "week" | "day" | "year";
12828
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
12829
- dateRange?: string;
12830
- /** @description Whether the end date is inclusive or exclusive */
12831
- isDateRangeEndInclusive?: boolean;
12979
+ query: {
12980
+ startDate: string;
12981
+ endDate: string;
12832
12982
  };
12833
12983
  header?: never;
12834
12984
  path?: never;
@@ -12844,9 +12994,10 @@ export interface operations {
12844
12994
  content: {
12845
12995
  "application/json": {
12846
12996
  data: {
12847
- currency: string | null;
12848
- date: string;
12849
- amount: number;
12997
+ current: number;
12998
+ previous: number;
12999
+ delta: number;
13000
+ deltaPercentage: number | null;
12850
13001
  }[];
12851
13002
  };
12852
13003
  };
@@ -12933,16 +13084,11 @@ export interface operations {
12933
13084
  };
12934
13085
  };
12935
13086
  };
12936
- getSyncMetricsByStatus: {
13087
+ getMetricAverageDailyRate: {
12937
13088
  parameters: {
12938
13089
  query: {
12939
- dimension?: "month" | "week" | "day" | "year";
12940
- connectionId: string;
12941
- view: "automate" | "extract";
12942
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
12943
- dateRange?: string;
12944
- /** @description Whether the end date is inclusive or exclusive */
12945
- isDateRangeEndInclusive?: boolean;
13090
+ startDate: string;
13091
+ endDate: string;
12946
13092
  };
12947
13093
  header?: never;
12948
13094
  path?: never;
@@ -12958,22 +13104,10 @@ export interface operations {
12958
13104
  content: {
12959
13105
  "application/json": {
12960
13106
  data: {
12961
- date: string;
12962
- total: number;
12963
- changes: {
12964
- completed?: {
12965
- [key: string]: number;
12966
- };
12967
- skipped?: {
12968
- [key: string]: number;
12969
- };
12970
- failed?: {
12971
- [key: string]: number;
12972
- };
12973
- queued?: {
12974
- [key: string]: number;
12975
- };
12976
- };
13107
+ current: number;
13108
+ previous: number;
13109
+ delta: number;
13110
+ deltaPercentage: number | null;
12977
13111
  }[];
12978
13112
  };
12979
13113
  };
@@ -13060,53 +13194,18 @@ export interface operations {
13060
13194
  };
13061
13195
  };
13062
13196
  };
13063
- batchPayments: {
13197
+ getMetricCashFlow: {
13064
13198
  parameters: {
13065
- query?: never;
13199
+ query: {
13200
+ dimension?: "month" | "week" | "day" | "year";
13201
+ startDate: string;
13202
+ endDate: string;
13203
+ };
13066
13204
  header?: never;
13067
13205
  path?: never;
13068
13206
  cookie?: never;
13069
13207
  };
13070
- requestBody?: {
13071
- content: {
13072
- "application/json": {
13073
- connectionId: string;
13074
- data: {
13075
- id?: string | null;
13076
- uniqueRef?: string | null;
13077
- etaAt?: string | null;
13078
- paidAt?: string | null;
13079
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
13080
- currency: string;
13081
- description?: string | null;
13082
- metadata?: {
13083
- [key: string]: unknown;
13084
- } | null;
13085
- userdata?: {
13086
- [key: string]: unknown;
13087
- } | null;
13088
- sourceId?: string | null;
13089
- lines: {
13090
- id?: string | null;
13091
- uniqueRef?: string | null;
13092
- type: string;
13093
- description?: string | null;
13094
- reservationId?: string | null;
13095
- reservationRef?: string | null;
13096
- /** @description Value in cents (100 = 1€) */
13097
- amount: number;
13098
- accountId?: string | null;
13099
- accountRef?: string | null;
13100
- connectionId?: string | null;
13101
- metadata?: {
13102
- [key: string]: unknown;
13103
- } | null;
13104
- }[];
13105
- bankAccountRef?: string | null;
13106
- }[];
13107
- };
13108
- };
13109
- };
13208
+ requestBody?: never;
13110
13209
  responses: {
13111
13210
  /** @description Successful response */
13112
13211
  200: {
@@ -13116,18 +13215,10 @@ export interface operations {
13116
13215
  content: {
13117
13216
  "application/json": {
13118
13217
  data: {
13119
- /** Format: uuid */
13120
- id: string;
13121
- uniqueRef?: string | null;
13122
- sourceId?: string | null;
13123
- }[];
13124
- issues: {
13125
- ref: string;
13126
- sourceId?: string | null;
13127
- message: string;
13128
- /** @enum {string} */
13129
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR";
13130
- context?: unknown;
13218
+ date: string;
13219
+ inflow: number;
13220
+ outflow: number;
13221
+ netCashFlow: number;
13131
13222
  }[];
13132
13223
  };
13133
13224
  };
@@ -13214,23 +13305,17 @@ export interface operations {
13214
13305
  };
13215
13306
  };
13216
13307
  };
13217
- plaidConnectComplete: {
13308
+ getMetricCheckinCounts: {
13218
13309
  parameters: {
13219
- query?: never;
13310
+ query: {
13311
+ startDate: string;
13312
+ endDate: string;
13313
+ };
13220
13314
  header?: never;
13221
13315
  path?: never;
13222
13316
  cookie?: never;
13223
13317
  };
13224
- requestBody?: {
13225
- content: {
13226
- "application/json": {
13227
- connectionId?: string | null;
13228
- environment?: ("sandbox" | "production") | null;
13229
- code?: string | null;
13230
- token?: string | null;
13231
- };
13232
- };
13233
- };
13318
+ requestBody?: never;
13234
13319
  responses: {
13235
13320
  /** @description Successful response */
13236
13321
  200: {
@@ -13239,8 +13324,12 @@ export interface operations {
13239
13324
  };
13240
13325
  content: {
13241
13326
  "application/json": {
13242
- connectionId: string;
13243
- syncId?: string;
13327
+ data: {
13328
+ current: number;
13329
+ previous: number;
13330
+ delta: number;
13331
+ deltaPercentage: number | null;
13332
+ }[];
13244
13333
  };
13245
13334
  };
13246
13335
  };
@@ -13326,13 +13415,1070 @@ export interface operations {
13326
13415
  };
13327
13416
  };
13328
13417
  };
13329
- plaidConnectInit: {
13418
+ getMetricFutureBookedRevenue: {
13330
13419
  parameters: {
13331
- query?: never;
13332
- header?: never;
13333
- path?: never;
13334
- cookie?: never;
13335
- };
13420
+ query: {
13421
+ dimension?: "month" | "week" | "day" | "year";
13422
+ startDate: string;
13423
+ endDate: string;
13424
+ };
13425
+ header?: never;
13426
+ path?: never;
13427
+ cookie?: never;
13428
+ };
13429
+ requestBody?: never;
13430
+ responses: {
13431
+ /** @description Successful response */
13432
+ 200: {
13433
+ headers: {
13434
+ [name: string]: unknown;
13435
+ };
13436
+ content: {
13437
+ "application/json": {
13438
+ data: {
13439
+ date: string;
13440
+ futureRevenue: number;
13441
+ bookedRevenue: number;
13442
+ }[];
13443
+ };
13444
+ };
13445
+ };
13446
+ /** @description Bad request */
13447
+ 400: {
13448
+ headers: {
13449
+ [name: string]: unknown;
13450
+ };
13451
+ content: {
13452
+ "application/json": {
13453
+ code: string;
13454
+ message: string;
13455
+ issues?: {
13456
+ message: string;
13457
+ }[];
13458
+ context?: unknown;
13459
+ };
13460
+ };
13461
+ };
13462
+ /** @description Unauthorized */
13463
+ 401: {
13464
+ headers: {
13465
+ [name: string]: unknown;
13466
+ };
13467
+ content: {
13468
+ "application/json": {
13469
+ code: string;
13470
+ message: string;
13471
+ issues?: {
13472
+ message: string;
13473
+ }[];
13474
+ context?: unknown;
13475
+ };
13476
+ };
13477
+ };
13478
+ /** @description Forbidden */
13479
+ 403: {
13480
+ headers: {
13481
+ [name: string]: unknown;
13482
+ };
13483
+ content: {
13484
+ "application/json": {
13485
+ code: string;
13486
+ message: string;
13487
+ issues?: {
13488
+ message: string;
13489
+ }[];
13490
+ context?: unknown;
13491
+ };
13492
+ };
13493
+ };
13494
+ /** @description Not found */
13495
+ 404: {
13496
+ headers: {
13497
+ [name: string]: unknown;
13498
+ };
13499
+ content: {
13500
+ "application/json": {
13501
+ code: string;
13502
+ message: string;
13503
+ issues?: {
13504
+ message: string;
13505
+ }[];
13506
+ context?: unknown;
13507
+ };
13508
+ };
13509
+ };
13510
+ /** @description Internal server error */
13511
+ 500: {
13512
+ headers: {
13513
+ [name: string]: unknown;
13514
+ };
13515
+ content: {
13516
+ "application/json": {
13517
+ code: string;
13518
+ message: string;
13519
+ issues?: {
13520
+ message: string;
13521
+ }[];
13522
+ context?: unknown;
13523
+ };
13524
+ };
13525
+ };
13526
+ };
13527
+ };
13528
+ getMetricOccupancyRateOverTime: {
13529
+ parameters: {
13530
+ query: {
13531
+ dimension?: "month" | "week" | "day" | "year";
13532
+ startDate: string;
13533
+ endDate: string;
13534
+ };
13535
+ header?: never;
13536
+ path?: never;
13537
+ cookie?: never;
13538
+ };
13539
+ requestBody?: never;
13540
+ responses: {
13541
+ /** @description Successful response */
13542
+ 200: {
13543
+ headers: {
13544
+ [name: string]: unknown;
13545
+ };
13546
+ content: {
13547
+ "application/json": {
13548
+ data: {
13549
+ date: string;
13550
+ occupiedNights: number;
13551
+ availableNights: number;
13552
+ occupancyRate: number;
13553
+ }[];
13554
+ };
13555
+ };
13556
+ };
13557
+ /** @description Bad request */
13558
+ 400: {
13559
+ headers: {
13560
+ [name: string]: unknown;
13561
+ };
13562
+ content: {
13563
+ "application/json": {
13564
+ code: string;
13565
+ message: string;
13566
+ issues?: {
13567
+ message: string;
13568
+ }[];
13569
+ context?: unknown;
13570
+ };
13571
+ };
13572
+ };
13573
+ /** @description Unauthorized */
13574
+ 401: {
13575
+ headers: {
13576
+ [name: string]: unknown;
13577
+ };
13578
+ content: {
13579
+ "application/json": {
13580
+ code: string;
13581
+ message: string;
13582
+ issues?: {
13583
+ message: string;
13584
+ }[];
13585
+ context?: unknown;
13586
+ };
13587
+ };
13588
+ };
13589
+ /** @description Forbidden */
13590
+ 403: {
13591
+ headers: {
13592
+ [name: string]: unknown;
13593
+ };
13594
+ content: {
13595
+ "application/json": {
13596
+ code: string;
13597
+ message: string;
13598
+ issues?: {
13599
+ message: string;
13600
+ }[];
13601
+ context?: unknown;
13602
+ };
13603
+ };
13604
+ };
13605
+ /** @description Not found */
13606
+ 404: {
13607
+ headers: {
13608
+ [name: string]: unknown;
13609
+ };
13610
+ content: {
13611
+ "application/json": {
13612
+ code: string;
13613
+ message: string;
13614
+ issues?: {
13615
+ message: string;
13616
+ }[];
13617
+ context?: unknown;
13618
+ };
13619
+ };
13620
+ };
13621
+ /** @description Internal server error */
13622
+ 500: {
13623
+ headers: {
13624
+ [name: string]: unknown;
13625
+ };
13626
+ content: {
13627
+ "application/json": {
13628
+ code: string;
13629
+ message: string;
13630
+ issues?: {
13631
+ message: string;
13632
+ }[];
13633
+ context?: unknown;
13634
+ };
13635
+ };
13636
+ };
13637
+ };
13638
+ };
13639
+ getMetricReservationCount: {
13640
+ parameters: {
13641
+ query: {
13642
+ startDate: string;
13643
+ endDate: string;
13644
+ };
13645
+ header?: never;
13646
+ path?: never;
13647
+ cookie?: never;
13648
+ };
13649
+ requestBody?: never;
13650
+ responses: {
13651
+ /** @description Successful response */
13652
+ 200: {
13653
+ headers: {
13654
+ [name: string]: unknown;
13655
+ };
13656
+ content: {
13657
+ "application/json": {
13658
+ data: {
13659
+ current: number;
13660
+ previous: number;
13661
+ delta: number;
13662
+ deltaPercentage: number | null;
13663
+ }[];
13664
+ };
13665
+ };
13666
+ };
13667
+ /** @description Bad request */
13668
+ 400: {
13669
+ headers: {
13670
+ [name: string]: unknown;
13671
+ };
13672
+ content: {
13673
+ "application/json": {
13674
+ code: string;
13675
+ message: string;
13676
+ issues?: {
13677
+ message: string;
13678
+ }[];
13679
+ context?: unknown;
13680
+ };
13681
+ };
13682
+ };
13683
+ /** @description Unauthorized */
13684
+ 401: {
13685
+ headers: {
13686
+ [name: string]: unknown;
13687
+ };
13688
+ content: {
13689
+ "application/json": {
13690
+ code: string;
13691
+ message: string;
13692
+ issues?: {
13693
+ message: string;
13694
+ }[];
13695
+ context?: unknown;
13696
+ };
13697
+ };
13698
+ };
13699
+ /** @description Forbidden */
13700
+ 403: {
13701
+ headers: {
13702
+ [name: string]: unknown;
13703
+ };
13704
+ content: {
13705
+ "application/json": {
13706
+ code: string;
13707
+ message: string;
13708
+ issues?: {
13709
+ message: string;
13710
+ }[];
13711
+ context?: unknown;
13712
+ };
13713
+ };
13714
+ };
13715
+ /** @description Not found */
13716
+ 404: {
13717
+ headers: {
13718
+ [name: string]: unknown;
13719
+ };
13720
+ content: {
13721
+ "application/json": {
13722
+ code: string;
13723
+ message: string;
13724
+ issues?: {
13725
+ message: string;
13726
+ }[];
13727
+ context?: unknown;
13728
+ };
13729
+ };
13730
+ };
13731
+ /** @description Internal server error */
13732
+ 500: {
13733
+ headers: {
13734
+ [name: string]: unknown;
13735
+ };
13736
+ content: {
13737
+ "application/json": {
13738
+ code: string;
13739
+ message: string;
13740
+ issues?: {
13741
+ message: string;
13742
+ }[];
13743
+ context?: unknown;
13744
+ };
13745
+ };
13746
+ };
13747
+ };
13748
+ };
13749
+ getMetricReservationVolume: {
13750
+ parameters: {
13751
+ query?: {
13752
+ dimension?: "month" | "week" | "day" | "year";
13753
+ /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
13754
+ dateRange?: string;
13755
+ /** @description Whether the end date is inclusive or exclusive */
13756
+ isDateRangeEndInclusive?: boolean;
13757
+ };
13758
+ header?: never;
13759
+ path?: never;
13760
+ cookie?: never;
13761
+ };
13762
+ requestBody?: never;
13763
+ responses: {
13764
+ /** @description Successful response */
13765
+ 200: {
13766
+ headers: {
13767
+ [name: string]: unknown;
13768
+ };
13769
+ content: {
13770
+ "application/json": {
13771
+ data: {
13772
+ currency: string | null;
13773
+ date: string;
13774
+ amount: number;
13775
+ }[];
13776
+ };
13777
+ };
13778
+ };
13779
+ /** @description Bad request */
13780
+ 400: {
13781
+ headers: {
13782
+ [name: string]: unknown;
13783
+ };
13784
+ content: {
13785
+ "application/json": {
13786
+ code: string;
13787
+ message: string;
13788
+ issues?: {
13789
+ message: string;
13790
+ }[];
13791
+ context?: unknown;
13792
+ };
13793
+ };
13794
+ };
13795
+ /** @description Unauthorized */
13796
+ 401: {
13797
+ headers: {
13798
+ [name: string]: unknown;
13799
+ };
13800
+ content: {
13801
+ "application/json": {
13802
+ code: string;
13803
+ message: string;
13804
+ issues?: {
13805
+ message: string;
13806
+ }[];
13807
+ context?: unknown;
13808
+ };
13809
+ };
13810
+ };
13811
+ /** @description Forbidden */
13812
+ 403: {
13813
+ headers: {
13814
+ [name: string]: unknown;
13815
+ };
13816
+ content: {
13817
+ "application/json": {
13818
+ code: string;
13819
+ message: string;
13820
+ issues?: {
13821
+ message: string;
13822
+ }[];
13823
+ context?: unknown;
13824
+ };
13825
+ };
13826
+ };
13827
+ /** @description Not found */
13828
+ 404: {
13829
+ headers: {
13830
+ [name: string]: unknown;
13831
+ };
13832
+ content: {
13833
+ "application/json": {
13834
+ code: string;
13835
+ message: string;
13836
+ issues?: {
13837
+ message: string;
13838
+ }[];
13839
+ context?: unknown;
13840
+ };
13841
+ };
13842
+ };
13843
+ /** @description Internal server error */
13844
+ 500: {
13845
+ headers: {
13846
+ [name: string]: unknown;
13847
+ };
13848
+ content: {
13849
+ "application/json": {
13850
+ code: string;
13851
+ message: string;
13852
+ issues?: {
13853
+ message: string;
13854
+ }[];
13855
+ context?: unknown;
13856
+ };
13857
+ };
13858
+ };
13859
+ };
13860
+ };
13861
+ getMetricRevenue: {
13862
+ parameters: {
13863
+ query: {
13864
+ dimension?: "month" | "week" | "day" | "year";
13865
+ startDate: string;
13866
+ endDate: string;
13867
+ };
13868
+ header?: never;
13869
+ path?: never;
13870
+ cookie?: never;
13871
+ };
13872
+ requestBody?: never;
13873
+ responses: {
13874
+ /** @description Successful response */
13875
+ 200: {
13876
+ headers: {
13877
+ [name: string]: unknown;
13878
+ };
13879
+ content: {
13880
+ "application/json": {
13881
+ data: {
13882
+ date: string;
13883
+ grossGuestRevenue: number;
13884
+ pmRevenue: number;
13885
+ }[];
13886
+ };
13887
+ };
13888
+ };
13889
+ /** @description Bad request */
13890
+ 400: {
13891
+ headers: {
13892
+ [name: string]: unknown;
13893
+ };
13894
+ content: {
13895
+ "application/json": {
13896
+ code: string;
13897
+ message: string;
13898
+ issues?: {
13899
+ message: string;
13900
+ }[];
13901
+ context?: unknown;
13902
+ };
13903
+ };
13904
+ };
13905
+ /** @description Unauthorized */
13906
+ 401: {
13907
+ headers: {
13908
+ [name: string]: unknown;
13909
+ };
13910
+ content: {
13911
+ "application/json": {
13912
+ code: string;
13913
+ message: string;
13914
+ issues?: {
13915
+ message: string;
13916
+ }[];
13917
+ context?: unknown;
13918
+ };
13919
+ };
13920
+ };
13921
+ /** @description Forbidden */
13922
+ 403: {
13923
+ headers: {
13924
+ [name: string]: unknown;
13925
+ };
13926
+ content: {
13927
+ "application/json": {
13928
+ code: string;
13929
+ message: string;
13930
+ issues?: {
13931
+ message: string;
13932
+ }[];
13933
+ context?: unknown;
13934
+ };
13935
+ };
13936
+ };
13937
+ /** @description Not found */
13938
+ 404: {
13939
+ headers: {
13940
+ [name: string]: unknown;
13941
+ };
13942
+ content: {
13943
+ "application/json": {
13944
+ code: string;
13945
+ message: string;
13946
+ issues?: {
13947
+ message: string;
13948
+ }[];
13949
+ context?: unknown;
13950
+ };
13951
+ };
13952
+ };
13953
+ /** @description Internal server error */
13954
+ 500: {
13955
+ headers: {
13956
+ [name: string]: unknown;
13957
+ };
13958
+ content: {
13959
+ "application/json": {
13960
+ code: string;
13961
+ message: string;
13962
+ issues?: {
13963
+ message: string;
13964
+ }[];
13965
+ context?: unknown;
13966
+ };
13967
+ };
13968
+ };
13969
+ };
13970
+ };
13971
+ getSyncMetricsByStatus: {
13972
+ parameters: {
13973
+ query: {
13974
+ dimension?: "month" | "week" | "day" | "year";
13975
+ connectionId: string;
13976
+ view: "automate" | "extract";
13977
+ /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
13978
+ dateRange?: string;
13979
+ /** @description Whether the end date is inclusive or exclusive */
13980
+ isDateRangeEndInclusive?: boolean;
13981
+ };
13982
+ header?: never;
13983
+ path?: never;
13984
+ cookie?: never;
13985
+ };
13986
+ requestBody?: never;
13987
+ responses: {
13988
+ /** @description Successful response */
13989
+ 200: {
13990
+ headers: {
13991
+ [name: string]: unknown;
13992
+ };
13993
+ content: {
13994
+ "application/json": {
13995
+ data: {
13996
+ date: string;
13997
+ total: number;
13998
+ changes: {
13999
+ completed?: {
14000
+ [key: string]: number;
14001
+ };
14002
+ skipped?: {
14003
+ [key: string]: number;
14004
+ };
14005
+ failed?: {
14006
+ [key: string]: number;
14007
+ };
14008
+ queued?: {
14009
+ [key: string]: number;
14010
+ };
14011
+ };
14012
+ }[];
14013
+ };
14014
+ };
14015
+ };
14016
+ /** @description Bad request */
14017
+ 400: {
14018
+ headers: {
14019
+ [name: string]: unknown;
14020
+ };
14021
+ content: {
14022
+ "application/json": {
14023
+ code: string;
14024
+ message: string;
14025
+ issues?: {
14026
+ message: string;
14027
+ }[];
14028
+ context?: unknown;
14029
+ };
14030
+ };
14031
+ };
14032
+ /** @description Unauthorized */
14033
+ 401: {
14034
+ headers: {
14035
+ [name: string]: unknown;
14036
+ };
14037
+ content: {
14038
+ "application/json": {
14039
+ code: string;
14040
+ message: string;
14041
+ issues?: {
14042
+ message: string;
14043
+ }[];
14044
+ context?: unknown;
14045
+ };
14046
+ };
14047
+ };
14048
+ /** @description Forbidden */
14049
+ 403: {
14050
+ headers: {
14051
+ [name: string]: unknown;
14052
+ };
14053
+ content: {
14054
+ "application/json": {
14055
+ code: string;
14056
+ message: string;
14057
+ issues?: {
14058
+ message: string;
14059
+ }[];
14060
+ context?: unknown;
14061
+ };
14062
+ };
14063
+ };
14064
+ /** @description Not found */
14065
+ 404: {
14066
+ headers: {
14067
+ [name: string]: unknown;
14068
+ };
14069
+ content: {
14070
+ "application/json": {
14071
+ code: string;
14072
+ message: string;
14073
+ issues?: {
14074
+ message: string;
14075
+ }[];
14076
+ context?: unknown;
14077
+ };
14078
+ };
14079
+ };
14080
+ /** @description Internal server error */
14081
+ 500: {
14082
+ headers: {
14083
+ [name: string]: unknown;
14084
+ };
14085
+ content: {
14086
+ "application/json": {
14087
+ code: string;
14088
+ message: string;
14089
+ issues?: {
14090
+ message: string;
14091
+ }[];
14092
+ context?: unknown;
14093
+ };
14094
+ };
14095
+ };
14096
+ };
14097
+ };
14098
+ getMetricTakeRate: {
14099
+ parameters: {
14100
+ query: {
14101
+ dimension?: "month" | "week" | "day" | "year";
14102
+ startDate: string;
14103
+ endDate: string;
14104
+ };
14105
+ header?: never;
14106
+ path?: never;
14107
+ cookie?: never;
14108
+ };
14109
+ requestBody?: never;
14110
+ responses: {
14111
+ /** @description Successful response */
14112
+ 200: {
14113
+ headers: {
14114
+ [name: string]: unknown;
14115
+ };
14116
+ content: {
14117
+ "application/json": {
14118
+ data: {
14119
+ date: string;
14120
+ grossGuestRevenue: number;
14121
+ pmRevenue: number;
14122
+ takeRate: number;
14123
+ }[];
14124
+ };
14125
+ };
14126
+ };
14127
+ /** @description Bad request */
14128
+ 400: {
14129
+ headers: {
14130
+ [name: string]: unknown;
14131
+ };
14132
+ content: {
14133
+ "application/json": {
14134
+ code: string;
14135
+ message: string;
14136
+ issues?: {
14137
+ message: string;
14138
+ }[];
14139
+ context?: unknown;
14140
+ };
14141
+ };
14142
+ };
14143
+ /** @description Unauthorized */
14144
+ 401: {
14145
+ headers: {
14146
+ [name: string]: unknown;
14147
+ };
14148
+ content: {
14149
+ "application/json": {
14150
+ code: string;
14151
+ message: string;
14152
+ issues?: {
14153
+ message: string;
14154
+ }[];
14155
+ context?: unknown;
14156
+ };
14157
+ };
14158
+ };
14159
+ /** @description Forbidden */
14160
+ 403: {
14161
+ headers: {
14162
+ [name: string]: unknown;
14163
+ };
14164
+ content: {
14165
+ "application/json": {
14166
+ code: string;
14167
+ message: string;
14168
+ issues?: {
14169
+ message: string;
14170
+ }[];
14171
+ context?: unknown;
14172
+ };
14173
+ };
14174
+ };
14175
+ /** @description Not found */
14176
+ 404: {
14177
+ headers: {
14178
+ [name: string]: unknown;
14179
+ };
14180
+ content: {
14181
+ "application/json": {
14182
+ code: string;
14183
+ message: string;
14184
+ issues?: {
14185
+ message: string;
14186
+ }[];
14187
+ context?: unknown;
14188
+ };
14189
+ };
14190
+ };
14191
+ /** @description Internal server error */
14192
+ 500: {
14193
+ headers: {
14194
+ [name: string]: unknown;
14195
+ };
14196
+ content: {
14197
+ "application/json": {
14198
+ code: string;
14199
+ message: string;
14200
+ issues?: {
14201
+ message: string;
14202
+ }[];
14203
+ context?: unknown;
14204
+ };
14205
+ };
14206
+ };
14207
+ };
14208
+ };
14209
+ batchPayments: {
14210
+ parameters: {
14211
+ query?: never;
14212
+ header?: never;
14213
+ path?: never;
14214
+ cookie?: never;
14215
+ };
14216
+ requestBody?: {
14217
+ content: {
14218
+ "application/json": {
14219
+ connectionId: string;
14220
+ data: {
14221
+ id?: string | null;
14222
+ uniqueRef?: string | null;
14223
+ etaAt?: string | null;
14224
+ paidAt?: string | null;
14225
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
14226
+ currency: string;
14227
+ description?: string | null;
14228
+ metadata?: {
14229
+ [key: string]: unknown;
14230
+ } | null;
14231
+ userdata?: {
14232
+ [key: string]: unknown;
14233
+ } | null;
14234
+ sourceId?: string | null;
14235
+ lines: {
14236
+ id?: string | null;
14237
+ uniqueRef?: string | null;
14238
+ type: string;
14239
+ description?: string | null;
14240
+ reservationId?: string | null;
14241
+ reservationRef?: string | null;
14242
+ /** @description Value in cents (100 = 1€) */
14243
+ amount: number;
14244
+ accountId?: string | null;
14245
+ accountRef?: string | null;
14246
+ connectionId?: string | null;
14247
+ metadata?: {
14248
+ [key: string]: unknown;
14249
+ } | null;
14250
+ }[];
14251
+ bankAccountRef?: string | null;
14252
+ }[];
14253
+ };
14254
+ };
14255
+ };
14256
+ responses: {
14257
+ /** @description Successful response */
14258
+ 200: {
14259
+ headers: {
14260
+ [name: string]: unknown;
14261
+ };
14262
+ content: {
14263
+ "application/json": {
14264
+ data: {
14265
+ /** Format: uuid */
14266
+ id: string;
14267
+ uniqueRef?: string | null;
14268
+ sourceId?: string | null;
14269
+ }[];
14270
+ issues: {
14271
+ ref: string;
14272
+ sourceId?: string | null;
14273
+ message: string;
14274
+ /** @enum {string} */
14275
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR";
14276
+ context?: unknown;
14277
+ }[];
14278
+ };
14279
+ };
14280
+ };
14281
+ /** @description Bad request */
14282
+ 400: {
14283
+ headers: {
14284
+ [name: string]: unknown;
14285
+ };
14286
+ content: {
14287
+ "application/json": {
14288
+ code: string;
14289
+ message: string;
14290
+ issues?: {
14291
+ message: string;
14292
+ }[];
14293
+ context?: unknown;
14294
+ };
14295
+ };
14296
+ };
14297
+ /** @description Unauthorized */
14298
+ 401: {
14299
+ headers: {
14300
+ [name: string]: unknown;
14301
+ };
14302
+ content: {
14303
+ "application/json": {
14304
+ code: string;
14305
+ message: string;
14306
+ issues?: {
14307
+ message: string;
14308
+ }[];
14309
+ context?: unknown;
14310
+ };
14311
+ };
14312
+ };
14313
+ /** @description Forbidden */
14314
+ 403: {
14315
+ headers: {
14316
+ [name: string]: unknown;
14317
+ };
14318
+ content: {
14319
+ "application/json": {
14320
+ code: string;
14321
+ message: string;
14322
+ issues?: {
14323
+ message: string;
14324
+ }[];
14325
+ context?: unknown;
14326
+ };
14327
+ };
14328
+ };
14329
+ /** @description Not found */
14330
+ 404: {
14331
+ headers: {
14332
+ [name: string]: unknown;
14333
+ };
14334
+ content: {
14335
+ "application/json": {
14336
+ code: string;
14337
+ message: string;
14338
+ issues?: {
14339
+ message: string;
14340
+ }[];
14341
+ context?: unknown;
14342
+ };
14343
+ };
14344
+ };
14345
+ /** @description Internal server error */
14346
+ 500: {
14347
+ headers: {
14348
+ [name: string]: unknown;
14349
+ };
14350
+ content: {
14351
+ "application/json": {
14352
+ code: string;
14353
+ message: string;
14354
+ issues?: {
14355
+ message: string;
14356
+ }[];
14357
+ context?: unknown;
14358
+ };
14359
+ };
14360
+ };
14361
+ };
14362
+ };
14363
+ plaidConnectComplete: {
14364
+ parameters: {
14365
+ query?: never;
14366
+ header?: never;
14367
+ path?: never;
14368
+ cookie?: never;
14369
+ };
14370
+ requestBody?: {
14371
+ content: {
14372
+ "application/json": {
14373
+ connectionId?: string | null;
14374
+ environment?: ("sandbox" | "production") | null;
14375
+ code?: string | null;
14376
+ token?: string | null;
14377
+ };
14378
+ };
14379
+ };
14380
+ responses: {
14381
+ /** @description Successful response */
14382
+ 200: {
14383
+ headers: {
14384
+ [name: string]: unknown;
14385
+ };
14386
+ content: {
14387
+ "application/json": {
14388
+ connectionId: string;
14389
+ syncId?: string;
14390
+ };
14391
+ };
14392
+ };
14393
+ /** @description Bad request */
14394
+ 400: {
14395
+ headers: {
14396
+ [name: string]: unknown;
14397
+ };
14398
+ content: {
14399
+ "application/json": {
14400
+ code: string;
14401
+ message: string;
14402
+ issues?: {
14403
+ message: string;
14404
+ }[];
14405
+ context?: unknown;
14406
+ };
14407
+ };
14408
+ };
14409
+ /** @description Unauthorized */
14410
+ 401: {
14411
+ headers: {
14412
+ [name: string]: unknown;
14413
+ };
14414
+ content: {
14415
+ "application/json": {
14416
+ code: string;
14417
+ message: string;
14418
+ issues?: {
14419
+ message: string;
14420
+ }[];
14421
+ context?: unknown;
14422
+ };
14423
+ };
14424
+ };
14425
+ /** @description Forbidden */
14426
+ 403: {
14427
+ headers: {
14428
+ [name: string]: unknown;
14429
+ };
14430
+ content: {
14431
+ "application/json": {
14432
+ code: string;
14433
+ message: string;
14434
+ issues?: {
14435
+ message: string;
14436
+ }[];
14437
+ context?: unknown;
14438
+ };
14439
+ };
14440
+ };
14441
+ /** @description Not found */
14442
+ 404: {
14443
+ headers: {
14444
+ [name: string]: unknown;
14445
+ };
14446
+ content: {
14447
+ "application/json": {
14448
+ code: string;
14449
+ message: string;
14450
+ issues?: {
14451
+ message: string;
14452
+ }[];
14453
+ context?: unknown;
14454
+ };
14455
+ };
14456
+ };
14457
+ /** @description Internal server error */
14458
+ 500: {
14459
+ headers: {
14460
+ [name: string]: unknown;
14461
+ };
14462
+ content: {
14463
+ "application/json": {
14464
+ code: string;
14465
+ message: string;
14466
+ issues?: {
14467
+ message: string;
14468
+ }[];
14469
+ context?: unknown;
14470
+ };
14471
+ };
14472
+ };
14473
+ };
14474
+ };
14475
+ plaidConnectInit: {
14476
+ parameters: {
14477
+ query?: never;
14478
+ header?: never;
14479
+ path?: never;
14480
+ cookie?: never;
14481
+ };
13336
14482
  requestBody?: {
13337
14483
  content: {
13338
14484
  "application/json": {
@@ -19288,39 +20434,44 @@ export interface operations {
19288
20434
  };
19289
20435
  content: {
19290
20436
  "application/json": {
19291
- data: ({
20437
+ trustReconciliation: {
19292
20438
  /** @constant */
19293
- name: "Owner Payables";
20439
+ name: "Trust Reconciliation";
19294
20440
  total: number;
19295
- /** @constant */
19296
- type: "listings";
19297
- listings: {
19298
- name: string;
19299
- id: string;
20441
+ data: ({
20442
+ /** @constant */
20443
+ name: "Owner Payables";
19300
20444
  total: number;
19301
- }[];
19302
- } | {
19303
- name: string;
19304
- total: number;
19305
- /** @constant */
19306
- type: "accounts";
19307
- accounts: {
19308
- id: string;
20445
+ /** @constant */
20446
+ type: "listings";
20447
+ listings: {
20448
+ name: string;
20449
+ id: string;
20450
+ total: number;
20451
+ }[];
20452
+ } | {
19309
20453
  name: string;
19310
20454
  total: number;
19311
- }[];
19312
- } | {
19313
- /** @constant */
19314
- name: "Guest Receivables & Deposits";
19315
- total: number;
19316
- /** @constant */
19317
- type: "occupancy_status";
19318
- occupancyStatuses: {
19319
- /** @enum {string} */
19320
- status: "departed" | "upcoming" | "inHouse" | "unassigned";
20455
+ /** @constant */
20456
+ type: "accounts";
20457
+ accounts: {
20458
+ id: string;
20459
+ name: string;
20460
+ total: number;
20461
+ }[];
20462
+ } | {
20463
+ /** @constant */
20464
+ name: "Guest Receivables & Deposits";
19321
20465
  total: number;
19322
- }[];
19323
- })[];
20466
+ /** @constant */
20467
+ type: "occupancy_status";
20468
+ occupancyStatuses: {
20469
+ /** @enum {string} */
20470
+ status: "departed" | "upcoming" | "inHouse" | "cancelled" | "unassigned";
20471
+ total: number;
20472
+ }[];
20473
+ })[];
20474
+ };
19324
20475
  };
19325
20476
  };
19326
20477
  };
@@ -19429,8 +20580,8 @@ export interface operations {
19429
20580
  name: "Trust Reconciliation by Listing";
19430
20581
  total: number;
19431
20582
  groups: ({
19432
- /** @constant */
19433
- name: "Bank Accounts";
20583
+ /** @enum {string} */
20584
+ name: "Bank Accounts" | "Unassigned Accounts";
19434
20585
  total: number;
19435
20586
  /** @constant */
19436
20587
  type: "accounts";