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