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