@vrplatform/api 1.3.0-stage.1158 → 1.3.0-stage.1160

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
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.0-stage.1158",
6
+ "version": "1.3.0-stage.1160",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -1426,6 +1426,23 @@ export interface paths {
1426
1426
  patch?: never;
1427
1427
  trace?: never;
1428
1428
  };
1429
+ "/dispatch/effects": {
1430
+ parameters: {
1431
+ query?: never;
1432
+ header?: never;
1433
+ path?: never;
1434
+ cookie?: never;
1435
+ };
1436
+ /** @description List effects with optional filters by dispatch ID, entity ID, entity type, or status. */
1437
+ get: operations["listEffects"];
1438
+ put?: never;
1439
+ post?: never;
1440
+ delete?: never;
1441
+ options?: never;
1442
+ head?: never;
1443
+ patch?: never;
1444
+ trace?: never;
1445
+ };
1429
1446
  "/dispatch/{id}": {
1430
1447
  parameters: {
1431
1448
  query?: never;
@@ -1443,6 +1460,23 @@ export interface paths {
1443
1460
  patch?: never;
1444
1461
  trace?: never;
1445
1462
  };
1463
+ "/dispatch": {
1464
+ parameters: {
1465
+ query?: never;
1466
+ header?: never;
1467
+ path?: never;
1468
+ cookie?: never;
1469
+ };
1470
+ /** @description List dispatched actions with optional filters. Use entityId to find dispatches related to a specific entity. */
1471
+ get: operations["listDispatchActions"];
1472
+ put?: never;
1473
+ post?: never;
1474
+ delete?: never;
1475
+ options?: never;
1476
+ head?: never;
1477
+ patch?: never;
1478
+ trace?: never;
1479
+ };
1446
1480
  "/plaid/connect": {
1447
1481
  parameters: {
1448
1482
  query?: never;
@@ -5949,7 +5983,7 @@ export interface operations {
5949
5983
  data: {
5950
5984
  /** Format: uuid */
5951
5985
  listingId: string;
5952
- /** @default 2025-11-26 */
5986
+ /** @default 2025-11-27 */
5953
5987
  startAt: string;
5954
5988
  endAt?: string | null;
5955
5989
  setListingInactive?: boolean | null;
@@ -6031,7 +6065,7 @@ export interface operations {
6031
6065
  "application/json": {
6032
6066
  /** Format: uuid */
6033
6067
  listingId: string;
6034
- /** @default 2025-11-26 */
6068
+ /** @default 2025-11-27 */
6035
6069
  startAt?: string;
6036
6070
  endAt?: string | null;
6037
6071
  members: {
@@ -6065,7 +6099,7 @@ export interface operations {
6065
6099
  "application/json": {
6066
6100
  /** Format: uuid */
6067
6101
  listingId: string;
6068
- /** @default 2025-11-26 */
6102
+ /** @default 2025-11-27 */
6069
6103
  startAt: string;
6070
6104
  endAt?: string | null;
6071
6105
  setListingInactive?: boolean | null;
@@ -6145,7 +6179,7 @@ export interface operations {
6145
6179
  "application/json": {
6146
6180
  /** Format: uuid */
6147
6181
  listingId: string;
6148
- /** @default 2025-11-26 */
6182
+ /** @default 2025-11-27 */
6149
6183
  startAt: string;
6150
6184
  endAt?: string | null;
6151
6185
  setListingInactive?: boolean | null;
@@ -6228,7 +6262,7 @@ export interface operations {
6228
6262
  "application/json": {
6229
6263
  /** Format: uuid */
6230
6264
  listingId?: string;
6231
- /** @default 2025-11-26 */
6265
+ /** @default 2025-11-27 */
6232
6266
  startAt?: string;
6233
6267
  endAt?: string | null;
6234
6268
  members?: {
@@ -6262,7 +6296,7 @@ export interface operations {
6262
6296
  "application/json": {
6263
6297
  /** Format: uuid */
6264
6298
  listingId: string;
6265
- /** @default 2025-11-26 */
6299
+ /** @default 2025-11-27 */
6266
6300
  startAt: string;
6267
6301
  endAt?: string | null;
6268
6302
  setListingInactive?: boolean | null;
@@ -6448,7 +6482,7 @@ export interface operations {
6448
6482
  /** Format: uuid */
6449
6483
  sourceId?: string | null;
6450
6484
  initialOwnership?: {
6451
- /** @default 2025-11-26 */
6485
+ /** @default 2025-11-27 */
6452
6486
  startAt?: string;
6453
6487
  endAt?: string | null;
6454
6488
  members: {
@@ -6506,7 +6540,7 @@ export interface operations {
6506
6540
  status: "active" | "inactive";
6507
6541
  defaultCurrency?: string | null;
6508
6542
  activeOwnership?: {
6509
- /** @default 2025-11-26 */
6543
+ /** @default 2025-11-27 */
6510
6544
  startAt: string;
6511
6545
  endAt?: string | null;
6512
6546
  setListingInactive?: boolean | null;
@@ -6747,7 +6781,7 @@ export interface operations {
6747
6781
  status: "active" | "inactive";
6748
6782
  defaultCurrency?: string | null;
6749
6783
  activeOwnership?: {
6750
- /** @default 2025-11-26 */
6784
+ /** @default 2025-11-27 */
6751
6785
  startAt: string;
6752
6786
  endAt?: string | null;
6753
6787
  setListingInactive?: boolean | null;
@@ -6886,7 +6920,7 @@ export interface operations {
6886
6920
  /** Format: uuid */
6887
6921
  sourceId?: string | null;
6888
6922
  initialOwnership?: {
6889
- /** @default 2025-11-26 */
6923
+ /** @default 2025-11-27 */
6890
6924
  startAt?: string;
6891
6925
  endAt?: string | null;
6892
6926
  members: {
@@ -6940,7 +6974,7 @@ export interface operations {
6940
6974
  status: "active" | "inactive";
6941
6975
  defaultCurrency?: string | null;
6942
6976
  activeOwnership?: {
6943
- /** @default 2025-11-26 */
6977
+ /** @default 2025-11-27 */
6944
6978
  startAt: string;
6945
6979
  endAt?: string | null;
6946
6980
  setListingInactive?: boolean | null;
@@ -7157,7 +7191,7 @@ export interface operations {
7157
7191
  status: "active" | "inactive";
7158
7192
  defaultCurrency?: string | null;
7159
7193
  activeOwnership?: {
7160
- /** @default 2025-11-26 */
7194
+ /** @default 2025-11-27 */
7161
7195
  startAt: string;
7162
7196
  endAt?: string | null;
7163
7197
  setListingInactive?: boolean | null;
@@ -7304,7 +7338,7 @@ export interface operations {
7304
7338
  /** Format: uuid */
7305
7339
  sourceId?: string | null;
7306
7340
  initialOwnership?: {
7307
- /** @default 2025-11-26 */
7341
+ /** @default 2025-11-27 */
7308
7342
  startAt?: string;
7309
7343
  endAt?: string | null;
7310
7344
  members: {
@@ -7358,7 +7392,7 @@ export interface operations {
7358
7392
  status: "active" | "inactive";
7359
7393
  defaultCurrency?: string | null;
7360
7394
  activeOwnership?: {
7361
- /** @default 2025-11-26 */
7395
+ /** @default 2025-11-27 */
7362
7396
  startAt: string;
7363
7397
  endAt?: string | null;
7364
7398
  setListingInactive?: boolean | null;
@@ -16910,6 +16944,8 @@ export interface operations {
16910
16944
  uniqueRef?: string | null;
16911
16945
  app: {
16912
16946
  id: string;
16947
+ /** @enum {string} */
16948
+ type: "accountingPlatform" | "propertyManagementSystem" | "bookingChannel" | "service";
16913
16949
  name: string;
16914
16950
  icon?: string | null;
16915
16951
  importers?: string[] | null;
@@ -17085,6 +17121,8 @@ export interface operations {
17085
17121
  uniqueRef?: string | null;
17086
17122
  app: {
17087
17123
  id: string;
17124
+ /** @enum {string} */
17125
+ type: "accountingPlatform" | "propertyManagementSystem" | "bookingChannel" | "service";
17088
17126
  name: string;
17089
17127
  icon?: string | null;
17090
17128
  importers?: string[] | null;
@@ -17188,7 +17226,31 @@ export interface operations {
17188
17226
  };
17189
17227
  content: {
17190
17228
  "application/json": {
17229
+ /** Format: uuid */
17191
17230
  id: string;
17231
+ name: string;
17232
+ /** @enum {string} */
17233
+ status: "active" | "inactive";
17234
+ uniqueRef?: string | null;
17235
+ app: {
17236
+ id: string;
17237
+ /** @enum {string} */
17238
+ type: "accountingPlatform" | "propertyManagementSystem" | "bookingChannel" | "service";
17239
+ name: string;
17240
+ icon?: string | null;
17241
+ importers?: string[] | null;
17242
+ extractors?: string[] | null;
17243
+ };
17244
+ createdAt: string;
17245
+ updatedAt: string;
17246
+ isErrorState: boolean;
17247
+ currentSync?: {
17248
+ /** @enum {string} */
17249
+ status: "queued" | "started" | "completed" | "failed" | "canceled";
17250
+ createdAt: string;
17251
+ updatedAt: string;
17252
+ message?: string | null;
17253
+ } | null;
17192
17254
  };
17193
17255
  };
17194
17256
  };
@@ -21370,15 +21432,22 @@ export interface operations {
21370
21432
  };
21371
21433
  };
21372
21434
  };
21373
- getDispatchAction: {
21435
+ listEffects: {
21374
21436
  parameters: {
21375
- query?: never;
21437
+ query?: {
21438
+ limit?: number;
21439
+ offset?: number;
21440
+ dispatchId?: string;
21441
+ entityId?: string;
21442
+ entityType?: "reservation" | "recurringTransactionTemplate" | "tenant" | "transaction";
21443
+ status?: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
21444
+ effectType?: "CREATE_RECURRING_TRANSACTION_INSTANCE" | "REFRESH_RESERVATION_JOURNAL" | "REFRESH_TRANSACTION_JOURNAL" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "TENANT_HYPERLINE_SYNC" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
21445
+ page?: number;
21446
+ };
21376
21447
  header?: {
21377
21448
  "X-Team-Id"?: string;
21378
21449
  };
21379
- path: {
21380
- id: string;
21381
- };
21450
+ path?: never;
21382
21451
  cookie?: never;
21383
21452
  };
21384
21453
  requestBody?: never;
@@ -21390,22 +21459,122 @@ export interface operations {
21390
21459
  };
21391
21460
  content: {
21392
21461
  "application/json": {
21393
- /** Format: uuid */
21394
- id: string;
21395
- /** Format: uuid */
21396
- tenantId: string;
21397
- actionType: string;
21398
- message: string | null;
21399
- payload?: unknown;
21400
- userId: string | null;
21401
- createdAt: string;
21402
- effects: {
21462
+ data: {
21403
21463
  /** Format: uuid */
21404
21464
  id: string;
21405
- effectType: string;
21465
+ dispatchedAction: {
21466
+ /** Format: uuid */
21467
+ id: string;
21468
+ actionType: string;
21469
+ apiEndpoint: string | null;
21470
+ };
21471
+ /** @enum {string} */
21472
+ effectType: "CREATE_RECURRING_TRANSACTION_INSTANCE" | "REFRESH_RESERVATION_JOURNAL" | "REFRESH_TRANSACTION_JOURNAL" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "TENANT_HYPERLINE_SYNC" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
21406
21473
  payload?: unknown;
21407
- entityType: string | null;
21408
- entityId: string | null;
21474
+ entity: ({
21475
+ /** @enum {string} */
21476
+ type: "reservation";
21477
+ data: {
21478
+ id: string;
21479
+ confirmationCode?: string | null;
21480
+ uniqueRef: string;
21481
+ /** @enum {string} */
21482
+ status: "booked" | "canceled" | "inactive";
21483
+ checkIn?: string | null;
21484
+ checkOut?: string | null;
21485
+ };
21486
+ } | {
21487
+ /** @enum {string} */
21488
+ type: "transaction";
21489
+ data: {
21490
+ id: string;
21491
+ /** @enum {string} */
21492
+ status: "active" | "inactive";
21493
+ /** @description Value in cents (100 = 1€) */
21494
+ amount: number;
21495
+ account?: {
21496
+ id: string;
21497
+ name: string;
21498
+ uniqueRef?: string | null;
21499
+ /** @enum {string} */
21500
+ status: "active" | "inactive";
21501
+ } | null;
21502
+ date: string;
21503
+ description: string;
21504
+ currency: string;
21505
+ /** @enum {string} */
21506
+ type: "deposit" | "expense" | "transfer";
21507
+ contact?: {
21508
+ /** Format: uuid */
21509
+ id: string;
21510
+ name?: string | null;
21511
+ uniqueRef?: string | null;
21512
+ } | null;
21513
+ connection?: {
21514
+ /** Format: uuid */
21515
+ id: string;
21516
+ name: string;
21517
+ /** @enum {string} */
21518
+ status: "active" | "inactive";
21519
+ uniqueRef?: string | null;
21520
+ appId: string;
21521
+ } | null;
21522
+ uniqueRef?: string | null;
21523
+ recurringTemplate?: {
21524
+ id: string;
21525
+ } | null;
21526
+ };
21527
+ } | {
21528
+ /** @enum {string} */
21529
+ type: "recurringTransactionTemplate";
21530
+ data: {
21531
+ id: string;
21532
+ /** @enum {string} */
21533
+ status: "active" | "inactive";
21534
+ /** @description Value in cents (100 = 1€) */
21535
+ amount: number;
21536
+ account?: {
21537
+ id: string;
21538
+ name: string;
21539
+ uniqueRef?: string | null;
21540
+ /** @enum {string} */
21541
+ status: "active" | "inactive";
21542
+ } | null;
21543
+ date: string;
21544
+ description: string;
21545
+ currency: string;
21546
+ /** @enum {string} */
21547
+ type: "deposit" | "expense" | "transfer";
21548
+ contact?: {
21549
+ /** Format: uuid */
21550
+ id: string;
21551
+ name?: string | null;
21552
+ uniqueRef?: string | null;
21553
+ } | null;
21554
+ connection?: {
21555
+ /** Format: uuid */
21556
+ id: string;
21557
+ name: string;
21558
+ /** @enum {string} */
21559
+ status: "active" | "inactive";
21560
+ uniqueRef?: string | null;
21561
+ appId: string;
21562
+ } | null;
21563
+ uniqueRef?: string | null;
21564
+ recurringTemplate?: {
21565
+ id: string;
21566
+ } | null;
21567
+ };
21568
+ } | {
21569
+ /** @enum {string} */
21570
+ type: "other";
21571
+ data: {
21572
+ /** Format: uuid */
21573
+ id: string;
21574
+ type: string;
21575
+ name: string | null;
21576
+ };
21577
+ }) | null;
21409
21578
  /** @enum {string} */
21410
21579
  status: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
21411
21580
  priority: number;
@@ -21419,6 +21588,94 @@ export interface operations {
21419
21588
  lastError: string | null;
21420
21589
  createdAt: string;
21421
21590
  }[];
21591
+ pagination: {
21592
+ /** @default 100 */
21593
+ limit: number;
21594
+ /** @default 1 */
21595
+ page: number;
21596
+ total: number;
21597
+ totalPage: number;
21598
+ nextPage?: number;
21599
+ };
21600
+ };
21601
+ };
21602
+ };
21603
+ /** @description Invalid input data */
21604
+ 400: {
21605
+ headers: {
21606
+ [name: string]: unknown;
21607
+ };
21608
+ content: {
21609
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
21610
+ };
21611
+ };
21612
+ /** @description Authorization not provided */
21613
+ 401: {
21614
+ headers: {
21615
+ [name: string]: unknown;
21616
+ };
21617
+ content: {
21618
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
21619
+ };
21620
+ };
21621
+ /** @description Insufficient access */
21622
+ 403: {
21623
+ headers: {
21624
+ [name: string]: unknown;
21625
+ };
21626
+ content: {
21627
+ "application/json": components["schemas"]["error.FORBIDDEN"];
21628
+ };
21629
+ };
21630
+ /** @description Not found */
21631
+ 404: {
21632
+ headers: {
21633
+ [name: string]: unknown;
21634
+ };
21635
+ content: {
21636
+ "application/json": components["schemas"]["error.NOT_FOUND"];
21637
+ };
21638
+ };
21639
+ /** @description Internal server error */
21640
+ 500: {
21641
+ headers: {
21642
+ [name: string]: unknown;
21643
+ };
21644
+ content: {
21645
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
21646
+ };
21647
+ };
21648
+ };
21649
+ };
21650
+ getDispatchAction: {
21651
+ parameters: {
21652
+ query?: never;
21653
+ header?: {
21654
+ "X-Team-Id"?: string;
21655
+ };
21656
+ path: {
21657
+ id: string;
21658
+ };
21659
+ cookie?: never;
21660
+ };
21661
+ requestBody?: never;
21662
+ responses: {
21663
+ /** @description Successful response */
21664
+ 200: {
21665
+ headers: {
21666
+ [name: string]: unknown;
21667
+ };
21668
+ content: {
21669
+ "application/json": {
21670
+ /** Format: uuid */
21671
+ id: string;
21672
+ /** Format: uuid */
21673
+ tenantId: string;
21674
+ actionType: string;
21675
+ message: string | null;
21676
+ payload?: unknown;
21677
+ userId: string | null;
21678
+ createdAt: string;
21422
21679
  effectCounts: {
21423
21680
  total: number;
21424
21681
  pending: number;
@@ -21428,6 +21685,115 @@ export interface operations {
21428
21685
  failed: number;
21429
21686
  deadLetter: number;
21430
21687
  };
21688
+ apiEndpoint: string | null;
21689
+ };
21690
+ };
21691
+ };
21692
+ /** @description Invalid input data */
21693
+ 400: {
21694
+ headers: {
21695
+ [name: string]: unknown;
21696
+ };
21697
+ content: {
21698
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
21699
+ };
21700
+ };
21701
+ /** @description Authorization not provided */
21702
+ 401: {
21703
+ headers: {
21704
+ [name: string]: unknown;
21705
+ };
21706
+ content: {
21707
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
21708
+ };
21709
+ };
21710
+ /** @description Insufficient access */
21711
+ 403: {
21712
+ headers: {
21713
+ [name: string]: unknown;
21714
+ };
21715
+ content: {
21716
+ "application/json": components["schemas"]["error.FORBIDDEN"];
21717
+ };
21718
+ };
21719
+ /** @description Not found */
21720
+ 404: {
21721
+ headers: {
21722
+ [name: string]: unknown;
21723
+ };
21724
+ content: {
21725
+ "application/json": components["schemas"]["error.NOT_FOUND"];
21726
+ };
21727
+ };
21728
+ /** @description Internal server error */
21729
+ 500: {
21730
+ headers: {
21731
+ [name: string]: unknown;
21732
+ };
21733
+ content: {
21734
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
21735
+ };
21736
+ };
21737
+ };
21738
+ };
21739
+ listDispatchActions: {
21740
+ parameters: {
21741
+ query?: {
21742
+ limit?: number;
21743
+ offset?: number;
21744
+ startDate?: string;
21745
+ endDate?: string;
21746
+ actionType?: string;
21747
+ entityId?: string;
21748
+ entityType?: "reservation" | "recurringTransactionTemplate" | "tenant" | "transaction";
21749
+ includeIfNoEffects?: boolean;
21750
+ page?: number;
21751
+ };
21752
+ header?: {
21753
+ "X-Team-Id"?: string;
21754
+ };
21755
+ path?: never;
21756
+ cookie?: never;
21757
+ };
21758
+ requestBody?: never;
21759
+ responses: {
21760
+ /** @description Successful response */
21761
+ 200: {
21762
+ headers: {
21763
+ [name: string]: unknown;
21764
+ };
21765
+ content: {
21766
+ "application/json": {
21767
+ data: {
21768
+ /** Format: uuid */
21769
+ id: string;
21770
+ /** Format: uuid */
21771
+ tenantId: string;
21772
+ actionType: string;
21773
+ message: string | null;
21774
+ payload?: unknown;
21775
+ userId: string | null;
21776
+ createdAt: string;
21777
+ effectCounts: {
21778
+ total: number;
21779
+ pending: number;
21780
+ claimed: number;
21781
+ running: number;
21782
+ completed: number;
21783
+ failed: number;
21784
+ deadLetter: number;
21785
+ };
21786
+ apiEndpoint: string | null;
21787
+ }[];
21788
+ pagination: {
21789
+ /** @default 100 */
21790
+ limit: number;
21791
+ /** @default 1 */
21792
+ page: number;
21793
+ total: number;
21794
+ totalPage: number;
21795
+ nextPage?: number;
21796
+ };
21431
21797
  };
21432
21798
  };
21433
21799
  };