@vrplatform/api 1.3.1-1776 → 1.3.1-1789

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-1776",
9
+ "version": "1.3.1-1789",
10
10
  "description": "",
11
11
  "main": "build/main/index.js",
12
12
  "module": "build/module/index.js",
@@ -1737,32 +1737,15 @@ export interface paths {
1737
1737
  patch?: never;
1738
1738
  trace?: never;
1739
1739
  };
1740
- "/statements/csv": {
1741
- parameters: {
1742
- query?: never;
1743
- header?: never;
1744
- path?: never;
1745
- cookie?: never;
1746
- };
1747
- /** @description Get Owner Statement CSV export */
1748
- get: operations["getStatementsCsv"];
1749
- put?: never;
1750
- post?: never;
1751
- delete?: never;
1752
- options?: never;
1753
- head?: never;
1754
- patch?: never;
1755
- trace?: never;
1756
- };
1757
- "/statements/csv/batch": {
1740
+ "/statements/batch/csv": {
1758
1741
  parameters: {
1759
1742
  query?: never;
1760
1743
  header?: never;
1761
1744
  path?: never;
1762
1745
  cookie?: never;
1763
1746
  };
1764
- /** @description Get Owner Statement CSV ZIP export */
1765
- get: operations["getStatementsCsvBatch"];
1747
+ /** @description Get Owner Statement CSV export (detailed) */
1748
+ get: operations["getStatementsBatchCsv"];
1766
1749
  put?: never;
1767
1750
  post?: never;
1768
1751
  delete?: never;
@@ -1771,15 +1754,15 @@ export interface paths {
1771
1754
  patch?: never;
1772
1755
  trace?: never;
1773
1756
  };
1774
- "/statements/csv/detailed": {
1757
+ "/statements/csv": {
1775
1758
  parameters: {
1776
1759
  query?: never;
1777
1760
  header?: never;
1778
1761
  path?: never;
1779
1762
  cookie?: never;
1780
1763
  };
1781
- /** @description Get Owner Statement CSV export (detailed) */
1782
- get: operations["getStatementsCsvDetailed"];
1764
+ /** @description Get Owner Statement CSV export */
1765
+ get: operations["getStatementsCsv"];
1783
1766
  put?: never;
1784
1767
  post?: never;
1785
1768
  delete?: never;
@@ -2086,23 +2069,6 @@ export interface paths {
2086
2069
  patch?: never;
2087
2070
  trace?: never;
2088
2071
  };
2089
- "/teams/opening-balances/advanced-deposits/synced-payments-refunds/{reservationId}": {
2090
- parameters: {
2091
- query?: never;
2092
- header?: never;
2093
- path?: never;
2094
- cookie?: never;
2095
- };
2096
- /** @description Retrieve synced payments/refunds for a single reservation (review advanced deposits) */
2097
- get: operations["getTeamsOpening-balancesAdvanced-depositsSynced-payments-refunds:reservationId"];
2098
- put?: never;
2099
- post?: never;
2100
- delete?: never;
2101
- options?: never;
2102
- head?: never;
2103
- patch?: never;
2104
- trace?: never;
2105
- };
2106
2072
  "/teams/opening-balances/tax-payable": {
2107
2073
  parameters: {
2108
2074
  query?: never;
@@ -15759,6 +15725,8 @@ export interface operations {
15759
15725
  id: string;
15760
15726
  title: string;
15761
15727
  categoryId: string;
15728
+ /** @enum {string} */
15729
+ party?: "owners" | "manager";
15762
15730
  values: {
15763
15731
  id: string;
15764
15732
  title: string;
@@ -15789,6 +15757,8 @@ export interface operations {
15789
15757
  id: string;
15790
15758
  title: string;
15791
15759
  categoryId: string;
15760
+ /** @enum {string} */
15761
+ party?: "owners" | "manager";
15792
15762
  values: {
15793
15763
  id: string;
15794
15764
  title: string;
@@ -15819,6 +15789,8 @@ export interface operations {
15819
15789
  id: string;
15820
15790
  title: string;
15821
15791
  categoryId: string;
15792
+ /** @enum {string} */
15793
+ party?: "owners" | "manager";
15822
15794
  values: {
15823
15795
  id: string;
15824
15796
  title: string;
@@ -15849,6 +15821,8 @@ export interface operations {
15849
15821
  id: string;
15850
15822
  title: string;
15851
15823
  categoryId: string;
15824
+ /** @enum {string} */
15825
+ party?: "owners" | "manager";
15852
15826
  values: {
15853
15827
  id: string;
15854
15828
  title: string;
@@ -16456,6 +16430,62 @@ export interface operations {
16456
16430
  id: string;
16457
16431
  /** @enum {string} */
16458
16432
  active: "active" | "inactive";
16433
+ issues: ({
16434
+ /** @constant */
16435
+ code: "generalLedgerStartAt";
16436
+ /** @constant */
16437
+ severity: "warning";
16438
+ context: {
16439
+ statementStartAt?: string | null;
16440
+ };
16441
+ } | {
16442
+ /** @constant */
16443
+ code: "listingInactive";
16444
+ /** @constant */
16445
+ severity: "warning";
16446
+ context: {
16447
+ listingOwnershipPeriodId?: string | null;
16448
+ };
16449
+ } | {
16450
+ /** @constant */
16451
+ code: "reservationGeneralLedgerStatusInactive";
16452
+ /** @constant */
16453
+ severity: "warning";
16454
+ context: {
16455
+ reservationId?: string | null;
16456
+ };
16457
+ } | {
16458
+ /** @constant */
16459
+ code: "cancelledReservationLine";
16460
+ /** @constant */
16461
+ severity: "warning";
16462
+ context: {
16463
+ reservationId?: string | null;
16464
+ };
16465
+ } | {
16466
+ /** @constant */
16467
+ code: "inactiveAccount";
16468
+ /** @constant */
16469
+ severity: "warning";
16470
+ context: {
16471
+ accountId?: string | null;
16472
+ };
16473
+ } | {
16474
+ /** @constant */
16475
+ code: "nonPostingAccount";
16476
+ /** @constant */
16477
+ severity: "warning";
16478
+ context: {
16479
+ accountId?: string | null;
16480
+ };
16481
+ } | {
16482
+ /** @constant */
16483
+ code: "unknownInactiveReason";
16484
+ /** @constant */
16485
+ severity: "error";
16486
+ context: Record<string, never>;
16487
+ message: string;
16488
+ })[];
16459
16489
  txnCode: string;
16460
16490
  txnAt: string;
16461
16491
  description: string;
@@ -17060,6 +17090,62 @@ export interface operations {
17060
17090
  id: string;
17061
17091
  /** @enum {string} */
17062
17092
  active: "active" | "inactive";
17093
+ issues: ({
17094
+ /** @constant */
17095
+ code: "generalLedgerStartAt";
17096
+ /** @constant */
17097
+ severity: "warning";
17098
+ context: {
17099
+ statementStartAt?: string | null;
17100
+ };
17101
+ } | {
17102
+ /** @constant */
17103
+ code: "listingInactive";
17104
+ /** @constant */
17105
+ severity: "warning";
17106
+ context: {
17107
+ listingOwnershipPeriodId?: string | null;
17108
+ };
17109
+ } | {
17110
+ /** @constant */
17111
+ code: "reservationGeneralLedgerStatusInactive";
17112
+ /** @constant */
17113
+ severity: "warning";
17114
+ context: {
17115
+ reservationId?: string | null;
17116
+ };
17117
+ } | {
17118
+ /** @constant */
17119
+ code: "cancelledReservationLine";
17120
+ /** @constant */
17121
+ severity: "warning";
17122
+ context: {
17123
+ reservationId?: string | null;
17124
+ };
17125
+ } | {
17126
+ /** @constant */
17127
+ code: "inactiveAccount";
17128
+ /** @constant */
17129
+ severity: "warning";
17130
+ context: {
17131
+ accountId?: string | null;
17132
+ };
17133
+ } | {
17134
+ /** @constant */
17135
+ code: "nonPostingAccount";
17136
+ /** @constant */
17137
+ severity: "warning";
17138
+ context: {
17139
+ accountId?: string | null;
17140
+ };
17141
+ } | {
17142
+ /** @constant */
17143
+ code: "unknownInactiveReason";
17144
+ /** @constant */
17145
+ severity: "error";
17146
+ context: Record<string, never>;
17147
+ message: string;
17148
+ })[];
17063
17149
  txnCode: string;
17064
17150
  txnAt: string;
17065
17151
  description: string;
@@ -20460,6 +20546,8 @@ export interface operations {
20460
20546
  "application/json": {
20461
20547
  dangerouslyAllowLocked?: boolean;
20462
20548
  ids?: string[];
20549
+ /** @enum {string} */
20550
+ mode?: "full" | "recurringFeesOnly" | "decoupledAdjustmentsOnly" | "arOnly";
20463
20551
  repairManagerFeeBalance?: boolean;
20464
20552
  };
20465
20553
  };
@@ -24968,139 +25056,11 @@ export interface operations {
24968
25056
  };
24969
25057
  };
24970
25058
  };
24971
- getStatementsCsv: {
24972
- parameters: {
24973
- query?: {
24974
- limit?: number;
24975
- page?: number;
24976
- /** @description comma separated periods */
24977
- periodIds?: string;
24978
- /** @description Year in format YYYY */
24979
- year?: number;
24980
- /** @description comma separated listings */
24981
- listingIds?: string;
24982
- /** @description comma separated statements */
24983
- statementIds?: string;
24984
- /** @description Date in format YYYY-MM */
24985
- month?: string;
24986
- search?: string;
24987
- status?: ("draft" | "inReview" | "published") | "all";
24988
- /** @description comma separated owners */
24989
- ownerIds?: string;
24990
- /** @description comma separated owners */
24991
- listingCollectionIds?: string;
24992
- /** @description comma separated recurring fees */
24993
- recurringFeeIds?: string;
24994
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
24995
- dateRange?: string;
24996
- /** @description Whether the end date is inclusive or exclusive */
24997
- isDateRangeEndInclusive?: boolean;
24998
- };
24999
- header?: never;
25000
- path?: never;
25001
- cookie?: never;
25002
- };
25003
- requestBody?: never;
25004
- responses: {
25005
- /** @description Successful response */
25006
- 200: {
25007
- headers: {
25008
- [name: string]: unknown;
25009
- };
25010
- content: {
25011
- "application/json": {
25012
- url: string;
25013
- expIn: number;
25014
- };
25015
- };
25016
- };
25017
- /** @description Bad request */
25018
- 400: {
25019
- headers: {
25020
- [name: string]: unknown;
25021
- };
25022
- content: {
25023
- "application/json": {
25024
- code: string;
25025
- message: string;
25026
- issues?: {
25027
- message: string;
25028
- }[];
25029
- context?: unknown;
25030
- };
25031
- };
25032
- };
25033
- /** @description Unauthorized */
25034
- 401: {
25035
- headers: {
25036
- [name: string]: unknown;
25037
- };
25038
- content: {
25039
- "application/json": {
25040
- code: string;
25041
- message: string;
25042
- issues?: {
25043
- message: string;
25044
- }[];
25045
- context?: unknown;
25046
- };
25047
- };
25048
- };
25049
- /** @description Forbidden */
25050
- 403: {
25051
- headers: {
25052
- [name: string]: unknown;
25053
- };
25054
- content: {
25055
- "application/json": {
25056
- code: string;
25057
- message: string;
25058
- issues?: {
25059
- message: string;
25060
- }[];
25061
- context?: unknown;
25062
- };
25063
- };
25064
- };
25065
- /** @description Not found */
25066
- 404: {
25067
- headers: {
25068
- [name: string]: unknown;
25069
- };
25070
- content: {
25071
- "application/json": {
25072
- code: string;
25073
- message: string;
25074
- issues?: {
25075
- message: string;
25076
- }[];
25077
- context?: unknown;
25078
- };
25079
- };
25080
- };
25081
- /** @description Internal server error */
25082
- 500: {
25083
- headers: {
25084
- [name: string]: unknown;
25085
- };
25086
- content: {
25087
- "application/json": {
25088
- code: string;
25089
- message: string;
25090
- issues?: {
25091
- message: string;
25092
- }[];
25093
- context?: unknown;
25094
- };
25095
- };
25096
- };
25097
- };
25098
- };
25099
- getStatementsCsvBatch: {
25059
+ getStatementsBatchCsv: {
25100
25060
  parameters: {
25101
25061
  query: {
25102
- /** @description comma separated ownership periods */
25103
- ownershipPeriodIds: string;
25062
+ viewAs?: "owner" | "manager";
25063
+ ownershipPeriodId: string;
25104
25064
  /** @description Date in format YYYY-MM */
25105
25065
  month: string;
25106
25066
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
@@ -25206,7 +25166,7 @@ export interface operations {
25206
25166
  };
25207
25167
  };
25208
25168
  };
25209
- getStatementsCsvDetailed: {
25169
+ getStatementsCsv: {
25210
25170
  parameters: {
25211
25171
  query?: {
25212
25172
  limit?: number;
@@ -25227,8 +25187,6 @@ export interface operations {
25227
25187
  ownerIds?: string;
25228
25188
  /** @description comma separated owners */
25229
25189
  listingCollectionIds?: string;
25230
- /** @description statement layout id */
25231
- layoutId?: string;
25232
25190
  /** @description comma separated recurring fees */
25233
25191
  recurringFeeIds?: string;
25234
25192
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
@@ -29627,8 +29585,6 @@ export interface operations {
29627
29585
  countryCode?: string | null;
29628
29586
  } | null;
29629
29587
  phone?: string | null;
29630
- /** Format: email */
29631
- email: string;
29632
29588
  taxId?: string | null;
29633
29589
  companyName?: string | null;
29634
29590
  /** @enum {string} */
@@ -29656,6 +29612,8 @@ export interface operations {
29656
29612
  userId: string;
29657
29613
  role: string;
29658
29614
  }[] | null;
29615
+ /** Format: email */
29616
+ email: string;
29659
29617
  };
29660
29618
  };
29661
29619
  };
@@ -30111,7 +30069,10 @@ export interface operations {
30111
30069
  };
30112
30070
  "getTeamsOpening-balancesAdvanced-depositsSynced-payments-refunds": {
30113
30071
  parameters: {
30114
- query?: never;
30072
+ query?: {
30073
+ /** @description comma separated list of reservation ids */
30074
+ reservationsIds?: string;
30075
+ };
30115
30076
  header?: never;
30116
30077
  path?: never;
30117
30078
  cookie?: never;
@@ -30241,135 +30202,6 @@ export interface operations {
30241
30202
  };
30242
30203
  };
30243
30204
  };
30244
- "getTeamsOpening-balancesAdvanced-depositsSynced-payments-refunds:reservationId": {
30245
- parameters: {
30246
- query?: never;
30247
- header?: never;
30248
- path: {
30249
- reservationId: string;
30250
- };
30251
- cookie?: never;
30252
- };
30253
- requestBody?: never;
30254
- responses: {
30255
- /** @description Successful response */
30256
- 200: {
30257
- headers: {
30258
- [name: string]: unknown;
30259
- };
30260
- content: {
30261
- "application/json": {
30262
- /** Format: uuid */
30263
- reservationId: string;
30264
- listingId?: string | null;
30265
- confirmationCode?: string | null;
30266
- guestName?: string | null;
30267
- checkIn?: string | null;
30268
- checkOut?: string | null;
30269
- bookedAt?: string | null;
30270
- reservationAmount?: number | null;
30271
- /** @description Value in cents (100 = 1€) */
30272
- payment: number;
30273
- /** @description Value in cents (100 = 1€) */
30274
- refund: number;
30275
- transactions: {
30276
- /** Format: uuid */
30277
- transactionId: string;
30278
- /** Format: uuid */
30279
- transactionLineId: string;
30280
- date: string;
30281
- uniqueRef?: string | null;
30282
- description?: string | null;
30283
- /** @description Value in cents (100 = 1€) */
30284
- amount: number;
30285
- /** @enum {string} */
30286
- direction: "payment" | "refund";
30287
- }[];
30288
- };
30289
- };
30290
- };
30291
- /** @description Bad request */
30292
- 400: {
30293
- headers: {
30294
- [name: string]: unknown;
30295
- };
30296
- content: {
30297
- "application/json": {
30298
- code: string;
30299
- message: string;
30300
- issues?: {
30301
- message: string;
30302
- }[];
30303
- context?: unknown;
30304
- };
30305
- };
30306
- };
30307
- /** @description Unauthorized */
30308
- 401: {
30309
- headers: {
30310
- [name: string]: unknown;
30311
- };
30312
- content: {
30313
- "application/json": {
30314
- code: string;
30315
- message: string;
30316
- issues?: {
30317
- message: string;
30318
- }[];
30319
- context?: unknown;
30320
- };
30321
- };
30322
- };
30323
- /** @description Forbidden */
30324
- 403: {
30325
- headers: {
30326
- [name: string]: unknown;
30327
- };
30328
- content: {
30329
- "application/json": {
30330
- code: string;
30331
- message: string;
30332
- issues?: {
30333
- message: string;
30334
- }[];
30335
- context?: unknown;
30336
- };
30337
- };
30338
- };
30339
- /** @description Not found */
30340
- 404: {
30341
- headers: {
30342
- [name: string]: unknown;
30343
- };
30344
- content: {
30345
- "application/json": {
30346
- code: string;
30347
- message: string;
30348
- issues?: {
30349
- message: string;
30350
- }[];
30351
- context?: unknown;
30352
- };
30353
- };
30354
- };
30355
- /** @description Internal server error */
30356
- 500: {
30357
- headers: {
30358
- [name: string]: unknown;
30359
- };
30360
- content: {
30361
- "application/json": {
30362
- code: string;
30363
- message: string;
30364
- issues?: {
30365
- message: string;
30366
- }[];
30367
- context?: unknown;
30368
- };
30369
- };
30370
- };
30371
- };
30372
- };
30373
30205
  "getTeamsOpening-balancesTax-payable": {
30374
30206
  parameters: {
30375
30207
  query?: never;
@@ -30836,8 +30668,6 @@ export interface operations {
30836
30668
  countryCode?: string | null;
30837
30669
  } | null;
30838
30670
  phone?: string | null;
30839
- /** Format: email */
30840
- email?: string;
30841
30671
  taxId?: string | null;
30842
30672
  companyName?: string | null;
30843
30673
  /** @enum {string} */
@@ -30853,6 +30683,8 @@ export interface operations {
30853
30683
  ownerPortalShowDraftStatements?: boolean;
30854
30684
  partnerId?: string | null;
30855
30685
  billingPartnerId?: string | null;
30686
+ /** Format: email */
30687
+ email?: string;
30856
30688
  /** @description Cancelation or Reinstatement of the team. */
30857
30689
  cancelation?: {
30858
30690
  /** @description Date on which the cancelation will take effect or null if an active cancellation should be withdrawn. */
@@ -31624,6 +31456,9 @@ export interface operations {
31624
31456
  hasActiveJournalEntries?: boolean;
31625
31457
  /** @description connection id or 'null' */
31626
31458
  connectionId?: string;
31459
+ /** @description Amount in cents, also accepts ranges like 100...200 */
31460
+ amount?: string;
31461
+ paidAtRange?: string;
31627
31462
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
31628
31463
  dateRange?: string;
31629
31464
  /** @description Whether the end date is inclusive or exclusive */
@@ -32696,6 +32531,9 @@ export interface operations {
32696
32531
  hasActiveJournalEntries?: boolean;
32697
32532
  /** @description connection id or 'null' */
32698
32533
  connectionId?: string;
32534
+ /** @description Amount in cents, also accepts ranges like 100...200 */
32535
+ amount?: string;
32536
+ paidAtRange?: string;
32699
32537
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
32700
32538
  dateRange?: string;
32701
32539
  /** @description Whether the end date is inclusive or exclusive */
@@ -32821,6 +32659,9 @@ export interface operations {
32821
32659
  hasActiveJournalEntries?: boolean;
32822
32660
  /** @description connection id or 'null' */
32823
32661
  connectionId?: string;
32662
+ /** @description Amount in cents, also accepts ranges like 100...200 */
32663
+ amount?: string;
32664
+ paidAtRange?: string;
32824
32665
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
32825
32666
  dateRange?: string;
32826
32667
  /** @description Whether the end date is inclusive or exclusive */
@@ -32946,6 +32787,9 @@ export interface operations {
32946
32787
  hasActiveJournalEntries?: boolean;
32947
32788
  /** @description connection id or 'null' */
32948
32789
  connectionId?: string;
32790
+ /** @description Amount in cents, also accepts ranges like 100...200 */
32791
+ amount?: string;
32792
+ paidAtRange?: string;
32949
32793
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
32950
32794
  dateRange?: string;
32951
32795
  /** @description Whether the end date is inclusive or exclusive */
@@ -35133,6 +34977,9 @@ export interface operations {
35133
34977
  hasActiveJournalEntries?: boolean;
35134
34978
  /** @description connection id or 'null' */
35135
34979
  connectionId?: string;
34980
+ /** @description Amount in cents, also accepts ranges like 100...200 */
34981
+ amount?: string;
34982
+ paidAtRange?: string;
35136
34983
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
35137
34984
  dateRange?: string;
35138
34985
  /** @description Whether the end date is inclusive or exclusive */