@vrplatform/api 1.3.0-stage.1156 → 1.3.0-stage.1159

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;
@@ -21369,15 +21403,22 @@ export interface operations {
21369
21403
  };
21370
21404
  };
21371
21405
  };
21372
- getDispatchAction: {
21406
+ listEffects: {
21373
21407
  parameters: {
21374
- query?: never;
21408
+ query?: {
21409
+ limit?: number;
21410
+ offset?: number;
21411
+ dispatchId?: string;
21412
+ entityId?: string;
21413
+ entityType?: "reservation" | "recurringTransactionTemplate" | "tenant" | "transaction";
21414
+ status?: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
21415
+ 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";
21416
+ page?: number;
21417
+ };
21375
21418
  header?: {
21376
21419
  "X-Team-Id"?: string;
21377
21420
  };
21378
- path: {
21379
- id: string;
21380
- };
21421
+ path?: never;
21381
21422
  cookie?: never;
21382
21423
  };
21383
21424
  requestBody?: never;
@@ -21389,22 +21430,122 @@ export interface operations {
21389
21430
  };
21390
21431
  content: {
21391
21432
  "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: {
21433
+ data: {
21402
21434
  /** Format: uuid */
21403
21435
  id: string;
21404
- effectType: string;
21436
+ dispatchedAction: {
21437
+ /** Format: uuid */
21438
+ id: string;
21439
+ actionType: string;
21440
+ apiEndpoint: string | null;
21441
+ };
21442
+ /** @enum {string} */
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";
21405
21444
  payload?: unknown;
21406
- entityType: string | null;
21407
- entityId: string | null;
21445
+ entity: ({
21446
+ /** @enum {string} */
21447
+ type: "reservation";
21448
+ data: {
21449
+ id: string;
21450
+ confirmationCode?: string | null;
21451
+ uniqueRef: string;
21452
+ /** @enum {string} */
21453
+ status: "booked" | "canceled" | "inactive";
21454
+ checkIn?: string | null;
21455
+ checkOut?: string | null;
21456
+ };
21457
+ } | {
21458
+ /** @enum {string} */
21459
+ type: "transaction";
21460
+ data: {
21461
+ id: string;
21462
+ /** @enum {string} */
21463
+ status: "active" | "inactive";
21464
+ /** @description Value in cents (100 = 1€) */
21465
+ amount: number;
21466
+ account?: {
21467
+ id: string;
21468
+ name: string;
21469
+ uniqueRef?: string | null;
21470
+ /** @enum {string} */
21471
+ status: "active" | "inactive";
21472
+ } | null;
21473
+ date: string;
21474
+ description: string;
21475
+ currency: string;
21476
+ /** @enum {string} */
21477
+ type: "deposit" | "expense" | "transfer";
21478
+ contact?: {
21479
+ /** Format: uuid */
21480
+ id: string;
21481
+ name?: string | null;
21482
+ uniqueRef?: string | null;
21483
+ } | null;
21484
+ connection?: {
21485
+ /** Format: uuid */
21486
+ id: string;
21487
+ name: string;
21488
+ /** @enum {string} */
21489
+ status: "active" | "inactive";
21490
+ uniqueRef?: string | null;
21491
+ appId: string;
21492
+ } | null;
21493
+ uniqueRef?: string | null;
21494
+ recurringTemplate?: {
21495
+ id: string;
21496
+ } | null;
21497
+ };
21498
+ } | {
21499
+ /** @enum {string} */
21500
+ type: "recurringTransactionTemplate";
21501
+ data: {
21502
+ id: string;
21503
+ /** @enum {string} */
21504
+ status: "active" | "inactive";
21505
+ /** @description Value in cents (100 = 1€) */
21506
+ amount: number;
21507
+ account?: {
21508
+ id: string;
21509
+ name: string;
21510
+ uniqueRef?: string | null;
21511
+ /** @enum {string} */
21512
+ status: "active" | "inactive";
21513
+ } | null;
21514
+ date: string;
21515
+ description: string;
21516
+ currency: string;
21517
+ /** @enum {string} */
21518
+ type: "deposit" | "expense" | "transfer";
21519
+ contact?: {
21520
+ /** Format: uuid */
21521
+ id: string;
21522
+ name?: string | null;
21523
+ uniqueRef?: string | null;
21524
+ } | null;
21525
+ connection?: {
21526
+ /** Format: uuid */
21527
+ id: string;
21528
+ name: string;
21529
+ /** @enum {string} */
21530
+ status: "active" | "inactive";
21531
+ uniqueRef?: string | null;
21532
+ appId: string;
21533
+ } | null;
21534
+ uniqueRef?: string | null;
21535
+ recurringTemplate?: {
21536
+ id: string;
21537
+ } | null;
21538
+ };
21539
+ } | {
21540
+ /** @enum {string} */
21541
+ type: "other";
21542
+ data: {
21543
+ /** Format: uuid */
21544
+ id: string;
21545
+ type: string;
21546
+ name: string | null;
21547
+ };
21548
+ }) | null;
21408
21549
  /** @enum {string} */
21409
21550
  status: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
21410
21551
  priority: number;
@@ -21418,6 +21559,94 @@ export interface operations {
21418
21559
  lastError: string | null;
21419
21560
  createdAt: string;
21420
21561
  }[];
21562
+ pagination: {
21563
+ /** @default 100 */
21564
+ limit: number;
21565
+ /** @default 1 */
21566
+ page: number;
21567
+ total: number;
21568
+ totalPage: number;
21569
+ nextPage?: number;
21570
+ };
21571
+ };
21572
+ };
21573
+ };
21574
+ /** @description Invalid input data */
21575
+ 400: {
21576
+ headers: {
21577
+ [name: string]: unknown;
21578
+ };
21579
+ content: {
21580
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
21581
+ };
21582
+ };
21583
+ /** @description Authorization not provided */
21584
+ 401: {
21585
+ headers: {
21586
+ [name: string]: unknown;
21587
+ };
21588
+ content: {
21589
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
21590
+ };
21591
+ };
21592
+ /** @description Insufficient access */
21593
+ 403: {
21594
+ headers: {
21595
+ [name: string]: unknown;
21596
+ };
21597
+ content: {
21598
+ "application/json": components["schemas"]["error.FORBIDDEN"];
21599
+ };
21600
+ };
21601
+ /** @description Not found */
21602
+ 404: {
21603
+ headers: {
21604
+ [name: string]: unknown;
21605
+ };
21606
+ content: {
21607
+ "application/json": components["schemas"]["error.NOT_FOUND"];
21608
+ };
21609
+ };
21610
+ /** @description Internal server error */
21611
+ 500: {
21612
+ headers: {
21613
+ [name: string]: unknown;
21614
+ };
21615
+ content: {
21616
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
21617
+ };
21618
+ };
21619
+ };
21620
+ };
21621
+ getDispatchAction: {
21622
+ parameters: {
21623
+ query?: never;
21624
+ header?: {
21625
+ "X-Team-Id"?: string;
21626
+ };
21627
+ path: {
21628
+ id: string;
21629
+ };
21630
+ cookie?: never;
21631
+ };
21632
+ requestBody?: never;
21633
+ responses: {
21634
+ /** @description Successful response */
21635
+ 200: {
21636
+ headers: {
21637
+ [name: string]: unknown;
21638
+ };
21639
+ content: {
21640
+ "application/json": {
21641
+ /** Format: uuid */
21642
+ id: string;
21643
+ /** Format: uuid */
21644
+ tenantId: string;
21645
+ actionType: string;
21646
+ message: string | null;
21647
+ payload?: unknown;
21648
+ userId: string | null;
21649
+ createdAt: string;
21421
21650
  effectCounts: {
21422
21651
  total: number;
21423
21652
  pending: number;
@@ -21427,6 +21656,114 @@ export interface operations {
21427
21656
  failed: number;
21428
21657
  deadLetter: number;
21429
21658
  };
21659
+ apiEndpoint: string | null;
21660
+ };
21661
+ };
21662
+ };
21663
+ /** @description Invalid input data */
21664
+ 400: {
21665
+ headers: {
21666
+ [name: string]: unknown;
21667
+ };
21668
+ content: {
21669
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
21670
+ };
21671
+ };
21672
+ /** @description Authorization not provided */
21673
+ 401: {
21674
+ headers: {
21675
+ [name: string]: unknown;
21676
+ };
21677
+ content: {
21678
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
21679
+ };
21680
+ };
21681
+ /** @description Insufficient access */
21682
+ 403: {
21683
+ headers: {
21684
+ [name: string]: unknown;
21685
+ };
21686
+ content: {
21687
+ "application/json": components["schemas"]["error.FORBIDDEN"];
21688
+ };
21689
+ };
21690
+ /** @description Not found */
21691
+ 404: {
21692
+ headers: {
21693
+ [name: string]: unknown;
21694
+ };
21695
+ content: {
21696
+ "application/json": components["schemas"]["error.NOT_FOUND"];
21697
+ };
21698
+ };
21699
+ /** @description Internal server error */
21700
+ 500: {
21701
+ headers: {
21702
+ [name: string]: unknown;
21703
+ };
21704
+ content: {
21705
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
21706
+ };
21707
+ };
21708
+ };
21709
+ };
21710
+ listDispatchActions: {
21711
+ parameters: {
21712
+ query?: {
21713
+ limit?: number;
21714
+ offset?: number;
21715
+ startDate?: string;
21716
+ endDate?: string;
21717
+ actionType?: string;
21718
+ entityId?: string;
21719
+ entityType?: "reservation" | "recurringTransactionTemplate" | "tenant" | "transaction";
21720
+ page?: number;
21721
+ };
21722
+ header?: {
21723
+ "X-Team-Id"?: string;
21724
+ };
21725
+ path?: never;
21726
+ cookie?: never;
21727
+ };
21728
+ requestBody?: never;
21729
+ responses: {
21730
+ /** @description Successful response */
21731
+ 200: {
21732
+ headers: {
21733
+ [name: string]: unknown;
21734
+ };
21735
+ content: {
21736
+ "application/json": {
21737
+ data: {
21738
+ /** Format: uuid */
21739
+ id: string;
21740
+ /** Format: uuid */
21741
+ tenantId: string;
21742
+ actionType: string;
21743
+ message: string | null;
21744
+ payload?: unknown;
21745
+ userId: string | null;
21746
+ createdAt: string;
21747
+ effectCounts: {
21748
+ total: number;
21749
+ pending: number;
21750
+ claimed: number;
21751
+ running: number;
21752
+ completed: number;
21753
+ failed: number;
21754
+ deadLetter: number;
21755
+ };
21756
+ apiEndpoint: string | null;
21757
+ }[];
21758
+ pagination: {
21759
+ /** @default 100 */
21760
+ limit: number;
21761
+ /** @default 1 */
21762
+ page: number;
21763
+ total: number;
21764
+ totalPage: number;
21765
+ nextPage?: number;
21766
+ };
21430
21767
  };
21431
21768
  };
21432
21769
  };
@@ -24711,7 +25048,10 @@ export interface operations {
24711
25048
  };
24712
25049
  runFlow: {
24713
25050
  parameters: {
24714
- query?: never;
25051
+ query?: {
25052
+ from?: string;
25053
+ to?: string;
25054
+ };
24715
25055
  header?: {
24716
25056
  "X-Team-Id"?: string;
24717
25057
  };