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

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