@vrplatform/api 1.3.1-stage.1611 → 1.3.1-stage.1613

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;
@@ -2122,6 +2156,23 @@ export interface paths {
2122
2156
  patch?: never;
2123
2157
  trace?: never;
2124
2158
  };
2159
+ "/transactions/expenses/csv": {
2160
+ parameters: {
2161
+ query?: never;
2162
+ header?: never;
2163
+ path?: never;
2164
+ cookie?: never;
2165
+ };
2166
+ /** @description Expense transactions CSV export */
2167
+ get: operations["getTransactionsExpensesCsv"];
2168
+ put?: never;
2169
+ post?: never;
2170
+ delete?: never;
2171
+ options?: never;
2172
+ head?: never;
2173
+ patch?: never;
2174
+ trace?: never;
2175
+ };
2125
2176
  "/transactions/journal-entries": {
2126
2177
  parameters: {
2127
2178
  query?: never;
@@ -6523,7 +6574,7 @@ export interface operations {
6523
6574
  };
6524
6575
  };
6525
6576
  };
6526
- createContact: {
6577
+ postContacts: {
6527
6578
  parameters: {
6528
6579
  query?: never;
6529
6580
  header?: never;
@@ -6699,7 +6750,7 @@ export interface operations {
6699
6750
  };
6700
6751
  };
6701
6752
  };
6702
- batchContacts: {
6753
+ postContactsBatch: {
6703
6754
  parameters: {
6704
6755
  query?: never;
6705
6756
  header?: never;
@@ -6848,7 +6899,117 @@ export interface operations {
6848
6899
  };
6849
6900
  };
6850
6901
  };
6851
- getContact: {
6902
+ getContactsCsv: {
6903
+ parameters: {
6904
+ query?: {
6905
+ search?: string;
6906
+ status?: "active" | "inactive";
6907
+ type?: "owner" | "vendor";
6908
+ companyType?: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
6909
+ isIndividual?: boolean;
6910
+ /** @description comma separated contact short refs */
6911
+ shortRefs?: string;
6912
+ };
6913
+ header?: never;
6914
+ path?: never;
6915
+ cookie?: never;
6916
+ };
6917
+ requestBody?: never;
6918
+ responses: {
6919
+ /** @description Successful response */
6920
+ 200: {
6921
+ headers: {
6922
+ [name: string]: unknown;
6923
+ };
6924
+ content: {
6925
+ "application/json": {
6926
+ url: string;
6927
+ };
6928
+ };
6929
+ };
6930
+ /** @description Bad request */
6931
+ 400: {
6932
+ headers: {
6933
+ [name: string]: unknown;
6934
+ };
6935
+ content: {
6936
+ "application/json": {
6937
+ code: string;
6938
+ message: string;
6939
+ issues?: {
6940
+ message: string;
6941
+ }[];
6942
+ context?: unknown;
6943
+ };
6944
+ };
6945
+ };
6946
+ /** @description Unauthorized */
6947
+ 401: {
6948
+ headers: {
6949
+ [name: string]: unknown;
6950
+ };
6951
+ content: {
6952
+ "application/json": {
6953
+ code: string;
6954
+ message: string;
6955
+ issues?: {
6956
+ message: string;
6957
+ }[];
6958
+ context?: unknown;
6959
+ };
6960
+ };
6961
+ };
6962
+ /** @description Forbidden */
6963
+ 403: {
6964
+ headers: {
6965
+ [name: string]: unknown;
6966
+ };
6967
+ content: {
6968
+ "application/json": {
6969
+ code: string;
6970
+ message: string;
6971
+ issues?: {
6972
+ message: string;
6973
+ }[];
6974
+ context?: unknown;
6975
+ };
6976
+ };
6977
+ };
6978
+ /** @description Not found */
6979
+ 404: {
6980
+ headers: {
6981
+ [name: string]: unknown;
6982
+ };
6983
+ content: {
6984
+ "application/json": {
6985
+ code: string;
6986
+ message: string;
6987
+ issues?: {
6988
+ message: string;
6989
+ }[];
6990
+ context?: unknown;
6991
+ };
6992
+ };
6993
+ };
6994
+ /** @description Internal server error */
6995
+ 500: {
6996
+ headers: {
6997
+ [name: string]: unknown;
6998
+ };
6999
+ content: {
7000
+ "application/json": {
7001
+ code: string;
7002
+ message: string;
7003
+ issues?: {
7004
+ message: string;
7005
+ }[];
7006
+ context?: unknown;
7007
+ };
7008
+ };
7009
+ };
7010
+ };
7011
+ };
7012
+ "getContacts:id": {
6852
7013
  parameters: {
6853
7014
  query?: never;
6854
7015
  header?: never;
@@ -6996,7 +7157,7 @@ export interface operations {
6996
7157
  };
6997
7158
  };
6998
7159
  };
6999
- updateContact: {
7160
+ "putContacts:id": {
7000
7161
  parameters: {
7001
7162
  query?: never;
7002
7163
  header?: never;
@@ -7173,7 +7334,7 @@ export interface operations {
7173
7334
  };
7174
7335
  };
7175
7336
  };
7176
- deleteContact: {
7337
+ "deleteContacts:id": {
7177
7338
  parameters: {
7178
7339
  query?: {
7179
7340
  onLocked?: "error" | "archive";
@@ -7284,7 +7445,7 @@ export interface operations {
7284
7445
  };
7285
7446
  };
7286
7447
  };
7287
- inviteContact: {
7448
+ "postContacts:idInvite": {
7288
7449
  parameters: {
7289
7450
  query?: never;
7290
7451
  header?: never;
@@ -7395,7 +7556,7 @@ export interface operations {
7395
7556
  };
7396
7557
  };
7397
7558
  };
7398
- revokeContactAccess: {
7559
+ "patchContacts:idRevoke-access": {
7399
7560
  parameters: {
7400
7561
  query?: never;
7401
7562
  header?: never;
@@ -10649,6 +10810,117 @@ export interface operations {
10649
10810
  };
10650
10811
  };
10651
10812
  };
10813
+ getListingsCsv: {
10814
+ parameters: {
10815
+ query?: {
10816
+ status?: "active" | "inactive";
10817
+ connectionId?: string;
10818
+ search?: string;
10819
+ contactId?: string;
10820
+ /** @description comma separated listing short refs */
10821
+ shortRefs?: string;
10822
+ activeOwnership?: boolean;
10823
+ activeRecurringFeePeriods?: string;
10824
+ };
10825
+ header?: never;
10826
+ path?: never;
10827
+ cookie?: never;
10828
+ };
10829
+ requestBody?: never;
10830
+ responses: {
10831
+ /** @description Successful response */
10832
+ 200: {
10833
+ headers: {
10834
+ [name: string]: unknown;
10835
+ };
10836
+ content: {
10837
+ "application/json": {
10838
+ url: string;
10839
+ };
10840
+ };
10841
+ };
10842
+ /** @description Bad request */
10843
+ 400: {
10844
+ headers: {
10845
+ [name: string]: unknown;
10846
+ };
10847
+ content: {
10848
+ "application/json": {
10849
+ code: string;
10850
+ message: string;
10851
+ issues?: {
10852
+ message: string;
10853
+ }[];
10854
+ context?: unknown;
10855
+ };
10856
+ };
10857
+ };
10858
+ /** @description Unauthorized */
10859
+ 401: {
10860
+ headers: {
10861
+ [name: string]: unknown;
10862
+ };
10863
+ content: {
10864
+ "application/json": {
10865
+ code: string;
10866
+ message: string;
10867
+ issues?: {
10868
+ message: string;
10869
+ }[];
10870
+ context?: unknown;
10871
+ };
10872
+ };
10873
+ };
10874
+ /** @description Forbidden */
10875
+ 403: {
10876
+ headers: {
10877
+ [name: string]: unknown;
10878
+ };
10879
+ content: {
10880
+ "application/json": {
10881
+ code: string;
10882
+ message: string;
10883
+ issues?: {
10884
+ message: string;
10885
+ }[];
10886
+ context?: unknown;
10887
+ };
10888
+ };
10889
+ };
10890
+ /** @description Not found */
10891
+ 404: {
10892
+ headers: {
10893
+ [name: string]: unknown;
10894
+ };
10895
+ content: {
10896
+ "application/json": {
10897
+ code: string;
10898
+ message: string;
10899
+ issues?: {
10900
+ message: string;
10901
+ }[];
10902
+ context?: unknown;
10903
+ };
10904
+ };
10905
+ };
10906
+ /** @description Internal server error */
10907
+ 500: {
10908
+ headers: {
10909
+ [name: string]: unknown;
10910
+ };
10911
+ content: {
10912
+ "application/json": {
10913
+ code: string;
10914
+ message: string;
10915
+ issues?: {
10916
+ message: string;
10917
+ }[];
10918
+ context?: unknown;
10919
+ };
10920
+ };
10921
+ };
10922
+ };
10923
+ };
10652
10924
  "getListingsOwnership-periods": {
10653
10925
  parameters: {
10654
10926
  query?: {
@@ -31024,6 +31296,131 @@ export interface operations {
31024
31296
  };
31025
31297
  };
31026
31298
  };
31299
+ getTransactionsExpensesCsv: {
31300
+ parameters: {
31301
+ query?: {
31302
+ type?: "deposit" | "expense" | "transfer";
31303
+ status?: "active" | "inactive";
31304
+ includeLines?: boolean;
31305
+ accountId?: string;
31306
+ last4?: string;
31307
+ isLocked?: boolean;
31308
+ hasActiveJournalEntries?: boolean;
31309
+ /** @description connection id or 'null' */
31310
+ connectionId?: string;
31311
+ /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
31312
+ dateRange?: string;
31313
+ /** @description Whether the end date is inclusive or exclusive */
31314
+ isDateRangeEndInclusive?: boolean;
31315
+ uniqueRefs?: string;
31316
+ shortRefs?: string;
31317
+ ids?: string;
31318
+ search?: string;
31319
+ recurringTemplateId?: string;
31320
+ paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
31321
+ reconciled?: boolean;
31322
+ contactId?: string;
31323
+ listingIds?: string;
31324
+ };
31325
+ header?: never;
31326
+ path?: never;
31327
+ cookie?: never;
31328
+ };
31329
+ requestBody?: never;
31330
+ responses: {
31331
+ /** @description Successful response */
31332
+ 200: {
31333
+ headers: {
31334
+ [name: string]: unknown;
31335
+ };
31336
+ content: {
31337
+ "application/json": {
31338
+ url: string;
31339
+ };
31340
+ };
31341
+ };
31342
+ /** @description Bad request */
31343
+ 400: {
31344
+ headers: {
31345
+ [name: string]: unknown;
31346
+ };
31347
+ content: {
31348
+ "application/json": {
31349
+ code: string;
31350
+ message: string;
31351
+ issues?: {
31352
+ message: string;
31353
+ }[];
31354
+ context?: unknown;
31355
+ };
31356
+ };
31357
+ };
31358
+ /** @description Unauthorized */
31359
+ 401: {
31360
+ headers: {
31361
+ [name: string]: unknown;
31362
+ };
31363
+ content: {
31364
+ "application/json": {
31365
+ code: string;
31366
+ message: string;
31367
+ issues?: {
31368
+ message: string;
31369
+ }[];
31370
+ context?: unknown;
31371
+ };
31372
+ };
31373
+ };
31374
+ /** @description Forbidden */
31375
+ 403: {
31376
+ headers: {
31377
+ [name: string]: unknown;
31378
+ };
31379
+ content: {
31380
+ "application/json": {
31381
+ code: string;
31382
+ message: string;
31383
+ issues?: {
31384
+ message: string;
31385
+ }[];
31386
+ context?: unknown;
31387
+ };
31388
+ };
31389
+ };
31390
+ /** @description Not found */
31391
+ 404: {
31392
+ headers: {
31393
+ [name: string]: unknown;
31394
+ };
31395
+ content: {
31396
+ "application/json": {
31397
+ code: string;
31398
+ message: string;
31399
+ issues?: {
31400
+ message: string;
31401
+ }[];
31402
+ context?: unknown;
31403
+ };
31404
+ };
31405
+ };
31406
+ /** @description Internal server error */
31407
+ 500: {
31408
+ headers: {
31409
+ [name: string]: unknown;
31410
+ };
31411
+ content: {
31412
+ "application/json": {
31413
+ code: string;
31414
+ message: string;
31415
+ issues?: {
31416
+ message: string;
31417
+ }[];
31418
+ context?: unknown;
31419
+ };
31420
+ };
31421
+ };
31422
+ };
31423
+ };
31027
31424
  "postTransactionsJournal-entries": {
31028
31425
  parameters: {
31029
31426
  query?: never;