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