@vrplatform/api 1.3.1-1635 → 1.3.1-1638

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.
@@ -377,7 +377,7 @@ export interface paths {
377
377
  get: operations["getContacts"];
378
378
  put?: never;
379
379
  /** @description Create contact */
380
- post: operations["createContact"];
380
+ post: operations["postContacts"];
381
381
  delete?: never;
382
382
  options?: never;
383
383
  head?: never;
@@ -394,7 +394,24 @@ export interface paths {
394
394
  get?: never;
395
395
  put?: never;
396
396
  /** @description Create owner */
397
- post: operations["batchContacts"];
397
+ post: operations["postContactsBatch"];
398
+ delete?: never;
399
+ options?: never;
400
+ head?: never;
401
+ patch?: never;
402
+ trace?: never;
403
+ };
404
+ "/contacts/csv": {
405
+ parameters: {
406
+ query?: never;
407
+ header?: never;
408
+ path?: never;
409
+ cookie?: never;
410
+ };
411
+ /** @description Contacts CSV export */
412
+ get: operations["getContactsCsv"];
413
+ put?: never;
414
+ post?: never;
398
415
  delete?: never;
399
416
  options?: never;
400
417
  head?: never;
@@ -409,12 +426,12 @@ export interface paths {
409
426
  cookie?: never;
410
427
  };
411
428
  /** @description Get contact by ID */
412
- get: operations["getContact"];
429
+ get: operations["getContacts:id"];
413
430
  /** @description Update Contact By ID */
414
- put: operations["updateContact"];
431
+ put: operations["putContacts:id"];
415
432
  post?: never;
416
433
  /** @description Delete Contact By ID */
417
- delete: operations["deleteContact"];
434
+ delete: operations["deleteContacts:id"];
418
435
  options?: never;
419
436
  head?: never;
420
437
  patch?: never;
@@ -430,7 +447,7 @@ export interface paths {
430
447
  get?: never;
431
448
  put?: never;
432
449
  /** @description Send Owner Portal Invite to Contact By ID */
433
- post: operations["inviteContact"];
450
+ post: operations["postContacts:idInvite"];
434
451
  delete?: never;
435
452
  options?: never;
436
453
  head?: never;
@@ -451,7 +468,7 @@ export interface paths {
451
468
  options?: never;
452
469
  head?: never;
453
470
  /** @description Revoke Owner Portal Access for Contact By ID */
454
- patch: operations["revokeContactAccess"];
471
+ patch: operations["patchContacts:idRevoke-access"];
455
472
  trace?: never;
456
473
  };
457
474
  "/csv/import": {
@@ -747,6 +764,23 @@ export interface paths {
747
764
  patch?: never;
748
765
  trace?: never;
749
766
  };
767
+ "/listings/csv": {
768
+ parameters: {
769
+ query?: never;
770
+ header?: never;
771
+ path?: never;
772
+ cookie?: never;
773
+ };
774
+ /** @description Listings CSV export */
775
+ get: operations["getListingsCsv"];
776
+ put?: never;
777
+ post?: never;
778
+ delete?: never;
779
+ options?: never;
780
+ head?: never;
781
+ patch?: never;
782
+ trace?: never;
783
+ };
750
784
  "/listings/ownership-periods": {
751
785
  parameters: {
752
786
  query?: never;
@@ -1493,6 +1527,23 @@ export interface paths {
1493
1527
  patch?: never;
1494
1528
  trace?: never;
1495
1529
  };
1530
+ "/reservations/csv": {
1531
+ parameters: {
1532
+ query?: never;
1533
+ header?: never;
1534
+ path?: never;
1535
+ cookie?: never;
1536
+ };
1537
+ /** @description Reservations CSV export */
1538
+ get: operations["getReservationsCsv"];
1539
+ put?: never;
1540
+ post?: never;
1541
+ delete?: never;
1542
+ options?: never;
1543
+ head?: never;
1544
+ patch?: never;
1545
+ trace?: never;
1546
+ };
1496
1547
  "/reservations/journal-entries": {
1497
1548
  parameters: {
1498
1549
  query?: never;
@@ -2122,6 +2173,23 @@ export interface paths {
2122
2173
  patch?: never;
2123
2174
  trace?: never;
2124
2175
  };
2176
+ "/transactions/expenses/csv": {
2177
+ parameters: {
2178
+ query?: never;
2179
+ header?: never;
2180
+ path?: never;
2181
+ cookie?: never;
2182
+ };
2183
+ /** @description Expense transactions CSV export */
2184
+ get: operations["getTransactionsExpensesCsv"];
2185
+ put?: never;
2186
+ post?: never;
2187
+ delete?: never;
2188
+ options?: never;
2189
+ head?: never;
2190
+ patch?: never;
2191
+ trace?: never;
2192
+ };
2125
2193
  "/transactions/journal-entries": {
2126
2194
  parameters: {
2127
2195
  query?: never;
@@ -6523,7 +6591,7 @@ export interface operations {
6523
6591
  };
6524
6592
  };
6525
6593
  };
6526
- createContact: {
6594
+ postContacts: {
6527
6595
  parameters: {
6528
6596
  query?: never;
6529
6597
  header?: never;
@@ -6699,7 +6767,7 @@ export interface operations {
6699
6767
  };
6700
6768
  };
6701
6769
  };
6702
- batchContacts: {
6770
+ postContactsBatch: {
6703
6771
  parameters: {
6704
6772
  query?: never;
6705
6773
  header?: never;
@@ -6848,7 +6916,117 @@ export interface operations {
6848
6916
  };
6849
6917
  };
6850
6918
  };
6851
- getContact: {
6919
+ getContactsCsv: {
6920
+ parameters: {
6921
+ query?: {
6922
+ search?: string;
6923
+ status?: "active" | "inactive";
6924
+ type?: "owner" | "vendor";
6925
+ companyType?: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
6926
+ isIndividual?: boolean;
6927
+ /** @description comma separated contact short refs */
6928
+ shortRefs?: string;
6929
+ };
6930
+ header?: never;
6931
+ path?: never;
6932
+ cookie?: never;
6933
+ };
6934
+ requestBody?: never;
6935
+ responses: {
6936
+ /** @description Successful response */
6937
+ 200: {
6938
+ headers: {
6939
+ [name: string]: unknown;
6940
+ };
6941
+ content: {
6942
+ "application/json": {
6943
+ url: string;
6944
+ };
6945
+ };
6946
+ };
6947
+ /** @description Bad request */
6948
+ 400: {
6949
+ headers: {
6950
+ [name: string]: unknown;
6951
+ };
6952
+ content: {
6953
+ "application/json": {
6954
+ code: string;
6955
+ message: string;
6956
+ issues?: {
6957
+ message: string;
6958
+ }[];
6959
+ context?: unknown;
6960
+ };
6961
+ };
6962
+ };
6963
+ /** @description Unauthorized */
6964
+ 401: {
6965
+ headers: {
6966
+ [name: string]: unknown;
6967
+ };
6968
+ content: {
6969
+ "application/json": {
6970
+ code: string;
6971
+ message: string;
6972
+ issues?: {
6973
+ message: string;
6974
+ }[];
6975
+ context?: unknown;
6976
+ };
6977
+ };
6978
+ };
6979
+ /** @description Forbidden */
6980
+ 403: {
6981
+ headers: {
6982
+ [name: string]: unknown;
6983
+ };
6984
+ content: {
6985
+ "application/json": {
6986
+ code: string;
6987
+ message: string;
6988
+ issues?: {
6989
+ message: string;
6990
+ }[];
6991
+ context?: unknown;
6992
+ };
6993
+ };
6994
+ };
6995
+ /** @description Not found */
6996
+ 404: {
6997
+ headers: {
6998
+ [name: string]: unknown;
6999
+ };
7000
+ content: {
7001
+ "application/json": {
7002
+ code: string;
7003
+ message: string;
7004
+ issues?: {
7005
+ message: string;
7006
+ }[];
7007
+ context?: unknown;
7008
+ };
7009
+ };
7010
+ };
7011
+ /** @description Internal server error */
7012
+ 500: {
7013
+ headers: {
7014
+ [name: string]: unknown;
7015
+ };
7016
+ content: {
7017
+ "application/json": {
7018
+ code: string;
7019
+ message: string;
7020
+ issues?: {
7021
+ message: string;
7022
+ }[];
7023
+ context?: unknown;
7024
+ };
7025
+ };
7026
+ };
7027
+ };
7028
+ };
7029
+ "getContacts:id": {
6852
7030
  parameters: {
6853
7031
  query?: never;
6854
7032
  header?: never;
@@ -6996,7 +7174,7 @@ export interface operations {
6996
7174
  };
6997
7175
  };
6998
7176
  };
6999
- updateContact: {
7177
+ "putContacts:id": {
7000
7178
  parameters: {
7001
7179
  query?: never;
7002
7180
  header?: never;
@@ -7173,7 +7351,7 @@ export interface operations {
7173
7351
  };
7174
7352
  };
7175
7353
  };
7176
- deleteContact: {
7354
+ "deleteContacts:id": {
7177
7355
  parameters: {
7178
7356
  query?: {
7179
7357
  onLocked?: "error" | "archive";
@@ -7284,7 +7462,7 @@ export interface operations {
7284
7462
  };
7285
7463
  };
7286
7464
  };
7287
- inviteContact: {
7465
+ "postContacts:idInvite": {
7288
7466
  parameters: {
7289
7467
  query?: never;
7290
7468
  header?: never;
@@ -7395,7 +7573,7 @@ export interface operations {
7395
7573
  };
7396
7574
  };
7397
7575
  };
7398
- revokeContactAccess: {
7576
+ "patchContacts:idRevoke-access": {
7399
7577
  parameters: {
7400
7578
  query?: never;
7401
7579
  header?: never;
@@ -10081,6 +10259,8 @@ export interface operations {
10081
10259
  query?: {
10082
10260
  status?: "active" | "inactive";
10083
10261
  connectionId?: string;
10262
+ /** @description comma separated listing ids */
10263
+ ids?: string;
10084
10264
  search?: string;
10085
10265
  contactId?: string;
10086
10266
  /** @description comma separated listing short refs */
@@ -10649,6 +10829,119 @@ export interface operations {
10649
10829
  };
10650
10830
  };
10651
10831
  };
10832
+ getListingsCsv: {
10833
+ parameters: {
10834
+ query?: {
10835
+ status?: "active" | "inactive";
10836
+ connectionId?: string;
10837
+ /** @description comma separated listing ids */
10838
+ ids?: string;
10839
+ search?: string;
10840
+ contactId?: string;
10841
+ /** @description comma separated listing short refs */
10842
+ shortRefs?: string;
10843
+ activeOwnership?: boolean;
10844
+ activeRecurringFeePeriods?: string;
10845
+ };
10846
+ header?: never;
10847
+ path?: never;
10848
+ cookie?: never;
10849
+ };
10850
+ requestBody?: never;
10851
+ responses: {
10852
+ /** @description Successful response */
10853
+ 200: {
10854
+ headers: {
10855
+ [name: string]: unknown;
10856
+ };
10857
+ content: {
10858
+ "application/json": {
10859
+ url: string;
10860
+ };
10861
+ };
10862
+ };
10863
+ /** @description Bad request */
10864
+ 400: {
10865
+ headers: {
10866
+ [name: string]: unknown;
10867
+ };
10868
+ content: {
10869
+ "application/json": {
10870
+ code: string;
10871
+ message: string;
10872
+ issues?: {
10873
+ message: string;
10874
+ }[];
10875
+ context?: unknown;
10876
+ };
10877
+ };
10878
+ };
10879
+ /** @description Unauthorized */
10880
+ 401: {
10881
+ headers: {
10882
+ [name: string]: unknown;
10883
+ };
10884
+ content: {
10885
+ "application/json": {
10886
+ code: string;
10887
+ message: string;
10888
+ issues?: {
10889
+ message: string;
10890
+ }[];
10891
+ context?: unknown;
10892
+ };
10893
+ };
10894
+ };
10895
+ /** @description Forbidden */
10896
+ 403: {
10897
+ headers: {
10898
+ [name: string]: unknown;
10899
+ };
10900
+ content: {
10901
+ "application/json": {
10902
+ code: string;
10903
+ message: string;
10904
+ issues?: {
10905
+ message: string;
10906
+ }[];
10907
+ context?: unknown;
10908
+ };
10909
+ };
10910
+ };
10911
+ /** @description Not found */
10912
+ 404: {
10913
+ headers: {
10914
+ [name: string]: unknown;
10915
+ };
10916
+ content: {
10917
+ "application/json": {
10918
+ code: string;
10919
+ message: string;
10920
+ issues?: {
10921
+ message: string;
10922
+ }[];
10923
+ context?: unknown;
10924
+ };
10925
+ };
10926
+ };
10927
+ /** @description Internal server error */
10928
+ 500: {
10929
+ headers: {
10930
+ [name: string]: unknown;
10931
+ };
10932
+ content: {
10933
+ "application/json": {
10934
+ code: string;
10935
+ message: string;
10936
+ issues?: {
10937
+ message: string;
10938
+ }[];
10939
+ context?: unknown;
10940
+ };
10941
+ };
10942
+ };
10943
+ };
10944
+ };
10652
10945
  "getListingsOwnership-periods": {
10653
10946
  parameters: {
10654
10947
  query?: {
@@ -16281,6 +16574,7 @@ export interface operations {
16281
16574
  entityTypes?: string;
16282
16575
  /** @description comma separated booking channel refs */
16283
16576
  bookingChannels?: string;
16577
+ includeDetails?: boolean;
16284
16578
  limit?: number;
16285
16579
  page?: number;
16286
16580
  };
@@ -19440,6 +19734,127 @@ export interface operations {
19440
19734
  };
19441
19735
  };
19442
19736
  };
19737
+ getReservationsCsv: {
19738
+ parameters: {
19739
+ query?: {
19740
+ /** @description comma separated reservation ids, negate with ! prefix */
19741
+ ids?: string;
19742
+ /** @description comma separated reservation short refs */
19743
+ shortRefs?: string;
19744
+ status?: "booked" | "canceled" | "inactive";
19745
+ listingId?: string;
19746
+ date?: string;
19747
+ dateField?: "bookedAt" | "checkIn" | "checkOut" | "payment" | "intersection";
19748
+ search?: string;
19749
+ /** @description unpaid, underpaid, overpaid, paid, !unpaid, !underpaid, !overpaid, !paid */
19750
+ paidStatus?: string;
19751
+ connectionId?: string;
19752
+ bookingChannel?: string;
19753
+ amount?: number;
19754
+ businessModel?: "managed" | "co_host" | "co_host_airbnb";
19755
+ /** @description Filter by reservation line type (paymentLine.type2), only when not excluded */
19756
+ lineType?: string;
19757
+ includeLines?: boolean;
19758
+ };
19759
+ header?: never;
19760
+ path?: never;
19761
+ cookie?: never;
19762
+ };
19763
+ requestBody?: never;
19764
+ responses: {
19765
+ /** @description Successful response */
19766
+ 200: {
19767
+ headers: {
19768
+ [name: string]: unknown;
19769
+ };
19770
+ content: {
19771
+ "application/json": {
19772
+ url: string;
19773
+ };
19774
+ };
19775
+ };
19776
+ /** @description Bad request */
19777
+ 400: {
19778
+ headers: {
19779
+ [name: string]: unknown;
19780
+ };
19781
+ content: {
19782
+ "application/json": {
19783
+ code: string;
19784
+ message: string;
19785
+ issues?: {
19786
+ message: string;
19787
+ }[];
19788
+ context?: unknown;
19789
+ };
19790
+ };
19791
+ };
19792
+ /** @description Unauthorized */
19793
+ 401: {
19794
+ headers: {
19795
+ [name: string]: unknown;
19796
+ };
19797
+ content: {
19798
+ "application/json": {
19799
+ code: string;
19800
+ message: string;
19801
+ issues?: {
19802
+ message: string;
19803
+ }[];
19804
+ context?: unknown;
19805
+ };
19806
+ };
19807
+ };
19808
+ /** @description Forbidden */
19809
+ 403: {
19810
+ headers: {
19811
+ [name: string]: unknown;
19812
+ };
19813
+ content: {
19814
+ "application/json": {
19815
+ code: string;
19816
+ message: string;
19817
+ issues?: {
19818
+ message: string;
19819
+ }[];
19820
+ context?: unknown;
19821
+ };
19822
+ };
19823
+ };
19824
+ /** @description Not found */
19825
+ 404: {
19826
+ headers: {
19827
+ [name: string]: unknown;
19828
+ };
19829
+ content: {
19830
+ "application/json": {
19831
+ code: string;
19832
+ message: string;
19833
+ issues?: {
19834
+ message: string;
19835
+ }[];
19836
+ context?: unknown;
19837
+ };
19838
+ };
19839
+ };
19840
+ /** @description Internal server error */
19841
+ 500: {
19842
+ headers: {
19843
+ [name: string]: unknown;
19844
+ };
19845
+ content: {
19846
+ "application/json": {
19847
+ code: string;
19848
+ message: string;
19849
+ issues?: {
19850
+ message: string;
19851
+ }[];
19852
+ context?: unknown;
19853
+ };
19854
+ };
19855
+ };
19856
+ };
19857
+ };
19443
19858
  "postReservationsJournal-entries": {
19444
19859
  parameters: {
19445
19860
  query?: never;
@@ -31024,6 +31439,131 @@ export interface operations {
31024
31439
  };
31025
31440
  };
31026
31441
  };
31442
+ getTransactionsExpensesCsv: {
31443
+ parameters: {
31444
+ query?: {
31445
+ type?: "deposit" | "expense" | "transfer";
31446
+ status?: "active" | "inactive";
31447
+ includeLines?: boolean;
31448
+ accountId?: string;
31449
+ last4?: string;
31450
+ isLocked?: boolean;
31451
+ hasActiveJournalEntries?: boolean;
31452
+ /** @description connection id or 'null' */
31453
+ connectionId?: string;
31454
+ /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
31455
+ dateRange?: string;
31456
+ /** @description Whether the end date is inclusive or exclusive */
31457
+ isDateRangeEndInclusive?: boolean;
31458
+ uniqueRefs?: string;
31459
+ shortRefs?: string;
31460
+ ids?: string;
31461
+ search?: string;
31462
+ recurringTemplateId?: string;
31463
+ paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
31464
+ reconciled?: boolean;
31465
+ contactId?: string;
31466
+ listingIds?: string;
31467
+ };
31468
+ header?: never;
31469
+ path?: never;
31470
+ cookie?: never;
31471
+ };
31472
+ requestBody?: never;
31473
+ responses: {
31474
+ /** @description Successful response */
31475
+ 200: {
31476
+ headers: {
31477
+ [name: string]: unknown;
31478
+ };
31479
+ content: {
31480
+ "application/json": {
31481
+ url: string;
31482
+ };
31483
+ };
31484
+ };
31485
+ /** @description Bad request */
31486
+ 400: {
31487
+ headers: {
31488
+ [name: string]: unknown;
31489
+ };
31490
+ content: {
31491
+ "application/json": {
31492
+ code: string;
31493
+ message: string;
31494
+ issues?: {
31495
+ message: string;
31496
+ }[];
31497
+ context?: unknown;
31498
+ };
31499
+ };
31500
+ };
31501
+ /** @description Unauthorized */
31502
+ 401: {
31503
+ headers: {
31504
+ [name: string]: unknown;
31505
+ };
31506
+ content: {
31507
+ "application/json": {
31508
+ code: string;
31509
+ message: string;
31510
+ issues?: {
31511
+ message: string;
31512
+ }[];
31513
+ context?: unknown;
31514
+ };
31515
+ };
31516
+ };
31517
+ /** @description Forbidden */
31518
+ 403: {
31519
+ headers: {
31520
+ [name: string]: unknown;
31521
+ };
31522
+ content: {
31523
+ "application/json": {
31524
+ code: string;
31525
+ message: string;
31526
+ issues?: {
31527
+ message: string;
31528
+ }[];
31529
+ context?: unknown;
31530
+ };
31531
+ };
31532
+ };
31533
+ /** @description Not found */
31534
+ 404: {
31535
+ headers: {
31536
+ [name: string]: unknown;
31537
+ };
31538
+ content: {
31539
+ "application/json": {
31540
+ code: string;
31541
+ message: string;
31542
+ issues?: {
31543
+ message: string;
31544
+ }[];
31545
+ context?: unknown;
31546
+ };
31547
+ };
31548
+ };
31549
+ /** @description Internal server error */
31550
+ 500: {
31551
+ headers: {
31552
+ [name: string]: unknown;
31553
+ };
31554
+ content: {
31555
+ "application/json": {
31556
+ code: string;
31557
+ message: string;
31558
+ issues?: {
31559
+ message: string;
31560
+ }[];
31561
+ context?: unknown;
31562
+ };
31563
+ };
31564
+ };
31565
+ };
31566
+ };
31027
31567
  "postTransactionsJournal-entries": {
31028
31568
  parameters: {
31029
31569
  query?: never;