@vrplatform/api 1.3.1-stage.1430 → 1.3.1-stage.1432

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.1430",
9
+ "version": "1.3.1-stage.1432",
10
10
  "description": "",
11
11
  "main": "build/main/index.js",
12
12
  "module": "build/module/index.js",
@@ -1204,23 +1204,6 @@ export interface paths {
1204
1204
  patch?: never;
1205
1205
  trace?: never;
1206
1206
  };
1207
- "/reports/owner-statement-summaries-per-layout-v2": {
1208
- parameters: {
1209
- query?: never;
1210
- header?: never;
1211
- path?: never;
1212
- cookie?: never;
1213
- };
1214
- /** @description Owner statement summaries aggregated by contact (per layout, v2) */
1215
- get: operations["getOwnerStatementSummariesPerLayoutReportV2"];
1216
- put?: never;
1217
- post?: never;
1218
- delete?: never;
1219
- options?: never;
1220
- head?: never;
1221
- patch?: never;
1222
- trace?: never;
1223
- };
1224
1207
  "/reports/owner-statement-summaries-per-layout/csv": {
1225
1208
  parameters: {
1226
1209
  query?: never;
@@ -16197,133 +16180,6 @@ export interface operations {
16197
16180
  };
16198
16181
  };
16199
16182
  };
16200
- getOwnerStatementSummariesPerLayoutReportV2: {
16201
- parameters: {
16202
- query: {
16203
- startAt: string;
16204
- endAt: string;
16205
- /** @description comma separated listings */
16206
- listingIds?: string;
16207
- };
16208
- header?: never;
16209
- path?: never;
16210
- cookie?: never;
16211
- };
16212
- requestBody?: never;
16213
- responses: {
16214
- /** @description Successful response */
16215
- 200: {
16216
- headers: {
16217
- [name: string]: unknown;
16218
- };
16219
- content: {
16220
- "application/json": {
16221
- data: {
16222
- contact: {
16223
- contactId: string;
16224
- name?: string;
16225
- firstName?: string;
16226
- /** Format: email */
16227
- email?: string;
16228
- phone?: string;
16229
- };
16230
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
16231
- currency: string;
16232
- financials: {
16233
- balanceStart: number;
16234
- netRevenue: number;
16235
- expenses: number;
16236
- transfers: number;
16237
- netIncome: number;
16238
- currentBalance: number;
16239
- balanceEnd: number;
16240
- };
16241
- }[];
16242
- };
16243
- };
16244
- };
16245
- /** @description Bad request */
16246
- 400: {
16247
- headers: {
16248
- [name: string]: unknown;
16249
- };
16250
- content: {
16251
- "application/json": {
16252
- code: string;
16253
- message: string;
16254
- issues?: {
16255
- message: string;
16256
- }[];
16257
- context?: unknown;
16258
- };
16259
- };
16260
- };
16261
- /** @description Unauthorized */
16262
- 401: {
16263
- headers: {
16264
- [name: string]: unknown;
16265
- };
16266
- content: {
16267
- "application/json": {
16268
- code: string;
16269
- message: string;
16270
- issues?: {
16271
- message: string;
16272
- }[];
16273
- context?: unknown;
16274
- };
16275
- };
16276
- };
16277
- /** @description Forbidden */
16278
- 403: {
16279
- headers: {
16280
- [name: string]: unknown;
16281
- };
16282
- content: {
16283
- "application/json": {
16284
- code: string;
16285
- message: string;
16286
- issues?: {
16287
- message: string;
16288
- }[];
16289
- context?: unknown;
16290
- };
16291
- };
16292
- };
16293
- /** @description Not found */
16294
- 404: {
16295
- headers: {
16296
- [name: string]: unknown;
16297
- };
16298
- content: {
16299
- "application/json": {
16300
- code: string;
16301
- message: string;
16302
- issues?: {
16303
- message: string;
16304
- }[];
16305
- context?: unknown;
16306
- };
16307
- };
16308
- };
16309
- /** @description Internal server error */
16310
- 500: {
16311
- headers: {
16312
- [name: string]: unknown;
16313
- };
16314
- content: {
16315
- "application/json": {
16316
- code: string;
16317
- message: string;
16318
- issues?: {
16319
- message: string;
16320
- }[];
16321
- context?: unknown;
16322
- };
16323
- };
16324
- };
16325
- };
16326
- };
16327
16183
  getOwnerStatementSummariesPerLayoutReportCsv: {
16328
16184
  parameters: {
16329
16185
  query: {
@@ -16480,15 +16336,44 @@ export interface operations {
16480
16336
  layoutId: string;
16481
16337
  layoutName: string;
16482
16338
  statementIds: string[];
16339
+ draftStatementRefs?: {
16340
+ /** Format: uuid */
16341
+ ownershipPeriodId: string;
16342
+ /** @description Date in format YYYY-MM */
16343
+ month: string;
16344
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16345
+ currency: string;
16346
+ }[];
16483
16347
  netRevenueSection: {
16484
16348
  title: string;
16485
16349
  rows: {
16350
+ id: string;
16486
16351
  title: string;
16487
16352
  statementIds?: string[];
16353
+ draftStatementRefs?: {
16354
+ /** Format: uuid */
16355
+ ownershipPeriodId: string;
16356
+ /** @description Date in format YYYY-MM */
16357
+ month: string;
16358
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16359
+ currency: string;
16360
+ }[];
16361
+ ownerStatements?: {
16362
+ id?: string | null;
16363
+ /** Format: uuid */
16364
+ ownershipPeriodId: string;
16365
+ /** @enum {string} */
16366
+ status: "draft" | "inReview" | "void" | "published";
16367
+ /** @description Date in format YYYY-MM */
16368
+ month: string;
16369
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16370
+ currency: string;
16371
+ }[] | null;
16488
16372
  columns: {
16489
16373
  title: string;
16490
16374
  value: number | string;
16491
16375
  formatted: string;
16376
+ accountIds: string[];
16492
16377
  }[];
16493
16378
  }[];
16494
16379
  subtotal?: {
@@ -16497,18 +16382,40 @@ export interface operations {
16497
16382
  title: string;
16498
16383
  value: number | string;
16499
16384
  formatted: string;
16385
+ accountIds: string[];
16500
16386
  }[];
16501
16387
  };
16502
16388
  };
16503
16389
  otherSections: {
16504
16390
  title: string;
16505
16391
  rows: {
16392
+ id: string;
16506
16393
  title: string;
16507
16394
  statementIds?: string[];
16395
+ draftStatementRefs?: {
16396
+ /** Format: uuid */
16397
+ ownershipPeriodId: string;
16398
+ /** @description Date in format YYYY-MM */
16399
+ month: string;
16400
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16401
+ currency: string;
16402
+ }[];
16403
+ ownerStatements?: {
16404
+ id?: string | null;
16405
+ /** Format: uuid */
16406
+ ownershipPeriodId: string;
16407
+ /** @enum {string} */
16408
+ status: "draft" | "inReview" | "void" | "published";
16409
+ /** @description Date in format YYYY-MM */
16410
+ month: string;
16411
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16412
+ currency: string;
16413
+ }[] | null;
16508
16414
  columns: {
16509
16415
  title: string;
16510
16416
  value: number | string;
16511
16417
  formatted: string;
16418
+ accountIds: string[];
16512
16419
  }[];
16513
16420
  }[];
16514
16421
  subtotal?: {
@@ -16517,18 +16424,40 @@ export interface operations {
16517
16424
  title: string;
16518
16425
  value: number | string;
16519
16426
  formatted: string;
16427
+ accountIds: string[];
16520
16428
  }[];
16521
16429
  };
16522
16430
  }[];
16523
16431
  transfersSection?: {
16524
16432
  title: string;
16525
16433
  rows: {
16434
+ id: string;
16526
16435
  title: string;
16527
16436
  statementIds?: string[];
16437
+ draftStatementRefs?: {
16438
+ /** Format: uuid */
16439
+ ownershipPeriodId: string;
16440
+ /** @description Date in format YYYY-MM */
16441
+ month: string;
16442
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16443
+ currency: string;
16444
+ }[];
16445
+ ownerStatements?: {
16446
+ id?: string | null;
16447
+ /** Format: uuid */
16448
+ ownershipPeriodId: string;
16449
+ /** @enum {string} */
16450
+ status: "draft" | "inReview" | "void" | "published";
16451
+ /** @description Date in format YYYY-MM */
16452
+ month: string;
16453
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16454
+ currency: string;
16455
+ }[] | null;
16528
16456
  columns: {
16529
16457
  title: string;
16530
16458
  value: number | string;
16531
16459
  formatted: string;
16460
+ accountIds: string[];
16532
16461
  }[];
16533
16462
  }[];
16534
16463
  subtotal?: {
@@ -16537,10 +16466,23 @@ export interface operations {
16537
16466
  title: string;
16538
16467
  value: number | string;
16539
16468
  formatted: string;
16469
+ accountIds: string[];
16540
16470
  }[];
16541
16471
  };
16542
16472
  };
16543
16473
  }[];
16474
+ issues?: {
16475
+ /** @constant */
16476
+ code: "orphanOwnerJournalEntries";
16477
+ /** @constant */
16478
+ severity: "warning";
16479
+ context: {
16480
+ affected: number;
16481
+ startAt: string;
16482
+ endAt: string;
16483
+ };
16484
+ message: string;
16485
+ }[];
16544
16486
  };
16545
16487
  };
16546
16488
  };
@@ -21811,6 +21753,26 @@ export interface operations {
21811
21753
  severity: "error";
21812
21754
  context: Record<string, never>;
21813
21755
  message: string;
21756
+ } | {
21757
+ /** @constant */
21758
+ code: "previousUnpublishedStatement";
21759
+ /** @constant */
21760
+ severity: "error";
21761
+ context: {
21762
+ priorStatementStartAt: string;
21763
+ priorStatementStatus: string;
21764
+ };
21765
+ message: string;
21766
+ } | {
21767
+ /** @constant */
21768
+ code: "previousUnattachedOwnerActivity";
21769
+ /** @constant */
21770
+ severity: "error";
21771
+ context: {
21772
+ affected: number;
21773
+ windowStartAt: string;
21774
+ };
21775
+ message: string;
21814
21776
  } | {
21815
21777
  /** @constant */
21816
21778
  code: "balanceMismatch_start";
@@ -21855,6 +21817,16 @@ export interface operations {
21855
21817
  affected: number;
21856
21818
  };
21857
21819
  message: string;
21820
+ } | {
21821
+ /** @constant */
21822
+ code: "missingPreviousStatement";
21823
+ /** @constant */
21824
+ severity: "warning";
21825
+ context: {
21826
+ periodStartAt: string;
21827
+ statementStartAt: string;
21828
+ };
21829
+ message: string;
21858
21830
  } | {
21859
21831
  /** @constant */
21860
21832
  code: "unpaidReservations";
@@ -21868,8 +21840,10 @@ export interface operations {
21868
21840
  /** @constant */
21869
21841
  severity: "warning";
21870
21842
  context: {
21871
- layoutUpdatedAt: string;
21872
- statementCreatedAt: string;
21843
+ layoutVersion?: number | null;
21844
+ statementLayoutVersion?: number | null;
21845
+ layoutUpdatedAt?: string | null;
21846
+ statementCreatedAt?: string | null;
21873
21847
  };
21874
21848
  message: string;
21875
21849
  })[];
@@ -22102,6 +22076,26 @@ export interface operations {
22102
22076
  severity: "error";
22103
22077
  context: Record<string, never>;
22104
22078
  message: string;
22079
+ } | {
22080
+ /** @constant */
22081
+ code: "previousUnpublishedStatement";
22082
+ /** @constant */
22083
+ severity: "error";
22084
+ context: {
22085
+ priorStatementStartAt: string;
22086
+ priorStatementStatus: string;
22087
+ };
22088
+ message: string;
22089
+ } | {
22090
+ /** @constant */
22091
+ code: "previousUnattachedOwnerActivity";
22092
+ /** @constant */
22093
+ severity: "error";
22094
+ context: {
22095
+ affected: number;
22096
+ windowStartAt: string;
22097
+ };
22098
+ message: string;
22105
22099
  } | {
22106
22100
  /** @constant */
22107
22101
  code: "balanceMismatch_start";
@@ -22146,6 +22140,16 @@ export interface operations {
22146
22140
  affected: number;
22147
22141
  };
22148
22142
  message: string;
22143
+ } | {
22144
+ /** @constant */
22145
+ code: "missingPreviousStatement";
22146
+ /** @constant */
22147
+ severity: "warning";
22148
+ context: {
22149
+ periodStartAt: string;
22150
+ statementStartAt: string;
22151
+ };
22152
+ message: string;
22149
22153
  } | {
22150
22154
  /** @constant */
22151
22155
  code: "unpaidReservations";
@@ -22159,8 +22163,10 @@ export interface operations {
22159
22163
  /** @constant */
22160
22164
  severity: "warning";
22161
22165
  context: {
22162
- layoutUpdatedAt: string;
22163
- statementCreatedAt: string;
22166
+ layoutVersion?: number | null;
22167
+ statementLayoutVersion?: number | null;
22168
+ layoutUpdatedAt?: string | null;
22169
+ statementCreatedAt?: string | null;
22164
22170
  };
22165
22171
  message: string;
22166
22172
  })[];
@@ -22239,6 +22245,7 @@ export interface operations {
22239
22245
  })[];
22240
22246
  }[];
22241
22247
  id: string;
22248
+ version: number;
22242
22249
  activeListings: {
22243
22250
  id: string;
22244
22251
  name?: string | null;
@@ -22592,6 +22599,26 @@ export interface operations {
22592
22599
  severity: "error";
22593
22600
  context: Record<string, never>;
22594
22601
  message: string;
22602
+ } | {
22603
+ /** @constant */
22604
+ code: "previousUnpublishedStatement";
22605
+ /** @constant */
22606
+ severity: "error";
22607
+ context: {
22608
+ priorStatementStartAt: string;
22609
+ priorStatementStatus: string;
22610
+ };
22611
+ message: string;
22612
+ } | {
22613
+ /** @constant */
22614
+ code: "previousUnattachedOwnerActivity";
22615
+ /** @constant */
22616
+ severity: "error";
22617
+ context: {
22618
+ affected: number;
22619
+ windowStartAt: string;
22620
+ };
22621
+ message: string;
22595
22622
  } | {
22596
22623
  /** @constant */
22597
22624
  code: "balanceMismatch_start";
@@ -22636,6 +22663,16 @@ export interface operations {
22636
22663
  affected: number;
22637
22664
  };
22638
22665
  message: string;
22666
+ } | {
22667
+ /** @constant */
22668
+ code: "missingPreviousStatement";
22669
+ /** @constant */
22670
+ severity: "warning";
22671
+ context: {
22672
+ periodStartAt: string;
22673
+ statementStartAt: string;
22674
+ };
22675
+ message: string;
22639
22676
  } | {
22640
22677
  /** @constant */
22641
22678
  code: "unpaidReservations";
@@ -22649,8 +22686,10 @@ export interface operations {
22649
22686
  /** @constant */
22650
22687
  severity: "warning";
22651
22688
  context: {
22652
- layoutUpdatedAt: string;
22653
- statementCreatedAt: string;
22689
+ layoutVersion?: number | null;
22690
+ statementLayoutVersion?: number | null;
22691
+ layoutUpdatedAt?: string | null;
22692
+ statementCreatedAt?: string | null;
22654
22693
  };
22655
22694
  message: string;
22656
22695
  })[];
@@ -22729,6 +22768,7 @@ export interface operations {
22729
22768
  })[];
22730
22769
  }[];
22731
22770
  id: string;
22771
+ version: number;
22732
22772
  activeListings: {
22733
22773
  id: string;
22734
22774
  name?: string | null;
@@ -23086,6 +23126,7 @@ export interface operations {
23086
23126
  })[];
23087
23127
  }[];
23088
23128
  id: string;
23129
+ version: number;
23089
23130
  activeListings: {
23090
23131
  id: string;
23091
23132
  name?: string | null;
@@ -23337,6 +23378,7 @@ export interface operations {
23337
23378
  })[];
23338
23379
  }[];
23339
23380
  id: string;
23381
+ version: number;
23340
23382
  activeListings: {
23341
23383
  id: string;
23342
23384
  name?: string | null;
@@ -23525,6 +23567,7 @@ export interface operations {
23525
23567
  })[];
23526
23568
  }[];
23527
23569
  id: string;
23570
+ version: number;
23528
23571
  activeListings: {
23529
23572
  id: string;
23530
23573
  name?: string | null;
@@ -23768,6 +23811,7 @@ export interface operations {
23768
23811
  })[];
23769
23812
  }[];
23770
23813
  id: string;
23814
+ version: number;
23771
23815
  activeListings: {
23772
23816
  id: string;
23773
23817
  name?: string | null;
@@ -24600,6 +24644,26 @@ export interface operations {
24600
24644
  severity: "error";
24601
24645
  context: Record<string, never>;
24602
24646
  message: string;
24647
+ } | {
24648
+ /** @constant */
24649
+ code: "previousUnpublishedStatement";
24650
+ /** @constant */
24651
+ severity: "error";
24652
+ context: {
24653
+ priorStatementStartAt: string;
24654
+ priorStatementStatus: string;
24655
+ };
24656
+ message: string;
24657
+ } | {
24658
+ /** @constant */
24659
+ code: "previousUnattachedOwnerActivity";
24660
+ /** @constant */
24661
+ severity: "error";
24662
+ context: {
24663
+ affected: number;
24664
+ windowStartAt: string;
24665
+ };
24666
+ message: string;
24603
24667
  } | {
24604
24668
  /** @constant */
24605
24669
  code: "balanceMismatch_start";
@@ -24644,6 +24708,16 @@ export interface operations {
24644
24708
  affected: number;
24645
24709
  };
24646
24710
  message: string;
24711
+ } | {
24712
+ /** @constant */
24713
+ code: "missingPreviousStatement";
24714
+ /** @constant */
24715
+ severity: "warning";
24716
+ context: {
24717
+ periodStartAt: string;
24718
+ statementStartAt: string;
24719
+ };
24720
+ message: string;
24647
24721
  } | {
24648
24722
  /** @constant */
24649
24723
  code: "unpaidReservations";
@@ -24657,8 +24731,10 @@ export interface operations {
24657
24731
  /** @constant */
24658
24732
  severity: "warning";
24659
24733
  context: {
24660
- layoutUpdatedAt: string;
24661
- statementCreatedAt: string;
24734
+ layoutVersion?: number | null;
24735
+ statementLayoutVersion?: number | null;
24736
+ layoutUpdatedAt?: string | null;
24737
+ statementCreatedAt?: string | null;
24662
24738
  };
24663
24739
  message: string;
24664
24740
  })[];
@@ -24737,6 +24813,7 @@ export interface operations {
24737
24813
  })[];
24738
24814
  }[];
24739
24815
  id: string;
24816
+ version: number;
24740
24817
  activeListings: {
24741
24818
  id: string;
24742
24819
  name?: string | null;
@@ -25095,6 +25172,26 @@ export interface operations {
25095
25172
  severity: "error";
25096
25173
  context: Record<string, never>;
25097
25174
  message: string;
25175
+ } | {
25176
+ /** @constant */
25177
+ code: "previousUnpublishedStatement";
25178
+ /** @constant */
25179
+ severity: "error";
25180
+ context: {
25181
+ priorStatementStartAt: string;
25182
+ priorStatementStatus: string;
25183
+ };
25184
+ message: string;
25185
+ } | {
25186
+ /** @constant */
25187
+ code: "previousUnattachedOwnerActivity";
25188
+ /** @constant */
25189
+ severity: "error";
25190
+ context: {
25191
+ affected: number;
25192
+ windowStartAt: string;
25193
+ };
25194
+ message: string;
25098
25195
  } | {
25099
25196
  /** @constant */
25100
25197
  code: "balanceMismatch_start";
@@ -25139,6 +25236,16 @@ export interface operations {
25139
25236
  affected: number;
25140
25237
  };
25141
25238
  message: string;
25239
+ } | {
25240
+ /** @constant */
25241
+ code: "missingPreviousStatement";
25242
+ /** @constant */
25243
+ severity: "warning";
25244
+ context: {
25245
+ periodStartAt: string;
25246
+ statementStartAt: string;
25247
+ };
25248
+ message: string;
25142
25249
  } | {
25143
25250
  /** @constant */
25144
25251
  code: "unpaidReservations";
@@ -25152,8 +25259,10 @@ export interface operations {
25152
25259
  /** @constant */
25153
25260
  severity: "warning";
25154
25261
  context: {
25155
- layoutUpdatedAt: string;
25156
- statementCreatedAt: string;
25262
+ layoutVersion?: number | null;
25263
+ statementLayoutVersion?: number | null;
25264
+ layoutUpdatedAt?: string | null;
25265
+ statementCreatedAt?: string | null;
25157
25266
  };
25158
25267
  message: string;
25159
25268
  })[];
@@ -25232,6 +25341,7 @@ export interface operations {
25232
25341
  })[];
25233
25342
  }[];
25234
25343
  id: string;
25344
+ version: number;
25235
25345
  activeListings: {
25236
25346
  id: string;
25237
25347
  name?: string | null;