@vrplatform/api 1.3.1-stage.1896 → 1.3.1-stage.1898

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